{ "openapi": "3.0.0", "info": { "title": "tms", "version": "0.0.1", "description": "tms", "contact": { "name": "jasbir", "email": "jsingh@creedinfotech.com" } }, "paths": { "/Get/DAT/New/Rate/detail/{OriginId}/{DestiId}/{EquipId}": { "get": { "x-controller-name": "DatratemateController", "x-operation-name": "GetDATNewRateDetail", "tags": [ "DatratemateController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker view getdatnewratedetail |\n", "responses": { "200": { "description": "Return value of DatratemateController.GetDATNewRateDetail", "content": {} } }, "parameters": [ { "name": "OriginId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "DestiId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "EquipId", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "DatratemateController.GetDATNewRateDetail" } }, "/Rate/detail/{OriginId}/{DestiId}/{EquipId}": { "get": { "x-controller-name": "DatratemateController", "x-operation-name": "get", "tags": [ "DatratemateController" ], "description": "\n\n| Permissions |\n| ------- |\n| sme view carrierOnboarding |\n", "responses": { "200": { "description": "Return value of DatratemateController.get", "content": {} } }, "parameters": [ { "name": "OriginId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "DestiId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "EquipId", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "DatratemateController.get" } }, "/Update/pod/uploaded/days/asi/APTeam": { "get": { "x-controller-name": "AsiallIncentivesController", "x-operation-name": "UpdatePodUploadedDaysAPTeam", "tags": [ "AsiallIncentivesController" ], "responses": { "200": { "description": "Return value of AsiallIncentivesController.UpdatePodUploadedDaysAPTeam" } }, "operationId": "AsiallIncentivesController.UpdatePodUploadedDaysAPTeam" } }, "/VerifyMcAuto/detail/mobile/{MCNumber}/{RequestType}": { "get": { "x-controller-name": "DatratemateController", "x-operation-name": "getMCDataForMobile", "tags": [ "DatratemateController" ], "responses": { "200": { "description": "Return value of DatratemateController.getMCDataForMobile" } }, "parameters": [ { "name": "MCNumber", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "RequestType", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "DatratemateController.getMCDataForMobile" } }, "/VerifyMcAuto/detail/{MCNumber}/{RequestType}": { "get": { "x-controller-name": "DatratemateController", "x-operation-name": "getData", "tags": [ "DatratemateController" ], "description": "\n\n| Permissions |\n| ------- |\n| sme approve mcAutoByCode |\n", "responses": { "200": { "description": "Return value of DatratemateController.getData", "content": {} } }, "parameters": [ { "name": "MCNumber", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "RequestType", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "DatratemateController.getData" } }, "/VerifyProInvoiced/detail/{ProNumber}": { "get": { "x-controller-name": "DatratemateController", "x-operation-name": "getInvoicedProDetails", "tags": [ "DatratemateController" ], "responses": { "200": { "description": "Return value of DatratemateController.getInvoicedProDetails" } }, "parameters": [ { "name": "ProNumber", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "DatratemateController.getInvoicedProDetails" } }, "/ace-vl-invoices-data": { "get": { "x-controller-name": "ArInvoicesController", "x-operation-name": "aceVlInvoicesDataList", "tags": [ "ArInvoicesController" ], "description": "\n\n| Permissions |\n| ------- |\n| ace asi invoices |\n", "responses": { "200": { "description": "Invoices model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoicesWithRelations" } } } } }, "parameters": [ { "name": "invoiceType", "in": "query", "schema": { "type": "string" } }, { "name": "shipmentId", "in": "query", "schema": { "type": "string" } }, { "name": "forExport", "in": "query", "schema": { "type": "boolean" } }, { "name": "qbStatus", "in": "query", "schema": { "type": "string" } }, { "name": "payStatus", "in": "query", "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "number" } }, { "name": "pageSize", "in": "query", "schema": { "type": "number" } }, { "name": "DateFrom", "in": "query", "schema": { "type": "string" } }, { "name": "DateTo", "in": "query", "schema": { "type": "string" } } ], "operationId": "ArInvoicesController.aceVlInvoicesDataList" } }, "/add-insurance-document": { "post": { "x-controller-name": "ArInsuranceDocumentsController", "x-operation-name": "addInsuranceDocument", "tags": [ "ArInsuranceDocumentsController" ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Files and fields" } }, "description": "", "requestBody": { "content": { "multipart/form-data": { "x-parser": "stream", "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } } } } }, "description": "Request body for multipart/form-data based file upload", "required": true }, "operationId": "ArInsuranceDocumentsController.addInsuranceDocument" } }, "/add-insurance-document-type": { "post": { "x-controller-name": "ArInsuranceDocumentsController", "x-operation-name": "createInsuranceDocumentType", "tags": [ "ArInsuranceDocumentsController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar add insurance document |\n", "responses": { "200": { "description": "Return value of ArInsuranceDocumentsController.createInsuranceDocumentType", "content": {} }, "201": { "description": "Insurance document created successfully", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "documentType", "documentCompanyName" ], "properties": { "documentType": { "type": "string" }, "documentCompanyName": { "type": "string" } } } } } }, "operationId": "ArInsuranceDocumentsController.createInsuranceDocumentType" } }, "/add-location": { "post": { "x-controller-name": "CommonSearchController", "x-operation-name": "AddLocation", "tags": [ "CommonSearchController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Location Post success" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "CommonSearchController.AddLocation" } }, "/add-one-time-credit-application": { "post": { "x-controller-name": "ShipmentController", "x-operation-name": "updateCreditException", "tags": [ "ShipmentController" ], "responses": { "200": { "description": "Return value of ShipmentController.updateCreditException" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "ShipmentController.updateCreditException" } }, "/add-remarks": { "post": { "x-controller-name": "BrokerVinVerificationController", "x-operation-name": "AddRemarks", "tags": [ "BrokerVinVerificationController" ], "description": "", "responses": { "200": { "description": "Notes model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Shipment" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "BrokerVinVerificationController.AddRemarks" } }, "/add-small-claims": { "post": { "x-controller-name": "ArShipperClaimController", "x-operation-name": "AddSmallClaim", "tags": [ "ArShipperClaimController" ], "responses": { "200": { "description": "SmallClaim model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Shippers" } } } } }, "description": "\n\n| Permissions |\n| ------- |\n| ar view shipper aging |\n", "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "ArShipperClaimController.AddSmallClaim" } }, "/add-ssl-payment": { "post": { "x-controller-name": "ShipmentController", "x-operation-name": "addSslPayment", "tags": [ "ShipmentController" ], "description": "", "responses": { "200": { "description": "Return value of ShipmentController.addSslPayment", "content": {} } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "ShipmentController.addSslPayment" } }, "/add-user-group": { "post": { "x-controller-name": "UserGroupController", "x-operation-name": "addUserGroup", "tags": [ "UserGroupController" ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "File and form upload" } }, "description": "", "requestBody": { "content": { "multipart/form-data": { "x-parser": "stream", "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } } } } }, "description": "Request body for multipart/form-data based file upload", "required": true }, "operationId": "UserGroupController.addUserGroup" } }, "/add-withdrawn-comments": { "post": { "x-controller-name": "WithdrawnShipperCreditLimitHistoryController", "x-operation-name": "addWithdrawnCommentsHistory", "tags": [ "WithdrawnShipperCreditLimitHistoryController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar withdrawn limit |\n", "responses": { "200": { "description": "WithdrawnCommentsHistory model instance", "content": { "application/json": { "schema": {} } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "WithdrawnShipperCreditLimitHistoryController.addWithdrawnCommentsHistory" } }, "/add-withdrawn-limit-data": { "post": { "x-controller-name": "WithdrawnShipperCreditLimitHistoryController", "x-operation-name": "addwithdrawnLimitData", "tags": [ "WithdrawnShipperCreditLimitHistoryController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar withdrawn limit |\n", "responses": { "200": { "description": "Return value of WithdrawnShipperCreditLimitHistoryController.addwithdrawnLimitData", "content": {} }, "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Shipper Limit PATCH success" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "WithdrawnShipperCreditLimitHistoryController.addwithdrawnLimitData" } }, "/add-write-off-payment": { "post": { "x-controller-name": "ArBadDebtsHistoryController", "x-operation-name": "addwriteOffpayment", "tags": [ "ArBadDebtsHistoryController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar view write off payments |\n", "responses": { "200": { "description": "Add write off payments", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "ArBadDebtsHistoryController.addwriteOffpayment" } }, "/advance-pay-carrier-payments/history": { "get": { "x-controller-name": "AdvancePayCarrierPaymentController", "x-operation-name": "getAdvancePayCarrierPaymentHistory", "tags": [ "AdvancePayCarrierPaymentController" ], "description": "", "responses": { "200": { "description": "Get advance pay carrier payment history with pagination and filters", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/AdvancePayCarrierPaymentWithRelations" } }, "totalCount": { "type": "number" }, "page": { "type": "number" }, "pageSize": { "type": "number" }, "totalPages": { "type": "number" } } } } } } }, "parameters": [ { "name": "paymentMethod", "in": "query", "schema": { "type": "string" } }, { "name": "dateFrom", "in": "query", "schema": { "type": "string" } }, { "name": "dateTo", "in": "query", "schema": { "type": "string" } }, { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "addedBy", "in": "query", "schema": { "type": "number" } }, { "name": "page", "in": "query", "schema": { "type": "number" } }, { "name": "pageSize", "in": "query", "schema": { "type": "number" } } ], "operationId": "AdvancePayCarrierPaymentController.getAdvancePayCarrierPaymentHistory" } }, "/advance-pay-carrier-payments": { "post": { "x-controller-name": "AdvancePayCarrierPaymentController", "x-operation-name": "createAdvancePayCarrierPayment", "tags": [ "AdvancePayCarrierPaymentController" ], "description": "", "responses": { "200": { "description": "AdvancePayCarrierPayment model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdvancePayCarrierPayment" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "paymentMethod", "amount" ], "properties": { "paymentMethod": { "type": "string", "description": "Payment method (e.g., ach, efs, cheque)" }, "shipmentId": { "type": "number", "description": "Shipment ID" }, "amount": { "type": "number", "description": "Payment amount" }, "description": { "type": "string", "description": "Payment description" } } } } }, "description": "Create advance pay carrier payment", "required": true }, "operationId": "AdvancePayCarrierPaymentController.createAdvancePayCarrierPayment" } }, "/advance-pay-carriers/{id}/carrier-aging": { "get": { "x-controller-name": "AdvancePayCarrierCarrierAgingController", "x-operation-name": "getCarrierAging", "tags": [ "AdvancePayCarrierCarrierAgingController" ], "responses": { "200": { "description": "CarrierAging belonging to AdvancePayCarrier", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CarrierAging" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "AdvancePayCarrierCarrierAgingController.getCarrierAging" } }, "/advance-pay-carriers/{id}/user": { "get": { "x-controller-name": "AdvancePayCarrierUserController", "x-operation-name": "getUser", "tags": [ "AdvancePayCarrierUserController" ], "responses": { "200": { "description": "User belonging to AdvancePayCarrier", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "AdvancePayCarrierUserController.getUser" } }, "/aging-claim-add": { "post": { "x-controller-name": "ArShipperClaimController", "x-operation-name": "addAgingClaim", "tags": [ "ArShipperClaimController" ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Files and fields" } }, "description": "\n\n| Permissions |\n| ------- |\n| ar view shipper aging |\n", "requestBody": { "content": { "multipart/form-data": { "x-parser": "stream", "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } } } } }, "description": "Request body for multipart/form-data based file upload", "required": true }, "operationId": "ArShipperClaimController.addAgingClaim" } }, "/ai-model-data": { "post": { "x-controller-name": "LoadsController", "x-operation-name": "createAiModelLoad", "tags": [ "LoadsController" ], "description": "", "responses": { "200": { "description": "Create AI Model Load entry", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AiModelLoads" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "aiData": { "type": "object", "additionalProperties": true }, "distanceData": { "type": "object", "properties": { "pickzip": { "type": "string" }, "dropzip": { "type": "string" }, "distance": { "type": "number" }, "distance_log": { "type": "string" } }, "required": [ "pickzip", "dropzip" ] } }, "required": [ "aiData", "distanceData" ] } } } }, "operationId": "LoadsController.createAiModelLoad" } }, "/aimodel-carrier-overallhistory/{originCity}/{destination}": { "get": { "x-controller-name": "DatratemateController", "x-operation-name": "aimodelcarrierhistory", "tags": [ "DatratemateController" ], "responses": { "200": { "description": "Return value of DatratemateController.aimodelcarrierhistory" } }, "parameters": [ { "name": "originCity", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "destination", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "DatratemateController.aimodelcarrierhistory" } }, "/aimodelload/{OriginId}/{DestiId}/{EquipId}/{commodityid}/{fullPartialid}/{is_high_paid_laneid}": { "get": { "x-controller-name": "DatratemateController", "x-operation-name": "aimodelload", "tags": [ "DatratemateController" ], "responses": { "200": { "description": "Return value of DatratemateController.aimodelload" } }, "parameters": [ { "name": "OriginId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "DestiId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "EquipId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "commodityid", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "fullPartialid", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "is_high_paid_laneid", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "DatratemateController.aimodelload" } }, "/all/cpr/count": { "get": { "x-controller-name": "ShipmentCprRequestController", "x-operation-name": "count", "tags": [ "ShipmentCprRequestController" ], "responses": { "200": { "description": "Loads model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "CprRequest.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "ShipmentCprRequestController.count" } }, "/all-carriers": { "get": { "x-controller-name": "CarriersController", "x-operation-name": "findcarrier", "tags": [ "CarriersController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker view carrier |\n", "responses": { "200": { "description": "Array of Broker All Carriers model instances", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CarriersWithRelations" } }, "totalCount": { "type": "number" }, "totalPages": { "type": "number" }, "currentPage": { "type": "number" } } } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Carriers.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } }, { "name": "page", "in": "query", "schema": { "type": "number" } }, { "name": "pageSize", "in": "query", "schema": { "type": "number" } }, { "name": "maxmindata", "in": "query", "schema": { "type": "string" } }, { "name": "pickupId", "in": "query", "schema": { "type": "string" } }, { "name": "dropId", "in": "query", "schema": { "type": "string" } }, { "name": "region", "in": "query", "schema": { "type": "string" } } ], "operationId": "CarriersController.findcarrier" } }, "/all-internal/shipments": { "get": { "x-controller-name": "ShipmentController", "x-operation-name": "findInternalShipments", "tags": [ "ShipmentController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker view shipment |\n", "responses": { "200": { "description": "Array of Shipment model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ShipmentWithRelations" } } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Shipment.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } }, { "name": "page", "in": "query", "schema": { "type": "number" } }, { "name": "pageSize", "in": "query", "schema": { "type": "number" } }, { "name": "status", "in": "query", "schema": { "type": "string" } }, { "name": "id", "in": "query", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "schema": { "type": "string" } }, { "name": "shippersId", "in": "query", "schema": { "type": "string" } } ], "operationId": "ShipmentController.findInternalShipments" } }, "/all-teams": { "get": { "x-controller-name": "ReportsController", "x-operation-name": "getTeamByCondition", "tags": [ "ReportsController" ], "description": "", "responses": { "200": { "description": "Return value of ReportsController.getTeamByCondition", "content": {} } }, "operationId": "ReportsController.getTeamByCondition" } }, "/allocate-user": { "post": { "x-controller-name": "ChurnCustomerController", "x-operation-name": "allocateUsers", "tags": [ "ChurnCustomerController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker view churn report |\n", "responses": { "200": { "description": "Return value of ChurnCustomerController.allocateUsers", "content": {} } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "ChurnCustomerController.allocateUsers" } }, "/allocate-user-multiple": { "post": { "x-controller-name": "ChurnCustomerController", "x-operation-name": "allocateUsersBulk", "tags": [ "ChurnCustomerController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker view churn report |\n", "responses": { "200": { "description": "Return value of ChurnCustomerController.allocateUsersBulk", "content": {} } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "ChurnCustomerController.allocateUsersBulk" } }, "/analytics/cpr-monthly-performance-all": { "get": { "x-controller-name": "AnalyticsPerformanceReportController", "x-operation-name": "getAnalyticsCprMonthlySummaryAll", "tags": [ "AnalyticsPerformanceReportController" ], "description": "", "responses": { "200": { "description": "Return value of AnalyticsPerformanceReportController.getAnalyticsCprMonthlySummaryAll", "content": {} } }, "parameters": [ { "name": "startDate", "in": "query", "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "schema": { "type": "string" } }, { "name": "userId", "in": "query", "schema": { "type": "number" } }, { "name": "teamId", "in": "query", "schema": { "type": "number" } } ], "operationId": "AnalyticsPerformanceReportController.getAnalyticsCprMonthlySummaryAll" } }, "/analytics/monthly-performance-all": { "get": { "x-controller-name": "AnalyticsPerformanceReportController", "x-operation-name": "getAnalyticsMonthlySummaryAll", "tags": [ "AnalyticsPerformanceReportController" ], "description": "", "responses": { "200": { "description": "Return value of AnalyticsPerformanceReportController.getAnalyticsMonthlySummaryAll", "content": {} } }, "parameters": [ { "name": "startDate", "in": "query", "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "schema": { "type": "string" } }, { "name": "userId", "in": "query", "schema": { "type": "number" } }, { "name": "teamId", "in": "query", "schema": { "type": "number" } }, { "name": "sendEmailTo", "in": "query", "schema": { "type": "string" } }, { "name": "exportFile", "in": "query", "schema": { "type": "boolean" }, "required": false, "description": "Export as CSV and send via email" } ], "operationId": "AnalyticsPerformanceReportController.getAnalyticsMonthlySummaryAll" } }, "/analytics-fetch-pie-chart-margin": { "get": { "x-controller-name": "AnalyticsBrokerReportController", "x-operation-name": "getPieChartMarginReport", "tags": [ "AnalyticsBrokerReportController" ], "responses": { "200": { "description": "Report fetched successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } } }, "description": "\n\n| Permissions |\n| ------- |\n| view broker reports |\n", "parameters": [ { "name": "month", "in": "query", "schema": { "type": "string" }, "description": "Month name (e.g., \"January\")", "required": true } ], "operationId": "AnalyticsBrokerReportController.getPieChartMarginReport" } }, "/analytics-fetch-quarterly-margin": { "get": { "x-controller-name": "AnalyticsBrokerReportController", "x-operation-name": "getQuarterMarginReport", "tags": [ "AnalyticsBrokerReportController" ], "responses": { "200": { "description": "Quarterly margin comparison between two years", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } } } } } }, "description": "\n\n| Permissions |\n| ------- |\n| view broker reports |\n", "parameters": [ { "name": "year1", "in": "query", "schema": { "type": "string" } }, { "name": "year2", "in": "query", "schema": { "type": "string" } } ], "operationId": "AnalyticsBrokerReportController.getQuarterMarginReport" } }, "/analytics-fetch-report-cpr": { "get": { "x-controller-name": "AnalyticsBrokerReportController", "x-operation-name": "getReport", "tags": [ "AnalyticsBrokerReportController" ], "responses": { "200": { "description": "Report fetched successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } } }, "description": "\n\n| Permissions |\n| ------- |\n| view broker reports |\n", "operationId": "AnalyticsBrokerReportController.getReport" } }, "/analytics-fetch-report-cpr-old": { "get": { "x-controller-name": "AnalyticsBrokerReportController", "x-operation-name": "getReportOld", "tags": [ "AnalyticsBrokerReportController" ], "responses": { "200": { "description": "Report fetched successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } } }, "description": "\n\n| Permissions |\n| ------- |\n| view broker reports |\n", "operationId": "AnalyticsBrokerReportController.getReportOld" } }, "/analytics-fetch-report-invoice": { "get": { "x-controller-name": "AnalyticsBrokerReportController", "x-operation-name": "getReportInvoice", "tags": [ "AnalyticsBrokerReportController" ], "responses": { "200": { "description": "Report fetched successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } } }, "description": "\n\n| Permissions |\n| ------- |\n| view broker reports |\n", "operationId": "AnalyticsBrokerReportController.getReportInvoice" } }, "/analytics-fetch-team-margin": { "get": { "x-controller-name": "AnalyticsBrokerReportController", "x-operation-name": "getTeamMarginReport", "tags": [ "AnalyticsBrokerReportController" ], "responses": { "200": { "description": "Report fetched successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } } }, "description": "\n\n| Permissions |\n| ------- |\n| view broker reports |\n", "parameters": [ { "name": "startDate", "in": "query", "schema": { "type": "string" }, "description": "Start date (YYYY-MM-DD)" }, { "name": "endDate", "in": "query", "schema": { "type": "string" }, "description": "End date (YYYY-MM-DD)" } ], "operationId": "AnalyticsBrokerReportController.getTeamMarginReport" } }, "/analytics-get-active-brokers-count": { "get": { "x-controller-name": "AnalyticsBrokerReportController", "x-operation-name": "getActiveBrokersCount", "tags": [ "AnalyticsBrokerReportController" ], "description": "", "responses": { "200": { "description": "Return value of AnalyticsBrokerReportController.getActiveBrokersCount", "content": {} } }, "operationId": "AnalyticsBrokerReportController.getActiveBrokersCount" } }, "/analytics-get-margin-report-managerById": { "get": { "x-controller-name": "AnalyticsBrokerReportController", "x-operation-name": "MarginReportManagerBy", "tags": [ "AnalyticsBrokerReportController" ], "description": "\n\n| Permissions |\n| ------- |\n| view broker reports |\n", "responses": { "200": { "description": "Invoices model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoicesWithRelations" } } } } }, "parameters": [ { "name": "startDate", "in": "query", "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "schema": { "type": "string" } }, { "name": "managerId", "in": "query", "schema": { "type": "string" } }, { "name": "userType", "in": "query", "schema": { "type": "string" } } ], "operationId": "AnalyticsBrokerReportController.MarginReportManagerBy" } }, "/analytics-get-margin-report-teamlead-by-managerById": { "get": { "x-controller-name": "AnalyticsBrokerReportController", "x-operation-name": "MarginReportManagerByTeamLead", "tags": [ "AnalyticsBrokerReportController" ], "description": "\n\n| Permissions |\n| ------- |\n| view broker reports |\n", "responses": { "200": { "description": "Invoices model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoicesWithRelations" } } } } }, "parameters": [ { "name": "startDate", "in": "query", "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "schema": { "type": "string" } }, { "name": "managerId", "in": "query", "schema": { "type": "string" } } ], "operationId": "AnalyticsBrokerReportController.MarginReportManagerByTeamLead" } }, "/analytics-get-total-users-count": { "get": { "x-controller-name": "AnalyticsBrokerReportController", "x-operation-name": "getTotalUsersCount", "tags": [ "AnalyticsBrokerReportController" ], "description": "", "responses": { "200": { "description": "Return value of AnalyticsBrokerReportController.getTotalUsersCount", "content": {} } }, "operationId": "AnalyticsBrokerReportController.getTotalUsersCount" } }, "/analytics-performance-comments": { "get": { "x-controller-name": "AnalyticsBrokerReportController", "x-operation-name": "listPerformanceComments", "tags": [ "AnalyticsBrokerReportController" ], "responses": { "200": { "description": "List performance comments with user info", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/User" } } } } } }, "parameters": [ { "name": "userId", "in": "query", "schema": { "type": "number" } } ], "operationId": "AnalyticsBrokerReportController.listPerformanceComments" } }, "/analytics-portal/monthly-performance-all": { "get": { "x-controller-name": "AnalyticsBrokerReportController", "x-operation-name": "getMonthlySummaryAll", "tags": [ "AnalyticsBrokerReportController" ], "description": "", "responses": { "200": { "description": "Return value of AnalyticsBrokerReportController.getMonthlySummaryAll", "content": {} } }, "parameters": [ { "name": "startDate", "in": "query", "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "schema": { "type": "string" } }, { "name": "userId", "in": "query", "schema": { "type": "number" } }, { "name": "teamId", "in": "query", "schema": { "type": "number" } }, { "name": "sendEmailTo", "in": "query", "schema": { "type": "string" } }, { "name": "exportFile", "in": "query", "schema": { "type": "boolean" }, "required": false, "description": "Export as CSV and send via email" } ], "operationId": "AnalyticsBrokerReportController.getMonthlySummaryAll" } }, "/ap/add-carrier-payment-update": { "post": { "x-controller-name": "ApSendStatementController", "x-operation-name": "AddCarrierPayment", "tags": [ "ApSendStatementController" ], "description": "", "responses": { "200": { "description": "Carrier Payment model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApSendPayment" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "ApSendStatementController.AddCarrierPayment" } }, "/ap/carrier-advance-pay-requests/{requestId}/status-update": { "post": { "x-controller-name": "CarrierAdvancePayRequestsController", "x-operation-name": "updateApCarrierAdvancePayRequestStatus", "tags": [ "CarrierAdvancePayRequestsController" ], "description": "\n\n| Permissions |\n| ------- |\n| ap carrier payment |\n| ap carrier aging |\n", "responses": { "200": { "description": "Update carrier advance pay request status by request ID", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object" } } } } } } }, "parameters": [ { "name": "requestId", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "status" ], "properties": { "status": { "type": "number" }, "remark_ap": { "type": "string" }, "moneyCode": { "type": "string" } } } } }, "required": true, "x-parameter-index": 1 }, "operationId": "CarrierAdvancePayRequestsController.updateApCarrierAdvancePayRequestStatus" } }, "/ap/carrier-advance-pay-requests": { "get": { "x-controller-name": "CarrierAdvancePayRequestsController", "x-operation-name": "getApCarrierAdvancePayRequests", "tags": [ "CarrierAdvancePayRequestsController" ], "description": "\n\n| Permissions |\n| ------- |\n| ap carrier payment |\n| ap carrier aging |\n", "responses": { "200": { "description": "Get all carrier advance pay requests for AP handling", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "array" }, "totalCount": { "type": "number" }, "totalPages": { "type": "number" }, "page": { "type": "number" }, "pageSize": { "type": "number" } } } } } } }, "parameters": [ { "name": "proNumber", "in": "query", "schema": { "type": "number" } }, { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "status", "in": "query", "schema": { "type": "number" } }, { "name": "startDate", "in": "query", "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "number" } }, { "name": "pageSize", "in": "query", "schema": { "type": "number" } } ], "operationId": "CarrierAdvancePayRequestsController.getApCarrierAdvancePayRequests" } }, "/ap/carrier-invoice-requests/{requestId}/status-update": { "post": { "x-controller-name": "CarrierInvoicesController", "x-operation-name": "updateApCarrierInvoiceRequestStatus", "tags": [ "CarrierInvoicesController" ], "description": "\n\n| Permissions |\n| ------- |\n| ap carrier payment |\n| ap carrier aging |\n", "responses": { "200": { "description": "Update carrier invoice request status by request ID", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object" } } } } } } }, "parameters": [ { "name": "requestId", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "request_status" ], "properties": { "request_status": { "type": "number" }, "remark_ap": { "type": "string" } } } } }, "required": true, "x-parameter-index": 1 }, "operationId": "CarrierInvoicesController.updateApCarrierInvoiceRequestStatus" } }, "/ap/carrier-invoice-requests": { "get": { "x-controller-name": "CarrierInvoicesController", "x-operation-name": "getApCarrierInvoiceRequests", "tags": [ "CarrierInvoicesController" ], "description": "\n\n| Permissions |\n| ------- |\n| ap carrier payment |\n| ap carrier aging |\n", "responses": { "200": { "description": "Get all carrier invoice raise requests for AP handling", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "array" }, "totalCount": { "type": "number" }, "totalPages": { "type": "number" }, "page": { "type": "number" }, "pageSize": { "type": "number" } } } } } } }, "parameters": [ { "name": "proNumber", "in": "query", "schema": { "type": "number" } }, { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "status", "in": "query", "schema": { "type": "number" } }, { "name": "startDate", "in": "query", "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "number" } }, { "name": "pageSize", "in": "query", "schema": { "type": "number" } } ], "operationId": "CarrierInvoicesController.getApCarrierInvoiceRequests" } }, "/ap/efs-add-balance": { "post": { "x-controller-name": "ArEcapitalController", "x-operation-name": "AddRemarks", "tags": [ "ArEcapitalController" ], "description": "", "responses": { "200": { "description": "Notes model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Shipment" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "ArEcapitalController.AddRemarks" } }, "/ap/get-efs-balance": { "get": { "x-controller-name": "ArEcapitalController", "x-operation-name": "GetEfsBalance", "tags": [ "ArEcapitalController" ], "description": "", "responses": { "200": { "description": "Notes model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Shipment" } } } } }, "operationId": "ArEcapitalController.GetEfsBalance" } }, "/ap/get-efs-paid-amount": { "get": { "x-controller-name": "ArEcapitalController", "x-operation-name": "GetEfsPaidAmount", "tags": [ "ArEcapitalController" ], "description": "", "responses": { "200": { "description": "Notes model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Shipment" } } } } }, "operationId": "ArEcapitalController.GetEfsPaidAmount" } }, "/ap/get-filter-data": { "get": { "x-controller-name": "ApShipmentControllerController", "x-operation-name": "getFilterData", "tags": [ "ApShipmentControllerController" ], "description": "\n\n| Permissions |\n| ------- |\n| ap view shipment |\n", "responses": { "200": { "description": "Array of Shipment model instances", "content": { "application/json": { "schema": { "type": "array" } } } } }, "operationId": "ApShipmentControllerController.getFilterData" } }, "/ap/payment-methods": { "post": { "x-controller-name": "ApShipmentControllerController", "x-operation-name": "createMethod", "tags": [ "ApShipmentControllerController" ], "responses": { "200": { "description": "PaymentMethods model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentMethods" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewPaymentMethods" } } } }, "operationId": "ApShipmentControllerController.createMethod" } }, "/ap/send-carrier-payment-count": { "get": { "x-controller-name": "ApSendStatementController", "x-operation-name": "count", "tags": [ "ApSendStatementController" ], "description": "", "responses": { "200": { "description": "Shippers model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "operationId": "ApSendStatementController.count" } }, "/ap/send-email-send-carrier-payment": { "post": { "x-controller-name": "ApSendStatementController", "x-operation-name": "SendEmailSendCarrierpayment", "tags": [ "ApSendStatementController" ], "description": "", "responses": { "200": { "description": "Carrier Payment model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApSendPayment" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "ApSendStatementController.SendEmailSendCarrierpayment" } }, "/ap/shipments/count": { "get": { "x-controller-name": "ApShipmentControllerController", "x-operation-name": "count", "tags": [ "ApShipmentControllerController" ], "responses": { "200": { "description": "Shipment model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Shipment.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "ApShipmentControllerController.count" } }, "/ap/shipments": { "post": { "x-controller-name": "ApShipmentControllerController", "x-operation-name": "create", "tags": [ "ApShipmentControllerController" ], "responses": { "200": { "description": "Shipment model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Shipment" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewShipment" } } } }, "operationId": "ApShipmentControllerController.create" }, "patch": { "x-controller-name": "ApShipmentControllerController", "x-operation-name": "updateAll", "tags": [ "ApShipmentControllerController" ], "responses": { "200": { "description": "Shipment PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Shipment.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipmentPartial" } } } }, "operationId": "ApShipmentControllerController.updateAll" }, "get": { "x-controller-name": "ApShipmentControllerController", "x-operation-name": "find", "tags": [ "ApShipmentControllerController" ], "description": "\n\n| Permissions |\n| ------- |\n| ap view shipment |\n", "responses": { "200": { "description": "Array of Shipment model instances", "content": { "application/json": { "schema": { "type": "array" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Shipment.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } }, { "name": "page", "in": "query", "schema": { "type": "number" } }, { "name": "invoiceNumber", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "number" } } ], "operationId": "ApShipmentControllerController.find" } }, "/ap/update-shipment-price": { "patch": { "x-controller-name": "ApShipmentControllerController", "x-operation-name": "updateShipment", "tags": [ "ApShipmentControllerController" ], "description": "\n\n| Permissions |\n| ------- |\n| ap view shipment |\n", "responses": { "200": { "description": "Shippers History model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Shipment" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "ApShipmentControllerController.updateShipment" } }, "/ap-alignment-history": { "get": { "x-controller-name": "EmpAlignmentUserController", "x-operation-name": "fetchApAlignmentHistory", "tags": [ "EmpAlignmentUserController" ], "description": "", "responses": { "200": { "description": "Return value of EmpAlignmentUserController.fetchApAlignmentHistory", "content": {} } }, "parameters": [ { "name": "brokerId", "in": "query", "schema": { "type": "number" } } ], "operationId": "EmpAlignmentUserController.fetchApAlignmentHistory" } }, "/ap-alignment-user": { "get": { "x-controller-name": "EmpAlignmentUserController", "x-operation-name": "approvalAlignmentUser", "tags": [ "EmpAlignmentUserController" ], "description": "", "responses": { "200": { "description": "Return value of EmpAlignmentUserController.approvalAlignmentUser", "content": {} } }, "parameters": [ { "name": "brokerId", "in": "query", "schema": { "type": "number" } }, { "name": "apUserId", "in": "query", "schema": { "type": "number" } } ], "operationId": "EmpAlignmentUserController.approvalAlignmentUser" } }, "/ap-carrier-send-statement-list": { "post": { "x-controller-name": "ApSendStatementController", "x-operation-name": "getSelectedStatementData", "tags": [ "ApSendStatementController" ], "description": "", "responses": { "200": { "description": "Array of CarrierPayment model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CarrierPaymentWithRelations" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "ApSendStatementController.getSelectedStatementData" } }, "/ap-change-histories/{id}/shipment": { "get": { "x-controller-name": "ApChangeHistoryShipmentController", "x-operation-name": "getShipment", "tags": [ "ApChangeHistoryShipmentController" ], "responses": { "200": { "description": "Shipment belonging to ApChangeHistory", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Shipment" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ApChangeHistoryShipmentController.getShipment" } }, "/ap-change-histories/{id}/user": { "get": { "x-controller-name": "ApChangeHistoryUserController", "x-operation-name": "getUser", "tags": [ "ApChangeHistoryUserController" ], "responses": { "200": { "description": "User belonging to ApChangeHistory", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ApChangeHistoryUserController.getUser" } }, "/ap-change-status-pro-histories": { "get": { "x-controller-name": "OpenProHistoryController", "x-operation-name": "findAPChangeStatusProHistories", "tags": [ "OpenProHistoryController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar pro openrequest |\n", "responses": { "200": { "description": "Array of OpenProHistory model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenProHistoryWithRelations" } } } } } }, "parameters": [ { "name": "page", "in": "query", "schema": { "type": "number" } }, { "name": "pageSize", "in": "query", "schema": { "type": "number" } } ], "operationId": "OpenProHistoryController.findAPChangeStatusProHistories" } }, "/ap-details/{id}/carriers": { "get": { "x-controller-name": "ApDetailsCarriersController", "x-operation-name": "getCarriers", "tags": [ "ApDetailsCarriersController" ], "responses": { "200": { "description": "Carriers belonging to ApDetails", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Carriers" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ApDetailsCarriersController.getCarriers" } }, "/ap-email-to-carriers/count": { "get": { "x-controller-name": "ApEmailToCarrierController", "x-operation-name": "count", "tags": [ "ApEmailToCarrierController" ], "responses": { "200": { "description": "ApEmailToCarrier model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "ApEmailToCarrier.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "ApEmailToCarrierController.count" } }, "/ap-email-to-carriers/{id}/carriers": { "get": { "x-controller-name": "ApEmailToCarrierCarriersController", "x-operation-name": "getCarriers", "tags": [ "ApEmailToCarrierCarriersController" ], "responses": { "200": { "description": "Carriers belonging to ApEmailToCarrier", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Carriers" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ApEmailToCarrierCarriersController.getCarriers" } }, "/ap-email-to-carriers/{id}/portal": { "get": { "x-controller-name": "ApEmailToCarrierPortalController", "x-operation-name": "getPortal", "tags": [ "ApEmailToCarrierPortalController" ], "responses": { "200": { "description": "Portal belonging to ApEmailToCarrier", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Portal" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ApEmailToCarrierPortalController.getPortal" } }, "/ap-email-to-carriers/{id}/shipment": { "get": { "x-controller-name": "ApEmailToCarrierShipmentController", "x-operation-name": "getShipment", "tags": [ "ApEmailToCarrierShipmentController" ], "responses": { "200": { "description": "Shipment belonging to ApEmailToCarrier", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Shipment" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ApEmailToCarrierShipmentController.getShipment" } }, "/ap-email-to-carriers/{id}": { "put": { "x-controller-name": "ApEmailToCarrierController", "x-operation-name": "replaceById", "tags": [ "ApEmailToCarrierController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "ApEmailToCarrier PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApEmailToCarrier" } } }, "x-parameter-index": 1 }, "operationId": "ApEmailToCarrierController.replaceById" }, "patch": { "x-controller-name": "ApEmailToCarrierController", "x-operation-name": "updateById", "tags": [ "ApEmailToCarrierController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "ApEmailToCarrier PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApEmailToCarrierPartial" } } }, "x-parameter-index": 1 }, "operationId": "ApEmailToCarrierController.updateById" }, "get": { "x-controller-name": "ApEmailToCarrierController", "x-operation-name": "findById", "tags": [ "ApEmailToCarrierController" ], "responses": { "200": { "description": "ApEmailToCarrier model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApEmailToCarrierWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApEmailToCarrier.Filter" } } } } ], "operationId": "ApEmailToCarrierController.findById" }, "delete": { "x-controller-name": "ApEmailToCarrierController", "x-operation-name": "deleteById", "tags": [ "ApEmailToCarrierController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "ApEmailToCarrier DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ApEmailToCarrierController.deleteById" } }, "/ap-email-to-carriers": { "post": { "x-controller-name": "ApEmailToCarrierController", "x-operation-name": "create", "tags": [ "ApEmailToCarrierController" ], "responses": { "200": { "description": "ApEmailToCarrier model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApEmailToCarrier" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "notes": { "type": "string", "description": " " }, "shipmentId": { "type": "number", "description": " " }, "paymentType": { "type": "string", "description": " " }, "attachment": { "type": "string" } } } } } }, "operationId": "ApEmailToCarrierController.create" }, "patch": { "x-controller-name": "ApEmailToCarrierController", "x-operation-name": "updateAll", "tags": [ "ApEmailToCarrierController" ], "responses": { "200": { "description": "ApEmailToCarrier PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "ApEmailToCarrier.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApEmailToCarrierPartial" } } } }, "operationId": "ApEmailToCarrierController.updateAll" }, "get": { "x-controller-name": "ApEmailToCarrierController", "x-operation-name": "find", "tags": [ "ApEmailToCarrierController" ], "responses": { "200": { "description": "Array of ApEmailToCarrier model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ApEmailToCarrierWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApEmailToCarrier.Filter1" } } } } ], "operationId": "ApEmailToCarrierController.find" } }, "/ap-incentives/{id}/shipment": { "get": { "x-controller-name": "ApIncentiveShipmentController", "x-operation-name": "getShipment", "tags": [ "ApIncentiveShipmentController" ], "responses": { "200": { "description": "Shipment belonging to ApIncentive", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Shipment" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ApIncentiveShipmentController.getShipment" } }, "/ap-incentives/{id}/user": { "get": { "x-controller-name": "ApIncentiveUserController", "x-operation-name": "getUser", "tags": [ "ApIncentiveUserController" ], "responses": { "200": { "description": "User belonging to ApIncentive", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ApIncentiveUserController.getUser" } }, "/ap-messages-histories/count": { "get": { "x-controller-name": "ApMessageHistoryController", "x-operation-name": "count", "tags": [ "ApMessageHistoryController" ], "responses": { "200": { "description": "ApMessagesHistory model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "ApMessagesHistory.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "ApMessageHistoryController.count" } }, "/ap-messages-histories/latest/{shipmentId}": { "get": { "x-controller-name": "ApMessageHistoryController", "x-operation-name": "findLatestByShipmentId", "tags": [ "ApMessageHistoryController" ], "responses": { "200": { "description": "Latest ApMessagesHistory model instance for a given shipmentId", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApMessagesHistoryWithRelations" } } } } }, "parameters": [ { "name": "shipmentId", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ApMessageHistoryController.findLatestByShipmentId" } }, "/ap-messages-histories/{id}": { "put": { "x-controller-name": "ApMessageHistoryController", "x-operation-name": "replaceById", "tags": [ "ApMessageHistoryController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "ApMessagesHistory PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApMessagesHistory" } } }, "x-parameter-index": 1 }, "operationId": "ApMessageHistoryController.replaceById" }, "patch": { "x-controller-name": "ApMessageHistoryController", "x-operation-name": "updateById", "tags": [ "ApMessageHistoryController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "ApMessagesHistory PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApMessagesHistoryPartial" } } }, "x-parameter-index": 1 }, "operationId": "ApMessageHistoryController.updateById" }, "get": { "x-controller-name": "ApMessageHistoryController", "x-operation-name": "findById", "tags": [ "ApMessageHistoryController" ], "responses": { "200": { "description": "ApMessagesHistory model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApMessagesHistoryWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApMessagesHistory.Filter" } } } } ], "operationId": "ApMessageHistoryController.findById" }, "delete": { "x-controller-name": "ApMessageHistoryController", "x-operation-name": "deleteById", "tags": [ "ApMessageHistoryController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "ApMessagesHistory DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ApMessageHistoryController.deleteById" } }, "/ap-messages-histories": { "post": { "x-controller-name": "ApMessageHistoryController", "x-operation-name": "create", "tags": [ "ApMessageHistoryController" ], "responses": { "200": { "description": "ApMessagesHistory model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApMessagesHistory" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewApMessagesHistory" } } } }, "operationId": "ApMessageHistoryController.create" }, "patch": { "x-controller-name": "ApMessageHistoryController", "x-operation-name": "updateAll", "tags": [ "ApMessageHistoryController" ], "responses": { "200": { "description": "ApMessagesHistory PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "ApMessagesHistory.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApMessagesHistoryPartial" } } } }, "operationId": "ApMessageHistoryController.updateAll" }, "get": { "x-controller-name": "ApMessageHistoryController", "x-operation-name": "find", "tags": [ "ApMessageHistoryController" ], "responses": { "200": { "description": "Array of ApMessagesHistory model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ApMessagesHistoryWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApMessagesHistory.Filter1" } } } } ], "operationId": "ApMessageHistoryController.find" } }, "/ap-send-carrier-statement-report": { "post": { "x-controller-name": "ApSendStatementController", "x-operation-name": "sendStatementData", "tags": [ "ApSendStatementController" ], "description": "", "responses": { "200": { "description": "Array of Shipment and invoices model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CarrierPaymentWithRelations" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "ApSendStatementController.sendStatementData" } }, "/ap-send-payments/{id}/carrier-payment": { "get": { "x-controller-name": "ApSendPaymentCarrierPaymentController", "x-operation-name": "getCarrierPayment", "tags": [ "ApSendPaymentCarrierPaymentController" ], "responses": { "200": { "description": "CarrierPayment belonging to ApSendPayment", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CarrierPayment" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ApSendPaymentCarrierPaymentController.getCarrierPayment" } }, "/ap-send-payments/{id}/portal": { "get": { "x-controller-name": "ApSendPaymentPortalController", "x-operation-name": "getPortal", "tags": [ "ApSendPaymentPortalController" ], "responses": { "200": { "description": "Portal belonging to ApSendPayment", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Portal" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ApSendPaymentPortalController.getPortal" } }, "/ap-send-payments/{id}/shipment": { "get": { "x-controller-name": "ApSendPaymentShipmentController", "x-operation-name": "getShipment", "tags": [ "ApSendPaymentShipmentController" ], "responses": { "200": { "description": "Shipment belonging to ApSendPayment", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Shipment" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ApSendPaymentShipmentController.getShipment" } }, "/ap-send-payments/{id}/user": { "get": { "x-controller-name": "ApSendPaymentUserController", "x-operation-name": "getUser", "tags": [ "ApSendPaymentUserController" ], "responses": { "200": { "description": "User belonging to ApSendPayment", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ApSendPaymentUserController.getUser" } }, "/ap-statement-carrier-data": { "get": { "x-controller-name": "ApSendStatementController", "x-operation-name": "AllStatementData", "tags": [ "ApSendStatementController" ], "description": "", "responses": { "200": { "description": "Array of CarrierPayment model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CarrierPaymentWithRelations" } } } } } }, "parameters": [ { "name": "carriersId", "in": "query", "schema": { "type": "string" } } ], "operationId": "ApSendStatementController.AllStatementData" } }, "/ap-update-shipment-rate-not-finalized": { "post": { "x-controller-name": "ApSendStatementController", "x-operation-name": "create", "tags": [ "ApSendStatementController" ], "description": "", "responses": { "200": { "description": "Shippers History model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Shippers" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "ApSendStatementController.create" } }, "/api/analytics/crash": { "post": { "x-controller-name": "AppAnalyticsController", "x-operation-name": "saveCrash", "tags": [ "AppAnalyticsController" ], "description": "", "responses": { "200": { "description": "Save crash", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "app_id", "date" ], "properties": { "app_id": { "type": "string" }, "device_id": { "type": "string" }, "error_message": { "type": "string" }, "stack_trace": { "type": "string" }, "os": { "type": "string" } } } } }, "required": true }, "operationId": "AppAnalyticsController.saveCrash" } }, "/api/analytics/dashboard": { "get": { "x-controller-name": "AppAnalyticsController", "x-operation-name": "dashboard", "tags": [ "AppAnalyticsController" ], "description": "", "responses": { "200": { "description": "Analytics dashboard", "content": { "application/json": { "schema": { "type": "array" } } } } }, "parameters": [ { "name": "app_id", "in": "query", "schema": { "type": "string" } }, { "name": "start_date", "in": "query", "schema": { "type": "string" } }, { "name": "end_date", "in": "query", "schema": { "type": "string" } }, { "name": "platform", "in": "query", "schema": { "type": "string" } } ], "operationId": "AppAnalyticsController.dashboard" } }, "/api/analytics/dimension": { "get": { "x-controller-name": "AppAnalyticsController", "x-operation-name": "dimension", "tags": [ "AppAnalyticsController" ], "description": "", "responses": { "200": { "description": "Analytics dimension report", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "app_id", "in": "query", "schema": { "type": "string" } }, { "name": "dimension", "in": "query", "schema": { "type": "string" } }, { "name": "start_date", "in": "query", "schema": { "type": "string" } }, { "name": "end_date", "in": "query", "schema": { "type": "string" } }, { "name": "platform", "in": "query", "schema": { "type": "string" } } ], "operationId": "AppAnalyticsController.dimension" } }, "/api/analytics/install": { "post": { "x-controller-name": "AppAnalyticsController", "x-operation-name": "saveInstall", "tags": [ "AppAnalyticsController" ], "description": "", "responses": { "200": { "description": "Save install", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "app_id", "device_id", "date", "platform" ], "properties": { "app_id": { "type": "string" }, "device_id": { "type": "string" }, "date": { "type": "string" }, "source": { "type": "string" }, "device_type": { "type": "string" }, "country": { "type": "string" }, "platform": { "type": "string" } } } } }, "required": true }, "operationId": "AppAnalyticsController.saveInstall" } }, "/api/analytics/track": { "post": { "x-controller-name": "AppAnalyticsController", "x-operation-name": "track", "tags": [ "AppAnalyticsController" ], "description": "", "responses": { "200": { "description": "Track metric", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "app_id", "metric", "platform" ], "properties": { "app_id": { "type": "string" }, "metric": { "type": "string" }, "amount": { "type": "number" }, "device_id": { "type": "string" }, "platform": { "type": "string" } } } } }, "required": true }, "operationId": "AppAnalyticsController.track" } }, "/api/aone-ff/shipments/{loadNo}": { "get": { "x-controller-name": "CommonApiController", "x-operation-name": "getAoneFfShipmentByShipmentNo", "tags": [ "CommonApiController" ], "description": "", "responses": { "200": { "description": "Get shipment by loadNo", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "$ref": "#/components/schemas/ShipmentWithRelations" } } } } } } }, "parameters": [ { "name": "loadNo", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "CommonApiController.getAoneFfShipmentByShipmentNo" } }, "/api/app-settings/{type}/{platform}": { "post": { "x-controller-name": "AppSettingsController", "x-operation-name": "updateAppSetting", "tags": [ "AppSettingsController" ], "description": "", "responses": { "200": { "description": "AppSettings model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AppSettingsWithRelations" } } } } }, "parameters": [ { "name": "type", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "platform", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "version": { "type": "string", "description": "App version (e.g., 1.0.0)" }, "description": { "type": "string", "description": "App description or release notes" }, "confirm_pickup_radius": { "type": "string", "description": "Confirm pickup radius (e.g., 10)" } } } } }, "description": "App settings update payload", "required": true, "x-parameter-index": 2 }, "operationId": "AppSettingsController.updateAppSetting" } }, "/api/broker-list": { "get": { "x-controller-name": "CommonAiControllerController", "x-operation-name": "getBrokerUserList", "tags": [ "CommonAiControllerController" ], "description": "", "responses": { "200": { "description": "Array of users with name, email, and designation", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "real_name": { "type": "string" }, "email": { "type": "string" }, "designation": { "type": "string" } } } }, "total": { "type": "number" } } } } } } }, "parameters": [ { "name": "type", "in": "query", "schema": { "type": "number" } } ], "operationId": "CommonAiControllerController.getBrokerUserList" } }, "/api/carrier/advance-pay-labels": { "get": { "x-controller-name": "CarrierAdvancePayRequestsController", "x-operation-name": "getActiveAdvancePayLabels", "tags": [ "CarrierAdvancePayRequestsController" ], "description": "", "responses": { "200": { "description": "Get all active carrier advance pay labels", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "array" } } } } } } }, "operationId": "CarrierAdvancePayRequestsController.getActiveAdvancePayLabels" } }, "/api/carrier/advance-pay-request/{advancePayRequestId}": { "get": { "x-controller-name": "CarrierAdvancePayRequestsController", "x-operation-name": "getCarrierAdvancePayRequestById", "tags": [ "CarrierAdvancePayRequestsController" ], "description": "", "responses": { "200": { "description": "Get carrier advance pay request details by ID", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object" } } } } } } }, "parameters": [ { "name": "advancePayRequestId", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CarrierAdvancePayRequestsController.getCarrierAdvancePayRequestById" } }, "/api/carrier/advance-pay-request": { "post": { "x-controller-name": "CarrierAdvancePayRequestsController", "x-operation-name": "createCarrierAdvancePayRequest", "tags": [ "CarrierAdvancePayRequestsController" ], "description": "", "responses": { "200": { "description": "Create carrier advance pay request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object" } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "labelId", "amount", "shipmentId" ], "properties": { "labelId": { "type": "number" }, "amount": { "type": "number" }, "advancePayMode": { "type": "number" }, "remarks": { "type": "string" }, "shipmentId": { "type": "number" } } } } }, "required": true }, "operationId": "CarrierAdvancePayRequestsController.createCarrierAdvancePayRequest" } }, "/api/carrier/cancel-advance-pay-request/{advancePayRequestId}": { "post": { "x-controller-name": "CarrierAdvancePayRequestsController", "x-operation-name": "cancelCarrierAdvancePayRequestById", "tags": [ "CarrierAdvancePayRequestsController" ], "description": "", "responses": { "200": { "description": "Cancel carrier advance pay request by ID", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object" } } } } } } }, "parameters": [ { "name": "advancePayRequestId", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CarrierAdvancePayRequestsController.cancelCarrierAdvancePayRequestById" } }, "/api/carrier/cancel-invoice-request/{invoiceRequestId}": { "post": { "x-controller-name": "CarrierInvoicesController", "x-operation-name": "cancelCarrierInvoiceRequestById", "tags": [ "CarrierInvoicesController" ], "description": "", "responses": { "200": { "description": "Cancel carrier invoice request by invoice request ID", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object" } } } } } } }, "parameters": [ { "name": "invoiceRequestId", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CarrierInvoicesController.cancelCarrierInvoiceRequestById" } }, "/api/carrier/carrier-aging-shipments": { "get": { "x-controller-name": "CarrierShipmentController", "x-operation-name": "getCarrierAgingShipments", "tags": [ "CarrierShipmentController" ], "responses": { "200": { "description": "Get all shipments for logged-in carrier from carrier aging table", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CarrierAgingWithRelations" } }, "totalCount": { "type": "number" }, "page": { "type": "number" }, "pageSize": { "type": "number" }, "totalPages": { "type": "number" } } } } } } }, "parameters": [ { "name": "page", "in": "query", "schema": { "type": "number" } }, { "name": "pageSize", "in": "query", "schema": { "type": "number" } } ], "operationId": "CarrierShipmentController.getCarrierAgingShipments" } }, "/api/carrier/carrier-confirm-delivery/{shipmentId}": { "get": { "x-controller-name": "CarrierShipmentController", "x-operation-name": "getCarrierConfirmDelivery", "tags": [ "CarrierShipmentController" ], "responses": { "200": { "description": "Get carrier confirm delivery by shipment ID", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "$ref": "#/components/schemas/CarrierConfirmDelivery" } } } } } } }, "parameters": [ { "name": "shipmentId", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CarrierShipmentController.getCarrierConfirmDelivery" } }, "/api/carrier/carrier-confirm-delivery": { "post": { "x-controller-name": "CarrierShipmentController", "x-operation-name": "upsertCarrierConfirmDelivery", "tags": [ "CarrierShipmentController" ], "description": "", "responses": { "200": { "description": "Insert or update carrier confirm delivery data with file upload", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "$ref": "#/components/schemas/CarrierConfirmDelivery" } } } } } } }, "requestBody": { "content": { "multipart/form-data": { "x-parser": "stream", "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } } } } }, "description": "Request body for multipart/form-data based file upload", "required": true }, "operationId": "CarrierShipmentController.upsertCarrierConfirmDelivery" } }, "/api/carrier/carrier-documents/{shipmentId}": { "get": { "x-controller-name": "CarrierShipmentController", "x-operation-name": "getCarrierDocuments", "tags": [ "CarrierShipmentController" ], "responses": { "200": { "description": "Get carrier documents by shipment ID", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "$ref": "#/components/schemas/CarrierDocs" } } } } } } }, "parameters": [ { "name": "shipmentId", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CarrierShipmentController.getCarrierDocuments" } }, "/api/carrier/carrier-documents-delete": { "post": { "x-controller-name": "CarrierShipmentController", "x-operation-name": "deleteCarrierDocument", "tags": [ "CarrierShipmentController" ], "description": "", "responses": { "200": { "description": "Delete carrier document by shipment ID and type", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "shipmentId", "type" ], "properties": { "shipmentId": { "type": "number", "description": "Shipment ID" }, "type": { "type": "string", "description": "Document type to delete (pod, lumper, tri, commodity, other, invoice)", "enum": [ "pod", "lumper", "tri", "commodity", "other", "invoice" ] } } } } }, "description": "Delete carrier document request", "required": true }, "operationId": "CarrierShipmentController.deleteCarrierDocument" } }, "/api/carrier/carrier-invoices/detail/{carrierinvoiceid}": { "get": { "x-controller-name": "CarrierInvoicesController", "x-operation-name": "getCarrierInvoiceById", "tags": [ "CarrierInvoicesController" ], "description": "", "responses": { "200": { "description": "Return value of CarrierInvoicesController.getCarrierInvoiceById", "content": {} } }, "parameters": [ { "name": "carrierinvoiceid", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CarrierInvoicesController.getCarrierInvoiceById" } }, "/api/carrier/carrier-invoices": { "get": { "x-controller-name": "CarrierInvoicesController", "x-operation-name": "getCarrierInvoicesByCarrierLoginId", "tags": [ "CarrierInvoicesController" ], "responses": { "200": { "description": "Get carrier invoices by carrier login ID", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "array" } } } } } } }, "parameters": [ { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "shipmentId", "in": "query", "schema": { "type": "string" } }, { "name": "invoiceNumber", "in": "query", "schema": { "type": "string" } }, { "name": "status", "in": "query", "schema": { "type": "string" } }, { "name": "period", "in": "query", "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "number" } }, { "name": "pageSize", "in": "query", "schema": { "type": "number" } } ], "operationId": "CarrierInvoicesController.getCarrierInvoicesByCarrierLoginId" } }, "/api/carrier/carrier-payments": { "get": { "x-controller-name": "CarrierShipmentController", "x-operation-name": "getCarrierPayments", "tags": [ "CarrierShipmentController" ], "responses": { "200": { "description": "Get all carrier payment details for logged-in carrier", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CarrierPaymentWithRelations" } }, "totalCount": { "type": "number" }, "page": { "type": "number" }, "pageSize": { "type": "number" }, "totalPages": { "type": "number" } } } } } } }, "parameters": [ { "name": "page", "in": "query", "schema": { "type": "number" } }, { "name": "pageSize", "in": "query", "schema": { "type": "number" } } ], "operationId": "CarrierShipmentController.getCarrierPayments" } }, "/api/carrier/carrier-shipment-tracking": { "post": { "x-controller-name": "CarrierShipmentController", "x-operation-name": "createCarrierShipmentTracking", "tags": [ "CarrierShipmentController" ], "description": "", "responses": { "200": { "description": "Create or update carrier shipment tracking entry", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "$ref": "#/components/schemas/CarrierShipmentTracking" } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "shipmentId", "latitude", "longitude" ], "properties": { "latitude": { "type": "string" }, "longitude": { "type": "string" }, "status": { "type": "number" } } } } }, "description": "Carrier shipment tracking payload", "required": true }, "operationId": "CarrierShipmentController.createCarrierShipmentTracking" }, "get": { "x-controller-name": "CarrierShipmentController", "x-operation-name": "getCarrierShipmentTracking", "tags": [ "CarrierShipmentController" ], "responses": { "200": { "description": "Get carrier shipment tracking details", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "$ref": "#/components/schemas/CarrierShipmentTracking" } } } } } } }, "operationId": "CarrierShipmentController.getCarrierShipmentTracking" } }, "/api/carrier/carrier-shipments/details/{uid}": { "get": { "x-controller-name": "CarrierShipmentController", "x-operation-name": "getShipmentDetailsByUid", "tags": [ "CarrierShipmentController" ], "description": "", "responses": { "200": { "description": "Get shipment details by UID for authenticated carrier", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipmentWithRelations" } } } } }, "parameters": [ { "name": "uid", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "CarrierShipmentController.getShipmentDetailsByUid" } }, "/api/carrier/get-advance-pay-requests": { "get": { "x-controller-name": "CarrierAdvancePayRequestsController", "x-operation-name": "getCarrierAdvancePayRequests", "tags": [ "CarrierAdvancePayRequestsController" ], "description": "", "responses": { "200": { "description": "Get carrier advance pay requests with filters", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "array" }, "totalCount": { "type": "number" }, "totalPages": { "type": "number" }, "page": { "type": "number" }, "pageSize": { "type": "number" } } } } } } }, "parameters": [ { "name": "requestNumber", "in": "query", "schema": { "type": "string" } }, { "name": "shipmentId", "in": "query", "schema": { "type": "number" } }, { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "status", "in": "query", "schema": { "type": "string" } }, { "name": "period", "in": "query", "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "number" } }, { "name": "pageSize", "in": "query", "schema": { "type": "number" } } ], "operationId": "CarrierAdvancePayRequestsController.getCarrierAdvancePayRequests" } }, "/api/carrier/get-invoice-request": { "get": { "x-controller-name": "CarrierInvoicesController", "x-operation-name": "getCarrierInvoiceRequestsByCarrierLoginId", "tags": [ "CarrierInvoicesController" ], "description": "", "responses": { "200": { "description": "Get carrier invoice requests by carrier login ID", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "array" }, "totalCount": { "type": "number" }, "totalPages": { "type": "number" }, "page": { "type": "number" }, "pageSize": { "type": "number" } } } } } } }, "parameters": [ { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "status", "in": "query", "schema": { "type": "string" } }, { "name": "period", "in": "query", "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "number" } }, { "name": "pageSize", "in": "query", "schema": { "type": "number" } } ], "operationId": "CarrierInvoicesController.getCarrierInvoiceRequestsByCarrierLoginId" } }, "/api/carrier/invoice-request/{invoiceRequestId}": { "get": { "x-controller-name": "CarrierInvoicesController", "x-operation-name": "getCarrierInvoiceRequestById", "tags": [ "CarrierInvoicesController" ], "description": "", "responses": { "200": { "description": "Get a single carrier invoice request by ID", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object" } } } } } } }, "parameters": [ { "name": "invoiceRequestId", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CarrierInvoicesController.getCarrierInvoiceRequestById" } }, "/api/carrier/invoice-request": { "post": { "x-controller-name": "CarrierInvoicesController", "x-operation-name": "createCarrierInvoiceRequest", "tags": [ "CarrierInvoicesController" ], "description": "", "responses": { "200": { "description": "Create carrier invoice request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "number" }, "carrierLoginId": { "type": "number" }, "carriersId": { "type": "number" }, "shipmentId": { "type": "number" }, "request_type": { "type": "number" }, "remark": { "type": "string" }, "request_status": { "type": "number" } } } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "shipmentId", "requestTypeId" ], "properties": { "shipmentId": { "type": "number" }, "requestTypeId": { "type": "number" }, "remarks": { "type": "string" } } } } }, "required": true }, "operationId": "CarrierInvoicesController.createCarrierInvoiceRequest" } }, "/api/carrier/invoice-request-types": { "get": { "x-controller-name": "CarrierInvoicesController", "x-operation-name": "getActiveInvoiceRequestTypes", "tags": [ "CarrierInvoicesController" ], "description": "", "responses": { "200": { "description": "Get all active carrier invoice request type names", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "array" } } } } } } }, "operationId": "CarrierInvoicesController.getActiveInvoiceRequestTypes" } }, "/api/carrier/login": { "post": { "x-controller-name": "CarrierAuthControllerController", "x-operation-name": "login", "tags": [ "CarrierAuthControllerController" ], "responses": { "200": { "description": "Token", "content": { "application/json": { "schema": { "type": "object", "properties": { "token": { "type": "string" } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "email", "password" ], "properties": { "email": { "type": "string", "format": "email" }, "password": { "type": "string", "minLength": 6 } } } } }, "description": "The input of login function", "required": true }, "operationId": "CarrierAuthControllerController.login" } }, "/api/carrier/loginotp": { "post": { "x-controller-name": "CarrierAuthControllerController", "x-operation-name": "loginOtp", "tags": [ "CarrierAuthControllerController" ], "responses": { "200": { "description": "OTP Login Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string", "format": "email" } } } } }, "description": "The input of login function", "required": true }, "operationId": "CarrierAuthControllerController.loginOtp" } }, "/api/carrier/verifyotp": { "post": { "x-controller-name": "CarrierAuthControllerController", "x-operation-name": "verifyOtp", "tags": [ "CarrierAuthControllerController" ], "responses": { "200": { "description": "OTP Verification Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "userData": { "type": "object" }, "accessToken": { "type": "string" } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "email", "otp" ], "properties": { "email": { "type": "string", "format": "email" }, "otp": { "type": "number", "minLength": 6 } } } } }, "description": "The input of login function", "required": true }, "operationId": "CarrierAuthControllerController.verifyOtp" } }, "/api/carrier-action-logs-all": { "get": { "x-controller-name": "CarrierLoginLogController", "x-operation-name": "getCarrierActionLogsGroupedArrays", "tags": [ "CarrierLoginLogController" ], "description": "", "responses": { "200": { "description": "Get carrier action logs grouped by carrier login ID with actions and counts as arrays", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "array", "items": { "type": "object", "properties": { "carrierLoginId": { "type": "number" }, "name": { "type": "string" }, "email": { "type": "string" }, "phone": { "type": "string" }, "source": { "type": "string" }, "actionCounts": { "type": "object", "additionalProperties": { "type": "number" } } } } }, "totalCount": { "type": "number" }, "page": { "type": "number" }, "pageSize": { "type": "number" }, "totalPages": { "type": "number" }, "totals": { "type": "object", "additionalProperties": { "type": "number" } }, "modules": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "key": { "type": "string" } } } } } } } } } }, "parameters": [ { "name": "platform", "in": "query", "schema": { "type": "string" } }, { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "number" } }, { "name": "pageSize", "in": "query", "schema": { "type": "number" } } ], "operationId": "CarrierLoginLogController.getCarrierActionLogsGroupedArrays" } }, "/api/carrier-drivers/all": { "get": { "x-controller-name": "CarrierDriverController", "x-operation-name": "getAllCarrierDrivers", "tags": [ "CarrierDriverController" ], "description": "", "responses": { "200": { "description": "Get all drivers for a carrier", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "email": { "type": "string" }, "phone": { "type": "string" }, "name": { "type": "string" }, "role": { "type": "number" }, "switchRole": { "type": "number" }, "status": { "type": "number" }, "profile_image": { "type": "string" }, "cdl_doc": { "type": "string" }, "softDelete": { "type": "number" }, "createdAt": { "type": "string" }, "relationshipId": { "type": "number" } } } }, "totalCount": { "type": "number" } } } } } } }, "parameters": [ { "name": "carrierId", "in": "query", "schema": { "type": "number" } }, { "name": "name", "in": "query", "schema": { "type": "string" } }, { "name": "phone", "in": "query", "schema": { "type": "string" } }, { "name": "email", "in": "query", "schema": { "type": "string" } }, { "name": "status", "in": "query", "schema": { "type": "number" } }, { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "isVerified", "in": "query", "schema": { "type": "number" } }, { "name": "softDelete", "in": "query", "schema": { "type": "number" } } ], "operationId": "CarrierDriverController.getAllCarrierDrivers" } }, "/api/carrier-drivers/assign-shipment": { "post": { "x-controller-name": "CarrierDriverController", "x-operation-name": "assignShipmentToDriver", "tags": [ "CarrierDriverController" ], "description": "", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Assign shipment to driver" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "driverId", "shipmentId" ], "properties": { "driverId": { "type": "number" }, "shipmentId": { "type": "number" } } } } }, "description": "Assign shipment to driver request", "required": true }, "operationId": "CarrierDriverController.assignShipmentToDriver" } }, "/api/carrier-drivers/change-role": { "post": { "x-controller-name": "CarrierDriverController", "x-operation-name": "changeCarrierRole", "tags": [ "CarrierDriverController" ], "description": "", "responses": { "200": { "description": "Change carrier role", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "role" ], "properties": { "role": { "type": "number", "description": "Role (mandatory)" } } } } }, "description": "Change carrier role request", "required": true }, "operationId": "CarrierDriverController.changeCarrierRole" } }, "/api/carrier-drivers/get-assign-driver-list": { "get": { "x-controller-name": "CarrierDriverController", "x-operation-name": "assignDriverList", "tags": [ "CarrierDriverController" ], "description": "", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Assign driver list" } } } } }, "parameters": [ { "name": "name", "in": "query", "schema": { "type": "string" } }, { "name": "phone", "in": "query", "schema": { "type": "string" } }, { "name": "email", "in": "query", "schema": { "type": "string" } }, { "name": "search", "in": "query", "schema": { "type": "string" } } ], "operationId": "CarrierDriverController.assignDriverList" } }, "/api/carrier-drivers/info/{carrierLoginId}": { "get": { "x-controller-name": "CarrierDriverController", "x-operation-name": "getDriverInfoByCarrierLoginId", "tags": [ "CarrierDriverController" ], "description": "", "responses": { "200": { "description": "Get driver info by carrier login id", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "number" }, "email": { "type": "string" }, "phone": { "type": "string" }, "name": { "type": "string" }, "role": { "type": "number" }, "switchRole": { "type": "number" }, "status": { "type": "number" }, "profile_image": { "type": "string" }, "cdl_doc": { "type": "string" }, "softDelete": { "type": "number" }, "createdAt": { "type": "string" }, "relationshipId": { "type": "number" } } } } } } } } }, "parameters": [ { "name": "carrierLoginId", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CarrierDriverController.getDriverInfoByCarrierLoginId" } }, "/api/carrier-drivers/profile-update": { "post": { "x-controller-name": "CarrierDriverController", "x-operation-name": "updateDriverProfile", "tags": [ "CarrierDriverController" ], "description": "", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Update driver profile" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "driverId", "name", "phone", "email" ], "properties": { "driverId": { "type": "number" }, "name": { "type": "string" }, "phone": { "type": "string" }, "email": { "type": "string" } } } } }, "description": "Update driver profile request", "required": true }, "operationId": "CarrierDriverController.updateDriverProfile" } }, "/api/carrier-drivers/shipment-tracking": { "get": { "x-controller-name": "CarrierDriverController", "x-operation-name": "DriverShipmentTracking", "tags": [ "CarrierDriverController" ], "description": "", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Shipment tracking" } } } } }, "parameters": [ { "name": "driverId", "in": "query", "schema": { "type": "number" } } ], "operationId": "CarrierDriverController.DriverShipmentTracking" } }, "/api/carrier-drivers/soft-delete": { "post": { "x-controller-name": "CarrierDriverController", "x-operation-name": "softDeleteDriver", "tags": [ "CarrierDriverController" ], "description": "", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Soft delete a driver" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "driverId", "softDelete" ], "properties": { "driverId": { "type": "number" }, "softDelete": { "type": "number" } } } } }, "description": "Soft delete a driver request", "required": true }, "operationId": "CarrierDriverController.softDeleteDriver" } }, "/api/carrier-drivers/switch-role": { "post": { "x-controller-name": "CarrierDriverController", "x-operation-name": "switchDriverRole", "tags": [ "CarrierDriverController" ], "description": "", "responses": { "200": { "description": "Change carrrier role", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "role" ], "properties": { "role": { "type": "string", "description": "Role (mandatory)" } } } } }, "description": "Change carrier role request", "required": true }, "operationId": "CarrierDriverController.switchDriverRole" } }, "/api/carrier-login/send-app-link": { "get": { "x-controller-name": "CarrierDriverController", "x-operation-name": "carrierLoginSendAPPlink", "tags": [ "CarrierDriverController" ], "description": "", "responses": { "200": { "description": "Carrier Send APP Link", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } } } } } }, "parameters": [ { "name": "email", "in": "query", "schema": { "type": "string" } } ], "operationId": "CarrierDriverController.carrierLoginSendAPPlink" } }, "/api/carrier-login-logs/login-logout": { "post": { "x-controller-name": "CarrierLoginLogController", "x-operation-name": "CarrierLoginLogout", "tags": [ "CarrierLoginLogController" ], "responses": { "200": { "description": "Carrier login log created successfully" } }, "description": "", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "status" ], "properties": { "status": { "type": "number", "description": "1 for login, 0 for logout" } } } } }, "description": "Carrier login log request", "required": true }, "operationId": "CarrierLoginLogController.CarrierLoginLogout" } }, "/api/carrier-register/check-invite-code": { "get": { "x-controller-name": "CarrierRegisterController", "x-operation-name": "checkInviteCode", "tags": [ "CarrierRegisterController" ], "responses": { "200": { "description": "Invite code existence check", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "exists": { "type": "boolean" }, "message": { "type": "string" } } } } } } }, "description": "", "parameters": [ { "name": "inviteCode", "in": "query", "schema": { "type": "string" }, "required": true } ], "operationId": "CarrierRegisterController.checkInviteCode" } }, "/api/carrier-register/check-mc": { "get": { "x-controller-name": "CarrierRegisterController", "x-operation-name": "checkMcRegistered", "tags": [ "CarrierRegisterController" ], "responses": { "200": { "description": "MC number carrier / carrier login existence check", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "carrierExists": { "type": "boolean" }, "hasCarrierLogin": { "type": "boolean" }, "carrierId": { "type": "number" }, "carrierLoginId": { "type": "number" }, "message": { "type": "string" } } } } } } }, "description": "", "parameters": [ { "name": "mc", "in": "query", "schema": { "type": "string" }, "required": true }, { "name": "type", "in": "query", "schema": { "type": "string" }, "required": true } ], "operationId": "CarrierRegisterController.checkMcRegistered" } }, "/api/carrier-register/driver": { "post": { "x-controller-name": "CarrierRegisterController", "x-operation-name": "registerDriver", "tags": [ "CarrierRegisterController" ], "responses": { "200": { "description": "Linked driver to dispatcher via invite code", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "driverLoginId": { "type": "number" }, "dispatcherLoginId": { "type": "number" }, "inviteCode": { "type": "string" } } } } } } } } }, "description": "", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "inviteCode" ], "properties": { "inviteCode": { "type": "string", "description": "Invite code stored on the dispatcher carrier_login row." } } } } }, "description": "Invite code from the carrier/dispatcher account only.", "required": true }, "operationId": "CarrierRegisterController.registerDriver" } }, "/api/carrier-register": { "post": { "x-controller-name": "CarrierRegisterController", "x-operation-name": "registerCarrier", "tags": [ "CarrierRegisterController" ], "responses": { "200": { "description": "Carrier registration response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "$ref": "#/components/schemas/CarrierLogin" }, "accessToken": { "type": "string" } } } } } } }, "description": "", "operationId": "CarrierRegisterController.registerCarrier" } }, "/api/carrierlogin/all-notifications": { "post": { "x-controller-name": "CarrierLoginController", "x-operation-name": "getAllNotificationsForUser", "tags": [ "CarrierLoginController" ], "description": "", "responses": { "200": { "description": "Fetch all notifications and optionally mark all as read", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "array", "items": { "type": "object", "properties": { "title": { "type": "string" }, "msg": { "type": "string" }, "readStatus": { "type": "number" }, "time": { "type": "string" }, "type": { "type": "string" }, "shipmentUid": { "type": "string" } } } }, "totalCount": { "type": "number" }, "currentPage": { "type": "number" }, "totalPages": { "type": "number" }, "pageSize": { "type": "number" } } } } } } }, "parameters": [ { "name": "page", "in": "query", "schema": { "type": "number" } }, { "name": "pageSize", "in": "query", "schema": { "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "readStatus": { "type": "string", "enum": [ "1" ] } } } } }, "description": "Optional readStatus to mark all notifications as read", "required": false, "x-parameter-index": 2 }, "operationId": "CarrierLoginController.getAllNotificationsForUser" } }, "/api/carrierlogin/allcrc": { "get": { "x-controller-name": "CarrierShipmentController", "x-operation-name": "getCRCNotifications", "tags": [ "CarrierShipmentController" ], "responses": { "200": { "description": "Fetch CRC notifications (type 1) for current carrier with optional date filtering", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "array", "items": { "type": "object" } }, "page": { "type": "number" }, "pageSize": { "type": "number" }, "totalCount": { "type": "number" }, "totalPages": { "type": "number" } } } } } } }, "parameters": [ { "name": "status", "in": "query", "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "schema": { "type": "string" } }, { "name": "latest", "in": "query", "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "string" } }, { "name": "pageSize", "in": "query", "schema": { "type": "string" } } ], "operationId": "CarrierShipmentController.getCRCNotifications" } }, "/api/carrierlogin/carrier-shipments": { "get": { "x-controller-name": "CarrierShipmentController", "x-operation-name": "getCarrierShipments", "tags": [ "CarrierShipmentController" ], "description": "", "responses": { "200": { "description": "Get all shipments for carrier with pagination and filtering", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "array", "items": { "type": "object" } }, "page": { "type": "number" }, "pageSize": { "type": "number" }, "totalCount": { "type": "number" }, "totalPages": { "type": "number" } } } } } } }, "parameters": [ { "name": "status", "in": "query", "schema": { "type": "string" } }, { "name": "period", "in": "query", "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "string" } }, { "name": "pageSize", "in": "query", "schema": { "type": "string" } }, { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "driverId", "in": "query", "schema": { "type": "number" } }, { "name": "dispatcherId", "in": "query", "schema": { "type": "number" } } ], "operationId": "CarrierShipmentController.getCarrierShipments" } }, "/api/carrierlogin/carrier-stats": { "get": { "x-controller-name": "CarrierShipmentController", "x-operation-name": "getCarrierStats", "tags": [ "CarrierShipmentController" ], "responses": { "200": { "description": "Get carrier statistics including total shipments, pending shipments, and total payment", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "totalShipments": { "type": "number" }, "pendingShipments": { "type": "number" }, "totalPayment": { "type": "number" }, "carrierLoginId": { "type": "number" } } } } } } } } }, "parameters": [ { "name": "period", "in": "query", "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "schema": { "type": "string" } }, { "name": "driverId", "in": "query", "schema": { "type": "number" } }, { "name": "dispatcherId", "in": "query", "schema": { "type": "number" } } ], "operationId": "CarrierShipmentController.getCarrierStats" } }, "/api/carrierlogin/cdl-data": { "post": { "x-controller-name": "CarrierLoginController", "x-operation-name": "saveCarrierCdlData", "tags": [ "CarrierLoginController" ], "description": "", "responses": { "200": { "description": "Carrier CDL data save result", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object" } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "name", "dob", "gender", "licenseNo", "issueDate", "validity", "address", "status" ], "properties": { "name": { "type": "string", "description": "Full name of the driver" }, "licenseNo": { "type": "string", "description": "Driver license number" }, "validity": { "type": "string", "description": "License validity period" }, "status": { "type": "string", "description": "License status" }, "dob": { "type": "string", "description": "Date of birth" }, "gender": { "type": "string", "description": "Gender" }, "issueDate": { "type": "string", "description": "License issue date" }, "address": { "type": "string", "description": "Driver address" } } } } }, "description": "Carrier CDL data payload", "required": true }, "operationId": "CarrierLoginController.saveCarrierCdlData" } }, "/api/carrierlogin/change-password": { "post": { "x-controller-name": "CarrierLoginController", "x-operation-name": "changePassword", "tags": [ "CarrierLoginController" ], "responses": { "200": { "description": "Change password response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } } } } } }, "description": "", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "oldPassword", "newPassword" ], "properties": { "oldPassword": { "type": "string", "minLength": 6, "description": "Current password" }, "newPassword": { "type": "string", "minLength": 6, "description": "New password (minimum 6 characters)" } } } } }, "description": "Change password request", "required": true }, "operationId": "CarrierLoginController.changePassword" } }, "/api/carrierlogin/crc-signin": { "post": { "x-controller-name": "CarrierShipmentController", "x-operation-name": "carrierSigningCrc", "tags": [ "CarrierShipmentController" ], "responses": { "200": { "description": "Merge PDF with images and save to signDoc table", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "signDocId": { "type": "number" }, "signedDocUrl": { "type": "string" } } } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "uid", "status" ], "properties": { "uid": { "type": "string" }, "signatures": { "type": "string" }, "status": { "type": "number" } }, "additionalProperties": false } } } }, "operationId": "CarrierShipmentController.carrierSigningCrc" } }, "/api/carrierlogin/crcdetails/{uid}": { "get": { "x-controller-name": "CarrierShipmentController", "x-operation-name": "getCRCNotificationById", "tags": [ "CarrierShipmentController" ], "responses": { "200": { "description": "Fetch single CRC details by ID for current carrier", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "array", "items": { "type": "object" } } } } } } } }, "parameters": [ { "name": "uid", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "CarrierShipmentController.getCRCNotificationById" } }, "/api/carrierlogin/device-token": { "post": { "x-controller-name": "CarrierLoginController", "x-operation-name": "updateDeviceToken", "tags": [ "CarrierLoginController" ], "description": "", "responses": { "200": { "description": "Device token update result", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "deviceToken", "deviceType" ], "properties": { "deviceToken": { "type": "string", "description": "The device token to update" }, "deviceType": { "type": "string", "enum": [ "ios", "android" ], "description": "Type of the device" } } } } }, "description": "Device token update payload", "required": true }, "operationId": "CarrierLoginController.updateDeviceToken" } }, "/api/carrierlogin/email-login": { "post": { "x-controller-name": "CarrierLoginController", "x-operation-name": "carrierEmailLogin", "tags": [ "CarrierLoginController" ], "responses": { "200": { "description": "Carrier login response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "$ref": "#/components/schemas/CarrierLogin" } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string", "description": "Email" } } } } }, "description": "Carrier login with email", "required": true }, "operationId": "CarrierLoginController.carrierEmailLogin" } }, "/api/carrierlogin/emailpassword-login": { "post": { "x-controller-name": "CarrierLoginController", "x-operation-name": "carrierEmailPasswordLogin", "tags": [ "CarrierLoginController" ], "responses": { "200": { "description": "Carrier login response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "$ref": "#/components/schemas/CarrierLogin" }, "accessToken": { "type": "string" } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "email", "password" ], "properties": { "email": { "type": "string", "description": "Email" }, "password": { "type": "string", "description": "Password" } } } } }, "description": "Carrier login with email and password", "required": true }, "operationId": "CarrierLoginController.carrierEmailPasswordLogin" } }, "/api/carrierlogin/forgot-password": { "post": { "x-controller-name": "CarrierLoginController", "x-operation-name": "forgotPassword", "tags": [ "CarrierLoginController" ], "responses": { "200": { "description": "Forgot password response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } } } } } }, "description": "", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string", "format": "email", "description": "Carrier email address" } } } } }, "description": "Forgot password request", "required": true }, "operationId": "CarrierLoginController.forgotPassword" } }, "/api/carrierlogin/generate-invite-code": { "post": { "x-controller-name": "CarrierRegisterController", "x-operation-name": "generateInviteCode", "tags": [ "CarrierRegisterController" ], "responses": { "200": { "description": "Generate or fetch the invite code for the logged-in carrier", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "inviteCode": { "type": "string" } } } } } } }, "description": "", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "regenerate": { "type": "boolean", "description": "If true, replace any existing invite code with a freshly generated one. Defaults to false." } } } } }, "description": "Optional regenerate flag. When true, a new invite code is always generated; otherwise the existing one (if any) is returned.", "required": false }, "operationId": "CarrierRegisterController.generateInviteCode" } }, "/api/carrierlogin/logout": { "post": { "x-controller-name": "CarrierLoginController", "x-operation-name": "carrierLogout", "tags": [ "CarrierLoginController" ], "description": "", "responses": { "200": { "description": "Carrier logout response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } } } } } }, "operationId": "CarrierLoginController.carrierLogout" } }, "/api/carrierlogin/phone-login": { "post": { "x-controller-name": "CarrierLoginController", "x-operation-name": "carrierPhoneLogin", "tags": [ "CarrierLoginController" ], "responses": { "200": { "description": "Carrier login response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "$ref": "#/components/schemas/CarrierLogin" } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "phone" ], "properties": { "phone": { "type": "string", "description": "phone number" } } } } }, "description": "Carrier login with email or phone", "required": true }, "operationId": "CarrierLoginController.carrierPhoneLogin" } }, "/api/carrierlogin/profile/me": { "get": { "x-controller-name": "CarrierLoginController", "x-operation-name": "getCarrierProfileget", "tags": [ "CarrierLoginController" ], "description": "", "responses": { "200": { "description": "Return value of CarrierLoginController.getCarrierProfileget", "content": {} } }, "operationId": "CarrierLoginController.getCarrierProfileget" } }, "/api/carrierlogin/profile": { "get": { "x-controller-name": "CarrierLoginController", "x-operation-name": "getCarrierProfile", "tags": [ "CarrierLoginController" ], "description": "", "responses": { "200": { "description": "Get carrier profile from JWT token", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "$ref": "#/components/schemas/CarrierLogin" } } } } } } }, "operationId": "CarrierLoginController.getCarrierProfile" } }, "/api/carrierlogin/refresh-token": { "post": { "x-controller-name": "CarrierLoginController", "x-operation-name": "refreshCarrierAccessToken", "tags": [ "CarrierLoginController" ], "responses": { "200": { "description": "New carrier access token", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "accessToken": { "type": "string" } } } } } } }, "description": "", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "carrierLoginId" ], "properties": { "carrierLoginId": { "type": "number", "description": "Must match the carrier login id embedded in the current Bearer token" } } } } }, "required": true }, "operationId": "CarrierLoginController.refreshCarrierAccessToken" } }, "/api/carrierlogin/reset-password": { "post": { "x-controller-name": "CarrierLoginController", "x-operation-name": "resetPassword", "tags": [ "CarrierLoginController" ], "responses": { "200": { "description": "Reset password response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } } } } } }, "description": "", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "email", "newPassword" ], "properties": { "email": { "type": "string", "format": "email", "description": "Carrier email address" }, "newPassword": { "type": "string", "minLength": 6, "description": "New password (minimum 6 characters)" } } } } }, "description": "Reset password request", "required": true }, "operationId": "CarrierLoginController.resetPassword" } }, "/api/carrierlogin/update-company-profile": { "patch": { "x-controller-name": "CarrierLoginController", "x-operation-name": "updateCompanyProfile", "tags": [ "CarrierLoginController" ], "responses": { "200": { "description": "Carrier profile update result", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object" } } } } } } }, "requestBody": { "content": { "multipart/form-data": { "x-parser": "stream", "schema": { "type": "object", "properties": { "company_name": { "type": "string" }, "company_logo": { "type": "string", "format": "binary" } } } } }, "description": "Carrier profile update with image", "required": true }, "operationId": "CarrierLoginController.updateCompanyProfile" } }, "/api/carrierlogin/update-profile": { "patch": { "x-controller-name": "CarrierLoginController", "x-operation-name": "updateCarrierProfile", "tags": [ "CarrierLoginController" ], "responses": { "200": { "description": "Carrier profile update result", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object" } } } } } } }, "requestBody": { "content": { "multipart/form-data": { "x-parser": "stream", "schema": { "type": "object", "properties": { "name": { "type": "string" }, "phone": { "type": "string" }, "profile_image": { "type": "string", "format": "binary" } } } } }, "description": "Carrier profile update with image", "required": true }, "operationId": "CarrierLoginController.updateCarrierProfile" } }, "/api/carrierlogin/update-twofactor": { "post": { "x-controller-name": "CarrierLoginController", "x-operation-name": "updateTwoFactor", "tags": [ "CarrierLoginController" ], "description": "", "responses": { "200": { "description": "Toggle two factor authentication setting (automatically toggles: 0 becomes 1, 1 becomes 0)", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "number" }, "twoFactor": { "type": "number" } } } } } } } } }, "operationId": "CarrierLoginController.updateTwoFactor" } }, "/api/carrierlogin/upload-cdl": { "post": { "x-controller-name": "CarrierLoginController", "x-operation-name": "CarrierLoginUploadCdl", "tags": [ "CarrierLoginController" ], "responses": { "200": { "description": "Upload CDL document", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } } } } } }, "requestBody": { "content": { "multipart/form-data": { "x-parser": "stream", "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } } } } }, "description": "Request body for multipart/form-data based file upload", "required": true }, "operationId": "CarrierLoginController.CarrierLoginUploadCdl" } }, "/api/carrierlogin/upload-documents": { "post": { "x-controller-name": "CarrierShipmentController", "x-operation-name": "uploadCarrierDocuments", "tags": [ "CarrierShipmentController" ], "responses": { "200": { "description": "Upload all carrier documents (POD, Invoice, Lumper, Commodity, TRI) in one request", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object" } } } } } } }, "requestBody": { "content": { "multipart/form-data": { "x-parser": "stream", "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } } } } }, "description": "Request body for multipart/form-data based file upload", "required": true }, "operationId": "CarrierShipmentController.uploadCarrierDocuments" } }, "/api/carrierlogin/verify-otp": { "post": { "x-controller-name": "CarrierLoginController", "x-operation-name": "verifyOTP", "tags": [ "CarrierLoginController" ], "responses": { "200": { "description": "OTP verification response", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "verified": { "type": "boolean" }, "carrierData": { "$ref": "#/components/schemas/CarrierLogin" } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "identifier", "otp" ], "properties": { "identifier": { "type": "string", "description": "Email or phone number" }, "otp": { "type": "string", "description": "OTP code to verify" } } } } }, "description": "Verify OTP for carrier login", "required": true }, "operationId": "CarrierLoginController.verifyOTP" } }, "/api/carrierlogin/verify-phone-otp": { "post": { "x-controller-name": "CarrierLoginController", "x-operation-name": "verifyPhoneOTP", "tags": [ "CarrierLoginController" ], "responses": { "200": { "description": "Phone OTP verification response", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "verified": { "type": "boolean" }, "carrierData": { "$ref": "#/components/schemas/CarrierLogin" } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "identifier", "otp" ], "properties": { "identifier": { "type": "string", "description": "Phone number" }, "otp": { "type": "string", "description": "Phone OTP code to verify" } } } } }, "description": "Verify Phone OTP for carrier login", "required": true }, "operationId": "CarrierLoginController.verifyPhoneOTP" } }, "/api/carriers/CRC/{id}": { "get": { "x-controller-name": "CarrierShipment2Controller", "x-operation-name": "findCRC", "tags": [ "CarrierShipment2Controller" ], "responses": { "200": { "description": "Array of Shipments belonging to Carrier", "content": { "application/json": { "schema": { "type": "object", "properties": { "shipmentDetails": { "type": "object" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CarrierShipment2Controller.findCRC" } }, "/api/carriers/shipments/{shipmentId}": { "get": { "x-controller-name": "CarrierShipment2Controller", "x-operation-name": "findShipmentsbyId", "tags": [ "CarrierShipment2Controller" ], "responses": { "200": { "description": " Shipment data belonging to Carrier", "content": { "application/json": { "schema": { "type": "object", "properties": { "shipmentDetails": { "type": "object" } } } } } } }, "parameters": [ { "name": "shipmentId", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CarrierShipment2Controller.findShipmentsbyId" } }, "/api/carriers/sign-pdf/{id}": { "post": { "x-controller-name": "CarrierShipment2Controller", "x-operation-name": "signPdf", "tags": [ "CarrierShipment2Controller" ], "responses": { "200": { "description": "Signatured PDF", "content": { "application/pdf": { "schema": { "type": "string" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "signatures" ], "properties": { "signatures": { "type": "string" } } } } }, "x-parameter-index": 1 }, "operationId": "CarrierShipment2Controller.signPdf" } }, "/api/carriers/{id}/CRC": { "get": { "x-controller-name": "CarrierShipment2Controller", "x-operation-name": "listCRC", "tags": [ "CarrierShipment2Controller" ], "responses": { "200": { "description": "Array of Shipments belonging to Carrier", "content": { "application/json": { "schema": { "type": "object", "properties": { "shipmentDetails": { "type": "object" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CarrierShipment2Controller.listCRC" } }, "/api/carriers/{id}/invoice": { "get": { "x-controller-name": "CarrierShipment2Controller", "x-operation-name": "findInvoice", "tags": [ "CarrierShipment2Controller" ], "responses": { "200": { "description": "Array of Invoice belonging to Carrier", "content": { "application/json": { "schema": { "type": "object", "properties": { "shipmentDetails": { "type": "object" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CarrierShipment2Controller.findInvoice" } }, "/api/carriers/{id}/profile": { "get": { "x-controller-name": "CarrierShipment2Controller", "x-operation-name": "findProfile", "tags": [ "CarrierShipment2Controller" ], "responses": { "200": { "description": "Array of Profile belonging to Carrier", "content": { "application/json": { "schema": { "type": "object", "properties": { "shipmentDetails": { "type": "object" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CarrierShipment2Controller.findProfile" } }, "/api/carriers/{id}/recentshipments": { "get": { "x-controller-name": "CarrierShipment2Controller", "x-operation-name": "findrecentShipments", "tags": [ "CarrierShipment2Controller" ], "responses": { "200": { "description": "Array of Shipments belonging to Carrier", "content": { "application/json": { "schema": { "type": "object", "properties": { "currentShipments": { "type": "number" }, "completedShipments": { "type": "number" }, "totalEarningsLastMonth": { "type": "object" }, "pendingEarnings": { "type": "number" }, "shipmentDetails": { "type": "object" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CarrierShipment2Controller.findrecentShipments" } }, "/api/carriers/{id}/shipments": { "get": { "x-controller-name": "CarrierShipment2Controller", "x-operation-name": "findShipments", "tags": [ "CarrierShipment2Controller" ], "responses": { "200": { "description": "Array of Shipments belonging to Carrier", "content": { "application/json": { "schema": { "type": "object", "properties": { "currentShipments": { "type": "number" }, "completedShipments": { "type": "number" }, "totalEarningsLastMonth": { "type": "object" }, "pendingEarnings": { "type": "number" }, "shipmentDetails": { "type": "object" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CarrierShipment2Controller.findShipments" } }, "/api/driver-login/create": { "post": { "x-controller-name": "CarrierDriverController", "x-operation-name": "createDriverLogin", "tags": [ "CarrierDriverController" ], "description": "", "responses": { "200": { "description": "Create driver login", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "id": { "type": "number" }, "email": { "type": "string" }, "phone": { "type": "string" }, "role": { "type": "number" } } } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "email", "carrierId" ], "properties": { "email": { "type": "string", "description": "Email address (mandatory)" }, "userId": { "type": "number", "description": "User ID (mandatory)" }, "name": { "type": "string", "description": "Driver Name (optional)" }, "phone": { "type": "string", "description": "Phone number (optional)" } } } } }, "description": "Driver login creation payload", "required": true }, "operationId": "CarrierDriverController.createDriverLogin" } }, "/api/face-verify": { "post": { "x-controller-name": "FaceVerificationController", "x-operation-name": "verify", "tags": [ "FaceVerificationController" ], "responses": { "200": { "description": "Return value of FaceVerificationController.verify" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "idImage", "selfieImage" ], "properties": { "idImage": { "type": "string" }, "selfieImage": { "type": "string" } } } } } }, "operationId": "FaceVerificationController.verify" } }, "/api/get-dispatchers-by-driver": { "post": { "x-controller-name": "CarrierDriverController", "x-operation-name": "getDispatchersByDriver", "tags": [ "CarrierDriverController" ], "description": "", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Get dispatchers by driver" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "driverId" ], "properties": { "driverId": { "type": "number" }, "page": { "type": "number" }, "pageSize": { "type": "number" }, "search": { "type": "string" } } } } }, "description": "Get dispatchers by driver request", "required": true }, "operationId": "CarrierDriverController.getDispatchersByDriver" } }, "/api/get-loads-list": { "get": { "x-controller-name": "CommonAiControllerController", "x-operation-name": "getLoadsList", "tags": [ "CommonAiControllerController" ], "description": "", "responses": { "200": { "description": "Array of loads with load_status = 1", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object" } }, "total": { "type": "number" } } } } } } }, "parameters": [ { "name": "last7Days", "in": "query", "schema": { "type": "boolean" } } ], "operationId": "CommonAiControllerController.getLoadsList" } }, "/api/merge-docs": { "post": { "x-controller-name": "ApiServiceController", "x-operation-name": "mergepdfs", "tags": [ "ApiServiceController" ], "responses": { "200": { "description": "Shipment model instance", "content": { "application/pdf": { "schema": { "type": "string", "format": "binary" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "urls": { "type": "array", "items": { "type": "string" } } } } } } }, "operationId": "ApiServiceController.mergepdfs" } }, "/api/send-multiple-emails": { "post": { "x-controller-name": "EmailMarketingController", "x-operation-name": "sendMultipleEmails", "tags": [ "EmailMarketingController" ], "responses": { "200": { "description": "Return value of EmailMarketingController.sendMultipleEmails" } }, "operationId": "EmailMarketingController.sendMultipleEmails" } }, "/api/send-silent-push-all-users": { "get": { "x-controller-name": "MobileAppController", "x-operation-name": "sendSilentPushToAllUsers", "tags": [ "MobileAppController" ], "description": "", "responses": { "200": { "description": "Send silent push notification to all users", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "totalTokens": { "type": "number" }, "successCount": { "type": "number" }, "failureCount": { "type": "number" } } } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "description": "Optional data payload for silent notification", "additionalProperties": true } } } } }, "description": "Silent push notification payload", "required": false }, "operationId": "MobileAppController.sendSilentPushToAllUsers" } }, "/api/shipments/latest-10-records": { "get": { "x-controller-name": "CommonApiController", "x-operation-name": "latest10Shipments", "tags": [ "CommonApiController" ], "description": "", "responses": { "200": { "description": "Latest 10 shipments with shipmentPrices, shipmentPicks, and shipmentDrops", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ShipmentWithRelations" } } } } } }, "operationId": "CommonApiController.latest10Shipments" } }, "/api/sign-request/serve-pdf/{requestId}": { "get": { "x-controller-name": "SignRequestController", "x-operation-name": "servePDF", "tags": [ "SignRequestController" ], "responses": { "200": { "description": "Return value of SignRequestController.servePDF" } }, "parameters": [ { "name": "requestId", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "SignRequestController.servePDF" } }, "/api/sign-request/serve-signed-pdf/{requestId}": { "get": { "x-controller-name": "SignRequestController", "x-operation-name": "serveSignedPDF", "tags": [ "SignRequestController" ], "responses": { "200": { "description": "Return value of SignRequestController.serveSignedPDF" } }, "parameters": [ { "name": "requestId", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "SignRequestController.serveSignedPDF" } }, "/api/sign-request/submit-signed-document/{requestId}": { "post": { "x-controller-name": "SignRequestController", "x-operation-name": "submitSignedDocument", "tags": [ "SignRequestController" ], "responses": { "200": { "description": "Return value of SignRequestController.submitSignedDocument" } }, "parameters": [ { "name": "requestId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "authorization", "in": "query", "schema": { "type": "string" } } ], "operationId": "SignRequestController.submitSignedDocument" } }, "/api/user/logs/installed-apps": { "get": { "x-controller-name": "MobileAppController", "x-operation-name": "getFirebaseTokenStatistics", "tags": [ "MobileAppController" ], "description": "", "responses": { "200": { "description": "Firebase token statistics", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "object", "properties": { "totalAndroidTokens": { "type": "number" }, "totalIosTokens": { "type": "number" }, "totalRecords": { "type": "number" } } } } } } } } }, "operationId": "MobileAppController.getFirebaseTokenStatistics" } }, "/api/user-login-logs/login-logout": { "post": { "x-controller-name": "UserLoginLogController", "x-operation-name": "loginLogout", "tags": [ "UserLoginLogController" ], "responses": { "200": { "description": "User login log response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } } } } } }, "description": "", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "status" ], "properties": { "status": { "type": "number", "description": "1 for login, 0 for logout" } } } } }, "description": "User login log request", "required": true }, "operationId": "UserLoginLogController.loginLogout" } }, "/api/vl/broker-list": { "get": { "x-controller-name": "CommonApiController", "x-operation-name": "getBrokerList", "tags": [ "CommonApiController" ], "description": "", "responses": { "200": { "description": "Return value of CommonApiController.getBrokerList", "content": {} } }, "operationId": "CommonApiController.getBrokerList" } }, "/api/vl/zipcodes": { "get": { "x-controller-name": "CommonApiController", "x-operation-name": "getZipCodes", "tags": [ "CommonApiController" ], "description": "", "responses": { "200": { "description": "Get zipcodes (optionally filter by zip)", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ZipCodes" } }, "totalCount": { "type": "number" }, "page": { "type": "number" }, "pageSize": { "type": "number" }, "totalPages": { "type": "number" } } } } } } }, "parameters": [ { "name": "zip", "in": "query", "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "number" } }, { "name": "pageSize", "in": "query", "schema": { "type": "number" } } ], "operationId": "CommonApiController.getZipCodes" } }, "/approve/ap/status/change": { "get": { "x-controller-name": "RoleUserController", "x-operation-name": "approveAPStatusChange", "tags": [ "RoleUserController" ], "description": "", "responses": { "200": { "description": "Return value of RoleUserController.approveAPStatusChange", "content": {} } }, "parameters": [ { "name": "MainId", "in": "query", "schema": { "type": "string" } } ], "operationId": "RoleUserController.approveAPStatusChange" } }, "/approve-ar-cpr-requests": { "post": { "x-controller-name": "ArCprInvoiceRequestController", "x-operation-name": "approveCpr", "tags": [ "ArCprInvoiceRequestController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker view cprInvoiceRequest |\n", "responses": { "200": { "description": "Return value of ArCprInvoiceRequestController.approveCpr", "content": {} }, "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "cpr patch success" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "ArCprInvoiceRequestController.approveCpr" } }, "/approve-ar-invoice-request": { "post": { "x-controller-name": "ArCprInvoiceRequestController", "x-operation-name": "approveInvoice", "tags": [ "ArCprInvoiceRequestController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker view cprInvoiceRequest |\n", "responses": { "200": { "description": "Return value of ArCprInvoiceRequestController.approveInvoice", "content": {} }, "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "invoice patch success" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "ArCprInvoiceRequestController.approveInvoice" } }, "/approve-cpr-by-email/{id}": { "get": { "x-controller-name": "ArCprInvoiceRequestController", "x-operation-name": "CprApproveByEmail", "tags": [ "ArCprInvoiceRequestController" ], "responses": { "200": { "description": "McVerification model instance", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "user", "in": "query", "schema": { "type": "string" } } ], "operationId": "ArCprInvoiceRequestController.CprApproveByEmail" } }, "/approve-inv-request-by-email/{id}": { "get": { "x-controller-name": "ArCprInvoiceRequestController", "x-operation-name": "ApproveInvoiceByEmail", "tags": [ "ArCprInvoiceRequestController" ], "responses": { "200": { "description": "McVerification model instance", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "user", "in": "query", "schema": { "type": "string" } } ], "operationId": "ArCprInvoiceRequestController.ApproveInvoiceByEmail" } }, "/approve-invoice-request-by-email/{id}/{portalId}/{type}": { "get": { "x-controller-name": "ArCprInvoiceRequestController", "x-operation-name": "ApproveInvoiceRequestByEmail", "tags": [ "ArCprInvoiceRequestController" ], "responses": { "200": { "description": "McVerification model instance", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "portalId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "type", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "ArCprInvoiceRequestController.ApproveInvoiceRequestByEmail" } }, "/approve-shipper-status": { "post": { "x-controller-name": "ArShippersController", "x-operation-name": "approve_shipper_status", "tags": [ "ArShippersController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar approve shipper |\n", "responses": { "200": { "description": "Shippers History model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Shippers" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "ArShippersController.approve_shipper_status" } }, "/approve-ssl-payment": { "post": { "x-controller-name": "ShipmentController", "x-operation-name": "approveSslPayment", "tags": [ "ShipmentController" ], "description": "", "responses": { "200": { "description": "Return value of ShipmentController.approveSslPayment", "content": {} } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "ShipmentController.approveSslPayment" } }, "/approved-cpr-shipment/{uid}": { "get": { "x-controller-name": "AuditorController", "x-operation-name": "approvedCprShipment", "tags": [ "AuditorController" ], "responses": { "200": { "description": "ShipmentPicks model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipmentPicksWithRelations" } } } } }, "parameters": [ { "name": "uid", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "AuditorController.approvedCprShipment" } }, "/approved-ip-address/{id}": { "get": { "x-controller-name": "AuthController", "x-operation-name": "ApproveByIpAddress", "tags": [ "AuthController" ], "responses": { "200": { "description": "IpAddress model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "AuthController.ApproveByIpAddress" } }, "/ar/broker-incentive-asi": { "get": { "x-controller-name": "DatratemateController", "x-operation-name": "UpdateASIIncentivesProDate", "tags": [ "DatratemateController" ], "responses": { "200": { "description": "Return value of DatratemateController.UpdateASIIncentivesProDate" } }, "parameters": [ { "name": "date", "in": "query", "schema": { "type": "string" } } ], "operationId": "DatratemateController.UpdateASIIncentivesProDate" } }, "/ar/broker-incentive-asi-get-allpro": { "get": { "x-controller-name": "DatratemateController", "x-operation-name": "ARBrokerIncentiveASIGetAllPro", "tags": [ "DatratemateController" ], "responses": { "200": { "description": "Return value of DatratemateController.ARBrokerIncentiveASIGetAllPro" } }, "parameters": [ { "name": "date", "in": "query", "schema": { "type": "string" } }, { "name": "userId", "in": "query", "schema": { "type": "string" } } ], "operationId": "DatratemateController.ARBrokerIncentiveASIGetAllPro" } }, "/ar/broker-incentive-vl-get-all-pending-pro-drayage-team": { "get": { "x-controller-name": "DatratemateController", "x-operation-name": "ArBrokerIncentiveAllPendingProDrayageTeam", "tags": [ "DatratemateController" ], "responses": { "200": { "description": "Return value of DatratemateController.ArBrokerIncentiveAllPendingProDrayageTeam" } }, "parameters": [ { "name": "date", "in": "query", "schema": { "type": "string" } }, { "name": "userId", "in": "query", "schema": { "type": "string" } } ], "operationId": "DatratemateController.ArBrokerIncentiveAllPendingProDrayageTeam" } }, "/ar/broker-incentive-vl-get-allpro-drayage-team": { "get": { "x-controller-name": "DatratemateController", "x-operation-name": "ArBrokerIncentiveVLGetAllProDrayageTeam", "tags": [ "DatratemateController" ], "responses": { "200": { "description": "Return value of DatratemateController.ArBrokerIncentiveVLGetAllProDrayageTeam" } }, "parameters": [ { "name": "date", "in": "query", "schema": { "type": "string" } }, { "name": "userId", "in": "query", "schema": { "type": "string" } } ], "operationId": "DatratemateController.ArBrokerIncentiveVLGetAllProDrayageTeam" } }, "/ar/broker-incentive-vl-otr-incentives-new-policy": { "get": { "x-controller-name": "DatratemateController", "x-operation-name": "UpdateVLOTRIncentivesProWithNewPolicyDate", "tags": [ "DatratemateController" ], "responses": { "200": { "description": "Return value of DatratemateController.UpdateVLOTRIncentivesProWithNewPolicyDate" } }, "parameters": [ { "name": "date", "in": "query", "schema": { "type": "string" } } ], "operationId": "DatratemateController.UpdateVLOTRIncentivesProWithNewPolicyDate" } }, "/ar/broker-incentive-vl-update-months-drayage-team": { "get": { "x-controller-name": "DatratemateController", "x-operation-name": "UpdateCalenderValueLoadsBrokers", "tags": [ "DatratemateController" ], "responses": { "200": { "description": "Return value of DatratemateController.UpdateCalenderValueLoadsBrokers" } }, "operationId": "DatratemateController.UpdateCalenderValueLoadsBrokers" } }, "/ar/get/broker-incentive-drayage": { "get": { "x-controller-name": "DatratemateController", "x-operation-name": "GetDrayageBrokerIncentives", "tags": [ "DatratemateController" ], "description": "", "responses": { "200": { "description": "Return value of DatratemateController.GetDrayageBrokerIncentives", "content": {} } }, "parameters": [ { "name": "date", "in": "query", "schema": { "type": "string" } } ], "operationId": "DatratemateController.GetDrayageBrokerIncentives" } }, "/ar/get-incentive-asi-tl": { "get": { "x-controller-name": "DatratemateController", "x-operation-name": "GetIncentivesASITL", "tags": [ "DatratemateController" ], "responses": { "200": { "description": "Return value of DatratemateController.GetIncentivesASITL" } }, "parameters": [ { "name": "date", "in": "query", "schema": { "type": "string" } } ], "operationId": "DatratemateController.GetIncentivesASITL" } }, "/ar/get-incentive-drayage-team-manager": { "get": { "x-controller-name": "DatratemateController", "x-operation-name": "GetDrayageIncentivesTeamManager", "tags": [ "DatratemateController" ], "description": "", "responses": { "200": { "description": "Return value of DatratemateController.GetDrayageIncentivesTeamManager", "content": {} } }, "parameters": [ { "name": "date", "in": "query", "schema": { "type": "string" } } ], "operationId": "DatratemateController.GetDrayageIncentivesTeamManager" } }, "/ar/get-incentive-drayage-tl": { "get": { "x-controller-name": "DatratemateController", "x-operation-name": "GetDrayageIncentivesTL", "tags": [ "DatratemateController" ], "description": "", "responses": { "200": { "description": "Return value of DatratemateController.GetDrayageIncentivesTL", "content": {} } }, "parameters": [ { "name": "date", "in": "query", "schema": { "type": "string" } } ], "operationId": "DatratemateController.GetDrayageIncentivesTL" } }, "/ar/import-incentiveold-from-qwerty": { "post": { "x-controller-name": "OtrIncentiveController", "x-operation-name": "importIncentiveOldFromQwerty", "tags": [ "OtrIncentiveController" ], "responses": { "200": { "description": "Import broker incentive monthly data from qwerty into incentiveold", "content": { "application/json": { "schema": { "type": "object", "properties": { "processed": { "type": "number" }, "inserted": { "type": "number" }, "updated": { "type": "number" }, "date": { "type": "string" } } } } } } }, "parameters": [ { "name": "date", "in": "query", "schema": { "type": "string" } } ], "operationId": "OtrIncentiveController.importIncentiveOldFromQwerty" } }, "/ar/import-incentivetlold-from-qwerty": { "post": { "x-controller-name": "OtrIncentiveController", "x-operation-name": "importIncentiveTlOldFromQwerty", "tags": [ "OtrIncentiveController" ], "responses": { "200": { "description": "Import TL incentive monthly data from qwerty into incentivetlold", "content": { "application/json": { "schema": { "type": "object", "properties": { "processed": { "type": "number" }, "inserted": { "type": "number" }, "updated": { "type": "number" }, "date": { "type": "string" } } } } } } }, "parameters": [ { "name": "date", "in": "query", "schema": { "type": "string" } } ], "operationId": "OtrIncentiveController.importIncentiveTlOldFromQwerty" } }, "/ar/locked-incentive": { "get": { "x-controller-name": "BrokerIncentiveController", "x-operation-name": "getLockedIncentive", "tags": [ "BrokerIncentiveController" ], "responses": { "200": { "description": "Locked Incentive Data", "content": { "application/json": { "schema": { "type": "object", "properties": { "incentive": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "tLIncentive": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "manageIncentive": { "type": "array", "items": { "type": "object", "additionalProperties": true } } } } } } } }, "parameters": [ { "name": "date", "in": "query", "schema": { "type": "string" } } ], "operationId": "BrokerIncentiveController.getLockedIncentive" } }, "/ar/locked-otr-incentive": { "get": { "x-controller-name": "OtrIncentiveController", "x-operation-name": "getLockedOtrIncentive", "tags": [ "OtrIncentiveController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar view incentive |\n", "responses": { "200": { "description": "Locked OTR Incentive Data", "content": { "application/json": { "schema": { "type": "object", "properties": { "incentive": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "tLIncentive": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "manageIncentive": { "type": "array", "items": { "type": "object", "additionalProperties": true } } } } } } } }, "parameters": [ { "name": "date", "in": "query", "schema": { "type": "string" } } ], "operationId": "OtrIncentiveController.getLockedOtrIncentive" } }, "/ar/locked-otr-incentive-mail": { "post": { "x-controller-name": "OtrIncentiveController", "x-operation-name": "sendLockedOtrIncentiveEmail", "tags": [ "OtrIncentiveController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar view incentive |\n", "responses": { "200": { "description": "Locked OTR Incentive Data emailed successfully", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "OtrIncentiveController.sendLockedOtrIncentiveEmail" } }, "/ar/locked-otr-incentive-new-policy": { "get": { "x-controller-name": "OtrIncentiveController", "x-operation-name": "getLockedOtrIncentiveNewPolicy", "tags": [ "OtrIncentiveController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar view incentive |\n", "responses": { "200": { "description": "Locked OTR Incentive Data", "content": { "application/json": { "schema": { "type": "object", "properties": { "incentive": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "tLIncentive": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "manageIncentive": { "type": "array", "items": { "type": "object", "additionalProperties": true } } } } } } } }, "parameters": [ { "name": "date", "in": "query", "schema": { "type": "string" } } ], "operationId": "OtrIncentiveController.getLockedOtrIncentiveNewPolicy" } }, "/ar/notes": { "post": { "x-controller-name": "ArNotesController", "x-operation-name": "create", "tags": [ "ArNotesController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar view note |\n", "responses": { "200": { "description": "Notes model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Notes" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "ArNotesController.create" } }, "/ar/shippers/{id}": { "patch": { "x-controller-name": "ArShippersController", "x-operation-name": "updateById", "tags": [ "ArShippersController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar update shipper |\n", "responses": { "200": { "description": "Return value of ArShippersController.updateById", "content": {} }, "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Shippers PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } }, "x-parameter-index": 1 }, "operationId": "ArShippersController.updateById" } }, "/ar-ap-locked-incentives/count": { "get": { "x-controller-name": "ArApLockedIncentiveController", "x-operation-name": "count", "tags": [ "ArApLockedIncentiveController" ], "responses": { "200": { "description": "ArApLockedIncentive model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "ArApLockedIncentive.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "ArApLockedIncentiveController.count" } }, "/ar-ap-locked-incentives/{id}": { "put": { "x-controller-name": "ArApLockedIncentiveController", "x-operation-name": "replaceById", "tags": [ "ArApLockedIncentiveController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "ArApLockedIncentive PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArApLockedIncentive" } } }, "x-parameter-index": 1 }, "operationId": "ArApLockedIncentiveController.replaceById" }, "patch": { "x-controller-name": "ArApLockedIncentiveController", "x-operation-name": "updateById", "tags": [ "ArApLockedIncentiveController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "ArApLockedIncentive PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArApLockedIncentivePartial" } } }, "x-parameter-index": 1 }, "operationId": "ArApLockedIncentiveController.updateById" }, "get": { "x-controller-name": "ArApLockedIncentiveController", "x-operation-name": "findById", "tags": [ "ArApLockedIncentiveController" ], "responses": { "200": { "description": "ArApLockedIncentive model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArApLockedIncentiveWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArApLockedIncentive.Filter" } } } } ], "operationId": "ArApLockedIncentiveController.findById" }, "delete": { "x-controller-name": "ArApLockedIncentiveController", "x-operation-name": "deleteById", "tags": [ "ArApLockedIncentiveController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "ArApLockedIncentive DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ArApLockedIncentiveController.deleteById" } }, "/ar-ap-locked-incentives": { "post": { "x-controller-name": "ArApLockedIncentiveController", "x-operation-name": "create", "tags": [ "ArApLockedIncentiveController" ], "responses": { "200": { "description": "ArApLockedIncentive model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArApLockedIncentive" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewArApLockedIncentive" } } } }, "operationId": "ArApLockedIncentiveController.create" }, "patch": { "x-controller-name": "ArApLockedIncentiveController", "x-operation-name": "updateAll", "tags": [ "ArApLockedIncentiveController" ], "responses": { "200": { "description": "ArApLockedIncentive PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "ArApLockedIncentive.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArApLockedIncentivePartial" } } } }, "operationId": "ArApLockedIncentiveController.updateAll" }, "get": { "x-controller-name": "ArApLockedIncentiveController", "x-operation-name": "find", "tags": [ "ArApLockedIncentiveController" ], "responses": { "200": { "description": "Array of ArApLockedIncentive model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ArApLockedIncentiveWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArApLockedIncentive.Filter1" } } } } ], "operationId": "ArApLockedIncentiveController.find" } }, "/ar-ap-locked-incentives-byUser/{UserId}/{FilterMonth}": { "get": { "x-controller-name": "ArApLockedIncentiveController", "x-operation-name": "findByUserId", "tags": [ "ArApLockedIncentiveController" ], "responses": { "200": { "description": "ArApLockedIncentive model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArApLockedIncentiveWithRelations" } } } } }, "parameters": [ { "name": "UserId", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "FilterMonth", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "ArApLockedIncentiveController.findByUserId" } }, "/ar-assign-to-shipper": { "post": { "x-controller-name": "ArShippersController", "x-operation-name": "shipperAssign", "tags": [ "ArShippersController" ], "description": "", "responses": { "200": { "description": "Shippers History model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipperHistory" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "ArShippersController.shipperAssign" } }, "/ar-checking-by-team-shipper/{id}": { "get": { "x-controller-name": "ArShippersController", "x-operation-name": "findByIdChecked", "tags": [ "ArShippersController" ], "description": "", "responses": { "200": { "description": "Shippers model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShippersWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "ArShippersController.findByIdChecked" } }, "/ar-invoices/resend-invoices/{id}": { "post": { "x-controller-name": "ArInvoicesController", "x-operation-name": "re_send_invoice", "tags": [ "ArInvoicesController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar view invoices |\n", "responses": { "200": { "description": "Return value of ArInvoicesController.re_send_invoice", "content": {} }, "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Invoices PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "from", "to", "subject" ], "properties": { "from": { "type": "string", "maxLength": 50 }, "to": { "type": "string", "maxLength": 50 } } } } }, "x-parameter-index": 1 }, "operationId": "ArInvoicesController.re_send_invoice" } }, "/ar-invoices/send-invoice/{id}": { "post": { "x-controller-name": "ArInvoicesController", "x-operation-name": "send_invoice", "tags": [ "ArInvoicesController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar view invoices |\n", "responses": { "200": { "description": "Return value of ArInvoicesController.send_invoice", "content": {} }, "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Invoices PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "from", "to", "subject" ], "properties": { "from": { "type": "string", "maxLength": 50 }, "to": { "type": "string", "maxLength": 50 } } } } }, "x-parameter-index": 1 }, "operationId": "ArInvoicesController.send_invoice" } }, "/ar-selected-statement-report": { "post": { "x-controller-name": "ArSendStatementController", "x-operation-name": "getSelectedStatementData", "tags": [ "ArSendStatementController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar view shipper aging |\n", "responses": { "200": { "description": "Array of Shipment and invoices model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InvoicesWithRelations" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "ArSendStatementController.getSelectedStatementData" } }, "/ar-send-invoice/{id}": { "get": { "x-controller-name": "ArInvoicesController", "x-operation-name": "ar_send_invoice", "tags": [ "ArInvoicesController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar view invoices |\n", "responses": { "200": { "description": "McVerification model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoicesWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "ArInvoicesController.ar_send_invoice" } }, "/ar-shipper/notifications/count": { "get": { "x-controller-name": "LoadsController", "x-operation-name": "findAllLoadNotificationsCountAR", "tags": [ "LoadsController" ], "description": "\n\n| Permissions |\n| ------- |\n| AR Shipper Notifications |\n", "responses": { "200": { "description": "Array of Loads model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LoadsWithRelations" } } } } } }, "operationId": "LoadsController.findAllLoadNotificationsCountAR" } }, "/ar-shipper/notifications": { "get": { "x-controller-name": "LoadsController", "x-operation-name": "findArShipperNotifications", "tags": [ "LoadsController" ], "description": "\n\n| Permissions |\n| ------- |\n| AR Shipper Notifications |\n", "responses": { "200": { "description": "Array of Loads model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LoadsWithRelations" } } } } } }, "operationId": "LoadsController.findArShipperNotifications" } }, "/ar-shipper-to-status": { "post": { "x-controller-name": "ArShippersController", "x-operation-name": "ArshipperStatus", "tags": [ "ArShippersController" ], "description": "", "responses": { "200": { "description": "Shippers History model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipperHistory" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "ArShippersController.ArshipperStatus" } }, "/ar-shipper-transfer/{id}": { "get": { "x-controller-name": "ArShippersController", "x-operation-name": "findByIdForTransfer", "tags": [ "ArShippersController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar view shipper |\n", "responses": { "200": { "description": "Shippers model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShippersWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "ArShippersController.findByIdForTransfer" } }, "/ar-shipperattachment/{id}": { "get": { "x-controller-name": "ArShippersController", "x-operation-name": "findByIds", "tags": [ "ArShippersController" ], "description": "", "responses": { "200": { "description": "Shippers model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShippersWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "ArShippersController.findByIds" } }, "/ar-shippers/{id}": { "get": { "x-controller-name": "ArShippersController", "x-operation-name": "findById", "tags": [ "ArShippersController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar view shipper |\n", "responses": { "200": { "description": "Shippers model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShippersWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "ArShippersController.findById" } }, "/ar-shippers-companiesinsurance/{id}": { "get": { "x-controller-name": "ArShippersController", "x-operation-name": "findBycompaniesinsurance", "tags": [ "ArShippersController" ], "description": "", "responses": { "200": { "description": "Shippers model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShippersWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "ArShippersController.findBycompaniesinsurance" } }, "/ar-shippers-history-view/{id}": { "get": { "x-controller-name": "ArShippersController", "x-operation-name": "findByIdByShipperHistory", "tags": [ "ArShippersController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar view shipper |\n", "responses": { "200": { "description": "Shippers model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipperHistoryWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ArShippersController.findByIdByShipperHistory" } }, "/ar-shippers-limit-get/{id}": { "get": { "x-controller-name": "ArshipperLimitController", "x-operation-name": "findById", "tags": [ "ArshipperLimitController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar view shipper limit |\n", "responses": { "200": { "description": "ShipperLimits model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipperLimitsWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "ArshipperLimitController.findById" } }, "/ar-shippers-transfer/{id}": { "get": { "x-controller-name": "ArShippersController", "x-operation-name": "findByIdShipperTransfer", "tags": [ "ArShippersController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar view shipper |\n", "responses": { "200": { "description": "Shippers model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShippersWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "ArShippersController.findByIdShipperTransfer" } }, "/ar-statement-data": { "get": { "x-controller-name": "ArSendStatementController", "x-operation-name": "AllStatementData", "tags": [ "ArSendStatementController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar view shipper aging |\n", "responses": { "200": { "description": "Array of Shipment and invoices model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InvoicesWithRelations" } } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Invoices.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } }, { "name": "invoiceType", "in": "query", "schema": { "type": "string" } }, { "name": "shippersId", "in": "query", "schema": { "type": "string" } }, { "name": "payStatus", "in": "query", "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "number" } }, { "name": "pageSize", "in": "query", "schema": { "type": "number" } } ], "operationId": "ArSendStatementController.AllStatementData" } }, "/arshipment/gtg-ar": { "post": { "x-controller-name": "ArShipmentsController", "x-operation-name": "gtgAr", "tags": [ "ArShipmentsController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar view shipment |\n", "responses": { "200": { "description": "Shipment model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Shipment" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "shipmentId", "comment" ], "properties": { "shipmentId": { "type": "string" }, "comment": { "type": "string" } } } } } }, "operationId": "ArShipmentsController.gtgAr" } }, "/arshipment-detail/{id}": { "get": { "x-controller-name": "ArShipmentsController", "x-operation-name": "get_arshipment_detail", "tags": [ "ArShipmentsController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar view shipment |\n| ap view shipment |\n", "responses": { "200": { "description": "Shipment model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipmentWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "ArShipmentsController.get_arshipment_detail" } }, "/arshipments": { "get": { "x-controller-name": "ArShipmentsController", "x-operation-name": "find", "tags": [ "ArShipmentsController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar view shipment |\n", "responses": { "200": { "description": "Array of Shipment model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ShipmentWithRelations" } } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Shipment.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } }, { "name": "page", "in": "query", "schema": { "type": "number" } }, { "name": "pageSize", "in": "query", "schema": { "type": "number" } }, { "name": "status", "in": "query", "schema": { "type": "string" } }, { "name": "GTGstatus", "in": "query", "schema": { "type": "string" } }, { "name": "MoveTo", "in": "query", "schema": { "type": "string" } }, { "name": "ModeType", "in": "query", "schema": { "type": "string" } }, { "name": "shipmentNo", "in": "query", "schema": { "type": "string" } }, { "name": "shippersId", "in": "query", "schema": { "type": "string" } }, { "name": "userId", "in": "query", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "schema": { "type": "string" } }, { "name": "AssignToShippers", "in": "query", "schema": { "type": "string" } }, { "name": "all", "in": "query", "schema": { "type": "string" } } ], "operationId": "ArShipmentsController.find" } }, "/audit-verify-carrier-agings/{id}/shipment": { "get": { "x-controller-name": "AuditVerifyCarrierAgingShipmentController", "x-operation-name": "getShipment", "tags": [ "AuditVerifyCarrierAgingShipmentController" ], "responses": { "200": { "description": "Shipment belonging to AuditVerifyCarrierAging", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Shipment" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "AuditVerifyCarrierAgingShipmentController.getShipment" } }, "/audit-verify-carrier-agings/{id}/user": { "get": { "x-controller-name": "AuditVerifyCarrierAgingUserController", "x-operation-name": "getUser", "tags": [ "AuditVerifyCarrierAgingUserController" ], "responses": { "200": { "description": "User belonging to AuditVerifyCarrierAging", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "AuditVerifyCarrierAgingUserController.getUser" } }, "/audit-verify-commodities/{id}/user": { "get": { "x-controller-name": "AuditVerifyCommodityUserController", "x-operation-name": "getUser", "tags": [ "AuditVerifyCommodityUserController" ], "responses": { "200": { "description": "User belonging to AuditVerifyCommodity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "AuditVerifyCommodityUserController.getUser" } }, "/audit-verify-cprs/{id}/user": { "get": { "x-controller-name": "AuditVerifyCprUserController", "x-operation-name": "getUser", "tags": [ "AuditVerifyCprUserController" ], "responses": { "200": { "description": "User belonging to AuditVerifyCpr", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "AuditVerifyCprUserController.getUser" } }, "/audit-verify-vins/{id}/shipment": { "get": { "x-controller-name": "AuditVerifyVinShipmentController", "x-operation-name": "getShipment", "tags": [ "AuditVerifyVinShipmentController" ], "responses": { "200": { "description": "Shipment belonging to AuditVerifyVin", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Shipment" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "AuditVerifyVinShipmentController.getShipment" } }, "/audit-verify-vins/{id}/user": { "get": { "x-controller-name": "AuditVerifyVinUserController", "x-operation-name": "getUser", "tags": [ "AuditVerifyVinUserController" ], "responses": { "200": { "description": "User belonging to AuditVerifyVin", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "AuditVerifyVinUserController.getUser" } }, "/borker/drayage-incentive/details": { "get": { "x-controller-name": "BrokerIncentiveController", "x-operation-name": "getBrokerDrayageIncentiveDetails", "tags": [ "BrokerIncentiveController" ], "description": "", "responses": { "200": { "description": "Drayage Incentive Invoice Details", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "shipmentId": { "type": "number" }, "invoiceId": { "type": "number" }, "paid": { "type": "number" }, "margin": { "type": "number" }, "broker": { "type": "string" } } } } } } } }, "parameters": [ { "name": "userId", "in": "query", "schema": { "type": "number" } }, { "name": "incentiveMonth", "in": "query", "schema": { "type": "string" } } ], "operationId": "BrokerIncentiveController.getBrokerDrayageIncentiveDetails" } }, "/broker/all-cmt-pro-drayage-team": { "get": { "x-controller-name": "DatratemateController", "x-operation-name": "BrokerAllCmtProDrayageTeam", "tags": [ "DatratemateController" ], "responses": { "200": { "description": "Return value of DatratemateController.BrokerAllCmtProDrayageTeam" } }, "parameters": [ { "name": "date", "in": "query", "schema": { "type": "string" } }, { "name": "userId", "in": "query", "schema": { "type": "string" } } ], "operationId": "DatratemateController.BrokerAllCmtProDrayageTeam" } }, "/broker/broker-incentive/{date}/{id}": { "get": { "x-controller-name": "BrokerIncentiveSingleController", "x-operation-name": "GetLoggedUserIncentive", "tags": [ "BrokerIncentiveSingleController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker view incentive |\n", "responses": { "200": { "description": "List of claimed items", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "additionalProperties": true } } } } } }, "parameters": [ { "name": "date", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "BrokerIncentiveSingleController.GetLoggedUserIncentive" } }, "/broker/broker-month-till-date-report": { "get": { "x-controller-name": "BrokerReportsController", "x-operation-name": "brokerMonthTillDateReport", "tags": [ "BrokerReportsController" ], "responses": { "200": { "description": "Broker margin and shipment summary for all brokers for a given month and manager", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } } } } } }, "description": "", "parameters": [ { "name": "month", "in": "query", "schema": { "type": "string" }, "required": true, "description": "Month in YYYY-MM format" }, { "name": "managerId", "in": "query", "schema": { "type": "number" }, "required": true, "description": "Manager ID" } ], "operationId": "BrokerReportsController.brokerMonthTillDateReport" } }, "/broker/broker-new-policy-incentive/{date}/{id}": { "get": { "x-controller-name": "BrokerIncentiveSingleController", "x-operation-name": "GetLoggedUserIncentiveNewPolicy", "tags": [ "BrokerIncentiveSingleController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker view incentive |\n", "responses": { "200": { "description": "List of claimed items", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "additionalProperties": true } } } } } }, "parameters": [ { "name": "date", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "BrokerIncentiveSingleController.GetLoggedUserIncentiveNewPolicy" } }, "/broker/broker-new-policy-incentive-according-to-months-wise/{date}/{id}": { "get": { "x-controller-name": "BrokerIncentiveSingleController", "x-operation-name": "GetLoggedUserIncentiveNewPolicyAccordingToMonthsWise", "tags": [ "BrokerIncentiveSingleController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker view incentive |\n", "responses": { "200": { "description": "List of claimed items", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "additionalProperties": true } } } } } }, "parameters": [ { "name": "date", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "BrokerIncentiveSingleController.GetLoggedUserIncentiveNewPolicyAccordingToMonthsWise" } }, "/broker/broker-new-policy-incentive-according-to-months-wise-ar/{date}/{id}": { "get": { "x-controller-name": "BrokerIncentiveSingleController", "x-operation-name": "GetLoggedUserIncentiveARNewPolicyAccordingToMonthsWise", "tags": [ "BrokerIncentiveSingleController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker view incentive |\n", "responses": { "200": { "description": "List of claimed items", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "additionalProperties": true } } } } } }, "parameters": [ { "name": "date", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "BrokerIncentiveSingleController.GetLoggedUserIncentiveARNewPolicyAccordingToMonthsWise" } }, "/broker/drayage-locked-incentive": { "get": { "x-controller-name": "BrokerIncentiveController", "x-operation-name": "getBrokerDrayageLockedIncentive", "tags": [ "BrokerIncentiveController" ], "description": "", "responses": { "200": { "description": "Get locked drayage incentive data", "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "properties": { "userId": { "type": "number" }, "employeeId": { "type": "string" }, "realName": { "type": "string" }, "name": { "type": "string" }, "tlName": { "type": "string" }, "tmName": { "type": "string" }, "tlEmployeeId": { "type": "string" }, "tmEmployeeId": { "type": "string" }, "managerId": { "type": "number" }, "tlId": { "type": "number" }, "minDateReceived": { "type": "string" }, "maxDateReceived": { "type": "string" }, "totalReceivedAmount": { "type": "number" }, "totalPaidAmount": { "type": "number" }, "redflag": { "type": "number" }, "incentive": { "type": "number" }, "inrAmt": { "type": "number" }, "incentiveMonth": { "type": "string" } } } }, "groupedByManager": { "type": "array", "items": { "type": "object", "properties": { "managerId": { "type": "number" }, "tlId": { "type": "number" }, "tmName": { "type": "string" }, "tmEmployeeId": { "type": "string" }, "totalReceivedAmount": { "type": "number" }, "indirecttotalReceivedAmount": { "type": "number" }, "redflag": { "type": "number" }, "totalPaidAmount": { "type": "number" }, "indirecttotalPaidAmount": { "type": "number" }, "white": { "type": "number" }, "incentive": { "type": "number" }, "indirectincentive": { "type": "number" }, "whiteincentive": { "type": "number" }, "inrAmt": { "type": "number" }, "incentiveMonth": { "type": "string" } } } }, "groupedByTl": { "type": "array", "items": { "type": "object", "properties": { "tlId": { "type": "number" }, "tlName": { "type": "string" }, "tlEmployeeId": { "type": "string" }, "totalReceivedAmount": { "type": "number" }, "redflag": { "type": "number" }, "totalPaidAmount": { "type": "number" }, "incentive": { "type": "number" }, "inrAmt": { "type": "number" }, "tlInr": { "type": "number" }, "incentiveMonth": { "type": "string" } } } } } } } } } }, "parameters": [ { "name": "incentiveMonth", "in": "query", "schema": { "type": "string" } } ], "operationId": "BrokerIncentiveController.getBrokerDrayageLockedIncentive" } }, "/broker/fetch-pie-chart-margin": { "get": { "x-controller-name": "BrokerReportsController", "x-operation-name": "getPieChartMarginReport", "tags": [ "BrokerReportsController" ], "responses": { "200": { "description": "Report fetched successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } } }, "description": "\n\n| Permissions |\n| ------- |\n| view portal reports |\n", "parameters": [ { "name": "month", "in": "query", "schema": { "type": "string" }, "description": "Month name (e.g., \"January\")", "required": true } ], "operationId": "BrokerReportsController.getPieChartMarginReport" } }, "/broker/fetch-quarterly-margin": { "get": { "x-controller-name": "BrokerReportsController", "x-operation-name": "getQuarterMarginReport", "tags": [ "BrokerReportsController" ], "responses": { "200": { "description": "Quarterly month-wise margin comparison", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } } } } } }, "description": "\n\n| Permissions |\n| ------- |\n| view portal reports |\n", "parameters": [ { "name": "quarter", "in": "query", "schema": { "type": "string" } }, { "name": "year", "in": "query", "schema": { "type": "string" } } ], "operationId": "BrokerReportsController.getQuarterMarginReport" } }, "/broker/fetch-report-cpr": { "get": { "x-controller-name": "BrokerReportsController", "x-operation-name": "getReport", "tags": [ "BrokerReportsController" ], "responses": { "200": { "description": "Report fetched successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } } }, "description": "\n\n| Permissions |\n| ------- |\n| view portal reports |\n", "parameters": [ { "name": "teamId", "in": "query", "schema": { "type": "string" } }, { "name": "brokerId", "in": "query", "schema": { "type": "string" } } ], "operationId": "BrokerReportsController.getReport" } }, "/broker/fetch-report-invoice": { "get": { "x-controller-name": "BrokerReportsController", "x-operation-name": "getReportInvoice", "tags": [ "BrokerReportsController" ], "responses": { "200": { "description": "Report fetched successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } } }, "description": "\n\n| Permissions |\n| ------- |\n| view portal reports |\n", "parameters": [ { "name": "teamId", "in": "query", "schema": { "type": "string" } }, { "name": "brokerId", "in": "query", "schema": { "type": "string" } } ], "operationId": "BrokerReportsController.getReportInvoice" } }, "/broker/fetch-team-margin": { "get": { "x-controller-name": "BrokerReportsController", "x-operation-name": "getTeamMarginReport", "tags": [ "BrokerReportsController" ], "responses": { "200": { "description": "Report fetched successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } } }, "description": "\n\n| Permissions |\n| ------- |\n| view portal reports |\n", "parameters": [ { "name": "month", "in": "query", "schema": { "type": "string" }, "description": "Month name (e.g., \"January\")", "required": true } ], "operationId": "BrokerReportsController.getTeamMarginReport" } }, "/broker/get-team-user": { "get": { "x-controller-name": "BrokerIncentiveController", "x-operation-name": "MarginReportManagerByAsi", "tags": [ "BrokerIncentiveController" ], "responses": { "200": { "description": "Invoices model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoicesWithRelations" } } } } }, "parameters": [ { "name": "monthDate", "in": "query", "schema": { "type": "string" } }, { "name": "userid", "in": "query", "schema": { "type": "string" } }, { "name": "usertype", "in": "query", "schema": { "type": "string" } } ], "operationId": "BrokerIncentiveController.MarginReportManagerByAsi" } }, "/broker/locked-incentive": { "get": { "x-controller-name": "BrokerIncentiveController", "x-operation-name": "getLockedIncentiveBrokerSide", "tags": [ "BrokerIncentiveController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker view incentive |\n", "responses": { "200": { "description": "Locked Incentive Data", "content": { "application/json": { "schema": { "type": "object", "properties": { "incentive": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "tLIncentive": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "manageIncentive": { "type": "array", "items": { "type": "object", "additionalProperties": true } } } } } } } }, "parameters": [ { "name": "date", "in": "query", "schema": { "type": "string" } } ], "operationId": "BrokerIncentiveController.getLockedIncentiveBrokerSide" } }, "/broker/locked-otr-incentive": { "get": { "x-controller-name": "OtrIncentiveController", "x-operation-name": "getLockedOtrIncentiveBrokerSide", "tags": [ "OtrIncentiveController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker view incentive |\n", "responses": { "200": { "description": "Locked OTR Incentive Data for Broker", "content": { "application/json": { "schema": { "type": "object", "properties": { "incentive": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "tLIncentive": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "manageIncentive": { "type": "array", "items": { "type": "object", "additionalProperties": true } } } } } } } }, "parameters": [ { "name": "date", "in": "query", "schema": { "type": "string" } } ], "operationId": "OtrIncentiveController.getLockedOtrIncentiveBrokerSide" } }, "/broker/locked-otr-new-policy-incentive": { "get": { "x-controller-name": "OtrIncentiveController", "x-operation-name": "getLockedOtrNewPolicyIncentiveBrokerSide", "tags": [ "OtrIncentiveController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker view incentive |\n", "responses": { "200": { "description": "Locked OTR Incentive Data for Broker", "content": { "application/json": { "schema": { "type": "object", "properties": { "incentive": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "tLIncentive": { "type": "array", "items": { "type": "object", "additionalProperties": true } }, "manageIncentive": { "type": "array", "items": { "type": "object", "additionalProperties": true } } } } } } } }, "parameters": [ { "name": "date", "in": "query", "schema": { "type": "string" } } ], "operationId": "OtrIncentiveController.getLockedOtrNewPolicyIncentiveBrokerSide" } }, "/broker/manager-month-till-date-report": { "get": { "x-controller-name": "BrokerReportsController", "x-operation-name": "getManagerMonthSummaryAll", "tags": [ "BrokerReportsController" ], "responses": { "200": { "description": "Manager margin and shipment summary for all managers for a given month", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } } } } } }, "description": "", "parameters": [ { "name": "month", "in": "query", "schema": { "type": "string" }, "required": true, "description": "Month in YYYY-MM format" } ], "operationId": "BrokerReportsController.getManagerMonthSummaryAll" } }, "/broker/month-till-date-report": { "get": { "x-controller-name": "BrokerReportsController", "x-operation-name": "getMonthlyMarginSummary", "tags": [ "BrokerReportsController" ], "responses": { "200": { "description": "Monthly margin summary for last 6 months or given date range", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } } } } } }, "description": "", "parameters": [ { "name": "fromDate", "in": "query", "schema": { "type": "string" } }, { "name": "toDate", "in": "query", "schema": { "type": "string" } } ], "operationId": "BrokerReportsController.getMonthlyMarginSummary" } }, "/broker/monthly-performance-all": { "get": { "x-controller-name": "BrokerReportsController", "x-operation-name": "getMonthlySummaryAll", "tags": [ "BrokerReportsController" ], "description": "", "responses": { "200": { "description": "Return value of BrokerReportsController.getMonthlySummaryAll", "content": {} } }, "parameters": [ { "name": "startDate", "in": "query", "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "schema": { "type": "string" } }, { "name": "userId", "in": "query", "schema": { "type": "number" } }, { "name": "teamId", "in": "query", "schema": { "type": "number" } } ], "operationId": "BrokerReportsController.getMonthlySummaryAll" } }, "/broker/my-month-till-date-report": { "get": { "x-controller-name": "BrokerReportsController", "x-operation-name": "myMonthTillDateReport", "tags": [ "BrokerReportsController" ], "responses": { "200": { "description": "Broker margin and shipment summary for all brokers for a given month and manager", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } } } } } }, "description": "", "parameters": [ { "name": "month", "in": "query", "schema": { "type": "string" }, "required": true, "description": "Month in YYYY-MM format" } ], "operationId": "BrokerReportsController.myMonthTillDateReport" } }, "/broker/notes": { "post": { "x-controller-name": "BrokerShipperAgingController", "x-operation-name": "create", "tags": [ "BrokerShipperAgingController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker view shipper aging |\n", "responses": { "200": { "description": "Notes model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Notes" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "BrokerShipperAgingController.create" } }, "/broker/one-broker-incentive-drayage": { "get": { "x-controller-name": "DatratemateController", "x-operation-name": "BrokerOneBrokerIncentiveDrayage", "tags": [ "DatratemateController" ], "description": "", "responses": { "200": { "description": "Return value of DatratemateController.BrokerOneBrokerIncentiveDrayage", "content": {} } }, "parameters": [ { "name": "date", "in": "query", "schema": { "type": "string" } } ], "operationId": "DatratemateController.BrokerOneBrokerIncentiveDrayage" } }, "/broker/one-broker-incentive-drayage-all-pro": { "get": { "x-controller-name": "DatratemateController", "x-operation-name": "BrokerOneBrokerIncentiveDrayageAllPro", "tags": [ "DatratemateController" ], "responses": { "200": { "description": "Return value of DatratemateController.BrokerOneBrokerIncentiveDrayageAllPro" } }, "parameters": [ { "name": "date", "in": "query", "schema": { "type": "string" } }, { "name": "userId", "in": "query", "schema": { "type": "string" } } ], "operationId": "DatratemateController.BrokerOneBrokerIncentiveDrayageAllPro" } }, "/broker/otr-team-alignment": { "get": { "x-controller-name": "OtrIncentiveController", "x-operation-name": "getOtrBrokerTeamAlignment", "tags": [ "OtrIncentiveController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker view incentive |\n", "responses": { "200": { "description": "OTR Team Alignment Data", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "userId": { "type": "number" }, "managerId": { "type": "number" }, "teamId": { "type": "number" }, "userName": { "type": "string" }, "managerName": { "type": "string" }, "tlName": { "type": "string" }, "userEmployeeId": { "type": "string" }, "managerEmployeeId": { "type": "string" }, "tlEmployeeId": { "type": "string" }, "date": { "type": "string" } } } } } } } }, "parameters": [ { "name": "date", "in": "query", "schema": { "type": "string" } } ], "operationId": "OtrIncentiveController.getOtrBrokerTeamAlignment" } }, "/broker/performance-comments": { "post": { "x-controller-name": "BrokerReportsController", "x-operation-name": "addPerformanceComment", "tags": [ "BrokerReportsController" ], "responses": { "200": { "description": "Add a comment to performancecomments table", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number" } } } } } } }, "description": "\n\n| Permissions |\n| ------- |\n| broker view reports |\n", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "userId", "comment" ], "properties": { "userId": { "type": "number" }, "comment": { "type": "string" } } } } } }, "operationId": "BrokerReportsController.addPerformanceComment" }, "get": { "x-controller-name": "BrokerReportsController", "x-operation-name": "listPerformanceComments", "tags": [ "BrokerReportsController" ], "responses": { "200": { "description": "List performance comments with user info", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/User" } } } } } }, "parameters": [ { "name": "userId", "in": "query", "schema": { "type": "number" } } ], "operationId": "BrokerReportsController.listPerformanceComments" } }, "/broker/refresh/dat/token": { "get": { "x-controller-name": "DatratemateController", "x-operation-name": "refreshDATtoken", "tags": [ "DatratemateController" ], "responses": { "200": { "description": "Return value of DatratemateController.refreshDATtoken" } }, "operationId": "DatratemateController.refreshDATtoken" } }, "/broker/refresh/loads/dat/{uid}": { "get": { "x-controller-name": "DatratemateController", "x-operation-name": "refreshLoadsOnDAT", "tags": [ "DatratemateController" ], "description": "", "responses": { "200": { "description": "Return value of DatratemateController.refreshLoadsOnDAT", "content": {} } }, "parameters": [ { "name": "uid", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "DatratemateController.refreshLoadsOnDAT" } }, "/broker/refresh/truckstops/token": { "get": { "x-controller-name": "DatratemateController", "x-operation-name": "refreshTruckstopsToken", "tags": [ "DatratemateController" ], "responses": { "200": { "description": "Return value of DatratemateController.refreshTruckstopsToken" } }, "operationId": "DatratemateController.refreshTruckstopsToken" } }, "/broker/search/live/internal/all/shipments/search/trucks/loads": { "get": { "x-controller-name": "DatratemateController", "x-operation-name": "brokerSearchLiveInternalAllLoadsSearchTrucksLoads", "tags": [ "DatratemateController" ], "description": "", "responses": { "200": { "description": "Return value of DatratemateController.brokerSearchLiveInternalAllLoadsSearchTrucksLoads", "content": {} } }, "parameters": [ { "name": "equipments", "in": "query", "schema": { "type": "string" } }, { "name": "origin_city", "in": "query", "schema": { "type": "string" } }, { "name": "destination_city", "in": "query", "schema": { "type": "string" } }, { "name": "pick_up_date", "in": "query", "schema": { "type": "string" } }, { "name": "full_partial_tl_ltl", "in": "query", "schema": { "type": "string" } }, { "name": "dhomiles", "in": "query", "schema": { "type": "string" } } ], "operationId": "DatratemateController.brokerSearchLiveInternalAllLoadsSearchTrucksLoads" } }, "/broker/search/live/internal/all/shipments": { "get": { "x-controller-name": "DatratemateController", "x-operation-name": "brokerSearchLiveInternalAllLoads", "tags": [ "DatratemateController" ], "description": "", "responses": { "200": { "description": "Return value of DatratemateController.brokerSearchLiveInternalAllLoads", "content": {} } }, "parameters": [ { "name": "OriginID", "in": "query", "schema": { "type": "string" } }, { "name": "OriginMiles", "in": "query", "schema": { "type": "string" } }, { "name": "DestinationID", "in": "query", "schema": { "type": "string" } }, { "name": "PickUpDate", "in": "query", "schema": { "type": "string" } }, { "name": "DropDate", "in": "query", "schema": { "type": "string" } } ], "operationId": "DatratemateController.brokerSearchLiveInternalAllLoads" } }, "/broker/search/live/internal/loads/shipments": { "get": { "x-controller-name": "DatratemateController", "x-operation-name": "brokerSearchLiveInternalLoads", "tags": [ "DatratemateController" ], "description": "", "responses": { "200": { "description": "Return value of DatratemateController.brokerSearchLiveInternalLoads", "content": {} } }, "parameters": [ { "name": "uid", "in": "query", "schema": { "type": "string" } } ], "operationId": "DatratemateController.brokerSearchLiveInternalLoads" } }, "/broker/search/live/internal/shipments/auto": { "get": { "x-controller-name": "DatratemateController", "x-operation-name": "getSearchLiveInternalShipmentsAuto", "tags": [ "DatratemateController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker live shipments |\n", "responses": { "200": { "description": "Return value of DatratemateController.getSearchLiveInternalShipmentsAuto", "content": {} } }, "operationId": "DatratemateController.getSearchLiveInternalShipmentsAuto" } }, "/broker/search/live/internal/shipments": { "get": { "x-controller-name": "DatratemateController", "x-operation-name": "getSearchLiveInternalShipments", "tags": [ "DatratemateController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker live shipments |\n", "responses": { "200": { "description": "Return value of DatratemateController.getSearchLiveInternalShipments", "content": {} } }, "parameters": [ { "name": "equipmentId", "in": "query", "schema": { "type": "number" } }, { "name": "originId", "in": "query", "schema": { "type": "number" } }, { "name": "destiID", "in": "query", "schema": { "type": "number" } }, { "name": "pick_up_date", "in": "query", "schema": { "type": "string" } }, { "name": "radiusMiles", "in": "query", "schema": { "type": "number" } } ], "operationId": "DatratemateController.getSearchLiveInternalShipments" } }, "/broker/search/loads/via/rest/api/on/dat": { "get": { "x-controller-name": "DatratemateController", "x-operation-name": "getSearchLoadsViaRestApiOnDat", "tags": [ "DatratemateController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker create loads |\n", "responses": { "200": { "description": "Return value of DatratemateController.getSearchLoadsViaRestApiOnDat", "content": {} } }, "parameters": [ { "name": "equipments", "in": "query", "schema": { "type": "string" } }, { "name": "origin_city", "in": "query", "schema": { "type": "string" } }, { "name": "destination_city", "in": "query", "schema": { "type": "string" } }, { "name": "pick_up_date", "in": "query", "schema": { "type": "string" } }, { "name": "full_partial_tl_ltl", "in": "query", "schema": { "type": "string" } }, { "name": "dhomiles", "in": "query", "schema": { "type": "number" } }, { "name": "dhdmiles", "in": "query", "schema": { "type": "number" } } ], "operationId": "DatratemateController.getSearchLoadsViaRestApiOnDat" } }, "/broker/search/onclick/dat/trucks/via/rest/api": { "get": { "x-controller-name": "DatratemateController", "x-operation-name": "getSearchTrucksOnClickDatTrucksViaRestApi", "tags": [ "DatratemateController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker create loads |\n", "responses": { "200": { "description": "Return value of DatratemateController.getSearchTrucksOnClickDatTrucksViaRestApi", "content": {} } }, "parameters": [ { "name": "uid", "in": "query", "schema": { "type": "string" } } ], "operationId": "DatratemateController.getSearchTrucksOnClickDatTrucksViaRestApi" } }, "/broker/search/onclick/internalTrucks/search/trucks/loads": { "get": { "x-controller-name": "DatratemateController", "x-operation-name": "getSearchInternalTrucksOnClickRefrenceSearchTrucksLoads", "tags": [ "DatratemateController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker create loads |\n", "responses": { "200": { "description": "Return value of DatratemateController.getSearchInternalTrucksOnClickRefrenceSearchTrucksLoads", "content": {} } }, "parameters": [ { "name": "equipments", "in": "query", "schema": { "type": "string" } }, { "name": "origin_city", "in": "query", "schema": { "type": "string" } }, { "name": "destination_city", "in": "query", "schema": { "type": "string" } }, { "name": "pick_up_date", "in": "query", "schema": { "type": "string" } }, { "name": "full_partial_tl_ltl", "in": "query", "schema": { "type": "string" } }, { "name": "dhomiles", "in": "query", "schema": { "type": "string" } } ], "operationId": "DatratemateController.getSearchInternalTrucksOnClickRefrenceSearchTrucksLoads" } }, "/broker/search/onclick/internalTrucks": { "get": { "x-controller-name": "DatratemateController", "x-operation-name": "getSearchInternalTrucksOnClickRefrence", "tags": [ "DatratemateController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker create loads |\n", "responses": { "200": { "description": "Return value of DatratemateController.getSearchInternalTrucksOnClickRefrence", "content": {} } }, "parameters": [ { "name": "uid", "in": "query", "schema": { "type": "string" } } ], "operationId": "DatratemateController.getSearchInternalTrucksOnClickRefrence" } }, "/broker/search/onclick/refrence": { "get": { "x-controller-name": "DatratemateController", "x-operation-name": "getSearchTrucksOnClickRefrence", "tags": [ "DatratemateController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker create loads |\n", "responses": { "200": { "description": "Return value of DatratemateController.getSearchTrucksOnClickRefrence", "content": {} } }, "parameters": [ { "name": "uid", "in": "query", "schema": { "type": "string" } } ], "operationId": "DatratemateController.getSearchTrucksOnClickRefrence" } }, "/broker/search/rims/reports/{MCID}": { "get": { "x-controller-name": "DatratemateController", "x-operation-name": "getRIMSDetailsLive", "tags": [ "DatratemateController" ], "responses": { "200": { "description": "Return value of DatratemateController.getRIMSDetailsLive" } }, "parameters": [ { "name": "MCID", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "DatratemateController.getRIMSDetailsLive" } }, "/broker/search/trucks/loads/on/dat": { "get": { "x-controller-name": "DatratemateController", "x-operation-name": "getSearchTrucksOnDat", "tags": [ "DatratemateController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker create loads |\n", "responses": { "200": { "description": "Return value of DatratemateController.getSearchTrucksOnDat", "content": {} } }, "parameters": [ { "name": "equipments", "in": "query", "schema": { "type": "string" } }, { "name": "origin_city", "in": "query", "schema": { "type": "string" } }, { "name": "destination_city", "in": "query", "schema": { "type": "string" } }, { "name": "pick_up_date", "in": "query", "schema": { "type": "string" } }, { "name": "full_partial_tl_ltl", "in": "query", "schema": { "type": "string" } }, { "name": "dhomiles", "in": "query", "schema": { "type": "string" } } ], "operationId": "DatratemateController.getSearchTrucksOnDat" } }, "/broker/search/trucks/on-truckstops/byClick/search/trucks/loads": { "get": { "x-controller-name": "DatratemateController", "x-operation-name": "getSearchTrucksOnTruckstopsByClickSearchTrucksLoads", "tags": [ "DatratemateController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker create loads |\n", "responses": { "200": { "description": "Return value of DatratemateController.getSearchTrucksOnTruckstopsByClickSearchTrucksLoads", "content": {} } }, "parameters": [ { "name": "equipments", "in": "query", "schema": { "type": "string" } }, { "name": "origin_city", "in": "query", "schema": { "type": "string" } }, { "name": "destination_city", "in": "query", "schema": { "type": "string" } }, { "name": "pick_up_date", "in": "query", "schema": { "type": "string" } }, { "name": "full_partial_tl_ltl", "in": "query", "schema": { "type": "string" } }, { "name": "dhomiles", "in": "query", "schema": { "type": "string" } } ], "operationId": "DatratemateController.getSearchTrucksOnTruckstopsByClickSearchTrucksLoads" } }, "/broker/search/trucks/on-truckstops/byClick": { "get": { "x-controller-name": "DatratemateController", "x-operation-name": "getSearchTrucksOnTruckstopsByClick", "tags": [ "DatratemateController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker create loads |\n", "responses": { "200": { "description": "Return value of DatratemateController.getSearchTrucksOnTruckstopsByClick", "content": {} } }, "parameters": [ { "name": "uid", "in": "query", "schema": { "type": "string" } } ], "operationId": "DatratemateController.getSearchTrucksOnTruckstopsByClick" } }, "/broker/search/trucks/on-truckstops": { "get": { "x-controller-name": "DatratemateController", "x-operation-name": "getSearchTrucksOnTruckstops", "tags": [ "DatratemateController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker create loads |\n", "responses": { "200": { "description": "Return value of DatratemateController.getSearchTrucksOnTruckstops", "content": {} } }, "parameters": [ { "name": "equipmentId", "in": "query", "schema": { "type": "number" } }, { "name": "originId", "in": "query", "schema": { "type": "number" } }, { "name": "destiID", "in": "query", "schema": { "type": "number" } }, { "name": "dhomiles", "in": "query", "schema": { "type": "number" } }, { "name": "pick_up_date", "in": "query", "schema": { "type": "string" } }, { "name": "full_partial_tl_ltl", "in": "query", "schema": { "type": "string" } }, { "name": "length_load", "in": "query", "schema": { "type": "number" } }, { "name": "weight_load", "in": "query", "schema": { "type": "number" } }, { "name": "search_back", "in": "query", "schema": { "type": "number" } }, { "name": "search_country", "in": "query", "schema": { "type": "string" } } ], "operationId": "DatratemateController.getSearchTrucksOnTruckstops" } }, "/broker/search/trucks/via/rest/api/on/dat": { "get": { "x-controller-name": "DatratemateController", "x-operation-name": "getSearchTrucksViaRestApiOnDat", "tags": [ "DatratemateController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker create loads |\n", "responses": { "200": { "description": "Return value of DatratemateController.getSearchTrucksViaRestApiOnDat", "content": {} } }, "parameters": [ { "name": "equipments", "in": "query", "schema": { "type": "string" } }, { "name": "origin_city", "in": "query", "schema": { "type": "string" } }, { "name": "destination_city", "in": "query", "schema": { "type": "string" } }, { "name": "pick_up_date", "in": "query", "schema": { "type": "string" } }, { "name": "full_partial_tl_ltl", "in": "query", "schema": { "type": "string" } }, { "name": "dhomiles", "in": "query", "schema": { "type": "number" } }, { "name": "dhdmiles", "in": "query", "schema": { "type": "number" } } ], "operationId": "DatratemateController.getSearchTrucksViaRestApiOnDat" } }, "/broker/search/trucks": { "get": { "x-controller-name": "DatratemateController", "x-operation-name": "getSearchTrucks", "tags": [ "DatratemateController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker create loads |\n", "responses": { "200": { "description": "Return value of DatratemateController.getSearchTrucks", "content": {} } }, "parameters": [ { "name": "equipmentId", "in": "query", "schema": { "type": "number" } }, { "name": "originId", "in": "query", "schema": { "type": "number" } }, { "name": "destiID", "in": "query", "schema": { "type": "number" } }, { "name": "dhomiles", "in": "query", "schema": { "type": "number" } }, { "name": "pick_up_date", "in": "query", "schema": { "type": "string" } }, { "name": "full_partial_tl_ltl", "in": "query", "schema": { "type": "string" } }, { "name": "length_load", "in": "query", "schema": { "type": "number" } }, { "name": "weight_load", "in": "query", "schema": { "type": "number" } }, { "name": "search_back", "in": "query", "schema": { "type": "number" } }, { "name": "search_country", "in": "query", "schema": { "type": "string" } } ], "operationId": "DatratemateController.getSearchTrucks" } }, "/broker/search/truckstops/ratemate": { "get": { "x-controller-name": "DatratemateController", "x-operation-name": "getSearchTrucksOnTruckstopsRatemate", "tags": [ "DatratemateController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker view ratemate |\n", "responses": { "200": { "description": "Return value of DatratemateController.getSearchTrucksOnTruckstopsRatemate", "content": {} } }, "parameters": [ { "name": "bymiles", "in": "query", "schema": { "type": "string" } }, { "name": "origin_city", "in": "query", "schema": { "type": "string" } }, { "name": "destination_city", "in": "query", "schema": { "type": "string" } }, { "name": "equipment_type", "in": "query", "schema": { "type": "string" } } ], "operationId": "DatratemateController.getSearchTrucksOnTruckstopsRatemate" } }, "/broker/team-alignment": { "get": { "x-controller-name": "BrokerIncentiveController", "x-operation-name": "getBrokerTeamAlignment", "tags": [ "BrokerIncentiveController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker view incentive |\n", "responses": { "200": { "description": "Team Alignment Data", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "userId": { "type": "number" }, "managerId": { "type": "number" }, "teamId": { "type": "number" }, "userName": { "type": "string" }, "managerName": { "type": "string" }, "tlName": { "type": "string" }, "userEmployeeId": { "type": "string" }, "managerEmployeeId": { "type": "string" }, "tlEmployeeId": { "type": "string" }, "date": { "type": "string" } } } } } } } }, "parameters": [ { "name": "date", "in": "query", "schema": { "type": "string" } } ], "operationId": "BrokerIncentiveController.getBrokerTeamAlignment" } }, "/broker/test/my/code": { "get": { "x-controller-name": "DatratemateController", "x-operation-name": "refreshTruckstopsTokenGG", "tags": [ "DatratemateController" ], "responses": { "200": { "description": "Return value of DatratemateController.refreshTruckstopsTokenGG" } }, "operationId": "DatratemateController.refreshTruckstopsTokenGG" } }, "/broker/ti-month-till-date-report": { "get": { "x-controller-name": "BrokerReportsController", "x-operation-name": "tlMonthTillDateReport", "tags": [ "BrokerReportsController" ], "responses": { "200": { "description": "Broker margin and shipment summary for all brokers for a given month and manager", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } } } } } }, "description": "", "parameters": [ { "name": "month", "in": "query", "schema": { "type": "string" }, "required": true, "description": "Month in YYYY-MM format" } ], "operationId": "BrokerReportsController.tlMonthTillDateReport" } }, "/broker/update/loads/ages": { "get": { "x-controller-name": "DatratemateController", "x-operation-name": "refreshLoadsAge", "tags": [ "DatratemateController" ], "responses": { "200": { "description": "Return value of DatratemateController.refreshLoadsAge" } }, "operationId": "DatratemateController.refreshLoadsAge" } }, "/broker-asi-incentives/count": { "get": { "x-controller-name": "BrokerAsiIncentivesController", "x-operation-name": "count", "tags": [ "BrokerAsiIncentivesController" ], "responses": { "200": { "description": "BrokerAsiIncentives model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "BrokerAsiIncentives.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "BrokerAsiIncentivesController.count" } }, "/broker-asi-incentives/{id}": { "put": { "x-controller-name": "BrokerAsiIncentivesController", "x-operation-name": "replaceById", "tags": [ "BrokerAsiIncentivesController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "BrokerAsiIncentives PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrokerAsiIncentives" } } }, "x-parameter-index": 1 }, "operationId": "BrokerAsiIncentivesController.replaceById" }, "patch": { "x-controller-name": "BrokerAsiIncentivesController", "x-operation-name": "updateById", "tags": [ "BrokerAsiIncentivesController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "BrokerAsiIncentives PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrokerAsiIncentivesPartial" } } }, "x-parameter-index": 1 }, "operationId": "BrokerAsiIncentivesController.updateById" }, "get": { "x-controller-name": "BrokerAsiIncentivesController", "x-operation-name": "findById", "tags": [ "BrokerAsiIncentivesController" ], "responses": { "200": { "description": "BrokerAsiIncentives model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrokerAsiIncentivesWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrokerAsiIncentives.Filter" } } } } ], "operationId": "BrokerAsiIncentivesController.findById" }, "delete": { "x-controller-name": "BrokerAsiIncentivesController", "x-operation-name": "deleteById", "tags": [ "BrokerAsiIncentivesController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "BrokerAsiIncentives DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "BrokerAsiIncentivesController.deleteById" } }, "/broker-asi-incentives": { "post": { "x-controller-name": "BrokerAsiIncentivesController", "x-operation-name": "create", "tags": [ "BrokerAsiIncentivesController" ], "responses": { "200": { "description": "BrokerAsiIncentives model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrokerAsiIncentives" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewBrokerAsiIncentives" } } } }, "operationId": "BrokerAsiIncentivesController.create" }, "patch": { "x-controller-name": "BrokerAsiIncentivesController", "x-operation-name": "updateAll", "tags": [ "BrokerAsiIncentivesController" ], "responses": { "200": { "description": "BrokerAsiIncentives PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "BrokerAsiIncentives.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrokerAsiIncentivesPartial" } } } }, "operationId": "BrokerAsiIncentivesController.updateAll" }, "get": { "x-controller-name": "BrokerAsiIncentivesController", "x-operation-name": "find", "tags": [ "BrokerAsiIncentivesController" ], "responses": { "200": { "description": "Array of BrokerAsiIncentives model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BrokerAsiIncentivesWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrokerAsiIncentives.Filter1" } } } } ], "operationId": "BrokerAsiIncentivesController.find" } }, "/broker-home": { "get": { "x-controller-name": "BrokerHomeController", "x-operation-name": "brokerHome", "tags": [ "BrokerHomeController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker view dashboard |\n", "responses": { "200": { "description": "Shipment model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoicesWithRelations" } } } } }, "operationId": "BrokerHomeController.brokerHome" } }, "/broker-incentive/{id}/{date}": { "get": { "x-controller-name": "BrokerIncentiveSingleController", "x-operation-name": "GetClaimedList", "tags": [ "BrokerIncentiveSingleController" ], "responses": { "200": { "description": "List of claimed items", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "additionalProperties": true } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "date", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "BrokerIncentiveSingleController.GetClaimedList" } }, "/broker-incentive": { "get": { "x-controller-name": "BrokerIncentiveController", "x-operation-name": "GetClaimedList", "tags": [ "BrokerIncentiveController" ], "responses": { "200": { "description": "List of claimed items", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "additionalProperties": true } } } } } }, "parameters": [ { "name": "date", "in": "query", "schema": { "type": "string" } }, { "name": "lock", "in": "query", "schema": { "type": "boolean" } } ], "operationId": "BrokerIncentiveController.GetClaimedList" } }, "/broker-incentive-asi-get-allpro": { "get": { "x-controller-name": "DatratemateController", "x-operation-name": "BrokerIncentiveASIGetAllPro", "tags": [ "DatratemateController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker asi incentive |\n", "responses": { "200": { "description": "Return value of DatratemateController.BrokerIncentiveASIGetAllPro", "content": {} } }, "parameters": [ { "name": "date", "in": "query", "schema": { "type": "string" } } ], "operationId": "DatratemateController.BrokerIncentiveASIGetAllPro" } }, "/broker-incentive-new-policy/{id}/{date}": { "get": { "x-controller-name": "BrokerIncentiveSingleController", "x-operation-name": "GetClaimedListNewPolicy", "tags": [ "BrokerIncentiveSingleController" ], "responses": { "200": { "description": "List of claimed items", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "additionalProperties": true } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "date", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "BrokerIncentiveSingleController.GetClaimedListNewPolicy" } }, "/broker-incentive-tl": { "get": { "x-controller-name": "BrokerIncentiveController", "x-operation-name": "GetBrokerIncentiveTl", "tags": [ "BrokerIncentiveController" ], "responses": { "200": { "description": "List of claimed items", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "additionalProperties": true } } } } } }, "parameters": [ { "name": "date", "in": "query", "schema": { "type": "string" } }, { "name": "lock", "in": "query", "schema": { "type": "boolean" } } ], "operationId": "BrokerIncentiveController.GetBrokerIncentiveTl" } }, "/broker-invoice-details/{id}": { "get": { "x-controller-name": "BrokerShipperAgingController", "x-operation-name": "InvoiceDetail", "tags": [ "BrokerShipperAgingController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker view shipper aging |\n", "responses": { "200": { "description": "Invoices model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoicesWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "BrokerShipperAgingController.InvoiceDetail" } }, "/broker-invoice-payments/{id}": { "get": { "x-controller-name": "BrokerShipperAgingController", "x-operation-name": "findInvoicePayment", "tags": [ "BrokerShipperAgingController" ], "responses": { "200": { "description": "Array of Invoices has many InvoicePayment", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InvoicePayment" } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } ], "operationId": "BrokerShipperAgingController.findInvoicePayment" } }, "/broker-month-till-date-report": { "get": { "x-controller-name": "ReportsController", "x-operation-name": "brokerMonthTillDateReport", "tags": [ "ReportsController" ], "responses": { "200": { "description": "Broker margin and shipment summary for all brokers for a given month and manager", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } } } } } }, "description": "\n\n| Permissions |\n| ------- |\n| view portal reports |\n", "parameters": [ { "name": "month", "in": "query", "schema": { "type": "string" }, "required": true, "description": "Month in YYYY-MM format" }, { "name": "managerId", "in": "query", "schema": { "type": "number" }, "required": true, "description": "Manager ID" }, { "name": "to", "in": "query", "schema": { "type": "string" }, "required": false, "description": "Recipient email address(es). Can be a single email or comma-separated multiple emails (e.g., \"email1@example.com,email2@example.com\")" }, { "name": "message", "in": "query", "schema": { "type": "string" }, "required": false, "description": "Message to include in email body" }, { "name": "userIds", "in": "query", "schema": { "type": "string" }, "required": false, "description": "Comma-separated userIds. Only export for these brokers if provided. Example: 1,2,3" }, { "name": "export", "in": "query", "schema": { "type": "boolean" }, "required": false, "description": "Export as CSV" } ], "operationId": "ReportsController.brokerMonthTillDateReport" } }, "/broker-month-till-date-report-new": { "get": { "x-controller-name": "BrokerReportsController", "x-operation-name": "brokerMonthTillDateReportNew", "tags": [ "BrokerReportsController" ], "responses": { "200": { "description": "Broker margin and shipment summary for all brokers for a given month and manager", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } } } } } }, "description": "", "parameters": [ { "name": "month", "in": "query", "schema": { "type": "string" }, "required": true, "description": "Month in YYYY-MM format" }, { "name": "managerId", "in": "query", "schema": { "type": "number" }, "required": true, "description": "Manager ID" } ], "operationId": "BrokerReportsController.brokerMonthTillDateReportNew" } }, "/broker-notes/{id}/invoicesId": { "get": { "x-controller-name": "BrokerShipperAgingController", "x-operation-name": "getInvoicesID", "tags": [ "BrokerShipperAgingController" ], "responses": { "200": { "description": "Invoices belonging to Notes", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Invoices" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "BrokerShipperAgingController.getInvoicesID" } }, "/broker-revenue": { "get": { "x-controller-name": "BrokerHomeController", "x-operation-name": "BrokerRevenue", "tags": [ "BrokerHomeController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker view dashboard |\n", "responses": { "200": { "description": "List of TM and Team Revenue", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "additionalProperties": true } } } } } }, "parameters": [ { "name": "fromDate", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "toDate", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "marginType", "in": "query", "schema": { "type": "string" } } ], "operationId": "BrokerHomeController.BrokerRevenue" } }, "/broker-revenue-details-by-manager": { "get": { "x-controller-name": "BrokerHomeController", "x-operation-name": "BrokerRevenueDetails", "tags": [ "BrokerHomeController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker view dashboard |\n", "responses": { "200": { "description": "List of TM and Team Revenue", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "additionalProperties": true } } } } } }, "parameters": [ { "name": "fromDate", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "toDate", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "usersId", "in": "query", "schema": { "type": "string" } }, { "name": "revenueTypes", "in": "query", "schema": { "type": "string" } } ], "operationId": "BrokerHomeController.BrokerRevenueDetails" } }, "/broker-revenue-details-by-manager-incentive": { "get": { "x-controller-name": "BrokerDashboardController", "x-operation-name": "BrokerRevenueDetails", "tags": [ "BrokerDashboardController" ], "description": "", "responses": { "200": { "description": "List of TM and Team Revenue", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "additionalProperties": true } } } } } }, "parameters": [ { "name": "fromDate", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "toDate", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "usersId", "in": "query", "schema": { "type": "string" } }, { "name": "revenueTypes", "in": "query", "schema": { "type": "string" } } ], "operationId": "BrokerDashboardController.BrokerRevenueDetails" } }, "/broker-revenue-details-by-teamlead": { "get": { "x-controller-name": "BrokerHomeController", "x-operation-name": "BrokerRevenueDetailsTeamLead", "tags": [ "BrokerHomeController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker view dashboard |\n", "responses": { "200": { "description": "List of TM and Team Revenue", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "additionalProperties": true } } } } } }, "parameters": [ { "name": "fromDate", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "toDate", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "usersId", "in": "query", "schema": { "type": "string" } }, { "name": "revenueTypes", "in": "query", "schema": { "type": "string" } } ], "operationId": "BrokerHomeController.BrokerRevenueDetailsTeamLead" } }, "/broker-revenue-details-by-teamlead-incentive": { "get": { "x-controller-name": "BrokerDashboardController", "x-operation-name": "BrokerRevenueDetailsTeamLead", "tags": [ "BrokerDashboardController" ], "description": "", "responses": { "200": { "description": "List of TM and Team Revenue", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "additionalProperties": true } } } } } }, "parameters": [ { "name": "fromDate", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "toDate", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "usersId", "in": "query", "schema": { "type": "string" } }, { "name": "revenueTypes", "in": "query", "schema": { "type": "string" } } ], "operationId": "BrokerDashboardController.BrokerRevenueDetailsTeamLead" } }, "/broker-revenue-incentive": { "get": { "x-controller-name": "BrokerDashboardController", "x-operation-name": "BrokerRevenue", "tags": [ "BrokerDashboardController" ], "description": "", "responses": { "200": { "description": "List of TM and Team Revenue", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "additionalProperties": true } } } } } }, "parameters": [ { "name": "fromDate", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "toDate", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "marginType", "in": "query", "schema": { "type": "string" } } ], "operationId": "BrokerDashboardController.BrokerRevenue" } }, "/broker-shipper-details": { "post": { "x-controller-name": "ShippersController", "x-operation-name": "brokerShipperDetails", "tags": [ "ShippersController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker create shipper |\n", "responses": { "200": { "description": "Shippers model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Shippers" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "ShippersController.brokerShipperDetails" } }, "/broker-shipper-limit-request": { "post": { "x-controller-name": "ArshipperLimitController", "x-operation-name": "ShipperlimitRequest", "tags": [ "ArshipperLimitController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker create shipment |\n", "responses": { "200": { "description": "Return value of ArshipperLimitController.ShipperlimitRequest", "content": {} }, "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Shipper Limit PATCH success" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "ArshipperLimitController.ShipperlimitRequest" } }, "/broker-vin-notes": { "post": { "x-controller-name": "BrokerVinVerificationController", "x-operation-name": "createNotes", "tags": [ "BrokerVinVerificationController" ], "description": "", "responses": { "200": { "description": "Notes model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Shipment" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "BrokerVinVerificationController.createNotes" } }, "/broker-vl-incentives/count": { "get": { "x-controller-name": "BrokerVlIncentivesController", "x-operation-name": "count", "tags": [ "BrokerVlIncentivesController" ], "responses": { "200": { "description": "BrokerVlIncentives model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "BrokerVlIncentives.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "BrokerVlIncentivesController.count" } }, "/broker-vl-incentives/{id}": { "put": { "x-controller-name": "BrokerVlIncentivesController", "x-operation-name": "replaceById", "tags": [ "BrokerVlIncentivesController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "BrokerVlIncentives PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrokerVlIncentives" } } }, "x-parameter-index": 1 }, "operationId": "BrokerVlIncentivesController.replaceById" }, "patch": { "x-controller-name": "BrokerVlIncentivesController", "x-operation-name": "updateById", "tags": [ "BrokerVlIncentivesController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "BrokerVlIncentives PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrokerVlIncentivesPartial" } } }, "x-parameter-index": 1 }, "operationId": "BrokerVlIncentivesController.updateById" }, "get": { "x-controller-name": "BrokerVlIncentivesController", "x-operation-name": "findById", "tags": [ "BrokerVlIncentivesController" ], "responses": { "200": { "description": "BrokerVlIncentives model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrokerVlIncentivesWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrokerVlIncentives.Filter" } } } } ], "operationId": "BrokerVlIncentivesController.findById" }, "delete": { "x-controller-name": "BrokerVlIncentivesController", "x-operation-name": "deleteById", "tags": [ "BrokerVlIncentivesController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "BrokerVlIncentives DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "BrokerVlIncentivesController.deleteById" } }, "/broker-vl-incentives": { "post": { "x-controller-name": "BrokerVlIncentivesController", "x-operation-name": "create", "tags": [ "BrokerVlIncentivesController" ], "responses": { "200": { "description": "BrokerVlIncentives model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrokerVlIncentives" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewBrokerVlIncentives" } } } }, "operationId": "BrokerVlIncentivesController.create" }, "patch": { "x-controller-name": "BrokerVlIncentivesController", "x-operation-name": "updateAll", "tags": [ "BrokerVlIncentivesController" ], "responses": { "200": { "description": "BrokerVlIncentives PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "BrokerVlIncentives.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrokerVlIncentivesPartial" } } } }, "operationId": "BrokerVlIncentivesController.updateAll" }, "get": { "x-controller-name": "BrokerVlIncentivesController", "x-operation-name": "find", "tags": [ "BrokerVlIncentivesController" ], "responses": { "200": { "description": "Array of BrokerVlIncentives model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BrokerVlIncentivesWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrokerVlIncentives.Filter1" } } } } ], "operationId": "BrokerVlIncentivesController.find" } }, "/broker-vl-incentives-calenders/count": { "get": { "x-controller-name": "BrokerVlIncentivesCalenderController", "x-operation-name": "count", "tags": [ "BrokerVlIncentivesCalenderController" ], "responses": { "200": { "description": "BrokerVlIncentivesCalender model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "BrokerVlIncentivesCalender.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "BrokerVlIncentivesCalenderController.count" } }, "/broker-vl-incentives-calenders/{id}": { "put": { "x-controller-name": "BrokerVlIncentivesCalenderController", "x-operation-name": "replaceById", "tags": [ "BrokerVlIncentivesCalenderController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "BrokerVlIncentivesCalender PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrokerVlIncentivesCalender" } } }, "x-parameter-index": 1 }, "operationId": "BrokerVlIncentivesCalenderController.replaceById" }, "patch": { "x-controller-name": "BrokerVlIncentivesCalenderController", "x-operation-name": "updateById", "tags": [ "BrokerVlIncentivesCalenderController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "BrokerVlIncentivesCalender PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrokerVlIncentivesCalenderPartial" } } }, "x-parameter-index": 1 }, "operationId": "BrokerVlIncentivesCalenderController.updateById" }, "get": { "x-controller-name": "BrokerVlIncentivesCalenderController", "x-operation-name": "findById", "tags": [ "BrokerVlIncentivesCalenderController" ], "responses": { "200": { "description": "BrokerVlIncentivesCalender model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrokerVlIncentivesCalenderWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrokerVlIncentivesCalender.Filter" } } } } ], "operationId": "BrokerVlIncentivesCalenderController.findById" }, "delete": { "x-controller-name": "BrokerVlIncentivesCalenderController", "x-operation-name": "deleteById", "tags": [ "BrokerVlIncentivesCalenderController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "BrokerVlIncentivesCalender DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "BrokerVlIncentivesCalenderController.deleteById" } }, "/broker-vl-incentives-calenders": { "post": { "x-controller-name": "BrokerVlIncentivesCalenderController", "x-operation-name": "create", "tags": [ "BrokerVlIncentivesCalenderController" ], "responses": { "200": { "description": "BrokerVlIncentivesCalender model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrokerVlIncentivesCalender" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewBrokerVlIncentivesCalender" } } } }, "operationId": "BrokerVlIncentivesCalenderController.create" }, "patch": { "x-controller-name": "BrokerVlIncentivesCalenderController", "x-operation-name": "updateAll", "tags": [ "BrokerVlIncentivesCalenderController" ], "responses": { "200": { "description": "BrokerVlIncentivesCalender PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "BrokerVlIncentivesCalender.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrokerVlIncentivesCalenderPartial" } } } }, "operationId": "BrokerVlIncentivesCalenderController.updateAll" }, "get": { "x-controller-name": "BrokerVlIncentivesCalenderController", "x-operation-name": "find", "tags": [ "BrokerVlIncentivesCalenderController" ], "responses": { "200": { "description": "Array of BrokerVlIncentivesCalender model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BrokerVlIncentivesCalenderWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrokerVlIncentivesCalender.Filter1" } } } } ], "operationId": "BrokerVlIncentivesCalenderController.find" } }, "/broker-vl-otr-incentives/count": { "get": { "x-controller-name": "BrokerVlOtrIncentivesController", "x-operation-name": "count", "tags": [ "BrokerVlOtrIncentivesController" ], "responses": { "200": { "description": "BrokerVlOtrIncentives model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "BrokerVlOtrIncentives.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "BrokerVlOtrIncentivesController.count" } }, "/broker-vl-otr-incentives/{id}": { "put": { "x-controller-name": "BrokerVlOtrIncentivesController", "x-operation-name": "replaceById", "tags": [ "BrokerVlOtrIncentivesController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "BrokerVlOtrIncentives PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrokerVlOtrIncentives" } } }, "x-parameter-index": 1 }, "operationId": "BrokerVlOtrIncentivesController.replaceById" }, "patch": { "x-controller-name": "BrokerVlOtrIncentivesController", "x-operation-name": "updateById", "tags": [ "BrokerVlOtrIncentivesController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "BrokerVlOtrIncentives PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrokerVlOtrIncentivesPartial" } } }, "x-parameter-index": 1 }, "operationId": "BrokerVlOtrIncentivesController.updateById" }, "get": { "x-controller-name": "BrokerVlOtrIncentivesController", "x-operation-name": "findById", "tags": [ "BrokerVlOtrIncentivesController" ], "responses": { "200": { "description": "BrokerVlOtrIncentives model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrokerVlOtrIncentivesWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrokerVlOtrIncentives.Filter" } } } } ], "operationId": "BrokerVlOtrIncentivesController.findById" }, "delete": { "x-controller-name": "BrokerVlOtrIncentivesController", "x-operation-name": "deleteById", "tags": [ "BrokerVlOtrIncentivesController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "BrokerVlOtrIncentives DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "BrokerVlOtrIncentivesController.deleteById" } }, "/broker-vl-otr-incentives": { "post": { "x-controller-name": "BrokerVlOtrIncentivesController", "x-operation-name": "create", "tags": [ "BrokerVlOtrIncentivesController" ], "responses": { "200": { "description": "BrokerVlOtrIncentives model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrokerVlOtrIncentives" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewBrokerVlOtrIncentives" } } } }, "operationId": "BrokerVlOtrIncentivesController.create" }, "patch": { "x-controller-name": "BrokerVlOtrIncentivesController", "x-operation-name": "updateAll", "tags": [ "BrokerVlOtrIncentivesController" ], "responses": { "200": { "description": "BrokerVlOtrIncentives PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "BrokerVlOtrIncentives.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrokerVlOtrIncentivesPartial" } } } }, "operationId": "BrokerVlOtrIncentivesController.updateAll" }, "get": { "x-controller-name": "BrokerVlOtrIncentivesController", "x-operation-name": "find", "tags": [ "BrokerVlOtrIncentivesController" ], "responses": { "200": { "description": "Array of BrokerVlOtrIncentives model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BrokerVlOtrIncentivesWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrokerVlOtrIncentives.Filter1" } } } } ], "operationId": "BrokerVlOtrIncentivesController.find" } }, "/broker-vl-otr-incentives-news/count": { "get": { "x-controller-name": "BrokerVlOtrIncentivesNewController", "x-operation-name": "count", "tags": [ "BrokerVlOtrIncentivesNewController" ], "responses": { "200": { "description": "BrokerVlOtrIncentivesNew model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "BrokerVlOtrIncentivesNew.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "BrokerVlOtrIncentivesNewController.count" } }, "/broker-vl-otr-incentives-news/{id}": { "put": { "x-controller-name": "BrokerVlOtrIncentivesNewController", "x-operation-name": "replaceById", "tags": [ "BrokerVlOtrIncentivesNewController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "BrokerVlOtrIncentivesNew PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrokerVlOtrIncentivesNew" } } }, "x-parameter-index": 1 }, "operationId": "BrokerVlOtrIncentivesNewController.replaceById" }, "patch": { "x-controller-name": "BrokerVlOtrIncentivesNewController", "x-operation-name": "updateById", "tags": [ "BrokerVlOtrIncentivesNewController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "BrokerVlOtrIncentivesNew PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrokerVlOtrIncentivesNewPartial" } } }, "x-parameter-index": 1 }, "operationId": "BrokerVlOtrIncentivesNewController.updateById" }, "get": { "x-controller-name": "BrokerVlOtrIncentivesNewController", "x-operation-name": "findById", "tags": [ "BrokerVlOtrIncentivesNewController" ], "responses": { "200": { "description": "BrokerVlOtrIncentivesNew model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrokerVlOtrIncentivesNewWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrokerVlOtrIncentivesNew.Filter" } } } } ], "operationId": "BrokerVlOtrIncentivesNewController.findById" }, "delete": { "x-controller-name": "BrokerVlOtrIncentivesNewController", "x-operation-name": "deleteById", "tags": [ "BrokerVlOtrIncentivesNewController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "BrokerVlOtrIncentivesNew DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "BrokerVlOtrIncentivesNewController.deleteById" } }, "/broker-vl-otr-incentives-news": { "post": { "x-controller-name": "BrokerVlOtrIncentivesNewController", "x-operation-name": "create", "tags": [ "BrokerVlOtrIncentivesNewController" ], "responses": { "200": { "description": "BrokerVlOtrIncentivesNew model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrokerVlOtrIncentivesNew" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewBrokerVlOtrIncentivesNew" } } } }, "operationId": "BrokerVlOtrIncentivesNewController.create" }, "patch": { "x-controller-name": "BrokerVlOtrIncentivesNewController", "x-operation-name": "updateAll", "tags": [ "BrokerVlOtrIncentivesNewController" ], "responses": { "200": { "description": "BrokerVlOtrIncentivesNew PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "BrokerVlOtrIncentivesNew.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrokerVlOtrIncentivesNewPartial" } } } }, "operationId": "BrokerVlOtrIncentivesNewController.updateAll" }, "get": { "x-controller-name": "BrokerVlOtrIncentivesNewController", "x-operation-name": "find", "tags": [ "BrokerVlOtrIncentivesNewController" ], "responses": { "200": { "description": "Array of BrokerVlOtrIncentivesNew model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BrokerVlOtrIncentivesNewWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrokerVlOtrIncentivesNew.Filter1" } } } } ], "operationId": "BrokerVlOtrIncentivesNewController.find" } }, "/broker-vl-otr-incentives-tls/count": { "get": { "x-controller-name": "BrokerVlOtrIncentivesTlController", "x-operation-name": "count", "tags": [ "BrokerVlOtrIncentivesTlController" ], "responses": { "200": { "description": "BrokerVlOtrIncentivesTl model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "BrokerVlOtrIncentivesTl.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "BrokerVlOtrIncentivesTlController.count" } }, "/broker-vl-otr-incentives-tls/{id}": { "put": { "x-controller-name": "BrokerVlOtrIncentivesTlController", "x-operation-name": "replaceById", "tags": [ "BrokerVlOtrIncentivesTlController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "BrokerVlOtrIncentivesTl PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrokerVlOtrIncentivesTl" } } }, "x-parameter-index": 1 }, "operationId": "BrokerVlOtrIncentivesTlController.replaceById" }, "patch": { "x-controller-name": "BrokerVlOtrIncentivesTlController", "x-operation-name": "updateById", "tags": [ "BrokerVlOtrIncentivesTlController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "BrokerVlOtrIncentivesTl PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrokerVlOtrIncentivesTlPartial" } } }, "x-parameter-index": 1 }, "operationId": "BrokerVlOtrIncentivesTlController.updateById" }, "get": { "x-controller-name": "BrokerVlOtrIncentivesTlController", "x-operation-name": "findById", "tags": [ "BrokerVlOtrIncentivesTlController" ], "responses": { "200": { "description": "BrokerVlOtrIncentivesTl model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrokerVlOtrIncentivesTlWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrokerVlOtrIncentivesTl.Filter" } } } } ], "operationId": "BrokerVlOtrIncentivesTlController.findById" }, "delete": { "x-controller-name": "BrokerVlOtrIncentivesTlController", "x-operation-name": "deleteById", "tags": [ "BrokerVlOtrIncentivesTlController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "BrokerVlOtrIncentivesTl DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "BrokerVlOtrIncentivesTlController.deleteById" } }, "/broker-vl-otr-incentives-tls": { "post": { "x-controller-name": "BrokerVlOtrIncentivesTlController", "x-operation-name": "create", "tags": [ "BrokerVlOtrIncentivesTlController" ], "responses": { "200": { "description": "BrokerVlOtrIncentivesTl model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrokerVlOtrIncentivesTl" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewBrokerVlOtrIncentivesTl" } } } }, "operationId": "BrokerVlOtrIncentivesTlController.create" }, "patch": { "x-controller-name": "BrokerVlOtrIncentivesTlController", "x-operation-name": "updateAll", "tags": [ "BrokerVlOtrIncentivesTlController" ], "responses": { "200": { "description": "BrokerVlOtrIncentivesTl PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "BrokerVlOtrIncentivesTl.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrokerVlOtrIncentivesTlPartial" } } } }, "operationId": "BrokerVlOtrIncentivesTlController.updateAll" }, "get": { "x-controller-name": "BrokerVlOtrIncentivesTlController", "x-operation-name": "find", "tags": [ "BrokerVlOtrIncentivesTlController" ], "responses": { "200": { "description": "Array of BrokerVlOtrIncentivesTl model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BrokerVlOtrIncentivesTlWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrokerVlOtrIncentivesTl.Filter1" } } } } ], "operationId": "BrokerVlOtrIncentivesTlController.find" } }, "/broker-vl-otr-incentives-tms/count": { "get": { "x-controller-name": "BrokerVlOtrIncentivesTmController", "x-operation-name": "count", "tags": [ "BrokerVlOtrIncentivesTmController" ], "responses": { "200": { "description": "BrokerVlOtrIncentivesTm model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "BrokerVlOtrIncentivesTm.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "BrokerVlOtrIncentivesTmController.count" } }, "/broker-vl-otr-incentives-tms/{id}": { "put": { "x-controller-name": "BrokerVlOtrIncentivesTmController", "x-operation-name": "replaceById", "tags": [ "BrokerVlOtrIncentivesTmController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "BrokerVlOtrIncentivesTm PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrokerVlOtrIncentivesTm" } } }, "x-parameter-index": 1 }, "operationId": "BrokerVlOtrIncentivesTmController.replaceById" }, "patch": { "x-controller-name": "BrokerVlOtrIncentivesTmController", "x-operation-name": "updateById", "tags": [ "BrokerVlOtrIncentivesTmController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "BrokerVlOtrIncentivesTm PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrokerVlOtrIncentivesTmPartial" } } }, "x-parameter-index": 1 }, "operationId": "BrokerVlOtrIncentivesTmController.updateById" }, "get": { "x-controller-name": "BrokerVlOtrIncentivesTmController", "x-operation-name": "findById", "tags": [ "BrokerVlOtrIncentivesTmController" ], "responses": { "200": { "description": "BrokerVlOtrIncentivesTm model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrokerVlOtrIncentivesTmWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrokerVlOtrIncentivesTm.Filter" } } } } ], "operationId": "BrokerVlOtrIncentivesTmController.findById" }, "delete": { "x-controller-name": "BrokerVlOtrIncentivesTmController", "x-operation-name": "deleteById", "tags": [ "BrokerVlOtrIncentivesTmController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "BrokerVlOtrIncentivesTm DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "BrokerVlOtrIncentivesTmController.deleteById" } }, "/broker-vl-otr-incentives-tms": { "post": { "x-controller-name": "BrokerVlOtrIncentivesTmController", "x-operation-name": "create", "tags": [ "BrokerVlOtrIncentivesTmController" ], "responses": { "200": { "description": "BrokerVlOtrIncentivesTm model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrokerVlOtrIncentivesTm" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewBrokerVlOtrIncentivesTm" } } } }, "operationId": "BrokerVlOtrIncentivesTmController.create" }, "patch": { "x-controller-name": "BrokerVlOtrIncentivesTmController", "x-operation-name": "updateAll", "tags": [ "BrokerVlOtrIncentivesTmController" ], "responses": { "200": { "description": "BrokerVlOtrIncentivesTm PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "BrokerVlOtrIncentivesTm.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrokerVlOtrIncentivesTmPartial" } } } }, "operationId": "BrokerVlOtrIncentivesTmController.updateAll" }, "get": { "x-controller-name": "BrokerVlOtrIncentivesTmController", "x-operation-name": "find", "tags": [ "BrokerVlOtrIncentivesTmController" ], "responses": { "200": { "description": "Array of BrokerVlOtrIncentivesTm model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BrokerVlOtrIncentivesTmWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrokerVlOtrIncentivesTm.Filter1" } } } } ], "operationId": "BrokerVlOtrIncentivesTmController.find" } }, "/broker-vl-otr-locked-incentives/count": { "get": { "x-controller-name": "BrokerVlOtrLockedIncentivesController", "x-operation-name": "count", "tags": [ "BrokerVlOtrLockedIncentivesController" ], "responses": { "200": { "description": "BrokerVlOtrLockedIncentives model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "BrokerVlOtrLockedIncentives.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "BrokerVlOtrLockedIncentivesController.count" } }, "/broker-vl-otr-locked-incentives/{id}": { "put": { "x-controller-name": "BrokerVlOtrLockedIncentivesController", "x-operation-name": "replaceById", "tags": [ "BrokerVlOtrLockedIncentivesController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "BrokerVlOtrLockedIncentives PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrokerVlOtrLockedIncentives" } } }, "x-parameter-index": 1 }, "operationId": "BrokerVlOtrLockedIncentivesController.replaceById" }, "patch": { "x-controller-name": "BrokerVlOtrLockedIncentivesController", "x-operation-name": "updateById", "tags": [ "BrokerVlOtrLockedIncentivesController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "BrokerVlOtrLockedIncentives PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrokerVlOtrLockedIncentivesPartial" } } }, "x-parameter-index": 1 }, "operationId": "BrokerVlOtrLockedIncentivesController.updateById" }, "get": { "x-controller-name": "BrokerVlOtrLockedIncentivesController", "x-operation-name": "findById", "tags": [ "BrokerVlOtrLockedIncentivesController" ], "responses": { "200": { "description": "BrokerVlOtrLockedIncentives model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrokerVlOtrLockedIncentivesWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrokerVlOtrLockedIncentives.Filter" } } } } ], "operationId": "BrokerVlOtrLockedIncentivesController.findById" }, "delete": { "x-controller-name": "BrokerVlOtrLockedIncentivesController", "x-operation-name": "deleteById", "tags": [ "BrokerVlOtrLockedIncentivesController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "BrokerVlOtrLockedIncentives DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "BrokerVlOtrLockedIncentivesController.deleteById" } }, "/broker-vl-otr-locked-incentives": { "post": { "x-controller-name": "BrokerVlOtrLockedIncentivesController", "x-operation-name": "create", "tags": [ "BrokerVlOtrLockedIncentivesController" ], "responses": { "200": { "description": "BrokerVlOtrLockedIncentives model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrokerVlOtrLockedIncentives" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewBrokerVlOtrLockedIncentives" } } } }, "operationId": "BrokerVlOtrLockedIncentivesController.create" }, "patch": { "x-controller-name": "BrokerVlOtrLockedIncentivesController", "x-operation-name": "updateAll", "tags": [ "BrokerVlOtrLockedIncentivesController" ], "responses": { "200": { "description": "BrokerVlOtrLockedIncentives PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "BrokerVlOtrLockedIncentives.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrokerVlOtrLockedIncentivesPartial" } } } }, "operationId": "BrokerVlOtrLockedIncentivesController.updateAll" }, "get": { "x-controller-name": "BrokerVlOtrLockedIncentivesController", "x-operation-name": "find", "tags": [ "BrokerVlOtrLockedIncentivesController" ], "responses": { "200": { "description": "Array of BrokerVlOtrLockedIncentives model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BrokerVlOtrLockedIncentivesWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BrokerVlOtrLockedIncentives.Filter1" } } } } ], "operationId": "BrokerVlOtrLockedIncentivesController.find" } }, "/cancel/shipment/{id}": { "post": { "x-controller-name": "ShipmentController", "x-operation-name": "cancelShipment", "tags": [ "ShipmentController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker create shipment |\n", "responses": { "200": { "description": "Shipment model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Shipment" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "ShipmentController.cancelShipment" } }, "/cancelTracking": { "post": { "x-controller-name": "ShipmentTrackingController", "x-operation-name": "cancelTracking", "tags": [ "ShipmentTrackingController" ], "responses": { "200": { "description": "Cancel tracking response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "boolean" }, "message": { "type": "string" } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "ShipmentTrackingController.cancelTracking" } }, "/carrier-advance-payment": { "post": { "x-controller-name": "CarrierAgingController", "x-operation-name": "carrierAdvancePayment", "tags": [ "CarrierAgingController" ], "description": "\n\n| Permissions |\n| ------- |\n| ap carrier aging |\n", "responses": { "200": { "description": "CarrierAging History model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CarrierAging" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "CarrierAgingController.carrierAdvancePayment" } }, "/carrier-aging/check": { "get": { "x-controller-name": "CarrierAgingController", "x-operation-name": "checkCarrierAging", "tags": [ "CarrierAgingController" ], "responses": { "200": { "description": "Check if a carrier aging entry exists based on shipmentId and carriersId", "content": { "application/json": { "schema": { "type": "object", "properties": { "exists": { "type": "boolean" }, "carrierAging": { "type": "object", "properties": { "id": { "type": "number" }, "carriersId": { "type": "number" }, "shipmentId": { "type": "number" } } } } } } } } }, "parameters": [ { "name": "shipmentId", "in": "query", "schema": { "type": "number" } }, { "name": "carriersId", "in": "query", "schema": { "type": "number" } } ], "operationId": "CarrierAgingController.checkCarrierAging" } }, "/carrier-agings/count": { "get": { "x-controller-name": "CarrierAgingController", "x-operation-name": "count", "tags": [ "CarrierAgingController" ], "responses": { "200": { "description": "CarrierAging model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "CarrierAging.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "CarrierAgingController.count" } }, "/carrier-agings/{id}/carriers": { "get": { "x-controller-name": "CarrierAgingCarriersController", "x-operation-name": "getCarriers", "tags": [ "CarrierAgingCarriersController" ], "responses": { "200": { "description": "Carriers belonging to CarrierAging", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Carriers" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CarrierAgingCarriersController.getCarriers" } }, "/carrier-agings/{id}/portal": { "get": { "x-controller-name": "CarrierAgingPortalController", "x-operation-name": "getPortal", "tags": [ "CarrierAgingPortalController" ], "responses": { "200": { "description": "Portal belonging to CarrierAging", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Portal" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CarrierAgingPortalController.getPortal" } }, "/carrier-agings/{id}/shipment": { "get": { "x-controller-name": "CarrierAgingShipmentController", "x-operation-name": "getShipment", "tags": [ "CarrierAgingShipmentController" ], "responses": { "200": { "description": "Shipment belonging to CarrierAging", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Shipment" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CarrierAgingShipmentController.getShipment" } }, "/carrier-agings/{id}/user": { "get": { "x-controller-name": "CarrierAgingUserController", "x-operation-name": "getUser", "tags": [ "CarrierAgingUserController" ], "responses": { "200": { "description": "User belonging to CarrierAging", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CarrierAgingUserController.getUser" } }, "/carrier-agings/{id}": { "put": { "x-controller-name": "CarrierAgingController", "x-operation-name": "replaceById", "tags": [ "CarrierAgingController" ], "description": "\n\n| Permissions |\n| ------- |\n| ap carrier aging |\n", "responses": { "200": { "description": "Return value of CarrierAgingController.replaceById", "content": {} }, "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "CarrierAging PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CarrierAging" } } }, "x-parameter-index": 1 }, "operationId": "CarrierAgingController.replaceById" }, "patch": { "x-controller-name": "CarrierAgingController", "x-operation-name": "updateById", "tags": [ "CarrierAgingController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "CarrierAging PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CarrierAgingPartial" } } }, "x-parameter-index": 1 }, "operationId": "CarrierAgingController.updateById" }, "get": { "x-controller-name": "CarrierAgingController", "x-operation-name": "findById", "tags": [ "CarrierAgingController" ], "responses": { "200": { "description": "CarrierAging model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CarrierAgingWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CarrierAging.Filter" } } } } ], "operationId": "CarrierAgingController.findById" }, "delete": { "x-controller-name": "CarrierAgingController", "x-operation-name": "deleteById", "tags": [ "CarrierAgingController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "CarrierAging DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CarrierAgingController.deleteById" } }, "/carrier-agings": { "post": { "x-controller-name": "CarrierAgingController", "x-operation-name": "create", "tags": [ "CarrierAgingController" ], "description": "\n\n| Permissions |\n| ------- |\n| ap carrier aging |\n", "responses": { "200": { "description": "CarrierAging model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CarrierAging" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "CarrierAgingController.create" }, "patch": { "x-controller-name": "CarrierAgingController", "x-operation-name": "updateAll", "tags": [ "CarrierAgingController" ], "responses": { "200": { "description": "CarrierAging PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "CarrierAging.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CarrierAgingPartial" } } } }, "operationId": "CarrierAgingController.updateAll" }, "get": { "x-controller-name": "CarrierAgingController", "x-operation-name": "find", "tags": [ "CarrierAgingController" ], "responses": { "200": { "description": "Array of CarrierAging model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CarrierAgingWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CarrierAging.Filter1" } } } } ], "operationId": "CarrierAgingController.find" } }, "/carrier-agings-data": { "get": { "x-controller-name": "CarrierAgingController", "x-operation-name": "findAllData", "tags": [ "CarrierAgingController" ], "responses": { "200": { "description": "Array of CarrierAging model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CarrierAgingWithRelations" } } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "CarrierAging.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } }, { "name": "page", "in": "query", "schema": { "type": "number" } }, { "name": "limit", "in": "query", "schema": { "type": "number" } } ], "operationId": "CarrierAgingController.findAllData" } }, "/carrier-back-off-logs/{id}/carriers": { "get": { "x-controller-name": "CarrierBackOffLogsCarriersController", "x-operation-name": "getCarriers", "tags": [ "CarrierBackOffLogsCarriersController" ], "responses": { "200": { "description": "Carriers belonging to CarrierBackOffLogs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Carriers" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CarrierBackOffLogsCarriersController.getCarriers" } }, "/carrier-back-off-logs/{id}/portal": { "get": { "x-controller-name": "CarrierBackOffLogsPortalController", "x-operation-name": "getPortal", "tags": [ "CarrierBackOffLogsPortalController" ], "responses": { "200": { "description": "Portal belonging to CarrierBackOffLogs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Portal" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CarrierBackOffLogsPortalController.getPortal" } }, "/carrier-back-off-logs/{id}/shipment": { "get": { "x-controller-name": "CarrierBackOffLogsShipmentController", "x-operation-name": "getShipment", "tags": [ "CarrierBackOffLogsShipmentController" ], "responses": { "200": { "description": "Shipment belonging to CarrierBackOffLogs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Shipment" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CarrierBackOffLogsShipmentController.getShipment" } }, "/carrier-back-off-logs/{id}/user": { "get": { "x-controller-name": "CarrierBackOffLogsUserController", "x-operation-name": "getUser", "tags": [ "CarrierBackOffLogsUserController" ], "responses": { "200": { "description": "User belonging to CarrierBackOffLogs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CarrierBackOffLogsUserController.getUser" } }, "/carrier-docs/{id}/approval-status": { "post": { "x-controller-name": "CarriersController", "x-operation-name": "updateCarrierDocApprovalStatus", "tags": [ "CarriersController" ], "description": "", "responses": { "200": { "description": "Update carrier doc approval status", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "action", "remark" ], "properties": { "remark": { "type": "string", "description": "Remark for the action" }, "action": { "type": "number", "description": "Action to perform: approved or rejected" } } } } }, "x-parameter-index": 1 }, "operationId": "CarriersController.updateCarrierDocApprovalStatus" } }, "/carrier-docs/{id}/document-status": { "post": { "x-controller-name": "CarriersController", "x-operation-name": "updateCarrierDocumentStatus", "tags": [ "CarriersController" ], "description": "", "responses": { "200": { "description": "Update specific carrier document status (POD, TRI, Lumper, Other, Invoice)", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "status" ], "properties": { "type": { "type": "string", "enum": [ "podDocStatus", "triDocStatus", "lumperDocStatus", "otherDocStatus", "invoiceDocStatus" ], "description": "Type of document status to update" }, "status": { "type": "number", "enum": [ 1, 2 ], "description": "1 for approved, 2 for rejected" }, "remark": { "type": "string", "description": "Optional remark for the action" } } } } }, "x-parameter-index": 1 }, "operationId": "CarriersController.updateCarrierDocumentStatus" } }, "/carrier-hold-comments/{id}": { "get": { "x-controller-name": "CarrierAgingController", "x-operation-name": "getCarrierHoldComments", "tags": [ "CarrierAgingController" ], "responses": { "200": { "description": "Array of CarrierAging model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CarrierHoldMessageWithRelations" } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "CarrierAgingController.getCarrierHoldComments" } }, "/carrier-hold-messages/{id}/carrier-aging": { "get": { "x-controller-name": "CarrierHoldMessageCarrierAgingController", "x-operation-name": "getCarrierAging", "tags": [ "CarrierHoldMessageCarrierAgingController" ], "responses": { "200": { "description": "CarrierAging belonging to CarrierHoldMessage", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CarrierAging" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CarrierHoldMessageCarrierAgingController.getCarrierAging" } }, "/carrier-hold-messages/{id}/user": { "get": { "x-controller-name": "CarrierHoldMessageUserController", "x-operation-name": "getUser", "tags": [ "CarrierHoldMessageUserController" ], "responses": { "200": { "description": "User belonging to CarrierHoldMessage", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CarrierHoldMessageUserController.getUser" } }, "/carrier-hold-payment": { "post": { "x-controller-name": "CarrierAgingController", "x-operation-name": "carrierHoldStatus", "tags": [ "CarrierAgingController" ], "description": "\n\n| Permissions |\n| ------- |\n| ap carrier aging |\n", "responses": { "200": { "description": "CarrierAging History model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CarrierAging" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "CarrierAgingController.carrierHoldStatus" } }, "/carrier-logins/count": { "get": { "x-controller-name": "CarrierLoginControllerController", "x-operation-name": "count", "tags": [ "CarrierLoginControllerController" ], "responses": { "200": { "description": "CarrierLogin model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "CarrierLogin.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "CarrierLoginControllerController.count" } }, "/carrier-logins/{id}": { "put": { "x-controller-name": "CarrierLoginControllerController", "x-operation-name": "replaceById", "tags": [ "CarrierLoginControllerController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "CarrierLogin PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CarrierLogin" } } }, "x-parameter-index": 1 }, "operationId": "CarrierLoginControllerController.replaceById" }, "patch": { "x-controller-name": "CarrierLoginControllerController", "x-operation-name": "updateById", "tags": [ "CarrierLoginControllerController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "CarrierLogin PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CarrierLoginPartial" } } }, "x-parameter-index": 1 }, "operationId": "CarrierLoginControllerController.updateById" }, "get": { "x-controller-name": "CarrierLoginControllerController", "x-operation-name": "findById", "tags": [ "CarrierLoginControllerController" ], "responses": { "200": { "description": "CarrierLogin model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CarrierLoginWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CarrierLogin.Filter" } } } } ], "operationId": "CarrierLoginControllerController.findById" }, "delete": { "x-controller-name": "CarrierLoginControllerController", "x-operation-name": "deleteById", "tags": [ "CarrierLoginControllerController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "CarrierLogin DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CarrierLoginControllerController.deleteById" } }, "/carrier-logins": { "patch": { "x-controller-name": "CarrierLoginControllerController", "x-operation-name": "updateAll", "tags": [ "CarrierLoginControllerController" ], "responses": { "200": { "description": "CarrierLogin PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "CarrierLogin.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CarrierLoginPartial" } } } }, "operationId": "CarrierLoginControllerController.updateAll" }, "get": { "x-controller-name": "CarrierLoginControllerController", "x-operation-name": "find", "tags": [ "CarrierLoginControllerController" ], "responses": { "200": { "description": "Array of CarrierLogin model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CarrierLoginWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CarrierLogin.Filter1" } } } } ], "operationId": "CarrierLoginControllerController.find" } }, "/carrier-payment/ap-messages-histories/latest/{shipmentId}": { "get": { "x-controller-name": "CarrierPaymentController", "x-operation-name": "findLatestByShipmentId", "tags": [ "CarrierPaymentController" ], "description": "", "responses": { "200": { "description": "Latest ApMessagesHistory model instance for a given shipmentId", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApMessagesHistoryWithRelations" } } } } }, "parameters": [ { "name": "shipmentId", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CarrierPaymentController.findLatestByShipmentId" } }, "/carrier-payment/hold": { "post": { "x-controller-name": "CarrierPaymentController", "x-operation-name": "holdShipment", "tags": [ "CarrierPaymentController" ], "description": "\n\n| Permissions |\n| ------- |\n| ap carrier payment |\n", "responses": { "200": { "description": "Return value of CarrierPaymentController.holdShipment", "content": {} } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "shipmentId": { "type": "number" }, "note": { "type": "string" }, "hold": { "type": "boolean" } } } } } }, "operationId": "CarrierPaymentController.holdShipment" } }, "/carrier-payment-dones/count": { "get": { "x-controller-name": "CarrierPaymentDoneController", "x-operation-name": "count", "tags": [ "CarrierPaymentDoneController" ], "responses": { "200": { "description": "CarrierPaymentDone model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "CarrierPaymentDone.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "CarrierPaymentDoneController.count" } }, "/carrier-payment-dones/{id}": { "put": { "x-controller-name": "CarrierPaymentDoneController", "x-operation-name": "replaceById", "tags": [ "CarrierPaymentDoneController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "CarrierPaymentDone PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CarrierPaymentDone" } } }, "x-parameter-index": 1 }, "operationId": "CarrierPaymentDoneController.replaceById" }, "patch": { "x-controller-name": "CarrierPaymentDoneController", "x-operation-name": "updateById", "tags": [ "CarrierPaymentDoneController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "CarrierPaymentDone PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CarrierPaymentDonePartial" } } }, "x-parameter-index": 1 }, "operationId": "CarrierPaymentDoneController.updateById" }, "get": { "x-controller-name": "CarrierPaymentDoneController", "x-operation-name": "findById", "tags": [ "CarrierPaymentDoneController" ], "responses": { "200": { "description": "CarrierPaymentDone model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CarrierPaymentDoneWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CarrierPaymentDone.Filter" } } } } ], "operationId": "CarrierPaymentDoneController.findById" }, "delete": { "x-controller-name": "CarrierPaymentDoneController", "x-operation-name": "deleteById", "tags": [ "CarrierPaymentDoneController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "CarrierPaymentDone DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CarrierPaymentDoneController.deleteById" } }, "/carrier-payment-dones": { "post": { "x-controller-name": "CarrierPaymentDoneController", "x-operation-name": "create", "tags": [ "CarrierPaymentDoneController" ], "responses": { "200": { "description": "CarrierPaymentDone model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CarrierPaymentDone" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewCarrierPaymentDone" } } } }, "operationId": "CarrierPaymentDoneController.create" }, "patch": { "x-controller-name": "CarrierPaymentDoneController", "x-operation-name": "updateAll", "tags": [ "CarrierPaymentDoneController" ], "responses": { "200": { "description": "CarrierPaymentDone PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "CarrierPaymentDone.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CarrierPaymentDonePartial" } } } }, "operationId": "CarrierPaymentDoneController.updateAll" }, "get": { "x-controller-name": "CarrierPaymentDoneController", "x-operation-name": "find", "tags": [ "CarrierPaymentDoneController" ], "responses": { "200": { "description": "Array of CarrierPayment model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CarrierPaymentDoneWithRelations" } } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "CarrierPaymentDone.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } }, { "name": "page", "in": "query", "schema": { "type": "number" } }, { "name": "limit", "in": "query", "schema": { "type": "number" } } ], "operationId": "CarrierPaymentDoneController.find" } }, "/carrier-payment-hold-request": { "get": { "x-controller-name": "CarrierPaymentHoldRequestController", "x-operation-name": "find", "tags": [ "CarrierPaymentHoldRequestController" ], "description": "", "responses": { "200": { "description": "Array of CarrierPaymentHoldRequestHistory model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CarrierPaymentHoldRequestHistoryWithRelations" } } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "CarrierPaymentHoldRequestHistory.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } }, { "name": "page", "in": "query", "schema": { "type": "number" } }, { "name": "pageSize", "in": "query", "schema": { "type": "number" } } ], "operationId": "CarrierPaymentHoldRequestController.find" } }, "/carrier-payment-hold-request-ar-side": { "get": { "x-controller-name": "CarrierPaymentHoldRequestController", "x-operation-name": "findARSide", "tags": [ "CarrierPaymentHoldRequestController" ], "description": "", "responses": { "200": { "description": "Array of CarrierPaymentHoldRequestHistory model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CarrierPaymentHoldRequestHistoryWithRelations" } } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "CarrierPaymentHoldRequestHistory.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } }, { "name": "page", "in": "query", "schema": { "type": "number" } }, { "name": "pageSize", "in": "query", "schema": { "type": "number" } } ], "operationId": "CarrierPaymentHoldRequestController.findARSide" } }, "/carrier-payment-hold-request-histories/{id}/portal": { "get": { "x-controller-name": "CarrierPaymentHoldRequestHistoryPortalController", "x-operation-name": "getPortal", "tags": [ "CarrierPaymentHoldRequestHistoryPortalController" ], "responses": { "200": { "description": "Portal belonging to CarrierPaymentHoldRequestHistory", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Portal" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CarrierPaymentHoldRequestHistoryPortalController.getPortal" } }, "/carrier-payment-hold-request-histories/{id}/shipment": { "get": { "x-controller-name": "CarrierPaymentHoldRequestHistoryShipmentController", "x-operation-name": "getShipment", "tags": [ "CarrierPaymentHoldRequestHistoryShipmentController" ], "responses": { "200": { "description": "Shipment belonging to CarrierPaymentHoldRequestHistory", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Shipment" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CarrierPaymentHoldRequestHistoryShipmentController.getShipment" } }, "/carrier-payment-hold-request-histories/{id}/user": { "get": { "x-controller-name": "CarrierPaymentHoldRequestHistoryUserController", "x-operation-name": "getUser", "tags": [ "CarrierPaymentHoldRequestHistoryUserController" ], "responses": { "200": { "description": "User belonging to CarrierPaymentHoldRequestHistory", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CarrierPaymentHoldRequestHistoryUserController.getUser" } }, "/carrier-payment-request-logs/{id}/carrier-payment-hold-request-history": { "get": { "x-controller-name": "CarrierPaymentRequestLogCarrierPaymentHoldRequestHistoryController", "x-operation-name": "getCarrierPaymentHoldRequestHistory", "tags": [ "CarrierPaymentRequestLogCarrierPaymentHoldRequestHistoryController" ], "responses": { "200": { "description": "CarrierPaymentHoldRequestHistory belonging to CarrierPaymentRequestLog", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CarrierPaymentHoldRequestHistory" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CarrierPaymentRequestLogCarrierPaymentHoldRequestHistoryController.getCarrierPaymentHoldRequestHistory" } }, "/carrier-payments/done": { "get": { "x-controller-name": "CarrierPaymentController", "x-operation-name": "donePayments", "tags": [ "CarrierPaymentController" ], "description": "\n\n| Permissions |\n| ------- |\n| ap payment done |\n", "responses": { "200": { "description": "Array of CarrierPayment model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CarrierPaymentWithRelations" } } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "CarrierPayment.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } }, { "name": "page", "in": "query", "schema": { "type": "number" } }, { "name": "limit", "in": "query", "schema": { "type": "number" } }, { "name": "forExport", "in": "query", "schema": { "type": "boolean" } } ], "operationId": "CarrierPaymentController.donePayments" } }, "/carrier-payments/done-multiple-payments": { "post": { "x-controller-name": "CarrierPaymentController", "x-operation-name": "doneMultiPayments", "tags": [ "CarrierPaymentController" ], "description": "\n\n| Permissions |\n| ------- |\n| ap carrier payment |\n", "responses": { "200": { "description": "Return value of CarrierPaymentController.doneMultiPayments", "content": {} }, "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "CarrierPayment PUT success" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "shipmentIds": { "type": "array", "items": { "type": "string" }, "description": "Array of shipment IDs to include in the CSV" } }, "required": [ "shipment_ids" ] } } } }, "operationId": "CarrierPaymentController.doneMultiPayments" } }, "/carrier-payments/download-csv": { "post": { "x-controller-name": "CarrierPaymentController", "x-operation-name": "createCsv", "tags": [ "CarrierPaymentController" ], "description": "\n\n| Permissions |\n| ------- |\n| ap carrier payment |\n", "responses": { "200": { "description": "CSV File", "content": { "text/csv": { "schema": { "type": "string" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "shipmentIds": { "type": "array", "items": { "type": "string" }, "description": "Array of shipment IDs to include in the CSV" } }, "required": [ "shipment_ids" ] } } } }, "operationId": "CarrierPaymentController.createCsv" }, "get": { "x-controller-name": "CarrierPaymentController", "x-operation-name": "downloadCSV", "tags": [ "CarrierPaymentController" ], "description": "\n\n| Permissions |\n| ------- |\n| ap payment done |\n", "responses": { "200": { "description": "CSV file download", "content": { "text/csv": { "schema": { "type": "string" } } } } }, "parameters": [ { "name": "batchNo", "in": "query", "schema": { "type": "string" } } ], "operationId": "CarrierPaymentController.downloadCSV" } }, "/carrier-payments/{id}/ap-email-to-carriers": { "post": { "x-controller-name": "CarrierPaymentApEmailToCarrierController", "x-operation-name": "create", "tags": [ "CarrierPaymentApEmailToCarrierController" ], "responses": { "200": { "description": "CarrierPayment model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApEmailToCarrier" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewApEmailToCarrierInCarrierPayment" } } }, "x-parameter-index": 1 }, "operationId": "CarrierPaymentApEmailToCarrierController.create" }, "patch": { "x-controller-name": "CarrierPaymentApEmailToCarrierController", "x-operation-name": "patch", "tags": [ "CarrierPaymentApEmailToCarrierController" ], "responses": { "200": { "description": "CarrierPayment.ApEmailToCarrier PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "ApEmailToCarrier.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApEmailToCarrierPartial" } } }, "x-parameter-index": 1 }, "operationId": "CarrierPaymentApEmailToCarrierController.patch" }, "get": { "x-controller-name": "CarrierPaymentApEmailToCarrierController", "x-operation-name": "find", "tags": [ "CarrierPaymentApEmailToCarrierController" ], "responses": { "200": { "description": "Array of CarrierPayment has many ApEmailToCarrier", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ApEmailToCarrier" } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } ], "operationId": "CarrierPaymentApEmailToCarrierController.find" }, "delete": { "x-controller-name": "CarrierPaymentApEmailToCarrierController", "x-operation-name": "delete", "tags": [ "CarrierPaymentApEmailToCarrierController" ], "responses": { "200": { "description": "CarrierPayment.ApEmailToCarrier DELETE success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "ApEmailToCarrier.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "CarrierPaymentApEmailToCarrierController.delete" } }, "/carrier-payments/{id}/carrier-aging": { "get": { "x-controller-name": "CarrierPaymentCarrierAgingController", "x-operation-name": "getCarrierAging", "tags": [ "CarrierPaymentCarrierAgingController" ], "responses": { "200": { "description": "CarrierAging belonging to CarrierPayment", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CarrierAging" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CarrierPaymentCarrierAgingController.getCarrierAging" } }, "/carrier-payments/{id}/carriers": { "get": { "x-controller-name": "CarrierPaymentCarriersController", "x-operation-name": "getCarriers", "tags": [ "CarrierPaymentCarriersController" ], "responses": { "200": { "description": "Carriers belonging to CarrierPayment", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Carriers" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CarrierPaymentCarriersController.getCarriers" } }, "/carrier-payments/{id}/portal": { "get": { "x-controller-name": "CarrierPaymentPortalController", "x-operation-name": "getPortal", "tags": [ "CarrierPaymentPortalController" ], "responses": { "200": { "description": "Portal belonging to CarrierPayment", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Portal" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CarrierPaymentPortalController.getPortal" } }, "/carrier-payments/{id}/shipment": { "get": { "x-controller-name": "CarrierPaymentShipmentController", "x-operation-name": "getShipment", "tags": [ "CarrierPaymentShipmentController" ], "responses": { "200": { "description": "Shipment belonging to CarrierPayment", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Shipment" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CarrierPaymentShipmentController.getShipment" } }, "/carrier-payments/{id}/user": { "get": { "x-controller-name": "CarrierPaymentUserController", "x-operation-name": "getUser", "tags": [ "CarrierPaymentUserController" ], "responses": { "200": { "description": "User belonging to CarrierPayment", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CarrierPaymentUserController.getUser" } }, "/carrier-payments": { "get": { "x-controller-name": "CarrierPaymentController", "x-operation-name": "find", "tags": [ "CarrierPaymentController" ], "description": "\n\n| Permissions |\n| ------- |\n| ap carrier payment |\n", "responses": { "200": { "description": "Array of CarrierPayment model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CarrierPaymentWithRelations" } } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "CarrierPayment.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } }, { "name": "page", "in": "query", "schema": { "type": "number" } }, { "name": "limit", "in": "query", "schema": { "type": "number" } } ], "operationId": "CarrierPaymentController.find" } }, "/carrier-payments-before-approval": { "get": { "x-controller-name": "CarrierPaymentController", "x-operation-name": "carrierPaymentBeforeApproval", "tags": [ "CarrierPaymentController" ], "description": "\n\n| Permissions |\n| ------- |\n| ap carrier payment |\n", "responses": { "200": { "description": "Array of CarrierPayment model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CarrierPaymentWithRelations" } } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "CarrierPayment.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } }, { "name": "page", "in": "query", "schema": { "type": "number" } }, { "name": "limit", "in": "query", "schema": { "type": "number" } } ], "operationId": "CarrierPaymentController.carrierPaymentBeforeApproval" } }, "/carrier-quick-pay": { "post": { "x-controller-name": "CarrierAgingController", "x-operation-name": "carrierSendPaymentQuickPay", "tags": [ "CarrierAgingController" ], "description": "\n\n| Permissions |\n| ------- |\n| ap carrier aging |\n", "responses": { "200": { "description": "CarrierAging History model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CarrierAging" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "CarrierAgingController.carrierSendPaymentQuickPay" } }, "/carrier-rate-con-reports/all/record/{ProNumber}": { "get": { "x-controller-name": "CarrierRateConReportController", "x-operation-name": "findAllRateConRecord", "tags": [ "CarrierRateConReportController" ], "responses": { "200": { "description": "Array of CarrierRateConReport model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CarrierRateConReportWithRelations" } } } } } }, "parameters": [ { "name": "ProNumber", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "CarrierRateConReportController.findAllRateConRecord" } }, "/carrier-rate-con-reports/count": { "get": { "x-controller-name": "CarrierRateConReportController", "x-operation-name": "count", "tags": [ "CarrierRateConReportController" ], "responses": { "200": { "description": "CarrierRateConReport model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "CarrierRateConReport.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "CarrierRateConReportController.count" } }, "/carrier-rate-con-reports/{id}/shipment": { "get": { "x-controller-name": "CarrierRateConReportShipmentController", "x-operation-name": "getShipment", "tags": [ "CarrierRateConReportShipmentController" ], "responses": { "200": { "description": "Shipment belonging to CarrierRateConReport", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Shipment" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CarrierRateConReportShipmentController.getShipment" } }, "/carrier-rate-con-reports/{id}/user": { "get": { "x-controller-name": "CarrierRateConReportUserController", "x-operation-name": "getUser", "tags": [ "CarrierRateConReportUserController" ], "responses": { "200": { "description": "User belonging to CarrierRateConReport", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CarrierRateConReportUserController.getUser" } }, "/carrier-rate-con-reports/{otrType}/{from}/{searchProNumber}": { "get": { "x-controller-name": "CarrierRateConReportController", "x-operation-name": "find", "tags": [ "CarrierRateConReportController" ], "responses": { "200": { "description": "Array of CarrierRateConReport model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ShipmentWithRelations" } } } } } }, "parameters": [ { "name": "otrType", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "from", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "searchProNumber", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "CarrierRateConReportController.find" } }, "/carrier-rate-con-reports/{id}": { "put": { "x-controller-name": "CarrierRateConReportController", "x-operation-name": "replaceById", "tags": [ "CarrierRateConReportController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "CarrierRateConReport PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CarrierRateConReport" } } }, "x-parameter-index": 1 }, "operationId": "CarrierRateConReportController.replaceById" }, "patch": { "x-controller-name": "CarrierRateConReportController", "x-operation-name": "updateById", "tags": [ "CarrierRateConReportController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "CarrierRateConReport PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CarrierRateConReportPartial" } } }, "x-parameter-index": 1 }, "operationId": "CarrierRateConReportController.updateById" }, "get": { "x-controller-name": "CarrierRateConReportController", "x-operation-name": "findById", "tags": [ "CarrierRateConReportController" ], "responses": { "200": { "description": "CarrierRateConReport model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CarrierRateConReportWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CarrierRateConReport.Filter" } } } } ], "operationId": "CarrierRateConReportController.findById" }, "delete": { "x-controller-name": "CarrierRateConReportController", "x-operation-name": "deleteById", "tags": [ "CarrierRateConReportController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "CarrierRateConReport DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CarrierRateConReportController.deleteById" } }, "/carrier-rate-con-reports": { "post": { "x-controller-name": "CarrierRateConReportController", "x-operation-name": "create", "tags": [ "CarrierRateConReportController" ], "responses": { "200": { "description": "CarrierRateConReport model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CarrierRateConReport" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewCarrierRateConReport" } } } }, "operationId": "CarrierRateConReportController.create" }, "patch": { "x-controller-name": "CarrierRateConReportController", "x-operation-name": "updateAll", "tags": [ "CarrierRateConReportController" ], "responses": { "200": { "description": "CarrierRateConReport PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "CarrierRateConReport.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CarrierRateConReportPartial" } } } }, "operationId": "CarrierRateConReportController.updateAll" } }, "/carrier-rate-con-reports-on-page": { "get": { "x-controller-name": "CarrierRateConReportController", "x-operation-name": "CarrierRateConReportsOnPage", "tags": [ "CarrierRateConReportController" ], "responses": { "200": { "description": "Array of CarrierRateConReport model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ShipmentWithRelations" } } } } } }, "operationId": "CarrierRateConReportController.CarrierRateConReportsOnPage" } }, "/carrierdocs/shipment/{shipmentId}/{carrierId}": { "get": { "x-controller-name": "CarriersController", "x-operation-name": "getCarrierDocsByShipmentId", "tags": [ "CarriersController" ], "responses": { "200": { "description": "Get all carrier documents by shipment ID", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CarrierDocs" } } } } } }, "parameters": [ { "name": "shipmentId", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "carrierId", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CarriersController.getCarrierDocsByShipmentId" } }, "/carriers/addBySME": { "post": { "x-controller-name": "CarriersController", "x-operation-name": "createCarrierBySME", "tags": [ "CarriersController" ], "description": "\n\n| Permissions |\n| ------- |\n| sme view mcapprove |\n", "responses": { "200": { "description": "Carriers model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Carriers" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewCarriers" } } } }, "operationId": "CarriersController.createCarrierBySME" } }, "/carriers/approval-pending": { "get": { "x-controller-name": "CarriersController", "x-operation-name": "approvalPending", "tags": [ "CarriersController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker view carrier |\n", "responses": { "200": { "description": "Array of Carriers model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CarriersWithRelations" } } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Carriers.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } }, { "name": "paginationModel", "in": "query", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } ], "operationId": "CarriersController.approvalPending" } }, "/carriers/approve-carrier/{id}": { "patch": { "x-controller-name": "CarriersController", "x-operation-name": "approveCarrier", "tags": [ "CarriersController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker update carrier |\n", "responses": { "200": { "description": "Return value of CarriersController.approveCarrier", "content": {} }, "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Carriers PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "CarriersController.approveCarrier" } }, "/carriers/carriers-shipments": { "get": { "x-controller-name": "CarriersController", "x-operation-name": "getCarriersShipments", "tags": [ "CarriersController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker view carrier |\n", "responses": { "200": { "description": "Get shipments for the authenticated carrier with pagination and status filtering", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ShipmentWithRelations" } } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Shipment.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } }, { "name": "page", "in": "query", "schema": { "type": "number" } }, { "name": "pageSize", "in": "query", "schema": { "type": "number" } }, { "name": "OrderBy", "in": "query", "schema": { "type": "string" } }, { "name": "mode", "in": "query", "schema": { "type": "string" } }, { "name": "containerNo", "in": "query", "schema": { "type": "string" } }, { "name": "carrierId", "in": "query", "schema": { "type": "string" } } ], "operationId": "CarriersController.getCarriersShipments" } }, "/carriers/count": { "get": { "x-controller-name": "CarriersController", "x-operation-name": "count", "tags": [ "CarriersController" ], "responses": { "200": { "description": "Carriers model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Carriers.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "CarriersController.count" } }, "/carriers/statistics": { "get": { "x-controller-name": "CarriersController", "x-operation-name": "getCarrierStatistics", "tags": [ "CarriersController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker view carrier |\n", "responses": { "200": { "description": "Get carrier statistics for authenticated user", "content": { "application/json": { "schema": { "type": "object", "properties": { "totalCarriers": { "type": "number" }, "notActiveCarriers": { "type": "number" }, "activeCarriers": { "type": "number" }, "blockedCarriers": { "type": "number" }, "mideastCarriers": { "type": "number" }, "southeastCarriers": { "type": "number" }, "northeastCarriers": { "type": "number" }, "westCarriers": { "type": "number" }, "otherCarriers": { "type": "number" } } } } } } }, "operationId": "CarriersController.getCarrierStatistics" } }, "/carriers/yearly-statistics/{year}": { "get": { "x-controller-name": "CarriersController", "x-operation-name": "getCarrierYearlyStatistics", "tags": [ "CarriersController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker view carrier |\n", "responses": { "200": { "description": "Get carrier statistics by year with monthly breakdowns based on carrier creation date", "content": { "application/json": { "schema": { "type": "object", "properties": { "year": { "type": "number" }, "months": { "type": "array", "items": { "type": "string" }, "description": "Array of month names in short format" }, "carrierTotals": { "type": "array", "items": { "type": "number" }, "description": "Array of carrier counts for each month" }, "totalCarriersForYear": { "type": "number" } } } } } } }, "parameters": [ { "name": "year", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CarriersController.getCarrierYearlyStatistics" } }, "/carriers/{id}/ap-details": { "post": { "x-controller-name": "CarriersApDetailsController", "x-operation-name": "create", "tags": [ "CarriersApDetailsController" ], "responses": { "200": { "description": "Carriers model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApDetails" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewApDetailsInCarriers" } } }, "x-parameter-index": 1 }, "operationId": "CarriersApDetailsController.create" }, "patch": { "x-controller-name": "CarriersApDetailsController", "x-operation-name": "patch", "tags": [ "CarriersApDetailsController" ], "responses": { "200": { "description": "Carriers.ApDetails PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "ApDetails.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApDetailsPartial" } } }, "x-parameter-index": 1 }, "operationId": "CarriersApDetailsController.patch" }, "get": { "x-controller-name": "CarriersApDetailsController", "x-operation-name": "get", "tags": [ "CarriersApDetailsController" ], "responses": { "200": { "description": "Carriers has one ApDetails", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApDetails" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } ], "operationId": "CarriersApDetailsController.get" }, "delete": { "x-controller-name": "CarriersApDetailsController", "x-operation-name": "delete", "tags": [ "CarriersApDetailsController" ], "responses": { "200": { "description": "Carriers.ApDetails DELETE success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "ApDetails.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "CarriersApDetailsController.delete" } }, "/carriers/{id}/cities": { "get": { "x-controller-name": "CarriersCitiesController", "x-operation-name": "getCities", "tags": [ "CarriersCitiesController" ], "responses": { "200": { "description": "Cities belonging to Carriers", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Cities" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CarriersCitiesController.getCities" } }, "/carriers/{id}/current-year-earnings": { "get": { "x-controller-name": "CarriersController", "x-operation-name": "getCurrentYearEarnings", "tags": [ "CarriersController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker view carrier |\n", "responses": { "200": { "description": "Get current year earnings by carrier ID", "content": { "application/json": { "schema": { "type": "object", "properties": { "carrier": { "$ref": "#/components/schemas/CarriersWithRelations" }, "earningsData": { "type": "array", "items": { "type": "object", "properties": { "month": { "type": "string" }, "year": { "type": "number" }, "totalEarningsUSD": { "type": "number" }, "totalEarningsCAD": { "type": "number" }, "totalPayments": { "type": "number" } } } }, "earningsUSD": { "type": "array", "items": { "type": "number" }, "description": "Array of USD earnings for each month (Jan to Dec)" }, "months": { "type": "array", "items": { "type": "string" }, "description": "Array of month names (Jan to Dec)" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "year", "in": "query", "schema": { "type": "number" } } ], "operationId": "CarriersController.getCurrentYearEarnings" } }, "/carriers/{id}/equipment": { "get": { "x-controller-name": "CarriersEquipmentController", "x-operation-name": "getEquipment", "tags": [ "CarriersEquipmentController" ], "responses": { "200": { "description": "Equipment belonging to Carriers", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Equipment" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CarriersEquipmentController.getEquipment" } }, "/carriers/{id}/factoring-details": { "get": { "x-controller-name": "CarriersFactoringDetailsController", "x-operation-name": "getFactoringDetails", "tags": [ "CarriersFactoringDetailsController" ], "responses": { "200": { "description": "FactoringDetails belonging to Carriers", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FactoringDetails" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CarriersFactoringDetailsController.getFactoringDetails" } }, "/carriers/{id}/payment-methods": { "post": { "x-controller-name": "CarriersPaymentMethodsController", "x-operation-name": "create", "tags": [ "CarriersPaymentMethodsController" ], "responses": { "200": { "description": "Carriers model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentMethods" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewPaymentMethodsInCarriers" } } }, "x-parameter-index": 1 }, "operationId": "CarriersPaymentMethodsController.create" }, "patch": { "x-controller-name": "CarriersPaymentMethodsController", "x-operation-name": "patch", "tags": [ "CarriersPaymentMethodsController" ], "responses": { "200": { "description": "Carriers.PaymentMethods PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "PaymentMethods.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentMethodsPartial" } } }, "x-parameter-index": 1 }, "operationId": "CarriersPaymentMethodsController.patch" }, "get": { "x-controller-name": "CarriersPaymentMethodsController", "x-operation-name": "get", "tags": [ "CarriersPaymentMethodsController" ], "responses": { "200": { "description": "Carriers has one PaymentMethods", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentMethods" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } ], "operationId": "CarriersPaymentMethodsController.get" }, "delete": { "x-controller-name": "CarriersPaymentMethodsController", "x-operation-name": "delete", "tags": [ "CarriersPaymentMethodsController" ], "responses": { "200": { "description": "Carriers.PaymentMethods DELETE success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "PaymentMethods.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "CarriersPaymentMethodsController.delete" } }, "/carriers/{id}/portal": { "get": { "x-controller-name": "CarriersPortalController", "x-operation-name": "getPortal", "tags": [ "CarriersPortalController" ], "responses": { "200": { "description": "Portal belonging to Carriers", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Portal" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CarriersPortalController.getPortal" } }, "/carriers/{id}/shipments": { "get": { "x-controller-name": "CarriersController", "x-operation-name": "getShipmentsByCarrierId", "tags": [ "CarriersController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker view carrier |\n", "responses": { "200": { "description": "Get shipments by carrier ID", "content": { "application/json": { "schema": { "type": "object", "properties": { "carrier": { "$ref": "#/components/schemas/CarriersWithRelations" }, "shipments": { "type": "array", "items": { "$ref": "#/components/schemas/ShipmentWithRelations" } }, "shipmentStats": { "type": "object", "properties": { "totalShipments": { "type": "number" }, "deliveredShipments": { "type": "number" }, "coveredShipments": { "type": "number" }, "otrDelivered": { "type": "number" }, "drayageDelivered": { "type": "number" }, "intermediateDelivered": { "type": "number" }, "otrCovered": { "type": "number" }, "drayageCovered": { "type": "number" }, "intermediateCovered": { "type": "number" }, "totalOtr": { "type": "number" }, "totalDrayage": { "type": "number" }, "totalIntermediate": { "type": "number" }, "cancelledFromLogs": { "type": "number" }, "otrCancelledFromLogs": { "type": "number" }, "drayageCancelledFromLogs": { "type": "number" }, "intermediateCancelledFromLogs": { "type": "number" } } }, "distanceStats": { "type": "object", "properties": { "totalDistance": { "type": "number", "description": "Total distance in miles for delivered shipments only (status >= 3)" }, "averageDistancePerLoad": { "type": "number", "description": "Average distance per load in miles for delivered shipments only" }, "shipmentsWithDistance": { "type": "number", "description": "Number of delivered shipments with valid distance data" }, "totalDeliveredShipments": { "type": "number", "description": "Total number of delivered shipments (status >= 3)" }, "shipmentDistances": { "type": "array", "items": { "type": "object", "properties": { "shipmentId": { "type": "number" }, "distance": { "type": "number", "description": "Distance in miles for this shipment" }, "picks": { "type": "number", "description": "Number of pickup locations" }, "drops": { "type": "number", "description": "Number of drop locations" }, "status": { "type": "number", "description": "Shipment status (3 or higher for delivered)" } } } } } } } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "CarriersController.getShipmentsByCarrierId" } }, "/carriers/{id}/shipments-per-month": { "get": { "x-controller-name": "CarriersController", "x-operation-name": "getShipmentsPerMonthByCarrierId", "tags": [ "CarriersController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker view carrier |\n", "responses": { "200": { "description": "Get total shipments per month by carrier ID (status > 0)", "content": { "application/json": { "schema": { "type": "object", "properties": { "carrier": { "$ref": "#/components/schemas/CarriersWithRelations" }, "shipmentsData": { "type": "array", "items": { "type": "object", "properties": { "month": { "type": "string" }, "year": { "type": "number" }, "totalShipments": { "type": "number" } } } }, "shipmentsCount": { "type": "array", "items": { "type": "number" } }, "months": { "type": "array", "items": { "type": "string" } } } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "year", "in": "query", "schema": { "type": "number" } } ], "operationId": "CarriersController.getShipmentsPerMonthByCarrierId" } }, "/carriers/{carrierId}/state-wise-shipments": { "get": { "x-controller-name": "CarriersController", "x-operation-name": "getStateWiseShipments", "tags": [ "CarriersController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker view carrier |\n", "responses": { "200": { "description": "Get state-wise shipments for a carrier", "content": { "application/json": { "schema": { "type": "object", "properties": { "carrier": { "$ref": "#/components/schemas/CarriersWithRelations" }, "stateWiseShipments": { "type": "object", "properties": { "shipments": { "type": "array", "description": "All shipments with complete data including pickup/drop locations, commodities, and equipment" }, "stateWiseData": { "type": "array", "description": "Shipments grouped by state with totals and shipment details for each state", "items": { "type": "object", "properties": { "state": { "type": "string" }, "stateCode": { "type": "string" }, "totalShipments": { "type": "number" }, "shipments": { "type": "array" } } } }, "allStates": { "type": "array", "description": "All states that exist for shipments with pickup location focus and shipment counts", "items": { "type": "object", "properties": { "stateCode": { "type": "string" }, "state": { "type": "string" }, "hasPickupLocations": { "type": "boolean" }, "totalShipments": { "type": "number" } } } } } } } } } } } }, "parameters": [ { "name": "carrierId", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "CarriersController.getStateWiseShipments" } }, "/carriers/{id}/user": { "get": { "x-controller-name": "CarriersUserController", "x-operation-name": "getUser", "tags": [ "CarriersUserController" ], "responses": { "200": { "description": "User belonging to Carriers", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CarriersUserController.getUser" } }, "/carriers/{id}/zip-codes": { "get": { "x-controller-name": "CarriersZipCodesController", "x-operation-name": "getZipCodes", "tags": [ "CarriersZipCodesController" ], "responses": { "200": { "description": "ZipCodes belonging to Carriers", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ZipCodes" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CarriersZipCodesController.getZipCodes" } }, "/carriers/{id}": { "put": { "x-controller-name": "CarriersController", "x-operation-name": "replaceById", "tags": [ "CarriersController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Carriers PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Carriers" } } }, "x-parameter-index": 1 }, "operationId": "CarriersController.replaceById" }, "patch": { "x-controller-name": "CarriersController", "x-operation-name": "updateById", "tags": [ "CarriersController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker update carrier |\n", "responses": { "200": { "description": "Return value of CarriersController.updateById", "content": {} }, "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Carriers PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "CarriersPartial": { "$ref": "#/components/schemas/CarriersPartial" }, "apDetails": { "$ref": "#/components/schemas/ApDetailsPartial" } } } } }, "x-parameter-index": 1 }, "operationId": "CarriersController.updateById" }, "get": { "x-controller-name": "CarriersController", "x-operation-name": "findById", "tags": [ "CarriersController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker view carrier |\n", "responses": { "200": { "description": "Carriers model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CarriersWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "CarriersController.findById" }, "delete": { "x-controller-name": "CarriersController", "x-operation-name": "deleteById", "tags": [ "CarriersController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Carriers DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CarriersController.deleteById" } }, "/carriers": { "post": { "x-controller-name": "CarriersController", "x-operation-name": "create", "tags": [ "CarriersController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker create carrier |\n", "responses": { "200": { "description": "Carriers model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Carriers" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewCarriers" } } } }, "operationId": "CarriersController.create" }, "patch": { "x-controller-name": "CarriersController", "x-operation-name": "updateAll", "tags": [ "CarriersController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker update carrier |\n", "responses": { "200": { "description": "Carriers PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Carriers.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CarriersPartial" } } } }, "operationId": "CarriersController.updateAll" }, "get": { "x-controller-name": "CarriersController", "x-operation-name": "find", "tags": [ "CarriersController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker view carrier |\n", "responses": { "200": { "description": "Array of Carriers model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CarriersWithRelations" } } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Carriers.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } }, { "name": "paginationModel", "in": "query", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } ], "operationId": "CarriersController.find" } }, "/carriers-details/{id}": { "get": { "x-controller-name": "CarriersController", "x-operation-name": "getCarrierDetailsData", "tags": [ "CarriersController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker view carrier |\n", "responses": { "200": { "description": "Carrier aging data with totals", "content": { "application/json": { "schema": { "type": "object", "properties": { "carrier": { "$ref": "#/components/schemas/CarriersWithRelations" }, "agingData": { "type": "array", "items": { "$ref": "#/components/schemas/CarrierAgingWithRelations" } }, "totals": { "type": "object", "properties": { "totalPayableUSD": { "type": "number" }, "totalPayableCAD": { "type": "number" }, "totalAdvancePayUSD": { "type": "number" }, "totalAdvancePayCAD": { "type": "number" }, "totalQuickPayUSD": { "type": "number" }, "totalQuickPayCAD": { "type": "number" }, "totalRecords": { "type": "number" }, "averageAge": { "type": "number" } } }, "paymentData": { "type": "array", "items": { "$ref": "#/components/schemas/CarrierPaymentWithRelations" } }, "paymenttotals": { "type": "object", "properties": { "totalPayments": { "type": "number" }, "totalPaymentAmountUSD": { "type": "number" }, "totalPaymentAmountCAD": { "type": "number" }, "pendingPayments": { "type": "number" }, "completedPayments": { "type": "number" }, "onHoldPayments": { "type": "number" }, "quickPayPayments": { "type": "number" }, "normalPayments": { "type": "number" } } }, "avgcost": { "type": "number" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "CarriersController.getCarrierDetailsData" } }, "/check-bounced-emails": { "post": { "x-controller-name": "EmailMarketingController", "x-operation-name": "checkBouncedEmailsForCampaign", "tags": [ "EmailMarketingController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker send email marketing |\n", "responses": { "200": { "description": "Return value of EmailMarketingController.checkBouncedEmailsForCampaign", "content": {} } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "EmailMarketingController.checkBouncedEmailsForCampaign" } }, "/check-cpr-detail/{id}": { "get": { "x-controller-name": "McVerificationController", "x-operation-name": "CheckedCprDetail", "tags": [ "McVerificationController" ], "description": "\n\n| Permissions |\n| ------- |\n| sme view mcapprove |\n", "responses": { "200": { "description": "McVerification model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/McVerificationWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "McVerificationController.CheckedCprDetail" } }, "/check-last-invoice-date/{id}": { "get": { "x-controller-name": "ShippersController", "x-operation-name": "findByShippersId", "tags": [ "ShippersController" ], "responses": { "200": { "description": "Shippers model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShippersWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "ShippersController.findByShippersId" } }, "/cities/count": { "get": { "x-controller-name": "CitiesController", "x-operation-name": "count", "tags": [ "CitiesController" ], "responses": { "200": { "description": "Cities model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Cities.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "CitiesController.count" } }, "/cities/{id}/countries": { "get": { "x-controller-name": "CitiesCountriesController", "x-operation-name": "getCountries", "tags": [ "CitiesCountriesController" ], "responses": { "200": { "description": "Countries belonging to Cities", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Countries" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CitiesCountriesController.getCountries" } }, "/cities/{id}/states": { "get": { "x-controller-name": "CitiesStatesController", "x-operation-name": "getStates", "tags": [ "CitiesStatesController" ], "responses": { "200": { "description": "States belonging to Cities", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/States" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CitiesStatesController.getStates" } }, "/cities/{id}": { "put": { "x-controller-name": "CitiesController", "x-operation-name": "replaceById", "tags": [ "CitiesController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Cities PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Cities" } } }, "x-parameter-index": 1 }, "operationId": "CitiesController.replaceById" }, "patch": { "x-controller-name": "CitiesController", "x-operation-name": "updateById", "tags": [ "CitiesController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Cities PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CitiesPartial" } } }, "x-parameter-index": 1 }, "operationId": "CitiesController.updateById" }, "get": { "x-controller-name": "CitiesController", "x-operation-name": "findById", "tags": [ "CitiesController" ], "responses": { "200": { "description": "Cities model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CitiesWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Cities.Filter" } } } } ], "operationId": "CitiesController.findById" }, "delete": { "x-controller-name": "CitiesController", "x-operation-name": "deleteById", "tags": [ "CitiesController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Cities DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CitiesController.deleteById" } }, "/cities": { "post": { "x-controller-name": "CitiesController", "x-operation-name": "create", "tags": [ "CitiesController" ], "responses": { "200": { "description": "Cities model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Cities" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewCities" } } } }, "operationId": "CitiesController.create" }, "patch": { "x-controller-name": "CitiesController", "x-operation-name": "updateAll", "tags": [ "CitiesController" ], "responses": { "200": { "description": "Cities PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Cities.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CitiesPartial" } } } }, "operationId": "CitiesController.updateAll" }, "get": { "x-controller-name": "CitiesController", "x-operation-name": "find", "tags": [ "CitiesController" ], "responses": { "200": { "description": "Array of Cities model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CitiesWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Cities.Filter1" } } } } ], "operationId": "CitiesController.find" } }, "/claim/add-comment": { "post": { "x-controller-name": "ArClaimedController", "x-operation-name": "addComment", "tags": [ "ArClaimedController" ], "description": "", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Add comment to claim" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "comment": { "type": "string" } } } } }, "description": "Add comment to claim", "required": true }, "operationId": "ArClaimedController.addComment" } }, "/claim/create": { "post": { "x-controller-name": "ArClaimedController", "x-operation-name": "createClaim", "tags": [ "ArClaimedController" ], "requestBody": { "content": { "multipart/form-data": { "x-parser": "stream", "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } } } } }, "description": "Request body for multipart/form-data based file upload", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Files and fields" } }, "description": "", "operationId": "ArClaimedController.createClaim" } }, "/claim/detail/{id}": { "get": { "x-controller-name": "ArClaimedController", "x-operation-name": "getClaimDetail", "tags": [ "ArClaimedController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Get claim detail" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ArClaimedController.getClaimDetail" } }, "/claim/list-ar": { "get": { "x-controller-name": "ArClaimedController", "x-operation-name": "getClaimList", "tags": [ "ArClaimedController" ], "description": "", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Get claim list with filters" } } } } }, "parameters": [ { "name": "page", "in": "query", "schema": { "type": "number" } }, { "name": "pageSize", "in": "query", "schema": { "type": "number" } }, { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "status", "in": "query", "schema": { "type": "string" } }, { "name": "claimType", "in": "query", "schema": { "type": "string" } } ], "operationId": "ArClaimedController.getClaimList" } }, "/claim/list-broker": { "get": { "x-controller-name": "ArClaimedController", "x-operation-name": "getClaimListBroker", "tags": [ "ArClaimedController" ], "description": "", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Get claim list with filters" } } } } }, "parameters": [ { "name": "page", "in": "query", "schema": { "type": "number" } }, { "name": "pageSize", "in": "query", "schema": { "type": "number" } }, { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "status", "in": "query", "schema": { "type": "string" } }, { "name": "claimType", "in": "query", "schema": { "type": "string" } } ], "operationId": "ArClaimedController.getClaimListBroker" } }, "/claim/notes": { "post": { "x-controller-name": "ArShipperClaimController", "x-operation-name": "create", "tags": [ "ArShipperClaimController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar view note |\n", "responses": { "200": { "description": "Notes model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Notes" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "ArShipperClaimController.create" } }, "/claim/search-pro": { "get": { "x-controller-name": "ArClaimedController", "x-operation-name": "searchPro", "tags": [ "ArClaimedController" ], "description": "", "responses": { "200": { "description": "Search for claim history from baddebt by PRO number", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "array", "items": { "type": "object" } } } } } } } }, "parameters": [ { "name": "proNumber", "in": "query", "schema": { "type": "string" } }, { "name": "ArSideView", "in": "query", "schema": { "type": "string" } } ], "operationId": "ArClaimedController.searchPro" } }, "/claim/update-date": { "put": { "x-controller-name": "ArClaimedController", "x-operation-name": "updateDate", "tags": [ "ArClaimedController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Update claim status" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "proNumber": { "type": "string" }, "claimDate": { "type": "string" } } } } }, "description": "Update claim date", "required": true }, "operationId": "ArClaimedController.updateDate" } }, "/claim/update-status": { "put": { "x-controller-name": "ArClaimedController", "x-operation-name": "updateStatus", "tags": [ "ArClaimedController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Update claim status" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "proNumber": { "type": "string" }, "status": { "type": "string" } } } } }, "description": "Update claim status", "required": true }, "operationId": "ArClaimedController.updateStatus" } }, "/claim/upload-document": { "post": { "x-controller-name": "ArClaimedController", "x-operation-name": "uplaodDocument", "tags": [ "ArClaimedController" ], "requestBody": { "content": { "multipart/form-data": { "x-parser": "stream", "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } } } } }, "description": "Request body for multipart/form-data based file upload", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Files and fields" } }, "description": "", "operationId": "ArClaimedController.uplaodDocument" } }, "/claim-notification/count": { "get": { "x-controller-name": "ArClaimedController", "x-operation-name": "claimNotificationCount", "tags": [ "ArClaimedController" ], "description": "", "responses": { "200": { "description": "Return value of ArClaimedController.claimNotificationCount", "content": {} } }, "operationId": "ArClaimedController.claimNotificationCount" } }, "/claim-remarks": { "get": { "x-controller-name": "ArShipperClaimController", "x-operation-name": "getShippersCollectionNotes", "tags": [ "ArShipperClaimController" ], "responses": { "200": { "description": "Invoices belonging to Notes", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Invoices" } } } } }, "description": "\n\n| Permissions |\n| ------- |\n| ar view shipper aging |\n", "parameters": [ { "name": "shippersId", "in": "query", "schema": { "type": "number" } }, { "name": "claimType", "in": "query", "schema": { "type": "number" } } ], "operationId": "ArShipperClaimController.getShippersCollectionNotes" } }, "/claim-settle": { "post": { "x-controller-name": "ArShipperClaimController", "x-operation-name": "claimSettle", "tags": [ "ArShipperClaimController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar view shipper aging |\n", "responses": { "200": { "description": "Collection Notes model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipperSmallClaim" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "ArShipperClaimController.claimSettle" } }, "/cmt/users": { "get": { "x-controller-name": "CmtController", "x-operation-name": "cmtUsers", "tags": [ "CmtController" ], "responses": { "200": { "description": "Array of Cmt model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CmtWithRelations" } } } } } }, "operationId": "CmtController.cmtUsers" } }, "/cmts/count": { "get": { "x-controller-name": "CmtController", "x-operation-name": "count", "tags": [ "CmtController" ], "responses": { "200": { "description": "Cmt model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Cmt.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "CmtController.count" } }, "/cmts/{id}": { "put": { "x-controller-name": "CmtController", "x-operation-name": "replaceById", "tags": [ "CmtController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Cmt PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Cmt" } } }, "x-parameter-index": 1 }, "operationId": "CmtController.replaceById" }, "patch": { "x-controller-name": "CmtController", "x-operation-name": "updateById", "tags": [ "CmtController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Cmt PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CmtPartial" } } }, "x-parameter-index": 1 }, "operationId": "CmtController.updateById" }, "get": { "x-controller-name": "CmtController", "x-operation-name": "findById", "tags": [ "CmtController" ], "responses": { "200": { "description": "Cmt model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CmtWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Cmt.Filter" } } } } ], "operationId": "CmtController.findById" }, "delete": { "x-controller-name": "CmtController", "x-operation-name": "deleteById", "tags": [ "CmtController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Cmt DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CmtController.deleteById" } }, "/cmts": { "post": { "x-controller-name": "CmtController", "x-operation-name": "create", "tags": [ "CmtController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker create shipment |\n", "responses": { "200": { "description": "Cmt model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Cmt" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "to", "comment", "shipmentId" ], "properties": { "to": { "type": "number", "maxLength": 50 }, "comment": { "type": "string", "nullable": true, "maxLength": 1000 }, "shipmentId": { "type": "string" } } } } } }, "operationId": "CmtController.create" }, "patch": { "x-controller-name": "CmtController", "x-operation-name": "updateAll", "tags": [ "CmtController" ], "responses": { "200": { "description": "Cmt PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Cmt.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CmtPartial" } } } }, "operationId": "CmtController.updateAll" }, "get": { "x-controller-name": "CmtController", "x-operation-name": "find", "tags": [ "CmtController" ], "responses": { "200": { "description": "Array of Cmt model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CmtWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Cmt.Filter1" } } } } ], "operationId": "CmtController.find" } }, "/collection-amount-create": { "post": { "x-controller-name": "ArCollectionController", "x-operation-name": "CollectionAmountCreate", "tags": [ "ArCollectionController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar view shipper aging |\n", "responses": { "200": { "description": "Collection Notes model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CollectionNotes" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "ArCollectionController.CollectionAmountCreate" } }, "/collection-amount-create-old": { "post": { "x-controller-name": "ArCollectionNotesController", "x-operation-name": "CollectionAmountCreate", "tags": [ "ArCollectionNotesController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar view shipper aging |\n", "responses": { "200": { "description": "Collection Notes model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CollectionNotes" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "ArCollectionNotesController.CollectionAmountCreate" } }, "/collection-notes/{id}/portal": { "get": { "x-controller-name": "CollectionNotesPortalController", "x-operation-name": "getPortal", "tags": [ "CollectionNotesPortalController" ], "responses": { "200": { "description": "Portal belonging to CollectionNotes", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Portal" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CollectionNotesPortalController.getPortal" } }, "/collection-notes/{id}/shippers": { "get": { "x-controller-name": "CollectionNotesShippersController", "x-operation-name": "getShippers", "tags": [ "CollectionNotesShippersController" ], "responses": { "200": { "description": "Shippers belonging to CollectionNotes", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Shippers" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CollectionNotesShippersController.getShippers" } }, "/collection-notes/{id}/user": { "get": { "x-controller-name": "CollectionNotesUserController", "x-operation-name": "getUser", "tags": [ "CollectionNotesUserController" ], "responses": { "200": { "description": "User belonging to CollectionNotes", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CollectionNotesUserController.getUser" } }, "/collection-settle-update": { "post": { "x-controller-name": "ArCollectionController", "x-operation-name": "collectionSettleUpdate", "tags": [ "ArCollectionController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar view shipper aging |\n", "responses": { "200": { "description": "Collection Notes model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CollectionSettle" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "ArCollectionController.collectionSettleUpdate" } }, "/collection-settle-update-old": { "post": { "x-controller-name": "ArCollectionNotesController", "x-operation-name": "CollectionsettleUpdate", "tags": [ "ArCollectionNotesController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar view shipper aging |\n", "responses": { "200": { "description": "Collection Notes model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CollectionSettle" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "ArCollectionNotesController.CollectionsettleUpdate" } }, "/collection-settles/{id}/collection-notes": { "get": { "x-controller-name": "CollectionSettleCollectionNotesController", "x-operation-name": "getCollectionNotes", "tags": [ "CollectionSettleCollectionNotesController" ], "responses": { "200": { "description": "CollectionNotes belonging to CollectionSettle", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CollectionNotes" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CollectionSettleCollectionNotesController.getCollectionNotes" } }, "/collection-settles/{id}/invoices": { "get": { "x-controller-name": "CollectionSettleInvoicesController", "x-operation-name": "getInvoices", "tags": [ "CollectionSettleInvoicesController" ], "responses": { "200": { "description": "Invoices belonging to CollectionSettle", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Invoices" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CollectionSettleInvoicesController.getInvoices" } }, "/collection-settles/{id}/portal": { "get": { "x-controller-name": "CollectionSettlePortalController", "x-operation-name": "getPortal", "tags": [ "CollectionSettlePortalController" ], "responses": { "200": { "description": "Portal belonging to CollectionSettle", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Portal" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CollectionSettlePortalController.getPortal" } }, "/collection-settles/{id}/shipment": { "get": { "x-controller-name": "CollectionSettleShipmentController", "x-operation-name": "getShipment", "tags": [ "CollectionSettleShipmentController" ], "responses": { "200": { "description": "Shipment belonging to CollectionSettle", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Shipment" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CollectionSettleShipmentController.getShipment" } }, "/collection-settles/{id}/shippers": { "get": { "x-controller-name": "CollectionSettleShippersController", "x-operation-name": "getShippers", "tags": [ "CollectionSettleShippersController" ], "responses": { "200": { "description": "Shippers belonging to CollectionSettle", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Shippers" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CollectionSettleShippersController.getShippers" } }, "/collection-settles/{id}/user": { "get": { "x-controller-name": "CollectionSettleUserController", "x-operation-name": "getUser", "tags": [ "CollectionSettleUserController" ], "responses": { "200": { "description": "User belonging to CollectionSettle", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CollectionSettleUserController.getUser" } }, "/commdiy-audit-update-shipment-verify": { "post": { "x-controller-name": "AuditorController", "x-operation-name": "commdiyupdateShipmentStatus", "tags": [ "AuditorController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker update carrier |\n", "responses": { "200": { "description": "Shipment model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Shipment" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "AuditorController.commdiyupdateShipmentStatus" } }, "/commodities/count": { "get": { "x-controller-name": "CommodityController", "x-operation-name": "count", "tags": [ "CommodityController" ], "responses": { "200": { "description": "Commodities model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Commodities.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "CommodityController.count" } }, "/commodities/{id}/user": { "get": { "x-controller-name": "CommoditiesUserController", "x-operation-name": "getUser", "tags": [ "CommoditiesUserController" ], "responses": { "200": { "description": "User belonging to Commodities", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CommoditiesUserController.getUser" } }, "/commodities/{id}": { "put": { "x-controller-name": "CommodityController", "x-operation-name": "replaceById", "tags": [ "CommodityController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Commodities PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Commodities" } } }, "x-parameter-index": 1 }, "operationId": "CommodityController.replaceById" }, "patch": { "x-controller-name": "CommodityController", "x-operation-name": "updateById", "tags": [ "CommodityController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Commodities PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommoditiesPartial" } } }, "x-parameter-index": 1 }, "operationId": "CommodityController.updateById" }, "get": { "x-controller-name": "CommodityController", "x-operation-name": "findById", "tags": [ "CommodityController" ], "responses": { "200": { "description": "Commodities model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommoditiesWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Commodities.Filter" } } } } ], "operationId": "CommodityController.findById" }, "delete": { "x-controller-name": "CommodityController", "x-operation-name": "deleteById", "tags": [ "CommodityController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Commodities DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CommodityController.deleteById" } }, "/commodities": { "post": { "x-controller-name": "CommodityController", "x-operation-name": "create", "tags": [ "CommodityController" ], "responses": { "200": { "description": "Commodities model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Commodities" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewCommodities" } } } }, "operationId": "CommodityController.create" }, "patch": { "x-controller-name": "CommodityController", "x-operation-name": "updateAll", "tags": [ "CommodityController" ], "responses": { "200": { "description": "Commodities PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Commodities.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommoditiesPartial" } } } }, "operationId": "CommodityController.updateAll" }, "get": { "x-controller-name": "CommodityController", "x-operation-name": "find", "tags": [ "CommodityController" ], "responses": { "200": { "description": "Array of Commodities model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CommoditiesWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Commodities.Filter1" } } } } ], "operationId": "CommodityController.find" } }, "/commodity-list": { "get": { "x-controller-name": "ExceptionController", "x-operation-name": "commodityfind", "tags": [ "ExceptionController" ], "description": "\n\n| Permissions |\n| ------- |\n| sme commodity view |\n", "responses": { "200": { "description": "Array of Sme model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/McVerificationWithRelations" } } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Commodities.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } }, { "name": "page", "in": "query", "schema": { "type": "number" } }, { "name": "pageSize", "in": "query", "schema": { "type": "number" } }, { "name": "userId", "in": "query", "schema": { "type": "string" } } ], "operationId": "ExceptionController.commodityfind" } }, "/common-list/{commonNumber}": { "get": { "x-controller-name": "CommonSearchController", "x-operation-name": "find", "tags": [ "CommonSearchController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker view dashboard |\n", "responses": { "200": { "description": "Shippers model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoadsWithRelations" } } } } }, "parameters": [ { "name": "commonNumber", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "CommonSearchController.find" } }, "/companies-insurances/count": { "get": { "x-controller-name": "CompaniesInsuranceController", "x-operation-name": "count", "tags": [ "CompaniesInsuranceController" ], "responses": { "200": { "description": "CompaniesInsurance model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "CompaniesInsurance.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "CompaniesInsuranceController.count" } }, "/companies-insurances/{id}": { "put": { "x-controller-name": "CompaniesInsuranceController", "x-operation-name": "replaceById", "tags": [ "CompaniesInsuranceController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "CompaniesInsurance PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompaniesInsurance" } } }, "x-parameter-index": 1 }, "operationId": "CompaniesInsuranceController.replaceById" }, "patch": { "x-controller-name": "CompaniesInsuranceController", "x-operation-name": "updateById", "tags": [ "CompaniesInsuranceController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "CompaniesInsurance PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompaniesInsurancePartial" } } }, "x-parameter-index": 1 }, "operationId": "CompaniesInsuranceController.updateById" }, "get": { "x-controller-name": "CompaniesInsuranceController", "x-operation-name": "findById", "tags": [ "CompaniesInsuranceController" ], "responses": { "200": { "description": "CompaniesInsurance model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompaniesInsuranceWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompaniesInsurance.Filter" } } } } ], "operationId": "CompaniesInsuranceController.findById" }, "delete": { "x-controller-name": "CompaniesInsuranceController", "x-operation-name": "deleteById", "tags": [ "CompaniesInsuranceController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "CompaniesInsurance DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CompaniesInsuranceController.deleteById" } }, "/companies-insurances": { "post": { "x-controller-name": "CompaniesInsuranceController", "x-operation-name": "create", "tags": [ "CompaniesInsuranceController" ], "responses": { "200": { "description": "CompaniesInsurance model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompaniesInsurance" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewCompaniesInsurance" } } } }, "operationId": "CompaniesInsuranceController.create" }, "patch": { "x-controller-name": "CompaniesInsuranceController", "x-operation-name": "updateAll", "tags": [ "CompaniesInsuranceController" ], "responses": { "200": { "description": "CompaniesInsurance PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "CompaniesInsurance.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompaniesInsurancePartial" } } } }, "operationId": "CompaniesInsuranceController.updateAll" }, "get": { "x-controller-name": "CompaniesInsuranceController", "x-operation-name": "find", "tags": [ "CompaniesInsuranceController" ], "responses": { "200": { "description": "Array of CompaniesInsurance model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CompaniesInsuranceWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompaniesInsurance.Filter1" } } } } ], "operationId": "CompaniesInsuranceController.find" } }, "/companies-insurances-asi": { "get": { "x-controller-name": "CompaniesInsuranceController", "x-operation-name": "findbyasi", "tags": [ "CompaniesInsuranceController" ], "responses": { "200": { "description": "Array of CompaniesInsurance model instances for vl", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CompaniesInsuranceWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompaniesInsurance.Filter1" } } } } ], "operationId": "CompaniesInsuranceController.findbyasi" } }, "/companies-insurances-basedonportal": { "get": { "x-controller-name": "CompaniesInsuranceController", "x-operation-name": "findbyportal", "tags": [ "CompaniesInsuranceController" ], "responses": { "200": { "description": "Array of CompaniesInsurance model instances based on portal", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CompaniesInsuranceWithRelations" } } } } } }, "parameters": [ { "name": "portalId", "in": "query", "schema": { "type": "number" } }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompaniesInsurance.Filter1" } } } } ], "operationId": "CompaniesInsuranceController.findbyportal" } }, "/companies-insurances-vl": { "get": { "x-controller-name": "CompaniesInsuranceController", "x-operation-name": "findbyvl", "tags": [ "CompaniesInsuranceController" ], "responses": { "200": { "description": "Array of CompaniesInsurance model instances for vl", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CompaniesInsuranceWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompaniesInsurance.Filter1" } } } } ], "operationId": "CompaniesInsuranceController.findbyvl" } }, "/consignee-to-delivered": { "get": { "x-controller-name": "ScheduleController", "x-operation-name": "updateShipmentStatusestoDelivered", "tags": [ "ScheduleController" ], "responses": { "200": { "description": "Shipment model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipmentWithRelations" } } } } }, "operationId": "ScheduleController.updateShipmentStatusestoDelivered" } }, "/copy-shipment": { "post": { "x-controller-name": "ShipmentController", "x-operation-name": "copyShipment", "tags": [ "ShipmentController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker create shipment |\n", "responses": { "200": { "description": "Shipment model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Shipment" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "loadType", "customer", "mode", "equipment", "commodity", "commodityValue" ], "properties": { "shipmentId": { "type": "string" }, "copies": { "type": "number" }, "shipper": { "type": "boolean", "nullable": true }, "carrierMc": { "type": "boolean", "nullable": true }, "rates": { "type": "boolean", "nullable": true }, "containerNo": { "type": "number", "nullable": true } } } } } }, "operationId": "ShipmentController.copyShipment" } }, "/count-emails": { "get": { "x-controller-name": "EmailMarketingController", "x-operation-name": "countEmails", "tags": [ "EmailMarketingController" ], "responses": { "200": { "description": "Return value of EmailMarketingController.countEmails" } }, "operationId": "EmailMarketingController.countEmails" } }, "/count-members": { "get": { "x-controller-name": "UserGroupController", "x-operation-name": "countMembers", "tags": [ "UserGroupController" ], "responses": { "200": { "description": "Return value of UserGroupController.countMembers" } }, "parameters": [ { "name": "url", "in": "query", "schema": { "type": "string" } } ], "operationId": "UserGroupController.countMembers" } }, "/countries/all": { "get": { "x-controller-name": "CountryController", "x-operation-name": "allCountries", "tags": [ "CountryController" ], "responses": { "200": { "description": "Array of Countries model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CountriesWithRelations" } } } } } }, "operationId": "CountryController.allCountries" } }, "/countries/count": { "get": { "x-controller-name": "CountryController", "x-operation-name": "count", "tags": [ "CountryController" ], "responses": { "200": { "description": "Countries model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Countries.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "CountryController.count" } }, "/countries/states": { "get": { "x-controller-name": "CountriesStatesController", "x-operation-name": "countryStates", "tags": [ "CountriesStatesController" ], "responses": { "200": { "description": "Array of Countries has many States", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/States" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/States.Filter" } } } } ], "operationId": "CountriesStatesController.countryStates" } }, "/countries/{id}/states": { "post": { "x-controller-name": "CountriesStatesController", "x-operation-name": "create", "tags": [ "CountriesStatesController" ], "responses": { "200": { "description": "Countries model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/States" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewStatesInCountries" } } }, "x-parameter-index": 1 }, "operationId": "CountriesStatesController.create" }, "patch": { "x-controller-name": "CountriesStatesController", "x-operation-name": "patch", "tags": [ "CountriesStatesController" ], "responses": { "200": { "description": "Countries.States PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "States.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StatesPartial" } } }, "x-parameter-index": 1 }, "operationId": "CountriesStatesController.patch" }, "get": { "x-controller-name": "CountriesStatesController", "x-operation-name": "find", "tags": [ "CountriesStatesController" ], "responses": { "200": { "description": "Array of Countries has many States", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/States" } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } ], "operationId": "CountriesStatesController.find" }, "delete": { "x-controller-name": "CountriesStatesController", "x-operation-name": "delete", "tags": [ "CountriesStatesController" ], "responses": { "200": { "description": "Countries.States DELETE success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "States.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "CountriesStatesController.delete" } }, "/countries/{id}": { "put": { "x-controller-name": "CountryController", "x-operation-name": "replaceById", "tags": [ "CountryController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Countries PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Countries" } } }, "x-parameter-index": 1 }, "operationId": "CountryController.replaceById" }, "patch": { "x-controller-name": "CountryController", "x-operation-name": "updateById", "tags": [ "CountryController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Countries PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CountriesPartial" } } }, "x-parameter-index": 1 }, "operationId": "CountryController.updateById" }, "get": { "x-controller-name": "CountryController", "x-operation-name": "findById", "tags": [ "CountryController" ], "responses": { "200": { "description": "Countries model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CountriesWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Countries.Filter" } } } } ], "operationId": "CountryController.findById" }, "delete": { "x-controller-name": "CountryController", "x-operation-name": "deleteById", "tags": [ "CountryController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Countries DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CountryController.deleteById" } }, "/countries": { "post": { "x-controller-name": "CountryController", "x-operation-name": "create", "tags": [ "CountryController" ], "responses": { "200": { "description": "Countries model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Countries" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewCountries" } } } }, "operationId": "CountryController.create" }, "patch": { "x-controller-name": "CountryController", "x-operation-name": "updateAll", "tags": [ "CountryController" ], "responses": { "200": { "description": "Countries PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Countries.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CountriesPartial" } } } }, "operationId": "CountryController.updateAll" }, "get": { "x-controller-name": "CountryController", "x-operation-name": "find", "tags": [ "CountryController" ], "responses": { "200": { "description": "Array of Countries model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CountriesWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Countries.Filter1" } } } } ], "operationId": "CountryController.find" } }, "/covered-to-consignee": { "get": { "x-controller-name": "ScheduleController", "x-operation-name": "updateShipmentStatusesToConsignedee", "tags": [ "ScheduleController" ], "responses": { "200": { "description": "Shipment model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipmentWithRelations" } } } } }, "operationId": "ScheduleController.updateShipmentStatusesToConsignedee" } }, "/cpr-audit-update-shipment-verify": { "post": { "x-controller-name": "AuditorController", "x-operation-name": "cprupdateShipmentStatus", "tags": [ "AuditorController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker update carrier |\n", "responses": { "200": { "description": "Shipment model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Shipment" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "AuditorController.cprupdateShipmentStatus" } }, "/cpr-checked-by-sme/{id}": { "get": { "x-controller-name": "McVerificationController", "x-operation-name": "CprCheckedBySme", "tags": [ "McVerificationController" ], "description": "\n\n| Permissions |\n| ------- |\n| sme view mcapprove |\n", "responses": { "200": { "description": "McVerification model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/McVerificationWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "McVerificationController.CprCheckedBySme" } }, "/cpr-checked-by-sme-second/{id}": { "get": { "x-controller-name": "McVerificationController", "x-operation-name": "CprCheckedBySmeSecond", "tags": [ "McVerificationController" ], "description": "\n\n| Permissions |\n| ------- |\n| sme view mcapprove |\n", "responses": { "200": { "description": "McVerification model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/McVerificationWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "McVerificationController.CprCheckedBySmeSecond" } }, "/cpr-details/{id}": { "get": { "x-controller-name": "MobileAppController", "x-operation-name": "CprDetails", "tags": [ "MobileAppController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker create shipment |\n", "responses": { "200": { "description": "Shipment model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipmentWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "MobileAppController.CprDetails" } }, "/cpr-list": { "get": { "x-controller-name": "SmeReportControllerController", "x-operation-name": "find", "tags": [ "SmeReportControllerController" ], "description": "\n\n| Permissions |\n| ------- |\n| sme view dashboard |\n| sme view cpr list |\n", "responses": { "200": { "description": "Array of CprRequest model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CprRequestWithRelations" } } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "CprRequest.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } }, { "name": "shipmentId", "in": "query", "schema": { "type": "string" } }, { "name": "mc", "in": "query", "schema": { "type": "string" } }, { "name": "dot", "in": "query", "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "number" } }, { "name": "pageSize", "in": "query", "schema": { "type": "number" } } ], "operationId": "SmeReportControllerController.find" } }, "/cpr-margin-notifications/{id}/exceptions-request-logs": { "get": { "x-controller-name": "CprMarginNotificationExceptionsRequestLogsController", "x-operation-name": "getExceptionsRequestLogs", "tags": [ "CprMarginNotificationExceptionsRequestLogsController" ], "responses": { "200": { "description": "ExceptionsRequestLogs belonging to CprMarginNotification", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExceptionsRequestLogs" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CprMarginNotificationExceptionsRequestLogsController.getExceptionsRequestLogs" } }, "/cpr-margin-notifications/{id}/shipment": { "get": { "x-controller-name": "CprMarginNotificationShipmentController", "x-operation-name": "getShipment", "tags": [ "CprMarginNotificationShipmentController" ], "responses": { "200": { "description": "Shipment belonging to CprMarginNotification", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Shipment" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CprMarginNotificationShipmentController.getShipment" } }, "/cpr-margin-notifications/{id}/user": { "get": { "x-controller-name": "CprMarginNotificationUserController", "x-operation-name": "getUser", "tags": [ "CprMarginNotificationUserController" ], "responses": { "200": { "description": "User belonging to CprMarginNotification", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CprMarginNotificationUserController.getUser" } }, "/cpr-remove-processing-by-sme/{id}": { "get": { "x-controller-name": "McVerificationController", "x-operation-name": "CprRemoveProcessing", "tags": [ "McVerificationController" ], "description": "\n\n| Permissions |\n| ------- |\n| sme view mcapprove |\n", "responses": { "200": { "description": "McVerification model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/McVerificationWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "McVerificationController.CprRemoveProcessing" } }, "/cpr-requests/{id}/carriers": { "get": { "x-controller-name": "CprRequestCarriersController", "x-operation-name": "getCarriers", "tags": [ "CprRequestCarriersController" ], "responses": { "200": { "description": "Carriers belonging to CprRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Carriers" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CprRequestCarriersController.getCarriers" } }, "/cpr-requests/{id}/portal": { "get": { "x-controller-name": "CprRequestPortalController", "x-operation-name": "getPortal", "tags": [ "CprRequestPortalController" ], "responses": { "200": { "description": "Portal belonging to CprRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Portal" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CprRequestPortalController.getPortal" } }, "/cpr-requests/{id}/shipment": { "get": { "x-controller-name": "CprRequestShipmentController", "x-operation-name": "getShipment", "tags": [ "CprRequestShipmentController" ], "responses": { "200": { "description": "Shipment belonging to CprRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Shipment" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CprRequestShipmentController.getShipment" } }, "/cpr-requests/{id}/user": { "get": { "x-controller-name": "CprRequestUserController", "x-operation-name": "getUser", "tags": [ "CprRequestUserController" ], "responses": { "200": { "description": "User belonging to CprRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "CprRequestUserController.getUser" } }, "/cpr-requests": { "get": { "x-controller-name": "ShipmentCprRequestController", "x-operation-name": "find", "tags": [ "ShipmentCprRequestController" ], "responses": { "200": { "description": "Array of CprRequest model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CprRequestWithRelations" } } } } } }, "description": "\n\n| Permissions |\n| ------- |\n| sme view dashboard |\n", "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "CprRequest.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "ShipmentCprRequestController.find" } }, "/create/carrier-logins": { "post": { "x-controller-name": "CarrierLoginControllerController", "x-operation-name": "createCarrierLogin", "tags": [ "CarrierLoginControllerController" ], "description": "", "responses": { "200": { "description": "CarrierLogin model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CarrierLogin" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewCarrierLogin" } } } }, "operationId": "CarrierLoginControllerController.createCarrierLogin" } }, "/create/shipment": { "patch": { "x-controller-name": "ShipmentController", "x-operation-name": "createShipment", "tags": [ "ShipmentController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker create shipment |\n", "responses": { "200": { "description": "Shipment model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Shipment" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "loadType", "customer", "mode", "equipment", "commodity", "commodityValue" ], "properties": { "loadType": { "type": "string", "enum": [ "full", "partial" ] }, "commodity": { "type": "object", "properties": { "id": { "type": "number", "minimum": 0, "maximum": 99999999999 }, "name": { "type": "string" } }, "required": [ "id", "name" ] }, "commodityValue": { "type": "number", "maximum": 99999999999 }, "equipment": { "type": "object", "properties": { "id": { "minimum": 0, "maximum": 99999999999 }, "name": { "type": "string" } } }, "customer": { "type": "object", "properties": { "id": { "minimum": 1, "maximum": 99999999999 } }, "required": [ "id" ] }, "pallet": { "type": "number", "maximum": 99999999999, "nullable": true }, "weight": { "type": "string", "maxLength": 20, "nullable": true }, "mode": { "type": "number", "enum": [ 0, 1, 2, 3 ] }, "footage": { "type": "string", "maxLength": 50 }, "miles": { "type": "number", "nullable": true, "maximum": 20000 }, "minTemp": { "type": "string", "nullable": true }, "maxTemp": { "type": "string", "nullable": true }, "precoolTemp": { "type": "string", "maximum": 1000 }, "carrierInstrctions": { "type": "string", "maxLength": 3000 }, "shipperInstrctions": { "type": "string", "maxLength": 3000 }, "billingName": { "type": "string", "maximum": 500 }, "billingAddress": { "type": "string", "maximum": 1000 }, "billingZip": { "type": "string", "maximum": 20 }, "billingPhone": { "type": "string", "maximum": 20 }, "billingCantact": { "type": "string", "maximum": 50 }, "billingFax": { "type": "string", "maximum": 20 }, "shipmentPicks": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "nullable": true, "maxLength": 500 }, "address": { "type": "string", "nullable": true, "maxLength": 1000 }, "city": { "type": "object", "properties": { "id": { "type": "number", "nullable": true } }, "nullable": true }, "contact": { "type": "string", "nullable": true, "maxLength": 50 }, "ref": { "type": "string", "maxLength": 200 }, "phone": { "type": "string", "nullable": true, "maxLength": 20 }, "email": { "type": "string", "nullable": true, "maxLength": 50 }, "pickupDate": { "type": "string" }, "apptDate": { "type": "string" }, "apptNote": { "type": "string", "nullable": true, "maxLength": 200 } }, "required": [ "ref", "pickupDate", "apptDate" ] } }, "shipmentDrops": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "nullable": true, "maxLength": 500 }, "address": { "type": "string", "nullable": true, "maxLength": 1000 }, "city": { "type": "object", "properties": { "id": { "type": "number", "nullable": true } }, "nullable": true }, "contact": { "type": "string", "nullable": true, "maxLength": 50 }, "ref": { "type": "string", "nullable": true, "maxLength": 200 }, "phone": { "type": "string", "nullable": true, "maxLength": 20 }, "email": { "type": "string", "nullable": true, "maxLength": 50 }, "dropDate": { "type": "string" }, "apptDate": { "type": "string", "nullable": true }, "apptNote": { "type": "string", "nullable": true, "maxLength": 200 } }, "required": [ "ref", "dropDate", "apptDate" ] } }, "shipmentPrices": { "type": "object", "properties": { "carrierPayMode": { "type": "number", "enum": [ 0, 1 ] }, "shipperPayMode": { "type": "number", "enum": [ 0, 1 ] }, "carrierPrice": { "type": "number", "maximum": 2000000 }, "shipperPrice": { "type": "number", "maximum": 2000000 }, "carrierPriceCad": { "type": "number", "maximum": 2000000 }, "shipperPriceCad": { "type": "number", "maximum": 2000000 }, "carrierPriceType": { "type": "number", "maximum": 9 }, "shipperPriceType": { "type": "number", "maximum": 9 }, "carrierUint": { "type": "number", "nullable": true, "maximum": 2000000 }, "ShipperUnit": { "type": "number", "nullable": true, "maximum": 2000000 }, "carrierUnitPrice": { "type": "number", "nullable": true, "maximum": 2000000 }, "shipperUnitPrice": { "type": "number", "nullable": true, "maximum": 2000000 }, "prices": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "maximum": 100 }, "susd": { "type": "number", "maximum": 200000, "nullable": true }, "scad": { "type": "number", "maximum": 200000, "nullable": true }, "cusd": { "type": "number", "maximum": 200000, "nullable": true }, "ccad": { "type": "number", "maximum": 200000, "nullable": true } }, "required": [ "label", "susd", "scad", "cusd", "ccad" ] } } } } } } } } }, "operationId": "ShipmentController.createShipment" } }, "/create-request": { "post": { "x-controller-name": "CarrierPaymentHoldRequestController", "x-operation-name": "createRequest", "tags": [ "CarrierPaymentHoldRequestController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker view shipment |\n", "responses": { "200": { "description": "Shippers History model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CarrierPaymentHoldRequestHistory" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "CarrierPaymentHoldRequestController.createRequest" } }, "/create-shipper-limit": { "post": { "x-controller-name": "ArshipperLimitController", "x-operation-name": "create", "tags": [ "ArshipperLimitController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar update shipper limit |\n", "responses": { "200": { "description": "Return value of ArshipperLimitController.create", "content": {} }, "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Shipper Limit PATCH success" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipperLimitsPartialExcluding_id-userId-portalId_WithRelations" } } } }, "operationId": "ArshipperLimitController.create" } }, "/create-trucker-tool": { "get": { "x-controller-name": "ApShipmentControllerController", "x-operation-name": "truckTool", "tags": [ "ApShipmentControllerController" ], "responses": { "200": { "description": "Shipment model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "operationId": "ApShipmentControllerController.truckTool" } }, "/customer-sign-document/{type}/{requestId}": { "get": { "x-controller-name": "SignRequestController", "x-operation-name": "getShipperSignatureDocumentView", "tags": [ "SignRequestController" ], "responses": { "200": { "description": "Signature document view HTML page", "content": { "text/html": { "schema": { "type": "string" } } } } }, "parameters": [ { "name": "requestId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "signer_token", "in": "query", "schema": { "type": "string" } }, { "name": "ref", "in": "query", "schema": { "type": "string" } } ], "operationId": "SignRequestController.getShipperSignatureDocumentView" } }, "/dat/equipmentsearch": { "post": { "x-controller-name": "DatSearchController", "x-operation-name": "DatsearchEquipment", "tags": [ "DatSearchController" ], "description": "", "responses": { "200": { "description": "Return value of DatSearchController.DatsearchEquipment", "content": {} } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "originCity": { "type": "string" }, "originState": { "type": "string" }, "destinationCity": { "type": "string" }, "destinationState": { "type": "string" }, "equipmentType": { "type": "string" }, "pickupDate": { "type": "string", "format": "date" }, "mode": { "type": "string", "enum": [ "TL", "LTL" ], "default": "TL" } }, "required": [ "originCity", "originState", "destinationCity", "destinationState", "equipmentType", "pickupDate" ] } } } }, "operationId": "DatSearchController.DatsearchEquipment" } }, "/dat/equipmentsearchcount": { "post": { "x-controller-name": "DatSearchController", "x-operation-name": "DatsearchCountEquipment", "tags": [ "DatSearchController" ], "description": "", "responses": { "200": { "description": "Return value of DatSearchController.DatsearchCountEquipment", "content": {} } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "originCity": { "type": "string" }, "originState": { "type": "string" }, "destinationCity": { "type": "string" }, "destinationState": { "type": "string" }, "equipmentType": { "type": "string" }, "pickupDate": { "type": "string", "format": "date" }, "mode": { "type": "string", "enum": [ "TL", "LTL" ], "default": "TL" } }, "required": [ "originCity", "originState", "destinationCity", "destinationState", "equipmentType", "pickupDate" ] } } } }, "operationId": "DatSearchController.DatsearchCountEquipment" } }, "/dat/shipmentsearch": { "post": { "x-controller-name": "DatSearchController", "x-operation-name": "DatsearchShipment", "tags": [ "DatSearchController" ], "description": "", "responses": { "200": { "description": "Return value of DatSearchController.DatsearchShipment", "content": {} } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "originCity": { "type": "string" }, "originState": { "type": "string" }, "destinationCity": { "type": "string" }, "destinationState": { "type": "string" }, "equipmentType": { "type": "string" }, "pickupDate": { "type": "string", "format": "date" }, "mode": { "type": "string", "enum": [ "TL", "LTL" ], "default": "TL" } }, "required": [ "originCity", "originState", "destinationCity", "destinationState", "equipmentType", "pickupDate" ] } } } }, "operationId": "DatSearchController.DatsearchShipment" } }, "/dat/shipmentsearchcount": { "post": { "x-controller-name": "DatSearchController", "x-operation-name": "DatsearchCountShipment", "tags": [ "DatSearchController" ], "description": "", "responses": { "200": { "description": "Return value of DatSearchController.DatsearchCountShipment", "content": {} } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "originCity": { "type": "string" }, "originState": { "type": "string" }, "destinationCity": { "type": "string" }, "destinationState": { "type": "string" }, "equipmentType": { "type": "string" }, "pickupDate": { "type": "string", "format": "date" }, "mode": { "type": "string", "enum": [ "TL", "LTL" ], "default": "TL" } }, "required": [ "originCity", "originState", "destinationCity", "destinationState", "equipmentType", "pickupDate" ] } } } }, "operationId": "DatSearchController.DatsearchCountShipment" } }, "/dat-keys/count": { "get": { "x-controller-name": "DatKeysController", "x-operation-name": "count", "tags": [ "DatKeysController" ], "responses": { "200": { "description": "DatKeys model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "DatKeys.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "DatKeysController.count" } }, "/dat-keys/{id}": { "put": { "x-controller-name": "DatKeysController", "x-operation-name": "replaceById", "tags": [ "DatKeysController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "DatKeys PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DatKeys" } } }, "x-parameter-index": 1 }, "operationId": "DatKeysController.replaceById" }, "patch": { "x-controller-name": "DatKeysController", "x-operation-name": "updateById", "tags": [ "DatKeysController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "DatKeys PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DatKeysPartial" } } }, "x-parameter-index": 1 }, "operationId": "DatKeysController.updateById" }, "get": { "x-controller-name": "DatKeysController", "x-operation-name": "findById", "tags": [ "DatKeysController" ], "responses": { "200": { "description": "DatKeys model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DatKeysWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "DatKeysController.findById" }, "delete": { "x-controller-name": "DatKeysController", "x-operation-name": "deleteById", "tags": [ "DatKeysController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "DatKeys DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "DatKeysController.deleteById" } }, "/dat-keys": { "post": { "x-controller-name": "DatKeysController", "x-operation-name": "create", "tags": [ "DatKeysController" ], "responses": { "200": { "description": "DatKeys model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DatKeys" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewDatKeys" } } } }, "operationId": "DatKeysController.create" }, "patch": { "x-controller-name": "DatKeysController", "x-operation-name": "updateAll", "tags": [ "DatKeysController" ], "responses": { "200": { "description": "DatKeys PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "DatKeys.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DatKeysPartial" } } } }, "operationId": "DatKeysController.updateAll" }, "get": { "x-controller-name": "DatKeysController", "x-operation-name": "find", "tags": [ "DatKeysController" ], "responses": { "200": { "description": "Array of DatKeys model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DatKeysWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DatKeys.Filter" } } } } ], "operationId": "DatKeysController.find" } }, "/datonboardcarriers/count": { "get": { "x-controller-name": "DatonboardcarrierController", "x-operation-name": "count", "tags": [ "DatonboardcarrierController" ], "responses": { "200": { "description": "Datonboardcarrier model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Datonboardcarrier.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "DatonboardcarrierController.count" } }, "/datonboardcarriers/findByMcNumber/{status}/{mcNumber}": { "get": { "x-controller-name": "DatonboardcarrierController", "x-operation-name": "findByMcNumber", "tags": [ "DatonboardcarrierController" ], "responses": { "200": { "description": "Datonboardcarrier model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DatonboardcarrierWithRelations" } } } } }, "parameters": [ { "name": "status", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "mcNumber", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "DatonboardcarrierController.findByMcNumber" } }, "/datonboardcarriers/getDetails/{carrierId}": { "get": { "x-controller-name": "DatonboardcarrierController", "x-operation-name": "GetCarrierDetailsfindById", "tags": [ "DatonboardcarrierController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker get date rate |\n", "responses": { "200": { "description": "Datonboardcarrier model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DatonboardcarrierWithRelations" } } } } }, "parameters": [ { "name": "carrierId", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "DatonboardcarrierController.GetCarrierDetailsfindById" } }, "/datonboardcarriers/{status}/{mcNumber}": { "get": { "x-controller-name": "DatonboardcarrierController", "x-operation-name": "findById", "tags": [ "DatonboardcarrierController" ], "description": "", "responses": { "200": { "description": "Datonboardcarrier model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DatonboardcarrierWithRelations" } } } } }, "parameters": [ { "name": "status", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "mcNumber", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "DatonboardcarrierController.findById" } }, "/datonboardcarriers/{id}": { "put": { "x-controller-name": "DatonboardcarrierController", "x-operation-name": "replaceById", "tags": [ "DatonboardcarrierController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Datonboardcarrier PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Datonboardcarrier" } } }, "x-parameter-index": 1 }, "operationId": "DatonboardcarrierController.replaceById" }, "patch": { "x-controller-name": "DatonboardcarrierController", "x-operation-name": "updateById", "tags": [ "DatonboardcarrierController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Datonboardcarrier PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DatonboardcarrierPartial" } } }, "x-parameter-index": 1 }, "operationId": "DatonboardcarrierController.updateById" }, "delete": { "x-controller-name": "DatonboardcarrierController", "x-operation-name": "deleteById", "tags": [ "DatonboardcarrierController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Datonboardcarrier DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "DatonboardcarrierController.deleteById" } }, "/datonboardcarriers": { "post": { "x-controller-name": "DatonboardcarrierController", "x-operation-name": "create", "tags": [ "DatonboardcarrierController" ], "responses": { "200": { "description": "Datonboardcarrier model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Datonboardcarrier" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewDatonboardcarrier" } } } }, "operationId": "DatonboardcarrierController.create" }, "patch": { "x-controller-name": "DatonboardcarrierController", "x-operation-name": "updateAll", "tags": [ "DatonboardcarrierController" ], "responses": { "200": { "description": "Datonboardcarrier PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Datonboardcarrier.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DatonboardcarrierPartial" } } } }, "operationId": "DatonboardcarrierController.updateAll" }, "get": { "x-controller-name": "DatonboardcarrierController", "x-operation-name": "find", "tags": [ "DatonboardcarrierController" ], "description": "", "responses": { "200": { "description": "Array of Datonboardcarrier model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DatonboardcarrierWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Datonboardcarrier.Filter" } } } } ], "operationId": "DatonboardcarrierController.find" } }, "/decline/by/admin/for/ap/status/change": { "get": { "x-controller-name": "RoleUserController", "x-operation-name": "declineByAdminForAPStatusChange", "tags": [ "RoleUserController" ], "description": "", "responses": { "200": { "description": "Return value of RoleUserController.declineByAdminForAPStatusChange", "content": {} } }, "parameters": [ { "name": "MainId", "in": "query", "schema": { "type": "string" } } ], "operationId": "RoleUserController.declineByAdminForAPStatusChange" } }, "/decline-ar-cpr-requests": { "post": { "x-controller-name": "ArCprInvoiceRequestController", "x-operation-name": "declinecpr", "tags": [ "ArCprInvoiceRequestController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker view cprInvoiceRequest |\n", "responses": { "200": { "description": "Return value of ArCprInvoiceRequestController.declinecpr", "content": {} }, "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Shipper Limit PATCH success" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "ArCprInvoiceRequestController.declinecpr" } }, "/decline-ar-invoice-request": { "post": { "x-controller-name": "ArCprInvoiceRequestController", "x-operation-name": "declineInvoiceRequest", "tags": [ "ArCprInvoiceRequestController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker view cprInvoiceRequest |\n", "responses": { "200": { "description": "Return value of ArCprInvoiceRequestController.declineInvoiceRequest", "content": {} }, "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Decline invoice request" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "ArCprInvoiceRequestController.declineInvoiceRequest" } }, "/declined-request": { "post": { "x-controller-name": "CarrierPaymentHoldRequestController", "x-operation-name": "declinedRequest", "tags": [ "CarrierPaymentHoldRequestController" ], "description": "", "responses": { "200": { "description": "Shippers History model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CarrierPaymentHoldRequestHistory" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "CarrierPaymentHoldRequestController.declinedRequest" } }, "/deduct/vl/drayage/incentives/pro": { "get": { "x-controller-name": "DatratemateController", "x-operation-name": "DeductVLDrayageIncentivesPro", "tags": [ "DatratemateController" ], "responses": { "200": { "description": "Return value of DatratemateController.DeductVLDrayageIncentivesPro" } }, "operationId": "DatratemateController.DeductVLDrayageIncentivesPro" } }, "/delete-azure-gallery": { "delete": { "x-controller-name": "CommonfileuploadController", "x-operation-name": "deleteFullGallery", "tags": [ "CommonfileuploadController" ], "responses": { "200": { "description": "Return value of CommonfileuploadController.deleteFullGallery" } }, "operationId": "CommonfileuploadController.deleteFullGallery" } }, "/delete-email-marketing": { "post": { "x-controller-name": "EmailMarketingController", "x-operation-name": "softDeleteById", "tags": [ "EmailMarketingController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker send email marketing |\n", "responses": { "200": { "description": "Return value of EmailMarketingController.softDeleteById", "content": {} }, "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Email Marketing soft delete success" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number" } }, "required": [ "id" ] } } } }, "operationId": "EmailMarketingController.softDeleteById" } }, "/delete-insurance-document": { "post": { "x-controller-name": "ArInsuranceDocumentsController", "x-operation-name": "softDeletedeleteById", "tags": [ "ArInsuranceDocumentsController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar delete insurance document |\n", "responses": { "200": { "description": "Return value of ArInsuranceDocumentsController.softDeletedeleteById", "content": {} }, "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Insurance document delete success" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "ArInsuranceDocumentsController.softDeletedeleteById" } }, "/delivered-to-rti": { "get": { "x-controller-name": "ScheduleController", "x-operation-name": "updateShipmentStatusestoRTI", "tags": [ "ScheduleController" ], "responses": { "200": { "description": "Shipment model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipmentWithRelations" } } } } }, "operationId": "ScheduleController.updateShipmentStatusestoRTI" } }, "/document/{pdfUrl}": { "get": { "x-controller-name": "ArInvoicesController", "x-operation-name": "getDocument", "tags": [ "ArInvoicesController" ], "responses": { "200": { "description": "Invoice PDF file", "content": { "application/pdf": {} } }, "404": { "description": "Invoice not found" } }, "parameters": [ { "name": "pdfUrl", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "ArInvoicesController.getDocument" } }, "/dot/detail/{intB}": { "get": { "x-controller-name": "TruckstopController", "x-operation-name": "getDot", "tags": [ "TruckstopController" ], "responses": { "200": { "description": "Return value of TruckstopController.getDot" } }, "parameters": [ { "name": "intB", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "operationId": "TruckstopController.getDot" } }, "/drayage-incentive/details": { "get": { "x-controller-name": "BrokerIncentiveController", "x-operation-name": "getDrayageIncentiveDetails", "tags": [ "BrokerIncentiveController" ], "responses": { "200": { "description": "Drayage Incentive Invoice Details", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "shipmentId": { "type": "number" }, "invoiceId": { "type": "number" }, "paid": { "type": "number" }, "margin": { "type": "number" }, "broker": { "type": "string" } } } } } } } }, "parameters": [ { "name": "userId", "in": "query", "schema": { "type": "number" } }, { "name": "incentiveMonth", "in": "query", "schema": { "type": "string" } } ], "operationId": "BrokerIncentiveController.getDrayageIncentiveDetails" } }, "/drayage-incentive": { "get": { "x-controller-name": "BrokerIncentiveController", "x-operation-name": "getDrayageIncentive", "tags": [ "BrokerIncentiveController" ], "responses": { "200": { "description": "Drayage Incentive Data", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "additionalProperties": true } } } } } }, "parameters": [ { "name": "incentiveMonth", "in": "query", "schema": { "type": "string" } }, { "name": "lock", "in": "query", "schema": { "type": "boolean" } } ], "operationId": "BrokerIncentiveController.getDrayageIncentive" } }, "/drayage-locked-incentive": { "get": { "x-controller-name": "BrokerIncentiveController", "x-operation-name": "getDrayageLockedIncentive", "tags": [ "BrokerIncentiveController" ], "responses": { "200": { "description": "Get locked drayage incentive data", "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "array", "items": { "type": "object", "properties": { "userId": { "type": "number" }, "employeeId": { "type": "string" }, "realName": { "type": "string" }, "name": { "type": "string" }, "tlName": { "type": "string" }, "tmName": { "type": "string" }, "tlEmployeeId": { "type": "string" }, "tmEmployeeId": { "type": "string" }, "managerId": { "type": "number" }, "tlId": { "type": "number" }, "minDateReceived": { "type": "string" }, "maxDateReceived": { "type": "string" }, "totalReceivedAmount": { "type": "number" }, "totalPaidAmount": { "type": "number" }, "redflag": { "type": "number" }, "incentive": { "type": "number" }, "inrAmt": { "type": "number" }, "incentiveMonth": { "type": "string" } } } }, "groupedByManager": { "type": "array", "items": { "type": "object", "properties": { "managerId": { "type": "number" }, "tlId": { "type": "number" }, "tmName": { "type": "string" }, "tmEmployeeId": { "type": "string" }, "totalReceivedAmount": { "type": "number" }, "indirecttotalReceivedAmount": { "type": "number" }, "redflag": { "type": "number" }, "totalPaidAmount": { "type": "number" }, "indirecttotalPaidAmount": { "type": "number" }, "white": { "type": "number" }, "incentive": { "type": "number" }, "indirectincentive": { "type": "number" }, "whiteincentive": { "type": "number" }, "inrAmt": { "type": "number" }, "incentiveMonth": { "type": "string" } } } }, "groupedByTl": { "type": "array", "items": { "type": "object", "properties": { "tlId": { "type": "number" }, "tlName": { "type": "string" }, "tlEmployeeId": { "type": "string" }, "totalReceivedAmount": { "type": "number" }, "redflag": { "type": "number" }, "totalPaidAmount": { "type": "number" }, "incentive": { "type": "number" }, "inrAmt": { "type": "number" }, "tlInr": { "type": "number" }, "incentiveMonth": { "type": "string" } } } } } } } } } }, "parameters": [ { "name": "incentiveMonth", "in": "query", "schema": { "type": "string" } } ], "operationId": "BrokerIncentiveController.getDrayageLockedIncentive" } }, "/drayage-locked-incentive-send": { "post": { "x-controller-name": "BrokerIncentiveController", "x-operation-name": "sendDrayageLockedIncentiveEmail", "tags": [ "BrokerIncentiveController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker view incentive |\n", "responses": { "200": { "description": "Send drayage locked incentive data via email with CSV attachments", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "incentiveMonth", "emailAddress" ], "properties": { "incentiveMonth": { "type": "string", "description": "Incentive month in YYYY-MM format" }, "emailAddress": { "type": "string", "description": "Email address to send the report to" } } } } } }, "operationId": "BrokerIncentiveController.sendDrayageLockedIncentiveEmail" } }, "/edit-user-group/{id}": { "post": { "x-controller-name": "UserGroupController", "x-operation-name": "editUserGroup", "tags": [ "UserGroupController" ], "responses": { "200": { "description": "File and form upload", "content": { "application/json": { "schema": { "type": "object" } } } } }, "description": "", "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "multipart/form-data": { "x-parser": "stream", "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } } } } }, "description": "Request body for multipart/form-data based file upload", "required": true, "x-parameter-index": 1 }, "operationId": "UserGroupController.editUserGroup" } }, "/efs-weekly-report": { "get": { "x-controller-name": "ReportsController", "x-operation-name": "getEfsWeeklyReport", "tags": [ "ReportsController" ], "responses": { "200": { "description": "Latest 300 EFS carrier payments with related carrier aging, carrier, and broker information", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "shipmentId": { "type": "number" }, "invoice_number": { "type": "string" }, "invoice_date": { "type": "string" } } } } } } } }, "description": "", "operationId": "ReportsController.getEfsWeeklyReport" } }, "/email/debounce/save": { "post": { "x-controller-name": "EmailMarketingController", "x-operation-name": "saveAllUniqueDebouncedEmails", "tags": [ "EmailMarketingController" ], "responses": { "200": { "description": "Return value of EmailMarketingController.saveAllUniqueDebouncedEmails" } }, "operationId": "EmailMarketingController.saveAllUniqueDebouncedEmails" } }, "/email-group/{groupId}/parse": { "get": { "x-controller-name": "UserGroupController", "x-operation-name": "parseEmails", "tags": [ "UserGroupController" ], "responses": { "200": { "description": "Return value of UserGroupController.parseEmails" } }, "parameters": [ { "name": "groupId", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "UserGroupController.parseEmails" } }, "/email-marketing/{id}": { "get": { "x-controller-name": "EmailMarketingController", "x-operation-name": "EmailMarketingView", "tags": [ "EmailMarketingController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker send email marketing |\n", "responses": { "200": { "description": "Return value of EmailMarketingController.EmailMarketingView", "content": {} } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "EmailMarketingController.EmailMarketingView" } }, "/email-marketing-edit/{id}": { "patch": { "x-controller-name": "EmailMarketingController", "x-operation-name": "updateEmailMarketing", "tags": [ "EmailMarketingController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker send email marketing |\n", "responses": { "200": { "description": "Return value of EmailMarketingController.updateEmailMarketing", "content": {} } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "subject": { "type": "string" }, "content": { "type": "string" } }, "required": [ "subject", "content" ] } } }, "x-parameter-index": 1 }, "operationId": "EmailMarketingController.updateEmailMarketing" } }, "/email-marketing-list": { "get": { "x-controller-name": "EmailMarketingController", "x-operation-name": "find", "tags": [ "EmailMarketingController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker send email marketing |\n", "responses": { "200": { "description": "Array of email marketing model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EmailMarketingWithRelations" } } } } } }, "parameters": [ { "name": "page", "in": "query", "schema": { "type": "number" } }, { "name": "pageSize", "in": "query", "schema": { "type": "number" } }, { "name": "subject", "in": "query", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "schema": { "type": "string" } }, { "name": "direction", "in": "query", "schema": { "type": "string" } } ], "operationId": "EmailMarketingController.find" } }, "/emp-alignments/create": { "post": { "x-controller-name": "EmpAlignmentUserController", "x-operation-name": "createUser", "tags": [ "EmpAlignmentUserController" ], "responses": { "200": { "description": "Employee Alignment instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmpAlignment" } } } } }, "description": "\n\n| Permissions |\n| ------- |\n| ar view alignment |\n", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/New Employee Alignment" } } } }, "operationId": "EmpAlignmentUserController.createUser" } }, "/emp-alignments/single-user/{id}": { "patch": { "x-controller-name": "EmpAlignmentUserController", "x-operation-name": "updateResource", "tags": [ "EmpAlignmentUserController" ], "responses": { "200": { "description": "Portal.User PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmpAlignmentPartial" } } }, "x-parameter-index": 1 }, "operationId": "EmpAlignmentUserController.updateResource" }, "get": { "x-controller-name": "EmpAlignmentUserController", "x-operation-name": "getSingleUser", "tags": [ "EmpAlignmentUserController" ], "responses": { "200": { "description": "User belonging to EmpAlignment", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EmpAlignmentWithRelations" } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "EmpAlignmentUserController.getSingleUser" } }, "/emp-alignments/user/{month}": { "get": { "x-controller-name": "EmpAlignmentUserController", "x-operation-name": "getUserMonth", "tags": [ "EmpAlignmentUserController" ], "responses": { "200": { "description": "User belonging to EmpAlignment", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EmpAlignmentWithRelations" } } } } } }, "description": "\n\n| Permissions |\n| ------- |\n| ar view alignment |\n", "parameters": [ { "name": "month", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "EmpAlignmentUserController.getUserMonth" } }, "/emp-alignments/{id}/user": { "get": { "x-controller-name": "EmpAlignmentUserController", "x-operation-name": "getUser", "tags": [ "EmpAlignmentUserController" ], "responses": { "200": { "description": "User belonging to EmpAlignment", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "EmpAlignmentUserController.getUser" } }, "/equipments/count": { "get": { "x-controller-name": "EquipmentController", "x-operation-name": "count", "tags": [ "EquipmentController" ], "responses": { "200": { "description": "Equipment model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Equipment.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "EquipmentController.count" } }, "/equipments/{id}": { "put": { "x-controller-name": "EquipmentController", "x-operation-name": "replaceById", "tags": [ "EquipmentController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Equipment PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Equipment" } } }, "x-parameter-index": 1 }, "operationId": "EquipmentController.replaceById" }, "patch": { "x-controller-name": "EquipmentController", "x-operation-name": "updateById", "tags": [ "EquipmentController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Equipment PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EquipmentPartial" } } }, "x-parameter-index": 1 }, "operationId": "EquipmentController.updateById" }, "get": { "x-controller-name": "EquipmentController", "x-operation-name": "findById", "tags": [ "EquipmentController" ], "responses": { "200": { "description": "Equipment model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EquipmentWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Equipment.Filter" } } } } ], "operationId": "EquipmentController.findById" }, "delete": { "x-controller-name": "EquipmentController", "x-operation-name": "deleteById", "tags": [ "EquipmentController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Equipment DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "EquipmentController.deleteById" } }, "/equipments": { "post": { "x-controller-name": "EquipmentController", "x-operation-name": "create", "tags": [ "EquipmentController" ], "responses": { "200": { "description": "Equipment model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Equipment" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewEquipment" } } } }, "operationId": "EquipmentController.create" }, "patch": { "x-controller-name": "EquipmentController", "x-operation-name": "updateAll", "tags": [ "EquipmentController" ], "responses": { "200": { "description": "Equipment PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Equipment.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EquipmentPartial" } } } }, "operationId": "EquipmentController.updateAll" }, "get": { "x-controller-name": "EquipmentController", "x-operation-name": "find", "tags": [ "EquipmentController" ], "responses": { "200": { "description": "Array of Equipment model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EquipmentWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Equipment.Filter1" } } } } ], "operationId": "EquipmentController.find" } }, "/exception-approved": { "post": { "x-controller-name": "ExceptionController", "x-operation-name": "approved", "tags": [ "ExceptionController" ], "description": "\n\n| Permissions |\n| ------- |\n| sme exception approved |\n", "responses": { "200": { "description": "Exception model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExceptionsRequestLogs" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "ExceptionController.approved" } }, "/exception-decline": { "post": { "x-controller-name": "ExceptionController", "x-operation-name": "reject", "tags": [ "ExceptionController" ], "description": "\n\n| Permissions |\n| ------- |\n| sme exception decline |\n", "responses": { "200": { "description": "Exception model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExceptionsRequestLogs" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "ExceptionController.reject" } }, "/exception-list": { "get": { "x-controller-name": "ExceptionController", "x-operation-name": "find", "tags": [ "ExceptionController" ], "description": "\n\n| Permissions |\n| ------- |\n| sme exception view |\n", "responses": { "200": { "description": "Array of Sme model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/McVerificationWithRelations" } } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "ExceptionsRequestLogs.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } }, { "name": "page", "in": "query", "schema": { "type": "number" } }, { "name": "pageSize", "in": "query", "schema": { "type": "number" } }, { "name": "userId", "in": "query", "schema": { "type": "string" } }, { "name": "McNo", "in": "query", "schema": { "type": "string" } }, { "name": "DotNo", "in": "query", "schema": { "type": "string" } } ], "operationId": "ExceptionController.find" } }, "/exceptions-request-logs/{id}/mc-verification": { "get": { "x-controller-name": "ExceptionsRequestLogsMcVerificationController", "x-operation-name": "getMcVerification", "tags": [ "ExceptionsRequestLogsMcVerificationController" ], "responses": { "200": { "description": "McVerification belonging to ExceptionsRequestLogs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/McVerification" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ExceptionsRequestLogsMcVerificationController.getMcVerification" } }, "/exceptions-request-logs/{id}/portal": { "get": { "x-controller-name": "ExceptionsRequestLogsPortalController", "x-operation-name": "getPortal", "tags": [ "ExceptionsRequestLogsPortalController" ], "responses": { "200": { "description": "Portal belonging to ExceptionsRequestLogs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Portal" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ExceptionsRequestLogsPortalController.getPortal" } }, "/exceptions-request-logs/{id}/user": { "get": { "x-controller-name": "ExceptionsRequestLogsUserController", "x-operation-name": "getUser", "tags": [ "ExceptionsRequestLogsUserController" ], "responses": { "200": { "description": "User belonging to ExceptionsRequestLogs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ExceptionsRequestLogsUserController.getUser" } }, "/extract-cdl-file": { "post": { "x-controller-name": "PdfReadController", "x-operation-name": "extractFile", "tags": [ "PdfReadController" ], "responses": { "200": { "description": "Extract CDL JSON from a single image (any type, no nulls)", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "content": { "multipart/form-data": { "x-parser": "stream", "schema": { "type": "object" } } }, "description": "Upload a single image", "required": true }, "operationId": "PdfReadController.extractFile" } }, "/extract-cdl-file-new": { "post": { "x-controller-name": "PdfReadController", "x-operation-name": "extractFileNew", "tags": [ "PdfReadController" ], "responses": { "200": { "description": "Extract CDL JSON from a single image (any type, no nulls)", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "content": { "multipart/form-data": { "x-parser": "stream", "schema": { "type": "object" } } }, "description": "Upload a single image", "required": true }, "operationId": "PdfReadController.extractFileNew" } }, "/extract-cdl-file-new-pdf": { "post": { "x-controller-name": "PdfReadController", "x-operation-name": "extractFileNewPdfUrl", "tags": [ "PdfReadController" ], "responses": { "200": { "description": "Extract CDL JSON from PDF via URL", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fileUrl": { "type": "string" }, "type": { "type": "string" } } } } }, "description": "PDF URL and type", "required": true }, "operationId": "PdfReadController.extractFileNewPdfUrl" } }, "/extract-commodity-pdf": { "post": { "x-controller-name": "PdfReadController", "x-operation-name": "extractCommodityFromUrl", "tags": [ "PdfReadController" ], "responses": { "200": { "description": "Extract commodity info from a PDF URL, return original and extracted data", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "PdfReadController.extractCommodityFromUrl" } }, "/factoring-details/count": { "get": { "x-controller-name": "FactoringDetailsController", "x-operation-name": "count", "tags": [ "FactoringDetailsController" ], "responses": { "200": { "description": "FactoringDetails model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "FactoringDetails.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "FactoringDetailsController.count" } }, "/factoring-details/{id}/carriers": { "get": { "x-controller-name": "FactoringDetailsCarriersController", "x-operation-name": "getCarriers", "tags": [ "FactoringDetailsCarriersController" ], "responses": { "200": { "description": "Carriers belonging to FactoringDetails", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Carriers" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "FactoringDetailsCarriersController.getCarriers" } }, "/factoring-details/{id}/portal": { "get": { "x-controller-name": "FactoringDetailsPortalController", "x-operation-name": "getPortal", "tags": [ "FactoringDetailsPortalController" ], "responses": { "200": { "description": "Portal belonging to FactoringDetails", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Portal" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "FactoringDetailsPortalController.getPortal" } }, "/factoring-details/{id}/user": { "get": { "x-controller-name": "FactoringDetailsUserController", "x-operation-name": "getUser", "tags": [ "FactoringDetailsUserController" ], "responses": { "200": { "description": "User belonging to FactoringDetails", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "FactoringDetailsUserController.getUser" } }, "/factoring-details/{id}/zip-codes": { "get": { "x-controller-name": "FactoringDetailsZipCodesController", "x-operation-name": "getZipCodes", "tags": [ "FactoringDetailsZipCodesController" ], "responses": { "200": { "description": "ZipCodes belonging to FactoringDetails", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ZipCodes" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "FactoringDetailsZipCodesController.getZipCodes" } }, "/factoring-details/{id}": { "put": { "x-controller-name": "FactoringDetailsController", "x-operation-name": "replaceById", "tags": [ "FactoringDetailsController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "FactoringDetails PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FactoringDetails" } } }, "x-parameter-index": 1 }, "operationId": "FactoringDetailsController.replaceById" }, "patch": { "x-controller-name": "FactoringDetailsController", "x-operation-name": "updateById", "tags": [ "FactoringDetailsController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "FactoringDetails PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FactoringDetailsPartial" } } }, "x-parameter-index": 1 }, "operationId": "FactoringDetailsController.updateById" }, "get": { "x-controller-name": "FactoringDetailsController", "x-operation-name": "findById", "tags": [ "FactoringDetailsController" ], "responses": { "200": { "description": "FactoringDetails model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FactoringDetailsWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FactoringDetails.Filter" } } } } ], "operationId": "FactoringDetailsController.findById" }, "delete": { "x-controller-name": "FactoringDetailsController", "x-operation-name": "deleteById", "tags": [ "FactoringDetailsController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "FactoringDetails DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "FactoringDetailsController.deleteById" } }, "/factoring-details": { "post": { "x-controller-name": "FactoringDetailsController", "x-operation-name": "create", "tags": [ "FactoringDetailsController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker view dashboard |\n", "responses": { "200": { "description": "FactoringDetails model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FactoringDetails" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewFactoringDetails" } } } }, "operationId": "FactoringDetailsController.create" }, "patch": { "x-controller-name": "FactoringDetailsController", "x-operation-name": "updateAll", "tags": [ "FactoringDetailsController" ], "responses": { "200": { "description": "FactoringDetails PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "FactoringDetails.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FactoringDetailsPartial" } } } }, "operationId": "FactoringDetailsController.updateAll" }, "get": { "x-controller-name": "FactoringDetailsController", "x-operation-name": "find", "tags": [ "FactoringDetailsController" ], "description": "\n\n| Permissions |\n| ------- |\n| ap carrier factoring |\n", "responses": { "200": { "description": "Array of FactoringDetails model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FactoringDetailsWithRelations" } } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "FactoringDetails.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "FactoringDetailsController.find" } }, "/factoring-names": { "get": { "x-controller-name": "FactoringDetailsController", "x-operation-name": "getFactoringNames", "tags": [ "FactoringDetailsController" ], "responses": { "200": { "description": "Array of Factoring Details with ID and Name", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" } } } } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "FactoringDetails.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "FactoringDetailsController.getFactoringNames" } }, "/fetch-ap-user": { "get": { "x-controller-name": "EmpAlignmentUserController", "x-operation-name": "fetchApUser", "tags": [ "EmpAlignmentUserController" ], "description": "", "responses": { "200": { "description": "Return value of EmpAlignmentUserController.fetchApUser", "content": {} } }, "operationId": "EmpAlignmentUserController.fetchApUser" } }, "/fetch-bounce-emails": { "get": { "x-controller-name": "EmailMarketingController", "x-operation-name": "fetchBounceEmails", "tags": [ "EmailMarketingController" ], "description": "", "responses": { "200": { "description": "Return value of EmailMarketingController.fetchBounceEmails", "content": {} } }, "parameters": [ { "name": "bulkEmailId", "in": "query", "schema": { "type": "number" } } ], "operationId": "EmailMarketingController.fetchBounceEmails" } }, "/fetch-bounce-emails-and-remove-bounced-emails": { "post": { "x-controller-name": "EmailMarketingController", "x-operation-name": "fetchBounceEmailsAndRemove", "tags": [ "EmailMarketingController" ], "description": "", "responses": { "200": { "description": "Return value of EmailMarketingController.fetchBounceEmailsAndRemove", "content": {} } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "EmailMarketingController.fetchBounceEmailsAndRemove" } }, "/fetch-bulk-emails": { "get": { "x-controller-name": "EmailMarketingController", "x-operation-name": "fetchBulkEmails", "tags": [ "EmailMarketingController" ], "description": "", "responses": { "200": { "description": "Paginated email campaigns with emails and subjects", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "emails": { "type": "array", "items": { "type": "string" } }, "subject": { "type": "string" }, "sent_from": { "type": "string" }, "created": { "type": "string" }, "user": { "type": "object", "properties": { "id": { "type": "number" }, "email": { "type": "string" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "name": { "type": "string" } } } } } }, "total": { "type": "number" }, "page": { "type": "number" }, "limit": { "type": "number" }, "totalPages": { "type": "number" } } } } } } }, "parameters": [ { "name": "page", "in": "query", "schema": { "type": "number" } }, { "name": "limit", "in": "query", "schema": { "type": "number" } }, { "name": "sent_from_user", "in": "query", "schema": { "type": "string" } }, { "name": "sent_from_portal", "in": "query", "schema": { "type": "string" } }, { "name": "subject", "in": "query", "schema": { "type": "string" } } ], "operationId": "EmailMarketingController.fetchBulkEmails" } }, "/fetch-call-broker-performance": { "get": { "x-controller-name": "EmailMarketingController", "x-operation-name": "fetchCallBrokerPerformance", "tags": [ "EmailMarketingController" ], "description": "", "responses": { "200": { "description": "Return value of EmailMarketingController.fetchCallBrokerPerformance", "content": {} } }, "parameters": [ { "name": "account_id", "in": "query", "schema": { "type": "string" } }, { "name": "from_date", "in": "query", "schema": { "type": "string" } }, { "name": "to_date", "in": "query", "schema": { "type": "string" } }, { "name": "user_id", "in": "query", "schema": { "type": "string" } }, { "name": "team_id", "in": "query", "schema": { "type": "string" } } ], "operationId": "EmailMarketingController.fetchCallBrokerPerformance" } }, "/fetch-call-distribution": { "get": { "x-controller-name": "EmailMarketingController", "x-operation-name": "fetchCallDistribution", "tags": [ "EmailMarketingController" ], "description": "", "responses": { "200": { "description": "Return value of EmailMarketingController.fetchCallDistribution", "content": {} } }, "parameters": [ { "name": "from_date", "in": "query", "schema": { "type": "string" } }, { "name": "to_date", "in": "query", "schema": { "type": "string" } }, { "name": "user_id", "in": "query", "schema": { "type": "string" } }, { "name": "team_id", "in": "query", "schema": { "type": "string" } } ], "operationId": "EmailMarketingController.fetchCallDistribution" } }, "/fetch-call-hourly": { "get": { "x-controller-name": "EmailMarketingController", "x-operation-name": "fetchCallHourly", "tags": [ "EmailMarketingController" ], "description": "", "responses": { "200": { "description": "Return value of EmailMarketingController.fetchCallHourly", "content": {} } }, "parameters": [ { "name": "from_date", "in": "query", "schema": { "type": "string" } }, { "name": "to_date", "in": "query", "schema": { "type": "string" } }, { "name": "user_id", "in": "query", "schema": { "type": "string" } }, { "name": "team_id", "in": "query", "schema": { "type": "string" } } ], "operationId": "EmailMarketingController.fetchCallHourly" } }, "/fetch-call-recording": { "get": { "x-controller-name": "EmailMarketingController", "x-operation-name": "fetchCallRecording", "tags": [ "EmailMarketingController" ], "description": "", "responses": { "200": { "description": "Return value of EmailMarketingController.fetchCallRecording", "content": {} } }, "parameters": [ { "name": "from_date", "in": "query", "schema": { "type": "string" } }, { "name": "to_date", "in": "query", "schema": { "type": "string" } }, { "name": "user_id", "in": "query", "schema": { "type": "string" } }, { "name": "team_id", "in": "query", "schema": { "type": "string" } } ], "operationId": "EmailMarketingController.fetchCallRecording" } }, "/fetch-call-recording-listing": { "get": { "x-controller-name": "EmailMarketingController", "x-operation-name": "fetchCallRecordingListing", "tags": [ "EmailMarketingController" ], "description": "", "responses": { "200": { "description": "Return value of EmailMarketingController.fetchCallRecordingListing", "content": {} } }, "parameters": [ { "name": "callListingFilter", "in": "query", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "schema": { "type": "string" } }, { "name": "teamLeader", "in": "query", "schema": { "type": "string" } }, { "name": "teamMember", "in": "query", "schema": { "type": "string" } }, { "name": "from", "in": "query", "schema": { "type": "string" } }, { "name": "to", "in": "query", "schema": { "type": "string" } }, { "name": "pickup_bucket", "in": "query", "schema": { "type": "string" } } ], "operationId": "EmailMarketingController.fetchCallRecordingListing" } }, "/fetch-carrier-call-pickup-speed-distribution": { "get": { "x-controller-name": "EmailMarketingController", "x-operation-name": "fetchCarrierCallPickupSpeedDistribution", "tags": [ "EmailMarketingController" ], "description": "", "responses": { "200": { "description": "Return value of EmailMarketingController.fetchCarrierCallPickupSpeedDistribution", "content": {} } }, "parameters": [ { "name": "from_date", "in": "query", "schema": { "type": "string" } }, { "name": "to_date", "in": "query", "schema": { "type": "string" } }, { "name": "user_id", "in": "query", "schema": { "type": "string" } }, { "name": "team_id", "in": "query", "schema": { "type": "string" } } ], "operationId": "EmailMarketingController.fetchCarrierCallPickupSpeedDistribution" } }, "/fetch-carrier-engagement": { "get": { "x-controller-name": "EmailMarketingController", "x-operation-name": "fetchCarrierEngagement", "tags": [ "EmailMarketingController" ], "description": "", "responses": { "200": { "description": "Return value of EmailMarketingController.fetchCarrierEngagement", "content": {} } }, "parameters": [ { "name": "from_date", "in": "query", "schema": { "type": "string" } }, { "name": "to_date", "in": "query", "schema": { "type": "string" } }, { "name": "user_id", "in": "query", "schema": { "type": "string" } }, { "name": "team_id", "in": "query", "schema": { "type": "string" } } ], "operationId": "EmailMarketingController.fetchCarrierEngagement" } }, "/fetch-claim-notification": { "get": { "x-controller-name": "ArClaimedController", "x-operation-name": "fetchClaimNotification", "tags": [ "ArClaimedController" ], "description": "", "responses": { "200": { "description": "Return value of ArClaimedController.fetchClaimNotification", "content": {} } }, "operationId": "ArClaimedController.fetchClaimNotification" } }, "/fetch-count-shippers-carriers": { "get": { "x-controller-name": "EmailMarketingController", "x-operation-name": "fetchCountShippersAndCarriers", "tags": [ "EmailMarketingController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker send email marketing |\n", "responses": { "200": { "description": "Return value of EmailMarketingController.fetchCountShippersAndCarriers", "content": {} } }, "operationId": "EmailMarketingController.fetchCountShippersAndCarriers" } }, "/fetch-emails-from-mailtrap": { "get": { "x-controller-name": "EmailMarketingController", "x-operation-name": "fetchEmailsFromMailtrap", "tags": [ "EmailMarketingController" ], "responses": { "200": { "description": "Return value of EmailMarketingController.fetchEmailsFromMailtrap" } }, "operationId": "EmailMarketingController.fetchEmailsFromMailtrap" } }, "/fetch-emails-from-smtp": { "get": { "x-controller-name": "EmailMarketingController", "x-operation-name": "fetchEmailsFromSmtp", "tags": [ "EmailMarketingController" ], "responses": { "200": { "description": "Return value of EmailMarketingController.fetchEmailsFromSmtp" } }, "operationId": "EmailMarketingController.fetchEmailsFromSmtp" } }, "/fetch-emails-from-smtp-2": { "get": { "x-controller-name": "EmailMarketingController", "x-operation-name": "fetchEmailsFromSmtp2", "tags": [ "EmailMarketingController" ], "responses": { "200": { "description": "Return value of EmailMarketingController.fetchEmailsFromSmtp2" } }, "operationId": "EmailMarketingController.fetchEmailsFromSmtp2" } }, "/fetch-group-list": { "get": { "x-controller-name": "UserGroupController", "x-operation-name": "findInsuranceDocumentCompanyName", "tags": [ "UserGroupController" ], "description": "", "responses": { "200": { "description": "Array of InsuranceDocument model instances with aliased field", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroup" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserGroup.Filter" } } } } ], "operationId": "UserGroupController.findInsuranceDocumentCompanyName" } }, "/fetch-pie-chart-margin": { "get": { "x-controller-name": "ReportsController", "x-operation-name": "getPieChartMarginReport", "tags": [ "ReportsController" ], "responses": { "200": { "description": "Report fetched successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } } }, "description": "\n\n| Permissions |\n| ------- |\n| view portal reports |\n", "parameters": [ { "name": "month", "in": "query", "schema": { "type": "string" }, "description": "Month name (e.g., \"January\")", "required": true } ], "operationId": "ReportsController.getPieChartMarginReport" } }, "/fetch-quarterly-margin": { "get": { "x-controller-name": "ReportsController", "x-operation-name": "getQuarterMarginReport", "tags": [ "ReportsController" ], "responses": { "200": { "description": "Quarterly margin comparison between two years", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } } } } } }, "description": "\n\n| Permissions |\n| ------- |\n| view portal reports |\n", "parameters": [ { "name": "year1", "in": "query", "schema": { "type": "string" } }, { "name": "year2", "in": "query", "schema": { "type": "string" } } ], "operationId": "ReportsController.getQuarterMarginReport" } }, "/fetch-report-cpr": { "get": { "x-controller-name": "ReportsController", "x-operation-name": "getReport", "tags": [ "ReportsController" ], "responses": { "200": { "description": "Report fetched successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } } }, "description": "\n\n| Permissions |\n| ------- |\n| view portal reports |\n", "parameters": [ { "name": "teamId", "in": "query", "schema": { "type": "string" } }, { "name": "brokerId", "in": "query", "schema": { "type": "string" } } ], "operationId": "ReportsController.getReport" } }, "/fetch-report-invoice": { "get": { "x-controller-name": "ReportsController", "x-operation-name": "getReportInvoice", "tags": [ "ReportsController" ], "responses": { "200": { "description": "Report fetched successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } } }, "description": "\n\n| Permissions |\n| ------- |\n| view portal reports |\n", "parameters": [ { "name": "teamId", "in": "query", "schema": { "type": "string" } }, { "name": "brokerId", "in": "query", "schema": { "type": "string" } } ], "operationId": "ReportsController.getReportInvoice" } }, "/fetch-resend-email-data/{id}": { "get": { "x-controller-name": "EmailMarketingController", "x-operation-name": "fetchResendEmailData", "tags": [ "EmailMarketingController" ], "description": "", "responses": { "200": { "description": "Return value of EmailMarketingController.fetchResendEmailData", "content": {} } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "EmailMarketingController.fetchResendEmailData" } }, "/fetch-shipment-details-ar-report": { "get": { "x-controller-name": "PerformanceReportController", "x-operation-name": "fetchShipmentDetailsArReport", "tags": [ "PerformanceReportController" ], "responses": { "200": { "description": "Return value of PerformanceReportController.fetchShipmentDetailsArReport" } }, "parameters": [ { "name": "startDate", "in": "query", "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "schema": { "type": "string" } }, { "name": "type", "in": "query", "schema": { "type": "string" } } ], "operationId": "PerformanceReportController.fetchShipmentDetailsArReport" } }, "/fetch-team-cpr-list": { "get": { "x-controller-name": "ReportsController", "x-operation-name": "getTeamCprList", "tags": [ "ReportsController" ], "responses": { "200": { "description": "Report fetched successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } } }, "description": "\n\n| Permissions |\n| ------- |\n| view portal reports |\n", "parameters": [ { "name": "month", "in": "query", "schema": { "type": "string" }, "description": "Start date (YYYY-MM-DD)" }, { "name": "year", "in": "query", "schema": { "type": "string" }, "description": "Start date (YYYY-MM-DD)" }, { "name": "startDate", "in": "query", "schema": { "type": "string" }, "description": "Start date (YYYY-MM-DD)" }, { "name": "endDate", "in": "query", "schema": { "type": "string" }, "description": "Start date (YYYY-MM-DD)" } ], "operationId": "ReportsController.getTeamCprList" } }, "/fetch-team-margin": { "get": { "x-controller-name": "ReportsController", "x-operation-name": "getTeamMarginReport", "tags": [ "ReportsController" ], "responses": { "200": { "description": "Report fetched successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } } }, "description": "\n\n| Permissions |\n| ------- |\n| view portal reports |\n", "parameters": [ { "name": "startDate", "in": "query", "schema": { "type": "string" }, "description": "Start date (YYYY-MM-DD)" }, { "name": "endDate", "in": "query", "schema": { "type": "string" }, "description": "End date (YYYY-MM-DD)" }, { "name": "drayage", "in": "query", "schema": { "type": "number" }, "description": "drayage (drayage|otr|all)" } ], "operationId": "ReportsController.getTeamMarginReport" } }, "/fetch-teams": { "get": { "x-controller-name": "EmailMarketingController", "x-operation-name": "fetchTeams", "tags": [ "EmailMarketingController" ], "responses": { "200": { "description": "Return value of EmailMarketingController.fetchTeams" } }, "operationId": "EmailMarketingController.fetchTeams" } }, "/filter-managers": { "get": { "x-controller-name": "ReportsController", "x-operation-name": "listManagers", "tags": [ "ReportsController" ], "responses": { "200": { "description": "List all managers (type=2) with id and first_name", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "first_name": { "type": "string" }, "email": { "type": "string" }, "portalId": { "type": "number" } } } } } } } }, "operationId": "ReportsController.listManagers" } }, "/filter-managers-list": { "get": { "x-controller-name": "ReportsController", "x-operation-name": "listManagersList", "tags": [ "ReportsController" ], "responses": { "200": { "description": "List all managers (type=2) with id and first_name", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "first_name": { "type": "string" }, "email": { "type": "string" }, "portalId": { "type": "number" } } } } } } } }, "description": "", "operationId": "ReportsController.listManagersList" } }, "/first-approved-request": { "post": { "x-controller-name": "CarrierPaymentHoldRequestController", "x-operation-name": "FirstApprovedRequest", "tags": [ "CarrierPaymentHoldRequestController" ], "description": "", "responses": { "200": { "description": "Shippers History model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CarrierPaymentHoldRequestHistory" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "CarrierPaymentHoldRequestController.FirstApprovedRequest" } }, "/follow-up-emails": { "get": { "x-controller-name": "EmailMarketingController", "x-operation-name": "findFollowUpEmails", "tags": [ "EmailMarketingController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker send email marketing |\n", "responses": { "200": { "description": "Array of custom emails from email marketing", "content": { "application/json": { "schema": { "type": "object", "properties": { "emails": { "type": "array", "items": { "type": "string" } } } } } } } }, "parameters": [ { "name": "rowId", "in": "query", "schema": { "type": "number" } } ], "operationId": "EmailMarketingController.findFollowUpEmails" } }, "/generate-invoice/{id}": { "get": { "x-controller-name": "ArInvoicesController", "x-operation-name": "GenerateInvoice", "tags": [ "ArInvoicesController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar view invoices |\n", "responses": { "200": { "description": "Shipment model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipmentWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "ArInvoicesController.GenerateInvoice" } }, "/generate-qb-token": { "get": { "x-controller-name": "QuickbookController", "x-operation-name": "generateQbToken", "tags": [ "QuickbookController" ], "responses": { "200": { "description": "Get QB Token", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" } } } } } } }, "operationId": "QuickbookController.generateQbToken" } }, "/get/all/APTeam/new/advanceshipment": { "get": { "x-controller-name": "RoleUserController", "x-operation-name": "getAPRolesByConditionNewAdvanceshipment", "tags": [ "RoleUserController" ], "description": "", "responses": { "200": { "description": "Return value of RoleUserController.getAPRolesByConditionNewAdvanceshipment", "content": {} } }, "parameters": [ { "name": "SmeIncentiveFrom", "in": "query", "schema": { "type": "string" } }, { "name": "SmeIncentiveTo", "in": "query", "schema": { "type": "string" } } ], "operationId": "RoleUserController.getAPRolesByConditionNewAdvanceshipment" } }, "/get/all/APTeam/new/valueloads": { "get": { "x-controller-name": "RoleUserController", "x-operation-name": "getAPRolesByConditionNewValueloads", "tags": [ "RoleUserController" ], "description": "", "responses": { "200": { "description": "Return value of RoleUserController.getAPRolesByConditionNewValueloads", "content": {} } }, "parameters": [ { "name": "SmeIncentiveFrom", "in": "query", "schema": { "type": "string" } }, { "name": "SmeIncentiveTo", "in": "query", "schema": { "type": "string" } } ], "operationId": "RoleUserController.getAPRolesByConditionNewValueloads" } }, "/get/all/APTeam": { "get": { "x-controller-name": "RoleUserController", "x-operation-name": "getAPRolesByCondition", "tags": [ "RoleUserController" ], "description": "", "responses": { "200": { "description": "Return value of RoleUserController.getAPRolesByCondition", "content": {} } }, "parameters": [ { "name": "SmeIncentiveFrom", "in": "query", "schema": { "type": "string" } }, { "name": "SmeIncentiveTo", "in": "query", "schema": { "type": "string" } } ], "operationId": "RoleUserController.getAPRolesByCondition" } }, "/get/all/arTeam/asi": { "get": { "x-controller-name": "AsiallIncentivesController", "x-operation-name": "getARRolesByConditionASI", "tags": [ "AsiallIncentivesController" ], "description": "", "responses": { "200": { "description": "Return value of AsiallIncentivesController.getARRolesByConditionASI", "content": {} } }, "parameters": [ { "name": "ArIncentiveFrom", "in": "query", "schema": { "type": "string" } }, { "name": "ARIncentiveTo", "in": "query", "schema": { "type": "string" } } ], "operationId": "AsiallIncentivesController.getARRolesByConditionASI" } }, "/get/all/arTeam/final/incentives/asi": { "get": { "x-controller-name": "AsiallIncentivesController", "x-operation-name": "getARFinalincentivesDataASI", "tags": [ "AsiallIncentivesController" ], "description": "", "responses": { "200": { "description": "Return value of AsiallIncentivesController.getARFinalincentivesDataASI", "content": {} } }, "parameters": [ { "name": "ArIncentiveFrom", "in": "query", "schema": { "type": "string" } }, { "name": "ARIncentiveTo", "in": "query", "schema": { "type": "string" } } ], "operationId": "AsiallIncentivesController.getARFinalincentivesDataASI" } }, "/get/all/arTeam/final/incentives": { "get": { "x-controller-name": "RoleUserController", "x-operation-name": "getARFinalincentivesData", "tags": [ "RoleUserController" ], "description": "", "responses": { "200": { "description": "Return value of RoleUserController.getARFinalincentivesData", "content": {} } }, "parameters": [ { "name": "ArIncentiveFrom", "in": "query", "schema": { "type": "string" } }, { "name": "ARIncentiveTo", "in": "query", "schema": { "type": "string" } } ], "operationId": "RoleUserController.getARFinalincentivesData" } }, "/get/all/arTeam/shippers/approved/asi": { "get": { "x-controller-name": "AsiallIncentivesController", "x-operation-name": "getARShipperApprovedListASI", "tags": [ "AsiallIncentivesController" ], "description": "", "responses": { "200": { "description": "Return value of AsiallIncentivesController.getARShipperApprovedListASI", "content": {} } }, "parameters": [ { "name": "ArIncentiveFrom", "in": "query", "schema": { "type": "string" } }, { "name": "ARIncentiveTo", "in": "query", "schema": { "type": "string" } } ], "operationId": "AsiallIncentivesController.getARShipperApprovedListASI" } }, "/get/all/arTeam/shippers/approved": { "get": { "x-controller-name": "RoleUserController", "x-operation-name": "getARShipperApprovedList", "tags": [ "RoleUserController" ], "description": "", "responses": { "200": { "description": "Return value of RoleUserController.getARShipperApprovedList", "content": {} } }, "parameters": [ { "name": "ArIncentiveFrom", "in": "query", "schema": { "type": "string" } }, { "name": "ARIncentiveTo", "in": "query", "schema": { "type": "string" } } ], "operationId": "RoleUserController.getARShipperApprovedList" } }, "/get/all/arTeam": { "get": { "x-controller-name": "RoleUserController", "x-operation-name": "getARRolesByCondition", "tags": [ "RoleUserController" ], "description": "", "responses": { "200": { "description": "Return value of RoleUserController.getARRolesByCondition", "content": {} } }, "parameters": [ { "name": "ArIncentiveFrom", "in": "query", "schema": { "type": "string" } }, { "name": "ARIncentiveTo", "in": "query", "schema": { "type": "string" } } ], "operationId": "RoleUserController.getARRolesByCondition" } }, "/get/all/asi/APTeam": { "get": { "x-controller-name": "AsiallIncentivesController", "x-operation-name": "getAPRolesByCondition", "tags": [ "AsiallIncentivesController" ], "description": "", "responses": { "200": { "description": "Return value of AsiallIncentivesController.getAPRolesByCondition", "content": {} } }, "parameters": [ { "name": "SmeIncentiveFrom", "in": "query", "schema": { "type": "string" } }, { "name": "SmeIncentiveTo", "in": "query", "schema": { "type": "string" } } ], "operationId": "AsiallIncentivesController.getAPRolesByCondition" } }, "/get/all/asi/arTeam/final/incentives": { "get": { "x-controller-name": "AsiallIncentivesController", "x-operation-name": "getARFinalincentivesData", "tags": [ "AsiallIncentivesController" ], "description": "", "responses": { "200": { "description": "Return value of AsiallIncentivesController.getARFinalincentivesData", "content": {} } }, "parameters": [ { "name": "ArIncentiveFrom", "in": "query", "schema": { "type": "string" } }, { "name": "ARIncentiveTo", "in": "query", "schema": { "type": "string" } } ], "operationId": "AsiallIncentivesController.getARFinalincentivesData" } }, "/get/all/asi/arTeam/shippers/approved": { "get": { "x-controller-name": "AsiallIncentivesController", "x-operation-name": "getARShipperApprovedList", "tags": [ "AsiallIncentivesController" ], "description": "", "responses": { "200": { "description": "Return value of AsiallIncentivesController.getARShipperApprovedList", "content": {} } }, "parameters": [ { "name": "ArIncentiveFrom", "in": "query", "schema": { "type": "string" } }, { "name": "ARIncentiveTo", "in": "query", "schema": { "type": "string" } } ], "operationId": "AsiallIncentivesController.getARShipperApprovedList" } }, "/get/all/asi/arTeam": { "get": { "x-controller-name": "AsiallIncentivesController", "x-operation-name": "getARRolesByCondition", "tags": [ "AsiallIncentivesController" ], "description": "", "responses": { "200": { "description": "Return value of AsiallIncentivesController.getARRolesByCondition", "content": {} } }, "parameters": [ { "name": "ArIncentiveFrom", "in": "query", "schema": { "type": "string" } }, { "name": "ARIncentiveTo", "in": "query", "schema": { "type": "string" } } ], "operationId": "AsiallIncentivesController.getARRolesByCondition" } }, "/get/all/asi/smeTeam/cpr/approved": { "get": { "x-controller-name": "AsiallIncentivesController", "x-operation-name": "getSMECPRByCondition", "tags": [ "AsiallIncentivesController" ], "description": "", "responses": { "200": { "description": "Return value of AsiallIncentivesController.getSMECPRByCondition", "content": {} } }, "parameters": [ { "name": "SmeIncentiveFrom", "in": "query", "schema": { "type": "string" } }, { "name": "SmeIncentiveTo", "in": "query", "schema": { "type": "string" } } ], "operationId": "AsiallIncentivesController.getSMECPRByCondition" } }, "/get/all/asi/smeTeam/final/incentives": { "get": { "x-controller-name": "AsiallIncentivesController", "x-operation-name": "getSMEFinalIncentive", "tags": [ "AsiallIncentivesController" ], "description": "", "responses": { "200": { "description": "Return value of AsiallIncentivesController.getSMEFinalIncentive", "content": {} } }, "parameters": [ { "name": "SmeIncentiveFrom", "in": "query", "schema": { "type": "string" } }, { "name": "SmeIncentiveTo", "in": "query", "schema": { "type": "string" } } ], "operationId": "AsiallIncentivesController.getSMEFinalIncentive" } }, "/get/all/asi/smeTeam": { "get": { "x-controller-name": "AsiallIncentivesController", "x-operation-name": "getSMERolesByCondition", "tags": [ "AsiallIncentivesController" ], "description": "", "responses": { "200": { "description": "Return value of AsiallIncentivesController.getSMERolesByCondition", "content": {} } }, "parameters": [ { "name": "SmeIncentiveFrom", "in": "query", "schema": { "type": "string" } }, { "name": "SmeIncentiveTo", "in": "query", "schema": { "type": "string" } } ], "operationId": "AsiallIncentivesController.getSMERolesByCondition" } }, "/get/all/carriers": { "get": { "x-controller-name": "CarriersUserController", "x-operation-name": "find", "tags": [ "CarriersUserController" ], "responses": { "200": { "description": "Array of Carriers", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Carriers" } } } } } }, "description": "", "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } ], "operationId": "CarriersUserController.find" } }, "/get/all/drayage/managers": { "get": { "x-controller-name": "RoleUserController", "x-operation-name": "getAllDrayageManagers", "tags": [ "RoleUserController" ], "description": "", "responses": { "200": { "description": "Return value of RoleUserController.getAllDrayageManagers", "content": {} } }, "operationId": "RoleUserController.getAllDrayageManagers" } }, "/get/all/factoring": { "get": { "x-controller-name": "CarriersUserController", "x-operation-name": "findFactorings", "tags": [ "CarriersUserController" ], "responses": { "200": { "description": "Array of Carriers", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Carriers" } } } } } }, "description": "", "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } ], "operationId": "CarriersUserController.findFactorings" } }, "/get/all/managers": { "get": { "x-controller-name": "RoleUserController", "x-operation-name": "getAllManagers", "tags": [ "RoleUserController" ], "description": "", "responses": { "200": { "description": "Return value of RoleUserController.getAllManagers", "content": {} } }, "operationId": "RoleUserController.getAllManagers" } }, "/get/all/otr/managers": { "get": { "x-controller-name": "RoleUserController", "x-operation-name": "getAllOTRManagers", "tags": [ "RoleUserController" ], "description": "", "responses": { "200": { "description": "Return value of RoleUserController.getAllOTRManagers", "content": {} } }, "operationId": "RoleUserController.getAllOTRManagers" } }, "/get/all/pro/numbers/by/ap/user/id/asi/APTeam": { "get": { "x-controller-name": "AsiallIncentivesController", "x-operation-name": "getAPRolesByConditionAllProNumbersASIAPTeam", "tags": [ "AsiallIncentivesController" ], "description": "", "responses": { "200": { "description": "Return value of AsiallIncentivesController.getAPRolesByConditionAllProNumbersASIAPTeam", "content": {} } }, "parameters": [ { "name": "APUserID", "in": "query", "schema": { "type": "number" } }, { "name": "SelectedMonth", "in": "query", "schema": { "type": "string" } } ], "operationId": "AsiallIncentivesController.getAPRolesByConditionAllProNumbersASIAPTeam" } }, "/get/all/pro/numbers/by/ap/user/id/pod/asi/APTeam": { "get": { "x-controller-name": "AsiallIncentivesController", "x-operation-name": "getAPRolesByConditionAllProNumbersPODASIAPTeam", "tags": [ "AsiallIncentivesController" ], "description": "", "responses": { "200": { "description": "Return value of AsiallIncentivesController.getAPRolesByConditionAllProNumbersPODASIAPTeam", "content": {} } }, "parameters": [ { "name": "APUserID", "in": "query", "schema": { "type": "number" } }, { "name": "SelectedMonth", "in": "query", "schema": { "type": "string" } } ], "operationId": "AsiallIncentivesController.getAPRolesByConditionAllProNumbersPODASIAPTeam" } }, "/get/all/pro/numbers/by/ap/user/id/pod/value/loads": { "get": { "x-controller-name": "AsiallIncentivesController", "x-operation-name": "getAPRolesByConditionAllProNumbersPODValueLoads", "tags": [ "AsiallIncentivesController" ], "description": "", "responses": { "200": { "description": "Return value of AsiallIncentivesController.getAPRolesByConditionAllProNumbersPODValueLoads", "content": {} } }, "parameters": [ { "name": "APUserID", "in": "query", "schema": { "type": "number" } }, { "name": "SelectedMonth", "in": "query", "schema": { "type": "string" } } ], "operationId": "AsiallIncentivesController.getAPRolesByConditionAllProNumbersPODValueLoads" } }, "/get/all/pro/numbers/by/ap/user/id": { "get": { "x-controller-name": "AsiallIncentivesController", "x-operation-name": "getAPRolesByConditionAllProNumbers", "tags": [ "AsiallIncentivesController" ], "description": "", "responses": { "200": { "description": "Return value of AsiallIncentivesController.getAPRolesByConditionAllProNumbers", "content": {} } }, "parameters": [ { "name": "APUserID", "in": "query", "schema": { "type": "number" } }, { "name": "SelectedMonth", "in": "query", "schema": { "type": "string" } } ], "operationId": "AsiallIncentivesController.getAPRolesByConditionAllProNumbers" } }, "/get/all/smeTeam/cpr/approved": { "get": { "x-controller-name": "RoleUserController", "x-operation-name": "getSMECPRByCondition", "tags": [ "RoleUserController" ], "description": "", "responses": { "200": { "description": "Return value of RoleUserController.getSMECPRByCondition", "content": {} } }, "parameters": [ { "name": "SmeIncentiveFrom", "in": "query", "schema": { "type": "string" } }, { "name": "SmeIncentiveTo", "in": "query", "schema": { "type": "string" } } ], "operationId": "RoleUserController.getSMECPRByCondition" } }, "/get/all/smeTeam/final/incentives": { "get": { "x-controller-name": "RoleUserController", "x-operation-name": "getSMEFinalIncentive", "tags": [ "RoleUserController" ], "description": "", "responses": { "200": { "description": "Return value of RoleUserController.getSMEFinalIncentive", "content": {} } }, "parameters": [ { "name": "SmeIncentiveFrom", "in": "query", "schema": { "type": "string" } }, { "name": "SmeIncentiveTo", "in": "query", "schema": { "type": "string" } } ], "operationId": "RoleUserController.getSMEFinalIncentive" } }, "/get/all/smeTeam": { "get": { "x-controller-name": "RoleUserController", "x-operation-name": "getSMERolesByCondition", "tags": [ "RoleUserController" ], "description": "", "responses": { "200": { "description": "Return value of RoleUserController.getSMERolesByCondition", "content": {} } }, "parameters": [ { "name": "SmeIncentiveFrom", "in": "query", "schema": { "type": "string" } }, { "name": "SmeIncentiveTo", "in": "query", "schema": { "type": "string" } } ], "operationId": "RoleUserController.getSMERolesByCondition" } }, "/get/api/app-settings/{type}/{platform}": { "get": { "x-controller-name": "AppSettingsController", "x-operation-name": "getAppSettings", "tags": [ "AppSettingsController" ], "description": "", "responses": { "200": { "description": "Return value of AppSettingsController.getAppSettings", "content": {} } }, "parameters": [ { "name": "type", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "platform", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "AppSettingsController.getAppSettings" } }, "/get/cacci/details/ByDOTNumber/{intB}": { "get": { "x-controller-name": "TruckstopsCacciController", "x-operation-name": "getCaccieByDOTNumber", "tags": [ "TruckstopsCacciController" ], "responses": { "200": { "description": "Return value of TruckstopsCacciController.getCaccieByDOTNumber" } }, "parameters": [ { "name": "intB", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "TruckstopsCacciController.getCaccieByDOTNumber" } }, "/get/cacci/details/ByName/{intB}": { "get": { "x-controller-name": "TruckstopsCacciController", "x-operation-name": "getCaccieByName", "tags": [ "TruckstopsCacciController" ], "responses": { "200": { "description": "Return value of TruckstopsCacciController.getCaccieByName" } }, "parameters": [ { "name": "intB", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "TruckstopsCacciController.getCaccieByName" } }, "/get/cacci/details/ByPhoneNumber/{intB}": { "get": { "x-controller-name": "TruckstopsCacciController", "x-operation-name": "getCaccieByPhoneNumber", "tags": [ "TruckstopsCacciController" ], "responses": { "200": { "description": "Return value of TruckstopsCacciController.getCaccieByPhoneNumber" } }, "parameters": [ { "name": "intB", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "TruckstopsCacciController.getCaccieByPhoneNumber" } }, "/get/cacci/details/mc/update/cdl": { "get": { "x-controller-name": "TruckstopsCacciController", "x-operation-name": "getUpdateCdl", "tags": [ "TruckstopsCacciController" ], "responses": { "200": { "description": "Return value of TruckstopsCacciController.getUpdateCdl" } }, "operationId": "TruckstopsCacciController.getUpdateCdl" } }, "/get/cacci/details/mc/update/insourance": { "get": { "x-controller-name": "TruckstopsCacciController", "x-operation-name": "getUpdateInsurance", "tags": [ "TruckstopsCacciController" ], "responses": { "200": { "description": "Return value of TruckstopsCacciController.getUpdateInsurance" } }, "operationId": "TruckstopsCacciController.getUpdateInsurance" } }, "/get/cacci/details/mc/{intB}": { "get": { "x-controller-name": "TruckstopsCacciController", "x-operation-name": "get", "tags": [ "TruckstopsCacciController" ], "responses": { "200": { "description": "Return value of TruckstopsCacciController.get" } }, "parameters": [ { "name": "intB", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "TruckstopsCacciController.get" } }, "/get/dat/onboarding/carrier/signed-list": { "get": { "x-controller-name": "DatratemateController", "x-operation-name": "getSignedList", "tags": [ "DatratemateController" ], "responses": { "200": { "description": "Return value of DatratemateController.getSignedList" } }, "operationId": "DatratemateController.getSignedList" } }, "/get/dat/onboarding/carrier/single": { "get": { "x-controller-name": "DatratemateController", "x-operation-name": "getDATonboardingCarrierSingle", "tags": [ "DatratemateController" ], "responses": { "200": { "description": "Return value of DatratemateController.getDATonboardingCarrierSingle" } }, "operationId": "DatratemateController.getDATonboardingCarrierSingle" } }, "/get/dat/onboarding/carrier/sync-signed-dates-asi": { "get": { "x-controller-name": "DatratemateController", "x-operation-name": "syncSignedDatesToDbASI", "tags": [ "DatratemateController" ], "responses": { "200": { "description": "Return value of DatratemateController.syncSignedDatesToDbASI" } }, "operationId": "DatratemateController.syncSignedDatesToDbASI" } }, "/get/dat/onboarding/carrier/sync-signed-dates-vl": { "get": { "x-controller-name": "DatratemateController", "x-operation-name": "syncSignedDatesToDb", "tags": [ "DatratemateController" ], "responses": { "200": { "description": "Return value of DatratemateController.syncSignedDatesToDb" } }, "operationId": "DatratemateController.syncSignedDatesToDb" } }, "/get/dat/onboarding/carriers/ByMcNumber": { "get": { "x-controller-name": "DatratemateController", "x-operation-name": "getDATonboardingCarriersByMC", "tags": [ "DatratemateController" ], "description": "", "responses": { "200": { "description": "Return value of DatratemateController.getDATonboardingCarriersByMC", "content": {} } }, "operationId": "DatratemateController.getDATonboardingCarriersByMC" } }, "/get/dat/onboarding/carriers/signedList11111": { "get": { "x-controller-name": "DatratemateController", "x-operation-name": "getDATonboardingCarriersSignedList", "tags": [ "DatratemateController" ], "description": "", "responses": { "200": { "description": "Return value of DatratemateController.getDATonboardingCarriersSignedList", "content": {} } }, "operationId": "DatratemateController.getDATonboardingCarriersSignedList" } }, "/get/dat/onboarding/carriers/updateMCDOT": { "get": { "x-controller-name": "DatratemateController", "x-operation-name": "getDATonboardingCarriersUpdateMcDot", "tags": [ "DatratemateController" ], "description": "", "responses": { "200": { "description": "Return value of DatratemateController.getDATonboardingCarriersUpdateMcDot", "content": {} } }, "operationId": "DatratemateController.getDATonboardingCarriersUpdateMcDot" } }, "/get/dat/onboarding/carriers/updateMCDOTDB": { "get": { "x-controller-name": "DatratemateController", "x-operation-name": "getDATonboardingCarriersUpdateMcDotDB", "tags": [ "DatratemateController" ], "description": "", "responses": { "200": { "description": "Return value of DatratemateController.getDATonboardingCarriersUpdateMcDotDB", "content": {} } }, "operationId": "DatratemateController.getDATonboardingCarriersUpdateMcDotDB" } }, "/get/dat/onboarding/carriers/updateMCDOTDB1": { "get": { "x-controller-name": "DatratemateController", "x-operation-name": "getDATonboardingCarriersUpdateMcDotDB1", "tags": [ "DatratemateController" ], "description": "", "responses": { "200": { "description": "Return value of DatratemateController.getDATonboardingCarriersUpdateMcDotDB1", "content": {} } }, "operationId": "DatratemateController.getDATonboardingCarriersUpdateMcDotDB1" } }, "/get/dat/onboarding/carriers/updateMCDOTDBASI": { "get": { "x-controller-name": "DatratemateController", "x-operation-name": "getDATonboardingCarriersUpdateMcDotDBASI", "tags": [ "DatratemateController" ], "description": "", "responses": { "200": { "description": "Return value of DatratemateController.getDATonboardingCarriersUpdateMcDotDBASI", "content": {} } }, "operationId": "DatratemateController.getDATonboardingCarriersUpdateMcDotDBASI" } }, "/get/dat/onboarding/carriers": { "get": { "x-controller-name": "DatratemateController", "x-operation-name": "getDATonboardingCarriers", "tags": [ "DatratemateController" ], "description": "", "responses": { "200": { "description": "Return value of DatratemateController.getDATonboardingCarriers", "content": {} } }, "operationId": "DatratemateController.getDATonboardingCarriers" } }, "/get/dat/onboarding/carriers-db-ASI": { "get": { "x-controller-name": "DatratemateController", "x-operation-name": "getDATonboardingCarriersDBASI", "tags": [ "DatratemateController" ], "description": "", "responses": { "200": { "description": "Return value of DatratemateController.getDATonboardingCarriersDBASI", "content": {} } }, "operationId": "DatratemateController.getDATonboardingCarriersDBASI" } }, "/get/dat/onboarding/carriers-db-vl": { "get": { "x-controller-name": "DatratemateController", "x-operation-name": "getDATonboardingCarriersDB", "tags": [ "DatratemateController" ], "description": "", "responses": { "200": { "description": "Return value of DatratemateController.getDATonboardingCarriersDB", "content": {} } }, "operationId": "DatratemateController.getDATonboardingCarriersDB" } }, "/get/old/loads/deleted": { "get": { "x-controller-name": "LoadsController", "x-operation-name": "GetOldLoadsDeleted", "tags": [ "LoadsController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker all loads list |\n", "responses": { "200": { "description": "Array of Loads model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LoadsWithRelations" } } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Loads.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "LoadsController.GetOldLoadsDeleted" } }, "/get/today/mc/approved/count": { "get": { "x-controller-name": "LoadsController", "x-operation-name": "GetTodayMCApprovedCount", "tags": [ "LoadsController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker view allNotifications |\n", "responses": { "200": { "description": "Array of Loads model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LoadsWithRelations" } } } } } }, "operationId": "LoadsController.GetTodayMCApprovedCount" } }, "/get-active-brokers-count": { "get": { "x-controller-name": "PerformanceReportController", "x-operation-name": "getActiveBrokersCount", "tags": [ "PerformanceReportController" ], "description": "", "responses": { "200": { "description": "Return value of PerformanceReportController.getActiveBrokersCount", "content": {} } }, "operationId": "PerformanceReportController.getActiveBrokersCount" } }, "/get-active-brokers-ogt-count": { "get": { "x-controller-name": "PerformanceReportController", "x-operation-name": "getActiveBrokersogtCount", "tags": [ "PerformanceReportController" ], "description": "", "responses": { "200": { "description": "Return value of PerformanceReportController.getActiveBrokersogtCount", "content": {} } }, "operationId": "PerformanceReportController.getActiveBrokersogtCount" } }, "/get-add-payment-details-logs": { "get": { "x-controller-name": "ApSendStatementController", "x-operation-name": "getPaymentApLogs", "tags": [ "ApSendStatementController" ], "description": "", "responses": { "200": { "description": "Array of apSendPaymentRepository model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ApSendPaymentWithRelations" } } } } } }, "parameters": [ { "name": "page", "in": "query", "schema": { "type": "number" } }, { "name": "pageSize", "in": "query", "schema": { "type": "number" } } ], "operationId": "ApSendStatementController.getPaymentApLogs" } }, "/get-aging-claim-detail/{shippersId}/{claimId}": { "get": { "x-controller-name": "ArShipperClaimController", "x-operation-name": "getAgingClaimDetail", "tags": [ "ArShipperClaimController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar view shipper aging |\n", "responses": { "200": { "description": "Claim List", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Shippers" } } } } }, "parameters": [ { "name": "shippersId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "claimId", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "ArShipperClaimController.getAgingClaimDetail" } }, "/get-ai-commodity-doc/{shipmentId}": { "get": { "x-controller-name": "PdfReadController", "x-operation-name": "getAiCommodityDoc", "tags": [ "PdfReadController" ], "responses": { "200": { "description": "Return value of PdfReadController.getAiCommodityDoc" } }, "parameters": [ { "name": "shipmentId", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "PdfReadController.getAiCommodityDoc" } }, "/get-all-ar-list": { "get": { "x-controller-name": "ArShippersController", "x-operation-name": "getAllAr", "tags": [ "ArShippersController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar view shipper |\n", "responses": { "200": { "description": "Array of Shippers model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ShippersWithRelations" } } } } } }, "operationId": "ArShippersController.getAllAr" } }, "/get-all-attrite-users": { "get": { "x-controller-name": "ReportsController", "x-operation-name": "getAllAttriteUsers", "tags": [ "ReportsController" ], "description": "\n\n| Permissions |\n| ------- |\n| view portal reports |\n", "responses": { "200": { "description": "Get all attrite users", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserWithRelations" } } } } }, "operationId": "ReportsController.getAllAttriteUsers" } }, "/get-all-attrite-users-manager": { "get": { "x-controller-name": "AnalyticsPerformanceReportController", "x-operation-name": "getAllAttriteUsers", "tags": [ "AnalyticsPerformanceReportController" ], "description": "", "responses": { "200": { "description": "Get all attrite users", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserWithRelations" } } } } }, "operationId": "AnalyticsPerformanceReportController.getAllAttriteUsers" } }, "/get-all-audit-auditverifycpr-comments/{shipmentId}": { "get": { "x-controller-name": "AuditorController", "x-operation-name": "getAllAuditCprComments", "tags": [ "AuditorController" ], "description": "", "responses": { "200": { "description": "Get all audit auditverifycpr comments", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserWithRelations" } } } } }, "parameters": [ { "name": "shipmentId", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "AuditorController.getAllAuditCprComments" } }, "/get-all-audit-carrieraging-comments/{shipmentId}": { "get": { "x-controller-name": "AuditorController", "x-operation-name": "getAllAuditCarrieragingComments", "tags": [ "AuditorController" ], "description": "", "responses": { "200": { "description": "Get all audit carrieraging comments", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserWithRelations" } } } } }, "parameters": [ { "name": "shipmentId", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "AuditorController.getAllAuditCarrieragingComments" } }, "/get-all-audit-commodity-comments/{shipmentId}": { "get": { "x-controller-name": "AuditorController", "x-operation-name": "getAllAuditCommodityComments", "tags": [ "AuditorController" ], "description": "", "responses": { "200": { "description": "Get all audit commodity comments", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserWithRelations" } } } } }, "parameters": [ { "name": "shipmentId", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "AuditorController.getAllAuditCommodityComments" } }, "/get-all-audit-verifyvin-comments/{shipmentId}/{type}": { "get": { "x-controller-name": "AuditorController", "x-operation-name": "getAllAuditVinComments", "tags": [ "AuditorController" ], "description": "", "responses": { "200": { "description": "Get all audit verifyvin comments", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserWithRelations" } } } } }, "parameters": [ { "name": "shipmentId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "type", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "AuditorController.getAllAuditVinComments" } }, "/get-all-cpr-list": { "get": { "x-controller-name": "SmeReportControllerController", "x-operation-name": "GetAllfind", "tags": [ "SmeReportControllerController" ], "description": "\n\n| Permissions |\n| ------- |\n| sme view dashboard |\n| sme view cpr list |\n", "responses": { "200": { "description": "Array of CprRequest model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CprRequestWithRelations" } } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "CprRequest.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } }, { "name": "shipmentId", "in": "query", "schema": { "type": "string" } }, { "name": "mc", "in": "query", "schema": { "type": "string" } }, { "name": "dot", "in": "query", "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "number" } }, { "name": "pageSize", "in": "query", "schema": { "type": "number" } }, { "name": "DateTo", "in": "query", "schema": { "type": "string" } }, { "name": "DateFrom", "in": "query", "schema": { "type": "string" } }, { "name": "userId", "in": "query", "schema": { "type": "string" } }, { "name": "ApprovedTime", "in": "query", "schema": { "type": "string" } } ], "operationId": "SmeReportControllerController.GetAllfind" } }, "/get-all-mc-list": { "get": { "x-controller-name": "SmeReportControllerController", "x-operation-name": "GetAllMCListfind", "tags": [ "SmeReportControllerController" ], "description": "\n\n| Permissions |\n| ------- |\n| sme view dashboard |\n| sme view mc list |\n", "responses": { "200": { "description": "Array of McVerification model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/McVerificationWithRelations" } } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "McVerification.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } }, { "name": "mcNumber", "in": "query", "schema": { "type": "string" } }, { "name": "dotNumber", "in": "query", "schema": { "type": "string" } }, { "name": "status", "in": "query", "schema": { "type": "string" } }, { "name": "ApprovedTime", "in": "query", "schema": { "type": "string" } }, { "name": "ExceptionType", "in": "query", "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "number" } }, { "name": "pageSize", "in": "query", "schema": { "type": "number" } }, { "name": "DateTo", "in": "query", "schema": { "type": "string" } }, { "name": "DateFrom", "in": "query", "schema": { "type": "string" } }, { "name": "userId", "in": "query", "schema": { "type": "string" } } ], "operationId": "SmeReportControllerController.GetAllMCListfind" } }, "/get-all-other-lob-users": { "get": { "x-controller-name": "ReportsController", "x-operation-name": "getAllOtherLobUsers", "tags": [ "ReportsController" ], "description": "\n\n| Permissions |\n| ------- |\n| view portal reports |\n", "responses": { "200": { "description": "Get all performance comments", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserWithRelations" } } } } }, "operationId": "ReportsController.getAllOtherLobUsers" } }, "/get-all-other-lob-users-manager": { "get": { "x-controller-name": "AnalyticsPerformanceReportController", "x-operation-name": "getAllOtherLobUsers", "tags": [ "AnalyticsPerformanceReportController" ], "description": "", "responses": { "200": { "description": "Get all performance comments", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserWithRelations" } } } } }, "operationId": "AnalyticsPerformanceReportController.getAllOtherLobUsers" } }, "/get-all-performance-comment": { "get": { "x-controller-name": "ReportsController", "x-operation-name": "getAllPerformancecomment", "tags": [ "ReportsController" ], "description": "\n\n| Permissions |\n| ------- |\n| view portal reports |\n", "responses": { "200": { "description": "Get all performance comments", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserWithRelations" } } } } }, "operationId": "ReportsController.getAllPerformancecomment" } }, "/get-all-performance-comment-manager": { "get": { "x-controller-name": "AnalyticsPerformanceReportController", "x-operation-name": "getAllPerformancecomment", "tags": [ "AnalyticsPerformanceReportController" ], "description": "", "responses": { "200": { "description": "Get all performance comments", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserWithRelations" } } } } }, "operationId": "AnalyticsPerformanceReportController.getAllPerformancecomment" } }, "/get-all-performance-comment-userId-wise/{id}": { "get": { "x-controller-name": "ReportsController", "x-operation-name": "getAllPerformancecommentUserIdWise", "tags": [ "ReportsController" ], "description": "\n\n| Permissions |\n| ------- |\n| view portal reports |\n", "responses": { "200": { "description": "Get all performance comments", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "ReportsController.getAllPerformancecommentUserIdWise" } }, "/get-all-shipper": { "get": { "x-controller-name": "ArshipperLimitController", "x-operation-name": "get_all_shipper_by_portal_find", "tags": [ "ArshipperLimitController" ], "responses": { "200": { "description": "Array of User has many Shippers", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Shippers" } } } } } }, "description": "\n\n| Permissions |\n| ------- |\n| ar view shipper limit |\n", "operationId": "ArshipperLimitController.get_all_shipper_by_portal_find" } }, "/get-all-shippers-assign-list": { "get": { "x-controller-name": "ArShippersController", "x-operation-name": "GetAllShippersAllocateList", "tags": [ "ArShippersController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar view shipper |\n", "responses": { "200": { "description": "Array of Shippers model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ShippersWithRelations" } } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Shippers.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } }, { "name": "page", "in": "query", "schema": { "type": "number" } }, { "name": "pageSize", "in": "query", "schema": { "type": "number" } }, { "name": "userId", "in": "query", "schema": { "type": "string" } }, { "name": "apId", "in": "query", "schema": { "type": "string" } }, { "name": "shippersId", "in": "query", "schema": { "type": "string" } } ], "operationId": "ArShippersController.GetAllShippersAllocateList" } }, "/get-all-shippers-list": { "get": { "x-controller-name": "ArShippersController", "x-operation-name": "GetAllfindList", "tags": [ "ArShippersController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar view shipper |\n", "responses": { "200": { "description": "Array of Shippers model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ShippersWithRelations" } } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Shippers.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } }, { "name": "page", "in": "query", "schema": { "type": "number" } }, { "name": "pageSize", "in": "query", "schema": { "type": "number" } }, { "name": "userId", "in": "query", "schema": { "type": "string" } }, { "name": "CreditApp", "in": "query", "schema": { "type": "string" } }, { "name": "apId", "in": "query", "schema": { "type": "string" } }, { "name": "shippersId", "in": "query", "schema": { "type": "string" } } ], "operationId": "ArShippersController.GetAllfindList" } }, "/get-all-sme-mc-and-cpr": { "get": { "x-controller-name": "SmeReportControllerController", "x-operation-name": "GetSmeMcAndCpr", "tags": [ "SmeReportControllerController" ], "description": "\n\n| Permissions |\n| ------- |\n| sme view dashboard |\n| sme view cpr list |\n", "responses": { "200": { "description": "SME users with MC and CPR count", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } } } } } }, "parameters": [ { "name": "DateTo", "in": "query", "schema": { "type": "string" } }, { "name": "DateFrom", "in": "query", "schema": { "type": "string" } } ], "operationId": "SmeReportControllerController.GetSmeMcAndCpr" } }, "/get-all-sme-user-list": { "get": { "x-controller-name": "SmeReportControllerController", "x-operation-name": "GetSmeUserList", "tags": [ "SmeReportControllerController" ], "description": "\n\n| Permissions |\n| ------- |\n| sme view dashboard |\n| sme view cpr list |\n", "responses": { "200": { "description": "Shipment model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserWithRelations" } } } } }, "operationId": "SmeReportControllerController.GetSmeUserList" } }, "/get-all-ssl-payment": { "get": { "x-controller-name": "ShipmentController", "x-operation-name": "getAllSslPayment", "tags": [ "ShipmentController" ], "responses": { "200": { "description": "Return value of ShipmentController.getAllSslPayment" } }, "operationId": "ShipmentController.getAllSslPayment" } }, "/get-alliance-records-excels": { "get": { "x-controller-name": "EmailMarketingController", "x-operation-name": "getAllianceRecordsExcels", "tags": [ "EmailMarketingController" ], "responses": { "200": { "description": "Distinct Alliance excel uploads with created date", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "array", "items": { "type": "object", "properties": { "excel_url": { "type": "string" }, "created": { "type": "string" }, "total_rows": { "type": "number" } } } } } } } } } }, "operationId": "EmailMarketingController.getAllianceRecordsExcels" } }, "/get-ap-user": { "get": { "x-controller-name": "RoleUserController", "x-operation-name": "getApuser", "tags": [ "RoleUserController" ], "description": "", "responses": { "200": { "description": "Return value of RoleUserController.getApuser", "content": {} } }, "operationId": "RoleUserController.getApuser" } }, "/get-ar-churn-customer-list": { "post": { "x-controller-name": "ChurnCustomerController", "x-operation-name": "getArChurnCustomerData", "tags": [ "ChurnCustomerController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker view churn report |\n", "responses": { "200": { "description": "Return value of ChurnCustomerController.getArChurnCustomerData", "content": {} } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "ChurnCustomerController.getArChurnCustomerData" } }, "/get-ar-churn-customer-logs": { "get": { "x-controller-name": "ChurnCustomerController", "x-operation-name": "getArChurnCustomerLogs", "tags": [ "ChurnCustomerController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker view churn report |\n", "responses": { "200": { "description": "Return value of ChurnCustomerController.getArChurnCustomerLogs", "content": {} } }, "parameters": [ { "name": "pageSize", "in": "query", "schema": { "type": "number" } }, { "name": "page", "in": "query", "schema": { "type": "number" } } ], "operationId": "ChurnCustomerController.getArChurnCustomerLogs" } }, "/get-ar-churn-customer-logs-list": { "get": { "x-controller-name": "ChurnCustomerController", "x-operation-name": "getArChurnCustomerLogsList", "tags": [ "ChurnCustomerController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker view churn report |\n", "responses": { "200": { "description": "Return value of ChurnCustomerController.getArChurnCustomerLogsList", "content": {} } }, "parameters": [ { "name": "pageSize", "in": "query", "schema": { "type": "number" } }, { "name": "page", "in": "query", "schema": { "type": "number" } } ], "operationId": "ChurnCustomerController.getArChurnCustomerLogsList" } }, "/get-ar-churn-followup-list": { "get": { "x-controller-name": "ChurnCustomerController", "x-operation-name": "getArChurnFollowupList", "tags": [ "ChurnCustomerController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker view churn report |\n", "responses": { "200": { "description": "Return value of ChurnCustomerController.getArChurnFollowupList", "content": {} } }, "parameters": [ { "name": "shipperId", "in": "query", "schema": { "type": "number" } } ], "operationId": "ChurnCustomerController.getArChurnFollowupList" } }, "/get-ar-cpr-requests-list": { "get": { "x-controller-name": "ArCprInvoiceRequestController", "x-operation-name": "GetArCprRequests", "tags": [ "ArCprInvoiceRequestController" ], "responses": { "200": { "description": "Array of CprRequest model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CprRequestWithRelations" } } } } } }, "description": "\n\n| Permissions |\n| ------- |\n| broker view cprInvoiceRequest |\n", "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "CprRequest.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "ArCprInvoiceRequestController.GetArCprRequests" } }, "/get-ar-customer-detail": { "get": { "x-controller-name": "ChurnCustomerController", "x-operation-name": "churnArCustomerDetails", "tags": [ "ChurnCustomerController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker view churn report |\n", "responses": { "200": { "description": "Return value of ChurnCustomerController.churnArCustomerDetails", "content": {} } }, "parameters": [ { "name": "month", "in": "query", "schema": { "type": "string" } }, { "name": "year", "in": "query", "schema": { "type": "number" } }, { "name": "limit", "in": "query", "schema": { "type": "number" } }, { "name": "offset", "in": "query", "schema": { "type": "number" } }, { "name": "DateFrom", "in": "query", "schema": { "type": "string" } }, { "name": "DateTo", "in": "query", "schema": { "type": "string" } } ], "operationId": "ChurnCustomerController.churnArCustomerDetails" } }, "/get-ar-customer-detail-new": { "get": { "x-controller-name": "ChurnCustomerController", "x-operation-name": "churnArCustomerDetailsNew", "tags": [ "ChurnCustomerController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker view churn report |\n", "responses": { "200": { "description": "Return value of ChurnCustomerController.churnArCustomerDetailsNew", "content": {} } }, "parameters": [ { "name": "month", "in": "query", "schema": { "type": "string" } }, { "name": "year", "in": "query", "schema": { "type": "number" } }, { "name": "limit", "in": "query", "schema": { "type": "number" } }, { "name": "offset", "in": "query", "schema": { "type": "number" } }, { "name": "DateFrom", "in": "query", "schema": { "type": "string" } }, { "name": "DateTo", "in": "query", "schema": { "type": "string" } } ], "operationId": "ChurnCustomerController.churnArCustomerDetailsNew" } }, "/get-ar-invoice-requests": { "get": { "x-controller-name": "ArCprInvoiceRequestController", "x-operation-name": "GetArInvoiceRequests", "tags": [ "ArCprInvoiceRequestController" ], "responses": { "200": { "description": "Array of CprRequest model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ShipmentWithRelations" } } } } } }, "description": "\n\n| Permissions |\n| ------- |\n| broker view cprInvoiceRequest |\n", "operationId": "ArCprInvoiceRequestController.GetArInvoiceRequests" } }, "/get-ar-invoices-list": { "get": { "x-controller-name": "ArPayReceivedController", "x-operation-name": "find", "tags": [ "ArPayReceivedController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar view pay received |\n", "responses": { "200": { "description": "Array of Invoices model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InvoicesWithRelations" } } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Invoices.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } }, { "name": "page", "in": "query", "schema": { "type": "number" } }, { "name": "pageSize", "in": "query", "schema": { "type": "number" } }, { "name": "InvoiceNo", "in": "query", "schema": { "type": "string" } }, { "name": "ProNo", "in": "query", "schema": { "type": "string" } }, { "name": "DateFrom", "in": "query", "schema": { "type": "string" } }, { "name": "DateTo", "in": "query", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "schema": { "type": "string" } } ], "operationId": "ArPayReceivedController.find" } }, "/get-ar-shipment-list": { "get": { "x-controller-name": "ArInvoiceCommunicationTypeController", "x-operation-name": "GetArShipmentListForInvoicing", "tags": [ "ArInvoiceCommunicationTypeController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar view shipment |\n", "responses": { "200": { "description": "Shipment model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipmentWithRelations" } } } } }, "parameters": [ { "name": "shipmentId", "in": "query", "schema": { "type": "string" } }, { "name": "shippersId", "in": "query", "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "number" } }, { "name": "limit", "in": "query", "schema": { "type": "number" } } ], "operationId": "ArInvoiceCommunicationTypeController.GetArShipmentListForInvoicing" } }, "/get-ar-shippers-aging-list": { "get": { "x-controller-name": "ArShipperAgingController", "x-operation-name": "find", "tags": [ "ArShipperAgingController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar view shipper aging |\n", "responses": { "200": { "description": "Array of Invoices model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InvoicesWithRelations" } } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Invoices.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } }, { "name": "assignStatus", "in": "query", "schema": { "type": "string" } }, { "name": "shippersId", "in": "query", "schema": { "type": "string" } }, { "name": "age", "in": "query", "schema": { "type": "string" } }, { "name": "type", "in": "query", "schema": { "type": "string" } }, { "name": "moveTo", "in": "query", "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "number" } }, { "name": "pageSize", "in": "query", "schema": { "type": "number" } }, { "name": "sort", "in": "query", "schema": { "type": "string" } }, { "name": "all", "in": "query", "schema": { "type": "string" } }, { "name": "selectedAr", "in": "query", "schema": { "type": "number" } } ], "operationId": "ArShipperAgingController.find" } }, "/get-ar-shippers-limit-list": { "get": { "x-controller-name": "ArshipperLimitController", "x-operation-name": "find", "tags": [ "ArshipperLimitController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar view shipper limit |\n", "responses": { "200": { "description": "Array of Shippers limit model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ShipperLimitsWithRelations" } } } } } }, "operationId": "ArshipperLimitController.find" } }, "/get-azure-gallery": { "get": { "x-controller-name": "CommonfileuploadController", "x-operation-name": "getAzureGallery", "tags": [ "CommonfileuploadController" ], "description": "", "responses": { "200": { "description": "Return value of CommonfileuploadController.getAzureGallery", "content": {} } }, "operationId": "CommonfileuploadController.getAzureGallery" } }, "/get-bad-debts-list-all": { "get": { "x-controller-name": "ArBadDebtsHistoryController", "x-operation-name": "findAllBadDebts", "tags": [ "ArBadDebtsHistoryController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar view write off payments |\n", "responses": { "200": { "description": "Array of write off payment model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InvoicesWithRelations" } } } } } }, "parameters": [ { "name": "InvoiceId", "in": "query", "schema": { "type": "string" } }, { "name": "ProNo", "in": "query", "schema": { "type": "string" } }, { "name": "shippersId", "in": "query", "schema": { "type": "string" } } ], "operationId": "ArBadDebtsHistoryController.findAllBadDebts" } }, "/get-bankruptcyshipper-list-by-company": { "get": { "x-controller-name": "ArShippersController", "x-operation-name": "find_bankruptcyshipper_list_by_company", "tags": [ "ArShippersController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar view dashboard |\n", "responses": { "200": { "description": "Array of Shippers who are marked as bankrupt", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ShippersWithRelations" } } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Shippers.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } }, { "name": "name", "in": "query", "schema": { "type": "string" } } ], "operationId": "ArShippersController.find_bankruptcyshipper_list_by_company" } }, "/get-broker-aging-report-by-shipperId": { "get": { "x-controller-name": "BrokerShipperAgingController", "x-operation-name": "AllShippmentfind", "tags": [ "BrokerShipperAgingController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker view shipper aging |\n", "responses": { "200": { "description": "Array of Shipment model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ShipmentWithRelations" } } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Shipment.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } }, { "name": "id", "in": "query", "schema": { "type": "string" } }, { "name": "InvoiceNo", "in": "query", "schema": { "type": "string" } }, { "name": "DaysFrom", "in": "query", "schema": { "type": "string" } }, { "name": "DaysTo", "in": "query", "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "number" } }, { "name": "pageSize", "in": "query", "schema": { "type": "number" } } ], "operationId": "BrokerShipperAgingController.AllShippmentfind" } }, "/get-broker-aging-report-list": { "get": { "x-controller-name": "BrokerShipperAgingController", "x-operation-name": "find", "tags": [ "BrokerShipperAgingController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker view shipper aging |\n", "responses": { "200": { "description": "Array of Invoices model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InvoicesWithRelations" } } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Invoices.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } }, { "name": "shippersId", "in": "query", "schema": { "type": "string" } }, { "name": "InvoiceNo", "in": "query", "schema": { "type": "string" } }, { "name": "DaysFrom", "in": "query", "schema": { "type": "string" } }, { "name": "DaysTo", "in": "query", "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "number" } }, { "name": "pageSize", "in": "query", "schema": { "type": "number" } } ], "operationId": "BrokerShipperAgingController.find" } }, "/get-bulk-email-list-seo": { "get": { "x-controller-name": "EmailMarketingController", "x-operation-name": "getBulkEmailListSeo", "tags": [ "EmailMarketingController" ], "description": "", "responses": { "200": { "description": "Return value of EmailMarketingController.getBulkEmailListSeo", "content": {} } }, "parameters": [ { "name": "subject", "in": "query", "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "number" } }, { "name": "pageSize", "in": "query", "schema": { "type": "number" } }, { "name": "sort", "in": "query", "schema": { "type": "string" } }, { "name": "direction", "in": "query", "schema": { "type": "string" } }, { "name": "event", "in": "query", "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "schema": { "type": "string" } } ], "operationId": "EmailMarketingController.getBulkEmailListSeo" } }, "/get-carrier-aging-list-by-auditor": { "get": { "x-controller-name": "AuditorController", "x-operation-name": "find", "tags": [ "AuditorController" ], "description": "\n\n| Permissions |\n| ------- |\n| auditor carrier aging view |\n", "responses": { "200": { "description": "Array of Carrier Aging model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CarrierAgingWithRelations" } } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "CarrierAging.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } }, { "name": "page", "in": "query", "schema": { "type": "number" } }, { "name": "pageSize", "in": "query", "schema": { "type": "number" } }, { "name": "auditStatus", "in": "query", "schema": { "type": "string" } }, { "name": "portalId", "in": "query", "schema": { "type": "string" } }, { "name": "shipmentId", "in": "query", "schema": { "type": "string" } } ], "operationId": "AuditorController.find" } }, "/get-carrier-agings-list": { "get": { "x-controller-name": "CarrierAgingController", "x-operation-name": "findBy", "tags": [ "CarrierAgingController" ], "description": "\n\n| Permissions |\n| ------- |\n| ap carrier aging |\n", "responses": { "200": { "description": "Array of CarrierAging model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CarrierAgingWithRelations" } } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "CarrierAging.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } }, { "name": "page", "in": "query", "schema": { "type": "number" } }, { "name": "pageSize", "in": "query", "schema": { "type": "number" } }, { "name": "RequestStatus", "in": "query", "schema": { "type": "string" } }, { "name": "AdvancedStatus", "in": "query", "schema": { "type": "string" } }, { "name": "shipmentId", "in": "query", "schema": { "type": "string" } }, { "name": "carriersId", "in": "query", "schema": { "type": "string" } }, { "name": "factoringId", "in": "query", "schema": { "type": "string" } }, { "name": "payToMethod", "in": "query", "schema": { "type": "string" } }, { "name": "userId", "in": "query", "schema": { "type": "string" } } ], "operationId": "CarrierAgingController.findBy" } }, "/get-carrier-details/{id}": { "get": { "x-controller-name": "CarrierAgingController", "x-operation-name": "GetCarrierDetail", "tags": [ "CarrierAgingController" ], "responses": { "200": { "description": "Array of CarrierAging model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CarrierAgingWithRelations" } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "CarrierAgingController.GetCarrierDetail" } }, "/get-carrier-invoices": { "get": { "x-controller-name": "ArShipmentsController", "x-operation-name": "getCarrierInvoicesList", "tags": [ "ArShipmentsController" ], "description": "", "responses": { "200": { "description": "Carrier invoices list", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipmentWithRelations" } } } } }, "parameters": [ { "name": "page", "in": "query", "schema": { "type": "number" } }, { "name": "pageSize", "in": "query", "schema": { "type": "number" } }, { "name": "proNumber", "in": "query", "schema": { "type": "string" } }, { "name": "brokerCarrierSearch", "in": "query", "schema": { "type": "string" } }, { "name": "dateFrom", "in": "query", "schema": { "type": "string" } }, { "name": "dateTo", "in": "query", "schema": { "type": "string" } } ], "operationId": "ArShipmentsController.getCarrierInvoicesList" } }, "/get-carrier-list-for-ap-statement": { "get": { "x-controller-name": "ApSendStatementController", "x-operation-name": "getRemittanceListCarrier", "tags": [ "ApSendStatementController" ], "description": "", "responses": { "200": { "description": "Array of Shipment model instances based on portal", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ShipmentWithRelations" } } } } } }, "operationId": "ApSendStatementController.getRemittanceListCarrier" } }, "/get-carrier-payment-details/{id}": { "get": { "x-controller-name": "CarrierAgingController", "x-operation-name": "GetCarrierPaymentDetail", "tags": [ "CarrierAgingController" ], "responses": { "200": { "description": "Array of CarrierPayment model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CarrierPaymentWithRelations" } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "CarrierAgingController.GetCarrierPaymentDetail" } }, "/get-change-status-list": { "get": { "x-controller-name": "ArShipmentsController", "x-operation-name": "getChangeStatusList", "tags": [ "ArShipmentsController" ], "description": "", "responses": { "200": { "description": "Change status list", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipmentWithRelations" } } } } }, "parameters": [ { "name": "page", "in": "query", "schema": { "type": "number" } }, { "name": "pageSize", "in": "query", "schema": { "type": "number" } }, { "name": "proNumber", "in": "query", "schema": { "type": "string" } }, { "name": "broker", "in": "query", "schema": { "type": "string" } }, { "name": "status", "in": "query", "schema": { "type": "string" } }, { "name": "dateFrom", "in": "query", "schema": { "type": "string" } }, { "name": "dateTo", "in": "query", "schema": { "type": "string" } } ], "operationId": "ArShipmentsController.getChangeStatusList" } }, "/get-churn-customer-list": { "post": { "x-controller-name": "ChurnCustomerController", "x-operation-name": "getChurnCustomerData", "tags": [ "ChurnCustomerController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker view churn report |\n", "responses": { "200": { "description": "Return value of ChurnCustomerController.getChurnCustomerData", "content": {} } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "ChurnCustomerController.getChurnCustomerData" } }, "/get-claim-ar-invoice-history": { "get": { "x-controller-name": "ArClaimedController", "x-operation-name": "getClaimArInvoiceHistory", "tags": [ "ArClaimedController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar view claimed |\n", "responses": { "200": { "description": "Get all claim AR invoices with history (claim_ar_invoice_pro relations) with pagination and filters", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ClaimArInvoiceWithRelations" } }, "totalCount": { "type": "number" }, "currentPage": { "type": "number" }, "totalPages": { "type": "number" } } } } } } }, "parameters": [ { "name": "page", "in": "query", "schema": { "type": "number" } }, { "name": "pageSize", "in": "query", "schema": { "type": "number" } }, { "name": "status", "in": "query", "schema": { "type": "string" } }, { "name": "shippersId", "in": "query", "schema": { "type": "string" } }, { "name": "claim_date", "in": "query", "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "schema": { "type": "string" } } ], "operationId": "ArClaimedController.getClaimArInvoiceHistory" } }, "/get-claim-collection-list": { "get": { "x-controller-name": "ArCollectionController", "x-operation-name": "getClaimAndCollectionList", "tags": [ "ArCollectionController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar view invoices |\n", "responses": { "200": { "description": "Return value of ArCollectionController.getClaimAndCollectionList", "content": {} } }, "operationId": "ArCollectionController.getClaimAndCollectionList" } }, "/get-claim-history-from-baddebt": { "get": { "x-controller-name": "ArClaimedController", "x-operation-name": "getClaimHistoryFromBaddebt", "tags": [ "ArClaimedController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar view claimed |\n", "responses": { "200": { "description": "Get claim history from baddebt history with filters and pagination", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "array", "items": { "type": "object" } }, "totalCount": { "type": "number" }, "currentPage": { "type": "number" }, "totalPages": { "type": "number" } } } } } } }, "parameters": [ { "name": "page", "in": "query", "schema": { "type": "number" } }, { "name": "pageSize", "in": "query", "schema": { "type": "number" } }, { "name": "shippersId", "in": "query", "schema": { "type": "string" } }, { "name": "customerName", "in": "query", "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "schema": { "type": "string" } } ], "operationId": "ArClaimedController.getClaimHistoryFromBaddebt" } }, "/get-claim-list": { "get": { "x-controller-name": "ArCollectionController", "x-operation-name": "getClaimList", "tags": [ "ArCollectionController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar view invoices |\n", "responses": { "200": { "description": "Return value of ArCollectionController.getClaimList", "content": {} } }, "operationId": "ArCollectionController.getClaimList" } }, "/get-claim-list-pro": { "get": { "x-controller-name": "ArShipperClaimController", "x-operation-name": "getShippersClaimList", "tags": [ "ArShipperClaimController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar view shipper aging |\n", "responses": { "200": { "description": "Claim List", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Shippers" } } } } }, "parameters": [ { "name": "brokerId", "in": "query", "schema": { "type": "string" } }, { "name": "shippersId", "in": "query", "schema": { "type": "string" } } ], "operationId": "ArShipperClaimController.getShippersClaimList" } }, "/get-claim-list-pro-recived": { "get": { "x-controller-name": "ArShipperClaimController", "x-operation-name": "getShippersClaimListRecived", "tags": [ "ArShipperClaimController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar view shipper aging |\n", "responses": { "200": { "description": "Claim List", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Shippers" } } } } }, "parameters": [ { "name": "shippersId", "in": "query", "schema": { "type": "string" } } ], "operationId": "ArShipperClaimController.getShippersClaimListRecived" } }, "/get-claim-settle-shipper/{id}": { "get": { "x-controller-name": "ArShipperClaimController", "x-operation-name": "GetClaimSettle", "tags": [ "ArShipperClaimController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar view shipper aging |\n", "responses": { "200": { "description": "claim Settle model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipperSmallClaimWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "ArShipperClaimController.GetClaimSettle" } }, "/get-claimed-list": { "get": { "x-controller-name": "ArClaimedController", "x-operation-name": "GetClaimedList", "tags": [ "ArClaimedController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar view claimed |\n", "responses": { "200": { "description": "Claimed model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoicesWithRelations" } } } } }, "parameters": [ { "name": "page", "in": "query", "schema": { "type": "number" } }, { "name": "pageSize", "in": "query", "schema": { "type": "number" } }, { "name": "userId", "in": "query", "schema": { "type": "string" } }, { "name": "shippersId", "in": "query", "schema": { "type": "string" } } ], "operationId": "ArClaimedController.GetClaimedList" } }, "/get-collection-list": { "get": { "x-controller-name": "ArCollectionController", "x-operation-name": "getCollectionList", "tags": [ "ArCollectionController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar view invoices |\n", "responses": { "200": { "description": "Return value of ArCollectionController.getCollectionList", "content": {} } }, "operationId": "ArCollectionController.getCollectionList" } }, "/get-collection-settle-shipper/{id}": { "get": { "x-controller-name": "ArCollectionController", "x-operation-name": "GetCollectionSettle", "tags": [ "ArCollectionController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar view shipper aging |\n", "responses": { "200": { "description": "CollectionSettle model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CollectionSettleWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "ArCollectionController.GetCollectionSettle" } }, "/get-collection-settle-shipper-old/{id}": { "get": { "x-controller-name": "ArCollectionNotesController", "x-operation-name": "GetCollectionSettle", "tags": [ "ArCollectionNotesController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar view shipper aging |\n", "responses": { "200": { "description": "CollectionSettle model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CollectionSettleWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "ArCollectionNotesController.GetCollectionSettle" } }, "/get-common-companies": { "get": { "x-controller-name": "CommonCompaniesController", "x-operation-name": "GetCommonCompanies", "tags": [ "CommonCompaniesController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } } }, "operationId": "CommonCompaniesController.GetCommonCompanies" } }, "/get-common-list/{commonNumber}": { "get": { "x-controller-name": "CommonSearchController", "x-operation-name": "findBy", "tags": [ "CommonSearchController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker view dashboard |\n", "responses": { "200": { "description": "Shippers model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoadsWithRelations" } } } } }, "parameters": [ { "name": "commonNumber", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "CommonSearchController.findBy" } }, "/get-company-details": { "get": { "x-controller-name": "QuickbookController", "x-operation-name": "getCompanyDetails", "tags": [ "QuickbookController" ], "responses": { "200": { "description": "get qb company details", "content": { "application/json": { "schema": { "type": "object" } } } } }, "operationId": "QuickbookController.getCompanyDetails" } }, "/get-cpr-details/{id}": { "get": { "x-controller-name": "SmeReportControllerController", "x-operation-name": "GetCprCommentID", "tags": [ "SmeReportControllerController" ], "description": "\n\n| Permissions |\n| ------- |\n| sme view dashboard |\n| sme view cpr list |\n", "responses": { "200": { "description": "CprRequest model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CprRequestWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "SmeReportControllerController.GetCprCommentID" } }, "/get-cpr-margin-notification/{id}": { "get": { "x-controller-name": "ShipmentCprRequestController", "x-operation-name": "ShippmentPickup", "tags": [ "ShipmentCprRequestController" ], "responses": { "200": { "description": "ShipmentPicks model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipmentPicksWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "ShipmentCprRequestController.ShippmentPickup" } }, "/get-cpr-margin-notification-update/{id}": { "get": { "x-controller-name": "ShipmentCprRequestController", "x-operation-name": "ShippmentPickupUpdate", "tags": [ "ShipmentCprRequestController" ], "responses": { "200": { "description": "ShipmentPicks model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipmentPicksWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "ShipmentCprRequestController.ShippmentPickupUpdate" } }, "/get-cpr-request-list": { "get": { "x-controller-name": "McVerificationController", "x-operation-name": "GetCPRList", "tags": [ "McVerificationController" ], "responses": { "200": { "description": "Array of CprRequest model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CprRequestWithRelations" } } } } } }, "description": "\n\n| Permissions |\n| ------- |\n| sme view dashboard |\n", "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "CprRequest.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "McVerificationController.GetCPRList" } }, "/get-cpr-request-list-call-to": { "get": { "x-controller-name": "McVerificationController", "x-operation-name": "GetCPRListCallTo", "tags": [ "McVerificationController" ], "responses": { "200": { "description": "Array of CprRequest model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CprRequestWithRelations" } } } } } }, "description": "\n\n| Permissions |\n| ------- |\n| sme view dashboard |\n", "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "CprRequest.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "McVerificationController.GetCPRListCallTo" } }, "/get-customer-detail": { "get": { "x-controller-name": "ChurnCustomerController", "x-operation-name": "churnCustomerDetails", "tags": [ "ChurnCustomerController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker view churn report |\n", "responses": { "200": { "description": "Return value of ChurnCustomerController.churnCustomerDetails", "content": {} } }, "parameters": [ { "name": "month", "in": "query", "schema": { "type": "string" } }, { "name": "year", "in": "query", "schema": { "type": "number" } }, { "name": "limit", "in": "query", "schema": { "type": "number" } }, { "name": "offset", "in": "query", "schema": { "type": "number" } }, { "name": "DateFrom", "in": "query", "schema": { "type": "string" } }, { "name": "DateTo", "in": "query", "schema": { "type": "string" } } ], "operationId": "ChurnCustomerController.churnCustomerDetails" } }, "/get-drop-date-log": { "get": { "x-controller-name": "ReportsController", "x-operation-name": "getDropDateLog", "tags": [ "ReportsController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar view drop date log |\n", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Drop Date Log fetched successfully" } } } } }, "parameters": [ { "name": "proNo", "in": "query", "schema": { "type": "string" } }, { "name": "brokerId", "in": "query", "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "number" } }, { "name": "limit", "in": "query", "schema": { "type": "number" } } ], "operationId": "ReportsController.getDropDateLog" } }, "/get-ecapital-list": { "get": { "x-controller-name": "ArEcapitalController", "x-operation-name": "AllShippmentfind", "tags": [ "ArEcapitalController" ], "description": "", "responses": { "200": { "description": "Array of Shipment model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ShipmentWithRelations" } } } } } }, "parameters": [ { "name": "page", "in": "query", "schema": { "type": "number" } }, { "name": "pageSize", "in": "query", "schema": { "type": "number" } }, { "name": "dateFrom", "in": "query", "schema": { "type": "string" } }, { "name": "dateTo", "in": "query", "schema": { "type": "string" } } ], "operationId": "ArEcapitalController.AllShippmentfind" } }, "/get-efs-list": { "get": { "x-controller-name": "ArEcapitalController", "x-operation-name": "AllEfsfind", "tags": [ "ArEcapitalController" ], "description": "", "responses": { "200": { "description": "Array of Shipment model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ShipmentWithRelations" } } } } } }, "parameters": [ { "name": "page", "in": "query", "schema": { "type": "number" } }, { "name": "pageSize", "in": "query", "schema": { "type": "number" } }, { "name": "dateFrom", "in": "query", "schema": { "type": "string" } }, { "name": "dateTo", "in": "query", "schema": { "type": "string" } } ], "operationId": "ArEcapitalController.AllEfsfind" } }, "/get-email-activity-list": { "get": { "x-controller-name": "EmailMarketingController", "x-operation-name": "getEmailActivityList", "tags": [ "EmailMarketingController" ], "description": "\n\n| Permissions |\n| ------- |\n| sidebar email report page |\n", "responses": { "200": { "description": "Return value of EmailMarketingController.getEmailActivityList", "content": {} } }, "parameters": [ { "name": "subject", "in": "query", "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "number" } }, { "name": "pageSize", "in": "query", "schema": { "type": "number" } }, { "name": "sort", "in": "query", "schema": { "type": "string" } }, { "name": "direction", "in": "query", "schema": { "type": "string" } }, { "name": "event", "in": "query", "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "schema": { "type": "string" } }, { "name": "server", "in": "query", "schema": { "type": "string" } }, { "name": "smtpFrom", "in": "query", "schema": { "type": "string" } } ], "operationId": "EmailMarketingController.getEmailActivityList" } }, "/get-email-reports": { "get": { "x-controller-name": "EmailMarketingController", "x-operation-name": "getEmailReports", "tags": [ "EmailMarketingController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker view email report |\n", "responses": { "200": { "description": "Email Marketing reports from SMTP2GO", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array" }, "totalCount": { "type": "number" }, "totalPages": { "type": "number" }, "currentPage": { "type": "number" } } } } } } }, "parameters": [ { "name": "status", "in": "query", "schema": { "type": "string" } }, { "name": "subject", "in": "query", "schema": { "type": "string" } }, { "name": "start_date", "in": "query", "schema": { "type": "string" } }, { "name": "end_date", "in": "query", "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "number" } }, { "name": "limit", "in": "query", "schema": { "type": "number" } } ], "operationId": "EmailMarketingController.getEmailReports" } }, "/get-insurance-document-list": { "get": { "x-controller-name": "ArInsuranceDocumentsController", "x-operation-name": "find", "tags": [ "ArInsuranceDocumentsController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar view insurance doc |\n", "responses": { "200": { "description": "Array of insurance document model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InsuranceDocumentsWithRelations" } } } } } }, "parameters": [ { "name": "page", "in": "query", "schema": { "type": "number" } }, { "name": "pageSize", "in": "query", "schema": { "type": "number" } }, { "name": "document_name", "in": "query", "schema": { "type": "string" } }, { "name": "document_type", "in": "query", "schema": { "type": "string" } }, { "name": "expiry_date", "in": "query", "schema": { "type": "string" } }, { "name": "sort_by", "in": "query", "schema": { "type": "string" } }, { "name": "sort_order", "in": "query", "schema": { "type": "string" } } ], "operationId": "ArInsuranceDocumentsController.find" } }, "/get-invoice-average": { "get": { "x-controller-name": "InvoicesPortalController", "x-operation-name": "find", "tags": [ "InvoicesPortalController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar view invoice average |\n", "responses": { "200": { "description": "Paginated invoices report", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/InvoicesWithRelations" } }, "totalRecords": { "type": "number" }, "totalPages": { "type": "number" }, "currentPage": { "type": "number" }, "pageSize": { "type": "number" } } } } } } }, "parameters": [ { "name": "page", "in": "query", "schema": { "type": "number" } }, { "name": "pageSize", "in": "query", "schema": { "type": "number" } } ], "operationId": "InvoicesPortalController.find" } }, "/get-invoice-detail/{id}": { "get": { "x-controller-name": "ArBadDebtsHistoryController", "x-operation-name": "getInvoiceDetails", "tags": [ "ArBadDebtsHistoryController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar view write off payments |\n", "responses": { "200": { "description": "Invoice detail with relations", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoicesWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ArBadDebtsHistoryController.getInvoiceDetails" } }, "/get-invoice-details/{id}": { "get": { "x-controller-name": "ArInvoicesController", "x-operation-name": "findByIdIn", "tags": [ "ArInvoicesController" ], "responses": { "200": { "description": "Shipment model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipmentWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "ArInvoicesController.findByIdIn" } }, "/get-invoice-id/{id}": { "get": { "x-controller-name": "ArPayReceivedController", "x-operation-name": "GetInvoiceID", "tags": [ "ArPayReceivedController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar view pay received |\n", "responses": { "200": { "description": "Invoices model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoicesWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "ArPayReceivedController.GetInvoiceID" } }, "/get-invoice-proNo/{id}": { "get": { "x-controller-name": "ArPayReceivedController", "x-operation-name": "GetInvoiceProNo", "tags": [ "ArPayReceivedController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar view pay received |\n", "responses": { "200": { "description": "Invoices model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoicesWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "ArPayReceivedController.GetInvoiceProNo" } }, "/get-invoices/{id}": { "get": { "x-controller-name": "ArPayReceivedController", "x-operation-name": "GetInvoice", "tags": [ "ArPayReceivedController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar view pay received |\n", "responses": { "200": { "description": "Invoices model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoicesWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "ArPayReceivedController.GetInvoice" } }, "/get-invoices-for-claim/{id}": { "get": { "x-controller-name": "ArShipperClaimController", "x-operation-name": "GetInvoice", "tags": [ "ArShipperClaimController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar view shipper aging |\n", "responses": { "200": { "description": "Invoices model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoicesWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "ArShipperClaimController.GetInvoice" } }, "/get-invoices-shippers/{id}": { "get": { "x-controller-name": "ArCollectionController", "x-operation-name": "GetInvoice", "tags": [ "ArCollectionController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar view shipper aging |\n", "responses": { "200": { "description": "Invoices model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoicesWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "ArCollectionController.GetInvoice" } }, "/get-latest-conversion-rate": { "get": { "x-controller-name": "ShipmentController", "x-operation-name": "getLatestConversionRate", "tags": [ "ShipmentController" ], "responses": { "200": { "description": "Latest conversion rates", "content": { "application/json": { "schema": { "type": "object", "properties": { "conversionRateUsd": { "type": "number" }, "conversionRateCsd": { "type": "number" } } } } } } }, "operationId": "ShipmentController.getLatestConversionRate" } }, "/get-load-comments/{id}": { "get": { "x-controller-name": "CommonSearchController", "x-operation-name": "getLoadsComment", "tags": [ "CommonSearchController" ], "responses": { "200": { "description": "LoadComments belonging to LoadComments", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoadComments" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "CommonSearchController.getLoadsComment" } }, "/get-loads-data-notifications-list/{commonNumber}": { "get": { "x-controller-name": "CommonSearchController", "x-operation-name": "findByLoadNumbeNotification", "tags": [ "CommonSearchController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker view dashboard |\n", "responses": { "200": { "description": "Shippers model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoadsWithRelations" } } } } }, "parameters": [ { "name": "commonNumber", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "CommonSearchController.findByLoadNumbeNotification" } }, "/get-manage-all-shipper": { "get": { "x-controller-name": "ArshipperLimitController", "x-operation-name": "get_manage_all_shippers", "tags": [ "ArshipperLimitController" ], "responses": { "200": { "description": "Array of User has many Shippers", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Shippers" } } } } } }, "description": "\n\n| Permissions |\n| ------- |\n| ar view shipper limit |\n", "operationId": "ArshipperLimitController.get_manage_all_shippers" } }, "/get-margin-chart-comparison-prev-year": { "get": { "x-controller-name": "MarginReportControllerController", "x-operation-name": "MarginReportChartComparisonPrevYear", "tags": [ "MarginReportControllerController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar margin report list |\n", "responses": { "200": { "description": "Invoices model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoicesWithRelations" } } } } }, "parameters": [ { "name": "startDate", "in": "query", "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "schema": { "type": "string" } }, { "name": "portalId", "in": "query", "schema": { "type": "number" } } ], "operationId": "MarginReportControllerController.MarginReportChartComparisonPrevYear" } }, "/get-margin-chart-comparison-prev-year-new": { "get": { "x-controller-name": "MarginReportControllerController", "x-operation-name": "MarginReportChartComparisonPrevYearNew", "tags": [ "MarginReportControllerController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar margin report list |\n", "responses": { "200": { "description": "Invoices model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoicesWithRelations" } } } } }, "parameters": [ { "name": "startDate", "in": "query", "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "schema": { "type": "string" } }, { "name": "portalId", "in": "query", "schema": { "type": "number" } }, { "name": "comparisonType", "in": "query", "schema": { "type": "string" } }, { "name": "debug", "in": "query", "schema": { "type": "boolean" } }, { "name": "comparisonStartDate", "in": "query", "schema": { "type": "string" } }, { "name": "comparisonEndDate", "in": "query", "schema": { "type": "string" } } ], "operationId": "MarginReportControllerController.MarginReportChartComparisonPrevYearNew" } }, "/get-margin-report": { "get": { "x-controller-name": "MarginReportControllerController", "x-operation-name": "MarginReport", "tags": [ "MarginReportControllerController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar margin report list |\n", "responses": { "200": { "description": "Invoices model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoicesWithRelations" } } } } }, "parameters": [ { "name": "startDate", "in": "query", "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "schema": { "type": "string" } } ], "operationId": "MarginReportControllerController.MarginReport" } }, "/get-margin-report-ByTeamLead": { "get": { "x-controller-name": "MarginReportControllerController", "x-operation-name": "MarginReportByTeamLead", "tags": [ "MarginReportControllerController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar margin report list |\n", "responses": { "200": { "description": "Invoices model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoicesWithRelations" } } } } }, "parameters": [ { "name": "startDate", "in": "query", "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "schema": { "type": "string" } }, { "name": "teamLeadId", "in": "query", "schema": { "type": "string" } }, { "name": "userType", "in": "query", "schema": { "type": "string" } } ], "operationId": "MarginReportControllerController.MarginReportByTeamLead" } }, "/get-margin-report-ByTeamLead-asi": { "get": { "x-controller-name": "MarginReportControllerController", "x-operation-name": "MarginReportByTeamLeadAsi", "tags": [ "MarginReportControllerController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar margin report list |\n", "responses": { "200": { "description": "Invoices model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoicesWithRelations" } } } } }, "parameters": [ { "name": "startDate", "in": "query", "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "schema": { "type": "string" } }, { "name": "teamLeadId", "in": "query", "schema": { "type": "string" } }, { "name": "userType", "in": "query", "schema": { "type": "string" } } ], "operationId": "MarginReportControllerController.MarginReportByTeamLeadAsi" } }, "/get-margin-report-asi": { "get": { "x-controller-name": "MarginReportControllerController", "x-operation-name": "MarginReportAsi", "tags": [ "MarginReportControllerController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar margin report list |\n", "responses": { "200": { "description": "Invoices model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoicesWithRelations" } } } } }, "parameters": [ { "name": "startDate", "in": "query", "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "schema": { "type": "string" } } ], "operationId": "MarginReportControllerController.MarginReportAsi" } }, "/get-margin-report-asi-new": { "get": { "x-controller-name": "MarginReportControllerController", "x-operation-name": "MarginReportAsiNew", "tags": [ "MarginReportControllerController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar margin report list |\n", "responses": { "200": { "description": "Invoices model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoicesWithRelations" } } } } }, "parameters": [ { "name": "startDate", "in": "query", "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "schema": { "type": "string" } }, { "name": "comparisonType", "in": "query", "schema": { "type": "string" } }, { "name": "comparisonStartDate", "in": "query", "schema": { "type": "string" } }, { "name": "comparisonEndDate", "in": "query", "schema": { "type": "string" } } ], "operationId": "MarginReportControllerController.MarginReportAsiNew" } }, "/get-margin-report-manager": { "get": { "x-controller-name": "MarginReportControllerController", "x-operation-name": "MarginReportManager", "tags": [ "MarginReportControllerController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar margin report list |\n", "responses": { "200": { "description": "Invoices model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoicesWithRelations" } } } } }, "parameters": [ { "name": "startDate", "in": "query", "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "schema": { "type": "string" } } ], "operationId": "MarginReportControllerController.MarginReportManager" } }, "/get-margin-report-manager-asi": { "get": { "x-controller-name": "MarginReportControllerController", "x-operation-name": "MarginReportManagerAsi", "tags": [ "MarginReportControllerController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar margin report list |\n", "responses": { "200": { "description": "Invoices model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoicesWithRelations" } } } } }, "parameters": [ { "name": "startDate", "in": "query", "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "schema": { "type": "string" } } ], "operationId": "MarginReportControllerController.MarginReportManagerAsi" } }, "/get-margin-report-managerById": { "get": { "x-controller-name": "MarginReportControllerController", "x-operation-name": "MarginReportManagerBy", "tags": [ "MarginReportControllerController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar margin report list |\n", "responses": { "200": { "description": "Invoices model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoicesWithRelations" } } } } }, "parameters": [ { "name": "startDate", "in": "query", "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "schema": { "type": "string" } }, { "name": "managerId", "in": "query", "schema": { "type": "string" } }, { "name": "userType", "in": "query", "schema": { "type": "string" } } ], "operationId": "MarginReportControllerController.MarginReportManagerBy" } }, "/get-margin-report-managerById-asi": { "get": { "x-controller-name": "MarginReportControllerController", "x-operation-name": "MarginReportManagerByAsi", "tags": [ "MarginReportControllerController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar margin report list |\n", "responses": { "200": { "description": "Invoices model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoicesWithRelations" } } } } }, "parameters": [ { "name": "startDate", "in": "query", "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "schema": { "type": "string" } }, { "name": "managerId", "in": "query", "schema": { "type": "string" } }, { "name": "userType", "in": "query", "schema": { "type": "string" } } ], "operationId": "MarginReportControllerController.MarginReportManagerByAsi" } }, "/get-margin-report-new": { "get": { "x-controller-name": "MarginReportControllerController", "x-operation-name": "MarginReportNew", "tags": [ "MarginReportControllerController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar margin report list |\n", "responses": { "200": { "description": "Invoices model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoicesWithRelations" } } } } }, "parameters": [ { "name": "startDate", "in": "query", "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "schema": { "type": "string" } }, { "name": "comparisonType", "in": "query", "schema": { "type": "string" } }, { "name": "comparisonStartDate", "in": "query", "schema": { "type": "string" } }, { "name": "comparisonEndDate", "in": "query", "schema": { "type": "string" } } ], "operationId": "MarginReportControllerController.MarginReportNew" } }, "/get-margin-report-teamlead-by-managerById": { "get": { "x-controller-name": "MarginReportControllerController", "x-operation-name": "MarginReportManagerByTeamLead", "tags": [ "MarginReportControllerController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar margin report list |\n", "responses": { "200": { "description": "Invoices model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoicesWithRelations" } } } } }, "parameters": [ { "name": "startDate", "in": "query", "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "schema": { "type": "string" } }, { "name": "managerId", "in": "query", "schema": { "type": "string" } } ], "operationId": "MarginReportControllerController.MarginReportManagerByTeamLead" } }, "/get-margin-report-teamlead-by-managerById-asi": { "get": { "x-controller-name": "MarginReportControllerController", "x-operation-name": "MarginReportManagerByTeamLeadAsi", "tags": [ "MarginReportControllerController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar margin report list |\n", "responses": { "200": { "description": "Invoices model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoicesWithRelations" } } } } }, "parameters": [ { "name": "managerId", "in": "query", "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "schema": { "type": "string" } } ], "operationId": "MarginReportControllerController.MarginReportManagerByTeamLeadAsi" } }, "/get-margin-report-user-list": { "get": { "x-controller-name": "MarginReportControllerController", "x-operation-name": "MarginReportManagerByUser", "tags": [ "MarginReportControllerController" ], "description": "", "responses": { "200": { "description": "Invoices model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoicesWithRelations" } } } } }, "parameters": [ { "name": "date", "in": "query", "schema": { "type": "string" } }, { "name": "userId", "in": "query", "schema": { "type": "string" } } ], "operationId": "MarginReportControllerController.MarginReportManagerByUser" } }, "/get-mc-approved-declined-details/{id}/{type}": { "get": { "x-controller-name": "McVerificationController", "x-operation-name": "getMcApprovedDeclinedDetails", "tags": [ "McVerificationController" ], "description": "", "responses": { "200": { "description": "McVerification model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/McVerificationWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "type", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "McVerificationController.getMcApprovedDeclinedDetails" } }, "/get-mc-block-list": { "get": { "x-controller-name": "McVerificationController", "x-operation-name": "GetMCBlockList", "tags": [ "McVerificationController" ], "description": "\n\n| Permissions |\n| ------- |\n| sme view dashboard |\n", "responses": { "200": { "description": "Array of McVerification model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/McVerificationWithRelations" } } } } } }, "operationId": "McVerificationController.GetMCBlockList" } }, "/get-mc-cpr-notifications-on-page": { "get": { "x-controller-name": "McVerificationController", "x-operation-name": "findMcCpr", "tags": [ "McVerificationController" ], "description": "", "responses": { "200": { "description": "Array of MC + CPR notifications", "content": { "application/json": { "schema": { "type": "object", "properties": { "totalCount": { "type": "number" }, "currentPage": { "type": "number" }, "totalPages": { "type": "number" }, "data": { "type": "array", "items": { "type": "object" } } } } } } } }, "parameters": [ { "name": "page", "in": "query", "schema": { "type": "number" } }, { "name": "limit", "in": "query", "schema": { "type": "number" } }, { "name": "dateFrom", "in": "query", "schema": { "type": "string" } }, { "name": "dateTo", "in": "query", "schema": { "type": "string" } } ], "operationId": "McVerificationController.findMcCpr" } }, "/get-mc-detail-decline/{id}": { "get": { "x-controller-name": "SmeReportControllerController", "x-operation-name": "GetComment", "tags": [ "SmeReportControllerController" ], "description": "\n\n| Permissions |\n| ------- |\n| sme view dashboard |\n", "responses": { "200": { "description": "McVerification model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/McVerificationWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "SmeReportControllerController.GetComment" } }, "/get-mc-details/{id}": { "get": { "x-controller-name": "SmeReportControllerController", "x-operation-name": "GetCommentID", "tags": [ "SmeReportControllerController" ], "description": "\n\n| Permissions |\n| ------- |\n| sme view dashboard |\n| sme view mc list |\n| sme exception view |\n", "responses": { "200": { "description": "McVerification model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/McVerificationWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "SmeReportControllerController.GetCommentID" } }, "/get-mc-list": { "get": { "x-controller-name": "McVerificationController", "x-operation-name": "GetMCList", "tags": [ "McVerificationController" ], "description": "\n\n| Permissions |\n| ------- |\n| sme view dashboard |\n", "responses": { "200": { "description": "Array of McVerification model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/McVerificationWithRelations" } } } } } }, "operationId": "McVerificationController.GetMCList" } }, "/get-payment-ap-logs": { "get": { "x-controller-name": "CarrierPaymentHoldRequestController", "x-operation-name": "getPaymentApLogs", "tags": [ "CarrierPaymentHoldRequestController" ], "description": "", "responses": { "200": { "description": "Array of CarrierPaymentHoldRequestHistory model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CarrierPaymentHoldRequestHistoryWithRelations" } } } } } }, "parameters": [ { "name": "page", "in": "query", "schema": { "type": "number" } }, { "name": "pageSize", "in": "query", "schema": { "type": "number" } } ], "operationId": "CarrierPaymentHoldRequestController.getPaymentApLogs" } }, "/get-payment-details/{shipmentId}": { "get": { "x-controller-name": "ApEmailToCarrierController", "x-operation-name": "getLatestPaymentDetailByShipmentId", "tags": [ "ApEmailToCarrierController" ], "responses": { "200": { "description": "Latest ApEmailToCarrier record for a shipment", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApEmailToCarrierWithRelations" } } } } }, "parameters": [ { "name": "shipmentId", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ApEmailToCarrierController.getLatestPaymentDetailByShipmentId" } }, "/get-payment-remittance-list": { "get": { "x-controller-name": "ShipperPaymentRemittanceController", "x-operation-name": "sentPaymentRemittanceData", "tags": [ "ShipperPaymentRemittanceController" ], "description": "\n\n| Permissions |\n| ------- |\n| payment remittance |\n", "responses": { "200": { "description": "ShipperPaymentRemittance model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipperPaymentRemittanceWithRelations" } } } } }, "parameters": [ { "name": "shippersId", "in": "query", "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "number" } }, { "name": "pageSize", "in": "query", "schema": { "type": "number" } }, { "name": "DateFrom", "in": "query", "schema": { "type": "string" } }, { "name": "DateTo", "in": "query", "schema": { "type": "string" } } ], "operationId": "ShipperPaymentRemittanceController.sentPaymentRemittanceData" } }, "/get-re-shippers-list": { "get": { "x-controller-name": "ArShippersController", "x-operation-name": "ReShipperfind", "tags": [ "ArShippersController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar view dashboard |\n", "responses": { "200": { "description": "Array of Shippers model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ShippersWithRelations" } } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Shippers.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } }, { "name": "page", "in": "query", "schema": { "type": "number" } }, { "name": "pageSize", "in": "query", "schema": { "type": "number" } } ], "operationId": "ArShippersController.ReShipperfind" } }, "/get-re-verified-mc/{id}": { "get": { "x-controller-name": "McVerificationController", "x-operation-name": "mcReVerificationGet", "tags": [ "McVerificationController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker send mc request |\n", "responses": { "200": { "description": "McVerification model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/McVerificationWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "McVerificationController.mcReVerificationGet" } }, "/get-remittance-data": { "post": { "x-controller-name": "ShipperPaymentRemittanceController", "x-operation-name": "getRemittaceData", "tags": [ "ShipperPaymentRemittanceController" ], "description": "\n\n| Permissions |\n| ------- |\n| payment remittance |\n", "responses": { "200": { "description": "Array of Shipment and invoices model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InvoicesWithRelations" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "ShipperPaymentRemittanceController.getRemittaceData" } }, "/get-remittance-list": { "get": { "x-controller-name": "ApRemittanceController", "x-operation-name": "getPaymentApLogs", "tags": [ "ApRemittanceController" ], "description": "", "responses": { "200": { "description": "Array of remittanceApRepository model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RemittanceApWithRelations" } } } } } }, "parameters": [ { "name": "carriersId", "in": "query", "schema": { "type": "string" } }, { "name": "shipmentId", "in": "query", "schema": { "type": "string" } }, { "name": "usersId", "in": "query", "schema": { "type": "string" } } ], "operationId": "ApRemittanceController.getPaymentApLogs" } }, "/get-remittance-list-carrier": { "get": { "x-controller-name": "ApRemittanceController", "x-operation-name": "getRemittanceListCarrier", "tags": [ "ApRemittanceController" ], "description": "", "responses": { "200": { "description": "Array of Shipment model instances based on portal", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ShipmentWithRelations" } } } } } }, "operationId": "ApRemittanceController.getRemittanceListCarrier" } }, "/get-remittance-list-username": { "get": { "x-controller-name": "ApRemittanceController", "x-operation-name": "getRemittanceListUsername", "tags": [ "ApRemittanceController" ], "description": "", "responses": { "200": { "description": "Array of Shipment model instances based on portal", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ShipmentWithRelations" } } } } } }, "operationId": "ApRemittanceController.getRemittanceListUsername" } }, "/get-shipment-by-shipper-contact/{id}": { "get": { "x-controller-name": "ShipmentController", "x-operation-name": "findByIdByShipper", "tags": [ "ShipmentController" ], "responses": { "200": { "description": "Shipment model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipmentWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "ShipmentController.findByIdByShipper" } }, "/get-shipment-byId/{shipment_id}": { "get": { "x-controller-name": "ShipmentStatusController", "x-operation-name": "find", "tags": [ "ShipmentStatusController" ], "responses": { "200": { "description": "Array of Shipment model instances", "content": { "application/json": { "schema": { "type": "array" } } } } }, "parameters": [ { "name": "shipment_id", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Shipment.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } }, { "name": "page", "in": "query", "schema": { "type": "number" } }, { "name": "invoiceNumber", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "number" } } ], "operationId": "ShipmentStatusController.find" } }, "/get-shipment-details/{id}": { "get": { "x-controller-name": "MobileAppController", "x-operation-name": "findById", "tags": [ "MobileAppController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker create shipment |\n", "responses": { "200": { "description": "Shipment model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipmentWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "MobileAppController.findById" } }, "/get-shipment-drayage/{id}": { "get": { "x-controller-name": "ShipmentController", "x-operation-name": "GetShipmentDrayage", "tags": [ "ShipmentController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker create shipment |\n", "responses": { "200": { "description": "Return value of ShipmentController.GetShipmentDrayage", "content": {} }, "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Shipment PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "ShipmentController.GetShipmentDrayage" } }, "/get-shipment-last-drop/{id}": { "get": { "x-controller-name": "TruckstopsCacciController", "x-operation-name": "findBy", "tags": [ "TruckstopsCacciController" ], "responses": { "200": { "description": "Shippers model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipmentWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "TruckstopsCacciController.findBy" } }, "/get-shipment-status/{shipment_id}": { "get": { "x-controller-name": "ShipmentStatusController", "x-operation-name": "findbyid", "tags": [ "ShipmentStatusController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker create carrier |\n", "responses": { "200": { "description": "Array of Shipment model instances", "content": { "application/json": { "schema": { "type": "array" } } } } }, "parameters": [ { "name": "shipment_id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "ShipmentStatusController.findbyid" } }, "/get-shipments-call-vin-list": { "get": { "x-controller-name": "BrokerVinVerificationController", "x-operation-name": "GetfindList", "tags": [ "BrokerVinVerificationController" ], "description": "", "responses": { "200": { "description": "Array of Shipment model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ShipmentWithRelations" } } } } } }, "operationId": "BrokerVinVerificationController.GetfindList" } }, "/get-shipments-carrier": { "get": { "x-controller-name": "ShipmentController", "x-operation-name": "getShippmentCarrier", "tags": [ "ShipmentController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker view shipment |\n", "responses": { "200": { "description": "Array of Shipment model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ShipmentWithRelations" } } } } } }, "operationId": "ShipmentController.getShippmentCarrier" } }, "/get-shipments-email-vin-list": { "get": { "x-controller-name": "BrokerVinVerificationController", "x-operation-name": "Getfind", "tags": [ "BrokerVinVerificationController" ], "description": "", "responses": { "200": { "description": "Array of Shipment model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ShipmentWithRelations" } } } } } }, "parameters": [ { "name": "page", "in": "query", "schema": { "type": "number" } }, { "name": "pageSize", "in": "query", "schema": { "type": "number" } }, { "name": "shipmentId", "in": "query", "schema": { "type": "string" } }, { "name": "emailVerifyStatus", "in": "query", "schema": { "type": "string" } }, { "name": "phoneVerifyStatus", "in": "query", "schema": { "type": "string" } }, { "name": "portalId", "in": "query", "schema": { "type": "string" } } ], "operationId": "BrokerVinVerificationController.Getfind" } }, "/get-shipments-email-vin-list-old": { "get": { "x-controller-name": "BrokerVinVerificationController", "x-operation-name": "GetfindOld", "tags": [ "BrokerVinVerificationController" ], "description": "", "responses": { "200": { "description": "Array of Shipment model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ShipmentWithRelations" } } } } } }, "parameters": [ { "name": "page", "in": "query", "schema": { "type": "number" } }, { "name": "pageSize", "in": "query", "schema": { "type": "number" } }, { "name": "shipmentId", "in": "query", "schema": { "type": "string" } }, { "name": "VerifyEmailStatus", "in": "query", "schema": { "type": "string" } }, { "name": "VerifyPhoneStatus", "in": "query", "schema": { "type": "string" } } ], "operationId": "BrokerVinVerificationController.GetfindOld" } }, "/get-shipments-list": { "get": { "x-controller-name": "ShipmentController", "x-operation-name": "Getfind", "tags": [ "ShipmentController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker view shipment |\n", "responses": { "200": { "description": "Array of Shipment model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ShipmentWithRelations" } } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Shipment.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } }, { "name": "page", "in": "query", "schema": { "type": "number" } }, { "name": "pageSize", "in": "query", "schema": { "type": "number" } }, { "name": "status", "in": "query", "schema": { "type": "string" } }, { "name": "id", "in": "query", "schema": { "type": "string" } }, { "name": "commodityVerify", "in": "query", "schema": { "type": "string" } }, { "name": "portalId", "in": "query", "schema": { "type": "string" } } ], "operationId": "ShipmentController.Getfind" } }, "/get-shipments-list-cpr-auditor": { "get": { "x-controller-name": "AuditorController", "x-operation-name": "Getfind", "tags": [ "AuditorController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker view shipment |\n", "responses": { "200": { "description": "Array of Shipment model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ShipmentWithRelations" } } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Shipment.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } }, { "name": "page", "in": "query", "schema": { "type": "number" } }, { "name": "pageSize", "in": "query", "schema": { "type": "number" } }, { "name": "status", "in": "query", "schema": { "type": "string" } }, { "name": "id", "in": "query", "schema": { "type": "string" } }, { "name": "cprVerify", "in": "query", "schema": { "type": "string" } } ], "operationId": "AuditorController.Getfind" } }, "/get-shipments-list-cpr-auditor-new": { "get": { "x-controller-name": "AuditorController", "x-operation-name": "GetfindNew", "tags": [ "AuditorController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker view shipment |\n", "responses": { "200": { "description": "Array of Shipment model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ShipmentWithRelations" } } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Shipment.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } }, { "name": "page", "in": "query", "schema": { "type": "number" } }, { "name": "pageSize", "in": "query", "schema": { "type": "number" } }, { "name": "status", "in": "query", "schema": { "type": "string" } }, { "name": "id", "in": "query", "schema": { "type": "string" } }, { "name": "cprVerify", "in": "query", "schema": { "type": "string" } }, { "name": "portalId", "in": "query", "schema": { "type": "string" } } ], "operationId": "AuditorController.GetfindNew" } }, "/get-shipments-list-vin-number": { "get": { "x-controller-name": "BrokerVinVerificationController", "x-operation-name": "GetfindVinNumber", "tags": [ "BrokerVinVerificationController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker view shipment |\n", "responses": { "200": { "description": "Array of Shipment model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ShipmentWithRelations" } } } } } }, "parameters": [ { "name": "page", "in": "query", "schema": { "type": "number" } }, { "name": "pageSize", "in": "query", "schema": { "type": "number" } }, { "name": "status", "in": "query", "schema": { "type": "string" } }, { "name": "id", "in": "query", "schema": { "type": "string" } }, { "name": "verifyVinNumber", "in": "query", "schema": { "type": "string" } }, { "name": "verifyPickupPhone", "in": "query", "schema": { "type": "string" } } ], "operationId": "BrokerVinVerificationController.GetfindVinNumber" } }, "/get-shipments-states": { "get": { "x-controller-name": "BrokerHomeController", "x-operation-name": "GetShipmentsStates", "tags": [ "BrokerHomeController" ], "description": "", "responses": { "200": { "description": "Shipment model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoicesWithRelations" } } } } }, "operationId": "BrokerHomeController.GetShipmentsStates" } }, "/get-shipments-states-manager": { "get": { "x-controller-name": "BrokerHomeController", "x-operation-name": "GetShipmentsStatesManager", "tags": [ "BrokerHomeController" ], "description": "", "responses": { "200": { "description": "Shipment model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoicesWithRelations" } } } } }, "operationId": "BrokerHomeController.GetShipmentsStatesManager" } }, "/get-shipper-limit/{id}": { "get": { "x-controller-name": "BrokerHomeController", "x-operation-name": "GetShipperLimit", "tags": [ "BrokerHomeController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker view dashboard |\n", "responses": { "200": { "description": "ShipperLimits model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShippersWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "BrokerHomeController.GetShipperLimit" } }, "/get-shipper-list-by-company": { "get": { "x-controller-name": "ArShippersController", "x-operation-name": "find_shipper_list_by_company", "tags": [ "ArShippersController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar view dashboard |\n", "responses": { "200": { "description": "Array of Shippers model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ShippersWithRelations" } } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Shippers.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } }, { "name": "name", "in": "query", "schema": { "type": "string" } } ], "operationId": "ArShippersController.find_shipper_list_by_company" } }, "/get-shippers-history": { "get": { "x-controller-name": "ArShippersController", "x-operation-name": "get_shippers_history_find", "tags": [ "ArShippersController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar view shipper |\n", "responses": { "200": { "description": "Array of Shippers model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ShipperHistoryWithRelations" } } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "ShipperHistory.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } }, { "name": "page", "in": "query", "schema": { "type": "number" } }, { "name": "pageSize", "in": "query", "schema": { "type": "number" } }, { "name": "status", "in": "query", "schema": { "type": "string" } } ], "operationId": "ArShippersController.get_shippers_history_find" } }, "/get-shippers-limit-list": { "get": { "x-controller-name": "ShipperLimitController", "x-operation-name": "find", "tags": [ "ShipperLimitController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker shipper limit |\n", "responses": { "200": { "description": "Array of Shippers model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ShipperLimitsWithRelations" } } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "ShipperLimits.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "ShipperLimitController.find" } }, "/get-shippers-list": { "get": { "x-controller-name": "ArShippersController", "x-operation-name": "find", "tags": [ "ArShippersController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar view dashboard |\n", "responses": { "200": { "description": "Array of Shippers model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ShippersWithRelations" } } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Shippers.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } }, { "name": "page", "in": "query", "schema": { "type": "number" } }, { "name": "pageSize", "in": "query", "schema": { "type": "number" } } ], "operationId": "ArShippersController.find" } }, "/get-shippers-request-history": { "get": { "x-controller-name": "ArshipperLimitController", "x-operation-name": "get_shippers_request_history", "tags": [ "ArshipperLimitController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar view shipper request history |\n", "responses": { "200": { "description": "Array of Shippers limit model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ShipperLimitsWithRelations" } } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "ShipperLimits.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } }, { "name": "page", "in": "query", "schema": { "type": "number" } }, { "name": "pageSize", "in": "query", "schema": { "type": "number" } }, { "name": "status", "in": "query", "schema": { "type": "string" } } ], "operationId": "ArshipperLimitController.get_shippers_request_history" } }, "/get-shippment-pickup/{id}": { "get": { "x-controller-name": "BrokerVinVerificationController", "x-operation-name": "ShippmentPickup", "tags": [ "BrokerVinVerificationController" ], "responses": { "200": { "description": "ShipmentPicks model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipmentPicksWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "BrokerVinVerificationController.ShippmentPickup" } }, "/get-shippment-vin-number-details/{id}": { "get": { "x-controller-name": "AuditorController", "x-operation-name": "ShippmentPickup", "tags": [ "AuditorController" ], "responses": { "200": { "description": "ShipmentPicks model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipmentPicksWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "AuditorController.ShippmentPickup" } }, "/get-single-shipment/by-shipmentId/{id}": { "get": { "x-controller-name": "ShipmentCprRequestController", "x-operation-name": "getCprRequestByUid", "tags": [ "ShipmentCprRequestController" ], "responses": { "200": { "description": "Return value of ShipmentCprRequestController.getCprRequestByUid" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "ShipmentCprRequestController.getCprRequestByUid" } }, "/get-small-claim-list": { "get": { "x-controller-name": "ArShipperClaimController", "x-operation-name": "getCollectionList", "tags": [ "ArShipperClaimController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar view shipper aging |\n", "responses": { "200": { "description": "Return value of ArShipperClaimController.getCollectionList", "content": {} } }, "operationId": "ArShipperClaimController.getCollectionList" } }, "/get-sms-shipments/{id}": { "get": { "x-controller-name": "McVerificationController", "x-operation-name": "GetfindById", "tags": [ "McVerificationController" ], "responses": { "200": { "description": "Shipment model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipmentWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "McVerificationController.GetfindById" } }, "/get-ssl-payment": { "get": { "x-controller-name": "ShipmentController", "x-operation-name": "getSslPayment", "tags": [ "ShipmentController" ], "responses": { "200": { "description": "Return value of ShipmentController.getSslPayment" } }, "parameters": [ { "name": "shipmentId", "in": "query", "schema": { "type": "number" } } ], "operationId": "ShipmentController.getSslPayment" } }, "/get-team-members": { "get": { "x-controller-name": "EmpAlignmentUserController", "x-operation-name": "getTeamMembers", "tags": [ "EmpAlignmentUserController" ], "responses": { "200": { "description": "Get team members current month alignment by manager ID", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EmpAlignmentWithRelations" } } } } } }, "description": "", "parameters": [ { "name": "managerId", "in": "query", "schema": { "type": "number" } }, { "name": "targetMonth", "in": "query", "schema": { "type": "string" } } ], "operationId": "EmpAlignmentUserController.getTeamMembers" } }, "/get-tonu-list": { "get": { "x-controller-name": "ArShipmentsController", "x-operation-name": "getTonuList", "tags": [ "ArShipmentsController" ], "description": "", "responses": { "200": { "description": "Tonu list", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipmentWithRelations" } } } } }, "parameters": [ { "name": "page", "in": "query", "schema": { "type": "number" } }, { "name": "pageSize", "in": "query", "schema": { "type": "number" } }, { "name": "proNumber", "in": "query", "schema": { "type": "string" } }, { "name": "brokerCarrierSearch", "in": "query", "schema": { "type": "string" } }, { "name": "tonuStatus", "in": "query", "schema": { "type": "string" } }, { "name": "dateFrom", "in": "query", "schema": { "type": "string" } }, { "name": "dateTo", "in": "query", "schema": { "type": "string" } } ], "operationId": "ArShipmentsController.getTonuList" } }, "/get-tonu-request-approval-list": { "get": { "x-controller-name": "ShipmentController", "x-operation-name": "getTonuRequestApprovalList", "tags": [ "ShipmentController" ], "description": "\n\n| Permissions |\n| ------- |\n| tonu request page |\n", "responses": { "200": { "description": "Tonu request approval list", "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "type": "number" }, "pageSize": { "type": "number" } } } } } } }, "parameters": [ { "name": "page", "in": "query", "schema": { "type": "number" } }, { "name": "pageSize", "in": "query", "schema": { "type": "number" } } ], "operationId": "ShipmentController.getTonuRequestApprovalList" } }, "/get-total-users-count": { "get": { "x-controller-name": "PerformanceReportController", "x-operation-name": "getTotalUsersCount", "tags": [ "PerformanceReportController" ], "description": "", "responses": { "200": { "description": "Return value of PerformanceReportController.getTotalUsersCount", "content": {} } }, "operationId": "PerformanceReportController.getTotalUsersCount" } }, "/get-update-shippers-list": { "get": { "x-controller-name": "ArShippersController", "x-operation-name": "UpdateShipperfind", "tags": [ "ArShippersController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar view dashboard |\n", "responses": { "200": { "description": "Array of Shippers model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ShippersWithRelations" } } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Shippers.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } }, { "name": "page", "in": "query", "schema": { "type": "number" } }, { "name": "pageSize", "in": "query", "schema": { "type": "number" } } ], "operationId": "ArShippersController.UpdateShipperfind" } }, "/get-used-limit/{id}": { "get": { "x-controller-name": "ShipmentController", "x-operation-name": "getUsedLimit", "tags": [ "ShipmentController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker create shipment |\n", "responses": { "200": { "description": "Shipment model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipmentWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "ShipmentController.getUsedLimit" } }, "/get-user/{id}": { "get": { "x-controller-name": "CommonSearchController", "x-operation-name": "findById", "tags": [ "CommonSearchController" ], "responses": { "200": { "description": "User model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "CommonSearchController.findById" } }, "/get-vinhistory/{id}": { "get": { "x-controller-name": "BrokerVinVerificationController", "x-operation-name": "GetCommentID", "tags": [ "BrokerVinVerificationController" ], "description": "", "responses": { "200": { "description": "McVerification model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipmentWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "BrokerVinVerificationController.GetCommentID" } }, "/get-withdrawn-shippers-list": { "get": { "x-controller-name": "WithdrawnShipperCreditLimitHistoryController", "x-operation-name": "get_withdrawn_shippers_list", "tags": [ "WithdrawnShipperCreditLimitHistoryController" ], "responses": { "200": { "description": "Array of User has many Shippers", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Shippers" } } } } } }, "description": "\n\n| Permissions |\n| ------- |\n| ar withdrawn limit |\n", "operationId": "WithdrawnShipperCreditLimitHistoryController.get_withdrawn_shippers_list" } }, "/get-write-off-list": { "get": { "x-controller-name": "ArBadDebtsHistoryController", "x-operation-name": "find", "tags": [ "ArBadDebtsHistoryController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar view write off payments |\n", "responses": { "200": { "description": "Array of write off payment model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InvoicesWithRelations" } } } } } }, "parameters": [ { "name": "InvoiceId", "in": "query", "schema": { "type": "string" } }, { "name": "ProNo", "in": "query", "schema": { "type": "string" } }, { "name": "shippersId", "in": "query", "schema": { "type": "string" } }, { "name": "filterStatus", "in": "query", "schema": { "type": "string" } } ], "operationId": "ArBadDebtsHistoryController.find" } }, "/get-write-off-list-all": { "get": { "x-controller-name": "ArBadDebtsHistoryController", "x-operation-name": "findAll", "tags": [ "ArBadDebtsHistoryController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar view write off payments |\n", "responses": { "200": { "description": "Array of write off payment model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InvoicesWithRelations" } } } } } }, "parameters": [ { "name": "InvoiceId", "in": "query", "schema": { "type": "string" } }, { "name": "ProNo", "in": "query", "schema": { "type": "string" } }, { "name": "shippersId", "in": "query", "schema": { "type": "string" } } ], "operationId": "ArBadDebtsHistoryController.findAll" } }, "/getInvoiceAndShipmentDetails/{shipmentId}": { "get": { "x-controller-name": "InvoiceRegenrationRequestsController", "x-operation-name": "getInvoiceAndShipmentDetails", "tags": [ "InvoiceRegenrationRequestsController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar view invoices |\n", "responses": { "200": { "description": "Return value of InvoiceRegenrationRequestsController.getInvoiceAndShipmentDetails", "content": {} } }, "parameters": [ { "name": "shipmentId", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "InvoiceRegenrationRequestsController.getInvoiceAndShipmentDetails" } }, "/gets-shippers-lists": { "get": { "x-controller-name": "ShippersController", "x-operation-name": "Getfind", "tags": [ "ShippersController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker view shipper |\n", "responses": { "200": { "description": "Array of Shippers model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ShippersWithRelations" } } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Shippers.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } }, { "name": "page", "in": "query", "schema": { "type": "number" } }, { "name": "pageSize", "in": "query", "schema": { "type": "number" } }, { "name": "ShipperName", "in": "query", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "schema": { "type": "string" } } ], "operationId": "ShippersController.Getfind" } }, "/getshipmentdetails/{id}": { "get": { "x-controller-name": "ArShipmentsController", "x-operation-name": "findById", "tags": [ "ArShipmentsController" ], "responses": { "200": { "description": "Shipment model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipmentWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "ArShipmentsController.findById" } }, "/good-to-go-detail/{id}": { "get": { "x-controller-name": "ArShipmentsController", "x-operation-name": "GetGoodToGoDetail", "tags": [ "ArShipmentsController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar view shipment |\n", "responses": { "200": { "description": "Shipment model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipmentWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "ArShipmentsController.GetGoodToGoDetail" } }, "/good-to-go-detail-ap/{id}": { "get": { "x-controller-name": "ApShipmentControllerController", "x-operation-name": "GetGoodToGoDetailAp", "tags": [ "ApShipmentControllerController" ], "description": "\n\n| Permissions |\n| ------- |\n| ap view shipment |\n", "responses": { "200": { "description": "Shipment model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipmentWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "ApShipmentControllerController.GetGoodToGoDetailAp" } }, "/good-to-go-histories/count": { "get": { "x-controller-name": "GoodToGoHistoryController", "x-operation-name": "count", "tags": [ "GoodToGoHistoryController" ], "responses": { "200": { "description": "GoodToGoHistory model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "GoodToGoHistory.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "GoodToGoHistoryController.count" } }, "/good-to-go-histories/{id}": { "put": { "x-controller-name": "GoodToGoHistoryController", "x-operation-name": "replaceById", "tags": [ "GoodToGoHistoryController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "GoodToGoHistory PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GoodToGoHistory" } } }, "x-parameter-index": 1 }, "operationId": "GoodToGoHistoryController.replaceById" }, "patch": { "x-controller-name": "GoodToGoHistoryController", "x-operation-name": "updateById", "tags": [ "GoodToGoHistoryController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "GoodToGoHistory PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GoodToGoHistoryPartial" } } }, "x-parameter-index": 1 }, "operationId": "GoodToGoHistoryController.updateById" }, "get": { "x-controller-name": "GoodToGoHistoryController", "x-operation-name": "findById", "tags": [ "GoodToGoHistoryController" ], "responses": { "200": { "description": "GoodToGoHistory model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GoodToGoHistoryWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GoodToGoHistory.Filter" } } } } ], "operationId": "GoodToGoHistoryController.findById" }, "delete": { "x-controller-name": "GoodToGoHistoryController", "x-operation-name": "deleteById", "tags": [ "GoodToGoHistoryController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "GoodToGoHistory DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "GoodToGoHistoryController.deleteById" } }, "/good-to-go-histories": { "post": { "x-controller-name": "GoodToGoHistoryController", "x-operation-name": "create", "tags": [ "GoodToGoHistoryController" ], "responses": { "200": { "description": "GoodToGoHistory model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GoodToGoHistory" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewGoodToGoHistory" } } } }, "operationId": "GoodToGoHistoryController.create" }, "patch": { "x-controller-name": "GoodToGoHistoryController", "x-operation-name": "updateAll", "tags": [ "GoodToGoHistoryController" ], "responses": { "200": { "description": "GoodToGoHistory PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "GoodToGoHistory.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GoodToGoHistoryPartial" } } } }, "operationId": "GoodToGoHistoryController.updateAll" }, "get": { "x-controller-name": "GoodToGoHistoryController", "x-operation-name": "find", "tags": [ "GoodToGoHistoryController" ], "responses": { "200": { "description": "Array of GoodToGoHistory model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GoodToGoHistoryWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GoodToGoHistory.Filter1" } } } } ], "operationId": "GoodToGoHistoryController.find" } }, "/gtg-histories/{id}/shipment": { "get": { "x-controller-name": "GtgHistoryShipmentController", "x-operation-name": "getShipment", "tags": [ "GtgHistoryShipmentController" ], "responses": { "200": { "description": "Shipment belonging to GtgHistory", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Shipment" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "GtgHistoryShipmentController.getShipment" } }, "/gtg-histories/{id}/user": { "get": { "x-controller-name": "GtgHistoryUserController", "x-operation-name": "getUser", "tags": [ "GtgHistoryUserController" ], "responses": { "200": { "description": "User belonging to GtgHistory", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "GtgHistoryUserController.getUser" } }, "/import-incentive-data": { "get": { "x-controller-name": "DataImportController", "x-operation-name": "importIncentiveData", "tags": [ "DataImportController" ], "responses": { "200": { "description": "Import incentive data from qwerty to lbtms", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "importedCount": { "type": "number" }, "skippedCount": { "type": "number" }, "errorCount": { "type": "number" } } } } } } }, "operationId": "DataImportController.importIncentiveData" } }, "/import-incentive-data-status": { "get": { "x-controller-name": "DataImportController", "x-operation-name": "getImportStatus", "tags": [ "DataImportController" ], "responses": { "200": { "description": "Get import status and statistics", "content": { "application/json": { "schema": { "type": "object", "properties": { "sourceCount": { "type": "number" }, "destinationCount": { "type": "number" }, "dateRange": { "type": "object", "properties": { "startDate": { "type": "string" }, "endDate": { "type": "string" } } } } } } } } }, "operationId": "DataImportController.getImportStatus" } }, "/import-lockedincentive-from-qwerty": { "post": { "x-controller-name": "DataImportController", "x-operation-name": "importLockedIncentiveFromQwerty", "tags": [ "DataImportController" ], "responses": { "200": { "description": "Import broker_incentive_monthly rows into lbtms.lockedincentive", "content": { "application/json": { "schema": { "type": "object", "properties": { "processed": { "type": "number" }, "inserted": { "type": "number" }, "updated": { "type": "number" }, "date": { "type": "string" } } } } } } }, "parameters": [ { "name": "startDate", "in": "query", "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "schema": { "type": "string" } } ], "operationId": "DataImportController.importLockedIncentiveFromQwerty" } }, "/incentive-holds/count": { "get": { "x-controller-name": "LeadgerIncentiveController", "x-operation-name": "count", "tags": [ "LeadgerIncentiveController" ], "responses": { "200": { "description": "IncentiveHold model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "IncentiveHold.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "LeadgerIncentiveController.count" } }, "/incentive-holds/{id}/invoices": { "get": { "x-controller-name": "IncentiveHoldInvoicesController", "x-operation-name": "getInvoices", "tags": [ "IncentiveHoldInvoicesController" ], "responses": { "200": { "description": "Invoices belonging to IncentiveHold", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Invoices" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "IncentiveHoldInvoicesController.getInvoices" } }, "/incentive-margin-year-month-list": { "get": { "x-controller-name": "ReportsController", "x-operation-name": "IncentiveMarginYearMonthList", "tags": [ "ReportsController" ], "responses": { "200": { "description": "Report fetched successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } } }, "description": "\n\n| Permissions |\n| ------- |\n| view portal reports |\n", "parameters": [ { "name": "year", "in": "query", "schema": { "type": "string" }, "description": "Start date (YYYY)" } ], "operationId": "ReportsController.IncentiveMarginYearMonthList" } }, "/incentive-margin-year-wise": { "get": { "x-controller-name": "ReportsController", "x-operation-name": "IncentiveMarginYearWise", "tags": [ "ReportsController" ], "responses": { "200": { "description": "Report fetched successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } } }, "description": "\n\n| Permissions |\n| ------- |\n| view portal reports |\n", "operationId": "ReportsController.IncentiveMarginYearWise" } }, "/insert-rr-data": { "get": { "x-controller-name": "EmailMarketingController", "x-operation-name": "insertRRData", "tags": [ "EmailMarketingController" ], "responses": { "200": { "description": "Return value of EmailMarketingController.insertRRData" } }, "operationId": "EmailMarketingController.insertRRData" } }, "/insurance-document-companyname": { "get": { "x-controller-name": "ArInsuranceDocumentsController", "x-operation-name": "findInsuranceDocumentCompanyName", "tags": [ "ArInsuranceDocumentsController" ], "responses": { "200": { "description": "Array of InsuranceDocument model instances with aliased field", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InsuranceDocuments" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/insurance_documents.Filter" } } } } ], "operationId": "ArInsuranceDocumentsController.findInsuranceDocumentCompanyName" } }, "/insurance-document-type": { "get": { "x-controller-name": "ArInsuranceDocumentsController", "x-operation-name": "findInsuranceDocumentTypes", "tags": [ "ArInsuranceDocumentsController" ], "responses": { "200": { "description": "Array of InsuranceDocument model instances with aliased field", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InsuranceDocuments" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/insurance_documents.Filter" } } } } ], "operationId": "ArInsuranceDocumentsController.findInsuranceDocumentTypes" } }, "/insurance-shipment-logs/{id}/shipment": { "get": { "x-controller-name": "InsuranceShipmentLogsShipmentController", "x-operation-name": "getShipment", "tags": [ "InsuranceShipmentLogsShipmentController" ], "responses": { "200": { "description": "Shipment belonging to InsuranceShipmentLogs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Shipment" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "InsuranceShipmentLogsShipmentController.getShipment" } }, "/invoice-claimed-received": { "get": { "x-controller-name": "ArInvoicesReportControllerController", "x-operation-name": "InvoiceClaimedReceived", "tags": [ "ArInvoicesReportControllerController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar view invoices |\n", "responses": { "200": { "description": "Array of Shipment model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ShipmentWithRelations" } } } } } }, "operationId": "ArInvoicesReportControllerController.InvoiceClaimedReceived" } }, "/invoice-details/{id}": { "get": { "x-controller-name": "ArInvoicesController", "x-operation-name": "InvoiceDetail", "tags": [ "ArInvoicesController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar view invoices |\n", "responses": { "200": { "description": "Invoices model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoicesWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "ArInvoicesController.InvoiceDetail" } }, "/invoice-list": { "get": { "x-controller-name": "ArInvoicesController", "x-operation-name": "AllShippmentfind", "tags": [ "ArInvoicesController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar view invoices |\n", "responses": { "200": { "description": "Array of Shipment model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ShipmentWithRelations" } } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Shipment.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } }, { "name": "InvoiceId", "in": "query", "schema": { "type": "string" } }, { "name": "ProNo", "in": "query", "schema": { "type": "string" } }, { "name": "shippersId", "in": "query", "schema": { "type": "string" } }, { "name": "userId", "in": "query", "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "number" } }, { "name": "pageSize", "in": "query", "schema": { "type": "number" } }, { "name": "MoveTo", "in": "query", "schema": { "type": "string" } }, { "name": "subType", "in": "query", "schema": { "type": "string" } }, { "name": "AssignToShippers", "in": "query", "schema": { "type": "string" } }, { "name": "DateFrom", "in": "query", "schema": { "type": "string" } }, { "name": "DateTo", "in": "query", "schema": { "type": "string" } }, { "name": "forExport", "in": "query", "schema": { "type": "boolean" } }, { "name": "qbStatus", "in": "query", "schema": { "type": "string" } } ], "operationId": "ArInvoicesController.AllShippmentfind" } }, "/invoice-margin-report": { "get": { "x-controller-name": "PerformanceReportController", "x-operation-name": "invoiceMarginReport", "tags": [ "PerformanceReportController" ], "responses": { "200": { "description": "Return value of PerformanceReportController.invoiceMarginReport" } }, "parameters": [ { "name": "startDate", "in": "query", "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "schema": { "type": "string" } }, { "name": "forData", "in": "query", "schema": { "type": "string" } } ], "operationId": "PerformanceReportController.invoiceMarginReport" } }, "/invoice-margin-report-asi": { "get": { "x-controller-name": "PerformanceReportController", "x-operation-name": "invoiceMarginReportASI", "tags": [ "PerformanceReportController" ], "responses": { "200": { "description": "Return value of PerformanceReportController.invoiceMarginReportASI" } }, "parameters": [ { "name": "startDate", "in": "query", "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "schema": { "type": "string" } } ], "operationId": "PerformanceReportController.invoiceMarginReportASI" } }, "/invoice-payments/{id}/invoices": { "get": { "x-controller-name": "InvoicePaymentInvoicesController", "x-operation-name": "getInvoices", "tags": [ "InvoicePaymentInvoicesController" ], "responses": { "200": { "description": "Invoices belonging to InvoicePayment", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Invoices" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "InvoicePaymentInvoicesController.getInvoices" } }, "/invoice-payments/{id}/user": { "get": { "x-controller-name": "InvoicePaymentUserController", "x-operation-name": "getUser", "tags": [ "InvoicePaymentUserController" ], "responses": { "200": { "description": "User belonging to InvoicePayment", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "InvoicePaymentUserController.getUser" } }, "/invoiced-pay-count": { "get": { "x-controller-name": "BrokerHomeController", "x-operation-name": "InvoicedPayCount", "tags": [ "BrokerHomeController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker view dashboard |\n", "responses": { "200": { "description": "Shipment model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoicesWithRelations" } } } } }, "parameters": [ { "name": "type", "in": "query", "schema": { "type": "string" } } ], "operationId": "BrokerHomeController.InvoicedPayCount" } }, "/invoices/{id}/invoice-payments": { "post": { "x-controller-name": "InvoicesInvoicePaymentController", "x-operation-name": "create", "tags": [ "InvoicesInvoicePaymentController" ], "responses": { "200": { "description": "Invoices model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoicePayment" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewInvoicePaymentInInvoices" } } }, "x-parameter-index": 1 }, "operationId": "InvoicesInvoicePaymentController.create" }, "patch": { "x-controller-name": "InvoicesInvoicePaymentController", "x-operation-name": "patch", "tags": [ "InvoicesInvoicePaymentController" ], "responses": { "200": { "description": "Invoices.InvoicePayment PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "InvoicePayment.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoicePaymentPartial" } } }, "x-parameter-index": 1 }, "operationId": "InvoicesInvoicePaymentController.patch" }, "get": { "x-controller-name": "InvoicesInvoicePaymentController", "x-operation-name": "find", "tags": [ "InvoicesInvoicePaymentController" ], "responses": { "200": { "description": "Array of Invoices has many InvoicePayment", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InvoicePayment" } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } ], "operationId": "InvoicesInvoicePaymentController.find" }, "delete": { "x-controller-name": "InvoicesInvoicePaymentController", "x-operation-name": "delete", "tags": [ "InvoicesInvoicePaymentController" ], "responses": { "200": { "description": "Invoices.InvoicePayment DELETE success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "InvoicePayment.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "InvoicesInvoicePaymentController.delete" } }, "/invoices/{id}/invoice-payments-history": { "get": { "x-controller-name": "InvoicesInvoicePaymentController", "x-operation-name": "findInvoicePaymentHistory", "tags": [ "InvoicesInvoicePaymentController" ], "responses": { "200": { "description": "Array of Invoices has many InvoicePayment", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InvoicePayment" } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "InvoicesInvoicePaymentController.findInvoicePaymentHistory" } }, "/invoices/{id}/portal": { "get": { "x-controller-name": "InvoicesPortalController", "x-operation-name": "getPortal", "tags": [ "InvoicesPortalController" ], "responses": { "200": { "description": "Portal belonging to Invoices", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Portal" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "InvoicesPortalController.getPortal" } }, "/invoices/{id}/shipment": { "get": { "x-controller-name": "InvoicesShipmentController", "x-operation-name": "getShipment", "tags": [ "InvoicesShipmentController" ], "responses": { "200": { "description": "Shipment belonging to Invoices", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Shipment" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "InvoicesShipmentController.getShipment" } }, "/invoices/{id}/shippers": { "get": { "x-controller-name": "InvoicesShippersController", "x-operation-name": "getShippers", "tags": [ "InvoicesShippersController" ], "responses": { "200": { "description": "Shippers belonging to Invoices", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Shippers" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "InvoicesShippersController.getShippers" } }, "/invoices/{id}/user": { "get": { "x-controller-name": "InvoicesUserController", "x-operation-name": "getUser", "tags": [ "InvoicesUserController" ], "responses": { "200": { "description": "User belonging to Invoices", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "InvoicesUserController.getUser" } }, "/invoiceshistories/{id}/invoices": { "get": { "x-controller-name": "InvoiceshistoryInvoicesController", "x-operation-name": "getInvoices", "tags": [ "InvoiceshistoryInvoicesController" ], "responses": { "200": { "description": "Invoices belonging to Invoiceshistory", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Invoices" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "InvoiceshistoryInvoicesController.getInvoices" } }, "/invoiceshistories/{id}/shipment": { "get": { "x-controller-name": "InvoiceshistoryShipmentController", "x-operation-name": "getShipment", "tags": [ "InvoiceshistoryShipmentController" ], "responses": { "200": { "description": "Shipment belonging to Invoiceshistory", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Shipment" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "InvoiceshistoryShipmentController.getShipment" } }, "/invoiceshistories/{id}/shippers": { "get": { "x-controller-name": "InvoiceshistoryShippersController", "x-operation-name": "getShippers", "tags": [ "InvoiceshistoryShippersController" ], "responses": { "200": { "description": "Shippers belonging to Invoiceshistory", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Shippers" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "InvoiceshistoryShippersController.getShippers" } }, "/invoiceshistories/{id}/user": { "get": { "x-controller-name": "InvoiceshistoryUserController", "x-operation-name": "getUser", "tags": [ "InvoiceshistoryUserController" ], "responses": { "200": { "description": "User belonging to Invoiceshistory", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "InvoiceshistoryUserController.getUser" } }, "/latest-apple-build": { "get": { "x-controller-name": "MobileAppController", "x-operation-name": "getLatestTestFlight", "tags": [ "MobileAppController" ], "responses": { "200": { "description": "Fetch latest TestFlight build", "content": { "application/json": { "schema": { "type": "object" } } } } }, "operationId": "MobileAppController.getLatestTestFlight" } }, "/leadger-incentive/incentive-holds": { "get": { "x-controller-name": "LeadgerIncentiveController", "x-operation-name": "incentiveHolds", "tags": [ "LeadgerIncentiveController" ], "responses": { "200": { "description": "Array of IncentiveHold model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/IncentiveHoldWithRelations" } } } } } }, "operationId": "LeadgerIncentiveController.incentiveHolds" } }, "/limit-modify-shippers/{id}/shippers": { "get": { "x-controller-name": "LimitModifyShipperShippersController", "x-operation-name": "getShippers", "tags": [ "LimitModifyShipperShippersController" ], "responses": { "200": { "description": "Shippers belonging to LimitModifyShipper", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Shippers" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "LimitModifyShipperShippersController.getShippers" } }, "/limit-modify-shippers/{id}/user": { "get": { "x-controller-name": "LimitModifyShipperUserController", "x-operation-name": "getUser", "tags": [ "LimitModifyShipperUserController" ], "responses": { "200": { "description": "User belonging to LimitModifyShipper", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "LimitModifyShipperUserController.getUser" } }, "/limit-request": { "post": { "x-controller-name": "ArshipperLimitController", "x-operation-name": "limitRequest", "tags": [ "ArshipperLimitController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker create shipment |\n", "responses": { "200": { "description": "Return value of ArshipperLimitController.limitRequest", "content": {} }, "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Shipper Limit PATCH success" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "approval_limit", "type" ], "properties": { "id": { "type": "string" }, "approval_limit": { "type": "number", "nullable": true, "maximum": 100000 }, "type": { "type": "number" }, "reason_ar": { "type": "string", "nullable": true, "maximum": 20000 } } } } } }, "operationId": "ArshipperLimitController.limitRequest" } }, "/load/reset/byBroker/{id}": { "patch": { "x-controller-name": "ShipmentController", "x-operation-name": "updateByIdNew", "tags": [ "ShipmentController" ], "responses": { "200": { "description": "Load Reset successfully", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "ShipmentController.updateByIdNew" } }, "/load/resetBeforeCpr/byBroker/{id}": { "patch": { "x-controller-name": "ShipmentController", "x-operation-name": "updateLoadConformationBeforeCPr", "tags": [ "ShipmentController" ], "responses": { "200": { "description": "Load Reset successfully", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "ShipmentController.updateLoadConformationBeforeCPr" } }, "/load-comments/{id}/loads": { "get": { "x-controller-name": "LoadCommentsLoadsController", "x-operation-name": "getLoads", "tags": [ "LoadCommentsLoadsController" ], "responses": { "200": { "description": "Loads belonging to LoadComments", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Loads" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "LoadCommentsLoadsController.getLoads" } }, "/load-comments/{id}/user": { "get": { "x-controller-name": "LoadCommentsUserController", "x-operation-name": "getUser", "tags": [ "LoadCommentsUserController" ], "responses": { "200": { "description": "User belonging to LoadComments", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "LoadCommentsUserController.getUser" } }, "/load-comments/{id}": { "get": { "x-controller-name": "CommonSearchController", "x-operation-name": "getLoads", "tags": [ "CommonSearchController" ], "responses": { "200": { "description": "LoadComments belonging to LoadComments", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoadComments" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "CommonSearchController.getLoads" } }, "/load-comments-add": { "post": { "x-controller-name": "CommonSearchController", "x-operation-name": "CreateLoadComment", "tags": [ "CommonSearchController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker view dashboard |\n", "responses": { "200": { "description": "Load Commnet model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Shipment" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "loadsId", "comment" ], "properties": { "loadsId": { "type": "number" }, "comment": { "type": "string" } } } } } }, "operationId": "CommonSearchController.CreateLoadComment" } }, "/loads/copy": { "post": { "x-controller-name": "LoadsController", "x-operation-name": "copyLoad", "tags": [ "LoadsController" ], "description": "", "responses": { "200": { "description": "Loads model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Loads" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewLoads" } } } }, "operationId": "LoadsController.copyLoad" } }, "/loads/count": { "get": { "x-controller-name": "LoadsController", "x-operation-name": "count", "tags": [ "LoadsController" ], "responses": { "200": { "description": "Loads model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Loads.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "LoadsController.count" } }, "/loads/dat/delete/via/rest/api/{id}": { "patch": { "x-controller-name": "LoadsController", "x-operation-name": "datDeleteLoadViaRestApi", "tags": [ "LoadsController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker all loads list |\n", "responses": { "200": { "description": "Return value of LoadsController.datDeleteLoadViaRestApi", "content": {} }, "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Loads PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoadsPartial" } } }, "x-parameter-index": 1 }, "operationId": "LoadsController.datDeleteLoadViaRestApi" } }, "/loads/dat/refresh/via/rest/api/{id}": { "patch": { "x-controller-name": "LoadsController", "x-operation-name": "datRefreshLoadViaRestApi", "tags": [ "LoadsController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker all loads list |\n", "responses": { "200": { "description": "Return value of LoadsController.datRefreshLoadViaRestApi", "content": {} }, "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Loads PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoadsPartial" } } }, "x-parameter-index": 1 }, "operationId": "LoadsController.datRefreshLoadViaRestApi" } }, "/loads/internal": { "get": { "x-controller-name": "LoadsController", "x-operation-name": "findInternalLoads", "tags": [ "LoadsController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker all loads list |\n", "responses": { "200": { "description": "Array of Loads model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LoadsWithRelations" } } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Loads.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "LoadsController.findInternalLoads" } }, "/loads/on/dat/via/rest/api": { "post": { "x-controller-name": "LoadsController", "x-operation-name": "loadsOnDatViaRestApi", "tags": [ "LoadsController" ], "description": "", "responses": { "200": { "description": "Loads model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Loads" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewLoads" } } } }, "operationId": "LoadsController.loadsOnDatViaRestApi" } }, "/loads/{id}/commodities": { "get": { "x-controller-name": "LoadsCommoditiesController", "x-operation-name": "getCommodities", "tags": [ "LoadsCommoditiesController" ], "responses": { "200": { "description": "Commodities belonging to Loads", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Commodities" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "LoadsCommoditiesController.getCommodities" } }, "/loads/{id}/equipment": { "get": { "x-controller-name": "LoadsEquipmentController", "x-operation-name": "getEquipment", "tags": [ "LoadsEquipmentController" ], "responses": { "200": { "description": "Equipment belonging to Loads", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Equipment" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "LoadsEquipmentController.getEquipment" } }, "/loads/{id}/load-comments": { "post": { "x-controller-name": "LoadsLoadCommentsController", "x-operation-name": "create", "tags": [ "LoadsLoadCommentsController" ], "responses": { "200": { "description": "Loads model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoadComments" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewLoadCommentsInLoads" } } }, "x-parameter-index": 1 }, "operationId": "LoadsLoadCommentsController.create" }, "patch": { "x-controller-name": "LoadsLoadCommentsController", "x-operation-name": "patch", "tags": [ "LoadsLoadCommentsController" ], "responses": { "200": { "description": "Loads.LoadComments PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "LoadComments.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoadCommentsPartial" } } }, "x-parameter-index": 1 }, "operationId": "LoadsLoadCommentsController.patch" }, "get": { "x-controller-name": "LoadsLoadCommentsController", "x-operation-name": "find", "tags": [ "LoadsLoadCommentsController" ], "responses": { "200": { "description": "Array of Loads has many LoadComments", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LoadComments" } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } ], "operationId": "LoadsLoadCommentsController.find" }, "delete": { "x-controller-name": "LoadsLoadCommentsController", "x-operation-name": "delete", "tags": [ "LoadsLoadCommentsController" ], "responses": { "200": { "description": "Loads.LoadComments DELETE success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "LoadComments.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "LoadsLoadCommentsController.delete" } }, "/loads/{id}/user": { "get": { "x-controller-name": "LoadsUserController", "x-operation-name": "getUser", "tags": [ "LoadsUserController" ], "responses": { "200": { "description": "User belonging to Loads", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "LoadsUserController.getUser" } }, "/loads/{id}/zip-codes": { "get": { "x-controller-name": "LoadsZipCodesController", "x-operation-name": "getZipCodes", "tags": [ "LoadsZipCodesController" ], "responses": { "200": { "description": "ZipCodes belonging to Loads", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ZipCodes" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "LoadsZipCodesController.getZipCodes" } }, "/loads/{id}": { "put": { "x-controller-name": "LoadsController", "x-operation-name": "replaceById", "tags": [ "LoadsController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Loads PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Loads" } } }, "x-parameter-index": 1 }, "operationId": "LoadsController.replaceById" }, "patch": { "x-controller-name": "LoadsController", "x-operation-name": "updateById", "tags": [ "LoadsController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker all loads list |\n", "responses": { "200": { "description": "Return value of LoadsController.updateById", "content": {} }, "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Loads PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoadsPartial" } } }, "x-parameter-index": 1 }, "operationId": "LoadsController.updateById" }, "get": { "x-controller-name": "LoadsController", "x-operation-name": "findById", "tags": [ "LoadsController" ], "responses": { "200": { "description": "Loads model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoadsWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "LoadsController.findById" }, "delete": { "x-controller-name": "LoadsController", "x-operation-name": "deleteById", "tags": [ "LoadsController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Loads DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "LoadsController.deleteById" } }, "/loads": { "post": { "x-controller-name": "LoadsController", "x-operation-name": "create", "tags": [ "LoadsController" ], "description": "", "responses": { "200": { "description": "Loads model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Loads" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewLoads" } } } }, "operationId": "LoadsController.create" }, "patch": { "x-controller-name": "LoadsController", "x-operation-name": "updateAll", "tags": [ "LoadsController" ], "responses": { "200": { "description": "Loads PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Loads.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoadsPartial" } } } }, "operationId": "LoadsController.updateAll" }, "get": { "x-controller-name": "LoadsController", "x-operation-name": "find", "tags": [ "LoadsController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker all loads list |\n", "responses": { "200": { "description": "Array of Loads model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LoadsWithRelations" } } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Loads.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "LoadsController.find" } }, "/loadtrack/locationupdate": { "post": { "x-controller-name": "TruckerToolsWebhookController", "x-operation-name": "handleLocationUpdate", "tags": [ "TruckerToolsWebhookController" ], "responses": { "200": { "description": "Webhook Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "TruckerToolsWebhookController.handleLocationUpdate" } }, "/loadtrack/statusupdate": { "post": { "x-controller-name": "TruckerToolsWebhookController", "x-operation-name": "handleStatusUpdate", "tags": [ "TruckerToolsWebhookController" ], "responses": { "200": { "description": "Webhook Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "TruckerToolsWebhookController.handleStatusUpdate" } }, "/lock/drayage/incentives/pro/withnewpolicy/final": { "get": { "x-controller-name": "DatratemateController", "x-operation-name": "UpdateVLDrayageFinalIncentivesPro", "tags": [ "DatratemateController" ], "responses": { "200": { "description": "Return value of DatratemateController.UpdateVLDrayageFinalIncentivesPro" } }, "operationId": "DatratemateController.UpdateVLDrayageFinalIncentivesPro" } }, "/lock/drayage/incentives/pro/withnewpolicy": { "get": { "x-controller-name": "DatratemateController", "x-operation-name": "UpdateVLDrayageIncentivesPro", "tags": [ "DatratemateController" ], "responses": { "200": { "description": "Return value of DatratemateController.UpdateVLDrayageIncentivesPro" } }, "operationId": "DatratemateController.UpdateVLDrayageIncentivesPro" } }, "/lock/drayage/incentives/tonu/shipments": { "get": { "x-controller-name": "DatratemateController", "x-operation-name": "UpdateVLDrayageIncentivesTonuShipments", "tags": [ "DatratemateController" ], "responses": { "200": { "description": "Return value of DatratemateController.UpdateVLDrayageIncentivesTonuShipments" } }, "operationId": "DatratemateController.UpdateVLDrayageIncentivesTonuShipments" } }, "/lock/otr/incentives/pro/withnewpolicy/step2": { "get": { "x-controller-name": "DatratemateController", "x-operation-name": "LockOTRIncentivesProWithNewPolicyStep2", "tags": [ "DatratemateController" ], "responses": { "200": { "description": "Return value of DatratemateController.LockOTRIncentivesProWithNewPolicyStep2" } }, "operationId": "DatratemateController.LockOTRIncentivesProWithNewPolicyStep2" } }, "/lock/otr/incentives/pro/withnewpolicy/step3": { "get": { "x-controller-name": "DatratemateController", "x-operation-name": "LockOTRIncentivesProWithNewPolicyStep3", "tags": [ "DatratemateController" ], "responses": { "200": { "description": "Return value of DatratemateController.LockOTRIncentivesProWithNewPolicyStep3" } }, "operationId": "DatratemateController.LockOTRIncentivesProWithNewPolicyStep3" } }, "/lock/otr/incentives/pro/withnewpolicy": { "get": { "x-controller-name": "DatratemateController", "x-operation-name": "LockOTRIncentivesProWithNewPolicy", "tags": [ "DatratemateController" ], "responses": { "200": { "description": "Return value of DatratemateController.LockOTRIncentivesProWithNewPolicy" } }, "operationId": "DatratemateController.LockOTRIncentivesProWithNewPolicy" } }, "/locked-otr-incentive-monthly": { "get": { "x-controller-name": "ReportsController", "x-operation-name": "getLockedOtrIncentiveMonthly", "tags": [ "ReportsController" ], "responses": { "200": { "description": "Locked OTR Incentive data grouped by employee and month", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "additionalProperties": true } } } } } }, "description": "", "operationId": "ReportsController.getLockedOtrIncentiveMonthly" } }, "/manage-all-shipper": { "get": { "x-controller-name": "ArshipperLimitController", "x-operation-name": "manage_all_shippers", "tags": [ "ArshipperLimitController" ], "responses": { "200": { "description": "Array of User has many Shippers", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Shippers" } } } } } }, "description": "\n\n| Permissions |\n| ------- |\n| ar view shipper limit |\n", "operationId": "ArshipperLimitController.manage_all_shippers" } }, "/manager-month-till-date-report": { "get": { "x-controller-name": "ReportsController", "x-operation-name": "getManagerMonthSummaryAll", "tags": [ "ReportsController" ], "responses": { "200": { "description": "Manager margin and shipment summary for all managers for a given month", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } } } } } }, "description": "\n\n| Permissions |\n| ------- |\n| view portal reports |\n", "parameters": [ { "name": "date", "in": "query", "schema": { "type": "string" }, "required": true, "description": "Month in YYYY-MM format" }, { "name": "to", "in": "query", "schema": { "type": "string" }, "required": false, "description": "Month in YYYY-MM format" }, { "name": "subject", "in": "query", "schema": { "type": "string" }, "required": false, "description": "Month in YYYY-MM format" }, { "name": "export", "in": "query", "schema": { "type": "boolean" }, "required": false, "description": "Export as CSV" }, { "name": "process", "in": "query", "schema": { "type": "string" } } ], "operationId": "ReportsController.getManagerMonthSummaryAll" } }, "/manager-month-till-date-report-export": { "get": { "x-controller-name": "ReportsController", "x-operation-name": "getManagerMonthSummaryAllExport", "tags": [ "ReportsController" ], "responses": { "200": { "description": "Manager margin and shipment summary for all managers for a given month", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } } } } } }, "parameters": [ { "name": "date", "in": "query", "schema": { "type": "string" }, "required": true, "description": "Month in YYYY-MM format" }, { "name": "to", "in": "query", "schema": { "type": "string" }, "required": false, "description": "Recipient email(s). Can be a single email or an array of strings." }, { "name": "subject", "in": "query", "schema": { "type": "string" }, "required": false, "description": "Month in YYYY-MM format" }, { "name": "export", "in": "query", "schema": { "type": "boolean" }, "required": false, "description": "Export as CSV" }, { "name": "process", "in": "query", "schema": { "type": "string" } }, { "name": "portalId", "in": "query", "schema": { "type": "string" }, "required": false, "description": "Portal ID" } ], "operationId": "ReportsController.getManagerMonthSummaryAllExport" } }, "/margin-analytics/monthly-comparison": { "get": { "x-controller-name": "ReportsController", "x-operation-name": "getMonthlyMarginComparison", "tags": [ "ReportsController" ], "description": "", "responses": { "200": { "description": "Get monthly margin data for last 3 years comparison", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "month": { "type": "string" }, "additionalProperties": { "type": "number" } } } } } } } }, "operationId": "ReportsController.getMonthlyMarginComparison" } }, "/mc/detail/{intB}": { "get": { "x-controller-name": "TruckstopController", "x-operation-name": "get", "tags": [ "TruckstopController" ], "responses": { "200": { "description": "Return value of TruckstopController.get" } }, "parameters": [ { "name": "intB", "in": "path", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "operationId": "TruckstopController.get" } }, "/mc-approve-by-email/{id}": { "get": { "x-controller-name": "McVerificationController", "x-operation-name": "MCApproveByEmailManagers", "tags": [ "McVerificationController" ], "responses": { "200": { "description": "McVerification model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/McVerificationWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "McVerificationController.MCApproveByEmailManagers" } }, "/mc-checked-by-sme/{id}": { "get": { "x-controller-name": "McVerificationController", "x-operation-name": "McCheckedBySme", "tags": [ "McVerificationController" ], "description": "\n\n| Permissions |\n| ------- |\n| sme view mcapprove |\n", "responses": { "200": { "description": "McVerification model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/McVerificationWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "McVerificationController.McCheckedBySme" } }, "/mc-checking-for-declined": { "get": { "x-controller-name": "McVerificationController", "x-operation-name": "mcDeclinedBySmeTeam", "tags": [ "McVerificationController" ], "responses": { "200": { "description": "Array of CprRequest model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CprRequestWithRelations" } } } } } }, "description": "\n\n| Permissions |\n| ------- |\n| sme view dashboard |\n", "parameters": [ { "name": "id", "in": "query", "schema": { "type": "string" } } ], "operationId": "McVerificationController.mcDeclinedBySmeTeam" } }, "/mc-cpr-checking-by-details": { "get": { "x-controller-name": "McVerificationController", "x-operation-name": "mcCprCheckingBy", "tags": [ "McVerificationController" ], "responses": { "200": { "description": "Array of CprRequest model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CprRequestWithRelations" } } } } } }, "description": "\n\n| Permissions |\n| ------- |\n| sme view dashboard |\n", "parameters": [ { "name": "type", "in": "query", "schema": { "type": "string" } }, { "name": "id", "in": "query", "schema": { "type": "string" } } ], "operationId": "McVerificationController.mcCprCheckingBy" } }, "/mc-cpr-checking-by-details-second-time": { "get": { "x-controller-name": "McVerificationController", "x-operation-name": "mcCprCheckingBySecondTime", "tags": [ "McVerificationController" ], "responses": { "200": { "description": "Array of CprRequest model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CprRequestWithRelations" } } } } } }, "description": "\n\n| Permissions |\n| ------- |\n| sme view dashboard |\n", "parameters": [ { "name": "type", "in": "query", "schema": { "type": "string" } }, { "name": "id", "in": "query", "schema": { "type": "string" } } ], "operationId": "McVerificationController.mcCprCheckingBySecondTime" } }, "/mc-declined-by-sme-team-first-time": { "get": { "x-controller-name": "McVerificationController", "x-operation-name": "mcDeclinedBySmeTeamFirstTime", "tags": [ "McVerificationController" ], "responses": { "200": { "description": "Array of CprRequest model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CprRequestWithRelations" } } } } } }, "description": "\n\n| Permissions |\n| ------- |\n| sme view dashboard |\n", "parameters": [ { "name": "id", "in": "query", "schema": { "type": "string" } } ], "operationId": "McVerificationController.mcDeclinedBySmeTeamFirstTime" } }, "/mc-disapproved-by-email/{id}": { "get": { "x-controller-name": "McVerificationController", "x-operation-name": "MCDisapprovedByEmailManagers", "tags": [ "McVerificationController" ], "responses": { "200": { "description": "McVerification model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/McVerificationWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "McVerificationController.MCDisapprovedByEmailManagers" } }, "/mc-exception-weekend-emails/count": { "get": { "x-controller-name": "McExceptionWeekendEmailController", "x-operation-name": "count", "tags": [ "McExceptionWeekendEmailController" ], "responses": { "200": { "description": "McExceptionWeekendEmail model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "McExceptionWeekendEmail.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "McExceptionWeekendEmailController.count" } }, "/mc-exception-weekend-emails/create": { "post": { "x-controller-name": "McExceptionWeekendEmailController", "x-operation-name": "create", "tags": [ "McExceptionWeekendEmailController" ], "responses": { "200": { "description": "McExceptionWeekendEmail model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/McExceptionWeekendEmail" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewMcExceptionWeekendEmail" } } } }, "operationId": "McExceptionWeekendEmailController.create" } }, "/mc-exception-weekend-emails/latest": { "get": { "x-controller-name": "McExceptionWeekendEmailController", "x-operation-name": "findLatestByDrayageAndPortal", "tags": [ "McExceptionWeekendEmailController" ], "responses": { "200": { "description": "Get latest McExceptionWeekendEmail by drayage and portalId", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/McExceptionWeekendEmailWithRelations" } } } } }, "parameters": [ { "name": "drayage", "in": "query", "schema": { "type": "number" } }, { "name": "portalId", "in": "query", "schema": { "type": "number" } } ], "operationId": "McExceptionWeekendEmailController.findLatestByDrayageAndPortal" } }, "/mc-exception-weekend-emails/{id}": { "put": { "x-controller-name": "McExceptionWeekendEmailController", "x-operation-name": "replaceById", "tags": [ "McExceptionWeekendEmailController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "McExceptionWeekendEmail PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/McExceptionWeekendEmail" } } }, "x-parameter-index": 1 }, "operationId": "McExceptionWeekendEmailController.replaceById" }, "patch": { "x-controller-name": "McExceptionWeekendEmailController", "x-operation-name": "updateById", "tags": [ "McExceptionWeekendEmailController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "McExceptionWeekendEmail PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/McExceptionWeekendEmailPartial" } } }, "x-parameter-index": 1 }, "operationId": "McExceptionWeekendEmailController.updateById" }, "get": { "x-controller-name": "McExceptionWeekendEmailController", "x-operation-name": "findById", "tags": [ "McExceptionWeekendEmailController" ], "responses": { "200": { "description": "McExceptionWeekendEmail model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/McExceptionWeekendEmailWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/McExceptionWeekendEmail.Filter" } } } } ], "operationId": "McExceptionWeekendEmailController.findById" }, "delete": { "x-controller-name": "McExceptionWeekendEmailController", "x-operation-name": "deleteById", "tags": [ "McExceptionWeekendEmailController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "McExceptionWeekendEmail DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "McExceptionWeekendEmailController.deleteById" } }, "/mc-exception-weekend-emails": { "patch": { "x-controller-name": "McExceptionWeekendEmailController", "x-operation-name": "updateAll", "tags": [ "McExceptionWeekendEmailController" ], "responses": { "200": { "description": "McExceptionWeekendEmail PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "McExceptionWeekendEmail.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/McExceptionWeekendEmailPartial" } } } }, "operationId": "McExceptionWeekendEmailController.updateAll" }, "get": { "x-controller-name": "McExceptionWeekendEmailController", "x-operation-name": "find", "tags": [ "McExceptionWeekendEmailController" ], "responses": { "200": { "description": "Array of McExceptionWeekendEmail model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/McExceptionWeekendEmailWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/McExceptionWeekendEmail.Filter1" } } } } ], "operationId": "McExceptionWeekendEmailController.find" } }, "/mc-list": { "get": { "x-controller-name": "SmeReportControllerController", "x-operation-name": "findas", "tags": [ "SmeReportControllerController" ], "description": "\n\n| Permissions |\n| ------- |\n| sme view dashboard |\n| sme view mc list |\n", "responses": { "200": { "description": "Array of McVerification model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/McVerificationWithRelations" } } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "McVerification.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } }, { "name": "mcNumber", "in": "query", "schema": { "type": "string" } }, { "name": "dotNumber", "in": "query", "schema": { "type": "string" } }, { "name": "status", "in": "query", "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "number" } }, { "name": "pageSize", "in": "query", "schema": { "type": "number" } } ], "operationId": "SmeReportControllerController.findas" } }, "/mc-re-verifications/{id}/shipment": { "get": { "x-controller-name": "McReVerificationShipmentController", "x-operation-name": "getShipment", "tags": [ "McReVerificationShipmentController" ], "responses": { "200": { "description": "Shipment belonging to McReVerification", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Shipment" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "McReVerificationShipmentController.getShipment" } }, "/mc-remove-processing-by-sme/{id}": { "get": { "x-controller-name": "McVerificationController", "x-operation-name": "McRemoveProcessing", "tags": [ "McVerificationController" ], "description": "\n\n| Permissions |\n| ------- |\n| sme view mcapprove |\n", "responses": { "200": { "description": "McVerification model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/McVerificationWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "McVerificationController.McRemoveProcessing" } }, "/mc-verification-block-list": { "get": { "x-controller-name": "McVerificationController", "x-operation-name": "findMcBlockVerification", "tags": [ "McVerificationController" ], "description": "\n\n| Permissions |\n| ------- |\n| sme view dashboard |\n", "responses": { "200": { "description": "Array of McVerification model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/McVerificationWithRelations" } } } } } }, "operationId": "McVerificationController.findMcBlockVerification" } }, "/mc-verification-list": { "get": { "x-controller-name": "McVerificationController", "x-operation-name": "findMcVerification", "tags": [ "McVerificationController" ], "description": "\n\n| Permissions |\n| ------- |\n| sme view dashboard |\n", "responses": { "200": { "description": "Array of McVerification model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/McVerificationWithRelations" } } } } } }, "operationId": "McVerificationController.findMcVerification" } }, "/mc-verifications/count": { "get": { "x-controller-name": "McVerificationController", "x-operation-name": "count", "tags": [ "McVerificationController" ], "description": "\n\n| Permissions |\n| ------- |\n| sme view dashboard |\n", "responses": { "200": { "description": "McVerification model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "McVerification.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "McVerificationController.count" } }, "/mc-verifications/{id}/user": { "get": { "x-controller-name": "McVerificationUserController", "x-operation-name": "getUser", "tags": [ "McVerificationUserController" ], "responses": { "200": { "description": "User belonging to McVerification", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "McVerificationUserController.getUser" } }, "/mc-verifications/{id}/{type}": { "get": { "x-controller-name": "McVerificationController", "x-operation-name": "findById", "tags": [ "McVerificationController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker send mc request |\n", "responses": { "200": { "description": "McVerification model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/McVerificationWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "type", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "McVerificationController.findById" } }, "/mc-verifications/{id}": { "put": { "x-controller-name": "McVerificationController", "x-operation-name": "replaceById", "tags": [ "McVerificationController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "McVerification PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/McVerification" } } }, "x-parameter-index": 1 }, "operationId": "McVerificationController.replaceById" }, "patch": { "x-controller-name": "McVerificationController", "x-operation-name": "updateById", "tags": [ "McVerificationController" ], "description": "\n\n| Permissions |\n| ------- |\n| sme view mcapprove |\n", "responses": { "200": { "description": "Return value of McVerificationController.updateById", "content": {} }, "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "McVerification PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/McVerificationPartial" } } }, "x-parameter-index": 1 }, "operationId": "McVerificationController.updateById" }, "delete": { "x-controller-name": "McVerificationController", "x-operation-name": "deleteById", "tags": [ "McVerificationController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "McVerification DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "McVerificationController.deleteById" } }, "/mc-verifications": { "post": { "x-controller-name": "McVerificationController", "x-operation-name": "create", "tags": [ "McVerificationController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker send mc request |\n", "responses": { "200": { "description": "McVerification model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/McVerification" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewMcVerification" } } } }, "operationId": "McVerificationController.create" }, "patch": { "x-controller-name": "McVerificationController", "x-operation-name": "updateAll", "tags": [ "McVerificationController" ], "responses": { "200": { "description": "McVerification PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "McVerification.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/McVerificationPartial" } } } }, "operationId": "McVerificationController.updateAll" }, "get": { "x-controller-name": "McVerificationController", "x-operation-name": "find", "tags": [ "McVerificationController" ], "description": "\n\n| Permissions |\n| ------- |\n| sme view dashboard |\n", "responses": { "200": { "description": "Array of McVerification model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/McVerificationWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/McVerification.Filter" } } } } ], "operationId": "McVerificationController.find" } }, "/mc-verifications-sme/{id}": { "get": { "x-controller-name": "McVerificationController", "x-operation-name": "get", "tags": [ "McVerificationController" ], "description": "\n\n| Permissions |\n| ------- |\n| sme view mcapprove |\n", "responses": { "200": { "description": "McVerification model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/McVerificationWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "McVerificationController.get" } }, "/month-till-date-report": { "get": { "x-controller-name": "ReportsController", "x-operation-name": "getMonthlyMarginSummary", "tags": [ "ReportsController" ], "responses": { "200": { "description": "Monthly margin summary for last 6 months or given date range", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } } } } } }, "description": "\n\n| Permissions |\n| ------- |\n| view portal reports |\n", "parameters": [ { "name": "date", "in": "query", "schema": { "type": "string" } }, { "name": "to", "in": "query", "schema": { "type": "string" } }, { "name": "process", "in": "query", "schema": { "type": "string" } }, { "name": "subject", "in": "query", "schema": { "type": "string" } }, { "name": "export", "in": "query", "schema": { "type": "boolean" }, "required": false, "description": "Export as CSV" } ], "operationId": "ReportsController.getMonthlyMarginSummary" } }, "/month-till-date-report-new": { "get": { "x-controller-name": "BrokerReportsController", "x-operation-name": "getMonthlyMarginSummaryNew", "tags": [ "BrokerReportsController" ], "responses": { "200": { "description": "Monthly margin summary for last 6 months or given date range", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } } } } } }, "description": "", "parameters": [ { "name": "date", "in": "query", "schema": { "type": "string" } } ], "operationId": "BrokerReportsController.getMonthlyMarginSummaryNew" } }, "/month-till-date-report-new-user": { "get": { "x-controller-name": "BrokerReportsController", "x-operation-name": "getMonthlyMarginSummaryNewUser", "tags": [ "BrokerReportsController" ], "responses": { "200": { "description": "Monthly margin summary for last 6 months or given date range", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } } } } } }, "description": "", "parameters": [ { "name": "date", "in": "query", "schema": { "type": "string" } } ], "operationId": "BrokerReportsController.getMonthlyMarginSummaryNewUser" } }, "/monthly-performance": { "get": { "x-controller-name": "PerformanceReportController", "x-operation-name": "getMonthlySummary", "tags": [ "PerformanceReportController" ], "responses": { "200": { "description": "Return value of PerformanceReportController.getMonthlySummary" } }, "parameters": [ { "name": "startDate", "in": "query", "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "schema": { "type": "string" } }, { "name": "teamLeadId", "in": "query", "schema": { "type": "number" } } ], "operationId": "PerformanceReportController.getMonthlySummary" } }, "/monthly-performance-all": { "get": { "x-controller-name": "PerformanceReportController", "x-operation-name": "getMonthlySummaryAll", "tags": [ "PerformanceReportController" ], "description": "", "responses": { "200": { "description": "Return value of PerformanceReportController.getMonthlySummaryAll", "content": {} } }, "parameters": [ { "name": "startDate", "in": "query", "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "schema": { "type": "string" } } ], "operationId": "PerformanceReportController.getMonthlySummaryAll" } }, "/monthly-performance-export": { "get": { "x-controller-name": "PerformanceReportController", "x-operation-name": "getMonthlySummaryExport", "tags": [ "PerformanceReportController" ], "responses": { "200": { "description": "Return value of PerformanceReportController.getMonthlySummaryExport" } }, "parameters": [ { "name": "startDate", "in": "query", "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "schema": { "type": "string" } } ], "operationId": "PerformanceReportController.getMonthlySummaryExport" } }, "/multi-payment-selected-pros": { "post": { "x-controller-name": "CarrierPaymentController", "x-operation-name": "multiPaymentSelectedPros", "tags": [ "CarrierPaymentController" ], "description": "\n\n| Permissions |\n| ------- |\n| ap carrier payment |\n", "responses": { "200": { "description": "Array of CarrierPayment model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CarrierPaymentWithRelations" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "shipmentIds": { "type": "array", "items": { "type": "string" }, "description": "Array of shipment IDs to include in the response" } }, "required": [ "shipmentIds" ] } } } }, "operationId": "CarrierPaymentController.multiPaymentSelectedPros" } }, "/multiple-send-loads-shipments-broker": { "post": { "x-controller-name": "ShipmentController", "x-operation-name": "updateMultipleLoadConfirmation", "tags": [ "ShipmentController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker create shipment |\n", "responses": { "200": { "description": "Return value of ShipmentController.updateMultipleLoadConfirmation", "content": {} }, "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Multiple Shippers PUT success" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "ShipmentController.updateMultipleLoadConfirmation" } }, "/multiple-upload-images": { "post": { "x-controller-name": "CommonfileuploadController", "x-operation-name": "fileUploadMultiple", "tags": [ "CommonfileuploadController" ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Files and fields" } }, "description": "", "requestBody": { "content": { "multipart/form-data": { "x-parser": "stream", "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } } } } }, "description": "Request body for multipart/form-data based file upload", "required": true }, "operationId": "CommonfileuploadController.fileUploadMultiple" } }, "/negative-performance": { "get": { "x-controller-name": "PerformanceReportController", "x-operation-name": "negativePerformance", "tags": [ "PerformanceReportController" ], "responses": { "200": { "description": "Return value of PerformanceReportController.negativePerformance" } }, "parameters": [ { "name": "startDate", "in": "query", "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "schema": { "type": "string" } }, { "name": "teamLeadId", "in": "query", "schema": { "type": "number" } } ], "operationId": "PerformanceReportController.negativePerformance" } }, "/negative-performance-all": { "get": { "x-controller-name": "PerformanceReportController", "x-operation-name": "negativePerformanceAll", "tags": [ "PerformanceReportController" ], "description": "", "responses": { "200": { "description": "Return value of PerformanceReportController.negativePerformanceAll", "content": {} } }, "parameters": [ { "name": "startDate", "in": "query", "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "schema": { "type": "string" } }, { "name": "teamLeadId", "in": "query", "schema": { "type": "number" } } ], "operationId": "PerformanceReportController.negativePerformanceAll" } }, "/notes/{id}/invoices": { "get": { "x-controller-name": "NotesInvoicesController", "x-operation-name": "getInvoices", "tags": [ "NotesInvoicesController" ], "responses": { "200": { "description": "Invoices belonging to Notes", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Invoices" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "NotesInvoicesController.getInvoices" } }, "/notes/{id}/invoicesId": { "get": { "x-controller-name": "NotesInvoicesController", "x-operation-name": "getInvoicesID", "tags": [ "NotesInvoicesController" ], "responses": { "200": { "description": "Invoices belonging to Notes", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Invoices" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "NotesInvoicesController.getInvoicesID" } }, "/notes/{id}/portal": { "get": { "x-controller-name": "NotesPortalController", "x-operation-name": "getPortal", "tags": [ "NotesPortalController" ], "responses": { "200": { "description": "Portal belonging to Notes", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Portal" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "NotesPortalController.getPortal" } }, "/notes/{id}/shipment": { "get": { "x-controller-name": "NotesShipmentController", "x-operation-name": "getShipment", "tags": [ "NotesShipmentController" ], "responses": { "200": { "description": "Shipment belonging to Notes", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Shipment" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "NotesShipmentController.getShipment" } }, "/notes/{id}/shipper": { "get": { "x-controller-name": "ArShipperAgingController", "x-operation-name": "getInvoicesID", "tags": [ "ArShipperAgingController" ], "responses": { "200": { "description": "Invoices belonging to Notes", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Invoices" } } } } }, "description": "\n\n| Permissions |\n| ------- |\n| ar view shipper aging |\n| broker view shipper aging |\n", "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "ArShipperAgingController.getInvoicesID" } }, "/notes/{id}/shippers": { "get": { "x-controller-name": "NotesShippersController", "x-operation-name": "getShippers", "tags": [ "NotesShippersController" ], "responses": { "200": { "description": "Shippers belonging to Notes", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Shippers" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "NotesShippersController.getShippers" } }, "/notes/{id}/user": { "get": { "x-controller-name": "NotesUserController", "x-operation-name": "getUser", "tags": [ "NotesUserController" ], "responses": { "200": { "description": "User belonging to Notes", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "NotesUserController.getUser" } }, "/notifications/count": { "get": { "x-controller-name": "NotificationController", "x-operation-name": "count", "tags": [ "NotificationController" ], "responses": { "200": { "description": "Notifications model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Notifications.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "NotificationController.count" } }, "/notifications/{id}": { "put": { "x-controller-name": "NotificationController", "x-operation-name": "replaceById", "tags": [ "NotificationController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Notifications PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Notifications" } } }, "x-parameter-index": 1 }, "operationId": "NotificationController.replaceById" }, "patch": { "x-controller-name": "NotificationController", "x-operation-name": "updateById", "tags": [ "NotificationController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Notifications PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationsPartial" } } }, "x-parameter-index": 1 }, "operationId": "NotificationController.updateById" }, "get": { "x-controller-name": "NotificationController", "x-operation-name": "findById", "tags": [ "NotificationController" ], "responses": { "200": { "description": "Notifications model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationsWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Notifications.Filter" } } } } ], "operationId": "NotificationController.findById" }, "delete": { "x-controller-name": "NotificationController", "x-operation-name": "deleteById", "tags": [ "NotificationController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Notifications DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "NotificationController.deleteById" } }, "/notifications": { "post": { "x-controller-name": "NotificationController", "x-operation-name": "create", "tags": [ "NotificationController" ], "responses": { "200": { "description": "Notifications model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Notifications" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewNotifications" } } } }, "operationId": "NotificationController.create" }, "patch": { "x-controller-name": "NotificationController", "x-operation-name": "updateAll", "tags": [ "NotificationController" ], "responses": { "200": { "description": "Notifications PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Notifications.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotificationsPartial" } } } }, "operationId": "NotificationController.updateAll" }, "get": { "x-controller-name": "NotificationController", "x-operation-name": "find", "tags": [ "NotificationController" ], "description": "", "responses": { "200": { "description": "Array of Notifications model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NotificationsWithRelations" } } } } } }, "operationId": "NotificationController.find" } }, "/open-pro-histories/count": { "get": { "x-controller-name": "OpenProHistoryController", "x-operation-name": "count", "tags": [ "OpenProHistoryController" ], "responses": { "200": { "description": "OpenProHistory model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "OpenProHistory.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "OpenProHistoryController.count" } }, "/open-pro-histories/{id}/user": { "get": { "x-controller-name": "OpenProHistoryUserController", "x-operation-name": "getUser", "tags": [ "OpenProHistoryUserController" ], "responses": { "200": { "description": "User belonging to OpenProHistory", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "OpenProHistoryUserController.getUser" } }, "/open-pro-histories/{id}": { "put": { "x-controller-name": "OpenProHistoryController", "x-operation-name": "replaceById", "tags": [ "OpenProHistoryController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "OpenProHistory PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenProHistory" } } }, "x-parameter-index": 1 }, "operationId": "OpenProHistoryController.replaceById" }, "patch": { "x-controller-name": "OpenProHistoryController", "x-operation-name": "updateById", "tags": [ "OpenProHistoryController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar pro openrequest |\n", "responses": { "200": { "description": "Return value of OpenProHistoryController.updateById", "content": {} }, "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "OpenProHistory PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenProHistoryPartial" } } }, "x-parameter-index": 1 }, "operationId": "OpenProHistoryController.updateById" }, "get": { "x-controller-name": "OpenProHistoryController", "x-operation-name": "findById", "tags": [ "OpenProHistoryController" ], "responses": { "200": { "description": "OpenProHistory model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenProHistoryWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenProHistory.Filter" } } } } ], "operationId": "OpenProHistoryController.findById" }, "delete": { "x-controller-name": "OpenProHistoryController", "x-operation-name": "deleteById", "tags": [ "OpenProHistoryController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "OpenProHistory DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "OpenProHistoryController.deleteById" } }, "/open-pro-histories": { "post": { "x-controller-name": "OpenProHistoryController", "x-operation-name": "create", "tags": [ "OpenProHistoryController" ], "description": "", "responses": { "200": { "description": "OpenProHistory model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenProHistory" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewOpenProHistory" } } } }, "operationId": "OpenProHistoryController.create" }, "patch": { "x-controller-name": "OpenProHistoryController", "x-operation-name": "updateAll", "tags": [ "OpenProHistoryController" ], "responses": { "200": { "description": "OpenProHistory PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "OpenProHistory.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenProHistoryPartial" } } } }, "operationId": "OpenProHistoryController.updateAll" }, "get": { "x-controller-name": "OpenProHistoryController", "x-operation-name": "find", "tags": [ "OpenProHistoryController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar pro openrequest |\n", "responses": { "200": { "description": "Array of OpenProHistory model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OpenProHistoryWithRelations" } } } } } }, "parameters": [ { "name": "page", "in": "query", "schema": { "type": "number" } }, { "name": "pageSize", "in": "query", "schema": { "type": "number" } } ], "operationId": "OpenProHistoryController.find" } }, "/otr-incentive": { "get": { "x-controller-name": "OtrIncentiveController", "x-operation-name": "getOtrIncentiveList", "tags": [ "OtrIncentiveController" ], "responses": { "200": { "description": "OTR Incentive List with New Slab-wise Structure", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "additionalProperties": true } } } } } }, "parameters": [ { "name": "incentiveMonth", "in": "query", "schema": { "type": "string" } }, { "name": "lock", "in": "query", "schema": { "type": "boolean" } } ], "operationId": "OtrIncentiveController.getOtrIncentiveList" } }, "/otr-incentive-new-policy": { "get": { "x-controller-name": "OtrIncentiveController", "x-operation-name": "getOtrIncentiveListNewPolicy", "tags": [ "OtrIncentiveController" ], "responses": { "200": { "description": "OTR Incentive List with New Slab-wise Structure", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "additionalProperties": true } } } } } }, "parameters": [ { "name": "incentiveMonth", "in": "query", "schema": { "type": "string" } }, { "name": "lock", "in": "query", "schema": { "type": "boolean" } } ], "operationId": "OtrIncentiveController.getOtrIncentiveListNewPolicy" } }, "/otr-incentive-tl": { "get": { "x-controller-name": "OtrIncentiveController", "x-operation-name": "getOtrIncentiveTl", "tags": [ "OtrIncentiveController" ], "responses": { "200": { "description": "OTR TL Incentive List with New Slab-wise Structure", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "additionalProperties": true } } } } } }, "parameters": [ { "name": "date", "in": "query", "schema": { "type": "string" } }, { "name": "lock", "in": "query", "schema": { "type": "boolean" } } ], "operationId": "OtrIncentiveController.getOtrIncentiveTl" } }, "/otr-incentive-tl-new-policy": { "get": { "x-controller-name": "OtrIncentiveController", "x-operation-name": "getOtrIncentiveTlNewPolicy", "tags": [ "OtrIncentiveController" ], "responses": { "200": { "description": "OTR TL Incentive List with New Slab-wise Structure", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "additionalProperties": true } } } } } }, "parameters": [ { "name": "date", "in": "query", "schema": { "type": "string" } }, { "name": "lock", "in": "query", "schema": { "type": "boolean" } } ], "operationId": "OtrIncentiveController.getOtrIncentiveTlNewPolicy" } }, "/pay-history": { "get": { "x-controller-name": "ArPayReceivedController", "x-operation-name": "PayHistoryfind", "tags": [ "ArPayReceivedController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar view pay received |\n", "responses": { "200": { "description": "Array of Shipment model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InvoicesWithRelations" } } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Invoices.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } }, { "name": "page", "in": "query", "schema": { "type": "number" } }, { "name": "pageSize", "in": "query", "schema": { "type": "number" } }, { "name": "shipmentId", "in": "query", "schema": { "type": "string" } }, { "name": "shippersId", "in": "query", "schema": { "type": "string" } }, { "name": "InvoiceId", "in": "query", "schema": { "type": "string" } }, { "name": "DateFrom", "in": "query", "schema": { "type": "string" } }, { "name": "DateTo", "in": "query", "schema": { "type": "string" } }, { "name": "quartly", "in": "query", "schema": { "type": "string" } } ], "operationId": "ArPayReceivedController.PayHistoryfind" } }, "/payment-files-history/{batchNo}": { "delete": { "x-controller-name": "CarrierPaymentController", "x-operation-name": "deletePaymentFile", "tags": [ "CarrierPaymentController" ], "description": "\n\n| Permissions |\n| ------- |\n| ap carrier payment |\n", "responses": { "200": { "description": "Return value of CarrierPaymentController.deletePaymentFile", "content": {} }, "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Delete Payment File and Update Status" } } } } }, "parameters": [ { "name": "batchNo", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "CarrierPaymentController.deletePaymentFile" } }, "/payment-files-history": { "get": { "x-controller-name": "CarrierPaymentController", "x-operation-name": "getPaymentFilesHistory", "tags": [ "CarrierPaymentController" ], "description": "\n\n| Permissions |\n| ------- |\n| ap carrier payment |\n", "responses": { "200": { "description": "Payment Files History grouped by month", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "month": { "type": "string" }, "files": { "type": "array", "items": {} } } } } } } } }, "operationId": "CarrierPaymentController.getPaymentFilesHistory" } }, "/payment-methods/count": { "get": { "x-controller-name": "PaymentMethodsController", "x-operation-name": "count", "tags": [ "PaymentMethodsController" ], "responses": { "200": { "description": "PaymentMethods model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "PaymentMethods.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "PaymentMethodsController.count" } }, "/payment-methods/{id}/carriers": { "get": { "x-controller-name": "PaymentMethodsCarriersController", "x-operation-name": "getCarriers", "tags": [ "PaymentMethodsCarriersController" ], "responses": { "200": { "description": "Carriers belonging to PaymentMethods", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Carriers" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "PaymentMethodsCarriersController.getCarriers" } }, "/payment-methods/{id}/factoring-details": { "get": { "x-controller-name": "PaymentMethodsFactoringDetailsController", "x-operation-name": "getFactoringDetails", "tags": [ "PaymentMethodsFactoringDetailsController" ], "responses": { "200": { "description": "FactoringDetails belonging to PaymentMethods", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FactoringDetails" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "PaymentMethodsFactoringDetailsController.getFactoringDetails" } }, "/payment-methods/{id}": { "put": { "x-controller-name": "PaymentMethodsController", "x-operation-name": "replaceById", "tags": [ "PaymentMethodsController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "PaymentMethods PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentMethods" } } }, "x-parameter-index": 1 }, "operationId": "PaymentMethodsController.replaceById" }, "patch": { "x-controller-name": "PaymentMethodsController", "x-operation-name": "updateById", "tags": [ "PaymentMethodsController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "PaymentMethods PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentMethodsPartial" } } }, "x-parameter-index": 1 }, "operationId": "PaymentMethodsController.updateById" }, "get": { "x-controller-name": "PaymentMethodsController", "x-operation-name": "findById", "tags": [ "PaymentMethodsController" ], "responses": { "200": { "description": "PaymentMethods model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentMethodsWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentMethods.Filter" } } } } ], "operationId": "PaymentMethodsController.findById" }, "delete": { "x-controller-name": "PaymentMethodsController", "x-operation-name": "deleteById", "tags": [ "PaymentMethodsController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "PaymentMethods DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "PaymentMethodsController.deleteById" } }, "/payment-methods": { "post": { "x-controller-name": "PaymentMethodsController", "x-operation-name": "create", "tags": [ "PaymentMethodsController" ], "responses": { "200": { "description": "PaymentMethods model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentMethods" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewPaymentMethods" } } } }, "operationId": "PaymentMethodsController.create" }, "patch": { "x-controller-name": "PaymentMethodsController", "x-operation-name": "updateAll", "tags": [ "PaymentMethodsController" ], "responses": { "200": { "description": "PaymentMethods PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "PaymentMethods.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentMethodsPartial" } } } }, "operationId": "PaymentMethodsController.updateAll" }, "get": { "x-controller-name": "PaymentMethodsController", "x-operation-name": "find", "tags": [ "PaymentMethodsController" ], "responses": { "200": { "description": "Array of PaymentMethods model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentMethodsWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentMethods.Filter1" } } } } ], "operationId": "PaymentMethodsController.find" } }, "/payment-remittance-documents/{id}/shipper-payment-remittance": { "get": { "x-controller-name": "PaymentRemittanceDocumentShipperPaymentRemittanceController", "x-operation-name": "getShipperPaymentRemittance", "tags": [ "PaymentRemittanceDocumentShipperPaymentRemittanceController" ], "responses": { "200": { "description": "ShipperPaymentRemittance belonging to PaymentRemittanceDocument", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipperPaymentRemittance" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "PaymentRemittanceDocumentShipperPaymentRemittanceController.getShipperPaymentRemittance" } }, "/performance-appraisals/create": { "post": { "x-controller-name": "PerformanceAppraisalController", "x-operation-name": "createAppraisal", "tags": [ "PerformanceAppraisalController" ], "responses": { "201": { "description": "Performance appraisal created successfully", "content": { "application/json": { "schema": { "type": "object" } } } } }, "description": "", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string" }, "employeeId": { "type": "number" }, "appraisalDate": { "type": "string" }, "kraScores": { "type": "array", "items": { "type": "object", "properties": { "kraId": { "type": "number" }, "score": { "type": "number" }, "includeInCalculation": { "type": "boolean" } } } }, "skillSetScores": { "type": "array", "items": { "type": "object", "properties": { "skillSetId": { "type": "number" }, "score": { "type": "number" }, "includeInCalculation": { "type": "boolean" } } } }, "comments": { "type": "string" } }, "required": [ "email", "appraisalDate" ] } } } }, "operationId": "PerformanceAppraisalController.createAppraisal" } }, "/performance-appraisals/employee-kras-skill-sets": { "post": { "x-controller-name": "PerformanceAppraisalController", "x-operation-name": "getEmployeeKRAsAndSkillSets", "tags": [ "PerformanceAppraisalController" ], "responses": { "200": { "description": "Employee KRAs and Skill Sets", "content": { "application/json": { "schema": { "type": "object" } } } } }, "description": "", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string" } }, "required": [ "email" ] } } } }, "operationId": "PerformanceAppraisalController.getEmployeeKRAsAndSkillSets" } }, "/performance-appraisals/list": { "post": { "x-controller-name": "PerformanceAppraisalController", "x-operation-name": "listAppraisals", "tags": [ "PerformanceAppraisalController" ], "responses": { "200": { "description": "List of performance appraisals", "content": { "application/json": { "schema": { "type": "object" } } } } }, "description": "", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "emails": { "type": "array", "items": { "type": "string" }, "description": "Array of employee emails" }, "status": { "type": "string", "description": "Filter by status" }, "startDate": { "type": "string", "description": "Start date filter" }, "endDate": { "type": "string", "description": "End date filter" } }, "required": [ "emails" ] } } } }, "operationId": "PerformanceAppraisalController.listAppraisals" } }, "/performance-appraisals/managed-users": { "get": { "x-controller-name": "PerformanceAppraisalController", "x-operation-name": "getManagedUsers", "tags": [ "PerformanceAppraisalController" ], "responses": { "200": { "description": "Array of users managed by the logged-in manager", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "email": { "type": "string" }, "firstName": { "type": "string" }, "userId": { "type": "number" }, "managerId": { "type": "number" }, "tlId": { "type": "number" }, "portalId": { "type": "number" }, "date": { "type": "string" }, "activeStatus": { "type": "boolean" } } } } } } } }, "description": "", "operationId": "PerformanceAppraisalController.getManagedUsers" } }, "/performance-appraisals/{id}": { "post": { "x-controller-name": "PerformanceAppraisalController", "x-operation-name": "getAppraisalById", "tags": [ "PerformanceAppraisalController" ], "responses": { "200": { "description": "Performance appraisal details", "content": { "application/json": { "schema": { "type": "object" } } } } }, "description": "", "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "PerformanceAppraisalController.getAppraisalById" }, "put": { "x-controller-name": "PerformanceAppraisalController", "x-operation-name": "updateAppraisal", "tags": [ "PerformanceAppraisalController" ], "responses": { "200": { "description": "Performance appraisal updated successfully", "content": { "application/json": { "schema": { "type": "object" } } } } }, "description": "", "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string" }, "appraisalDate": { "type": "string" }, "kraScores": { "type": "array", "items": { "type": "object", "properties": { "kraId": { "type": "number" }, "score": { "type": "number" }, "includeInCalculation": { "type": "boolean" } } } }, "skillSetScores": { "type": "array", "items": { "type": "object", "properties": { "skillSetId": { "type": "number" }, "score": { "type": "number" }, "includeInCalculation": { "type": "boolean" } } } }, "comments": { "type": "string" }, "status": { "type": "string" } }, "required": [ "email" ] } } }, "x-parameter-index": 1 }, "operationId": "PerformanceAppraisalController.updateAppraisal" } }, "/performance-comments": { "post": { "x-controller-name": "ReportsController", "x-operation-name": "addPerformanceComment", "tags": [ "ReportsController" ], "responses": { "200": { "description": "Add a comment to performancecomments table", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number" } } } } } } }, "description": "\n\n| Permissions |\n| ------- |\n| view portal reports |\n", "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "ReportsController.addPerformanceComment" }, "get": { "x-controller-name": "ReportsController", "x-operation-name": "listPerformanceComments", "tags": [ "ReportsController" ], "responses": { "200": { "description": "List performance comments with user info", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/User" } } } } } }, "parameters": [ { "name": "userId", "in": "query", "schema": { "type": "number" } } ], "operationId": "ReportsController.listPerformanceComments" } }, "/performance-comments-count": { "get": { "x-controller-name": "ReportsController", "x-operation-name": "PerformancecommentCount", "tags": [ "ReportsController" ], "description": "\n\n| Permissions |\n| ------- |\n| view portal reports |\n", "responses": { "200": { "description": "Invoices model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserWithRelations" } } } } }, "operationId": "ReportsController.PerformancecommentCount" } }, "/performance-comments-manager-count": { "get": { "x-controller-name": "AnalyticsPerformanceReportController", "x-operation-name": "PerformancecommentCount", "tags": [ "AnalyticsPerformanceReportController" ], "description": "", "responses": { "200": { "description": "Invoices model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserWithRelations" } } } } }, "operationId": "AnalyticsPerformanceReportController.PerformancecommentCount" } }, "/pick-date-change-logs/{id}/shipment": { "get": { "x-controller-name": "PickDateChangeLogsShipmentController", "x-operation-name": "getShipment", "tags": [ "PickDateChangeLogsShipmentController" ], "responses": { "200": { "description": "Shipment belonging to PickDateChangeLogs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Shipment" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "PickDateChangeLogsShipmentController.getShipment" } }, "/pick-date-change-logs/{id}/user": { "get": { "x-controller-name": "PickDateChangeLogsUserController", "x-operation-name": "getUser", "tags": [ "PickDateChangeLogsUserController" ], "responses": { "200": { "description": "User belonging to PickDateChangeLogs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "PickDateChangeLogsUserController.getUser" } }, "/ping": { "get": { "x-controller-name": "PingController", "x-operation-name": "ping", "tags": [ "PingController" ], "responses": { "200": { "description": "Ping Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PingResponse" } } } } }, "operationId": "PingController.ping" } }, "/plan-summary": { "get": { "x-controller-name": "BrokerHomeController", "x-operation-name": "PlanSummary", "tags": [ "BrokerHomeController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker view dashboard |\n", "responses": { "200": { "description": "Shipment model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoicesWithRelations" } } } } }, "parameters": [ { "name": "type", "in": "query", "schema": { "type": "string" } } ], "operationId": "BrokerHomeController.PlanSummary" } }, "/portal/cpr-monthly-performance-all": { "get": { "x-controller-name": "CprBaseReportController", "x-operation-name": "getMonthlySummaryAll", "tags": [ "CprBaseReportController" ], "description": "", "responses": { "200": { "description": "Return value of CprBaseReportController.getMonthlySummaryAll", "content": {} } }, "parameters": [ { "name": "startDate", "in": "query", "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "schema": { "type": "string" } }, { "name": "userId", "in": "query", "schema": { "type": "number" } }, { "name": "teamId", "in": "query", "schema": { "type": "number" } } ], "operationId": "CprBaseReportController.getMonthlySummaryAll" } }, "/portal/cpr-pickup-performance-report": { "get": { "x-controller-name": "CprBaseReportController", "x-operation-name": "getCprPickupPerformanceReport", "tags": [ "CprBaseReportController" ], "responses": { "200": { "description": "Report fetched successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } } }, "description": "\n\n| Permissions |\n| ------- |\n| view portal reports |\n", "parameters": [ { "name": "startDate", "in": "query", "schema": { "type": "string" }, "description": "Start date (YYYY-MM-DD)" }, { "name": "endDate", "in": "query", "schema": { "type": "string" }, "description": "End date (YYYY-MM-DD)" } ], "operationId": "CprBaseReportController.getCprPickupPerformanceReport" } }, "/portal/cpr-send-bulk-performance-report": { "post": { "x-controller-name": "CprBaseReportController", "x-operation-name": "sendBulkPerformanceReport", "tags": [ "CprBaseReportController" ], "description": "", "responses": { "200": { "description": "Send Bulk Performance Report", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "CprBaseReportController.sendBulkPerformanceReport" } }, "/portal/mc-business-report": { "get": { "x-controller-name": "PerformanceReportController", "x-operation-name": "ShipmentCarrierBusinessReport", "tags": [ "PerformanceReportController" ], "description": "", "responses": { "200": { "description": "Return value of PerformanceReportController.ShipmentCarrierBusinessReport", "content": {} } }, "parameters": [ { "name": "startDate", "in": "query", "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "string" } } ], "operationId": "PerformanceReportController.ShipmentCarrierBusinessReport" } }, "/portal/mc-business-report-details/{carrierId}": { "get": { "x-controller-name": "PerformanceReportController", "x-operation-name": "ShipmentCarrierBusinessReportDetails", "tags": [ "PerformanceReportController" ], "description": "", "responses": { "200": { "description": "Return value of PerformanceReportController.ShipmentCarrierBusinessReportDetails", "content": {} } }, "parameters": [ { "name": "carrierId", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "PerformanceReportController.ShipmentCarrierBusinessReportDetails" } }, "/portal/mc-business-report-details-tracking-comments/{carrierId}": { "get": { "x-controller-name": "PerformanceReportController", "x-operation-name": "ShipmentCarrierBusinessReportDetailsTracking", "tags": [ "PerformanceReportController" ], "description": "", "responses": { "200": { "description": "Return value of PerformanceReportController.ShipmentCarrierBusinessReportDetailsTracking", "content": {} } }, "parameters": [ { "name": "carrierId", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "PerformanceReportController.ShipmentCarrierBusinessReportDetailsTracking" } }, "/portal/monthly-performance-all": { "get": { "x-controller-name": "ReportsController", "x-operation-name": "getMonthlySummaryAll", "tags": [ "ReportsController" ], "description": "", "responses": { "200": { "description": "Return value of ReportsController.getMonthlySummaryAll", "content": {} } }, "parameters": [ { "name": "startDate", "in": "query", "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "schema": { "type": "string" } }, { "name": "userId", "in": "query", "schema": { "type": "number" } }, { "name": "teamId", "in": "query", "schema": { "type": "number" } }, { "name": "sendEmailTo", "in": "query", "schema": { "type": "string" } }, { "name": "exportFile", "in": "query", "schema": { "type": "boolean" }, "required": false, "description": "Export as CSV and send via email" } ], "operationId": "ReportsController.getMonthlySummaryAll" } }, "/portal/monthly-performance-all-new": { "get": { "x-controller-name": "ReportsController", "x-operation-name": "getMonthlySummaryAllNew", "tags": [ "ReportsController" ], "description": "", "responses": { "200": { "description": "Return value of ReportsController.getMonthlySummaryAllNew", "content": {} } }, "parameters": [ { "name": "startDate", "in": "query", "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "schema": { "type": "string" } }, { "name": "userId", "in": "query", "schema": { "type": "number" } }, { "name": "teamId", "in": "query", "schema": { "type": "number" } }, { "name": "sendEmailTo", "in": "query", "schema": { "type": "string" } }, { "name": "exportFile", "in": "query", "schema": { "type": "boolean" }, "required": false, "description": "Export as CSV and send via email" } ], "operationId": "ReportsController.getMonthlySummaryAllNew" } }, "/portal/send-bulk-performance-report": { "post": { "x-controller-name": "EmailMarketingController", "x-operation-name": "sendBulkPerformanceReport", "tags": [ "EmailMarketingController" ], "description": "", "responses": { "200": { "description": "Send Bulk Performance Report", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "EmailMarketingController.sendBulkPerformanceReport" } }, "/portal/users": { "get": { "x-controller-name": "EmpAlignmentUserController", "x-operation-name": "find", "tags": [ "EmpAlignmentUserController" ], "responses": { "200": { "description": "Array of Portal has many User", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/User" } } } } } }, "description": "\n\n| Permissions |\n| ------- |\n| ar view alignment |\n", "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "User.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "EmpAlignmentUserController.find" } }, "/portal-bank-details/{id}/portal": { "get": { "x-controller-name": "PortalBankDetailsPortalController", "x-operation-name": "getPortal", "tags": [ "PortalBankDetailsPortalController" ], "responses": { "200": { "description": "Portal belonging to PortalBankDetails", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Portal" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "PortalBankDetailsPortalController.getPortal" } }, "/portal3/margin-summary": { "get": { "x-controller-name": "ReportsController", "x-operation-name": "getPortal3MarginSummary", "tags": [ "ReportsController" ], "responses": { "200": { "description": "Shipment margin sum and count by userId for portalId 3, with user name and date filter", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "userId": { "type": "number" }, "userName": { "type": "string" }, "marginSum": { "type": "number" }, "shipmentCount": { "type": "number" } } } } } } } }, "description": "\n\n| Permissions |\n| ------- |\n| view portal reports |\n", "parameters": [ { "name": "from", "in": "query", "schema": { "type": "string" }, "required": true, "description": "Start date YYYY-MM" }, { "name": "to", "in": "query", "schema": { "type": "string" }, "required": true, "description": "End date YYYY-MM" } ], "operationId": "ReportsController.getPortal3MarginSummary" } }, "/portal3/user-margin-details": { "get": { "x-controller-name": "ReportsController", "x-operation-name": "getPortal3UserMarginDetails", "tags": [ "ReportsController" ], "responses": { "200": { "description": "Detailed shipment records for a userId (portalId 3)", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "Pro": { "type": "number" }, "Invoice": { "type": "number" }, "Margin": { "type": "number" }, "PaymentStatus": { "type": "number" }, "CarrierPaymentStatus": { "type": "number" }, "POD": { "type": "string" }, "PickupDate": { "type": "string" } } } } } } } }, "description": "\n\n| Permissions |\n| ------- |\n| view portal reports |\n", "parameters": [ { "name": "userId", "in": "query", "schema": { "type": "number" }, "required": true, "description": "User ID" }, { "name": "from", "in": "query", "schema": { "type": "string" } }, { "name": "to", "in": "query", "schema": { "type": "string" } } ], "operationId": "ReportsController.getPortal3UserMarginDetails" } }, "/portal3/user-margin-summary": { "get": { "x-controller-name": "ReportsController", "x-operation-name": "getPortal3UserMarginSummary", "tags": [ "ReportsController" ], "responses": { "200": { "description": "Shipment margin sum and count by userId for portalId 3, with user name and date filter", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "userId": { "type": "number" }, "userName": { "type": "string" }, "marginSum": { "type": "number" }, "shipmentCount": { "type": "number" } } } } } } } }, "description": "\n\n| Permissions |\n| ------- |\n| view portal reports |\n", "parameters": [ { "name": "from", "in": "query", "schema": { "type": "string" }, "required": true, "description": "Start date YYYY-MM" }, { "name": "to", "in": "query", "schema": { "type": "string" }, "required": true, "description": "End date YYYY-MM" } ], "operationId": "ReportsController.getPortal3UserMarginSummary" } }, "/portals/{id}/portal-bank-details": { "get": { "x-controller-name": "PortalPortalBankDetailsController", "x-operation-name": "getPortalBankDetails", "tags": [ "PortalPortalBankDetailsController" ], "responses": { "200": { "description": "PortalBankDetails belonging to Portal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PortalBankDetails" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "PortalPortalBankDetailsController.getPortalBankDetails" } }, "/portals/{id}/potral-role": { "get": { "x-controller-name": "PortalPotralRoleController", "x-operation-name": "getPotralRole", "tags": [ "PortalPotralRoleController" ], "responses": { "200": { "description": "PotralRole belonging to Portal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PotralRole" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "PortalPotralRoleController.getPotralRole" } }, "/portals/{id}/users": { "post": { "x-controller-name": "PortalUserController", "x-operation-name": "create", "tags": [ "PortalUserController" ], "responses": { "200": { "description": "Portal model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewUserInPortal" } } }, "x-parameter-index": 1 }, "operationId": "PortalUserController.create" }, "patch": { "x-controller-name": "PortalUserController", "x-operation-name": "patch", "tags": [ "PortalUserController" ], "responses": { "200": { "description": "Portal.User PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "User.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserPartial" } } }, "x-parameter-index": 1 }, "operationId": "PortalUserController.patch" }, "get": { "x-controller-name": "PortalUserController", "x-operation-name": "find", "tags": [ "PortalUserController" ], "responses": { "200": { "description": "Array of Portal has many User", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/User" } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } ], "operationId": "PortalUserController.find" }, "delete": { "x-controller-name": "PortalUserController", "x-operation-name": "delete", "tags": [ "PortalUserController" ], "responses": { "200": { "description": "Portal.User DELETE success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "User.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "PortalUserController.delete" } }, "/preview-pdf": { "get": { "x-controller-name": "PdfReadController", "x-operation-name": "previewPdf", "tags": [ "PdfReadController" ], "responses": { "200": { "description": "Return value of PdfReadController.previewPdf" } }, "parameters": [ { "name": "fileUrl", "in": "query", "schema": { "type": "string" } } ], "operationId": "PdfReadController.previewPdf" } }, "/process-vonage-call-recordings": { "get": { "x-controller-name": "EmailMarketingController", "x-operation-name": "processVonageCallRecordings", "tags": [ "EmailMarketingController" ], "responses": { "200": { "description": "Return value of EmailMarketingController.processVonageCallRecordings" } }, "parameters": [ { "name": "date", "in": "query", "schema": { "type": "string" } }, { "name": "dry_run", "in": "query", "schema": { "type": "string" } }, { "name": "ext", "in": "query", "schema": { "type": "string" } }, { "name": "match_dnis", "in": "query", "schema": { "type": "string" } }, { "name": "dump", "in": "query", "schema": { "type": "string" } }, { "name": "cross_check", "in": "query", "schema": { "type": "string" } } ], "operationId": "EmailMarketingController.processVonageCallRecordings" } }, "/quick-shipment": { "post": { "x-controller-name": "ShipmentController", "x-operation-name": "quickcreate", "tags": [ "ShipmentController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker create shipment |\n", "responses": { "200": { "description": "Shipment model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Shipment" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "customer", "mode", "equipment", "commodity", "commodityValue", "pickupRef", "pickupDate", "pickupAptDate", "shipperPayMode", "carrierPayMode", "shipperPrice", "carrierPrice", "shipperInstrction", "carrierInstrction" ], "properties": { "customer": { "type": "number", "minimum": 1, "maximum": 99999999999 }, "mode": { "type": "number", "enum": [ 0, 1, 2, 3 ] }, "loadType": { "type": "string", "enum": [ "full", "partial" ] }, "equipment": { "type": "number", "minimum": 1, "maximum": 99999999999 }, "commodity": { "type": "number", "minimum": 1, "maximum": 99999999999 }, "commodityValue": { "type": "number", "minimum": 1, "maximum": 1000000 }, "pickupRef": { "type": "string", "maxLength": 200 }, "pickupDate": { "type": "string", "format": "date-time" }, "pickupAptDate": { "type": "string", "format": "date-time" }, "shipperPayMode": { "type": "number", "enum": [ 0, 1 ] }, "carrierPayMode": { "type": "number", "enum": [ 0, 1 ] }, "shipperPrice": { "type": "number", "maximum": 100000 }, "carrierPrice": { "type": "number", "maximum": 100000 }, "shipperInstrction": { "type": "string", "maxLength": 1000 }, "carrierInstrction": { "type": "string", "maxLength": 1000 } } } } } }, "operationId": "ShipmentController.quickcreate" } }, "/re-approval-mc-request/{id}": { "patch": { "x-controller-name": "ShipmentCprRequestController", "x-operation-name": "reupdateMcReVerificationById", "tags": [ "ShipmentCprRequestController" ], "description": "\n\n| Permissions |\n| ------- |\n| sme view cpr |\n", "responses": { "200": { "description": "Return value of ShipmentCprRequestController.reupdateMcReVerificationById", "content": {} }, "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "McReVerification PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "smeStatus", "approvalDate" ], "properties": { "smeStatus": { "type": "number", "maxLength": 10 }, "approvalDate": { "type": "string" } } } } }, "x-parameter-index": 1 }, "operationId": "ShipmentCprRequestController.reupdateMcReVerificationById" } }, "/re-approval-shipper-status": { "post": { "x-controller-name": "ArShippersController", "x-operation-name": "reapprovalshipperstatus", "tags": [ "ArShippersController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar approve shipper |\n", "responses": { "200": { "description": "Shippers History model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Shippers" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "ArShippersController.reapprovalshipperstatus" } }, "/re-cpr-delete-by-sme/{id}": { "get": { "x-controller-name": "McVerificationController", "x-operation-name": "ReCheckedCprDetail", "tags": [ "McVerificationController" ], "description": "\n\n| Permissions |\n| ------- |\n| sme view mcapprove |\n", "responses": { "200": { "description": "McVerification model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/McVerificationWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "McVerificationController.ReCheckedCprDetail" } }, "/re-cpr-request-list": { "get": { "x-controller-name": "McVerificationController", "x-operation-name": "GetReRequestCpr", "tags": [ "McVerificationController" ], "responses": { "200": { "description": "Array of CprRequest model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CprRequestWithRelations" } } } } } }, "description": "\n\n| Permissions |\n| ------- |\n| sme view dashboard |\n", "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "CprRequest.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/McReVerification.Filter" } } } } ], "operationId": "McVerificationController.GetReRequestCpr" } }, "/re-generate-invoice-update/{id}": { "get": { "x-controller-name": "ArInvoicesController", "x-operation-name": "ReGenerateInvoiceUpdated", "tags": [ "ArInvoicesController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar view invoices |\n", "responses": { "200": { "description": "Shipment model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipmentWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "ArInvoicesController.ReGenerateInvoiceUpdated" } }, "/re-mc-verification-list": { "get": { "x-controller-name": "McVerificationController", "x-operation-name": "findBy", "tags": [ "McVerificationController" ], "description": "\n\n| Permissions |\n| ------- |\n| sme view dashboard |\n", "responses": { "200": { "description": "Array of McVerification model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/McReVerificationWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/McReVerification.Filter" } } } } ], "operationId": "McVerificationController.findBy" } }, "/re-verified-mc/{id}": { "post": { "x-controller-name": "McVerificationController", "x-operation-name": "mcReVerification", "tags": [ "McVerificationController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker send mc request |\n", "responses": { "200": { "description": "McVerification model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/McVerificationWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "carrierNumber", "carrierEmail" ], "properties": { "carrierNumber": { "type": "string", "nullable": true }, "carrierEmail": { "type": "string", "nullable": true } } } } }, "x-parameter-index": 1 }, "operationId": "McVerificationController.mcReVerification" } }, "/read-aliance-excel-data": { "post": { "x-controller-name": "EmailMarketingController", "x-operation-name": "readAlianceExcelData", "tags": [ "EmailMarketingController" ], "responses": { "200": { "description": "Return value of EmailMarketingController.readAlianceExcelData" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "EmailMarketingController.readAlianceExcelData" } }, "/read-members": { "get": { "x-controller-name": "UserGroupController", "x-operation-name": "readMembers", "tags": [ "UserGroupController" ], "responses": { "200": { "description": "Return value of UserGroupController.readMembers" } }, "parameters": [ { "name": "url", "in": "query", "schema": { "type": "string" } } ], "operationId": "UserGroupController.readMembers" } }, "/ready-to-invoiced": { "get": { "x-controller-name": "BrokerHomeController", "x-operation-name": "ReadytoInvoiced", "tags": [ "BrokerHomeController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker view dashboard |\n", "responses": { "200": { "description": "Array of Shipment model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InvoicesWithRelations" } } } } } }, "parameters": [ { "name": "type", "in": "query", "schema": { "type": "string" } } ], "operationId": "BrokerHomeController.ReadytoInvoiced" } }, "/red-flags/count": { "get": { "x-controller-name": "RedFlagsController", "x-operation-name": "count", "tags": [ "RedFlagsController" ], "responses": { "200": { "description": "RedFlags model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "RedFlags.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "RedFlagsController.count" } }, "/red-flags/{id}": { "put": { "x-controller-name": "RedFlagsController", "x-operation-name": "replaceById", "tags": [ "RedFlagsController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "RedFlags PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RedFlags" } } }, "x-parameter-index": 1 }, "operationId": "RedFlagsController.replaceById" }, "patch": { "x-controller-name": "RedFlagsController", "x-operation-name": "updateById", "tags": [ "RedFlagsController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "RedFlags PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RedFlagsPartial" } } }, "x-parameter-index": 1 }, "operationId": "RedFlagsController.updateById" }, "get": { "x-controller-name": "RedFlagsController", "x-operation-name": "findById", "tags": [ "RedFlagsController" ], "responses": { "200": { "description": "RedFlags model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RedFlagsWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RedFlags.Filter" } } } } ], "operationId": "RedFlagsController.findById" }, "delete": { "x-controller-name": "RedFlagsController", "x-operation-name": "deleteById", "tags": [ "RedFlagsController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "RedFlags DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "RedFlagsController.deleteById" } }, "/red-flags": { "post": { "x-controller-name": "RedFlagsController", "x-operation-name": "create", "tags": [ "RedFlagsController" ], "responses": { "200": { "description": "RedFlags model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RedFlags" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewRedFlags" } } } }, "operationId": "RedFlagsController.create" }, "patch": { "x-controller-name": "RedFlagsController", "x-operation-name": "updateAll", "tags": [ "RedFlagsController" ], "responses": { "200": { "description": "RedFlags PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "RedFlags.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RedFlagsPartial" } } } }, "operationId": "RedFlagsController.updateAll" }, "get": { "x-controller-name": "RedFlagsController", "x-operation-name": "find", "tags": [ "RedFlagsController" ], "responses": { "200": { "description": "Array of RedFlags model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RedFlagsWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RedFlags.Filter1" } } } } ], "operationId": "RedFlagsController.find" } }, "/regenerate-invoice-request": { "post": { "x-controller-name": "InvoiceRegenrationRequestsController", "x-operation-name": "create", "tags": [ "InvoiceRegenrationRequestsController" ], "description": "", "responses": { "200": { "description": "InvoiceRegenrationRequests model instance", "content": { "application/json": { "schema": {} } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "invoiceId": { "type": "number" }, "shipmentId": { "type": "number" }, "shipmentOldPrice": { "type": "number" }, "shipmentNewPrice": { "type": "number" } }, "required": [ "invoiceId", "shipmentId" ] } } }, "description": "Invoice regeneration request payload", "required": true }, "operationId": "InvoiceRegenrationRequestsController.create" } }, "/regenerate-invoice-requests": { "get": { "x-controller-name": "InvoiceRegenrationRequestsController", "x-operation-name": "getInvoiceRegenrationRequests", "tags": [ "InvoiceRegenrationRequestsController" ], "description": "", "responses": { "200": { "description": "Return value of InvoiceRegenrationRequestsController.getInvoiceRegenrationRequests", "content": {} } }, "operationId": "InvoiceRegenrationRequestsController.getInvoiceRegenrationRequests" } }, "/regenerate-invoice-requests-approve-decline/{id}": { "patch": { "x-controller-name": "InvoiceRegenrationRequestsController", "x-operation-name": "updateInvoiceRegenrationRequestById", "tags": [ "InvoiceRegenrationRequestsController" ], "description": "", "responses": { "200": { "description": "Return value of InvoiceRegenrationRequestsController.updateInvoiceRegenrationRequestById", "content": {} } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "number" }, "manager_comment": { "type": "string" } }, "required": [ "status" ] } } }, "description": "Invoice regeneration request payload", "required": true, "x-parameter-index": 1 }, "operationId": "InvoiceRegenrationRequestsController.updateInvoiceRegenrationRequestById" } }, "/reject-cpr-by-email/{id}": { "get": { "x-controller-name": "ArCprInvoiceRequestController", "x-operation-name": "CprDeclineByEmail", "tags": [ "ArCprInvoiceRequestController" ], "responses": { "200": { "description": "McVerification model instance", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "userId", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "ArCprInvoiceRequestController.CprDeclineByEmail" } }, "/reject-inv-request-by-email/{id}": { "get": { "x-controller-name": "ArCprInvoiceRequestController", "x-operation-name": "InvoiceDeclineByEmail", "tags": [ "ArCprInvoiceRequestController" ], "responses": { "200": { "description": "McVerification model instance", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "userId", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "ArCprInvoiceRequestController.InvoiceDeclineByEmail" } }, "/reject-shipper-limit-request": { "post": { "x-controller-name": "ArshipperLimitController", "x-operation-name": "rejectById", "tags": [ "ArshipperLimitController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar update shipper limit |\n", "responses": { "200": { "description": "Return value of ArshipperLimitController.rejectById", "content": {} }, "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Shipper Limit PATCH success" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "ArshipperLimitController.rejectById" } }, "/reject-shipper-status": { "post": { "x-controller-name": "ArShippersController", "x-operation-name": "create", "tags": [ "ArShippersController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar approve shipper |\n", "responses": { "200": { "description": "Shippers History model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipperHistory" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Shippers History" } } } }, "operationId": "ArShippersController.create" } }, "/reject-ssl-payment": { "post": { "x-controller-name": "ShipmentController", "x-operation-name": "rejectSslPayment", "tags": [ "ShipmentController" ], "description": "", "responses": { "200": { "description": "Return value of ShipmentController.rejectSslPayment", "content": {} } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "ShipmentController.rejectSslPayment" } }, "/remittance-aps/{id}/carriers": { "get": { "x-controller-name": "RemittanceApCarriersController", "x-operation-name": "getCarriers", "tags": [ "RemittanceApCarriersController" ], "responses": { "200": { "description": "Carriers belonging to RemittanceAp", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Carriers" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "RemittanceApCarriersController.getCarriers" } }, "/remittance-aps/{id}/portal": { "get": { "x-controller-name": "RemittanceApPortalController", "x-operation-name": "getPortal", "tags": [ "RemittanceApPortalController" ], "responses": { "200": { "description": "Portal belonging to RemittanceAp", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Portal" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "RemittanceApPortalController.getPortal" } }, "/remittance-aps/{id}/shipment": { "get": { "x-controller-name": "RemittanceApShipmentController", "x-operation-name": "getShipment", "tags": [ "RemittanceApShipmentController" ], "responses": { "200": { "description": "Shipment belonging to RemittanceAp", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Shipment" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "RemittanceApShipmentController.getShipment" } }, "/remove-email-from-campaign": { "post": { "x-controller-name": "EmailMarketingController", "x-operation-name": "removeEmailFromCampaign", "tags": [ "EmailMarketingController" ], "description": "", "responses": { "200": { "description": "Return value of EmailMarketingController.removeEmailFromCampaign", "content": {} } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "EmailMarketingController.removeEmailFromCampaign" } }, "/remove-user-lob-pip-attrite/{id}/{type}": { "get": { "x-controller-name": "ReportsController", "x-operation-name": "removeUserLobPipAttrite", "tags": [ "ReportsController" ], "description": "\n\n| Permissions |\n| ------- |\n| view portal reports |\n", "responses": { "200": { "description": "Return value of ReportsController.removeUserLobPipAttrite", "content": {} } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "type", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "ReportsController.removeUserLobPipAttrite" } }, "/reset-incentive": { "get": { "x-controller-name": "CronJobController", "x-operation-name": "resetIncentives", "tags": [ "CronJobController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } } }, "operationId": "CronJobController.resetIncentives" } }, "/rims/serch/history": { "get": { "x-controller-name": "DatratemateController", "x-operation-name": "getRIMSSearchHistory", "tags": [ "DatratemateController" ], "responses": { "200": { "description": "Return value of DatratemateController.getRIMSSearchHistory" } }, "operationId": "DatratemateController.getRIMSSearchHistory" } }, "/rims/serch/{MCID}": { "get": { "x-controller-name": "DatratemateController", "x-operation-name": "getRIMSSearchDetails", "tags": [ "DatratemateController" ], "responses": { "200": { "description": "Return value of DatratemateController.getRIMSSearchDetails" } }, "parameters": [ { "name": "MCID", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "querytype", "in": "query", "schema": { "type": "string" } } ], "operationId": "DatratemateController.getRIMSSearchDetails" } }, "/roles/{id}/users": { "post": { "x-controller-name": "RoleUserController", "x-operation-name": "create", "tags": [ "RoleUserController" ], "responses": { "200": { "description": "Role model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewUserInRole" } } }, "x-parameter-index": 1 }, "operationId": "RoleUserController.create" }, "patch": { "x-controller-name": "RoleUserController", "x-operation-name": "patch", "tags": [ "RoleUserController" ], "responses": { "200": { "description": "Role.User PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "User.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserPartial" } } }, "x-parameter-index": 1 }, "operationId": "RoleUserController.patch" }, "get": { "x-controller-name": "RoleUserController", "x-operation-name": "find", "tags": [ "RoleUserController" ], "responses": { "200": { "description": "Array of Role has many User", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/User" } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } ], "operationId": "RoleUserController.find" }, "delete": { "x-controller-name": "RoleUserController", "x-operation-name": "delete", "tags": [ "RoleUserController" ], "responses": { "200": { "description": "Role.User DELETE success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "User.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "RoleUserController.delete" } }, "/roles": { "get": { "x-controller-name": "RoleUserController", "x-operation-name": "getRolesByCondition", "tags": [ "RoleUserController" ], "description": "", "responses": { "200": { "description": "Return value of RoleUserController.getRolesByCondition", "content": {} } }, "operationId": "RoleUserController.getRolesByCondition" } }, "/roles-all": { "get": { "x-controller-name": "RoleUserController", "x-operation-name": "getAllRolesByCondition", "tags": [ "RoleUserController" ], "description": "", "responses": { "200": { "description": "Return value of RoleUserController.getAllRolesByCondition", "content": {} } }, "operationId": "RoleUserController.getAllRolesByCondition" } }, "/save-ar-churn-followup": { "post": { "x-controller-name": "ChurnCustomerController", "x-operation-name": "saveArChurnFollowup", "tags": [ "ChurnCustomerController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker view churn report |\n", "responses": { "200": { "description": "Return value of ChurnCustomerController.saveArChurnFollowup", "content": {} } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "ChurnCustomerController.saveArChurnFollowup" } }, "/save-remittance-data": { "post": { "x-controller-name": "ShipperPaymentRemittanceController", "x-operation-name": "saveRemittanceData", "tags": [ "ShipperPaymentRemittanceController" ], "description": "\n\n| Permissions |\n| ------- |\n| payment remittance |\n", "responses": { "200": { "description": "Array of Shipment and invoices model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InvoicesWithRelations" } } } } } }, "requestBody": { "content": { "multipart/form-data": { "x-parser": "stream", "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } } } } }, "description": "Request body for multipart/form-data based file upload", "required": true }, "operationId": "ShipperPaymentRemittanceController.saveRemittanceData" } }, "/send/email/to/admin/of/invoicing/report/on-click": { "post": { "x-controller-name": "DatratemateController", "x-operation-name": "SendEmailToAdminOfInvoicingReportOnClick", "tags": [ "DatratemateController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar performance report |\n", "responses": { "200": { "description": "Return value of DatratemateController.SendEmailToAdminOfInvoicingReportOnClick", "content": {} } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "to": { "type": "array", "items": { "type": "string" } }, "subject": { "type": "string" }, "content": { "type": "string" } } } } } }, "operationId": "DatratemateController.SendEmailToAdminOfInvoicingReportOnClick" } }, "/send/email/to/internalTrucks/on-click": { "post": { "x-controller-name": "DatratemateController", "x-operation-name": "SendEmailToInternalTrucksOnClick", "tags": [ "DatratemateController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker create loads |\n", "responses": { "200": { "description": "Return value of DatratemateController.SendEmailToInternalTrucksOnClick", "content": {} } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "to": { "type": "array", "items": { "type": "string" } }, "subject": { "type": "string" }, "content": { "type": "string" } } } } } }, "operationId": "DatratemateController.SendEmailToInternalTrucksOnClick" } }, "/send/onboardingToRIMS/{EmailID}/{CarrierName}/{UserName}/{UserEmail}": { "get": { "x-controller-name": "TruckstopsCacciController", "x-operation-name": "SendOnboardingRIMS", "tags": [ "TruckstopsCacciController" ], "description": "", "responses": { "200": { "description": "Return value of TruckstopsCacciController.SendOnboardingRIMS", "content": {} } }, "parameters": [ { "name": "EmailID", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "CarrierName", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "UserName", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "UserEmail", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "TruckstopsCacciController.SendOnboardingRIMS" } }, "/send-email-invoice-secure-limit": { "get": { "x-controller-name": "ArInvoicesReportControllerController", "x-operation-name": "AllInvoicesfind", "tags": [ "ArInvoicesReportControllerController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar view invoices |\n", "responses": { "200": { "description": "Array of Shipment model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ShipmentWithRelations" } } } } } }, "parameters": [ { "name": "InvoiceId", "in": "query", "schema": { "type": "string" } }, { "name": "ProNo", "in": "query", "schema": { "type": "string" } }, { "name": "shippersId", "in": "query", "schema": { "type": "string" } }, { "name": "userId", "in": "query", "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "number" } }, { "name": "pageSize", "in": "query", "schema": { "type": "number" } }, { "name": "MoveTo", "in": "query", "schema": { "type": "string" } }, { "name": "subType", "in": "query", "schema": { "type": "string" } }, { "name": "AssignToShippers", "in": "query", "schema": { "type": "string" } }, { "name": "DateFrom", "in": "query", "schema": { "type": "string" } }, { "name": "DateTo", "in": "query", "schema": { "type": "string" } } ], "operationId": "ArInvoicesReportControllerController.AllInvoicesfind" } }, "/send-email-invoice-secure-limit-ace": { "get": { "x-controller-name": "ArInvoicesReportControllerController", "x-operation-name": "AllInvoicesfindACE", "tags": [ "ArInvoicesReportControllerController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar view invoices |\n", "responses": { "200": { "description": "Array of Shipment model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ShipmentWithRelations" } } } } } }, "parameters": [ { "name": "shippersId", "in": "query", "schema": { "type": "string" } }, { "name": "DateFrom", "in": "query", "schema": { "type": "string" } }, { "name": "DateTo", "in": "query", "schema": { "type": "string" } } ], "operationId": "ArInvoicesReportControllerController.AllInvoicesfindACE" } }, "/send-email-invoice-secure-limit-vl-ace": { "get": { "x-controller-name": "ArInvoicesReportControllerController", "x-operation-name": "AllInvoicesVlACEfind", "tags": [ "ArInvoicesReportControllerController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar view invoices |\n", "responses": { "200": { "description": "Array of Shipment model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ShipmentWithRelations" } } } } } }, "parameters": [ { "name": "shippersId", "in": "query", "schema": { "type": "string" } }, { "name": "DateFrom", "in": "query", "schema": { "type": "string" } }, { "name": "DateTo", "in": "query", "schema": { "type": "string" } } ], "operationId": "ArInvoicesReportControllerController.AllInvoicesVlACEfind" } }, "/send-email-remittance-data": { "post": { "x-controller-name": "ShipperPaymentRemittanceController", "x-operation-name": "sendEmailRemittanceData", "tags": [ "ShipperPaymentRemittanceController" ], "description": "\n\n| Permissions |\n| ------- |\n| payment remittance |\n", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Send remittance email" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "selectedIds": { "type": "array", "items": { "type": "number" } }, "mail_subject": { "type": "string" }, "emailBody": { "type": "string" }, "to_emails": { "type": "array", "items": { "type": "string" } }, "cc_emails": { "type": "array", "items": { "type": "string" } }, "cc_others": { "type": "string" } } } } } }, "operationId": "ShipperPaymentRemittanceController.sendEmailRemittanceData" } }, "/send-email-rewards": { "get": { "x-controller-name": "EmailMarketingController", "x-operation-name": "sendEmailRewards", "tags": [ "EmailMarketingController" ], "responses": { "200": { "description": "Return value of EmailMarketingController.sendEmailRewards" } }, "operationId": "EmailMarketingController.sendEmailRewards" } }, "/send-email-rewards-dummy": { "get": { "x-controller-name": "EmailMarketingController", "x-operation-name": "sendEmailRewardsDummy", "tags": [ "EmailMarketingController" ], "responses": { "200": { "description": "Return value of EmailMarketingController.sendEmailRewardsDummy" } }, "operationId": "EmailMarketingController.sendEmailRewardsDummy" } }, "/send-marketing-email": { "post": { "x-controller-name": "EmailMarketingController", "x-operation-name": "sendMarketingEmail", "tags": [ "EmailMarketingController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker send email marketing |\n", "responses": { "200": { "description": "Return value of EmailMarketingController.sendMarketingEmail", "content": {} } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "EmailMarketingController.sendMarketingEmail" } }, "/send-marketing-email-all-shippers": { "post": { "x-controller-name": "EmailMarketingController", "x-operation-name": "sendMarketingEmailAllShippers", "tags": [ "EmailMarketingController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker send email marketing |\n", "responses": { "200": { "description": "Return value of EmailMarketingController.sendMarketingEmailAllShippers", "content": {} } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "EmailMarketingController.sendMarketingEmailAllShippers" } }, "/send-marketing-email-followup": { "post": { "x-controller-name": "EmailMarketingController", "x-operation-name": "sendMarketingEmailFollowup", "tags": [ "EmailMarketingController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker send email marketing |\n", "responses": { "200": { "description": "Return value of EmailMarketingController.sendMarketingEmailFollowup", "content": {} } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "EmailMarketingController.sendMarketingEmailFollowup" } }, "/send-selected-statement-report": { "post": { "x-controller-name": "ArSendStatementController", "x-operation-name": "sendStatementData", "tags": [ "ArSendStatementController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar view shipper aging |\n", "responses": { "200": { "description": "Array of Shipment and invoices model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InvoicesWithRelations" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "ArSendStatementController.sendStatementData" } }, "/send-send-insurance-email": { "post": { "x-controller-name": "BrokerVinVerificationController", "x-operation-name": "shipperblock", "tags": [ "BrokerVinVerificationController" ], "description": "", "responses": { "200": { "description": "Shippers History model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Shipment" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "BrokerVinVerificationController.shipperblock" } }, "/send-shipment-details-email-to-broker": { "post": { "x-controller-name": "ShipmentController", "x-operation-name": "sendShipmentDetailsEmailToBroker", "tags": [ "ShipmentController" ], "description": "", "responses": { "200": { "description": "Send shipment details email to broker", "content": { "application/json": { "schema": { "type": "object", "properties": { "page": { "type": "number" }, "pageSize": { "type": "number" } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "shipmentId" ], "properties": { "id": { "type": "number" } } } } } }, "operationId": "ShipmentController.sendShipmentDetailsEmailToBroker" } }, "/send-withdrawn-claim-reminder": { "get": { "x-controller-name": "WithdrawnShipperCreditLimitHistoryController", "x-operation-name": "SendClaimReminder", "tags": [ "WithdrawnShipperCreditLimitHistoryController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Shipper Limit Reminder success" } } } } }, "operationId": "WithdrawnShipperCreditLimitHistoryController.SendClaimReminder" } }, "/sendgrid/fetch-day": { "get": { "x-controller-name": "EmailMarketingController", "x-operation-name": "fetchSendGridRange", "tags": [ "EmailMarketingController" ], "responses": { "200": { "description": "Return value of EmailMarketingController.fetchSendGridRange" } }, "parameters": [ { "name": "start", "in": "query", "schema": { "type": "string" } }, { "name": "end", "in": "query", "schema": { "type": "string" } } ], "operationId": "EmailMarketingController.fetchSendGridRange" } }, "/set-schedule-marketing-email": { "post": { "x-controller-name": "EmailMarketingController", "x-operation-name": "setEmailMarketingSchedule", "tags": [ "EmailMarketingController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker send email marketing |\n", "responses": { "200": { "description": "Return value of EmailMarketingController.setEmailMarketingSchedule", "content": {} } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "EmailMarketingController.setEmailMarketingSchedule" } }, "/shipment/api/aone-ff/update/{loadNo}": { "patch": { "x-controller-name": "CommonApiController", "x-operation-name": "updateAoneFfShipment", "tags": [ "CommonApiController" ], "description": "", "responses": { "200": { "description": "Update pickup/drop name + contact for an AONE-FF shipment", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } } } } } }, "parameters": [ { "name": "loadNo", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "pickupName": { "type": "string" }, "pickupContact": { "type": "string" }, "dropName": { "type": "string" }, "dropContact": { "type": "string" } } } } }, "required": true, "x-parameter-index": 1 }, "operationId": "CommonApiController.updateAoneFfShipment" } }, "/shipment/api/aone-ff-create": { "post": { "x-controller-name": "CommonApiController", "x-operation-name": "AoneFfInsertShipment", "tags": [ "CommonApiController" ], "responses": { "200": { "description": "Insert shipment with manual userId + shipperId", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Shipment" } } } } }, "description": "", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "quotationNo", "brokerid", "loadNo", "containerNo", "loadType", "commoditiesName", "equipmentName", "commodityValue", "shipperPayMode", "shipperPrice", "mode", "pick_ref", "pick_name", "pick_address", "pick_city", "pick_zipCode", "pick_state", "pick_country", "pick_phone", "pick_email", "pick_contact", "pickupDate", "pickupApptDate", "pickupApptNote", "drop_ref", "drop_name", "drop_address", "drop_city", "drop_zipCode", "drop_state", "drop_country", "drop_phone", "drop_email", "drop_contact", "dropDate", "dropupApptDate", "dropupApptNote" ], "properties": { "quotationNo": { "type": "string" }, "brokerid": { "type": "number" }, "loadNo": { "type": "string" }, "containerNo": { "type": "string" }, "loadType": { "type": "string" }, "commoditiesName": { "type": "string" }, "equipmentName": { "type": "string" }, "commodityValue": { "type": "number" }, "status": { "type": "number" }, "shipperPayMode": { "type": "number" }, "shipperPrice": { "type": "number" }, "mode": { "type": "string" }, "pick_ref": { "type": "string" }, "pick_name": { "type": "string" }, "pick_address": { "type": "string" }, "pick_city": { "type": "string" }, "pick_zipCode": { "type": "string" }, "pick_state": { "type": "string" }, "pick_country": { "type": "string" }, "pick_phone": { "type": "string" }, "pick_email": { "type": "string" }, "pick_contact": { "type": "string" }, "pickupDate": { "type": "string" }, "pickupApptDate": { "type": "string" }, "pickupApptNote": { "type": "string" }, "drop_ref": { "type": "string" }, "drop_name": { "type": "string" }, "drop_address": { "type": "string" }, "drop_city": { "type": "string" }, "drop_zipCode": { "type": "string" }, "drop_state": { "type": "string" }, "drop_country": { "type": "string" }, "drop_phone": { "type": "string" }, "drop_email": { "type": "string" }, "drop_contact": { "type": "string" }, "dropDate": { "type": "string" }, "dropupApptDate": { "type": "string" }, "dropupApptNote": { "type": "string" }, "weight": { "type": "string" }, "footage": { "type": "string" }, "pallet": { "type": "number" }, "precoolTemp": { "type": "string" }, "miles": { "type": "number" }, "minTemp": { "type": "string" }, "maxTemp": { "type": "string" }, "shipperInstrctions": { "type": "string" }, "extraprice": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "price": { "type": "number" } } } } } } } }, "description": "Insert into shipment table.", "required": true }, "operationId": "CommonApiController.AoneFfInsertShipment" } }, "/shipment/auto-gtg-ap-by-pod-age": { "post": { "x-controller-name": "ShipmentController", "x-operation-name": "autoGtgApByPodAge", "tags": [ "ShipmentController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker create shipment |\n", "responses": { "200": { "description": "Auto update AP GTG for shipments with POD doc created between 30-40 days ago (mode=1, status=4)", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "mode": { "type": "string", "description": "Shipment mode (default \"1\")" }, "status": { "type": "number", "description": "Shipment status (default 4)" }, "toDays": { "type": "number", "description": "Newer bound in days (default 30)" }, "message": { "type": "string", "description": "GTG history message override" } } } } }, "description": "Optional overrides. By default: mode=1, status=4, fromDays=40, toDays=30.", "required": false }, "operationId": "ShipmentController.autoGtgApByPodAge" } }, "/shipment/gtg-ap": { "post": { "x-controller-name": "ShipmentController", "x-operation-name": "gtgAp", "tags": [ "ShipmentController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker create shipment |\n", "responses": { "200": { "description": "Shipment model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Shipment" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "shipmentId", "comment", "holdPayment" ], "properties": { "shipmentId": { "type": "string" }, "comment": { "type": "string" }, "holdPayment": { "type": "string" } } } } } }, "operationId": "ShipmentController.gtgAp" } }, "/shipment/gtg-ar": { "post": { "x-controller-name": "ShipmentController", "x-operation-name": "gtgAr", "tags": [ "ShipmentController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker create shipment |\n", "responses": { "200": { "description": "Shipment model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Shipment" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "shipmentId", "comment" ], "properties": { "shipmentId": { "type": "string" }, "comment": { "type": "string" } } } } } }, "operationId": "ShipmentController.gtgAr" } }, "/shipment/load-conf": { "post": { "x-controller-name": "ShipmentController", "x-operation-name": "LoadConf", "tags": [ "ShipmentController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker create shipment |\n", "responses": { "200": { "description": "Shipment model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Shipment" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "shipmentId", "email" ], "properties": { "shipmentId": { "type": "string" }, "email": { "type": "array" } } } } } }, "operationId": "ShipmentController.LoadConf" } }, "/shipment-cancel-logs/{id}/shipment": { "get": { "x-controller-name": "ShipmentCancelLogsShipmentController", "x-operation-name": "getShipment", "tags": [ "ShipmentCancelLogsShipmentController" ], "responses": { "200": { "description": "Shipment belonging to ShipmentCancelLogs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Shipment" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ShipmentCancelLogsShipmentController.getShipment" } }, "/shipment-details/send": { "post": { "x-controller-name": "ReportsController", "x-operation-name": "sendShipmentReport", "tags": [ "ReportsController" ], "description": "\n\n| Permissions |\n| ------- |\n| view portal reports |\n", "responses": { "200": { "description": "Return value of ReportsController.sendShipmentReport", "content": {} } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fromDate": { "type": "string" }, "toDate": { "type": "string" }, "status": { "type": "string" }, "to": { "type": "string" }, "subject": { "type": "string" }, "content": { "type": "string" } }, "required": [ "fromDate", "toDate", "to", "subject", "content" ] } } } }, "operationId": "ReportsController.sendShipmentReport" } }, "/shipment-details": { "get": { "x-controller-name": "ReportsController", "x-operation-name": "getShipmentDetails", "tags": [ "ReportsController" ], "responses": { "200": { "description": "Get shipment details with invoice and carrier aging info", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "shipmentId": { "type": "number" }, "pickupDate": { "type": "string" }, "shipperPrice": { "type": "number" }, "carrierPrice": { "type": "number" }, "invoiceId": { "type": "number" }, "invoiceDate": { "type": "string" }, "carrierInvoiceNumber": { "type": "string" }, "carrierInvoiceDate": { "type": "string" } } } } } } } }, "description": "\n\n| Permissions |\n| ------- |\n| view portal reports |\n", "parameters": [ { "name": "from", "in": "query", "schema": { "type": "string" }, "required": true, "description": "Start date YYYY-MM-DD" }, { "name": "to", "in": "query", "schema": { "type": "string" }, "required": true, "description": "End date YYYY-MM-DD" }, { "name": "status", "in": "query", "schema": { "type": "string" }, "required": false, "description": "should be 0 to 6" } ], "operationId": "ReportsController.getShipmentDetails" } }, "/shipment-docs/{id}/user": { "get": { "x-controller-name": "ShipmentDocsUserController", "x-operation-name": "getUser", "tags": [ "ShipmentDocsUserController" ], "responses": { "200": { "description": "User belonging to ShipmentDocs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ShipmentDocsUserController.getUser" } }, "/shipment-drops/{id}/shipment": { "get": { "x-controller-name": "ShipmentDropsShipmentController", "x-operation-name": "getShipment", "tags": [ "ShipmentDropsShipmentController" ], "responses": { "200": { "description": "Shipment belonging to ShipmentDrops", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Shipment" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ShipmentDropsShipmentController.getShipment" } }, "/shipment-drops/{id}/zip-codes": { "get": { "x-controller-name": "ShipmentDropsZipCodesController", "x-operation-name": "getZipCodes", "tags": [ "ShipmentDropsZipCodesController" ], "responses": { "200": { "description": "ZipCodes belonging to ShipmentDrops", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ZipCodes" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ShipmentDropsZipCodesController.getZipCodes" } }, "/shipment-drops/{id}": { "get": { "x-controller-name": "ShipmentShipmentDropsController", "x-operation-name": "find1", "tags": [ "ShipmentShipmentDropsController" ], "responses": { "200": { "description": "Array of Shipment has many ShipmentDrops", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ShipmentDrops" } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "ShipmentShipmentDropsController.find1" } }, "/shipment-gtg-ap": { "post": { "x-controller-name": "ApShipmentControllerController", "x-operation-name": "gtgAp", "tags": [ "ApShipmentControllerController" ], "description": "\n\n| Permissions |\n| ------- |\n| ap view shipment |\n", "responses": { "200": { "description": "Shipment model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Shipment" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "shipmentId", "comment" ], "properties": { "shipmentId": { "type": "string" }, "comment": { "type": "string" } } } } } }, "operationId": "ApShipmentControllerController.gtgAp" } }, "/shipment-picks/{id}/shipment": { "get": { "x-controller-name": "ShipmentPicksShipmentController", "x-operation-name": "getShipment", "tags": [ "ShipmentPicksShipmentController" ], "responses": { "200": { "description": "Shipment belonging to ShipmentPicks", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Shipment" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ShipmentPicksShipmentController.getShipment" } }, "/shipment-picks/{id}/zip-codes": { "get": { "x-controller-name": "ShipmentPicksZipCodesController", "x-operation-name": "getZipCodes", "tags": [ "ShipmentPicksZipCodesController" ], "responses": { "200": { "description": "ZipCodes belonging to ShipmentPicks", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ZipCodes" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ShipmentPicksZipCodesController.getZipCodes" } }, "/shipment-picks/{id}": { "get": { "x-controller-name": "ShipmentShipmentPicksController", "x-operation-name": "find1", "tags": [ "ShipmentShipmentPicksController" ], "responses": { "200": { "description": "Array of Shipment has many ShipmentPicks", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ShipmentPicks" } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "ShipmentShipmentPicksController.find1" } }, "/shipment-price-logs/{id}/shipment": { "get": { "x-controller-name": "ShipmentPriceLogsShipmentController", "x-operation-name": "getShipment", "tags": [ "ShipmentPriceLogsShipmentController" ], "responses": { "200": { "description": "Shipment belonging to ShipmentPriceLogs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Shipment" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ShipmentPriceLogsShipmentController.getShipment" } }, "/shipment-price-logs/{id}/user": { "get": { "x-controller-name": "ShipmentPriceLogsUserController", "x-operation-name": "getUser", "tags": [ "ShipmentPriceLogsUserController" ], "responses": { "200": { "description": "User belonging to ShipmentPriceLogs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ShipmentPriceLogsUserController.getUser" } }, "/shipment-prices/{id}/shipment": { "get": { "x-controller-name": "ShipmentPriceShipmentController", "x-operation-name": "getShipment", "tags": [ "ShipmentPriceShipmentController" ], "responses": { "200": { "description": "Shipment belonging to ShipmentPrice", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Shipment" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ShipmentPriceShipmentController.getShipment" } }, "/shipment-status/count": { "get": { "x-controller-name": "ShipmentStatusController", "x-operation-name": "count", "tags": [ "ShipmentStatusController" ], "responses": { "200": { "description": "Shipment model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Shipment.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "ShipmentStatusController.count" } }, "/shipment-status/{id}": { "patch": { "x-controller-name": "ShipmentStatusController", "x-operation-name": "updateById", "tags": [ "ShipmentStatusController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Shipment PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipmentPartial" } } }, "x-parameter-index": 1 }, "operationId": "ShipmentStatusController.updateById" }, "delete": { "x-controller-name": "ShipmentStatusController", "x-operation-name": "deleteById", "tags": [ "ShipmentStatusController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Shipment DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ShipmentStatusController.deleteById" } }, "/shipment-status": { "post": { "x-controller-name": "ShipmentStatusController", "x-operation-name": "create", "tags": [ "ShipmentStatusController" ], "responses": { "200": { "description": "Shipment model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Shipment" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewShipment" } } } }, "operationId": "ShipmentStatusController.create" } }, "/shipment-trackings/count": { "get": { "x-controller-name": "ShipmentTrackingController", "x-operation-name": "count", "tags": [ "ShipmentTrackingController" ], "responses": { "200": { "description": "ShipmentTracking model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "ShipmentTracking.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "ShipmentTrackingController.count" } }, "/shipment-trackings/current-user": { "get": { "x-controller-name": "TruckerToolsWebhookController", "x-operation-name": "getCurrentUserShipmentTrackings", "tags": [ "TruckerToolsWebhookController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker view shipment |\n", "responses": { "200": { "description": "Recent shipment tracking records for current logged-in broker", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "statusPageLink": { "type": "string" }, "code": { "type": "string" }, "name": { "type": "string" }, "lastlocationUpdate": { "type": "string", "format": "date-time" } } } } } } } }, "operationId": "TruckerToolsWebhookController.getCurrentUserShipmentTrackings" } }, "/shipment-trackings/{id}/shipment": { "get": { "x-controller-name": "ShipmentTrackingShipmentController", "x-operation-name": "getShipment", "tags": [ "ShipmentTrackingShipmentController" ], "responses": { "200": { "description": "Shipment belonging to ShipmentTracking", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Shipment" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ShipmentTrackingShipmentController.getShipment" } }, "/shipment-trackings/{id}": { "put": { "x-controller-name": "ShipmentTrackingController", "x-operation-name": "replaceById", "tags": [ "ShipmentTrackingController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "ShipmentTracking PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipmentTracking" } } }, "x-parameter-index": 1 }, "operationId": "ShipmentTrackingController.replaceById" }, "patch": { "x-controller-name": "ShipmentTrackingController", "x-operation-name": "updateById", "tags": [ "ShipmentTrackingController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "ShipmentTracking PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipmentTrackingPartial" } } }, "x-parameter-index": 1 }, "operationId": "ShipmentTrackingController.updateById" }, "get": { "x-controller-name": "ShipmentTrackingController", "x-operation-name": "findById", "tags": [ "ShipmentTrackingController" ], "responses": { "200": { "description": "ShipmentTracking model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipmentTrackingWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ShipmentTrackingController.findById" }, "delete": { "x-controller-name": "ShipmentTrackingController", "x-operation-name": "deleteById", "tags": [ "ShipmentTrackingController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "ShipmentTracking DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ShipmentTrackingController.deleteById" } }, "/shipment-trackings": { "post": { "x-controller-name": "ShipmentTrackingController", "x-operation-name": "create", "tags": [ "ShipmentTrackingController" ], "responses": { "200": { "description": "ShipmentTracking model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipmentTracking" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "ShipmentTrackingController.create" }, "patch": { "x-controller-name": "ShipmentTrackingController", "x-operation-name": "updateAll", "tags": [ "ShipmentTrackingController" ], "responses": { "200": { "description": "ShipmentTracking PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "ShipmentTracking.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipmentTrackingPartial" } } } }, "operationId": "ShipmentTrackingController.updateAll" }, "get": { "x-controller-name": "ShipmentTrackingController", "x-operation-name": "find", "tags": [ "ShipmentTrackingController" ], "responses": { "200": { "description": "Array of ShipmentTracking model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ShipmentTrackingWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipmentTracking.Filter" } } } } ], "operationId": "ShipmentTrackingController.find" } }, "/shipmentresetlogs/{id}/carriers": { "get": { "x-controller-name": "ShipmentresetlogsCarriersController", "x-operation-name": "getCarriers", "tags": [ "ShipmentresetlogsCarriersController" ], "responses": { "200": { "description": "Carriers belonging to Shipmentresetlogs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Carriers" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ShipmentresetlogsCarriersController.getCarriers" } }, "/shipmentresetlogs/{id}/shipment": { "get": { "x-controller-name": "ShipmentresetlogsShipmentController", "x-operation-name": "getShipment", "tags": [ "ShipmentresetlogsShipmentController" ], "responses": { "200": { "description": "Shipment belonging to Shipmentresetlogs", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Shipment" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ShipmentresetlogsShipmentController.getShipment" } }, "/shipments/bol/download/{id}": { "get": { "x-controller-name": "ShipmentController", "x-operation-name": "shipperBOLDownload", "tags": [ "ShipmentController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker create shipment |\n", "responses": { "200": { "description": "Return value of ShipmentController.shipperBOLDownload", "content": {} }, "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Shipment PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "ShipmentController.shipperBOLDownload" } }, "/shipments/bol/{id}": { "post": { "x-controller-name": "ShipmentController", "x-operation-name": "shipperBOL", "tags": [ "ShipmentController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker create shipment |\n", "responses": { "200": { "description": "Return value of ShipmentController.shipperBOL", "content": {} }, "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Shipment PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "from", "to" ], "properties": { "from": { "type": "string", "maxLength": 50 }, "to": { "type": "string", "maxLength": 50 } } } } }, "x-parameter-index": 1 }, "operationId": "ShipmentController.shipperBOL" } }, "/shipments/bol-without-drop/{id}": { "get": { "x-controller-name": "ShipmentController", "x-operation-name": "BOLWithOutDrop", "tags": [ "ShipmentController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker create shipment |\n", "responses": { "200": { "description": "Return value of ShipmentController.BOLWithOutDrop", "content": {} }, "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Shipment PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "ShipmentController.BOLWithOutDrop" } }, "/shipments/bol-without-pick/{id}": { "get": { "x-controller-name": "ShipmentController", "x-operation-name": "BOLWithOutPick", "tags": [ "ShipmentController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker create shipment |\n", "responses": { "200": { "description": "Return value of ShipmentController.BOLWithOutPick", "content": {} }, "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Shipment PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "ShipmentController.BOLWithOutPick" } }, "/shipments/carrier-rc/{id}": { "post": { "x-controller-name": "ShipmentController", "x-operation-name": "carrierRc", "tags": [ "ShipmentController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker create shipment |\n", "responses": { "200": { "description": "Return value of ShipmentController.carrierRc", "content": {} }, "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Shipment PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "from", "to" ], "properties": { "from": { "type": "string", "maxLength": 50 }, "to": { "type": "array" } } } } }, "x-parameter-index": 1 }, "operationId": "ShipmentController.carrierRc" } }, "/shipments/count": { "get": { "x-controller-name": "ShipmentController", "x-operation-name": "count", "tags": [ "ShipmentController" ], "responses": { "200": { "description": "Shipment model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Shipment.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "ShipmentController.count" } }, "/shipments/download-bol/{id}": { "get": { "x-controller-name": "ShipmentController", "x-operation-name": "BOLDownload", "tags": [ "ShipmentController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker create shipment |\n", "responses": { "200": { "description": "Return value of ShipmentController.BOLDownload", "content": {} }, "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Shipment PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "ShipmentController.BOLDownload" } }, "/shipments/download-carrier-rc/{id}": { "get": { "x-controller-name": "ShipmentController", "x-operation-name": "CarrierRcDownload", "tags": [ "ShipmentController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker create shipment |\n", "responses": { "200": { "description": "Return value of ShipmentController.CarrierRcDownload", "content": {} }, "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Shipment PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "ShipmentController.CarrierRcDownload" } }, "/shipments/download-document/{id}": { "get": { "x-controller-name": "BrokerVinVerificationController", "x-operation-name": "DownloadDocument", "tags": [ "BrokerVinVerificationController" ], "responses": { "200": { "description": "ShipmentPicks model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipmentPicksWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "BrokerVinVerificationController.DownloadDocument" } }, "/shipments/download-shipper-rc/{id}": { "get": { "x-controller-name": "ShipmentController", "x-operation-name": "ShipperRcDownload", "tags": [ "ShipmentController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker create shipment |\n", "responses": { "200": { "description": "Return value of ShipmentController.ShipperRcDownload", "content": {} }, "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Shipment PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "ShipmentController.ShipperRcDownload" } }, "/shipments/shipper-rc/{id}": { "post": { "x-controller-name": "ShipmentController", "x-operation-name": "shipperRc", "tags": [ "ShipmentController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker create shipment |\n", "responses": { "200": { "description": "Return value of ShipmentController.shipperRc", "content": {} }, "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Shipment PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "from", "to" ], "properties": { "from": { "type": "string", "maxLength": 50 }, "to": { "type": "string", "maxLength": 50 } } } } }, "x-parameter-index": 1 }, "operationId": "ShipmentController.shipperRc" } }, "/shipments/{id}/ap-incentive": { "post": { "x-controller-name": "ShipmentApIncentiveController", "x-operation-name": "create", "tags": [ "ShipmentApIncentiveController" ], "responses": { "200": { "description": "Shipment model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApIncentive" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewApIncentiveInShipment" } } }, "x-parameter-index": 1 }, "operationId": "ShipmentApIncentiveController.create" }, "patch": { "x-controller-name": "ShipmentApIncentiveController", "x-operation-name": "patch", "tags": [ "ShipmentApIncentiveController" ], "responses": { "200": { "description": "Shipment.ApIncentive PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "ApIncentive.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApIncentivePartial" } } }, "x-parameter-index": 1 }, "operationId": "ShipmentApIncentiveController.patch" }, "get": { "x-controller-name": "ShipmentApIncentiveController", "x-operation-name": "get", "tags": [ "ShipmentApIncentiveController" ], "responses": { "200": { "description": "Shipment has one ApIncentive", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApIncentive" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } ], "operationId": "ShipmentApIncentiveController.get" }, "delete": { "x-controller-name": "ShipmentApIncentiveController", "x-operation-name": "delete", "tags": [ "ShipmentApIncentiveController" ], "responses": { "200": { "description": "Shipment.ApIncentive DELETE success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "ApIncentive.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "ShipmentApIncentiveController.delete" } }, "/shipments/{id}/audit-verify-commodities": { "post": { "x-controller-name": "ShipmentAuditVerifyCommodityController", "x-operation-name": "create", "tags": [ "ShipmentAuditVerifyCommodityController" ], "responses": { "200": { "description": "Shipment model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuditVerifyCommodity" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewAuditVerifyCommodityInShipment" } } }, "x-parameter-index": 1 }, "operationId": "ShipmentAuditVerifyCommodityController.create" }, "patch": { "x-controller-name": "ShipmentAuditVerifyCommodityController", "x-operation-name": "patch", "tags": [ "ShipmentAuditVerifyCommodityController" ], "responses": { "200": { "description": "Shipment.AuditVerifyCommodity PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "AuditVerifyCommodity.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuditVerifyCommodityPartial" } } }, "x-parameter-index": 1 }, "operationId": "ShipmentAuditVerifyCommodityController.patch" }, "get": { "x-controller-name": "ShipmentAuditVerifyCommodityController", "x-operation-name": "find", "tags": [ "ShipmentAuditVerifyCommodityController" ], "responses": { "200": { "description": "Array of Shipment has many AuditVerifyCommodity", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AuditVerifyCommodity" } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } ], "operationId": "ShipmentAuditVerifyCommodityController.find" }, "delete": { "x-controller-name": "ShipmentAuditVerifyCommodityController", "x-operation-name": "delete", "tags": [ "ShipmentAuditVerifyCommodityController" ], "responses": { "200": { "description": "Shipment.AuditVerifyCommodity DELETE success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "AuditVerifyCommodity.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "ShipmentAuditVerifyCommodityController.delete" } }, "/shipments/{id}/audit-verify-cprs": { "post": { "x-controller-name": "ShipmentAuditVerifyCprController", "x-operation-name": "create", "tags": [ "ShipmentAuditVerifyCprController" ], "responses": { "200": { "description": "Shipment model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuditVerifyCpr" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewAuditVerifyCprInShipment" } } }, "x-parameter-index": 1 }, "operationId": "ShipmentAuditVerifyCprController.create" }, "patch": { "x-controller-name": "ShipmentAuditVerifyCprController", "x-operation-name": "patch", "tags": [ "ShipmentAuditVerifyCprController" ], "responses": { "200": { "description": "Shipment.AuditVerifyCpr PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "AuditVerifyCpr.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuditVerifyCprPartial" } } }, "x-parameter-index": 1 }, "operationId": "ShipmentAuditVerifyCprController.patch" }, "get": { "x-controller-name": "ShipmentAuditVerifyCprController", "x-operation-name": "find", "tags": [ "ShipmentAuditVerifyCprController" ], "responses": { "200": { "description": "Array of Shipment has many AuditVerifyCpr", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AuditVerifyCpr" } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } ], "operationId": "ShipmentAuditVerifyCprController.find" }, "delete": { "x-controller-name": "ShipmentAuditVerifyCprController", "x-operation-name": "delete", "tags": [ "ShipmentAuditVerifyCprController" ], "responses": { "200": { "description": "Shipment.AuditVerifyCpr DELETE success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "AuditVerifyCpr.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "ShipmentAuditVerifyCprController.delete" } }, "/shipments/{id}/carrier-aging": { "post": { "x-controller-name": "ShipmentCarrierAgingController", "x-operation-name": "create", "tags": [ "ShipmentCarrierAgingController" ], "responses": { "200": { "description": "Shipment model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CarrierAging" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewCarrierAgingInShipment" } } }, "x-parameter-index": 1 }, "operationId": "ShipmentCarrierAgingController.create" }, "patch": { "x-controller-name": "ShipmentCarrierAgingController", "x-operation-name": "patch", "tags": [ "ShipmentCarrierAgingController" ], "responses": { "200": { "description": "Shipment.CarrierAging PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "CarrierAging.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CarrierAgingPartial" } } }, "x-parameter-index": 1 }, "operationId": "ShipmentCarrierAgingController.patch" }, "get": { "x-controller-name": "ShipmentCarrierAgingController", "x-operation-name": "get", "tags": [ "ShipmentCarrierAgingController" ], "responses": { "200": { "description": "Shipment has one CarrierAging", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CarrierAging" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } ], "operationId": "ShipmentCarrierAgingController.get" }, "delete": { "x-controller-name": "ShipmentCarrierAgingController", "x-operation-name": "delete", "tags": [ "ShipmentCarrierAgingController" ], "responses": { "200": { "description": "Shipment.CarrierAging DELETE success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "CarrierAging.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "ShipmentCarrierAgingController.delete" } }, "/shipments/{id}/carrier-backoff": { "post": { "x-controller-name": "ShipmentController", "x-operation-name": "carrierBackoff", "tags": [ "ShipmentController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker create shipment |\n", "responses": { "200": { "description": "Shipment model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Shipment" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "ShipmentController.carrierBackoff" } }, "/shipments/{id}/carrier-payment": { "post": { "x-controller-name": "ShipmentCarrierPaymentController", "x-operation-name": "create", "tags": [ "ShipmentCarrierPaymentController" ], "responses": { "200": { "description": "Shipment model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CarrierPayment" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewCarrierPaymentInShipment" } } }, "x-parameter-index": 1 }, "operationId": "ShipmentCarrierPaymentController.create" }, "patch": { "x-controller-name": "ShipmentCarrierPaymentController", "x-operation-name": "patch", "tags": [ "ShipmentCarrierPaymentController" ], "responses": { "200": { "description": "Shipment.CarrierPayment PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "CarrierPayment.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CarrierPaymentPartial" } } }, "x-parameter-index": 1 }, "operationId": "ShipmentCarrierPaymentController.patch" }, "get": { "x-controller-name": "ShipmentCarrierPaymentController", "x-operation-name": "get", "tags": [ "ShipmentCarrierPaymentController" ], "responses": { "200": { "description": "Shipment has one CarrierPayment", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CarrierPayment" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } ], "operationId": "ShipmentCarrierPaymentController.get" }, "delete": { "x-controller-name": "ShipmentCarrierPaymentController", "x-operation-name": "delete", "tags": [ "ShipmentCarrierPaymentController" ], "responses": { "200": { "description": "Shipment.CarrierPayment DELETE success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "CarrierPayment.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "ShipmentCarrierPaymentController.delete" } }, "/shipments/{id}/carriers": { "get": { "x-controller-name": "ShipmentCarriersController", "x-operation-name": "getCarriers", "tags": [ "ShipmentCarriersController" ], "responses": { "200": { "description": "Carriers belonging to Shipment", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Carriers" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ShipmentCarriersController.getCarriers" } }, "/shipments/{id}/commodities": { "get": { "x-controller-name": "ShipmentCommoditiesController", "x-operation-name": "getCommodities", "tags": [ "ShipmentCommoditiesController" ], "responses": { "200": { "description": "Commodities belonging to Shipment", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Commodities" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ShipmentCommoditiesController.getCommodities" } }, "/shipments/{id}/cpr-request": { "post": { "x-controller-name": "ShipmentCprRequestController", "x-operation-name": "create", "tags": [ "ShipmentCprRequestController" ], "responses": { "200": { "description": "Shipment model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CprRequest" } } } } }, "description": "\n\n| Permissions |\n| ------- |\n| broker create shipment |\n", "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "ShipmentCprRequestController.create" }, "patch": { "x-controller-name": "ShipmentCprRequestController", "x-operation-name": "patch", "tags": [ "ShipmentCprRequestController" ], "responses": { "200": { "description": "Shipment.CprRequest PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "CprRequest.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CprRequestPartial" } } }, "x-parameter-index": 1 }, "operationId": "ShipmentCprRequestController.patch" }, "get": { "x-controller-name": "ShipmentCprRequestController", "x-operation-name": "get", "tags": [ "ShipmentCprRequestController" ], "responses": { "200": { "description": "Shipment has one CprRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CprRequest" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "ShipmentCprRequestController.get" }, "delete": { "x-controller-name": "ShipmentCprRequestController", "x-operation-name": "delete", "tags": [ "ShipmentCprRequestController" ], "responses": { "200": { "description": "Shipment.CprRequest DELETE success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "CprRequest.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "ShipmentCprRequestController.delete" } }, "/shipments/{id}/equipment": { "get": { "x-controller-name": "ShipmentEquipmentController", "x-operation-name": "getEquipment", "tags": [ "ShipmentEquipmentController" ], "responses": { "200": { "description": "Equipment belonging to Shipment", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Equipment" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ShipmentEquipmentController.getEquipment" } }, "/shipments/{id}/good-to-go-history": { "get": { "x-controller-name": "ShipmentGoodToGoHistoryController", "x-operation-name": "getGoodToGoHistory", "tags": [ "ShipmentGoodToGoHistoryController" ], "responses": { "200": { "description": "GoodToGoHistory belonging to Shipment", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GoodToGoHistory" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ShipmentGoodToGoHistoryController.getGoodToGoHistory" } }, "/shipments/{id}/gtg-histories": { "post": { "x-controller-name": "ShipmentGtgHistoryController", "x-operation-name": "create", "tags": [ "ShipmentGtgHistoryController" ], "responses": { "200": { "description": "Shipment model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GtgHistory" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewGtgHistoryInShipment" } } }, "x-parameter-index": 1 }, "operationId": "ShipmentGtgHistoryController.create" }, "patch": { "x-controller-name": "ShipmentGtgHistoryController", "x-operation-name": "patch", "tags": [ "ShipmentGtgHistoryController" ], "responses": { "200": { "description": "Shipment.GtgHistory PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "GtgHistory.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GtgHistoryPartial" } } }, "x-parameter-index": 1 }, "operationId": "ShipmentGtgHistoryController.patch" }, "get": { "x-controller-name": "ShipmentGtgHistoryController", "x-operation-name": "find", "tags": [ "ShipmentGtgHistoryController" ], "responses": { "200": { "description": "Array of Shipment has many GtgHistory", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GtgHistory" } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } ], "operationId": "ShipmentGtgHistoryController.find" }, "delete": { "x-controller-name": "ShipmentGtgHistoryController", "x-operation-name": "delete", "tags": [ "ShipmentGtgHistoryController" ], "responses": { "200": { "description": "Shipment.GtgHistory DELETE success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "GtgHistory.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "ShipmentGtgHistoryController.delete" } }, "/shipments/{id}/invoices": { "post": { "x-controller-name": "ShipmentInvoicesController", "x-operation-name": "create", "tags": [ "ShipmentInvoicesController" ], "responses": { "200": { "description": "Shipment model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Invoices" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewInvoicesInShipment" } } }, "x-parameter-index": 1 }, "operationId": "ShipmentInvoicesController.create" }, "patch": { "x-controller-name": "ShipmentInvoicesController", "x-operation-name": "patch", "tags": [ "ShipmentInvoicesController" ], "responses": { "200": { "description": "Shipment.Invoices PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Invoices.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoicesPartial" } } }, "x-parameter-index": 1 }, "operationId": "ShipmentInvoicesController.patch" }, "get": { "x-controller-name": "ShipmentInvoicesController", "x-operation-name": "get", "tags": [ "ShipmentInvoicesController" ], "responses": { "200": { "description": "Shipment has one Invoices", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Invoices" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } ], "operationId": "ShipmentInvoicesController.get" }, "delete": { "x-controller-name": "ShipmentInvoicesController", "x-operation-name": "delete", "tags": [ "ShipmentInvoicesController" ], "responses": { "200": { "description": "Shipment.Invoices DELETE success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Invoices.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "ShipmentInvoicesController.delete" } }, "/shipments/{id}/mc-re-verification": { "post": { "x-controller-name": "ShipmentMcReVerificationController", "x-operation-name": "create", "tags": [ "ShipmentMcReVerificationController" ], "responses": { "200": { "description": "Shipment model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/McReVerification" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewMcReVerificationInShipment" } } }, "x-parameter-index": 1 }, "operationId": "ShipmentMcReVerificationController.create" }, "patch": { "x-controller-name": "ShipmentMcReVerificationController", "x-operation-name": "patch", "tags": [ "ShipmentMcReVerificationController" ], "responses": { "200": { "description": "Shipment.McReVerification PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "McReVerification.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/McReVerificationPartial" } } }, "x-parameter-index": 1 }, "operationId": "ShipmentMcReVerificationController.patch" }, "get": { "x-controller-name": "ShipmentMcReVerificationController", "x-operation-name": "get", "tags": [ "ShipmentMcReVerificationController" ], "responses": { "200": { "description": "Shipment has one McReVerification", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/McReVerification" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } ], "operationId": "ShipmentMcReVerificationController.get" }, "delete": { "x-controller-name": "ShipmentMcReVerificationController", "x-operation-name": "delete", "tags": [ "ShipmentMcReVerificationController" ], "responses": { "200": { "description": "Shipment.McReVerification DELETE success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "McReVerification.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "ShipmentMcReVerificationController.delete" } }, "/shipments/{id}/portal": { "get": { "x-controller-name": "ShipmentPortalController", "x-operation-name": "getPortal", "tags": [ "ShipmentPortalController" ], "responses": { "200": { "description": "Portal belonging to Shipment", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Portal" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ShipmentPortalController.getPortal" } }, "/shipments/{id}/shipment-carrier": { "post": { "x-controller-name": "ShipmentShipmentCarrierController", "x-operation-name": "create", "tags": [ "ShipmentShipmentCarrierController" ], "responses": { "200": { "description": "Shipment model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipmentCarrier" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewShipmentCarrierInShipment" } } }, "x-parameter-index": 1 }, "operationId": "ShipmentShipmentCarrierController.create" }, "patch": { "x-controller-name": "ShipmentShipmentCarrierController", "x-operation-name": "patch", "tags": [ "ShipmentShipmentCarrierController" ], "responses": { "200": { "description": "Shipment.ShipmentCarrier PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "ShipmentCarrier.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipmentCarrierPartial" } } }, "x-parameter-index": 1 }, "operationId": "ShipmentShipmentCarrierController.patch" }, "get": { "x-controller-name": "ShipmentShipmentCarrierController", "x-operation-name": "get", "tags": [ "ShipmentShipmentCarrierController" ], "responses": { "200": { "description": "Shipment has one ShipmentCarrier", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipmentCarrier" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } ], "operationId": "ShipmentShipmentCarrierController.get" }, "delete": { "x-controller-name": "ShipmentShipmentCarrierController", "x-operation-name": "delete", "tags": [ "ShipmentShipmentCarrierController" ], "responses": { "200": { "description": "Shipment.ShipmentCarrier DELETE success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "ShipmentCarrier.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "ShipmentShipmentCarrierController.delete" } }, "/shipments/{id}/shipment-details": { "post": { "x-controller-name": "ShipmentShipmentDetailsController", "x-operation-name": "create", "tags": [ "ShipmentShipmentDetailsController" ], "responses": { "200": { "description": "Shipment model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipmentDetails" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewShipmentDetailsInShipment" } } }, "x-parameter-index": 1 }, "operationId": "ShipmentShipmentDetailsController.create" }, "patch": { "x-controller-name": "ShipmentShipmentDetailsController", "x-operation-name": "patch", "tags": [ "ShipmentShipmentDetailsController" ], "responses": { "200": { "description": "Shipment.ShipmentDetails PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "ShipmentDetails.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipmentDetailsPartial" } } }, "x-parameter-index": 1 }, "operationId": "ShipmentShipmentDetailsController.patch" }, "get": { "x-controller-name": "ShipmentShipmentDetailsController", "x-operation-name": "get", "tags": [ "ShipmentShipmentDetailsController" ], "responses": { "200": { "description": "Shipment has one ShipmentDetails", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipmentDetails" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } ], "operationId": "ShipmentShipmentDetailsController.get" }, "delete": { "x-controller-name": "ShipmentShipmentDetailsController", "x-operation-name": "delete", "tags": [ "ShipmentShipmentDetailsController" ], "responses": { "200": { "description": "Shipment.ShipmentDetails DELETE success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "ShipmentDetails.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "ShipmentShipmentDetailsController.delete" } }, "/shipments/{id}/shipment-docs": { "post": { "x-controller-name": "ShipmentShipmentDocsController", "x-operation-name": "create", "tags": [ "ShipmentShipmentDocsController" ], "responses": { "200": { "description": "Shipment model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipmentDocs" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewShipmentDocsInShipment" } } }, "x-parameter-index": 1 }, "operationId": "ShipmentShipmentDocsController.create" }, "patch": { "x-controller-name": "ShipmentShipmentDocsController", "x-operation-name": "patch", "tags": [ "ShipmentShipmentDocsController" ], "responses": { "200": { "description": "Shipment.ShipmentDocs PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "ShipmentDocs.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipmentDocsPartial" } } }, "x-parameter-index": 1 }, "operationId": "ShipmentShipmentDocsController.patch" }, "get": { "x-controller-name": "ShipmentShipmentDocsController", "x-operation-name": "find", "tags": [ "ShipmentShipmentDocsController" ], "responses": { "200": { "description": "Array of Shipment has many ShipmentDocs", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ShipmentDocs" } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } ], "operationId": "ShipmentShipmentDocsController.find" }, "delete": { "x-controller-name": "ShipmentShipmentDocsController", "x-operation-name": "delete", "tags": [ "ShipmentShipmentDocsController" ], "responses": { "200": { "description": "Shipment.ShipmentDocs DELETE success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "ShipmentDocs.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "ShipmentShipmentDocsController.delete" } }, "/shipments/{id}/shipment-docs-delete": { "get": { "x-controller-name": "ShipmentController", "x-operation-name": "delete", "tags": [ "ShipmentController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Shipment get delete" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ShipmentController.delete" } }, "/shipments/{id}/shipment-drops": { "post": { "x-controller-name": "ShipmentShipmentDropsController", "x-operation-name": "create", "tags": [ "ShipmentShipmentDropsController" ], "responses": { "200": { "description": "Shipment model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipmentDrops" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewShipmentDropsInShipment" } } }, "x-parameter-index": 1 }, "operationId": "ShipmentShipmentDropsController.create" }, "patch": { "x-controller-name": "ShipmentShipmentDropsController", "x-operation-name": "patch", "tags": [ "ShipmentShipmentDropsController" ], "responses": { "200": { "description": "Shipment.ShipmentDrops PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "ShipmentDrops.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipmentDropsPartial" } } }, "x-parameter-index": 1 }, "operationId": "ShipmentShipmentDropsController.patch" }, "get": { "x-controller-name": "ShipmentShipmentDropsController", "x-operation-name": "find", "tags": [ "ShipmentShipmentDropsController" ], "responses": { "200": { "description": "Array of Shipment has many ShipmentDrops", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ShipmentDrops" } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } ], "operationId": "ShipmentShipmentDropsController.find" }, "delete": { "x-controller-name": "ShipmentShipmentDropsController", "x-operation-name": "delete", "tags": [ "ShipmentShipmentDropsController" ], "responses": { "200": { "description": "Shipment.ShipmentDrops DELETE success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "ShipmentDrops.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "ShipmentShipmentDropsController.delete" } }, "/shipments/{id}/shipment-picks": { "post": { "x-controller-name": "ShipmentShipmentPicksController", "x-operation-name": "create", "tags": [ "ShipmentShipmentPicksController" ], "responses": { "200": { "description": "Shipment model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipmentPicks" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewShipmentPicksInShipment" } } }, "x-parameter-index": 1 }, "operationId": "ShipmentShipmentPicksController.create" }, "patch": { "x-controller-name": "ShipmentShipmentPicksController", "x-operation-name": "patch", "tags": [ "ShipmentShipmentPicksController" ], "responses": { "200": { "description": "Shipment.ShipmentPicks PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "ShipmentPicks.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipmentPicksPartial" } } }, "x-parameter-index": 1 }, "operationId": "ShipmentShipmentPicksController.patch" }, "get": { "x-controller-name": "ShipmentShipmentPicksController", "x-operation-name": "find", "tags": [ "ShipmentShipmentPicksController" ], "responses": { "200": { "description": "Array of Shipment has many ShipmentPicks", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ShipmentPicks" } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } ], "operationId": "ShipmentShipmentPicksController.find" }, "delete": { "x-controller-name": "ShipmentShipmentPicksController", "x-operation-name": "delete", "tags": [ "ShipmentShipmentPicksController" ], "responses": { "200": { "description": "Shipment.ShipmentPicks DELETE success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "ShipmentPicks.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "ShipmentShipmentPicksController.delete" } }, "/shipments/{id}/shipment-prices": { "post": { "x-controller-name": "ShipmentShipmentPriceController", "x-operation-name": "create", "tags": [ "ShipmentShipmentPriceController" ], "responses": { "200": { "description": "Shipment model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipmentPrice" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewShipmentPriceInShipment" } } }, "x-parameter-index": 1 }, "operationId": "ShipmentShipmentPriceController.create" }, "patch": { "x-controller-name": "ShipmentShipmentPriceController", "x-operation-name": "patch", "tags": [ "ShipmentShipmentPriceController" ], "responses": { "200": { "description": "Shipment.ShipmentPrice PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "ShipmentPrice.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipmentPricePartial" } } }, "x-parameter-index": 1 }, "operationId": "ShipmentShipmentPriceController.patch" }, "get": { "x-controller-name": "ShipmentShipmentPriceController", "x-operation-name": "find", "tags": [ "ShipmentShipmentPriceController" ], "responses": { "200": { "description": "Array of Shipment has many ShipmentPrice", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ShipmentPrice" } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } ], "operationId": "ShipmentShipmentPriceController.find" }, "delete": { "x-controller-name": "ShipmentShipmentPriceController", "x-operation-name": "delete", "tags": [ "ShipmentShipmentPriceController" ], "responses": { "200": { "description": "Shipment.ShipmentPrice DELETE success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "ShipmentPrice.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "ShipmentShipmentPriceController.delete" } }, "/shipments/{id}/shipment-timelines": { "post": { "x-controller-name": "ShipmentShipmentTimelineController", "x-operation-name": "create", "tags": [ "ShipmentShipmentTimelineController" ], "responses": { "200": { "description": "Shipment model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipmentTimeline" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewShipmentTimelineInShipment" } } }, "x-parameter-index": 1 }, "operationId": "ShipmentShipmentTimelineController.create" }, "patch": { "x-controller-name": "ShipmentShipmentTimelineController", "x-operation-name": "patch", "tags": [ "ShipmentShipmentTimelineController" ], "responses": { "200": { "description": "Shipment.ShipmentTimeline PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "ShipmentTimeline.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipmentTimelinePartial" } } }, "x-parameter-index": 1 }, "operationId": "ShipmentShipmentTimelineController.patch" }, "get": { "x-controller-name": "ShipmentShipmentTimelineController", "x-operation-name": "find", "tags": [ "ShipmentShipmentTimelineController" ], "responses": { "200": { "description": "Array of Shipment has many ShipmentTimeline", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ShipmentTimeline" } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } ], "operationId": "ShipmentShipmentTimelineController.find" }, "delete": { "x-controller-name": "ShipmentShipmentTimelineController", "x-operation-name": "delete", "tags": [ "ShipmentShipmentTimelineController" ], "responses": { "200": { "description": "Shipment.ShipmentTimeline DELETE success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "ShipmentTimeline.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "ShipmentShipmentTimelineController.delete" } }, "/shipments/{id}/shippers": { "get": { "x-controller-name": "ShipmentShippersController", "x-operation-name": "getShippers", "tags": [ "ShipmentShippersController" ], "responses": { "200": { "description": "Shippers belonging to Shipment", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Shippers" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ShipmentShippersController.getShippers" } }, "/shipments/{id}/sign-doc": { "post": { "x-controller-name": "ShipmentSignDocController", "x-operation-name": "create", "tags": [ "ShipmentSignDocController" ], "responses": { "200": { "description": "Shipment model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SignDoc" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewSignDocInShipment" } } }, "x-parameter-index": 1 }, "operationId": "ShipmentSignDocController.create" }, "patch": { "x-controller-name": "ShipmentSignDocController", "x-operation-name": "patch", "tags": [ "ShipmentSignDocController" ], "responses": { "200": { "description": "Shipment.SignDoc PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "SignDoc.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SignDocPartial" } } }, "x-parameter-index": 1 }, "operationId": "ShipmentSignDocController.patch" }, "get": { "x-controller-name": "ShipmentSignDocController", "x-operation-name": "get", "tags": [ "ShipmentSignDocController" ], "responses": { "200": { "description": "Shipment has one SignDoc", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SignDoc" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } ], "operationId": "ShipmentSignDocController.get" }, "delete": { "x-controller-name": "ShipmentSignDocController", "x-operation-name": "delete", "tags": [ "ShipmentSignDocController" ], "responses": { "200": { "description": "Shipment.SignDoc DELETE success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "SignDoc.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "ShipmentSignDocController.delete" } }, "/shipments/{id}/user": { "get": { "x-controller-name": "ShipmentUserController", "x-operation-name": "getUser", "tags": [ "ShipmentUserController" ], "responses": { "200": { "description": "User belonging to Shipment", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ShipmentUserController.getUser" } }, "/shipments/{id}": { "put": { "x-controller-name": "ApShipmentControllerController", "x-operation-name": "replaceById", "tags": [ "ApShipmentControllerController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Shipment PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Shipment" } } }, "x-parameter-index": 1 }, "operationId": "ApShipmentControllerController.replaceById" }, "patch": { "x-controller-name": "ApShipmentControllerController", "x-operation-name": "updateById", "tags": [ "ApShipmentControllerController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Shipment PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipmentPartial" } } }, "x-parameter-index": 1 }, "operationId": "ApShipmentControllerController.updateById" }, "get": { "x-controller-name": "ShipmentController", "x-operation-name": "findById", "tags": [ "ShipmentController" ], "responses": { "200": { "description": "Shipment model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipmentWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "ShipmentController.findById" }, "delete": { "x-controller-name": "ApShipmentControllerController", "x-operation-name": "deleteById", "tags": [ "ApShipmentControllerController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Shipment DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ApShipmentControllerController.deleteById" } }, "/shipments": { "post": { "x-controller-name": "ShipmentController", "x-operation-name": "create", "tags": [ "ShipmentController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker create shipment |\n", "responses": { "200": { "description": "Shipment model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Shipment" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewShipment" } } } }, "operationId": "ShipmentController.create" }, "patch": { "x-controller-name": "ShipmentController", "x-operation-name": "updateAll", "tags": [ "ShipmentController" ], "responses": { "200": { "description": "Shipment PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Shipment.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipmentPartial" } } } }, "operationId": "ShipmentController.updateAll" }, "get": { "x-controller-name": "ShipmentController", "x-operation-name": "find", "tags": [ "ShipmentController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker view shipment |\n", "responses": { "200": { "description": "Array of Shipment model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ShipmentWithRelations" } } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Shipment.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } }, { "name": "page", "in": "query", "schema": { "type": "number" } }, { "name": "pageSize", "in": "query", "schema": { "type": "number" } }, { "name": "status", "in": "query", "schema": { "type": "string" } }, { "name": "id", "in": "query", "schema": { "type": "string" } }, { "name": "containerNo", "in": "query", "schema": { "type": "string" } }, { "name": "GTGstatus", "in": "query", "schema": { "type": "string" } }, { "name": "GTGAPstatus", "in": "query", "schema": { "type": "string" } }, { "name": "carriersId", "in": "query", "schema": { "type": "string" } }, { "name": "shippersId", "in": "query", "schema": { "type": "string" } }, { "name": "DateFrom", "in": "query", "schema": { "type": "string" } }, { "name": "DateTo", "in": "query", "schema": { "type": "string" } } ], "operationId": "ShipmentController.find" } }, "/shipments-billing": { "get": { "x-controller-name": "BrokerHomeController", "x-operation-name": "ShipmentsBilling", "tags": [ "BrokerHomeController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker view dashboard |\n", "responses": { "200": { "description": "Shipment model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoicesWithRelations" } } } } }, "parameters": [ { "name": "type", "in": "query", "schema": { "type": "string" } } ], "operationId": "BrokerHomeController.ShipmentsBilling" } }, "/shipments-by-uid/{id}": { "get": { "x-controller-name": "SignRequestController", "x-operation-name": "findById", "tags": [ "SignRequestController" ], "responses": { "200": { "description": "Shipment model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipmentWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "SignRequestController.findById" } }, "/shipments-carrier-rate-conf-prview/{id}": { "get": { "x-controller-name": "ShipmentController", "x-operation-name": "findByIdCarrierRate", "tags": [ "ShipmentController" ], "responses": { "200": { "description": "Shipment model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipmentWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "ShipmentController.findByIdCarrierRate" } }, "/shipments-states": { "get": { "x-controller-name": "BrokerHomeController", "x-operation-name": "ShipmentsStates", "tags": [ "BrokerHomeController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker view dashboard |\n", "responses": { "200": { "description": "Shipment model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoicesWithRelations" } } } } }, "operationId": "BrokerHomeController.ShipmentsStates" } }, "/shipmentsss/{id}": { "get": { "x-controller-name": "ApShipmentControllerController", "x-operation-name": "findById", "tags": [ "ApShipmentControllerController" ], "responses": { "200": { "description": "Shipment model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipmentWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Shipment.Filter" } } } } ], "operationId": "ApShipmentControllerController.findById" } }, "/shipper-assignes/{id}/shippers": { "get": { "x-controller-name": "ShipperAssigneShippersController", "x-operation-name": "getShippers", "tags": [ "ShipperAssigneShippersController" ], "responses": { "200": { "description": "Shippers belonging to ShipperAssigne", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Shippers" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ShipperAssigneShippersController.getShippers" } }, "/shipper-assignes/{id}/user": { "get": { "x-controller-name": "ShipperAssigneUserController", "x-operation-name": "getUser", "tags": [ "ShipperAssigneUserController" ], "responses": { "200": { "description": "User belonging to ShipperAssigne", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ShipperAssigneUserController.getUser" } }, "/shipper-attachments/{id}/shippers": { "get": { "x-controller-name": "ShipperAttachmentShippersController", "x-operation-name": "getShippers", "tags": [ "ShipperAttachmentShippersController" ], "responses": { "200": { "description": "Shippers belonging to ShipperAttachment", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Shippers" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ShipperAttachmentShippersController.getShippers" } }, "/shipper-attachments/{id}/user": { "get": { "x-controller-name": "ShipperAttachmentUserController", "x-operation-name": "getUser", "tags": [ "ShipperAttachmentUserController" ], "responses": { "200": { "description": "User belonging to ShipperAttachment", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ShipperAttachmentUserController.getUser" } }, "/shipper-block": { "post": { "x-controller-name": "ArShippersController", "x-operation-name": "shipperblock", "tags": [ "ArShippersController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar approve shipper |\n", "responses": { "200": { "description": "Shippers History model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipperHistory" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "ArShippersController.shipperblock" } }, "/shipper-contacts/{id}/shippers": { "get": { "x-controller-name": "ShipperContactsShippersController", "x-operation-name": "getShippers", "tags": [ "ShipperContactsShippersController" ], "responses": { "200": { "description": "Shippers belonging to ShipperContacts", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Shippers" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ShipperContactsShippersController.getShippers" } }, "/shipper-credit-app": { "post": { "x-controller-name": "ArShippersController", "x-operation-name": "shippercreditapp", "tags": [ "ArShippersController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar approve shipper |\n", "responses": { "200": { "description": "Shippers History model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipperHistory" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "ArShippersController.shippercreditapp" } }, "/shipper-histories/{id}/portal": { "get": { "x-controller-name": "ShipperHistoryPortalController", "x-operation-name": "getPortal", "tags": [ "ShipperHistoryPortalController" ], "responses": { "200": { "description": "Portal belonging to ShipperHistory", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Portal" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ShipperHistoryPortalController.getPortal" } }, "/shipper-histories/{id}/shippers": { "get": { "x-controller-name": "ShipperHistoryShippersController", "x-operation-name": "getShippers", "tags": [ "ShipperHistoryShippersController" ], "responses": { "200": { "description": "Shippers belonging to ShipperHistory", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Shippers" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ShipperHistoryShippersController.getShippers" } }, "/shipper-histories/{id}/user": { "get": { "x-controller-name": "ShipperHistoryUserController", "x-operation-name": "getUser", "tags": [ "ShipperHistoryUserController" ], "responses": { "200": { "description": "User belonging to ShipperHistory", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ShipperHistoryUserController.getUser" } }, "/shipper-limits/{id}/portal": { "get": { "x-controller-name": "ShipperLimitsPortalController", "x-operation-name": "getPortal", "tags": [ "ShipperLimitsPortalController" ], "responses": { "200": { "description": "Portal belonging to ShipperLimits", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Portal" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ShipperLimitsPortalController.getPortal" } }, "/shipper-limits/{id}/shippers": { "get": { "x-controller-name": "ShipperLimitsShippersController", "x-operation-name": "getShippers", "tags": [ "ShipperLimitsShippersController" ], "responses": { "200": { "description": "Shippers belonging to ShipperLimits", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Shippers" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ShipperLimitsShippersController.getShippers" } }, "/shipper-limits/{id}/user": { "get": { "x-controller-name": "ShipperLimitsUserController", "x-operation-name": "getUser", "tags": [ "ShipperLimitsUserController" ], "responses": { "200": { "description": "User belonging to ShipperLimits", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ShipperLimitsUserController.getUser" } }, "/shipper-payment-remittance/{id}/soft-delete": { "patch": { "x-controller-name": "ShipperPaymentRemittanceController", "x-operation-name": "softDeleteRemittance", "tags": [ "ShipperPaymentRemittanceController" ], "description": "\n\n| Permissions |\n| ------- |\n| payment remittance |\n", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Soft delete a remittance" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ShipperPaymentRemittanceController.softDeleteRemittance" } }, "/shipper-payment-remittances/{id}/shippers": { "get": { "x-controller-name": "ShipperPaymentRemittanceShippersController", "x-operation-name": "getShippers", "tags": [ "ShipperPaymentRemittanceShippersController" ], "responses": { "200": { "description": "Shippers belonging to ShipperPaymentRemittance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Shippers" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ShipperPaymentRemittanceShippersController.getShippers" } }, "/shipper-small-claims/{id}/invoices": { "get": { "x-controller-name": "ShipperSmallClaimInvoicesController", "x-operation-name": "getInvoices", "tags": [ "ShipperSmallClaimInvoicesController" ], "responses": { "200": { "description": "Invoices belonging to ShipperSmallClaim", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Invoices" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ShipperSmallClaimInvoicesController.getInvoices" } }, "/shipper-transfer": { "post": { "x-controller-name": "ArShippersController", "x-operation-name": "shippertransfer", "tags": [ "ArShippersController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar approve shipper |\n", "responses": { "200": { "description": "Shippers History model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipperHistory" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "ArShippersController.shippertransfer" } }, "/shipper-transfers/{id}/shippers": { "get": { "x-controller-name": "ShipperTransferShippersController", "x-operation-name": "getShippers", "tags": [ "ShipperTransferShippersController" ], "responses": { "200": { "description": "Shippers belonging to ShipperTransfer", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Shippers" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ShipperTransferShippersController.getShippers" } }, "/shipper-transfers/{id}/user": { "get": { "x-controller-name": "ShipperTransferUserController", "x-operation-name": "getUser", "tags": [ "ShipperTransferUserController" ], "responses": { "200": { "description": "User belonging to ShipperTransfer", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ShipperTransferUserController.getUser" } }, "/shipper-unknown-payments/delete/{id}": { "patch": { "x-controller-name": "ShipperUnknownPaymentControllerController", "x-operation-name": "softDeleteById", "tags": [ "ShipperUnknownPaymentControllerController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar view unknown payment entries |\n", "responses": { "200": { "description": "Mark ShipperUnknownPayment as deleted", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ShipperUnknownPaymentControllerController.softDeleteById" } }, "/shipper-unknown-payments/update/{id}": { "put": { "x-controller-name": "ShipperUnknownPaymentControllerController", "x-operation-name": "updateById", "tags": [ "ShipperUnknownPaymentControllerController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar view unknown payment entries |\n", "responses": { "200": { "description": "ShipperUnknownPayment model instance updated successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipperUnknownPaymentPartial" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipperUnknownPaymentPartial" } } }, "x-parameter-index": 1 }, "operationId": "ShipperUnknownPaymentControllerController.updateById" } }, "/shipper-unknown-payments/{id}": { "get": { "x-controller-name": "ShipperUnknownPaymentControllerController", "x-operation-name": "findById", "tags": [ "ShipperUnknownPaymentControllerController" ], "responses": { "200": { "description": "ShipperUnknownPayment model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipperUnknownPaymentWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipperUnknownPayment.Filter" } } } } ], "operationId": "ShipperUnknownPaymentControllerController.findById" } }, "/shipper-unknown-payments": { "post": { "x-controller-name": "ShipperUnknownPaymentControllerController", "x-operation-name": "create", "tags": [ "ShipperUnknownPaymentControllerController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar view unknown payment entries |\n", "responses": { "200": { "description": "ShipperUnknownPayment model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipperUnknownPayment" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewShipperUnknownPayment" } } } }, "operationId": "ShipperUnknownPaymentControllerController.create" }, "get": { "x-controller-name": "ShipperUnknownPaymentControllerController", "x-operation-name": "find", "tags": [ "ShipperUnknownPaymentControllerController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar view unknown payment entries |\n", "responses": { "200": { "description": "Array of ShipperUnknownPayment model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ShipperUnknownPaymentWithRelations" } } } } } }, "parameters": [ { "name": "page", "in": "query", "schema": { "type": "number" } }, { "name": "pageSize", "in": "query", "schema": { "type": "number" } }, { "name": "paymentStatus", "in": "query", "schema": { "type": "string" } }, { "name": "communication", "in": "query", "schema": { "type": "string" } }, { "name": "paymentReceivedDate", "in": "query", "schema": { "type": "string" } }, { "name": "companyName", "in": "query", "schema": { "type": "string" } } ], "operationId": "ShipperUnknownPaymentControllerController.find" } }, "/shippernotes/{id}": { "get": { "x-controller-name": "ArShipperAgingController", "x-operation-name": "getShippersCollectionNotes", "tags": [ "ArShipperAgingController" ], "responses": { "200": { "description": "Invoices belonging to Notes", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Invoices" } } } } }, "description": "\n\n| Permissions |\n| ------- |\n| ar view shipper aging |\n", "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ArShipperAgingController.getShippersCollectionNotes" } }, "/shippers/count": { "get": { "x-controller-name": "ShippersController", "x-operation-name": "count", "tags": [ "ShippersController" ], "responses": { "200": { "description": "Shippers model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Shippers.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "ShippersController.count" } }, "/shippers/statistics": { "get": { "x-controller-name": "ShippersController", "x-operation-name": "getShipperStatistics", "tags": [ "ShippersController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker view shipper |\n", "responses": { "200": { "description": "Get shipper statistics for authenticated user", "content": { "application/json": { "schema": { "type": "object", "properties": { "totalShippers": { "type": "number" }, "approvedShippers": { "type": "number" }, "rejectedShippers": { "type": "number" }, "pendingShippers": { "type": "number" }, "blockedShippers": { "type": "number" }, "mideastShippers": { "type": "number" }, "southeastShippers": { "type": "number" }, "northeastShippers": { "type": "number" }, "westShippers": { "type": "number" }, "otherShippers": { "type": "number" }, "onboardingShippers": { "type": "number" }, "activeShippers": { "type": "number" }, "inactiveShippers": { "type": "number" }, "regularShippers": { "type": "number" }, "seasonalShippers": { "type": "number" } } } } } } }, "operationId": "ShippersController.getShipperStatistics" } }, "/shippers/{id}/commodities": { "get": { "x-controller-name": "ShippersCommoditiesController", "x-operation-name": "getCommodities", "tags": [ "ShippersCommoditiesController" ], "responses": { "200": { "description": "Commodities belonging to Shippers", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Commodities" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ShippersCommoditiesController.getCommodities" } }, "/shippers/{id}/companies-insurances": { "post": { "x-controller-name": "ShippersCompaniesInsuranceController", "x-operation-name": "create", "tags": [ "ShippersCompaniesInsuranceController" ], "responses": { "200": { "description": "create a CompaniesInsurance model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompaniesInsurance" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewCompaniesInsuranceInShippers" } } }, "x-parameter-index": 1 }, "operationId": "ShippersCompaniesInsuranceController.create" }, "patch": { "x-controller-name": "ShippersCompaniesInsuranceController", "x-operation-name": "patch", "tags": [ "ShippersCompaniesInsuranceController" ], "responses": { "200": { "description": "Shippers.CompaniesInsurance PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "CompaniesInsurance.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompaniesInsurancePartial" } } }, "x-parameter-index": 1 }, "operationId": "ShippersCompaniesInsuranceController.patch" }, "get": { "x-controller-name": "ShippersCompaniesInsuranceController", "x-operation-name": "find", "tags": [ "ShippersCompaniesInsuranceController" ], "responses": { "200": { "description": "Array of Shippers has many CompaniesInsurance through ShippersCompaniesInsurance", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CompaniesInsurance" } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } ], "operationId": "ShippersCompaniesInsuranceController.find" }, "delete": { "x-controller-name": "ShippersCompaniesInsuranceController", "x-operation-name": "delete", "tags": [ "ShippersCompaniesInsuranceController" ], "responses": { "200": { "description": "Shippers.CompaniesInsurance DELETE success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "CompaniesInsurance.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "ShippersCompaniesInsuranceController.delete" } }, "/shippers/{shipperId}/current-year-earnings": { "get": { "x-controller-name": "ShippersController", "x-operation-name": "getCurrentYearEarnings", "tags": [ "ShippersController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker view shipper |\n", "responses": { "200": { "description": "Get current year earnings by Shipper ID", "content": { "application/json": { "schema": { "type": "object", "properties": { "carrier": { "$ref": "#/components/schemas/ShippersWithRelations" }, "earningsData": { "type": "array", "items": { "type": "object", "properties": { "month": { "type": "string" }, "year": { "type": "number" }, "totalEarnings": { "type": "number" }, "totalPayments": { "type": "number" } } } }, "earnings": { "type": "array", "items": { "type": "number" }, "description": "Array of USD earnings for each month (Jan to Dec)" }, "months": { "type": "array", "items": { "type": "string" }, "description": "Array of month names (Jan to Dec)" } } } } } } }, "parameters": [ { "name": "shipperId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "year", "in": "query", "schema": { "type": "number" } } ], "operationId": "ShippersController.getCurrentYearEarnings" } }, "/shippers/{id}/equipment": { "get": { "x-controller-name": "ShippersEquipmentController", "x-operation-name": "getEquipment", "tags": [ "ShippersEquipmentController" ], "responses": { "200": { "description": "Equipment belonging to Shippers", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Equipment" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ShippersEquipmentController.getEquipment" } }, "/shippers/{id}/invoices": { "post": { "x-controller-name": "ShippersInvoicesController", "x-operation-name": "create", "tags": [ "ShippersInvoicesController" ], "responses": { "200": { "description": "Shippers model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Invoices" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewInvoicesInShippers" } } }, "x-parameter-index": 1 }, "operationId": "ShippersInvoicesController.create" }, "patch": { "x-controller-name": "ShippersInvoicesController", "x-operation-name": "patch", "tags": [ "ShippersInvoicesController" ], "responses": { "200": { "description": "Shippers.Invoices PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Invoices.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoicesPartial" } } }, "x-parameter-index": 1 }, "operationId": "ShippersInvoicesController.patch" }, "get": { "x-controller-name": "ShippersInvoicesController", "x-operation-name": "find", "tags": [ "ShippersInvoicesController" ], "responses": { "200": { "description": "Array of Shippers has many Invoices", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Invoices" } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } ], "operationId": "ShippersInvoicesController.find" }, "delete": { "x-controller-name": "ShippersInvoicesController", "x-operation-name": "delete", "tags": [ "ShippersInvoicesController" ], "responses": { "200": { "description": "Shippers.Invoices DELETE success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Invoices.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "ShippersInvoicesController.delete" } }, "/shippers/{id}/portal": { "get": { "x-controller-name": "ShippersPortalController", "x-operation-name": "getPortal", "tags": [ "ShippersPortalController" ], "responses": { "200": { "description": "Portal belonging to Shippers", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Portal" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ShippersPortalController.getPortal" } }, "/shippers/{shipperId}/shipments-by-user": { "get": { "x-controller-name": "ShippersController", "x-operation-name": "getShipmentsByShipperAndUser", "tags": [ "ShippersController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker view shipper |\n", "responses": { "200": { "description": "Get shipments by shipper ID and user ID with different types and statuses", "content": { "application/json": { "schema": { "type": "object", "properties": { "allShipments": { "type": "array" }, "otrShipments": { "type": "array" }, "drayageShipments": { "type": "array" }, "intermediateShipments": { "type": "array" }, "openShipments": { "type": "array" }, "deliveredShipments": { "type": "array" }, "totalCount": { "type": "number" }, "summary": { "type": "object", "properties": { "totalShipments": { "type": "number" }, "totalOTR": { "type": "number" }, "totalDrayage": { "type": "number" }, "totalIntermediate": { "type": "number" }, "totalOpen": { "type": "number" }, "totalDelivered": { "type": "number" }, "totalValue": { "type": "number" }, "averageValue": { "type": "number" }, "titalcommodityValue": { "type": "number" }, "statusBreakdown": { "type": "object", "properties": { "open": { "type": "number" }, "covered": { "type": "number" }, "consignee": { "type": "number" }, "delivered": { "type": "number" }, "rti": { "type": "number" }, "invoiced": { "type": "number" }, "paid": { "type": "number" }, "badDebt": { "type": "number" }, "tonu": { "type": "number" } } } } } } } } } } }, "parameters": [ { "name": "shipperId", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ShippersController.getShipmentsByShipperAndUser" } }, "/shippers/{shipperId}/shipments-per-month": { "get": { "x-controller-name": "ShippersController", "x-operation-name": "getShipmentsByShipperByYear", "tags": [ "ShippersController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker view shipper |\n", "responses": { "200": { "description": "Get shipments for a shipper for a rolling year window", "content": { "application/json": { "schema": { "type": "object", "properties": { "shipmentsData": { "shipper": { "$ref": "#/components/schemas/ShippersWithRelations", "definitions": { "ShippersWithRelations": { "$ref": "#/components/schemas/ShippersWithRelations" } } }, "type": "array", "items": { "type": "object", "properties": { "month": { "type": "string" }, "year": { "type": "number" }, "totalShipments": { "type": "number" } } } }, "shipmentsCount": { "type": "array", "items": { "type": "number" } }, "months": { "type": "array", "items": { "type": "string" } } } } } } } }, "parameters": [ { "name": "shipperId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "year", "in": "query", "schema": { "type": "number" } } ], "operationId": "ShippersController.getShipmentsByShipperByYear" } }, "/shippers/{id}/shipper-contacts": { "post": { "x-controller-name": "ShippersShipperContactsController", "x-operation-name": "create", "tags": [ "ShippersShipperContactsController" ], "responses": { "200": { "description": "Shippers model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipperContacts" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewShipperContactsInShippers" } } }, "x-parameter-index": 1 }, "operationId": "ShippersShipperContactsController.create" }, "patch": { "x-controller-name": "ShippersShipperContactsController", "x-operation-name": "patch", "tags": [ "ShippersShipperContactsController" ], "responses": { "200": { "description": "Shippers.ShipperContacts PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "ShipperContacts.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipperContactsPartial" } } }, "x-parameter-index": 1 }, "operationId": "ShippersShipperContactsController.patch" }, "get": { "x-controller-name": "ShippersShipperContactsController", "x-operation-name": "find", "tags": [ "ShippersShipperContactsController" ], "responses": { "200": { "description": "Array of Shippers has many ShipperContacts", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ShipperContacts" } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } ], "operationId": "ShippersShipperContactsController.find" }, "delete": { "x-controller-name": "ShippersShipperContactsController", "x-operation-name": "delete", "tags": [ "ShippersShipperContactsController" ], "responses": { "200": { "description": "Shippers.ShipperContacts DELETE success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "ShipperContacts.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "ShippersShipperContactsController.delete" } }, "/shippers/{id}/shippers-companies-insurances": { "post": { "x-controller-name": "ShippersShippersCompaniesInsuranceController", "x-operation-name": "create", "tags": [ "ShippersShippersCompaniesInsuranceController" ], "responses": { "200": { "description": "Shippers model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShippersCompaniesInsurance" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewShippersCompaniesInsuranceInShippers" } } }, "x-parameter-index": 1 }, "operationId": "ShippersShippersCompaniesInsuranceController.create" }, "patch": { "x-controller-name": "ShippersShippersCompaniesInsuranceController", "x-operation-name": "patch", "tags": [ "ShippersShippersCompaniesInsuranceController" ], "responses": { "200": { "description": "Shippers.ShippersCompaniesInsurance PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "ShippersCompaniesInsurance.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShippersCompaniesInsurancePartial" } } }, "x-parameter-index": 1 }, "operationId": "ShippersShippersCompaniesInsuranceController.patch" }, "get": { "x-controller-name": "ShippersShippersCompaniesInsuranceController", "x-operation-name": "find", "tags": [ "ShippersShippersCompaniesInsuranceController" ], "responses": { "200": { "description": "Array of Shippers has many ShippersCompaniesInsurance", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ShippersCompaniesInsurance" } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } ], "operationId": "ShippersShippersCompaniesInsuranceController.find" }, "delete": { "x-controller-name": "ShippersShippersCompaniesInsuranceController", "x-operation-name": "delete", "tags": [ "ShippersShippersCompaniesInsuranceController" ], "responses": { "200": { "description": "Shippers.ShippersCompaniesInsurance DELETE success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "ShippersCompaniesInsurance.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "ShippersShippersCompaniesInsuranceController.delete" } }, "/shippers/{shipperId}/state-wise-shipments": { "get": { "x-controller-name": "ShippersController", "x-operation-name": "getStateWiseShipments", "tags": [ "ShippersController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker view shipper |\n", "responses": { "200": { "description": "Get state-wise shipments for a shipper", "content": { "application/json": { "schema": { "type": "object", "properties": { "shipper": { "$ref": "#/components/schemas/ShippersWithRelations" }, "stateWiseShipments": { "type": "object", "properties": { "shipments": { "type": "array", "description": "All shipments with complete data including pickup/drop locations, commodities, and equipment" }, "stateWiseData": { "type": "array", "description": "Shipments grouped by state with totals and shipment details for each state", "items": { "type": "object", "properties": { "state": { "type": "string" }, "stateCode": { "type": "string" }, "totalShipments": { "type": "number" }, "shipments": { "type": "array" } } } }, "allStates": { "type": "array", "description": "All states that exist for shipments with pickup location focus and shipment counts", "items": { "type": "object", "properties": { "stateCode": { "type": "string" }, "state": { "type": "string" }, "hasPickupLocations": { "type": "boolean" }, "totalShipments": { "type": "number" } } } } } } } } } } } }, "parameters": [ { "name": "shipperId", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "ShippersController.getStateWiseShipments" } }, "/shippers/{id}/user": { "get": { "x-controller-name": "ShippersUserController", "x-operation-name": "getUser", "tags": [ "ShippersUserController" ], "responses": { "200": { "description": "User belonging to Shippers", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ShippersUserController.getUser" } }, "/shippers/{id}/zip-codes": { "get": { "x-controller-name": "ShippersZipCodesController", "x-operation-name": "getZipCodes", "tags": [ "ShippersZipCodesController" ], "responses": { "200": { "description": "ZipCodes belonging to Shippers", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ZipCodes" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ShippersZipCodesController.getZipCodes" } }, "/shippers/{id}": { "put": { "x-controller-name": "ShippersController", "x-operation-name": "replaceById", "tags": [ "ShippersController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Shippers PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Shippers" } } }, "x-parameter-index": 1 }, "operationId": "ShippersController.replaceById" }, "patch": { "x-controller-name": "ShippersController", "x-operation-name": "updateById", "tags": [ "ShippersController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker update shipper |\n", "responses": { "200": { "description": "Return value of ShippersController.updateById", "content": {} }, "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Shippers PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } }, "x-parameter-index": 1 }, "operationId": "ShippersController.updateById" }, "get": { "x-controller-name": "ShippersController", "x-operation-name": "findById", "tags": [ "ShippersController" ], "responses": { "200": { "description": "Shippers model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShippersWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "ShippersController.findById" }, "delete": { "x-controller-name": "ShippersController", "x-operation-name": "deleteById", "tags": [ "ShippersController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Shippers DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ShippersController.deleteById" } }, "/shippers": { "post": { "x-controller-name": "ShippersController", "x-operation-name": "create", "tags": [ "ShippersController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker create shipper |\n", "responses": { "200": { "description": "Shippers model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Shippers" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "ShippersController.create" }, "patch": { "x-controller-name": "ShippersController", "x-operation-name": "updateAll", "tags": [ "ShippersController" ], "responses": { "200": { "description": "Shippers PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Shippers.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShippersPartial" } } } }, "operationId": "ShippersController.updateAll" }, "get": { "x-controller-name": "ShippersController", "x-operation-name": "find", "tags": [ "ShippersController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker view shipper |\n", "responses": { "200": { "description": "Array of Shippers model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ShippersWithRelations" } } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Shippers.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } }, { "name": "page", "in": "query", "schema": { "type": "number" } }, { "name": "pageSize", "in": "query", "schema": { "type": "number" } }, { "name": "ShipperName", "in": "query", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "schema": { "type": "string" } } ], "operationId": "ShippersController.find" } }, "/shippers-bankruptcies/check-bankruptcy": { "get": { "x-controller-name": "ShippersBankruptcyController", "x-operation-name": "checkBankruptcy", "tags": [ "ShippersBankruptcyController" ], "description": "", "responses": { "200": { "description": "Check if a company exists in bankruptcy list", "content": { "application/json": { "schema": { "type": "object", "properties": { "exists": { "type": "boolean" } } } } } } }, "parameters": [ { "name": "company_name", "in": "query", "schema": { "type": "string" } } ], "operationId": "ShippersBankruptcyController.checkBankruptcy" } }, "/shippers-bankruptcies/check-duplicates": { "post": { "x-controller-name": "ShippersBankruptcyController", "x-operation-name": "checkDuplicates", "tags": [ "ShippersBankruptcyController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar view shippers bankruptcy |\n", "responses": { "200": { "description": "Check for existing company names in ShippersBankruptcy table", "content": { "application/json": { "schema": { "type": "object", "properties": { "exists": { "type": "array", "items": { "type": "string" } } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "company_names": { "type": "array", "items": { "type": "string" } } }, "required": [ "company_names" ] } } }, "description": "Array of company names to check", "required": true }, "operationId": "ShippersBankruptcyController.checkDuplicates" } }, "/shippers-bankruptcies/count": { "get": { "x-controller-name": "ShippersBankruptcyController", "x-operation-name": "count", "tags": [ "ShippersBankruptcyController" ], "responses": { "200": { "description": "ShippersBankruptcy model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "ShippersBankruptcy.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "ShippersBankruptcyController.count" } }, "/shippers-bankruptcies/update/{id}": { "put": { "x-controller-name": "ShippersBankruptcyController", "x-operation-name": "updateById", "tags": [ "ShippersBankruptcyController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar view shippers bankruptcy |\n", "responses": { "200": { "description": "Return value of ShippersBankruptcyController.updateById", "content": {} }, "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "ShippersBankruptcy PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShippersBankruptcyPartial" } } }, "x-parameter-index": 1 }, "operationId": "ShippersBankruptcyController.updateById" } }, "/shippers-bankruptcies/{id}": { "get": { "x-controller-name": "ShippersBankruptcyController", "x-operation-name": "findById", "tags": [ "ShippersBankruptcyController" ], "responses": { "200": { "description": "ShippersBankruptcy model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShippersBankruptcyWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShippersBankruptcy.Filter" } } } } ], "operationId": "ShippersBankruptcyController.findById" }, "delete": { "x-controller-name": "ShippersBankruptcyController", "x-operation-name": "deleteById", "tags": [ "ShippersBankruptcyController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "ShippersBankruptcy DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ShippersBankruptcyController.deleteById" } }, "/shippers-bankruptcies": { "post": { "x-controller-name": "ShippersBankruptcyController", "x-operation-name": "create", "tags": [ "ShippersBankruptcyController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar view shippers bankruptcy |\n", "responses": { "200": { "description": "ShippersBankruptcy model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShippersBankruptcy" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewShippersBankruptcy" } } } }, "operationId": "ShippersBankruptcyController.create" }, "patch": { "x-controller-name": "ShippersBankruptcyController", "x-operation-name": "updateAll", "tags": [ "ShippersBankruptcyController" ], "responses": { "200": { "description": "ShippersBankruptcy PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "ShippersBankruptcy.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShippersBankruptcyPartial" } } } }, "operationId": "ShippersBankruptcyController.updateAll" }, "get": { "x-controller-name": "ShippersBankruptcyController", "x-operation-name": "find", "tags": [ "ShippersBankruptcyController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar view shippers bankruptcy |\n", "responses": { "200": { "description": "Array of ShippersBankruptcy model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ShippersBankruptcyWithRelations" } } } } } }, "parameters": [ { "name": "page", "in": "query", "schema": { "type": "number" } }, { "name": "pageSize", "in": "query", "schema": { "type": "number" } }, { "name": "companyName", "in": "query", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShippersBankruptcy.Filter1" } } } } ], "operationId": "ShippersBankruptcyController.find" } }, "/shippers-details/{id}": { "get": { "x-controller-name": "ArInvoicesController", "x-operation-name": "ShippersDetails", "tags": [ "ArInvoicesController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar view invoices |\n", "responses": { "200": { "description": "Invoices model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoicesWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "ArInvoicesController.ShippersDetails" } }, "/shippers-list": { "get": { "x-controller-name": "ArShippersController", "x-operation-name": "findList", "tags": [ "ArShippersController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar view shipper |\n", "responses": { "200": { "description": "Array of Shippers model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ShippersWithRelations" } } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Shippers.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } }, { "name": "page", "in": "query", "schema": { "type": "number" } }, { "name": "pageSize", "in": "query", "schema": { "type": "number" } }, { "name": "status", "in": "query", "schema": { "type": "string" } }, { "name": "shippersId", "in": "query", "schema": { "type": "string" } }, { "name": "AssignToShippers", "in": "query", "schema": { "type": "string" } }, { "name": "shipperQuote", "in": "query", "schema": { "type": "string" } }, { "name": "userId", "in": "query", "schema": { "type": "string" } }, { "name": "MoveTo", "in": "query", "schema": { "type": "string" } } ], "operationId": "ArShippersController.findList" } }, "/shippers-shipments": { "get": { "x-controller-name": "ShippersController", "x-operation-name": "getShippersShipments", "tags": [ "ShippersController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker view shipper |\n", "responses": { "200": { "description": "Get shipments for the authenticated user with pagination and status filtering", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ShipmentWithRelations" } } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Shipment.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } }, { "name": "page", "in": "query", "schema": { "type": "number" } }, { "name": "pageSize", "in": "query", "schema": { "type": "number" } }, { "name": "OrderBy", "in": "query", "schema": { "type": "string" } }, { "name": "mode", "in": "query", "schema": { "type": "string" } }, { "name": "containerNo", "in": "query", "schema": { "type": "string" } }, { "name": "shippersId", "in": "query", "schema": { "type": "string" } } ], "operationId": "ShippersController.getShippersShipments" } }, "/shippment-by-shipperId": { "get": { "x-controller-name": "ArShipperAgingController", "x-operation-name": "AllShippmentfind", "tags": [ "ArShipperAgingController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar view shipper aging |\n", "responses": { "200": { "description": "Array of Shipment model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ShipmentWithRelations" } } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Shipment.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } }, { "name": "id", "in": "query", "schema": { "type": "string" } }, { "name": "InvoiceNo", "in": "query", "schema": { "type": "string" } }, { "name": "DaysFrom", "in": "query", "schema": { "type": "string" } }, { "name": "DaysTo", "in": "query", "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "number" } }, { "name": "pageSize", "in": "query", "schema": { "type": "number" } }, { "name": "moveTo", "in": "query", "schema": { "type": "string" } }, { "name": "invoiceStatus", "in": "query", "schema": { "type": "string" } }, { "name": "invoiceType", "in": "query", "schema": { "type": "string" } } ], "operationId": "ArShipperAgingController.AllShippmentfind" } }, "/sign-document/{requestId}": { "get": { "x-controller-name": "SignRequestController", "x-operation-name": "getSignatureDocumentView", "tags": [ "SignRequestController" ], "responses": { "200": { "description": "Signature document view HTML page", "content": { "text/html": { "schema": { "type": "string" } } } } }, "parameters": [ { "name": "requestId", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "signer_token", "in": "query", "schema": { "type": "string" } }, { "name": "ref", "in": "query", "schema": { "type": "string" } } ], "operationId": "SignRequestController.getSignatureDocumentView" } }, "/sign-pdf/{id}": { "post": { "x-controller-name": "ShipmentController", "x-operation-name": "signPdf", "tags": [ "ShipmentController" ], "responses": { "200": { "description": "Signatured PDF", "content": { "application/pdf": { "schema": { "type": "string" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "signatures" ], "properties": { "signatures": { "type": "string" } } } } }, "x-parameter-index": 1 }, "operationId": "ShipmentController.signPdf" }, "get": { "x-controller-name": "ShipmentController", "x-operation-name": "signPdfData", "tags": [ "ShipmentController" ], "responses": { "200": { "description": "sign Doc data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SignDoc" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "ShipmentController.signPdfData" } }, "/sign-request/my-requests": { "get": { "x-controller-name": "SignRequestController", "x-operation-name": "getMySignatureRequests", "tags": [ "SignRequestController" ], "responses": { "200": { "description": "User signature requests retrieved successfully", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SignDoc" } } } } } }, "parameters": [ { "name": "email", "in": "query", "schema": { "type": "string" } }, { "name": "status", "in": "query", "schema": { "type": "number" } } ], "operationId": "SignRequestController.getMySignatureRequests" } }, "/sign-request/send-document/{id}": { "post": { "x-controller-name": "SignRequestController", "x-operation-name": "sendDocumentForSigning", "tags": [ "SignRequestController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker create shipment |\n", "responses": { "200": { "description": "Return value of SignRequestController.sendDocumentForSigning", "content": {} }, "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Shipment Carrier Rc Sign Req" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "from", "to" ], "properties": { "from": { "type": "string", "maxLength": 50 }, "to": { "type": "array" } } } } }, "x-parameter-index": 1 }, "operationId": "SignRequestController.sendDocumentForSigning" } }, "/sign-request/{requestId}/cancel": { "patch": { "x-controller-name": "SignRequestController", "x-operation-name": "cancelSignatureRequest", "tags": [ "SignRequestController" ], "responses": { "200": { "description": "Signature request cancelled successfully", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } } } } } }, "parameters": [ { "name": "requestId", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "SignRequestController.cancelSignatureRequest" } }, "/sign-request/{requestId}/remind": { "post": { "x-controller-name": "SignRequestController", "x-operation-name": "sendReminderEmail", "tags": [ "SignRequestController" ], "responses": { "200": { "description": "Reminder email sent successfully", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } } } } } }, "parameters": [ { "name": "requestId", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "SignRequestController.sendReminderEmail" } }, "/sign-request/{requestId}/resend": { "post": { "x-controller-name": "SignRequestController", "x-operation-name": "resendSignatureRequest", "tags": [ "SignRequestController" ], "responses": { "200": { "description": "Signature request email resent successfully", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } } } } } }, "parameters": [ { "name": "requestId", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "SignRequestController.resendSignatureRequest" } }, "/sign-request/{requestId}/status": { "get": { "x-controller-name": "SignRequestController", "x-operation-name": "getSignatureRequestStatus", "tags": [ "SignRequestController" ], "responses": { "200": { "description": "Signature request status retrieved successfully", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "status": { "type": "string" }, "createdAt": { "type": "string" }, "expiresAt": { "type": "string" }, "signedAt": { "type": "string" }, "signedBy": { "type": "string" }, "documentUrl": { "type": "string" }, "signedDocumentUrl": { "type": "string" } } } } } } }, "parameters": [ { "name": "requestId", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "SignRequestController.getSignatureRequestStatus" } }, "/sign-request/{id}": { "delete": { "x-controller-name": "SignRequestController", "x-operation-name": "deleteSignatureRequest", "tags": [ "SignRequestController" ], "responses": { "204": { "description": "Signature request deleted successfully" } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "SignRequestController.deleteSignatureRequest" } }, "/signup": { "post": { "x-controller-name": "AuthController", "x-operation-name": "signUp", "tags": [ "AuthController" ], "responses": { "200": { "description": "User", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } } }, "requestBody": { "content": { "application/json": {} } }, "operationId": "AuthController.signUp" } }, "/single-manager-month-till-date-report-export": { "get": { "x-controller-name": "ReportsController", "x-operation-name": "getsingleManagerMonthSummaryAllExport", "tags": [ "ReportsController" ], "responses": { "200": { "description": "Manager margin and shipment summary for all managers for a given month", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } } } } } }, "parameters": [ { "name": "date", "in": "query", "schema": { "type": "string" }, "required": true, "description": "Month in YYYY-MM format" }, { "name": "to", "in": "query", "schema": { "type": "string" }, "required": false, "description": "Recipient email(s). Can be a single email or an array of strings." }, { "name": "subject", "in": "query", "schema": { "type": "string" }, "required": false, "description": "Month in YYYY-MM format" }, { "name": "export", "in": "query", "schema": { "type": "boolean" }, "required": false, "description": "Export as CSV" }, { "name": "process", "in": "query", "schema": { "type": "string" } }, { "name": "portalId", "in": "query", "schema": { "type": "string" }, "required": false, "description": "Portal ID" } ], "operationId": "ReportsController.getsingleManagerMonthSummaryAllExport" } }, "/sme-file-upload-documents": { "post": { "x-controller-name": "CommonfileuploadController", "x-operation-name": "smeFileUploadDocuments", "tags": [ "CommonfileuploadController" ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Files and fields" } }, "description": "", "requestBody": { "content": { "multipart/form-data": { "x-parser": "stream", "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } } } } }, "description": "Request body for multipart/form-data based file upload", "required": true }, "operationId": "CommonfileuploadController.smeFileUploadDocuments" } }, "/sme-mc-approved": { "post": { "x-controller-name": "McVerificationController", "x-operation-name": "SmeApprovedMC", "tags": [ "McVerificationController" ], "description": "\n\n| Permissions |\n| ------- |\n| sme view mcapprove |\n", "responses": { "200": { "description": "Return value of McVerificationController.SmeApprovedMC", "content": {} }, "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "McVerification PATCH success" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "McVerificationController.SmeApprovedMC" } }, "/sme-mc-comments/count": { "get": { "x-controller-name": "SmeMcCommentsController", "x-operation-name": "count", "tags": [ "SmeMcCommentsController" ], "responses": { "200": { "description": "SmeMcComments model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "SmeMcComments.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "SmeMcCommentsController.count" } }, "/sme-mc-comments/{id}/cpr-request": { "get": { "x-controller-name": "SmeMcCommentsCprRequestController", "x-operation-name": "getCprRequest", "tags": [ "SmeMcCommentsCprRequestController" ], "responses": { "200": { "description": "CprRequest belonging to SmeMcComments", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CprRequest" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "SmeMcCommentsCprRequestController.getCprRequest" } }, "/sme-mc-comments/{id}/mc-verification": { "get": { "x-controller-name": "SmeMcCommentsMcVerificationController", "x-operation-name": "getMcVerification", "tags": [ "SmeMcCommentsMcVerificationController" ], "responses": { "200": { "description": "McVerification belonging to SmeMcComments", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/McVerification" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "SmeMcCommentsMcVerificationController.getMcVerification" } }, "/sme-mc-comments/{id}/user": { "get": { "x-controller-name": "SmeMcCommentsUserController", "x-operation-name": "getUser", "tags": [ "SmeMcCommentsUserController" ], "responses": { "200": { "description": "User belonging to SmeMcComments", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "SmeMcCommentsUserController.getUser" } }, "/sme-mc-comments/{id}": { "put": { "x-controller-name": "SmeMcCommentsController", "x-operation-name": "replaceById", "tags": [ "SmeMcCommentsController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "SmeMcComments PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SmeMcComments" } } }, "x-parameter-index": 1 }, "operationId": "SmeMcCommentsController.replaceById" }, "patch": { "x-controller-name": "SmeMcCommentsController", "x-operation-name": "updateById", "tags": [ "SmeMcCommentsController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "SmeMcComments PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SmeMcCommentsPartial" } } }, "x-parameter-index": 1 }, "operationId": "SmeMcCommentsController.updateById" }, "get": { "x-controller-name": "SmeMcCommentsController", "x-operation-name": "findById", "tags": [ "SmeMcCommentsController" ], "responses": { "200": { "description": "SmeMcComments model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SmeMcCommentsWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SmeMcComments.Filter" } } } } ], "operationId": "SmeMcCommentsController.findById" }, "delete": { "x-controller-name": "SmeMcCommentsController", "x-operation-name": "deleteById", "tags": [ "SmeMcCommentsController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "SmeMcComments DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "SmeMcCommentsController.deleteById" } }, "/sme-mc-comments": { "post": { "x-controller-name": "SmeMcCommentsController", "x-operation-name": "create", "tags": [ "SmeMcCommentsController" ], "description": "\n\n| Permissions |\n| ------- |\n| sme view mcapprove |\n", "responses": { "200": { "description": "SmeMcComments model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SmeMcComments" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewSmeMcComments" } } } }, "operationId": "SmeMcCommentsController.create" }, "patch": { "x-controller-name": "SmeMcCommentsController", "x-operation-name": "updateAll", "tags": [ "SmeMcCommentsController" ], "responses": { "200": { "description": "SmeMcComments PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "SmeMcComments.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SmeMcCommentsPartial" } } } }, "operationId": "SmeMcCommentsController.updateAll" }, "get": { "x-controller-name": "SmeMcCommentsController", "x-operation-name": "find", "tags": [ "SmeMcCommentsController" ], "responses": { "200": { "description": "Array of SmeMcComments model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SmeMcCommentsWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SmeMcComments.Filter1" } } } } ], "operationId": "SmeMcCommentsController.find" } }, "/states/{id}/cities": { "post": { "x-controller-name": "StatesCitiesController", "x-operation-name": "create", "tags": [ "StatesCitiesController" ], "responses": { "200": { "description": "States model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Cities" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewCitiesInStates" } } }, "x-parameter-index": 1 }, "operationId": "StatesCitiesController.create" }, "patch": { "x-controller-name": "StatesCitiesController", "x-operation-name": "patch", "tags": [ "StatesCitiesController" ], "responses": { "200": { "description": "States.Cities PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Cities.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CitiesPartial" } } }, "x-parameter-index": 1 }, "operationId": "StatesCitiesController.patch" }, "get": { "x-controller-name": "StatesCitiesController", "x-operation-name": "find", "tags": [ "StatesCitiesController" ], "responses": { "200": { "description": "Array of States has many Cities", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Cities" } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } ], "operationId": "StatesCitiesController.find" }, "delete": { "x-controller-name": "StatesCitiesController", "x-operation-name": "delete", "tags": [ "StatesCitiesController" ], "responses": { "200": { "description": "States.Cities DELETE success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Cities.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "StatesCitiesController.delete" } }, "/team-lead-revenue": { "get": { "x-controller-name": "BrokerHomeController", "x-operation-name": "getTeamLeadRevenue", "tags": [ "BrokerHomeController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker view dashboard |\n", "responses": { "200": { "description": "List of TM and Team Revenue", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "additionalProperties": true } } } } } }, "parameters": [ { "name": "fromDate", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "toDate", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "revenueType", "in": "query", "schema": { "type": "string" } }, { "name": "revenueTypes", "in": "query", "schema": { "type": "string" } } ], "operationId": "BrokerHomeController.getTeamLeadRevenue" } }, "/team-lead-revenue-incentive": { "get": { "x-controller-name": "BrokerDashboardController", "x-operation-name": "getTeamLeadRevenueIncentive", "tags": [ "BrokerDashboardController" ], "description": "", "responses": { "200": { "description": "List of TM and Team Revenue", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "additionalProperties": true } } } } } }, "parameters": [ { "name": "fromDate", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "toDate", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "revenueType", "in": "query", "schema": { "type": "string" } }, { "name": "revenueTypes", "in": "query", "schema": { "type": "string" } } ], "operationId": "BrokerDashboardController.getTeamLeadRevenueIncentive" } }, "/team-target-update": { "get": { "x-controller-name": "EmailMarketingController", "x-operation-name": "teamTargetUpdate", "tags": [ "EmailMarketingController" ], "responses": { "200": { "description": "Return value of EmailMarketingController.teamTargetUpdate" } }, "operationId": "EmailMarketingController.teamTargetUpdate" } }, "/teamtargets/individual": { "post": { "x-controller-name": "ReportsController", "x-operation-name": "createTeamTargetByvikas", "tags": [ "ReportsController" ], "responses": { "200": { "description": "Create or update a teamtarget", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number" }, "updated": { "type": "boolean" } } } } } } }, "description": "\n\n| Permissions |\n| ------- |\n| view portal reports |\n", "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "ReportsController.createTeamTargetByvikas" } }, "/teamtargets/individual-edit": { "post": { "x-controller-name": "ReportsController", "x-operation-name": "createTeamTargetByvikasEdit", "tags": [ "ReportsController" ], "responses": { "200": { "description": "Create or update a teamtarget", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number" }, "updated": { "type": "boolean" } } } } } } }, "description": "\n\n| Permissions |\n| ------- |\n| view portal reports |\n", "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "ReportsController.createTeamTargetByvikasEdit" } }, "/teamtargets/update": { "post": { "x-controller-name": "ReportsController", "x-operation-name": "updateTeamTarget", "tags": [ "ReportsController" ], "responses": { "200": { "description": "Update an existing teamtarget", "content": { "application/json": { "schema": { "type": "object", "properties": { "updated": { "type": "boolean" } } } } } } }, "description": "\n\n| Permissions |\n| ------- |\n| view portal reports |\n", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "number" }, "targetAmount": { "type": "number" }, "targetMonth": { "type": "string" }, "managerId": { "type": "number" }, "benchmarkAmount": { "type": "number" } } } } } }, "operationId": "ReportsController.updateTeamTarget" } }, "/teamtargets": { "post": { "x-controller-name": "ReportsController", "x-operation-name": "createTeamTarget", "tags": [ "ReportsController" ], "responses": { "200": { "description": "Create or update a teamtarget", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "number" }, "updated": { "type": "boolean" } } } } } } }, "description": "\n\n| Permissions |\n| ------- |\n| view portal reports |\n", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "targetAmount", "targetMonth", "managerId" ], "properties": { "targetAmount": { "type": "number" }, "targetMonth": { "type": "string", "description": "YYYY-MM-DD" }, "managerId": { "type": "number" }, "benchmarkAmount": { "type": "number" } } } } } }, "operationId": "ReportsController.createTeamTarget" }, "get": { "x-controller-name": "ReportsController", "x-operation-name": "listTeamTargets", "tags": [ "ReportsController" ], "responses": { "200": { "description": "List all teamtargets with manager info", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } } } } } }, "description": "\n\n| Permissions |\n| ------- |\n| view portal reports |\n", "parameters": [ { "name": "managerId", "in": "query", "schema": { "type": "number" } }, { "name": "targetMonth", "in": "query", "schema": { "type": "string" } } ], "operationId": "ReportsController.listTeamTargets" } }, "/teamtargetsfetch": { "get": { "x-controller-name": "ReportsController", "x-operation-name": "fetchTeamTargets", "tags": [ "ReportsController" ], "responses": { "200": { "description": "List all teamtargets with manager info", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } } } } } }, "description": "\n\n| Permissions |\n| ------- |\n| view portal reports |\n", "parameters": [ { "name": "brokerId", "in": "query", "schema": { "type": "number" } }, { "name": "managerId", "in": "query", "schema": { "type": "number" } }, { "name": "targetMonth", "in": "query", "schema": { "type": "string" } } ], "operationId": "ReportsController.fetchTeamTargets" } }, "/teamtargetsfetch-manager": { "get": { "x-controller-name": "ReportsController", "x-operation-name": "listTeamTargetsManager", "tags": [ "ReportsController" ], "responses": { "200": { "description": "List all teamtargets with manager info", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object" } } } } } }, "description": "\n\n| Permissions |\n| ------- |\n| view portal reports |\n", "parameters": [ { "name": "managerId", "in": "query", "schema": { "type": "number" } }, { "name": "targetMonth", "in": "query", "schema": { "type": "string" } } ], "operationId": "ReportsController.listTeamTargetsManager" } }, "/test": { "post": { "x-controller-name": "EmailMarketingController", "x-operation-name": "test", "tags": [ "EmailMarketingController" ], "responses": { "200": { "description": "Return value of EmailMarketingController.test" } }, "operationId": "EmailMarketingController.test" } }, "/test-firebase-notification": { "post": { "x-controller-name": "NotificationController", "x-operation-name": "sendtestNotification", "tags": [ "NotificationController" ], "responses": { "200": { "description": "Return value of NotificationController.sendtestNotification" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "NotificationController.sendtestNotification" } }, "/test-firebase-notification2": { "post": { "x-controller-name": "NotificationController", "x-operation-name": "sendtestNotification2", "tags": [ "NotificationController" ], "responses": { "200": { "description": "Return value of NotificationController.sendtestNotification2" } }, "operationId": "NotificationController.sendtestNotification2" } }, "/third-party-users/count": { "get": { "x-controller-name": "ThirdPartyUsersController", "x-operation-name": "count", "tags": [ "ThirdPartyUsersController" ], "responses": { "200": { "description": "ThirdPartyUsers model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "ThirdPartyUsers.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "ThirdPartyUsersController.count" } }, "/third-party-users/{id}": { "put": { "x-controller-name": "ThirdPartyUsersController", "x-operation-name": "replaceById", "tags": [ "ThirdPartyUsersController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "ThirdPartyUsers PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThirdPartyUsers" } } }, "x-parameter-index": 1 }, "operationId": "ThirdPartyUsersController.replaceById" }, "patch": { "x-controller-name": "ThirdPartyUsersController", "x-operation-name": "updateById", "tags": [ "ThirdPartyUsersController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "ThirdPartyUsers PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThirdPartyUsersPartial" } } }, "x-parameter-index": 1 }, "operationId": "ThirdPartyUsersController.updateById" }, "get": { "x-controller-name": "ThirdPartyUsersController", "x-operation-name": "findById", "tags": [ "ThirdPartyUsersController" ], "responses": { "200": { "description": "ThirdPartyUsers model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThirdPartyUsersWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThirdPartyUsers.Filter" } } } } ], "operationId": "ThirdPartyUsersController.findById" }, "delete": { "x-controller-name": "ThirdPartyUsersController", "x-operation-name": "deleteById", "tags": [ "ThirdPartyUsersController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "ThirdPartyUsers DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ThirdPartyUsersController.deleteById" } }, "/third-party-users": { "post": { "x-controller-name": "ThirdPartyUsersController", "x-operation-name": "create", "tags": [ "ThirdPartyUsersController" ], "responses": { "200": { "description": "ThirdPartyUsers model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThirdPartyUsers" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewThirdPartyUsers" } } } }, "operationId": "ThirdPartyUsersController.create" }, "patch": { "x-controller-name": "ThirdPartyUsersController", "x-operation-name": "updateAll", "tags": [ "ThirdPartyUsersController" ], "responses": { "200": { "description": "ThirdPartyUsers PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "ThirdPartyUsers.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThirdPartyUsersPartial" } } } }, "operationId": "ThirdPartyUsersController.updateAll" }, "get": { "x-controller-name": "ThirdPartyUsersController", "x-operation-name": "find", "tags": [ "ThirdPartyUsersController" ], "responses": { "200": { "description": "Array of ThirdPartyUsers model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ThirdPartyUsersWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThirdPartyUsers.Filter1" } } } } ], "operationId": "ThirdPartyUsersController.find" } }, "/tm-and-team-revenue": { "get": { "x-controller-name": "BrokerHomeController", "x-operation-name": "getTmAndTeamRevenue", "tags": [ "BrokerHomeController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker view dashboard |\n", "responses": { "200": { "description": "List of TM and Team Revenue", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "additionalProperties": true } } } } } }, "parameters": [ { "name": "fromDate", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "toDate", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "revenueType", "in": "query", "schema": { "type": "string" } }, { "name": "revenueTypes", "in": "query", "schema": { "type": "string" } } ], "operationId": "BrokerHomeController.getTmAndTeamRevenue" } }, "/tm-and-team-revenue-incentive": { "get": { "x-controller-name": "BrokerDashboardController", "x-operation-name": "getTmAndTeamRevenue", "tags": [ "BrokerDashboardController" ], "description": "", "responses": { "200": { "description": "List of TM and Team Revenue", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "additionalProperties": true } } } } } }, "parameters": [ { "name": "fromDate", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "toDate", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "revenueType", "in": "query", "schema": { "type": "string" } }, { "name": "revenueTypes", "in": "query", "schema": { "type": "string" } } ], "operationId": "BrokerDashboardController.getTmAndTeamRevenue" } }, "/tm-and-team-revenue-old": { "get": { "x-controller-name": "BrokerHomeController", "x-operation-name": "getTmAndTeamRevenueOld", "tags": [ "BrokerHomeController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker view dashboard |\n", "responses": { "200": { "description": "List of TM and Team Revenue", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "additionalProperties": true } } } } } }, "parameters": [ { "name": "fromDate", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "toDate", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "revenueType", "in": "query", "schema": { "type": "string" } } ], "operationId": "BrokerHomeController.getTmAndTeamRevenueOld" } }, "/tonu/shipment": { "post": { "x-controller-name": "ShipmentController", "x-operation-name": "tonu", "tags": [ "ShipmentController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker create shipment |\n", "responses": { "200": { "description": "Shipment model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Shipment" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "shipmentId", "tonuFor", "carrierAmount", "shipperAmount" ], "properties": { "shipmentId": { "type": "string" }, "tonuFor": { "type": "number" }, "carrierAmount": { "type": "number", "nullable": true }, "shipperAmount": { "type": "number", "nullable": true } } } } } }, "operationId": "ShipmentController.tonu" } }, "/tonu-request-approval": { "post": { "x-controller-name": "ShipmentController", "x-operation-name": "approveTonuRequest", "tags": [ "ShipmentController" ], "description": "\n\n| Permissions |\n| ------- |\n| tonu request page |\n", "responses": { "200": { "description": "Approve or reject TONU request; creates history and updates shipment tonuApproval", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "ShipmentController.approveTonuRequest" } }, "/top-customer": { "get": { "x-controller-name": "BrokerHomeController", "x-operation-name": "TopCustomer", "tags": [ "BrokerHomeController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker view dashboard |\n", "responses": { "200": { "description": "Shipment model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoicesWithRelations" } } } } }, "parameters": [ { "name": "type", "in": "query", "schema": { "type": "string" } } ], "operationId": "BrokerHomeController.TopCustomer" } }, "/total-business": { "get": { "x-controller-name": "PerformanceReportController", "x-operation-name": "ShipperBussinessReport", "tags": [ "PerformanceReportController" ], "description": "", "responses": { "200": { "description": "Return value of PerformanceReportController.ShipperBussinessReport", "content": {} } }, "parameters": [ { "name": "startDate", "in": "query", "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "string" } } ], "operationId": "PerformanceReportController.ShipperBussinessReport" } }, "/truck-stops-keys/count": { "get": { "x-controller-name": "TruckStopKeyController", "x-operation-name": "count", "tags": [ "TruckStopKeyController" ], "responses": { "200": { "description": "TruckStopsKey model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "TruckStopsKey.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "TruckStopKeyController.count" } }, "/truck-stops-keys/{id}": { "put": { "x-controller-name": "TruckStopKeyController", "x-operation-name": "replaceById", "tags": [ "TruckStopKeyController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "TruckStopsKey PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TruckStopsKey" } } }, "x-parameter-index": 1 }, "operationId": "TruckStopKeyController.replaceById" }, "patch": { "x-controller-name": "TruckStopKeyController", "x-operation-name": "updateById", "tags": [ "TruckStopKeyController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "TruckStopsKey PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TruckStopsKeyPartial" } } }, "x-parameter-index": 1 }, "operationId": "TruckStopKeyController.updateById" }, "get": { "x-controller-name": "TruckStopKeyController", "x-operation-name": "findById", "tags": [ "TruckStopKeyController" ], "responses": { "200": { "description": "TruckStopsKey model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TruckStopsKeyWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "TruckStopKeyController.findById" }, "delete": { "x-controller-name": "TruckStopKeyController", "x-operation-name": "deleteById", "tags": [ "TruckStopKeyController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "TruckStopsKey DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "TruckStopKeyController.deleteById" } }, "/truck-stops-keys": { "post": { "x-controller-name": "TruckStopKeyController", "x-operation-name": "create", "tags": [ "TruckStopKeyController" ], "responses": { "200": { "description": "TruckStopsKey model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TruckStopsKey" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewTruckStopsKey" } } } }, "operationId": "TruckStopKeyController.create" }, "patch": { "x-controller-name": "TruckStopKeyController", "x-operation-name": "updateAll", "tags": [ "TruckStopKeyController" ], "responses": { "200": { "description": "TruckStopsKey PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "TruckStopsKey.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TruckStopsKeyPartial" } } } }, "operationId": "TruckStopKeyController.updateAll" }, "get": { "x-controller-name": "TruckStopKeyController", "x-operation-name": "find", "tags": [ "TruckStopKeyController" ], "responses": { "200": { "description": "Array of TruckStopsKey model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TruckStopsKeyWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TruckStopsKey.Filter" } } } } ], "operationId": "TruckStopKeyController.find" } }, "/unsecured-approve-shipper-limit-request": { "post": { "x-controller-name": "ArshipperLimitController", "x-operation-name": "approveUnsceuredLimtByManager", "tags": [ "ArshipperLimitController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker view cprInvoiceRequest |\n", "responses": { "200": { "description": "Return value of ArshipperLimitController.approveUnsceuredLimtByManager", "content": {} }, "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Shipper Limit PATCH success" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "ArshipperLimitController.approveUnsceuredLimtByManager" } }, "/unsecured-ar-shippers-limit-list": { "get": { "x-controller-name": "ArshipperLimitController", "x-operation-name": "getUnsecuredApprovedLimit", "tags": [ "ArshipperLimitController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker view cprInvoiceRequest |\n", "responses": { "200": { "description": "Array of Shippers limit model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ShipperLimitsWithRelations" } } } } } }, "operationId": "ArshipperLimitController.getUnsecuredApprovedLimit" } }, "/unsecured-reject-shipper-limit-request": { "post": { "x-controller-name": "ArshipperLimitController", "x-operation-name": "rejectUnsecuredLimitByManager", "tags": [ "ArshipperLimitController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker view cprInvoiceRequest |\n", "responses": { "200": { "description": "Return value of ArshipperLimitController.rejectUnsecuredLimitByManager", "content": {} }, "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Shipper Limit PATCH success" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "ArshipperLimitController.rejectUnsecuredLimitByManager" } }, "/update/asi/incentives/pro": { "get": { "x-controller-name": "DatratemateController", "x-operation-name": "UpdateASIIncentivesPro", "tags": [ "DatratemateController" ], "responses": { "200": { "description": "Return value of DatratemateController.UpdateASIIncentivesPro" } }, "operationId": "DatratemateController.UpdateASIIncentivesPro" } }, "/update/carrier/lanes/details": { "get": { "x-controller-name": "DatratemateController", "x-operation-name": "UpdateCarrierLanesDetails", "tags": [ "DatratemateController" ], "responses": { "200": { "description": "Return value of DatratemateController.UpdateCarrierLanesDetails" } }, "operationId": "DatratemateController.UpdateCarrierLanesDetails" } }, "/update/claim-submitted-to": { "post": { "x-controller-name": "ArShipperClaimController", "x-operation-name": "updateClaimSubmittedTo", "tags": [ "ArShipperClaimController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar view note |\n", "responses": { "200": { "description": "SmallClaim model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipperSmallClaim" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "ArShipperClaimController.updateClaimSubmittedTo" } }, "/update/collection-submitted-to": { "post": { "x-controller-name": "ArCollectionController", "x-operation-name": "updateClaimSubmittedTo", "tags": [ "ArCollectionController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar view note |\n", "responses": { "200": { "description": "Shipper Aging Collection model instance", "content": { "application/json": { "schema": {} } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "ArCollectionController.updateClaimSubmittedTo" } }, "/update/loads/lanes/cron": { "get": { "x-controller-name": "DatratemateController", "x-operation-name": "updateLoadsTracking", "tags": [ "DatratemateController" ], "responses": { "200": { "description": "Return value of DatratemateController.updateLoadsTracking" } }, "operationId": "DatratemateController.updateLoadsTracking" } }, "/update/shipment/{id}": { "patch": { "x-controller-name": "ShipmentController", "x-operation-name": "updateShipment", "tags": [ "ShipmentController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker create shipment |\n", "responses": { "200": { "description": "Shipment model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Shipment" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "loadType", "customer", "mode", "equipment", "commodity", "commodityValue" ], "properties": { "loadType": { "type": "string", "enum": [ "full", "partial" ] }, "commodity": { "type": "object", "properties": { "id": { "type": "number", "minimum": 0, "maximum": 99999999999 }, "name": { "type": "string" } }, "required": [ "id", "name" ] }, "commodityValue": { "type": "number", "maximum": 99999999999 }, "equipment": { "type": "object", "properties": { "id": { "minimum": 1, "maximum": 99999999999 }, "name": { "type": "string" } } }, "customer": { "type": "object", "properties": { "id": { "minimum": 1, "maximum": 99999999999 } }, "required": [ "id" ] }, "pallet": { "type": "number", "maximum": 99999999999, "nullable": true }, "weight": { "type": "string", "maxLength": 20, "nullable": true }, "mode": { "type": "number", "enum": [ 0, 1, 2, 3 ] }, "footage": { "type": "string", "maxLength": 50 }, "miles": { "type": "number", "nullable": true, "maximum": 20000 }, "minTemp": { "type": "string", "nullable": true }, "maxTemp": { "type": "string", "nullable": true }, "precoolTemp": { "type": "string", "maximum": 50 }, "carrierInstrctions": { "type": "string", "maxLength": 3000 }, "shipperInstrctions": { "type": "string", "maxLength": 3000 }, "billingName": { "type": "string", "maximum": 500 }, "billingAddress": { "type": "string", "maximum": 1000 }, "billingZip": { "type": "string", "maximum": 20 }, "billingPhone": { "type": "string", "maximum": 20 }, "billingCantact": { "type": "string", "maximum": 50 }, "billingFax": { "type": "string", "maximum": 20 }, "shipmentPicks": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "nullable": true, "maxLength": 500 }, "address": { "type": "string", "nullable": true, "maxLength": 1000 }, "city": { "type": "object", "properties": { "id": { "type": "number", "nullable": true } }, "nullable": true }, "contact": { "type": "string", "nullable": true, "maxLength": 50 }, "ref": { "type": "string", "maxLength": 200 }, "phone": { "type": "string", "nullable": true, "maxLength": 20 }, "email": { "type": "string", "nullable": true, "maxLength": 50 }, "pickupDate": { "type": "string" }, "apptDate": { "type": "string" }, "apptNote": { "type": "string", "nullable": true, "maxLength": 200 } }, "required": [ "ref", "pickupDate", "apptDate" ] } }, "shipmentDrops": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "nullable": true, "maxLength": 500 }, "address": { "type": "string", "nullable": true, "maxLength": 1000 }, "city": { "type": "object", "properties": { "id": { "type": "number", "nullable": true } }, "nullable": true }, "contact": { "type": "string", "nullable": true, "maxLength": 50 }, "ref": { "type": "string", "nullable": true, "maxLength": 200 }, "phone": { "type": "string", "nullable": true, "maxLength": 20 }, "email": { "type": "string", "nullable": true, "maxLength": 50 }, "dropDate": { "type": "string" }, "apptDate": { "type": "string", "nullable": true }, "emptyDate": { "type": "string", "nullable": true }, "apptNote": { "type": "string", "nullable": true, "maxLength": 200 } }, "required": [ "dropDate", "apptDate" ] } }, "shipmentPrices": { "type": "object", "properties": { "carrierPayMode": { "type": "number", "enum": [ 0, 1 ] }, "shipperPayMode": { "type": "number", "enum": [ 0, 1 ] }, "carrierPrice": { "type": "number", "maximum": 200000, "nullable": true }, "shipperPrice": { "type": "number", "maximum": 200000, "nullable": true }, "carrierPriceCad": { "type": "number", "maximum": 200000, "nullable": true }, "shipperPriceCad": { "type": "number", "maximum": 200000, "nullable": true }, "carrierPriceType": { "type": "number", "maximum": 9, "nullable": true }, "shipperPriceType": { "type": "number", "maximum": 9, "nullable": true }, "carrierUint": { "type": "number", "nullable": true, "maximum": 200000 }, "ShipperUnit": { "type": "number", "nullable": true, "maximum": 200000 }, "carrierUnitPrice": { "type": "number", "nullable": true, "maximum": 200000 }, "shipperUnitPrice": { "type": "number", "nullable": true, "maximum": 200000 }, "prices": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "maximum": 100 }, "susd": { "type": "number", "maximum": 200000, "nullable": true }, "scad": { "type": "number", "maximum": 200000, "nullable": true }, "cusd": { "type": "number", "maximum": 200000, "nullable": true }, "ccad": { "type": "number", "maximum": 200000, "nullable": true } }, "required": [ "label", "susd", "scad", "cusd", "ccad" ] } } } } } } } }, "x-parameter-index": 1 }, "operationId": "ShipmentController.updateShipment" } }, "/update/vl/otr/incentives/pro/with/new/policy": { "get": { "x-controller-name": "DatratemateController", "x-operation-name": "UpdateVLOTRIncentivesProWithNewPolicy", "tags": [ "DatratemateController" ], "responses": { "200": { "description": "Return value of DatratemateController.UpdateVLOTRIncentivesProWithNewPolicy" } }, "operationId": "DatratemateController.UpdateVLOTRIncentivesProWithNewPolicy" } }, "/update/withdrawn-status": { "post": { "x-controller-name": "WithdrawnShipperCreditLimitHistoryController", "x-operation-name": "updateWithdrawnStatus", "tags": [ "WithdrawnShipperCreditLimitHistoryController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar withdrawn limit |\n", "responses": { "200": { "description": "WithdrawnShipperCreditLimitHistory model instance", "content": { "application/json": { "schema": {} } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "WithdrawnShipperCreditLimitHistoryController.updateWithdrawnStatus" } }, "/update-ace-vl-invoices-data-status": { "post": { "x-controller-name": "ArInvoicesController", "x-operation-name": "updateAceAsiPayStatus", "tags": [ "ArInvoicesController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar view invoices |\n", "responses": { "200": { "description": "Array invoices model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InvoicesWithRelations" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "ArInvoicesController.updateAceAsiPayStatus" } }, "/update-ap-alignment": { "put": { "x-controller-name": "EmpAlignmentUserController", "x-operation-name": "updateApAlignment", "tags": [ "EmpAlignmentUserController" ], "description": "", "responses": { "200": { "description": "Return value of EmpAlignmentUserController.updateApAlignment", "content": {} } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "brokerId", "apUserId" ], "properties": { "brokerId": { "type": "number" }, "apUserId": { "type": "number" } } } } } }, "operationId": "EmpAlignmentUserController.updateApAlignment" } }, "/update-broker-details/{id}": { "patch": { "x-controller-name": "CommonSearchController", "x-operation-name": "update", "tags": [ "CommonSearchController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "User PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } }, "x-parameter-index": 1 }, "operationId": "CommonSearchController.update" } }, "/update-broker-image": { "post": { "x-controller-name": "CommonfileuploadController", "x-operation-name": "fileUploadBroker", "tags": [ "CommonfileuploadController" ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Files and fields" } }, "requestBody": { "content": { "multipart/form-data": { "x-parser": "stream", "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } } } } }, "description": "Request body for multipart/form-data based file upload", "required": true }, "operationId": "CommonfileuploadController.fileUploadBroker" } }, "/update-broker-profile-image/{id}": { "patch": { "x-controller-name": "CommonSearchController", "x-operation-name": "updateById", "tags": [ "CommonSearchController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "User PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } }, "x-parameter-index": 1 }, "operationId": "CommonSearchController.updateById" } }, "/update-carrier-aging-status": { "post": { "x-controller-name": "AuditorController", "x-operation-name": "auditUpdateShipmentStatus", "tags": [ "AuditorController" ], "description": "\n\n| Permissions |\n| ------- |\n| auditor carrier aging view |\n", "responses": { "200": { "description": "Shipment model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Shipment" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "AuditorController.auditUpdateShipmentStatus" } }, "/update-claim-notification": { "post": { "x-controller-name": "ArClaimedController", "x-operation-name": "readClaimNotification", "tags": [ "ArClaimedController" ], "description": "", "responses": { "200": { "description": "Return value of ArClaimedController.readClaimNotification", "content": {} } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "proNumber": { "type": "string" } } } } }, "description": "Update claim notification", "required": true }, "operationId": "ArClaimedController.readClaimNotification" } }, "/update-claim-received": { "post": { "x-controller-name": "ArShipperClaimController", "x-operation-name": "updateClaimReceived", "tags": [ "ArShipperClaimController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar view shipper aging |\n", "responses": { "200": { "description": "Collection Notes model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClaimArInvoice" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "ArShipperClaimController.updateClaimReceived" } }, "/update-cpr-to-call/{id}": { "patch": { "x-controller-name": "ShipmentCprRequestController", "x-operation-name": "updateByIdToCall", "tags": [ "ShipmentCprRequestController" ], "description": "\n\n| Permissions |\n| ------- |\n| sme view cpr |\n", "responses": { "200": { "description": "Return value of ShipmentCprRequestController.updateByIdToCall", "content": {} }, "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "CprRequest PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "cprApproveDeclineMessage", "type" ], "properties": { "cprApproveDeclineMessage": { "type": "string", "maxLength": 5000 }, "type": { "type": "string", "maxLength": 50 } } } } }, "x-parameter-index": 1 }, "operationId": "ShipmentCprRequestController.updateByIdToCall" } }, "/update-insurance-document": { "post": { "x-controller-name": "ArInsuranceDocumentsController", "x-operation-name": "updateById", "tags": [ "ArInsuranceDocumentsController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar update insurance document |\n", "responses": { "200": { "description": "Return value of ArInsuranceDocumentsController.updateById", "content": {} }, "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Insurance document PATCH success" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "ArInsuranceDocumentsController.updateById" } }, "/update-multiple-shippers-ap": { "put": { "x-controller-name": "ArShippersController", "x-operation-name": "updateMultipleShippersAp", "tags": [ "ArShippersController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar update shipper |\n", "responses": { "200": { "description": "Return value of ArShippersController.updateMultipleShippersAp", "content": {} }, "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Multiple Shippers PUT success" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "apId": { "type": "number" }, "shipperIds": { "type": "array", "items": { "type": "number" } } }, "required": [ "apId", "shipperIds" ] } } } }, "operationId": "ArShippersController.updateMultipleShippersAp" } }, "/update-payment": { "post": { "x-controller-name": "ArPayReceivedController", "x-operation-name": "createPayment", "tags": [ "ArPayReceivedController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar view pay received |\n", "responses": { "200": { "description": "Invoices model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Invoices" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "ArPayReceivedController.createPayment" } }, "/update-qb-token": { "get": { "x-controller-name": "QuickbookController", "x-operation-name": "updateQbToken", "tags": [ "QuickbookController" ], "responses": { "200": { "description": "Update QB Token", "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "accessToken": { "type": "string" } } } } } } }, "parameters": [ { "name": "realmId", "in": "query", "schema": { "type": "string" } } ], "operationId": "QuickbookController.updateQbToken" } }, "/update-remittance-batch": { "post": { "x-controller-name": "ApRemittanceController", "x-operation-name": "bulkUpdate", "tags": [ "ApRemittanceController" ], "responses": { "200": { "description": "Return value of ApRemittanceController.bulkUpdate" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "ApRemittanceController.bulkUpdate" } }, "/update-shipment-invoice-communication": { "post": { "x-controller-name": "ArInvoiceCommunicationTypeController", "x-operation-name": "updateShipmentInvoiceCommunication", "tags": [ "ArInvoiceCommunicationTypeController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar view shipment |\n", "responses": { "200": { "description": "Return value of ArInvoiceCommunicationTypeController.updateShipmentInvoiceCommunication", "content": {} }, "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "shipment patch success" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "ArInvoiceCommunicationTypeController.updateShipmentInvoiceCommunication" } }, "/update-shipment-price": { "patch": { "x-controller-name": "ArShipmentsController", "x-operation-name": "updateShipment", "tags": [ "ArShipmentsController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar view shipment |\n", "responses": { "200": { "description": "Shippers History model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Shipment" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "ArShipmentsController.updateShipment" } }, "/update-shipment-status/{id}": { "put": { "x-controller-name": "ShipmentStatusController", "x-operation-name": "updateShipmentStatus", "tags": [ "ShipmentStatusController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker create carrier |\n", "responses": { "200": { "description": "Return value of ShipmentStatusController.updateShipmentStatus", "content": {} }, "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Shipment PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "comment": { "type": "string" } }, "required": [ "status" ] } } }, "x-parameter-index": 1 }, "operationId": "ShipmentStatusController.updateShipmentStatus" } }, "/update-shipment-verify-vinnumber-pickup-phone": { "post": { "x-controller-name": "BrokerVinVerificationController", "x-operation-name": "updateShipmentVinNumberPickupPhoneStatus", "tags": [ "BrokerVinVerificationController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker update carrier |\n", "responses": { "200": { "description": "Shipment model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Shipment" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "BrokerVinVerificationController.updateShipmentVinNumberPickupPhoneStatus" } }, "/update-shipper-ap": { "put": { "x-controller-name": "ArShippersController", "x-operation-name": "updateShipperAp", "tags": [ "ArShippersController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar update shipper |\n", "responses": { "200": { "description": "Return value of ArShippersController.updateShipperAp", "content": {} }, "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Shippers PUT success" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "apId": { "type": "number" }, "shipperId": { "type": "number" } }, "required": [ "apId", "shipperId" ] } } } }, "operationId": "ArShippersController.updateShipperAp" } }, "/update-shipper-credit-limit": { "post": { "x-controller-name": "ArShippersController", "x-operation-name": "shippercreditlimit", "tags": [ "ArShippersController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar approve shipper |\n", "responses": { "200": { "description": "Shippers History model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipperHistory" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "ArShippersController.shippercreditlimit" } }, "/update-shipper-limit-request": { "post": { "x-controller-name": "ArshipperLimitController", "x-operation-name": "updateById", "tags": [ "ArshipperLimitController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar update shipper limit |\n", "responses": { "200": { "description": "Return value of ArshipperLimitController.updateById", "content": {} }, "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Shipper Limit PATCH success" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "ArshipperLimitController.updateById" } }, "/update-user-policy-date": { "post": { "x-controller-name": "BrokerHomeController", "x-operation-name": "updateMultipleLoadConfirmation", "tags": [ "BrokerHomeController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker create shipment |\n", "responses": { "200": { "description": "Return value of BrokerHomeController.updateMultipleLoadConfirmation", "content": {} }, "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Multiple Shippers PUT success" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "BrokerHomeController.updateMultipleLoadConfirmation" } }, "/updateCPR/{id}": { "patch": { "x-controller-name": "ShipmentCprRequestController", "x-operation-name": "updateById", "tags": [ "ShipmentCprRequestController" ], "description": "\n\n| Permissions |\n| ------- |\n| sme view cpr |\n", "responses": { "200": { "description": "Return value of ShipmentCprRequestController.updateById", "content": {} }, "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "CprRequest PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "cprApproveDeclineMessage", "type" ], "properties": { "cprApproveDeclineMessage": { "type": "string", "maxLength": 5000 }, "type": { "type": "string", "maxLength": 50 } } } } }, "x-parameter-index": 1 }, "operationId": "ShipmentCprRequestController.updateById" } }, "/updateReMcRequest/{id}": { "patch": { "x-controller-name": "ShipmentCprRequestController", "x-operation-name": "updateMcReVerificationById", "tags": [ "ShipmentCprRequestController" ], "description": "\n\n| Permissions |\n| ------- |\n| sme view cpr |\n", "responses": { "200": { "description": "Return value of ShipmentCprRequestController.updateMcReVerificationById", "content": {} }, "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "McReVerification PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "smeStatus", "approvalDate" ], "properties": { "smeStatus": { "type": "number", "maxLength": 10 }, "approvalDate": { "type": "string" } } } } }, "x-parameter-index": 1 }, "operationId": "ShipmentCprRequestController.updateMcReVerificationById" } }, "/upload": { "post": { "x-controller-name": "FileController", "x-operation-name": "fileUpload", "tags": [ "FileController" ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Files and fields" } }, "requestBody": { "content": { "multipart/form-data": { "x-parser": "stream", "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } } } } }, "description": "Request body for multipart/form-data based file upload", "required": true }, "operationId": "FileController.fileUpload" } }, "/upload-ace-asi-invoices": { "get": { "x-controller-name": "QuickbookController", "x-operation-name": "aceVlInvoicesDataList", "tags": [ "QuickbookController" ], "responses": { "200": { "description": "Upload ASI ACE fake invoices/bills on QB", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "invoiceType", "in": "query", "schema": { "type": "number" } } ], "operationId": "QuickbookController.aceVlInvoicesDataList" } }, "/upload-ace-bills-qb": { "get": { "x-controller-name": "QuickbookController", "x-operation-name": "uploadAceInvoicesBills", "tags": [ "QuickbookController" ], "responses": { "200": { "description": "Upload ACE fake invoices-bills on QB", "content": { "application/json": { "schema": { "type": "object" } } } } }, "operationId": "QuickbookController.uploadAceInvoicesBills" } }, "/upload-ace-customer": { "get": { "x-controller-name": "QuickbookController", "x-operation-name": "uploadAceCustomer", "tags": [ "QuickbookController" ], "responses": { "200": { "description": "Upload Ace customer on QB", "content": { "application/json": { "schema": { "type": "object" } } } } }, "operationId": "QuickbookController.uploadAceCustomer" } }, "/upload-ace-customers-invoices": { "get": { "x-controller-name": "QuickbookController", "x-operation-name": "uploadAceCustomersInvoices", "tags": [ "QuickbookController" ], "responses": { "200": { "description": "Upload VL customer on QB", "content": { "application/json": { "schema": { "type": "object" } } } } }, "operationId": "QuickbookController.uploadAceCustomersInvoices" } }, "/upload-asi-carriers-bill-on-vl-quick-book-with-real-carrier": { "get": { "x-controller-name": "QuickbookController", "x-operation-name": "uploadAsiCarriersBillOnVlQuickBookWithRealCarrier", "tags": [ "QuickbookController" ], "responses": { "200": { "description": "Upload ASI carrier on VL QB", "content": { "application/json": { "schema": { "type": "object" } } } } }, "operationId": "QuickbookController.uploadAsiCarriersBillOnVlQuickBookWithRealCarrier" } }, "/upload-asi-carriers-paid-invoices": { "get": { "x-controller-name": "QuickbookController", "x-operation-name": "uploadAsiCarriersPaidInvoices", "tags": [ "QuickbookController" ], "responses": { "200": { "description": "Upload VL carriers on QB", "content": { "application/json": { "schema": { "type": "object" } } } } }, "operationId": "QuickbookController.uploadAsiCarriersPaidInvoices" } }, "/upload-asi-customer": { "get": { "x-controller-name": "QuickbookController", "x-operation-name": "uploadAsiCustomer", "tags": [ "QuickbookController" ], "responses": { "200": { "description": "Upload VL customer on QB", "content": { "application/json": { "schema": { "type": "object" } } } } }, "operationId": "QuickbookController.uploadAsiCustomer" } }, "/upload-asi-customers-invoices": { "get": { "x-controller-name": "QuickbookController", "x-operation-name": "uploadAsiCustomersInvoices", "tags": [ "QuickbookController" ], "responses": { "200": { "description": "Upload VL customer on QB", "content": { "application/json": { "schema": { "type": "object" } } } } }, "operationId": "QuickbookController.uploadAsiCustomersInvoices" } }, "/upload-asi-vl-carriers": { "get": { "x-controller-name": "QuickbookController", "x-operation-name": "uploadCarriersOnQb", "tags": [ "QuickbookController" ], "responses": { "200": { "description": "Upload VL carriers on QB", "content": { "application/json": { "schema": { "type": "object" } } } } }, "parameters": [ { "name": "type", "in": "query", "schema": { "type": "number" } } ], "operationId": "QuickbookController.uploadCarriersOnQb" } }, "/upload-asi-vl-customers-invoices": { "get": { "x-controller-name": "QuickbookController", "x-operation-name": "uploadAsiVlCustomersInvoices", "tags": [ "QuickbookController" ], "responses": { "200": { "description": "Upload VL customer on QB", "content": { "application/json": { "schema": { "type": "object" } } } } }, "operationId": "QuickbookController.uploadAsiVlCustomersInvoices" } }, "/upload-azure-gallery": { "post": { "x-controller-name": "CommonfileuploadController", "x-operation-name": "uploadAzureGallery", "tags": [ "CommonfileuploadController" ], "responses": { "200": { "description": "Upload file to Azure Gallery" } }, "operationId": "CommonfileuploadController.uploadAzureGallery" } }, "/upload-blog-image": { "post": { "x-controller-name": "EmailMarketingController", "x-operation-name": "uploadImage", "tags": [ "EmailMarketingController" ], "responses": { "200": { "description": "File Upload Success", "content": { "application/json": { "schema": { "type": "object" } } } } }, "operationId": "EmailMarketingController.uploadImage" } }, "/upload-files": { "post": { "x-controller-name": "CommonfileuploadController", "x-operation-name": "fileUploadPdf", "tags": [ "CommonfileuploadController" ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Files and fields" } }, "description": "", "requestBody": { "content": { "multipart/form-data": { "x-parser": "stream", "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } } } } }, "description": "Request body for multipart/form-data based file upload", "required": true }, "operationId": "CommonfileuploadController.fileUploadPdf" } }, "/upload-images": { "post": { "x-controller-name": "CommonfileuploadController", "x-operation-name": "fileUpload", "tags": [ "CommonfileuploadController" ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Files and fields" } }, "description": "", "requestBody": { "content": { "multipart/form-data": { "x-parser": "stream", "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } } } } }, "description": "Request body for multipart/form-data based file upload", "required": true }, "operationId": "CommonfileuploadController.fileUpload" } }, "/upload-remittance-doc": { "post": { "x-controller-name": "CommonfileuploadController", "x-operation-name": "uploadRemittance", "tags": [ "CommonfileuploadController" ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Files and fields" } }, "description": "", "requestBody": { "content": { "multipart/form-data": { "x-parser": "stream", "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } } } } }, "description": "Request body for multipart/form-data based file upload", "required": true }, "operationId": "CommonfileuploadController.uploadRemittance" } }, "/upload-vl-carriers-invoices": { "get": { "x-controller-name": "QuickbookController", "x-operation-name": "uploadVlCarriersInvoices", "tags": [ "QuickbookController" ], "responses": { "200": { "description": "Upload VL carriers on QB", "content": { "application/json": { "schema": { "type": "object" } } } } }, "operationId": "QuickbookController.uploadVlCarriersInvoices" } }, "/upload-vl-carriers-paid-invoices": { "get": { "x-controller-name": "QuickbookController", "x-operation-name": "uploadVlCarriersPaidInvoices", "tags": [ "QuickbookController" ], "responses": { "200": { "description": "Upload VL carriers on QB", "content": { "application/json": { "schema": { "type": "object" } } } } }, "operationId": "QuickbookController.uploadVlCarriersPaidInvoices" } }, "/upload-vl-customer": { "get": { "x-controller-name": "QuickbookController", "x-operation-name": "uploadVlCustomer", "tags": [ "QuickbookController" ], "responses": { "200": { "description": "Upload VL customer on QB", "content": { "application/json": { "schema": { "type": "object" } } } } }, "operationId": "QuickbookController.uploadVlCustomer" } }, "/upload-vl-customer-invoices": { "get": { "x-controller-name": "QuickbookController", "x-operation-name": "uploadVlCustomerInvoices", "tags": [ "QuickbookController" ], "responses": { "200": { "description": "Upload VL customer on QB", "content": { "application/json": { "schema": { "type": "object" } } } } }, "operationId": "QuickbookController.uploadVlCustomerInvoices" } }, "/upload-vl-customer-invoices-done-by-flio": { "get": { "x-controller-name": "QuickbookController", "x-operation-name": "uploadVlCustomerInvoicesDoneByFlio", "tags": [ "QuickbookController" ], "responses": { "200": { "description": "Upload VL customer on QB", "content": { "application/json": { "schema": { "type": "object" } } } } }, "operationId": "QuickbookController.uploadVlCustomerInvoicesDoneByFlio" } }, "/user-group-list": { "get": { "x-controller-name": "UserGroupController", "x-operation-name": "find", "tags": [ "UserGroupController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker create group |\n", "responses": { "200": { "description": "Array of email marketing model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserGroupWithRelations" } } } } } }, "parameters": [ { "name": "page", "in": "query", "schema": { "type": "number" } }, { "name": "pageSize", "in": "query", "schema": { "type": "number" } } ], "operationId": "UserGroupController.find" } }, "/users/all/shippers": { "get": { "x-controller-name": "UserShippersController", "x-operation-name": "find", "tags": [ "UserShippersController" ], "responses": { "200": { "description": "Array of User has many Shippers", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Shippers" } } } } } }, "description": "\n\n| Permissions |\n| ------- |\n| broker view shipper |\n", "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } ], "operationId": "UserShippersController.find" } }, "/users/device/all-notifications": { "post": { "x-controller-name": "NotificationController", "x-operation-name": "getAllNotificationsForUser", "tags": [ "NotificationController" ], "description": "", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Fetch all notifications and optionally mark all as read" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "readStatus": { "type": "string", "enum": [ "1" ] } } } } }, "description": "Optional readStatus to mark all notifications as read", "required": false }, "operationId": "NotificationController.getAllNotificationsForUser" } }, "/users/device-token": { "post": { "x-controller-name": "MobileAppController", "x-operation-name": "updateDeviceToken", "tags": [ "MobileAppController" ], "description": "", "responses": { "200": { "description": "Device token update result", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "deviceType", "deviceToken" ], "properties": { "deviceType": { "type": "string", "enum": [ "ios", "android" ], "description": "Type of the device" }, "deviceToken": { "type": "string", "description": "The device token to update" } } } } }, "description": "Device token update payload", "required": true }, "operationId": "MobileAppController.updateDeviceToken" } }, "/users/get-user-action-logs": { "get": { "x-controller-name": "UserUserController", "x-operation-name": "getUserActionLogs", "tags": [ "UserUserController" ], "responses": { "200": { "description": "Array of UserActionLog model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UserActionLogWithRelations" } } } } } }, "description": "", "parameters": [ { "name": "action", "in": "query", "schema": { "type": "string" } }, { "name": "module", "in": "query", "schema": { "type": "string" } } ], "operationId": "UserUserController.getUserActionLogs" } }, "/users/login": { "post": { "x-controller-name": "AuthController", "x-operation-name": "login", "tags": [ "AuthController" ], "responses": { "200": { "description": "Token", "content": { "application/json": { "schema": { "type": "object", "properties": { "token": { "type": "string" } } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "email", "password" ], "properties": { "email": { "type": "string", "format": "email" }, "password": { "type": "string", "minLength": 6 } } } } }, "description": "The input of login function", "required": true }, "operationId": "AuthController.login" } }, "/users/optlogin": { "post": { "x-controller-name": "AuthController", "x-operation-name": "otplogin", "tags": [ "AuthController" ], "responses": { "200": { "description": "Return value of AuthController.otplogin" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "optNumber" ], "properties": { "optNumber": { "type": "string" } } } } } }, "operationId": "AuthController.otplogin" } }, "/users/user-action-log": { "post": { "x-controller-name": "UserUserController", "x-operation-name": "createUserActionLog", "tags": [ "UserUserController" ], "responses": { "200": { "description": "UserActionLog model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserActionLog" } } } } }, "description": "", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserActionLog" } } }, "description": "User action log request", "required": true }, "operationId": "UserUserController.createUserActionLog" } }, "/users/user-action-logs-all": { "get": { "x-controller-name": "UserUserController", "x-operation-name": "getUserActionLogsGroupedArrays", "tags": [ "UserUserController" ], "description": "", "responses": { "200": { "description": "Get user action logs grouped by user ID with actions and counts as arrays", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "array", "items": { "type": "object", "properties": { "userId": { "type": "number" }, "name": { "type": "string" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "source": { "type": "string" }, "real_name": { "type": "string" }, "email": { "type": "string" }, "actionCounts": { "type": "object", "additionalProperties": { "type": "number" } } } } }, "totalCount": { "type": "number" }, "page": { "type": "number" }, "pageSize": { "type": "number" }, "totalPages": { "type": "number" }, "totals": { "type": "object", "additionalProperties": { "type": "number" } }, "modules": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "key": { "type": "string" } } } } } } } } } }, "parameters": [ { "name": "platform", "in": "query", "schema": { "type": "string" } }, { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "type": "number" } }, { "name": "pageSize", "in": "query", "schema": { "type": "number" } } ], "operationId": "UserUserController.getUserActionLogsGroupedArrays" } }, "/users/user-action-logs-history": { "get": { "x-controller-name": "UserUserController", "x-operation-name": "getUserActionLogsHistory", "tags": [ "UserUserController" ], "description": "", "responses": { "200": { "description": "Get all user action logs history with pagination", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/UserActionLogWithRelations" } }, "totalCount": { "type": "number" }, "page": { "type": "number" }, "pageSize": { "type": "number" }, "totalPages": { "type": "number" } } } } } } }, "parameters": [ { "name": "module", "in": "query", "schema": { "type": "string" } }, { "name": "source", "in": "query", "schema": { "type": "string" } }, { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "userId", "in": "query", "schema": { "type": "number" } }, { "name": "page", "in": "query", "schema": { "type": "number" } }, { "name": "pageSize", "in": "query", "schema": { "type": "number" } } ], "operationId": "UserUserController.getUserActionLogsHistory" } }, "/users/{id}/carrier-payment-dones": { "post": { "x-controller-name": "UserCarrierPaymentDoneController", "x-operation-name": "create", "tags": [ "UserCarrierPaymentDoneController" ], "responses": { "200": { "description": "User model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CarrierPaymentDone" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewCarrierPaymentDoneInUser" } } }, "x-parameter-index": 1 }, "operationId": "UserCarrierPaymentDoneController.create" }, "patch": { "x-controller-name": "UserCarrierPaymentDoneController", "x-operation-name": "patch", "tags": [ "UserCarrierPaymentDoneController" ], "responses": { "200": { "description": "User.CarrierPaymentDone PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "CarrierPaymentDone.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CarrierPaymentDonePartial" } } }, "x-parameter-index": 1 }, "operationId": "UserCarrierPaymentDoneController.patch" }, "get": { "x-controller-name": "UserCarrierPaymentDoneController", "x-operation-name": "find", "tags": [ "UserCarrierPaymentDoneController" ], "responses": { "200": { "description": "Array of User has many CarrierPaymentDone", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CarrierPaymentDone" } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } ], "operationId": "UserCarrierPaymentDoneController.find" }, "delete": { "x-controller-name": "UserCarrierPaymentDoneController", "x-operation-name": "delete", "tags": [ "UserCarrierPaymentDoneController" ], "responses": { "200": { "description": "User.CarrierPaymentDone DELETE success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "CarrierPaymentDone.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "UserCarrierPaymentDoneController.delete" } }, "/users/{id}/carrier-payments": { "post": { "x-controller-name": "UserCarrierPaymentController", "x-operation-name": "create", "tags": [ "UserCarrierPaymentController" ], "responses": { "200": { "description": "User model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CarrierPayment" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewCarrierPaymentInUser" } } }, "x-parameter-index": 1 }, "operationId": "UserCarrierPaymentController.create" }, "patch": { "x-controller-name": "UserCarrierPaymentController", "x-operation-name": "patch", "tags": [ "UserCarrierPaymentController" ], "responses": { "200": { "description": "User.CarrierPayment PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "CarrierPayment.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CarrierPaymentPartial" } } }, "x-parameter-index": 1 }, "operationId": "UserCarrierPaymentController.patch" }, "get": { "x-controller-name": "UserCarrierPaymentController", "x-operation-name": "find", "tags": [ "UserCarrierPaymentController" ], "responses": { "200": { "description": "Array of User has many CarrierPayment", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CarrierPayment" } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } ], "operationId": "UserCarrierPaymentController.find" }, "delete": { "x-controller-name": "UserCarrierPaymentController", "x-operation-name": "delete", "tags": [ "UserCarrierPaymentController" ], "responses": { "200": { "description": "User.CarrierPayment DELETE success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "CarrierPayment.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "UserCarrierPaymentController.delete" } }, "/users/{id}/cpr-requests": { "post": { "x-controller-name": "UserCprRequestController", "x-operation-name": "create", "tags": [ "UserCprRequestController" ], "responses": { "200": { "description": "User model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CprRequest" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewCprRequestInUser" } } }, "x-parameter-index": 1 }, "operationId": "UserCprRequestController.create" }, "patch": { "x-controller-name": "UserCprRequestController", "x-operation-name": "patch", "tags": [ "UserCprRequestController" ], "responses": { "200": { "description": "User.CprRequest PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "CprRequest.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CprRequestPartial" } } }, "x-parameter-index": 1 }, "operationId": "UserCprRequestController.patch" }, "get": { "x-controller-name": "UserCprRequestController", "x-operation-name": "find", "tags": [ "UserCprRequestController" ], "responses": { "200": { "description": "Array of User has many CprRequest", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CprRequest" } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } ], "operationId": "UserCprRequestController.find" }, "delete": { "x-controller-name": "UserCprRequestController", "x-operation-name": "delete", "tags": [ "UserCprRequestController" ], "responses": { "200": { "description": "User.CprRequest DELETE success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "CprRequest.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "UserCprRequestController.delete" } }, "/users/{id}/mc-verifications": { "post": { "x-controller-name": "UserMcVerificationController", "x-operation-name": "create", "tags": [ "UserMcVerificationController" ], "responses": { "200": { "description": "User model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/McVerification" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewMcVerificationInUser" } } }, "x-parameter-index": 1 }, "operationId": "UserMcVerificationController.create" }, "patch": { "x-controller-name": "UserMcVerificationController", "x-operation-name": "patch", "tags": [ "UserMcVerificationController" ], "responses": { "200": { "description": "User.McVerification PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "McVerification.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/McVerificationPartial" } } }, "x-parameter-index": 1 }, "operationId": "UserMcVerificationController.patch" }, "get": { "x-controller-name": "UserMcVerificationController", "x-operation-name": "find", "tags": [ "UserMcVerificationController" ], "responses": { "200": { "description": "Array of User has many McVerification", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/McVerification" } } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } ], "operationId": "UserMcVerificationController.find" }, "delete": { "x-controller-name": "UserMcVerificationController", "x-operation-name": "delete", "tags": [ "UserMcVerificationController" ], "responses": { "200": { "description": "User.McVerification DELETE success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "McVerification.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "UserMcVerificationController.delete" } }, "/users/{id}/portal": { "get": { "x-controller-name": "UserPortalController", "x-operation-name": "getPortal", "tags": [ "UserPortalController" ], "responses": { "200": { "description": "Portal belonging to User", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Portal" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "UserPortalController.getPortal" } }, "/users/{id}/role": { "get": { "x-controller-name": "UserRoleController", "x-operation-name": "getRole", "tags": [ "UserRoleController" ], "responses": { "200": { "description": "Role belonging to User", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Role" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "UserRoleController.getRole" } }, "/users/{id}/shippers": { "post": { "x-controller-name": "UserShippersController", "x-operation-name": "create", "tags": [ "UserShippersController" ], "responses": { "200": { "description": "User model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Shippers" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewShippersInUser" } } }, "x-parameter-index": 1 }, "operationId": "UserShippersController.create" }, "patch": { "x-controller-name": "UserShippersController", "x-operation-name": "patch", "tags": [ "UserShippersController" ], "responses": { "200": { "description": "User.Shippers PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Shippers.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShippersPartial" } } }, "x-parameter-index": 1 }, "operationId": "UserShippersController.patch" }, "delete": { "x-controller-name": "UserShippersController", "x-operation-name": "delete", "tags": [ "UserShippersController" ], "responses": { "200": { "description": "User.Shippers DELETE success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Shippers.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "UserShippersController.delete" } }, "/users/{id}/user": { "get": { "x-controller-name": "UserUserController", "x-operation-name": "getUser", "tags": [ "UserUserController" ], "responses": { "200": { "description": "User belonging to User", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "UserUserController.getUser" } }, "/v1/calls": { "post": { "x-controller-name": "EmailMarketingController", "x-operation-name": "createCall", "tags": [ "EmailMarketingController" ], "responses": { "200": { "description": "Return value of EmailMarketingController.createCall" } }, "operationId": "EmailMarketingController.createCall" } }, "/v1/calls1": { "post": { "x-controller-name": "VonageController", "x-operation-name": "createCall", "tags": [ "VonageController" ], "responses": { "200": { "description": "Return value of VonageController.createCall" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "toNumber": { "type": "string", "description": "E.164 like 91XXXXXXXXXX" }, "mode": { "type": "string", "enum": [ "ncco", "answer_url" ] }, "text": { "type": "string" } } } } }, "required": false }, "operationId": "VonageController.createCall" }, "get": { "x-controller-name": "VonageController", "x-operation-name": "testEndpoint", "tags": [ "VonageController" ], "responses": { "200": { "description": "Return value of VonageController.testEndpoint" } }, "operationId": "VonageController.testEndpoint" } }, "/v1/recordings/audio/{recording_id}": { "get": { "x-controller-name": "VonageController", "x-operation-name": "downloadRecordingAudio", "tags": [ "VonageController" ], "responses": { "200": { "description": "Return value of VonageController.downloadRecordingAudio" } }, "parameters": [ { "name": "recording_id", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "VonageController.downloadRecordingAudio" } }, "/v1/recordings/{uuid}": { "get": { "x-controller-name": "VonageController", "x-operation-name": "downloadRecording", "tags": [ "VonageController" ], "responses": { "200": { "description": "Return value of VonageController.downloadRecording" } }, "parameters": [ { "name": "uuid", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "VonageController.downloadRecording" } }, "/value-desk/redirection-link": { "get": { "x-controller-name": "AuthController", "x-operation-name": "getValueDeskRedirectionLink", "tags": [ "AuthController" ], "responses": { "200": { "description": "Get ValueDesk SSO redirection link for current user", "content": { "application/json": { "schema": { "type": "object", "properties": { "loginUrl": { "type": "string" } } } } } } }, "description": "", "operationId": "AuthController.getValueDeskRedirectionLink" } }, "/verified-mc/{id}/{type}": { "get": { "x-controller-name": "McVerificationController", "x-operation-name": "getvarifiedMC", "tags": [ "McVerificationController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker send mc request |\n", "responses": { "200": { "description": "McVerification model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/McVerificationWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "string" }, "required": true }, { "name": "type", "in": "path", "schema": { "type": "string" }, "required": true } ], "operationId": "McVerificationController.getvarifiedMC" } }, "/verify-pickup-phone-number": { "post": { "x-controller-name": "BrokerVinVerificationController", "x-operation-name": "PickPhoneNumberVerify", "tags": [ "BrokerVinVerificationController" ], "responses": { "200": { "description": "Notes model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Shipment" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "BrokerVinVerificationController.PickPhoneNumberVerify" } }, "/vin-month-report-asi-list": { "get": { "x-controller-name": "CronJobController", "x-operation-name": "vinReportAsi", "tags": [ "CronJobController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } } }, "operationId": "CronJobController.vinReportAsi" } }, "/vin-month-report-vl-list": { "get": { "x-controller-name": "CronJobController", "x-operation-name": "vinReport", "tags": [ "CronJobController" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } } } } }, "operationId": "CronJobController.vinReport" } }, "/vin-verifications/{id}/shipment": { "get": { "x-controller-name": "VinVerificationShipmentController", "x-operation-name": "getShipment", "tags": [ "VinVerificationShipmentController" ], "responses": { "200": { "description": "Shipment belonging to VinVerification", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Shipment" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "VinVerificationShipmentController.getShipment" } }, "/vin-verifications/{id}/user": { "get": { "x-controller-name": "VinVerificationUserController", "x-operation-name": "getUser", "tags": [ "VinVerificationUserController" ], "responses": { "200": { "description": "User belonging to VinVerification", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "VinVerificationUserController.getUser" } }, "/vinhistories/{id}/shipment": { "get": { "x-controller-name": "VinhistoryShipmentController", "x-operation-name": "getShipment", "tags": [ "VinhistoryShipmentController" ], "responses": { "200": { "description": "Shipment belonging to Vinhistory", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Shipment" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "VinhistoryShipmentController.getShipment" } }, "/vinhistories/{id}/user": { "get": { "x-controller-name": "VinhistoryUserController", "x-operation-name": "getUser", "tags": [ "VinhistoryUserController" ], "responses": { "200": { "description": "User belonging to Vinhistory", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "VinhistoryUserController.getUser" } }, "/vonage/answer": { "post": { "x-controller-name": "EmailMarketingController", "x-operation-name": "vonageAnswer", "tags": [ "EmailMarketingController" ], "responses": { "200": { "description": "Vonage answer webhook", "content": { "application/json": { "schema": { "type": "array" } } } } }, "operationId": "EmailMarketingController.vonageAnswer" } }, "/vonage/compare-key-reading": { "get": { "x-controller-name": "VonageController", "x-operation-name": "compareKeyReading", "tags": [ "VonageController" ], "responses": { "200": { "description": "Return value of VonageController.compareKeyReading" } }, "operationId": "VonageController.compareKeyReading" } }, "/vonage/event": { "post": { "x-controller-name": "EmailMarketingController", "x-operation-name": "vonageEvent", "tags": [ "EmailMarketingController" ], "responses": { "200": { "description": "Return value of EmailMarketingController.vonageEvent" } }, "operationId": "EmailMarketingController.vonageEvent" } }, "/vonage/test-jwt": { "get": { "x-controller-name": "VonageController", "x-operation-name": "testJWT", "tags": [ "VonageController" ], "responses": { "200": { "description": "Return value of VonageController.testJWT" } }, "operationId": "VonageController.testJWT" } }, "/vonage/validate-number": { "post": { "x-controller-name": "EmailMarketingController", "x-operation-name": "validatePhoneNumber", "tags": [ "EmailMarketingController" ], "responses": { "200": { "description": "Validate phone number format before making call", "content": { "application/json": { "schema": { "type": "object" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "EmailMarketingController.validatePhoneNumber" } }, "/vonage-users-list": { "get": { "x-controller-name": "EmailMarketingController", "x-operation-name": "vonageUsersList", "tags": [ "EmailMarketingController" ], "responses": { "200": { "description": "Return value of EmailMarketingController.vonageUsersList" } }, "operationId": "EmailMarketingController.vonageUsersList" } }, "/webhook/sendgrid": { "post": { "x-controller-name": "EmailMarketingController", "x-operation-name": "handleSendGridWebhook", "tags": [ "EmailMarketingController" ], "responses": { "200": { "description": "Return value of EmailMarketingController.handleSendGridWebhook" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "array" } } } }, "operationId": "EmailMarketingController.handleSendGridWebhook" } }, "/webhooks/mailtrap": { "post": { "x-controller-name": "EmailMarketingController", "x-operation-name": "receiveWebhook", "tags": [ "EmailMarketingController" ], "responses": { "200": { "description": "Return value of EmailMarketingController.receiveWebhook" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } } }, "operationId": "EmailMarketingController.receiveWebhook" } }, "/week-of-sales": { "get": { "x-controller-name": "BrokerHomeController", "x-operation-name": "weekofSales", "tags": [ "BrokerHomeController" ], "description": "\n\n| Permissions |\n| ------- |\n| broker view dashboard |\n", "responses": { "200": { "description": "Shipment model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoicesWithRelations" } } } } }, "operationId": "BrokerHomeController.weekofSales" } }, "/whoami": { "get": { "x-controller-name": "AuthController", "x-operation-name": "whoAmI", "tags": [ "AuthController" ], "responses": { "200": { "description": "Return current user", "content": { "application/json": { "schema": { "type": "string" } } } } }, "description": "", "operationId": "AuthController.whoAmI" } }, "/withdrawn-comments/{id}/withdrawn-shipper-credit-limit-history": { "get": { "x-controller-name": "WithdrawnCommentsHistoryWithdrawnShipperCreditLimitHistoryController", "x-operation-name": "getWithdrawnShipperCreditLimitHistory", "tags": [ "WithdrawnCommentsHistoryWithdrawnShipperCreditLimitHistoryController" ], "responses": { "200": { "description": "WithdrawnShipperCreditLimitHistory belonging to WithdrawnCommentsHistory", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WithdrawnShipperCreditLimitHistory" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "WithdrawnCommentsHistoryWithdrawnShipperCreditLimitHistoryController.getWithdrawnShipperCreditLimitHistory" } }, "/withdrawn-comments-history": { "get": { "x-controller-name": "WithdrawnShipperCreditLimitHistoryController", "x-operation-name": "getWithdrawnCommentsHistory", "tags": [ "WithdrawnShipperCreditLimitHistoryController" ], "description": "\n\n| Permissions |\n| ------- |\n| ar withdrawn limit |\n", "responses": { "200": { "description": "WithdrawnCommentsHistory model instance", "content": { "application/json": { "schema": {} } } } }, "parameters": [ { "name": "withdrawnId", "in": "query", "schema": { "type": "number" } } ], "operationId": "WithdrawnShipperCreditLimitHistoryController.getWithdrawnCommentsHistory" } }, "/withdrawn-shipper-credit-limit-histories/{id}/portal": { "get": { "x-controller-name": "WithdrawnShipperCreditLimitHistoryPortalController", "x-operation-name": "getPortal", "tags": [ "WithdrawnShipperCreditLimitHistoryPortalController" ], "responses": { "200": { "description": "Portal belonging to WithdrawnShipperCreditLimitHistory", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Portal" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "WithdrawnShipperCreditLimitHistoryPortalController.getPortal" } }, "/withdrawn-shipper-credit-limit-histories/{id}/shippers": { "get": { "x-controller-name": "WithdrawnShipperCreditLimitHistoryController", "x-operation-name": "getShippers", "tags": [ "WithdrawnShipperCreditLimitHistoryController" ], "responses": { "200": { "description": "Shippers belonging to WithdrawnShipperCreditLimitHistory", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Shippers" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "WithdrawnShipperCreditLimitHistoryController.getShippers" } }, "/withdrawn-shipper-limit-list": { "get": { "x-controller-name": "WithdrawnShipperCreditLimitHistoryController", "x-operation-name": "getShipperListForWithdrawn", "tags": [ "WithdrawnShipperCreditLimitHistoryController" ], "responses": { "200": { "description": "Shippers belonging to WithdrawnShipperCreditLimitHistory", "content": { "application/json": { "items": { "$ref": "#/components/schemas/ShippersWithRelations", "definitions": { "ShippersWithRelations": { "$ref": "#/components/schemas/ShippersWithRelations" } } } } } } }, "description": "\n\n| Permissions |\n| ------- |\n| ar withdrawn limit |\n", "parameters": [ { "name": "shippersId", "in": "query", "schema": { "type": "number" } }, { "name": "page", "in": "query", "schema": { "type": "number" } }, { "name": "limit", "in": "query", "schema": { "type": "number" } }, { "name": "withdrawnStatus", "in": "query", "schema": { "type": "number" } } ], "operationId": "WithdrawnShipperCreditLimitHistoryController.getShipperListForWithdrawn" } }, "/workbooks/count": { "get": { "x-controller-name": "WorkbookController", "x-operation-name": "count", "tags": [ "WorkbookController" ], "description": "", "responses": { "200": { "description": "Workbook model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Workbook.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "WorkbookController.count" } }, "/workbooks/{id}": { "put": { "x-controller-name": "WorkbookController", "x-operation-name": "replaceById", "tags": [ "WorkbookController" ], "description": "", "responses": { "200": { "description": "Return value of WorkbookController.replaceById", "content": {} }, "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Workbook PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Workbook" } } }, "x-parameter-index": 1 }, "operationId": "WorkbookController.replaceById" }, "patch": { "x-controller-name": "WorkbookController", "x-operation-name": "updateById", "tags": [ "WorkbookController" ], "description": "", "responses": { "200": { "description": "Return value of WorkbookController.updateById", "content": {} }, "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Workbook PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkbookPartialExcluding_id-createdAt-userId_" } } }, "x-parameter-index": 1 }, "operationId": "WorkbookController.updateById" }, "get": { "x-controller-name": "WorkbookController", "x-operation-name": "findById", "tags": [ "WorkbookController" ], "description": "", "responses": { "200": { "description": "Workbook model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkbookWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Workbook.Filter" } } } } ], "operationId": "WorkbookController.findById" }, "delete": { "x-controller-name": "WorkbookController", "x-operation-name": "deleteById", "tags": [ "WorkbookController" ], "description": "", "responses": { "200": { "description": "Return value of WorkbookController.deleteById", "content": {} }, "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Workbook DELETE success (soft delete)" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "WorkbookController.deleteById" } }, "/workbooks": { "post": { "x-controller-name": "WorkbookController", "x-operation-name": "create", "tags": [ "WorkbookController" ], "description": "", "responses": { "200": { "description": "Workbook model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Workbook" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewWorkbook" } } } }, "operationId": "WorkbookController.create" }, "patch": { "x-controller-name": "WorkbookController", "x-operation-name": "updateAll", "tags": [ "WorkbookController" ], "description": "", "responses": { "200": { "description": "Workbook PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Workbook.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkbookPartial" } } } }, "operationId": "WorkbookController.updateAll" }, "get": { "x-controller-name": "WorkbookController", "x-operation-name": "find", "tags": [ "WorkbookController" ], "description": "", "responses": { "200": { "description": "Array of Workbook model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WorkbookWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Workbook.Filter1" } } } } ], "operationId": "WorkbookController.find" } }, "/worksheets/count": { "get": { "x-controller-name": "WorksheetController", "x-operation-name": "count", "tags": [ "WorksheetController" ], "description": "", "responses": { "200": { "description": "Worksheet model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Worksheet.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "WorksheetController.count" } }, "/worksheets/{id}": { "patch": { "x-controller-name": "WorksheetController", "x-operation-name": "updateById", "tags": [ "WorksheetController" ], "description": "", "responses": { "200": { "description": "Return value of WorksheetController.updateById", "content": {} }, "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Worksheet PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "data": { "type": "array", "items": { "type": "array", "items": { "type": "object", "additionalProperties": true } } }, "rows": { "type": "number" }, "cols": { "type": "number" }, "columnNames": { "type": "array", "items": { "type": "string" }, "nullable": true } } } } }, "x-parameter-index": 1 }, "operationId": "WorksheetController.updateById" }, "get": { "x-controller-name": "WorksheetController", "x-operation-name": "findById", "tags": [ "WorksheetController" ], "description": "", "responses": { "200": { "description": "Worksheet model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorksheetWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "WorksheetController.findById" }, "delete": { "x-controller-name": "WorksheetController", "x-operation-name": "deleteById", "tags": [ "WorksheetController" ], "description": "", "responses": { "200": { "description": "Return value of WorksheetController.deleteById", "content": {} }, "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "Worksheet DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "WorksheetController.deleteById" } }, "/worksheets": { "post": { "x-controller-name": "WorksheetController", "x-operation-name": "create", "tags": [ "WorksheetController" ], "description": "", "responses": { "200": { "description": "Worksheet model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Worksheet" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "name", "data", "rows", "cols" ], "properties": { "name": { "type": "string" }, "data": { "type": "array", "items": { "type": "array", "items": { "type": "object", "additionalProperties": true } } }, "rows": { "type": "number" }, "cols": { "type": "number" }, "columnNames": { "type": "array", "items": { "type": "string" }, "nullable": true } } } } } }, "operationId": "WorksheetController.create" }, "get": { "x-controller-name": "WorksheetController", "x-operation-name": "find", "tags": [ "WorksheetController" ], "description": "", "responses": { "200": { "description": "Array of Worksheet model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WorksheetWithRelations" } } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "Worksheet.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "WorksheetController.find" } }, "/zip-codes/count": { "get": { "x-controller-name": "ZipCodesController", "x-operation-name": "count", "tags": [ "ZipCodesController" ], "responses": { "200": { "description": "ZipCodes model count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "ZipCodes.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "operationId": "ZipCodesController.count" } }, "/zip-codes/{id}": { "put": { "x-controller-name": "ZipCodesController", "x-operation-name": "replaceById", "tags": [ "ZipCodesController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "ZipCodes PUT success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ZipCodes" } } }, "x-parameter-index": 1 }, "operationId": "ZipCodesController.replaceById" }, "patch": { "x-controller-name": "ZipCodesController", "x-operation-name": "updateById", "tags": [ "ZipCodesController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "ZipCodes PATCH success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ZipCodesPartial" } } }, "x-parameter-index": 1 }, "operationId": "ZipCodesController.updateById" }, "get": { "x-controller-name": "ZipCodesController", "x-operation-name": "findById", "tags": [ "ZipCodesController" ], "responses": { "200": { "description": "ZipCodes model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ZipCodesWithRelations" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true }, { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ZipCodes.Filter" } } } } ], "operationId": "ZipCodesController.findById" }, "delete": { "x-controller-name": "ZipCodesController", "x-operation-name": "deleteById", "tags": [ "ZipCodesController" ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "description": "ZipCodes DELETE success" } } } } }, "parameters": [ { "name": "id", "in": "path", "schema": { "type": "number" }, "required": true } ], "operationId": "ZipCodesController.deleteById" } }, "/zip-codes": { "post": { "x-controller-name": "ZipCodesController", "x-operation-name": "create", "tags": [ "ZipCodesController" ], "responses": { "200": { "description": "ZipCodes model instance", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ZipCodes" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewZipCodes" } } } }, "operationId": "ZipCodesController.create" }, "patch": { "x-controller-name": "ZipCodesController", "x-operation-name": "updateAll", "tags": [ "ZipCodesController" ], "responses": { "200": { "description": "ZipCodes PATCH success count", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/loopback.Count" } } } } }, "parameters": [ { "name": "where", "in": "query", "content": { "application/json": { "schema": { "type": "object", "title": "ZipCodes.WhereFilter", "additionalProperties": true, "x-typescript-type": "@loopback/repository#Where" } } } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ZipCodesPartial" } } } }, "operationId": "ZipCodesController.updateAll" }, "get": { "x-controller-name": "ZipCodesController", "x-operation-name": "find", "tags": [ "ZipCodesController" ], "responses": { "200": { "description": "Array of ZipCodes model instances", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ZipCodesWithRelations" } } } } } }, "parameters": [ { "name": "filter", "in": "query", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ZipCodes.Filter1" } } } } ], "operationId": "ZipCodesController.find" } } }, "servers": [ { "url": "http://wsinhousebrokerapi.valueloads.com" } ], "components": { "schemas": { "ZipCodes": { "title": "ZipCodes", "type": "object", "properties": { "id": { "type": "number" }, "city_id": { "type": "string" }, "name": { "type": "string" }, "state_code": { "type": "string" }, "zip": { "type": "string" }, "latitude": { "type": "string" }, "longitude": { "type": "string" }, "county": { "type": "string" } }, "additionalProperties": false }, "NewZipCodes": { "title": "NewZipCodes", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewZipCodes', exclude: [ 'id' ] })", "properties": { "city_id": { "type": "string" }, "name": { "type": "string" }, "state_code": { "type": "string" }, "zip": { "type": "string" }, "latitude": { "type": "string" }, "longitude": { "type": "string" }, "county": { "type": "string" } }, "additionalProperties": false, "x-typescript-type": "Omit" }, "ZipCodesWithRelations": { "title": "ZipCodesWithRelations", "type": "object", "description": "(tsType: ZipCodesWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "city_id": { "type": "string" }, "name": { "type": "string" }, "state_code": { "type": "string" }, "zip": { "type": "string" }, "latitude": { "type": "string" }, "longitude": { "type": "string" }, "county": { "type": "string" } }, "additionalProperties": false, "x-typescript-type": "ZipCodesWithRelations" }, "ZipCodesPartial": { "title": "ZipCodesPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number" }, "city_id": { "type": "string" }, "name": { "type": "string" }, "state_code": { "type": "string" }, "zip": { "type": "string" }, "latitude": { "type": "string" }, "longitude": { "type": "string" }, "county": { "type": "string" } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "Worksheet": { "title": "Worksheet", "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "data": { "type": "array", "items": { "type": "array", "items": { "type": "object", "additionalProperties": true } } }, "rows": { "type": "number" }, "cols": { "type": "number" }, "columnNames": { "type": "object", "oneOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "userId": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "user": { "type": "number" } }, "required": [ "name", "data", "rows", "cols" ], "additionalProperties": false }, "UserWithRelations": { "title": "UserWithRelations", "type": "object", "description": "(tsType: UserWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "first_name": { "type": "string", "nullable": true }, "last_name": { "type": "string", "nullable": true }, "real_name": { "type": "string", "nullable": true }, "phone": { "type": "string", "nullable": true }, "ext": { "type": "string", "nullable": true }, "fax": { "type": "string", "nullable": true }, "avatar": { "type": "string", "nullable": true }, "status": { "type": "number", "enum": [ 0, 1, 2 ] }, "optNumber": { "type": "string", "nullable": true }, "twoFactor": { "type": "number", "enum": [ 0, 1 ] }, "arTypeUser": { "type": "number", "enum": [ 0, 1 ] }, "email_verified_at": { "type": "string", "format": "date-time" }, "email": { "type": "string" }, "AccEmail": { "type": "string", "nullable": true }, "password": { "type": "string" }, "realPassword": { "type": "string" }, "created": { "type": "string", "format": "date-time" }, "modified": { "type": "string", "format": "date-time" }, "realm": { "type": "string", "nullable": true }, "username": { "type": "string", "nullable": true }, "emailVerified": { "type": "boolean" }, "verificationToken": { "type": "boolean" }, "type": { "type": "number" }, "drayage": { "type": "boolean" }, "s_gross": { "type": "number" }, "BrokerPolicyDate": { "type": "string", "format": "date-time" }, "brokerIncentivePolicy": { "type": "number", "enum": [ 0, 1 ] }, "vl_user": { "type": "string", "nullable": true }, "vl_phone": { "type": "string", "nullable": true }, "vl_fax": { "type": "string", "nullable": true }, "vl_ext": { "type": "string", "nullable": true }, "bulkEmailAccess": { "type": "string", "nullable": true }, "onboardingDate": { "type": "string", "format": "date-time" }, "lobType": { "type": "number" }, "attrite": { "type": "number" }, "pipType": { "type": "number" }, "vonage_ext": { "type": "number", "nullable": true }, "aliance_ext": { "type": "number", "nullable": true }, "dids_number": { "type": "string", "nullable": true }, "apId": { "type": "number" }, "employeeId": { "type": "string", "nullable": true }, "socketId": { "type": "string" }, "roleId": { "type": "number" }, "portalId": { "type": "number" }, "smeMcVerification": { "type": "array", "items": { "$ref": "#/components/schemas/McVerificationWithRelations" } }, "semCprApproved": { "type": "array", "items": { "$ref": "#/components/schemas/CprRequestWithRelations" } }, "carrierPaymentDones": { "type": "array", "items": { "$ref": "#/components/schemas/CarrierPaymentDoneWithRelations" } }, "AssignApToBroker": { "$ref": "#/components/schemas/UserWithRelations" }, "foreignKey": {}, "apincentives": { "type": "array", "items": { "$ref": "#/components/schemas/CarrierPaymentWithRelations" } }, "role": { "$ref": "#/components/schemas/RoleWithRelations" }, "portal": { "$ref": "#/components/schemas/PortalWithRelations" }, "shippers": { "type": "array", "items": { "$ref": "#/components/schemas/ShippersWithRelations" } } }, "required": [ "name", "status", "twoFactor", "arTypeUser", "email", "password", "type", "brokerIncentivePolicy" ], "additionalProperties": false, "x-typescript-type": "UserWithRelations" }, "WorksheetWithRelations": { "title": "WorksheetWithRelations", "type": "object", "description": "(tsType: WorksheetWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "data": { "type": "array", "items": { "type": "array", "items": { "type": "object", "additionalProperties": true } } }, "rows": { "type": "number" }, "cols": { "type": "number" }, "columnNames": { "type": "object", "oneOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "userId": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "user": { "type": "number" }, "foreignKey": {} }, "required": [ "name", "data", "rows", "cols" ], "additionalProperties": false, "x-typescript-type": "WorksheetWithRelations" }, "Workbook": { "title": "Workbook", "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "sheets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "data": { "type": "array", "items": { "type": "array", "items": { "type": "object", "additionalProperties": true } } }, "rows": { "type": "number" }, "cols": { "type": "number" }, "columnNames": { "type": "array", "items": { "type": "string" } }, "columnWidths": { "type": "object" }, "rowHeights": { "type": "object" }, "frozenRows": { "type": "number" }, "frozenCols": { "type": "number" } }, "required": [ "id", "name", "data", "rows", "cols" ], "additionalProperties": false } }, "activeSheetId": { "type": "string" }, "userId": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" } }, "required": [ "name", "sheets", "activeSheetId" ], "additionalProperties": false }, "NewWorkbook": { "title": "NewWorkbook", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewWorkbook', exclude: [ 'id', 'createdAt', 'updatedAt', 'userId' ] })", "properties": { "name": { "type": "string" }, "sheets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "data": { "type": "array", "items": { "type": "array", "items": { "type": "object", "additionalProperties": true } } }, "rows": { "type": "number" }, "cols": { "type": "number" }, "columnNames": { "type": "array", "items": { "type": "string" } }, "columnWidths": { "type": "object" }, "rowHeights": { "type": "object" }, "frozenRows": { "type": "number" }, "frozenCols": { "type": "number" } }, "required": [ "id", "name", "data", "rows", "cols" ], "additionalProperties": false } }, "activeSheetId": { "type": "string" }, "deletedAt": { "type": "string", "format": "date-time" } }, "required": [ "name", "sheets", "activeSheetId" ], "additionalProperties": false, "x-typescript-type": "Omit" }, "WorkbookWithRelations": { "title": "WorkbookWithRelations", "type": "object", "description": "(tsType: WorkbookWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "sheets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "data": { "type": "array", "items": { "type": "array", "items": { "type": "object", "additionalProperties": true } } }, "rows": { "type": "number" }, "cols": { "type": "number" }, "columnNames": { "type": "array", "items": { "type": "string" } }, "columnWidths": { "type": "object" }, "rowHeights": { "type": "object" }, "frozenRows": { "type": "number" }, "frozenCols": { "type": "number" } }, "required": [ "id", "name", "data", "rows", "cols" ], "additionalProperties": false } }, "activeSheetId": { "type": "string" }, "userId": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" } }, "required": [ "name", "sheets", "activeSheetId" ], "additionalProperties": false, "x-typescript-type": "WorkbookWithRelations" }, "WorkbookPartial": { "title": "WorkbookPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "sheets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "data": { "type": "array", "items": { "type": "array", "items": { "type": "object", "additionalProperties": true } } }, "rows": { "type": "number" }, "cols": { "type": "number" }, "columnNames": { "type": "array", "items": { "type": "string" } }, "columnWidths": { "type": "object" }, "rowHeights": { "type": "object" }, "frozenRows": { "type": "number" }, "frozenCols": { "type": "number" } }, "required": [ "id", "name", "data", "rows", "cols" ], "additionalProperties": false } }, "activeSheetId": { "type": "string" }, "userId": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "WorkbookPartialExcluding_id-createdAt-userId_": { "title": "WorkbookPartialExcluding_id-createdAt-userId_", "type": "object", "description": "(tsType: Omit, 'id' | 'createdAt' | 'userId'>, schemaOptions: { partial: true, exclude: [ 'id', 'createdAt', 'userId' ] })", "properties": { "name": { "type": "string" }, "sheets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "data": { "type": "array", "items": { "type": "array", "items": { "type": "object", "additionalProperties": true } } }, "rows": { "type": "number" }, "cols": { "type": "number" }, "columnNames": { "type": "array", "items": { "type": "string" } }, "columnWidths": { "type": "object" }, "rowHeights": { "type": "object" }, "frozenRows": { "type": "number" }, "frozenCols": { "type": "number" } }, "required": [ "id", "name", "data", "rows", "cols" ], "additionalProperties": false } }, "activeSheetId": { "type": "string" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false, "x-typescript-type": "Omit, 'id' | 'createdAt' | 'userId'>" }, "Shippers": { "title": "Shippers", "type": "object", "properties": { "id": { "type": "number" }, "oldShipperId": { "type": "number", "nullable": true }, "name": { "type": "string", "nullable": true }, "shipperQuote": { "type": "string", "nullable": true }, "phone_no": { "type": "string", "nullable": true }, "address": { "type": "string", "nullable": true }, "fax": { "type": "string", "nullable": true }, "zip": { "type": "string", "nullable": true }, "contact_name": { "type": "string", "nullable": true }, "instructions": { "type": "string", "nullable": true }, "insurance_name": { "type": "string", "nullable": true }, "setupType": { "type": "string", "nullable": true }, "shipperType": { "type": "string", "nullable": true }, "FromDate": { "type": "string", "format": "date-time" }, "ToDate": { "type": "string", "format": "date-time" }, "shipper_status": { "type": "number" }, "shipperCommunicationType": { "type": "number" }, "assignTo": { "type": "number" }, "secure_limit": { "type": "number", "nullable": true }, "unsecure_limit": { "type": "number", "nullable": true }, "reApprovalStatus": { "type": "number", "nullable": true }, "insurance_status": { "type": "string", "nullable": true }, "url": { "type": "string", "nullable": true }, "creditApp": { "type": "string", "nullable": true }, "quotationProof": { "type": "string", "nullable": true }, "creditLimitDoc": { "type": "string", "nullable": true }, "insurance_exp_date": { "type": "string", "format": "date-time" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "uid": { "type": "string" }, "oldLimit": { "type": "number", "nullable": true }, "ace_qb_id": { "type": "string", "nullable": true }, "ace_qb_status": { "type": "string", "nullable": true }, "vl_qb_id": { "type": "string", "nullable": true }, "vl_qb_status": { "type": "string", "nullable": true }, "asi_qb_id": { "type": "string", "nullable": true }, "asi_qb_status": { "type": "string", "nullable": true }, "callingType": { "type": "string", "nullable": true }, "userId": { "type": "number" }, "portalId": { "type": "number" }, "equipmentId": { "type": "number" }, "zipCodesId": { "type": "number" }, "shipperContactsId": { "type": "number" }, "allocate_churn_customer": { "type": "number" }, "invoiceSend": { "type": "number" }, "sessional_shipper": { "type": "number" }, "shipperHistoryId": { "type": "number" }, "commoditiesId": { "type": "number" }, "apId": { "type": "number" } }, "required": [ "uid" ], "additionalProperties": false }, "Portal": { "title": "Portal", "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "domain": { "type": "string", "nullable": true }, "company_email": { "type": "string" }, "email": { "type": "string" }, "password": { "type": "string" }, "company_logo": { "type": "string" }, "company_name": { "type": "string" }, "corporate_number": { "type": "string" }, "fax_number": { "type": "string" }, "company_address": { "type": "string" }, "description": { "type": "string", "nullable": true }, "phoneNumber": { "type": "string" }, "mciNumber": { "type": "string" }, "corporate_address": { "type": "string" }, "status": { "type": "number", "description": "0 deactive | 1 active| 2 blocked", "enum": [ 0, 1, 2 ] }, "second_email_login": { "type": "string", "nullable": true }, "potralRoleId": { "type": "number" } }, "required": [ "name", "email", "password", "status" ], "additionalProperties": false }, "WithdrawnShipperCreditLimitHistory": { "title": "WithdrawnShipperCreditLimitHistory", "type": "object", "properties": { "id": { "type": "number" }, "arId": { "type": "number" }, "secureLimit": { "type": "string" }, "unsecureLimit": { "type": "string" }, "oldSecureLimit": { "type": "string" }, "oldUnsecureLimit": { "type": "string" }, "pendingAmount": { "type": "string" }, "withdrawnAmount": { "type": "string" }, "withdrawnDate": { "type": "string", "format": "date-time" }, "mailReminder": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "withdrawnComments": { "type": "string" }, "status": { "type": "string" }, "shippersId": { "type": "number" }, "portalId": { "type": "number" } }, "required": [ "arId", "mailReminder" ], "additionalProperties": false }, "User": { "title": "User", "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "first_name": { "type": "string", "nullable": true }, "last_name": { "type": "string", "nullable": true }, "real_name": { "type": "string", "nullable": true }, "phone": { "type": "string", "nullable": true }, "ext": { "type": "string", "nullable": true }, "fax": { "type": "string", "nullable": true }, "avatar": { "type": "string", "nullable": true }, "status": { "type": "number", "enum": [ 0, 1, 2 ] }, "optNumber": { "type": "string", "nullable": true }, "twoFactor": { "type": "number", "enum": [ 0, 1 ] }, "arTypeUser": { "type": "number", "enum": [ 0, 1 ] }, "email_verified_at": { "type": "string", "format": "date-time" }, "email": { "type": "string" }, "AccEmail": { "type": "string", "nullable": true }, "password": { "type": "string" }, "realPassword": { "type": "string" }, "created": { "type": "string", "format": "date-time" }, "modified": { "type": "string", "format": "date-time" }, "realm": { "type": "string", "nullable": true }, "username": { "type": "string", "nullable": true }, "emailVerified": { "type": "boolean" }, "verificationToken": { "type": "boolean" }, "type": { "type": "number" }, "drayage": { "type": "boolean" }, "s_gross": { "type": "number" }, "BrokerPolicyDate": { "type": "string", "format": "date-time" }, "brokerIncentivePolicy": { "type": "number", "enum": [ 0, 1 ] }, "vl_user": { "type": "string", "nullable": true }, "vl_phone": { "type": "string", "nullable": true }, "vl_fax": { "type": "string", "nullable": true }, "vl_ext": { "type": "string", "nullable": true }, "bulkEmailAccess": { "type": "string", "nullable": true }, "onboardingDate": { "type": "string", "format": "date-time" }, "lobType": { "type": "number" }, "attrite": { "type": "number" }, "pipType": { "type": "number" }, "vonage_ext": { "type": "number", "nullable": true }, "aliance_ext": { "type": "number", "nullable": true }, "dids_number": { "type": "string", "nullable": true }, "apId": { "type": "number" }, "employeeId": { "type": "string", "nullable": true }, "socketId": { "type": "string" }, "roleId": { "type": "number" }, "portalId": { "type": "number" } }, "required": [ "name", "status", "twoFactor", "arTypeUser", "email", "password", "type", "brokerIncentivePolicy" ], "additionalProperties": false }, "Shipment": { "title": "Shipment", "type": "object", "properties": { "id": { "type": "number" }, "shipmentNo": { "type": "number" }, "uid": { "type": "string" }, "status": { "type": "number" }, "tonuStatus": { "type": "number" }, "loadNo": { "type": "string" }, "containerNo": { "type": "string" }, "loadType": { "type": "string" }, "cdlNumber": { "type": "string", "nullable": true }, "vinNumber": { "type": "string", "nullable": true }, "pickupPhone": { "type": "string", "nullable": true }, "brokerSelfConfirmation": { "type": "string", "nullable": true }, "mc": { "type": "string", "nullable": true }, "dot": { "type": "string", "nullable": true }, "nsc": { "type": "string", "nullable": true }, "ar_gtg": { "type": "number" }, "ap_gtg": { "type": "number" }, "aone_ff_sync": { "type": "number" }, "cmt": { "type": "boolean" }, "commodityValue": { "type": "number" }, "weight": { "type": "string", "nullable": true }, "mode": { "type": "string" }, "footage": { "type": "string", "nullable": true }, "pallet": { "type": "number", "nullable": true }, "miles": { "type": "number", "nullable": true }, "minTemp": { "type": "string", "nullable": true }, "maxTemp": { "type": "string", "nullable": true }, "precoolTemp": { "type": "string", "nullable": true }, "carrierPayMode": { "type": "number" }, "shipperPayMode": { "type": "number" }, "carrierCommunicationPortalid": { "type": "number" }, "carrierInstrctions": { "type": "string" }, "shipperInstrctions": { "type": "string" }, "carrierPrice": { "type": "number" }, "carrierPriceCad": { "type": "number" }, "shipperPrice": { "type": "number" }, "shipperPriceCad": { "type": "number" }, "carrierPriceType": { "type": "number" }, "shipperPriceType": { "type": "number" }, "carrierUint": { "type": "number", "nullable": true }, "carrierUnitPrice": { "type": "number", "nullable": true }, "ShipperUnit": { "type": "number", "nullable": true }, "shipperUnitPrice": { "type": "number", "nullable": true }, "billingDetail": { "type": "object", "nullable": true }, "auditComment": { "type": "string", "nullable": true }, "VinPickupPhoneComment": { "type": "string", "nullable": true }, "auditCreatedAt": { "type": "string", "format": "date-time" }, "auditVinNumberCreatedAt": { "type": "string", "format": "date-time" }, "ai_commodity_value": { "type": "string", "nullable": true }, "ai_doc_id": { "type": "string", "nullable": true }, "vinEmailStatus": { "type": "number" }, "equipmentId": { "type": "number" }, "commoditiesId": { "type": "number" }, "carriersId": { "type": "number" }, "conversionRateUsd": { "type": "number", "nullable": true }, "conversionRateCsd": { "type": "number", "nullable": true }, "carrierRc": { "type": "boolean", "nullable": true }, "shipperRc": { "type": "boolean", "nullable": true }, "bol": { "type": "boolean", "nullable": true }, "apHold": { "type": "boolean", "nullable": true }, "tonuApproval": { "type": "number" }, "loadCof": { "type": "boolean", "nullable": true }, "reminderStatus": { "type": "boolean", "nullable": true }, "managerId": { "type": "number" }, "teamId": { "type": "number" }, "refPortalId": { "type": "number" }, "holdCarrierAmt": { "type": "boolean", "nullable": true }, "created": { "type": "string", "format": "date-time" }, "modified": { "type": "string", "format": "date-time" }, "verifyCommodity": { "type": "number" }, "verifyCpr": { "type": "number" }, "verifyVinNumber": { "type": "number" }, "verifyPickupPhone": { "type": "number" }, "userId": { "type": "number" }, "portalId": { "type": "number" }, "shippersId": { "type": "number" }, "managerComments": { "type": "string", "nullable": true }, "managerApproveId": { "type": "number" }, "invMarginStatus": { "type": "number" }, "invCommunicationType": { "type": "number" }, "invCommunicationApproveId": { "type": "number" }, "credit_exception": { "type": "number" }, "rateNotFinalizedDrayageStatus": { "type": "number", "nullable": true }, "rateNotFinalizedDrayageComment": { "type": "string", "nullable": true } }, "required": [ "shipmentNo", "uid", "status", "commodityValue", "carrierPayMode", "shipperPayMode", "carrierPrice", "carrierPriceCad", "shipperPrice", "shipperPriceCad", "carrierPriceType", "shipperPriceType" ], "additionalProperties": false }, "UserActionLog": { "title": "UserActionLog", "type": "object", "properties": { "id": { "type": "number" }, "action": { "type": "string" }, "module": { "type": "string" }, "source": { "type": "string" }, "count": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "userId": { "type": "number" } }, "additionalProperties": false }, "UserActionLogWithRelations": { "title": "UserActionLogWithRelations", "type": "object", "description": "(tsType: UserActionLogWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "action": { "type": "string" }, "module": { "type": "string" }, "source": { "type": "string" }, "count": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "userId": { "type": "number" }, "user": { "$ref": "#/components/schemas/UserWithRelations" }, "foreignKey": {} }, "additionalProperties": false, "x-typescript-type": "UserActionLogWithRelations" }, "NewShippersInUser": { "title": "NewShippersInUser", "type": "object", "description": "(tsType: @loopback/repository-json-schema#Optional, 'userId'>, schemaOptions: { title: 'NewShippersInUser', exclude: [ 'id' ], optional: [ 'userId' ] })", "properties": { "oldShipperId": { "type": "number", "nullable": true }, "name": { "type": "string", "nullable": true }, "shipperQuote": { "type": "string", "nullable": true }, "phone_no": { "type": "string", "nullable": true }, "address": { "type": "string", "nullable": true }, "fax": { "type": "string", "nullable": true }, "zip": { "type": "string", "nullable": true }, "contact_name": { "type": "string", "nullable": true }, "instructions": { "type": "string", "nullable": true }, "insurance_name": { "type": "string", "nullable": true }, "setupType": { "type": "string", "nullable": true }, "shipperType": { "type": "string", "nullable": true }, "FromDate": { "type": "string", "format": "date-time" }, "ToDate": { "type": "string", "format": "date-time" }, "shipper_status": { "type": "number" }, "shipperCommunicationType": { "type": "number" }, "assignTo": { "type": "number" }, "secure_limit": { "type": "number", "nullable": true }, "unsecure_limit": { "type": "number", "nullable": true }, "reApprovalStatus": { "type": "number", "nullable": true }, "insurance_status": { "type": "string", "nullable": true }, "url": { "type": "string", "nullable": true }, "creditApp": { "type": "string", "nullable": true }, "quotationProof": { "type": "string", "nullable": true }, "creditLimitDoc": { "type": "string", "nullable": true }, "insurance_exp_date": { "type": "string", "format": "date-time" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "uid": { "type": "string" }, "oldLimit": { "type": "number", "nullable": true }, "ace_qb_id": { "type": "string", "nullable": true }, "ace_qb_status": { "type": "string", "nullable": true }, "vl_qb_id": { "type": "string", "nullable": true }, "vl_qb_status": { "type": "string", "nullable": true }, "asi_qb_id": { "type": "string", "nullable": true }, "asi_qb_status": { "type": "string", "nullable": true }, "callingType": { "type": "string", "nullable": true }, "userId": { "type": "number" }, "portalId": { "type": "number" }, "equipmentId": { "type": "number" }, "zipCodesId": { "type": "number" }, "shipperContactsId": { "type": "number" }, "allocate_churn_customer": { "type": "number" }, "invoiceSend": { "type": "number" }, "sessional_shipper": { "type": "number" }, "shipperHistoryId": { "type": "number" }, "commoditiesId": { "type": "number" }, "apId": { "type": "number" } }, "required": [ "uid" ], "additionalProperties": false, "x-typescript-type": "@loopback/repository-json-schema#Optional, 'userId'>" }, "ShippersPartial": { "title": "ShippersPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number" }, "oldShipperId": { "type": "number", "nullable": true }, "name": { "type": "string", "nullable": true }, "shipperQuote": { "type": "string", "nullable": true }, "phone_no": { "type": "string", "nullable": true }, "address": { "type": "string", "nullable": true }, "fax": { "type": "string", "nullable": true }, "zip": { "type": "string", "nullable": true }, "contact_name": { "type": "string", "nullable": true }, "instructions": { "type": "string", "nullable": true }, "insurance_name": { "type": "string", "nullable": true }, "setupType": { "type": "string", "nullable": true }, "shipperType": { "type": "string", "nullable": true }, "FromDate": { "type": "string", "format": "date-time" }, "ToDate": { "type": "string", "format": "date-time" }, "shipper_status": { "type": "number" }, "shipperCommunicationType": { "type": "number" }, "assignTo": { "type": "number" }, "secure_limit": { "type": "number", "nullable": true }, "unsecure_limit": { "type": "number", "nullable": true }, "reApprovalStatus": { "type": "number", "nullable": true }, "insurance_status": { "type": "string", "nullable": true }, "url": { "type": "string", "nullable": true }, "creditApp": { "type": "string", "nullable": true }, "quotationProof": { "type": "string", "nullable": true }, "creditLimitDoc": { "type": "string", "nullable": true }, "insurance_exp_date": { "type": "string", "format": "date-time" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "uid": { "type": "string" }, "oldLimit": { "type": "number", "nullable": true }, "ace_qb_id": { "type": "string", "nullable": true }, "ace_qb_status": { "type": "string", "nullable": true }, "vl_qb_id": { "type": "string", "nullable": true }, "vl_qb_status": { "type": "string", "nullable": true }, "asi_qb_id": { "type": "string", "nullable": true }, "asi_qb_status": { "type": "string", "nullable": true }, "callingType": { "type": "string", "nullable": true }, "userId": { "type": "number" }, "portalId": { "type": "number" }, "equipmentId": { "type": "number" }, "zipCodesId": { "type": "number" }, "shipperContactsId": { "type": "number" }, "allocate_churn_customer": { "type": "number" }, "invoiceSend": { "type": "number" }, "sessional_shipper": { "type": "number" }, "shipperHistoryId": { "type": "number" }, "commoditiesId": { "type": "number" }, "apId": { "type": "number" } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "Role": { "title": "Role", "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "permissions": { "type": "array", "items": { "type": "string" } }, "role_key": { "type": "number" }, "type": { "type": "number" }, "defaultPermissions": { "type": "array", "items": { "type": "string" } }, "portalId": { "type": "number" } }, "required": [ "name" ], "additionalProperties": false }, "McVerification": { "title": "McVerification", "type": "object", "properties": { "id": { "type": "number" }, "uid": { "type": "string" }, "portalId": { "type": "number" }, "mcCategory": { "type": "string" }, "requestType": { "type": "string" }, "exceptionType": { "type": "string", "nullable": true }, "smeStatus": { "type": "number" }, "mcNumber": { "type": "string", "nullable": true }, "dotNumber": { "type": "string", "nullable": true }, "nscNumber": { "type": "string", "nullable": true }, "mcCarrierSetUp": { "type": "number", "enum": [ 1, 2 ] }, "mcTruckType": { "type": "string" }, "mcApproveNotes": { "type": "string", "maxLength": 2000, "nullable": true }, "approveTime": { "type": "string", "format": "date-time", "nullable": true }, "timeDiffrence": { "type": "number", "nullable": true }, "totalIncentive": { "type": "number", "nullable": true }, "mcSentTime": { "type": "string", "format": "date-time", "nullable": true }, "VerifiedCarrierName": { "type": "string", "nullable": true }, "FmcsaPhoneNumber": { "type": "string", "nullable": true }, "CacciPhoneNumber": { "type": "string", "nullable": true }, "VerifiedCacciEmail": { "type": "string", "nullable": true }, "VerifiedCarrier411Email": { "type": "string", "nullable": true }, "VerifiedCarrierCity": { "type": "string", "nullable": true }, "VerifiedCarrierState": { "type": "string", "nullable": true }, "VerifiedCarrierZip": { "type": "string", "nullable": true }, "VerifiedCarrierCountry": { "type": "string", "nullable": true }, "VerifiedFullAddress": { "type": "string", "nullable": true }, "checkedById": { "type": "number" }, "ReverifyCarrierEmail": { "type": "string", "nullable": true }, "ReverifyCarrierPhoneNumber": { "type": "number", "nullable": true }, "McStatus": { "type": "string", "nullable": true }, "TotalInspections": { "type": "string", "nullable": true }, "InsuranceStatus": { "type": "string", "nullable": true }, "TotalTrucks": { "type": "string", "nullable": true }, "VictimIdentityTheft": { "type": "string", "nullable": true }, "TotalActiveTime": { "type": "string", "nullable": true }, "comment": {}, "userId": { "type": "number" }, "ApprovedBySmeId": { "type": "number" } }, "required": [ "uid", "portalId", "mcCategory", "requestType", "smeStatus", "mcCarrierSetUp", "mcTruckType" ], "additionalProperties": false }, "NewMcVerificationInUser": { "title": "NewMcVerificationInUser", "type": "object", "description": "(tsType: @loopback/repository-json-schema#Optional, 'ApprovedBySmeId'>, schemaOptions: { title: 'NewMcVerificationInUser', exclude: [ 'id' ], optional: [ 'ApprovedBySmeId' ] })", "properties": { "uid": { "type": "string" }, "portalId": { "type": "number" }, "mcCategory": { "type": "string" }, "requestType": { "type": "string" }, "exceptionType": { "type": "string", "nullable": true }, "smeStatus": { "type": "number" }, "mcNumber": { "type": "string", "nullable": true }, "dotNumber": { "type": "string", "nullable": true }, "nscNumber": { "type": "string", "nullable": true }, "mcCarrierSetUp": { "type": "number", "enum": [ 1, 2 ] }, "mcTruckType": { "type": "string" }, "mcApproveNotes": { "type": "string", "maxLength": 2000, "nullable": true }, "approveTime": { "type": "string", "format": "date-time", "nullable": true }, "timeDiffrence": { "type": "number", "nullable": true }, "totalIncentive": { "type": "number", "nullable": true }, "mcSentTime": { "type": "string", "format": "date-time", "nullable": true }, "VerifiedCarrierName": { "type": "string", "nullable": true }, "FmcsaPhoneNumber": { "type": "string", "nullable": true }, "CacciPhoneNumber": { "type": "string", "nullable": true }, "VerifiedCacciEmail": { "type": "string", "nullable": true }, "VerifiedCarrier411Email": { "type": "string", "nullable": true }, "VerifiedCarrierCity": { "type": "string", "nullable": true }, "VerifiedCarrierState": { "type": "string", "nullable": true }, "VerifiedCarrierZip": { "type": "string", "nullable": true }, "VerifiedCarrierCountry": { "type": "string", "nullable": true }, "VerifiedFullAddress": { "type": "string", "nullable": true }, "checkedById": { "type": "number" }, "ReverifyCarrierEmail": { "type": "string", "nullable": true }, "ReverifyCarrierPhoneNumber": { "type": "number", "nullable": true }, "McStatus": { "type": "string", "nullable": true }, "TotalInspections": { "type": "string", "nullable": true }, "InsuranceStatus": { "type": "string", "nullable": true }, "TotalTrucks": { "type": "string", "nullable": true }, "VictimIdentityTheft": { "type": "string", "nullable": true }, "TotalActiveTime": { "type": "string", "nullable": true }, "comment": {}, "userId": { "type": "number" }, "ApprovedBySmeId": { "type": "number" } }, "required": [ "uid", "portalId", "mcCategory", "requestType", "smeStatus", "mcCarrierSetUp", "mcTruckType" ], "additionalProperties": false, "x-typescript-type": "@loopback/repository-json-schema#Optional, 'ApprovedBySmeId'>" }, "McVerificationPartial": { "title": "McVerificationPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number" }, "uid": { "type": "string" }, "portalId": { "type": "number" }, "mcCategory": { "type": "string" }, "requestType": { "type": "string" }, "exceptionType": { "type": "string", "nullable": true }, "smeStatus": { "type": "number" }, "mcNumber": { "type": "string", "nullable": true }, "dotNumber": { "type": "string", "nullable": true }, "nscNumber": { "type": "string", "nullable": true }, "mcCarrierSetUp": { "type": "number", "enum": [ 1, 2 ] }, "mcTruckType": { "type": "string" }, "mcApproveNotes": { "type": "string", "maxLength": 2000, "nullable": true }, "approveTime": { "type": "string", "format": "date-time", "nullable": true }, "timeDiffrence": { "type": "number", "nullable": true }, "totalIncentive": { "type": "number", "nullable": true }, "mcSentTime": { "type": "string", "format": "date-time", "nullable": true }, "VerifiedCarrierName": { "type": "string", "nullable": true }, "FmcsaPhoneNumber": { "type": "string", "nullable": true }, "CacciPhoneNumber": { "type": "string", "nullable": true }, "VerifiedCacciEmail": { "type": "string", "nullable": true }, "VerifiedCarrier411Email": { "type": "string", "nullable": true }, "VerifiedCarrierCity": { "type": "string", "nullable": true }, "VerifiedCarrierState": { "type": "string", "nullable": true }, "VerifiedCarrierZip": { "type": "string", "nullable": true }, "VerifiedCarrierCountry": { "type": "string", "nullable": true }, "VerifiedFullAddress": { "type": "string", "nullable": true }, "checkedById": { "type": "number" }, "ReverifyCarrierEmail": { "type": "string", "nullable": true }, "ReverifyCarrierPhoneNumber": { "type": "number", "nullable": true }, "McStatus": { "type": "string", "nullable": true }, "TotalInspections": { "type": "string", "nullable": true }, "InsuranceStatus": { "type": "string", "nullable": true }, "TotalTrucks": { "type": "string", "nullable": true }, "VictimIdentityTheft": { "type": "string", "nullable": true }, "TotalActiveTime": { "type": "string", "nullable": true }, "comment": {}, "userId": { "type": "number" }, "ApprovedBySmeId": { "type": "number" } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "UserGroupWithRelations": { "title": "UserGroupWithRelations", "type": "object", "description": "(tsType: UserGroupWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "group_name": { "type": "string" }, "description": { "type": "string" }, "status": { "type": "string" }, "file_url": { "type": "string" }, "userId": { "type": "number" }, "created": { "type": "string", "format": "date-time" }, "updated": { "type": "string", "format": "date-time" } }, "additionalProperties": false, "x-typescript-type": "UserGroupWithRelations" }, "UserGroup": { "title": "UserGroup", "type": "object", "description": "(tsType: UserGroup, schemaOptions: { includeRelations: false })", "properties": { "id": { "type": "number" }, "group_name": { "type": "string" }, "description": { "type": "string" }, "status": { "type": "string" }, "file_url": { "type": "string" }, "userId": { "type": "number" }, "created": { "type": "string", "format": "date-time" }, "updated": { "type": "string", "format": "date-time" } }, "additionalProperties": false, "x-typescript-type": "UserGroup" }, "CprRequest": { "title": "CprRequest", "type": "object", "properties": { "id": { "type": "number" }, "uid": { "type": "string" }, "status": { "type": "number" }, "reApprovalStatus": { "type": "number" }, "sendDate": { "type": "string", "format": "date-time" }, "approvedDate": { "type": "string", "format": "date-time" }, "mc": { "type": "string", "nullable": true }, "checkedById": { "type": "number" }, "dot": { "type": "string", "nullable": true }, "marginStatus": { "type": "number" }, "portalId": { "type": "number" }, "nsc": { "type": "string", "nullable": true }, "timeDiffrence": { "type": "number", "nullable": true }, "totalIncentive": { "type": "number", "nullable": true }, "signeDocumentID": { "type": "string", "nullable": true }, "emailViewed": { "type": "number", "nullable": true }, "docViewed": { "type": "number", "nullable": true }, "secondApprovedBySmeId": { "type": "number" }, "secondCheckedBySmeId": { "type": "number" }, "signedOn": { "type": "string", "format": "date-time" }, "emailStatus": { "type": "number" }, "etaEmailStatus": { "type": "number" }, "documentSigned": { "type": "number", "nullable": true }, "userId": { "type": "number" }, "carrierId": { "type": "number" }, "shipmentId": { "type": "number" }, "ApprovedBySmsId": { "type": "number" }, "managerComments": { "type": "string", "nullable": true }, "approvalType": { "type": "string", "nullable": true }, "cprDoneFor": { "type": "string", "nullable": true }, "spokesTo": { "type": "string", "nullable": true }, "insuranceDocuments": { "type": "string", "nullable": true }, "cacciDocuments": { "type": "string", "nullable": true }, "managerApproveId": { "type": "number" }, "callStatus": { "type": "number" }, "mcNotesCall": { "type": "string", "maxLength": 5000, "nullable": true }, "pickupPhoneVerified": { "type": "number" }, "loadMatchComments": { "type": "string", "nullable": true } }, "required": [ "uid" ], "additionalProperties": false }, "NewCprRequestInUser": { "title": "NewCprRequestInUser", "type": "object", "description": "(tsType: @loopback/repository-json-schema#Optional, 'ApprovedBySmsId'>, schemaOptions: { title: 'NewCprRequestInUser', exclude: [ 'id' ], optional: [ 'ApprovedBySmsId' ] })", "properties": { "uid": { "type": "string" }, "status": { "type": "number" }, "reApprovalStatus": { "type": "number" }, "sendDate": { "type": "string", "format": "date-time" }, "approvedDate": { "type": "string", "format": "date-time" }, "mc": { "type": "string", "nullable": true }, "checkedById": { "type": "number" }, "dot": { "type": "string", "nullable": true }, "marginStatus": { "type": "number" }, "portalId": { "type": "number" }, "nsc": { "type": "string", "nullable": true }, "timeDiffrence": { "type": "number", "nullable": true }, "totalIncentive": { "type": "number", "nullable": true }, "signeDocumentID": { "type": "string", "nullable": true }, "emailViewed": { "type": "number", "nullable": true }, "docViewed": { "type": "number", "nullable": true }, "secondApprovedBySmeId": { "type": "number" }, "secondCheckedBySmeId": { "type": "number" }, "signedOn": { "type": "string", "format": "date-time" }, "emailStatus": { "type": "number" }, "etaEmailStatus": { "type": "number" }, "documentSigned": { "type": "number", "nullable": true }, "userId": { "type": "number" }, "carrierId": { "type": "number" }, "shipmentId": { "type": "number" }, "ApprovedBySmsId": { "type": "number" }, "managerComments": { "type": "string", "nullable": true }, "approvalType": { "type": "string", "nullable": true }, "cprDoneFor": { "type": "string", "nullable": true }, "spokesTo": { "type": "string", "nullable": true }, "insuranceDocuments": { "type": "string", "nullable": true }, "cacciDocuments": { "type": "string", "nullable": true }, "managerApproveId": { "type": "number" }, "callStatus": { "type": "number" }, "mcNotesCall": { "type": "string", "maxLength": 5000, "nullable": true }, "pickupPhoneVerified": { "type": "number" }, "loadMatchComments": { "type": "string", "nullable": true } }, "required": [ "uid" ], "additionalProperties": false, "x-typescript-type": "@loopback/repository-json-schema#Optional, 'ApprovedBySmsId'>" }, "CprRequestPartial": { "title": "CprRequestPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number" }, "uid": { "type": "string" }, "status": { "type": "number" }, "reApprovalStatus": { "type": "number" }, "sendDate": { "type": "string", "format": "date-time" }, "approvedDate": { "type": "string", "format": "date-time" }, "mc": { "type": "string", "nullable": true }, "checkedById": { "type": "number" }, "dot": { "type": "string", "nullable": true }, "marginStatus": { "type": "number" }, "portalId": { "type": "number" }, "nsc": { "type": "string", "nullable": true }, "timeDiffrence": { "type": "number", "nullable": true }, "totalIncentive": { "type": "number", "nullable": true }, "signeDocumentID": { "type": "string", "nullable": true }, "emailViewed": { "type": "number", "nullable": true }, "docViewed": { "type": "number", "nullable": true }, "secondApprovedBySmeId": { "type": "number" }, "secondCheckedBySmeId": { "type": "number" }, "signedOn": { "type": "string", "format": "date-time" }, "emailStatus": { "type": "number" }, "etaEmailStatus": { "type": "number" }, "documentSigned": { "type": "number", "nullable": true }, "userId": { "type": "number" }, "carrierId": { "type": "number" }, "shipmentId": { "type": "number" }, "ApprovedBySmsId": { "type": "number" }, "managerComments": { "type": "string", "nullable": true }, "approvalType": { "type": "string", "nullable": true }, "cprDoneFor": { "type": "string", "nullable": true }, "spokesTo": { "type": "string", "nullable": true }, "insuranceDocuments": { "type": "string", "nullable": true }, "cacciDocuments": { "type": "string", "nullable": true }, "managerApproveId": { "type": "number" }, "callStatus": { "type": "number" }, "mcNotesCall": { "type": "string", "maxLength": 5000, "nullable": true }, "pickupPhoneVerified": { "type": "number" }, "loadMatchComments": { "type": "string", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "CarrierPayment": { "title": "CarrierPayment", "type": "object", "properties": { "id": { "type": "number" }, "agingDate": { "type": "string", "format": "date-time" }, "paymentInitiated": { "type": "string", "format": "date-time", "nullable": true }, "attachment": { "type": "string" }, "notes": { "type": "string", "nullable": true }, "paymentStatus": { "type": "number" }, "brokerName": { "type": "string", "nullable": true }, "qpStatus": { "type": "number" }, "amountUsd": { "type": "number" }, "amountCad": { "type": "number" }, "paymentType": { "type": "number" }, "paymentMethod": { "type": "string" }, "payTo": { "type": "number" }, "subject": { "type": "string", "nullable": true }, "message": { "type": "string", "nullable": true }, "qb_id": { "type": "string" }, "qb_status": { "type": "number" }, "doc_number": { "type": "string" }, "VlAsiDocNumber": { "type": "string" }, "oldPaymentDate": { "type": "string", "format": "date-time", "nullable": true }, "shipmentId": { "type": "number" }, "carriersId": { "type": "number" }, "userId": { "type": "number" }, "apId": { "type": "number" }, "portalId": { "type": "number" }, "carrierAgingId": { "type": "number" } }, "additionalProperties": false }, "NewCarrierPaymentInUser": { "title": "NewCarrierPaymentInUser", "type": "object", "description": "(tsType: @loopback/repository-json-schema#Optional, 'apId'>, schemaOptions: { title: 'NewCarrierPaymentInUser', exclude: [ 'id' ], optional: [ 'apId' ] })", "properties": { "agingDate": { "type": "string", "format": "date-time" }, "paymentInitiated": { "type": "string", "format": "date-time", "nullable": true }, "attachment": { "type": "string" }, "notes": { "type": "string", "nullable": true }, "paymentStatus": { "type": "number" }, "brokerName": { "type": "string", "nullable": true }, "qpStatus": { "type": "number" }, "amountUsd": { "type": "number" }, "amountCad": { "type": "number" }, "paymentType": { "type": "number" }, "paymentMethod": { "type": "string" }, "payTo": { "type": "number" }, "subject": { "type": "string", "nullable": true }, "message": { "type": "string", "nullable": true }, "qb_id": { "type": "string" }, "qb_status": { "type": "number" }, "doc_number": { "type": "string" }, "VlAsiDocNumber": { "type": "string" }, "oldPaymentDate": { "type": "string", "format": "date-time", "nullable": true }, "shipmentId": { "type": "number" }, "carriersId": { "type": "number" }, "userId": { "type": "number" }, "apId": { "type": "number" }, "portalId": { "type": "number" }, "carrierAgingId": { "type": "number" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository-json-schema#Optional, 'apId'>" }, "CarrierPaymentPartial": { "title": "CarrierPaymentPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number" }, "agingDate": { "type": "string", "format": "date-time" }, "paymentInitiated": { "type": "string", "format": "date-time", "nullable": true }, "attachment": { "type": "string" }, "notes": { "type": "string", "nullable": true }, "paymentStatus": { "type": "number" }, "brokerName": { "type": "string", "nullable": true }, "qpStatus": { "type": "number" }, "amountUsd": { "type": "number" }, "amountCad": { "type": "number" }, "paymentType": { "type": "number" }, "paymentMethod": { "type": "string" }, "payTo": { "type": "number" }, "subject": { "type": "string", "nullable": true }, "message": { "type": "string", "nullable": true }, "qb_id": { "type": "string" }, "qb_status": { "type": "number" }, "doc_number": { "type": "string" }, "VlAsiDocNumber": { "type": "string" }, "oldPaymentDate": { "type": "string", "format": "date-time", "nullable": true }, "shipmentId": { "type": "number" }, "carriersId": { "type": "number" }, "userId": { "type": "number" }, "apId": { "type": "number" }, "portalId": { "type": "number" }, "carrierAgingId": { "type": "number" } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "CarrierPaymentDone": { "title": "CarrierPaymentDone", "type": "object", "properties": { "id": { "type": "number" }, "carrier_id": { "type": "number" }, "shipmentNo": { "type": "number" }, "carrier_name": { "type": "string" }, "portal_id": { "type": "number" }, "age_date": { "type": "string", "format": "date-time" }, "invoice_number": { "type": "number" }, "invoice_date": { "type": "string", "format": "date-time" }, "advance_payment_date": { "type": "string", "format": "date-time" }, "advance_pay_usd": { "type": "number" }, "advance_pay_cad": { "type": "number" }, "advance_pay_type": { "type": "string" }, "payable_amount_usd": { "type": "number" }, "payable_amount_cad": { "type": "number" }, "quick_book_invoice_status": { "type": "number" }, "quick_book_invoice_date": { "type": "string", "format": "date-time" }, "status": { "type": "number", "enum": [ 0, 1, 2, 3 ] }, "agent_name": { "type": "string" }, "quick_pay": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "shipmentId": { "type": "number" }, "carriersId": { "type": "number" }, "userId": { "type": "number" } }, "required": [ "status" ], "additionalProperties": false }, "NewCarrierPaymentDoneInUser": { "title": "NewCarrierPaymentDoneInUser", "type": "object", "description": "(tsType: @loopback/repository-json-schema#Optional, 'userId'>, schemaOptions: { title: 'NewCarrierPaymentDoneInUser', exclude: [ 'id' ], optional: [ 'userId' ] })", "properties": { "carrier_id": { "type": "number" }, "shipmentNo": { "type": "number" }, "carrier_name": { "type": "string" }, "portal_id": { "type": "number" }, "age_date": { "type": "string", "format": "date-time" }, "invoice_number": { "type": "number" }, "invoice_date": { "type": "string", "format": "date-time" }, "advance_payment_date": { "type": "string", "format": "date-time" }, "advance_pay_usd": { "type": "number" }, "advance_pay_cad": { "type": "number" }, "advance_pay_type": { "type": "string" }, "payable_amount_usd": { "type": "number" }, "payable_amount_cad": { "type": "number" }, "quick_book_invoice_status": { "type": "number" }, "quick_book_invoice_date": { "type": "string", "format": "date-time" }, "status": { "type": "number", "enum": [ 0, 1, 2, 3 ] }, "agent_name": { "type": "string" }, "quick_pay": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "shipmentId": { "type": "number" }, "carriersId": { "type": "number" }, "userId": { "type": "number" } }, "required": [ "status" ], "additionalProperties": false, "x-typescript-type": "@loopback/repository-json-schema#Optional, 'userId'>" }, "CarrierPaymentDonePartial": { "title": "CarrierPaymentDonePartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number" }, "carrier_id": { "type": "number" }, "shipmentNo": { "type": "number" }, "carrier_name": { "type": "string" }, "portal_id": { "type": "number" }, "age_date": { "type": "string", "format": "date-time" }, "invoice_number": { "type": "number" }, "invoice_date": { "type": "string", "format": "date-time" }, "advance_payment_date": { "type": "string", "format": "date-time" }, "advance_pay_usd": { "type": "number" }, "advance_pay_cad": { "type": "number" }, "advance_pay_type": { "type": "string" }, "payable_amount_usd": { "type": "number" }, "payable_amount_cad": { "type": "number" }, "quick_book_invoice_status": { "type": "number" }, "quick_book_invoice_date": { "type": "string", "format": "date-time" }, "status": { "type": "number", "enum": [ 0, 1, 2, 3 ] }, "agent_name": { "type": "string" }, "quick_pay": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "shipmentId": { "type": "number" }, "carriersId": { "type": "number" }, "userId": { "type": "number" } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "ShipmentWithRelations": { "title": "ShipmentWithRelations", "type": "object", "description": "(tsType: ShipmentWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "shipmentNo": { "type": "number" }, "uid": { "type": "string" }, "status": { "type": "number" }, "tonuStatus": { "type": "number" }, "loadNo": { "type": "string" }, "containerNo": { "type": "string" }, "loadType": { "type": "string" }, "cdlNumber": { "type": "string", "nullable": true }, "vinNumber": { "type": "string", "nullable": true }, "pickupPhone": { "type": "string", "nullable": true }, "brokerSelfConfirmation": { "type": "string", "nullable": true }, "mc": { "type": "string", "nullable": true }, "dot": { "type": "string", "nullable": true }, "nsc": { "type": "string", "nullable": true }, "ar_gtg": { "type": "number" }, "ap_gtg": { "type": "number" }, "aone_ff_sync": { "type": "number" }, "cmt": { "type": "boolean" }, "commodityValue": { "type": "number" }, "weight": { "type": "string", "nullable": true }, "mode": { "type": "string" }, "footage": { "type": "string", "nullable": true }, "pallet": { "type": "number", "nullable": true }, "miles": { "type": "number", "nullable": true }, "minTemp": { "type": "string", "nullable": true }, "maxTemp": { "type": "string", "nullable": true }, "precoolTemp": { "type": "string", "nullable": true }, "carrierPayMode": { "type": "number" }, "shipperPayMode": { "type": "number" }, "carrierCommunicationPortalid": { "type": "number" }, "carrierInstrctions": { "type": "string" }, "shipperInstrctions": { "type": "string" }, "carrierPrice": { "type": "number" }, "carrierPriceCad": { "type": "number" }, "shipperPrice": { "type": "number" }, "shipperPriceCad": { "type": "number" }, "carrierPriceType": { "type": "number" }, "shipperPriceType": { "type": "number" }, "carrierUint": { "type": "number", "nullable": true }, "carrierUnitPrice": { "type": "number", "nullable": true }, "ShipperUnit": { "type": "number", "nullable": true }, "shipperUnitPrice": { "type": "number", "nullable": true }, "billingDetail": { "type": "object", "nullable": true }, "auditComment": { "type": "string", "nullable": true }, "VinPickupPhoneComment": { "type": "string", "nullable": true }, "auditCreatedAt": { "type": "string", "format": "date-time" }, "auditVinNumberCreatedAt": { "type": "string", "format": "date-time" }, "ai_commodity_value": { "type": "string", "nullable": true }, "ai_doc_id": { "type": "string", "nullable": true }, "vinEmailStatus": { "type": "number" }, "equipmentId": { "type": "number" }, "commoditiesId": { "type": "number" }, "carriersId": { "type": "number" }, "conversionRateUsd": { "type": "number", "nullable": true }, "conversionRateCsd": { "type": "number", "nullable": true }, "carrierRc": { "type": "boolean", "nullable": true }, "shipperRc": { "type": "boolean", "nullable": true }, "bol": { "type": "boolean", "nullable": true }, "apHold": { "type": "boolean", "nullable": true }, "tonuApproval": { "type": "number" }, "loadCof": { "type": "boolean", "nullable": true }, "reminderStatus": { "type": "boolean", "nullable": true }, "managerId": { "type": "number" }, "teamId": { "type": "number" }, "refPortalId": { "type": "number" }, "holdCarrierAmt": { "type": "boolean", "nullable": true }, "created": { "type": "string", "format": "date-time" }, "modified": { "type": "string", "format": "date-time" }, "verifyCommodity": { "type": "number" }, "verifyCpr": { "type": "number" }, "verifyVinNumber": { "type": "number" }, "verifyPickupPhone": { "type": "number" }, "userId": { "type": "number" }, "portalId": { "type": "number" }, "shippersId": { "type": "number" }, "managerComments": { "type": "string", "nullable": true }, "managerApproveId": { "type": "number" }, "invMarginStatus": { "type": "number" }, "invCommunicationType": { "type": "number" }, "invCommunicationApproveId": { "type": "number" }, "credit_exception": { "type": "number" }, "rateNotFinalizedDrayageStatus": { "type": "number", "nullable": true }, "rateNotFinalizedDrayageComment": { "type": "string", "nullable": true }, "equipment": { "$ref": "#/components/schemas/EquipmentWithRelations" }, "foreignKey": {}, "commodities": { "$ref": "#/components/schemas/CommoditiesWithRelations" }, "shipmentDocs": { "type": "array", "items": { "$ref": "#/components/schemas/ShipmentDocsWithRelations" } }, "carriers": { "$ref": "#/components/schemas/CarriersWithRelations" }, "shipmentCarrier": { "$ref": "#/components/schemas/ShipmentCarrierWithRelations" }, "shipmentTimelines": { "type": "array", "items": { "$ref": "#/components/schemas/ShipmentTimelineWithRelations" } }, "cprRequest": { "$ref": "#/components/schemas/CprRequestWithRelations" }, "gtgHistory": { "type": "array", "items": { "$ref": "#/components/schemas/GtgHistoryWithRelations" } }, "mcReVerification": { "$ref": "#/components/schemas/McReVerificationWithRelations" }, "carrierAgings": { "type": "array", "items": { "$ref": "#/components/schemas/CarrierAgingWithRelations" } }, "carrierAging": { "$ref": "#/components/schemas/CarrierAgingWithRelations" }, "carrierPayment": { "$ref": "#/components/schemas/CarrierPaymentWithRelations" }, "manager": { "$ref": "#/components/schemas/UserWithRelations" }, "team": { "$ref": "#/components/schemas/UserWithRelations" }, "signDoc": { "$ref": "#/components/schemas/SignDocWithRelations" }, "refPortal": { "$ref": "#/components/schemas/PortalWithRelations" }, "user": { "$ref": "#/components/schemas/UserWithRelations" }, "apIncentive": { "$ref": "#/components/schemas/ApIncentiveWithRelations" }, "invoices": { "$ref": "#/components/schemas/InvoicesWithRelations" }, "portal": { "$ref": "#/components/schemas/PortalWithRelations" }, "shipmentPrices": { "type": "array", "items": { "$ref": "#/components/schemas/ShipmentPriceWithRelations" } }, "shipmentPicks": { "type": "array", "items": { "$ref": "#/components/schemas/ShipmentPicksWithRelations" } }, "shipmentDrops": { "type": "array", "items": { "$ref": "#/components/schemas/ShipmentDropsWithRelations" } }, "shipmentDetails": { "$ref": "#/components/schemas/ShipmentDetailsWithRelations" }, "auditVerifyCprs": { "type": "array", "items": { "$ref": "#/components/schemas/AuditVerifyCprWithRelations" } }, "auditVerifyCommodities": { "type": "array", "items": { "$ref": "#/components/schemas/AuditVerifyCommodityWithRelations" } }, "carrierConfirmDelivery": { "$ref": "#/components/schemas/CarrierConfirmDeliveryWithRelations" }, "shippers": { "$ref": "#/components/schemas/ShippersWithRelations" } }, "required": [ "shipmentNo", "uid", "status", "commodityValue", "carrierPayMode", "shipperPayMode", "carrierPrice", "carrierPriceCad", "shipperPrice", "shipperPriceCad", "carrierPriceType", "shipperPriceType" ], "additionalProperties": false, "x-typescript-type": "ShipmentWithRelations" }, "TruckStopsKey": { "title": "TruckStopsKey", "type": "object", "properties": { "id": { "type": "number" }, "email": { "type": "string", "nullable": true }, "password": { "type": "string", "nullable": true }, "primary_token": { "type": "string" }, "secondary_token": { "type": "string" }, "portalId": { "type": "number" }, "dta": { "type": "number" }, "token_type": { "type": "number" }, "status": { "type": "number" }, "managerId": { "type": "number" } }, "required": [ "primary_token", "secondary_token", "dta", "token_type", "status" ], "additionalProperties": false }, "NewTruckStopsKey": { "title": "NewTruckStopsKey", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewTruckStopsKey', exclude: [ 'id' ] })", "properties": { "email": { "type": "string", "nullable": true }, "password": { "type": "string", "nullable": true }, "primary_token": { "type": "string" }, "secondary_token": { "type": "string" }, "portalId": { "type": "number" }, "dta": { "type": "number" }, "token_type": { "type": "number" }, "status": { "type": "number" }, "managerId": { "type": "number" } }, "required": [ "primary_token", "secondary_token", "dta", "token_type", "status" ], "additionalProperties": false, "x-typescript-type": "Omit" }, "TruckStopsKeyWithRelations": { "title": "TruckStopsKeyWithRelations", "type": "object", "description": "(tsType: TruckStopsKeyWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "email": { "type": "string", "nullable": true }, "password": { "type": "string", "nullable": true }, "primary_token": { "type": "string" }, "secondary_token": { "type": "string" }, "portalId": { "type": "number" }, "dta": { "type": "number" }, "token_type": { "type": "number" }, "status": { "type": "number" }, "managerId": { "type": "number" } }, "required": [ "primary_token", "secondary_token", "dta", "token_type", "status" ], "additionalProperties": false, "x-typescript-type": "TruckStopsKeyWithRelations" }, "TruckStopsKeyPartial": { "title": "TruckStopsKeyPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number" }, "email": { "type": "string", "nullable": true }, "password": { "type": "string", "nullable": true }, "primary_token": { "type": "string" }, "secondary_token": { "type": "string" }, "portalId": { "type": "number" }, "dta": { "type": "number" }, "token_type": { "type": "number" }, "status": { "type": "number" }, "managerId": { "type": "number" } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "ThirdPartyUsers": { "title": "ThirdPartyUsers", "type": "object", "properties": { "id": { "type": "number" }, "keyId": { "type": "number" }, "userName": { "type": "string" }, "realUserName": { "type": "string" }, "realPassword": { "type": "string" }, "userType": { "type": "string" }, "portalId": { "type": "number" }, "dat_header": { "type": "string" } }, "required": [ "keyId", "portalId", "dat_header" ], "additionalProperties": false }, "NewThirdPartyUsers": { "title": "NewThirdPartyUsers", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewThirdPartyUsers', exclude: [ 'id' ] })", "properties": { "keyId": { "type": "number" }, "userName": { "type": "string" }, "realUserName": { "type": "string" }, "realPassword": { "type": "string" }, "userType": { "type": "string" }, "portalId": { "type": "number" }, "dat_header": { "type": "string" } }, "required": [ "keyId", "portalId", "dat_header" ], "additionalProperties": false, "x-typescript-type": "Omit" }, "ThirdPartyUsersWithRelations": { "title": "ThirdPartyUsersWithRelations", "type": "object", "description": "(tsType: ThirdPartyUsersWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "keyId": { "type": "number" }, "userName": { "type": "string" }, "realUserName": { "type": "string" }, "realPassword": { "type": "string" }, "userType": { "type": "string" }, "portalId": { "type": "number" }, "dat_header": { "type": "string" } }, "required": [ "keyId", "portalId", "dat_header" ], "additionalProperties": false, "x-typescript-type": "ThirdPartyUsersWithRelations" }, "ThirdPartyUsersPartial": { "title": "ThirdPartyUsersPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number" }, "keyId": { "type": "number" }, "userName": { "type": "string" }, "realUserName": { "type": "string" }, "realPassword": { "type": "string" }, "userType": { "type": "string" }, "portalId": { "type": "number" }, "dat_header": { "type": "string" } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "Cities": { "title": "Cities", "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "state_code": { "type": "string" }, "country_code": { "type": "string" }, "latitude": { "type": "string" }, "longitude": { "type": "string" }, "updated_at": { "type": "string", "format": "date-time" }, "created_at": { "type": "string", "format": "date-time" }, "flag": { "type": "number" }, "wikiDataId": { "type": "string" }, "statesId": { "type": "number" }, "countriesId": { "type": "number" } }, "required": [ "name" ], "additionalProperties": false }, "NewCitiesInStates": { "title": "NewCitiesInStates", "type": "object", "description": "(tsType: @loopback/repository-json-schema#Optional, 'statesId'>, schemaOptions: { title: 'NewCitiesInStates', exclude: [ 'id' ], optional: [ 'statesId' ] })", "properties": { "name": { "type": "string" }, "state_code": { "type": "string" }, "country_code": { "type": "string" }, "latitude": { "type": "string" }, "longitude": { "type": "string" }, "updated_at": { "type": "string", "format": "date-time" }, "created_at": { "type": "string", "format": "date-time" }, "flag": { "type": "number" }, "wikiDataId": { "type": "string" }, "statesId": { "type": "number" }, "countriesId": { "type": "number" } }, "required": [ "name" ], "additionalProperties": false, "x-typescript-type": "@loopback/repository-json-schema#Optional, 'statesId'>" }, "CitiesPartial": { "title": "CitiesPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "state_code": { "type": "string" }, "country_code": { "type": "string" }, "latitude": { "type": "string" }, "longitude": { "type": "string" }, "updated_at": { "type": "string", "format": "date-time" }, "created_at": { "type": "string", "format": "date-time" }, "flag": { "type": "number" }, "wikiDataId": { "type": "string" }, "statesId": { "type": "number" }, "countriesId": { "type": "number" } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "McVerificationWithRelations": { "title": "McVerificationWithRelations", "type": "object", "description": "(tsType: McVerificationWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "uid": { "type": "string" }, "portalId": { "type": "number" }, "mcCategory": { "type": "string" }, "requestType": { "type": "string" }, "exceptionType": { "type": "string", "nullable": true }, "smeStatus": { "type": "number" }, "mcNumber": { "type": "string", "nullable": true }, "dotNumber": { "type": "string", "nullable": true }, "nscNumber": { "type": "string", "nullable": true }, "mcCarrierSetUp": { "type": "number", "enum": [ 1, 2 ] }, "mcTruckType": { "type": "string" }, "mcApproveNotes": { "type": "string", "maxLength": 2000, "nullable": true }, "approveTime": { "type": "string", "format": "date-time", "nullable": true }, "timeDiffrence": { "type": "number", "nullable": true }, "totalIncentive": { "type": "number", "nullable": true }, "mcSentTime": { "type": "string", "format": "date-time", "nullable": true }, "VerifiedCarrierName": { "type": "string", "nullable": true }, "FmcsaPhoneNumber": { "type": "string", "nullable": true }, "CacciPhoneNumber": { "type": "string", "nullable": true }, "VerifiedCacciEmail": { "type": "string", "nullable": true }, "VerifiedCarrier411Email": { "type": "string", "nullable": true }, "VerifiedCarrierCity": { "type": "string", "nullable": true }, "VerifiedCarrierState": { "type": "string", "nullable": true }, "VerifiedCarrierZip": { "type": "string", "nullable": true }, "VerifiedCarrierCountry": { "type": "string", "nullable": true }, "VerifiedFullAddress": { "type": "string", "nullable": true }, "checkedById": { "type": "number" }, "ReverifyCarrierEmail": { "type": "string", "nullable": true }, "ReverifyCarrierPhoneNumber": { "type": "number", "nullable": true }, "McStatus": { "type": "string", "nullable": true }, "TotalInspections": { "type": "string", "nullable": true }, "InsuranceStatus": { "type": "string", "nullable": true }, "TotalTrucks": { "type": "string", "nullable": true }, "VictimIdentityTheft": { "type": "string", "nullable": true }, "TotalActiveTime": { "type": "string", "nullable": true }, "comment": {}, "userId": { "type": "number" }, "ApprovedBySmeId": { "type": "number" }, "checkedBy": { "$ref": "#/components/schemas/UserWithRelations" }, "foreignKey": {}, "user": { "$ref": "#/components/schemas/UserWithRelations" }, "ApprovedBySme": { "$ref": "#/components/schemas/UserWithRelations" } }, "required": [ "uid", "portalId", "mcCategory", "requestType", "smeStatus", "mcCarrierSetUp", "mcTruckType" ], "additionalProperties": false, "x-typescript-type": "McVerificationWithRelations" }, "CprRequestWithRelations": { "title": "CprRequestWithRelations", "type": "object", "description": "(tsType: CprRequestWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "uid": { "type": "string" }, "status": { "type": "number" }, "reApprovalStatus": { "type": "number" }, "sendDate": { "type": "string", "format": "date-time" }, "approvedDate": { "type": "string", "format": "date-time" }, "mc": { "type": "string", "nullable": true }, "checkedById": { "type": "number" }, "dot": { "type": "string", "nullable": true }, "marginStatus": { "type": "number" }, "portalId": { "type": "number" }, "nsc": { "type": "string", "nullable": true }, "timeDiffrence": { "type": "number", "nullable": true }, "totalIncentive": { "type": "number", "nullable": true }, "signeDocumentID": { "type": "string", "nullable": true }, "emailViewed": { "type": "number", "nullable": true }, "docViewed": { "type": "number", "nullable": true }, "secondApprovedBySmeId": { "type": "number" }, "secondCheckedBySmeId": { "type": "number" }, "signedOn": { "type": "string", "format": "date-time" }, "emailStatus": { "type": "number" }, "etaEmailStatus": { "type": "number" }, "documentSigned": { "type": "number", "nullable": true }, "userId": { "type": "number" }, "carrierId": { "type": "number" }, "shipmentId": { "type": "number" }, "ApprovedBySmsId": { "type": "number" }, "managerComments": { "type": "string", "nullable": true }, "approvalType": { "type": "string", "nullable": true }, "cprDoneFor": { "type": "string", "nullable": true }, "spokesTo": { "type": "string", "nullable": true }, "insuranceDocuments": { "type": "string", "nullable": true }, "cacciDocuments": { "type": "string", "nullable": true }, "managerApproveId": { "type": "number" }, "callStatus": { "type": "number" }, "mcNotesCall": { "type": "string", "maxLength": 5000, "nullable": true }, "pickupPhoneVerified": { "type": "number" }, "loadMatchComments": { "type": "string", "nullable": true }, "checkedBy": { "$ref": "#/components/schemas/UserWithRelations" }, "foreignKey": {}, "portal": { "$ref": "#/components/schemas/PortalWithRelations" }, "secondApprovedBySme": { "$ref": "#/components/schemas/UserWithRelations" }, "secondCheckedBySme": { "$ref": "#/components/schemas/UserWithRelations" }, "user": { "$ref": "#/components/schemas/UserWithRelations" }, "carrier": { "$ref": "#/components/schemas/CarriersWithRelations" }, "shipment": { "$ref": "#/components/schemas/ShipmentWithRelations" }, "ApprovedBySms": { "$ref": "#/components/schemas/UserWithRelations" } }, "required": [ "uid" ], "additionalProperties": false, "x-typescript-type": "CprRequestWithRelations" }, "SmeMcComments": { "title": "SmeMcComments", "type": "object", "properties": { "id": { "type": "number" }, "portalId": { "type": "number" }, "userId": { "type": "number" }, "mcNumber": { "type": "string" }, "dotNumber": { "type": "string" }, "nscNumber": { "type": "string" }, "mcTruckType": { "type": "string" }, "mcVerificationId": { "type": "number" }, "cprRequestId": { "type": "number" }, "ApprovedBySmsId": { "type": "number" }, "mcApproveNotes": { "type": "string", "maxLength": 2000, "nullable": true }, "loadMatchComments": { "type": "string", "maxLength": 5000, "nullable": true }, "approveTime": { "type": "string", "format": "date-time", "nullable": true }, "smeStatus": { "type": "number" }, "approveBy": { "type": "string" } }, "required": [ "userId", "smeStatus", "approveBy" ], "additionalProperties": false }, "NewSmeMcComments": { "title": "NewSmeMcComments", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewSmeMcComments', exclude: [ 'id', 'userId', 'approveBy' ] })", "properties": { "portalId": { "type": "number" }, "mcNumber": { "type": "string" }, "dotNumber": { "type": "string" }, "nscNumber": { "type": "string" }, "mcTruckType": { "type": "string" }, "mcVerificationId": { "type": "number" }, "cprRequestId": { "type": "number" }, "ApprovedBySmsId": { "type": "number" }, "mcApproveNotes": { "type": "string", "maxLength": 2000, "nullable": true }, "loadMatchComments": { "type": "string", "maxLength": 5000, "nullable": true }, "approveTime": { "type": "string", "format": "date-time", "nullable": true }, "smeStatus": { "type": "number" } }, "required": [ "smeStatus" ], "additionalProperties": false, "x-typescript-type": "Omit" }, "SmeMcCommentsWithRelations": { "title": "SmeMcCommentsWithRelations", "type": "object", "description": "(tsType: SmeMcCommentsWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "portalId": { "type": "number" }, "userId": { "type": "number" }, "mcNumber": { "type": "string" }, "dotNumber": { "type": "string" }, "nscNumber": { "type": "string" }, "mcTruckType": { "type": "string" }, "mcVerificationId": { "type": "number" }, "cprRequestId": { "type": "number" }, "ApprovedBySmsId": { "type": "number" }, "mcApproveNotes": { "type": "string", "maxLength": 2000, "nullable": true }, "loadMatchComments": { "type": "string", "maxLength": 5000, "nullable": true }, "approveTime": { "type": "string", "format": "date-time", "nullable": true }, "smeStatus": { "type": "number" }, "approveBy": { "type": "string" }, "mcVerification": { "$ref": "#/components/schemas/McVerificationWithRelations" }, "foreignKey": {}, "cprRequest": { "$ref": "#/components/schemas/CprRequestWithRelations" }, "ApprovedBySms": { "$ref": "#/components/schemas/UserWithRelations" } }, "required": [ "userId", "smeStatus", "approveBy" ], "additionalProperties": false, "x-typescript-type": "SmeMcCommentsWithRelations" }, "SmeMcCommentsPartial": { "title": "SmeMcCommentsPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number" }, "portalId": { "type": "number" }, "userId": { "type": "number" }, "mcNumber": { "type": "string" }, "dotNumber": { "type": "string" }, "nscNumber": { "type": "string" }, "mcTruckType": { "type": "string" }, "mcVerificationId": { "type": "number" }, "cprRequestId": { "type": "number" }, "ApprovedBySmsId": { "type": "number" }, "mcApproveNotes": { "type": "string", "maxLength": 2000, "nullable": true }, "loadMatchComments": { "type": "string", "maxLength": 5000, "nullable": true }, "approveTime": { "type": "string", "format": "date-time", "nullable": true }, "smeStatus": { "type": "number" }, "approveBy": { "type": "string" } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "SignDoc": { "title": "SignDoc", "type": "object", "properties": { "id": { "type": "number" }, "uid": { "type": "string" }, "document": { "type": "string" }, "signedDoc": { "type": "string" }, "shipmentId": { "type": "number" }, "emailFrom": { "type": "string" }, "emailTo": { "type": "string" }, "docType": { "type": "string" }, "subject": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "number", "enum": [ 0, 1, 2 ] }, "carrierLoginId": { "type": "number" }, "portalId": { "type": "number" }, "container": { "type": "string" }, "readStatus": { "type": "number" }, "created": { "type": "string", "format": "date-time" }, "updated": { "type": "string", "format": "date-time" } }, "required": [ "uid", "document", "status" ], "additionalProperties": false }, "ShippersWithRelations": { "title": "ShippersWithRelations", "type": "object", "description": "(tsType: ShippersWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "oldShipperId": { "type": "number", "nullable": true }, "name": { "type": "string", "nullable": true }, "shipperQuote": { "type": "string", "nullable": true }, "phone_no": { "type": "string", "nullable": true }, "address": { "type": "string", "nullable": true }, "fax": { "type": "string", "nullable": true }, "zip": { "type": "string", "nullable": true }, "contact_name": { "type": "string", "nullable": true }, "instructions": { "type": "string", "nullable": true }, "insurance_name": { "type": "string", "nullable": true }, "setupType": { "type": "string", "nullable": true }, "shipperType": { "type": "string", "nullable": true }, "FromDate": { "type": "string", "format": "date-time" }, "ToDate": { "type": "string", "format": "date-time" }, "shipper_status": { "type": "number" }, "shipperCommunicationType": { "type": "number" }, "assignTo": { "type": "number" }, "secure_limit": { "type": "number", "nullable": true }, "unsecure_limit": { "type": "number", "nullable": true }, "reApprovalStatus": { "type": "number", "nullable": true }, "insurance_status": { "type": "string", "nullable": true }, "url": { "type": "string", "nullable": true }, "creditApp": { "type": "string", "nullable": true }, "quotationProof": { "type": "string", "nullable": true }, "creditLimitDoc": { "type": "string", "nullable": true }, "insurance_exp_date": { "type": "string", "format": "date-time" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "uid": { "type": "string" }, "oldLimit": { "type": "number", "nullable": true }, "ace_qb_id": { "type": "string", "nullable": true }, "ace_qb_status": { "type": "string", "nullable": true }, "vl_qb_id": { "type": "string", "nullable": true }, "vl_qb_status": { "type": "string", "nullable": true }, "asi_qb_id": { "type": "string", "nullable": true }, "asi_qb_status": { "type": "string", "nullable": true }, "callingType": { "type": "string", "nullable": true }, "userId": { "type": "number" }, "portalId": { "type": "number" }, "equipmentId": { "type": "number" }, "zipCodesId": { "type": "number" }, "shipperContactsId": { "type": "number" }, "allocate_churn_customer": { "type": "number" }, "invoiceSend": { "type": "number" }, "sessional_shipper": { "type": "number" }, "shipperHistoryId": { "type": "number" }, "commoditiesId": { "type": "number" }, "apId": { "type": "number" }, "user": { "$ref": "#/components/schemas/UserWithRelations" }, "foreignKey": {}, "portal": { "$ref": "#/components/schemas/PortalWithRelations" }, "equipment": { "$ref": "#/components/schemas/EquipmentWithRelations" }, "zipCodes": { "$ref": "#/components/schemas/ZipCodesWithRelations" }, "shipperContacts": { "type": "array", "items": { "$ref": "#/components/schemas/ShipperContactsWithRelations" } }, "shipperHistory": { "$ref": "#/components/schemas/ShipperHistoryWithRelations" }, "commodities": { "$ref": "#/components/schemas/CommoditiesWithRelations" }, "companiesInsurances": { "type": "array", "items": { "$ref": "#/components/schemas/CompaniesInsuranceWithRelations" } }, "shippersCompaniesInsurances": { "type": "array", "items": { "$ref": "#/components/schemas/ShippersCompaniesInsuranceWithRelations" } }, "shipmentsList": { "type": "array", "items": { "$ref": "#/components/schemas/ShipmentWithRelations" } }, "shippersinvoiceslist": { "type": "array", "items": { "$ref": "#/components/schemas/InvoicesWithRelations" } }, "ap": { "$ref": "#/components/schemas/UserWithRelations" } }, "required": [ "uid" ], "additionalProperties": false, "x-typescript-type": "ShippersWithRelations" }, "ShippersCompaniesInsurance": { "title": "ShippersCompaniesInsurance", "type": "object", "properties": { "id": { "type": "number" }, "shippersId": { "type": "number" }, "companiesInsuranceId": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "NewShippersCompaniesInsuranceInShippers": { "title": "NewShippersCompaniesInsuranceInShippers", "type": "object", "description": "(tsType: @loopback/repository-json-schema#Optional, 'shippersId'>, schemaOptions: { title: 'NewShippersCompaniesInsuranceInShippers', exclude: [ 'id' ], optional: [ 'shippersId' ] })", "properties": { "shippersId": { "type": "number" }, "companiesInsuranceId": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository-json-schema#Optional, 'shippersId'>" }, "ShippersCompaniesInsurancePartial": { "title": "ShippersCompaniesInsurancePartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number" }, "shippersId": { "type": "number" }, "companiesInsuranceId": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "ShipperContacts": { "title": "ShipperContacts", "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "phone": { "type": "string", "nullable": true }, "primary": { "type": "number" }, "send_email": { "type": "number" }, "eta": { "type": "number" }, "email_marketing_status": { "type": "number" }, "shippersId": { "type": "number" } }, "additionalProperties": false }, "NewShipperContactsInShippers": { "title": "NewShipperContactsInShippers", "type": "object", "description": "(tsType: @loopback/repository-json-schema#Optional, 'shippersId'>, schemaOptions: { title: 'NewShipperContactsInShippers', exclude: [ 'id' ], optional: [ 'shippersId' ] })", "properties": { "name": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "phone": { "type": "string", "nullable": true }, "primary": { "type": "number" }, "send_email": { "type": "number" }, "eta": { "type": "number" }, "email_marketing_status": { "type": "number" }, "shippersId": { "type": "number" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository-json-schema#Optional, 'shippersId'>" }, "ShipperContactsPartial": { "title": "ShipperContactsPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number" }, "name": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "phone": { "type": "string", "nullable": true }, "primary": { "type": "number" }, "send_email": { "type": "number" }, "eta": { "type": "number" }, "email_marketing_status": { "type": "number" }, "shippersId": { "type": "number" } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "Invoices": { "title": "Invoices", "type": "object", "properties": { "id": { "type": "number" }, "uid": { "type": "string" }, "shipmentId": { "type": "number" }, "shippersId": { "type": "number" }, "userId": { "type": "number" }, "portalId": { "type": "number" }, "ArUserID": { "type": "number" }, "doc": { "type": "string", "nullable": true }, "invoicePayment": { "type": "number" }, "balance": { "type": "number" }, "paid": { "type": "number", "nullable": true }, "oldInvoiceId": { "type": "number", "nullable": true }, "payStatus": { "type": "number" }, "assignStatus": { "type": "number" }, "status": { "type": "number" }, "collectionStatus": { "type": "number" }, "aceFreight": { "type": "string", "nullable": true }, "assignTo": { "type": "number" }, "comments": { "type": "string", "nullable": true }, "invoiceDate": { "type": "string", "format": "date-time" }, "regenerateDate": { "type": "string", "format": "date-time" }, "regenerateStatus": { "type": "number" }, "emailStatus": { "type": "number" }, "lastReceivedDate": { "type": "string", "format": "date-time" }, "created": { "type": "string", "format": "date-time" }, "payMode": { "type": "string", "nullable": true }, "writeOffType": { "type": "string", "nullable": true }, "calim_received_percentage": { "type": "number", "nullable": true }, "customerInsurance": { "type": "string", "nullable": true }, "qb_status": { "type": "string", "nullable": true }, "qb_doc_number": { "type": "string", "nullable": true }, "oldQb": { "type": "string" }, "aceAsiStatus": { "type": "number" }, "aceAsiQBStatus": { "type": "string", "nullable": true }, "ace_qb_bill_status": { "type": "string" }, "ace_qb_bill_id": { "type": "number" }, "asi_qb_bill_status": { "type": "string" }, "asi_qb_bill_id": { "type": "number" }, "ecapitalPercentage": { "type": "number" } }, "required": [ "uid" ], "additionalProperties": false }, "NewInvoicesInShippers": { "title": "NewInvoicesInShippers", "type": "object", "description": "(tsType: @loopback/repository-json-schema#Optional, 'shippersId'>, schemaOptions: { title: 'NewInvoicesInShippers', exclude: [ 'id' ], optional: [ 'shippersId' ] })", "properties": { "uid": { "type": "string" }, "shipmentId": { "type": "number" }, "shippersId": { "type": "number" }, "userId": { "type": "number" }, "portalId": { "type": "number" }, "ArUserID": { "type": "number" }, "doc": { "type": "string", "nullable": true }, "invoicePayment": { "type": "number" }, "balance": { "type": "number" }, "paid": { "type": "number", "nullable": true }, "oldInvoiceId": { "type": "number", "nullable": true }, "payStatus": { "type": "number" }, "assignStatus": { "type": "number" }, "status": { "type": "number" }, "collectionStatus": { "type": "number" }, "aceFreight": { "type": "string", "nullable": true }, "assignTo": { "type": "number" }, "comments": { "type": "string", "nullable": true }, "invoiceDate": { "type": "string", "format": "date-time" }, "regenerateDate": { "type": "string", "format": "date-time" }, "regenerateStatus": { "type": "number" }, "emailStatus": { "type": "number" }, "lastReceivedDate": { "type": "string", "format": "date-time" }, "created": { "type": "string", "format": "date-time" }, "payMode": { "type": "string", "nullable": true }, "writeOffType": { "type": "string", "nullable": true }, "calim_received_percentage": { "type": "number", "nullable": true }, "customerInsurance": { "type": "string", "nullable": true }, "qb_status": { "type": "string", "nullable": true }, "qb_doc_number": { "type": "string", "nullable": true }, "oldQb": { "type": "string" }, "aceAsiStatus": { "type": "number" }, "aceAsiQBStatus": { "type": "string", "nullable": true }, "ace_qb_bill_status": { "type": "string" }, "ace_qb_bill_id": { "type": "number" }, "asi_qb_bill_status": { "type": "string" }, "asi_qb_bill_id": { "type": "number" }, "ecapitalPercentage": { "type": "number" } }, "required": [ "uid" ], "additionalProperties": false, "x-typescript-type": "@loopback/repository-json-schema#Optional, 'shippersId'>" }, "InvoicesPartial": { "title": "InvoicesPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number" }, "uid": { "type": "string" }, "shipmentId": { "type": "number" }, "shippersId": { "type": "number" }, "userId": { "type": "number" }, "portalId": { "type": "number" }, "ArUserID": { "type": "number" }, "doc": { "type": "string", "nullable": true }, "invoicePayment": { "type": "number" }, "balance": { "type": "number" }, "paid": { "type": "number", "nullable": true }, "oldInvoiceId": { "type": "number", "nullable": true }, "payStatus": { "type": "number" }, "assignStatus": { "type": "number" }, "status": { "type": "number" }, "collectionStatus": { "type": "number" }, "aceFreight": { "type": "string", "nullable": true }, "assignTo": { "type": "number" }, "comments": { "type": "string", "nullable": true }, "invoiceDate": { "type": "string", "format": "date-time" }, "regenerateDate": { "type": "string", "format": "date-time" }, "regenerateStatus": { "type": "number" }, "emailStatus": { "type": "number" }, "lastReceivedDate": { "type": "string", "format": "date-time" }, "created": { "type": "string", "format": "date-time" }, "payMode": { "type": "string", "nullable": true }, "writeOffType": { "type": "string", "nullable": true }, "calim_received_percentage": { "type": "number", "nullable": true }, "customerInsurance": { "type": "string", "nullable": true }, "qb_status": { "type": "string", "nullable": true }, "qb_doc_number": { "type": "string", "nullable": true }, "oldQb": { "type": "string" }, "aceAsiStatus": { "type": "number" }, "aceAsiQBStatus": { "type": "string", "nullable": true }, "ace_qb_bill_status": { "type": "string" }, "ace_qb_bill_id": { "type": "number" }, "asi_qb_bill_status": { "type": "string" }, "asi_qb_bill_id": { "type": "number" }, "ecapitalPercentage": { "type": "number" } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "Equipment": { "title": "Equipment", "type": "object", "properties": { "name": { "type": "string" }, "id": { "type": "number" }, "equip_type": { "type": "string" }, "spot_equip": { "type": "string" }, "pst_evrywre": { "type": "string" }, "ts_equip": { "type": "string" }, "cat_ts": { "type": "string" }, "ts_id": { "type": "string" }, "dat_id": { "type": "string" }, "status": { "type": "boolean" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "deleted_at": { "type": "string", "format": "date-time" } }, "required": [ "name", "equip_type" ], "additionalProperties": false }, "CompaniesInsurance": { "title": "CompaniesInsurance", "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "status": { "type": "number" }, "portalId": { "type": "number" } }, "required": [ "portalId" ], "additionalProperties": false }, "NewCompaniesInsuranceInShippers": { "title": "NewCompaniesInsuranceInShippers", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewCompaniesInsuranceInShippers', exclude: [ 'id' ] })", "properties": { "name": { "type": "string" }, "status": { "type": "number" }, "portalId": { "type": "number" } }, "required": [ "portalId" ], "additionalProperties": false, "x-typescript-type": "Omit" }, "CompaniesInsurancePartial": { "title": "CompaniesInsurancePartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "status": { "type": "number" }, "portalId": { "type": "number" } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "Commodities": { "title": "Commodities", "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "status": { "type": "number", "enum": [ 0, 1, 2 ] }, "EstimatedValue": { "type": "string", "nullable": true }, "created": { "type": "string", "format": "date-time" }, "user_id": { "type": "number" }, "modified": { "type": "string", "format": "date-time" } }, "required": [ "name", "status" ], "additionalProperties": false }, "ShippersBankruptcy": { "title": "ShippersBankruptcy", "type": "object", "properties": { "id": { "type": "number" }, "company_name": { "type": "string" }, "mc_number": { "type": "string" }, "address": { "type": "string" }, "added_by": { "type": "number" }, "is_active": { "type": "boolean" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } }, "required": [ "company_name" ], "additionalProperties": false }, "NewShippersBankruptcy": { "title": "NewShippersBankruptcy", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewShippersBankruptcy', exclude: [ 'id' ] })", "properties": { "company_name": { "type": "string" }, "mc_number": { "type": "string" }, "address": { "type": "string" }, "added_by": { "type": "number" }, "is_active": { "type": "boolean" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } }, "required": [ "company_name" ], "additionalProperties": false, "x-typescript-type": "Omit" }, "ShippersBankruptcyWithRelations": { "title": "ShippersBankruptcyWithRelations", "type": "object", "description": "(tsType: ShippersBankruptcyWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "company_name": { "type": "string" }, "mc_number": { "type": "string" }, "address": { "type": "string" }, "added_by": { "type": "number" }, "is_active": { "type": "boolean" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } }, "required": [ "company_name" ], "additionalProperties": false, "x-typescript-type": "ShippersBankruptcyWithRelations" }, "ShippersBankruptcyPartial": { "title": "ShippersBankruptcyPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number" }, "company_name": { "type": "string" }, "mc_number": { "type": "string" }, "address": { "type": "string" }, "added_by": { "type": "number" }, "is_active": { "type": "boolean" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "ShipperUnknownPayment": { "title": "ShipperUnknownPayment", "type": "object", "properties": { "id": { "type": "number" }, "paymentReceivedDate": { "type": "string" }, "paymentReceivedFrom": { "type": "string" }, "customerName": { "type": "string" }, "currency": { "type": "string" }, "modeOfPayment": { "type": "string" }, "checkNumber": { "type": "string" }, "checkDate": { "type": "string" }, "receivedAmount": { "type": "number" }, "paymentStatus": { "type": "number" }, "invoiceNumber": { "type": "string" }, "communication": { "type": "number" }, "openCredit": { "type": "number" }, "mainComment": { "type": "string" }, "arComment": { "type": "string" }, "isDeleted": { "type": "number" }, "amountRefunded": { "type": "number" }, "addedBy": { "type": "number" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "paymentReceivedDate", "receivedAmount", "createdAt" ], "additionalProperties": false }, "NewShipperUnknownPayment": { "title": "NewShipperUnknownPayment", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewShipperUnknownPayment', exclude: [ 'id' ] })", "properties": { "paymentReceivedDate": { "type": "string" }, "paymentReceivedFrom": { "type": "string" }, "customerName": { "type": "string" }, "currency": { "type": "string" }, "modeOfPayment": { "type": "string" }, "checkNumber": { "type": "string" }, "checkDate": { "type": "string" }, "receivedAmount": { "type": "number" }, "paymentStatus": { "type": "number" }, "invoiceNumber": { "type": "string" }, "communication": { "type": "number" }, "openCredit": { "type": "number" }, "mainComment": { "type": "string" }, "arComment": { "type": "string" }, "isDeleted": { "type": "number" }, "amountRefunded": { "type": "number" }, "addedBy": { "type": "number" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "paymentReceivedDate", "receivedAmount", "createdAt" ], "additionalProperties": false, "x-typescript-type": "Omit" }, "ShipperUnknownPaymentWithRelations": { "title": "ShipperUnknownPaymentWithRelations", "type": "object", "description": "(tsType: ShipperUnknownPaymentWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "paymentReceivedDate": { "type": "string" }, "paymentReceivedFrom": { "type": "string" }, "customerName": { "type": "string" }, "currency": { "type": "string" }, "modeOfPayment": { "type": "string" }, "checkNumber": { "type": "string" }, "checkDate": { "type": "string" }, "receivedAmount": { "type": "number" }, "paymentStatus": { "type": "number" }, "invoiceNumber": { "type": "string" }, "communication": { "type": "number" }, "openCredit": { "type": "number" }, "mainComment": { "type": "string" }, "arComment": { "type": "string" }, "isDeleted": { "type": "number" }, "amountRefunded": { "type": "number" }, "addedBy": { "type": "number" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "paymentReceivedDate", "receivedAmount", "createdAt" ], "additionalProperties": false, "x-typescript-type": "ShipperUnknownPaymentWithRelations" }, "ShipperUnknownPaymentPartial": { "title": "ShipperUnknownPaymentPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number" }, "paymentReceivedDate": { "type": "string" }, "paymentReceivedFrom": { "type": "string" }, "customerName": { "type": "string" }, "currency": { "type": "string" }, "modeOfPayment": { "type": "string" }, "checkNumber": { "type": "string" }, "checkDate": { "type": "string" }, "receivedAmount": { "type": "number" }, "paymentStatus": { "type": "number" }, "invoiceNumber": { "type": "string" }, "communication": { "type": "number" }, "openCredit": { "type": "number" }, "mainComment": { "type": "string" }, "arComment": { "type": "string" }, "isDeleted": { "type": "number" }, "amountRefunded": { "type": "number" }, "addedBy": { "type": "number" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "InvoicesWithRelations": { "title": "InvoicesWithRelations", "type": "object", "description": "(tsType: InvoicesWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "uid": { "type": "string" }, "shipmentId": { "type": "number" }, "shippersId": { "type": "number" }, "userId": { "type": "number" }, "portalId": { "type": "number" }, "ArUserID": { "type": "number" }, "doc": { "type": "string", "nullable": true }, "invoicePayment": { "type": "number" }, "balance": { "type": "number" }, "paid": { "type": "number", "nullable": true }, "oldInvoiceId": { "type": "number", "nullable": true }, "payStatus": { "type": "number" }, "assignStatus": { "type": "number" }, "status": { "type": "number" }, "collectionStatus": { "type": "number" }, "aceFreight": { "type": "string", "nullable": true }, "assignTo": { "type": "number" }, "comments": { "type": "string", "nullable": true }, "invoiceDate": { "type": "string", "format": "date-time" }, "regenerateDate": { "type": "string", "format": "date-time" }, "regenerateStatus": { "type": "number" }, "emailStatus": { "type": "number" }, "lastReceivedDate": { "type": "string", "format": "date-time" }, "created": { "type": "string", "format": "date-time" }, "payMode": { "type": "string", "nullable": true }, "writeOffType": { "type": "string", "nullable": true }, "calim_received_percentage": { "type": "number", "nullable": true }, "customerInsurance": { "type": "string", "nullable": true }, "qb_status": { "type": "string", "nullable": true }, "qb_doc_number": { "type": "string", "nullable": true }, "oldQb": { "type": "string" }, "aceAsiStatus": { "type": "number" }, "aceAsiQBStatus": { "type": "string", "nullable": true }, "ace_qb_bill_status": { "type": "string" }, "ace_qb_bill_id": { "type": "number" }, "asi_qb_bill_status": { "type": "string" }, "asi_qb_bill_id": { "type": "number" }, "ecapitalPercentage": { "type": "number" }, "shipment": { "$ref": "#/components/schemas/ShipmentWithRelations" }, "foreignKey": {}, "shippers": { "$ref": "#/components/schemas/ShippersWithRelations" }, "user": { "$ref": "#/components/schemas/UserWithRelations" }, "portal": { "$ref": "#/components/schemas/PortalWithRelations" }, "aruser": { "$ref": "#/components/schemas/UserWithRelations" }, "invoicePayments": { "type": "array", "items": { "$ref": "#/components/schemas/InvoicePaymentWithRelations" } }, "invoiceRegenrationRequests": { "type": "array", "items": { "$ref": "#/components/schemas/InvoiceRegenrationRequestsWithRelations" } }, "BadDebtsHistory": { "type": "array", "items": { "$ref": "#/components/schemas/BadDebtsHistoryWithRelations" } } }, "required": [ "uid" ], "additionalProperties": false, "x-typescript-type": "InvoicesWithRelations" }, "ShipperPaymentRemittanceWithRelations": { "title": "ShipperPaymentRemittanceWithRelations", "type": "object", "description": "(tsType: ShipperPaymentRemittanceWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "portalId": { "type": "number" }, "invoices": { "type": "string" }, "paidAmount": { "type": "string" }, "paidTo": { "type": "string" }, "paymentMode": { "type": "string" }, "sent": { "type": "number" }, "eCheck": { "type": "number" }, "checkNumber": { "type": "string" }, "paymentDate": { "type": "string", "format": "date-time" }, "arName": { "type": "string" }, "submitDate": { "type": "string", "format": "date-time" }, "isDeleted": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "shippersId": { "type": "number" }, "shippers": { "$ref": "#/components/schemas/ShippersWithRelations" }, "foreignKey": {} }, "additionalProperties": false, "x-typescript-type": "ShipperPaymentRemittanceWithRelations" }, "PortalWithRelations": { "title": "PortalWithRelations", "type": "object", "description": "(tsType: PortalWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "domain": { "type": "string", "nullable": true }, "company_email": { "type": "string" }, "email": { "type": "string" }, "password": { "type": "string" }, "company_logo": { "type": "string" }, "company_name": { "type": "string" }, "corporate_number": { "type": "string" }, "fax_number": { "type": "string" }, "company_address": { "type": "string" }, "description": { "type": "string", "nullable": true }, "phoneNumber": { "type": "string" }, "mciNumber": { "type": "string" }, "corporate_address": { "type": "string" }, "status": { "type": "number", "description": "0 deactive | 1 active| 2 blocked", "enum": [ 0, 1, 2 ] }, "second_email_login": { "type": "string", "nullable": true }, "potralRoleId": { "type": "number" }, "user": { "$ref": "#/components/schemas/UserWithRelations" }, "users": { "type": "array", "items": { "$ref": "#/components/schemas/UserWithRelations" } }, "potralRole": { "$ref": "#/components/schemas/PotralRoleWithRelations" }, "foreignKey": {} }, "required": [ "name", "email", "password", "status" ], "additionalProperties": false, "x-typescript-type": "PortalWithRelations" }, "ShipperLimitsWithRelations": { "title": "ShipperLimitsWithRelations", "type": "object", "description": "(tsType: ShipperLimitsWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "userId": { "type": "number" }, "portalId": { "type": "number" }, "shippersId": { "type": "number" }, "request_limit": { "type": "number", "nullable": true }, "secure_limit": { "type": "number", "nullable": true }, "un_secured_limit": { "type": "number", "nullable": true }, "approval_limit": { "type": "number", "nullable": true }, "un_approval_limit": { "type": "number", "nullable": true }, "reason_ar": { "type": "string" }, "reason_broker": { "type": "string" }, "type": { "type": "number" }, "status": { "type": "number" }, "limitType": { "type": "number" }, "creditLimitDoc": { "type": "string", "nullable": true }, "manager_id": { "type": "number", "nullable": true }, "approved_communication_type": { "type": "number", "nullable": true }, "manager_comments": { "type": "string" }, "created": { "type": "string", "format": "date-time" }, "ArUserID": { "type": "number" }, "user": { "$ref": "#/components/schemas/UserWithRelations" }, "foreignKey": {}, "portal": { "$ref": "#/components/schemas/PortalWithRelations" }, "shippers": { "$ref": "#/components/schemas/ShippersWithRelations" }, "arusers": { "$ref": "#/components/schemas/UserWithRelations" } }, "additionalProperties": false, "x-typescript-type": "ShipperLimitsWithRelations" }, "ShipperLimits": { "title": "ShipperLimits", "type": "object", "properties": { "id": { "type": "number" }, "userId": { "type": "number" }, "portalId": { "type": "number" }, "shippersId": { "type": "number" }, "request_limit": { "type": "number", "nullable": true }, "secure_limit": { "type": "number", "nullable": true }, "un_secured_limit": { "type": "number", "nullable": true }, "approval_limit": { "type": "number", "nullable": true }, "un_approval_limit": { "type": "number", "nullable": true }, "reason_ar": { "type": "string" }, "reason_broker": { "type": "string" }, "type": { "type": "number" }, "status": { "type": "number" }, "limitType": { "type": "number" }, "creditLimitDoc": { "type": "string", "nullable": true }, "manager_id": { "type": "number", "nullable": true }, "approved_communication_type": { "type": "number", "nullable": true }, "manager_comments": { "type": "string" }, "created": { "type": "string", "format": "date-time" }, "ArUserID": { "type": "number" } }, "additionalProperties": false }, "Carriers": { "title": "Carriers", "type": "object", "properties": { "id": { "type": "number" }, "uid": { "type": "string" }, "mc": { "type": "string", "nullable": true }, "dot": { "type": "string", "nullable": true }, "nsc": { "type": "string", "nullable": true }, "company_name": { "type": "string" }, "address": { "type": "string" }, "phone_no": { "type": "string" }, "fax": { "type": "string" }, "email": { "type": "string", "format": "email", "minLength": 5, "maxLength": 50, "transform": [ "toLowerCase" ], "nullable": true }, "dispatcher": { "type": "string" }, "zip": { "type": "string" }, "cargo_amount": { "type": "number" }, "cargo_expires": { "type": "string", "format": "date-time" }, "trailer_interchange_expires": { "type": "string", "format": "date-time", "nullable": true }, "cargo_deductable": { "type": "number" }, "liability_amount": { "type": "number" }, "liability_expires": { "type": "string", "format": "date-time" }, "gen_liability_amount": { "type": "number" }, "gen_liab_expires": { "type": "string", "format": "date-time" }, "trailer_interchange_amount": { "type": "number", "nullable": true }, "reefer_breakdown": { "type": "number", "enum": [ 0, 1 ] }, "reefer_breakdown_deduct": { "type": "number", "nullable": true }, "contact_authority": { "type": "string", "nullable": true }, "common_authority": { "type": "string", "nullable": true }, "safety_rating": { "type": "string", "nullable": true }, "driver_name": { "type": "string", "nullable": true }, "driver_phone": { "type": "string", "nullable": true }, "w9_w8_type": { "type": "string" }, "tin_type": { "type": "string" }, "ein_ssn_number": { "type": "string" }, "carrier_type": { "type": "string" }, "carrier_email": { "type": "string", "format": "email", "minLength": 5, "maxLength": 50, "transform": [ "toLowerCase" ] }, "pcf_besic_company_email": { "type": "string", "format": "email", "minLength": 5, "maxLength": 50, "transform": [ "toLowerCase" ] }, "pcf_besic_address": { "type": "string" }, "is_pcf": { "type": "number", "enum": [ 0, 1 ] }, "pcf_besic_phone": { "type": "string" }, "pcf_besic_fax": { "type": "string" }, "pcf_besic_concern_person": { "type": "string" }, "noa_pdf": { "type": "string" }, "pcf_additional_company_name": { "type": "string", "nullable": true }, "pcf_additional_w9_pdf": { "type": "string" }, "pcf_additional_signature_pdf": { "type": "string" }, "pcf_additional_ach_pdf": { "type": "string" }, "pcf_additional_cacci_pdf": { "type": "string" }, "pcf_additional_address": { "type": "string" }, "pcf_additional_phone": { "type": "string", "nullable": true }, "pcf_additional_fax": { "type": "string", "nullable": true }, "pcf_additional_email": { "type": "string", "nullable": true }, "pcf_additional_contact_person": { "type": "string", "nullable": true }, "status": { "type": "number", "enum": [ 0, 1, 2 ] }, "factoringPayTo": { "type": "number", "nullable": true, "additionalProperties": true }, "payTo": { "type": "number" }, "firstApproval": { "type": "number" }, "email_marketing_status": { "type": "number" }, "qb_id": { "type": "string" }, "qb_status": { "type": "number" }, "pcf_qb_id": { "type": "string" }, "pcf_qb_status": { "type": "number" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "userId": { "type": "number" }, "portalId": { "type": "number" }, "pcf_additional_zipCodeId": { "type": "number" }, "city": { "type": "number" }, "equipment_type": { "type": "number" }, "zipCodesId": { "type": "number" }, "factoringId": { "type": "number" }, "pcf_besic_zipCodeId": { "type": "number" } }, "required": [ "uid", "email", "cargo_amount", "cargo_expires", "cargo_deductable", "liability_amount", "gen_liability_amount", "reefer_breakdown", "status" ], "additionalProperties": false }, "EquipmentExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations": { "title": "EquipmentExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations", "type": "object", "description": "(tsType: Omit, schemaOptions: { exclude: [ 'id', 'userId', 'portalId', 'uid', 'carrierPriceCad', 'shipperPriceCad', 'shipperPriceType', 'carrierPriceType' ], includeRelations: true })", "properties": { "name": { "type": "string" }, "equip_type": { "type": "string" }, "spot_equip": { "type": "string" }, "pst_evrywre": { "type": "string" }, "ts_equip": { "type": "string" }, "cat_ts": { "type": "string" }, "ts_id": { "type": "string" }, "dat_id": { "type": "string" }, "status": { "type": "boolean" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "deleted_at": { "type": "string", "format": "date-time" } }, "required": [ "name", "equip_type" ], "additionalProperties": false, "x-typescript-type": "Omit" }, "PortalExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations": { "title": "PortalExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations", "type": "object", "description": "(tsType: Omit, schemaOptions: { exclude: [ 'id', 'userId', 'portalId', 'uid', 'carrierPriceCad', 'shipperPriceCad', 'shipperPriceType', 'carrierPriceType' ], includeRelations: true })", "properties": { "name": { "type": "string" }, "domain": { "type": "string", "nullable": true }, "company_email": { "type": "string" }, "email": { "type": "string" }, "password": { "type": "string" }, "company_logo": { "type": "string" }, "company_name": { "type": "string" }, "corporate_number": { "type": "string" }, "fax_number": { "type": "string" }, "company_address": { "type": "string" }, "description": { "type": "string", "nullable": true }, "phoneNumber": { "type": "string" }, "mciNumber": { "type": "string" }, "corporate_address": { "type": "string" }, "status": { "type": "number", "description": "0 deactive | 1 active| 2 blocked", "enum": [ 0, 1, 2 ] }, "second_email_login": { "type": "string", "nullable": true }, "potralRoleId": { "type": "number" }, "user": { "$ref": "#/components/schemas/UserExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations" }, "users": { "type": "array", "items": { "$ref": "#/components/schemas/UserExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations" } }, "potralRole": { "$ref": "#/components/schemas/PotralRoleExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations" }, "foreignKey": {} }, "required": [ "name", "email", "password", "status" ], "additionalProperties": false, "x-typescript-type": "Omit" }, "CarrierPaymentExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations": { "title": "CarrierPaymentExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations", "type": "object", "description": "(tsType: Omit, schemaOptions: { exclude: [ 'id', 'userId', 'portalId', 'uid', 'carrierPriceCad', 'shipperPriceCad', 'shipperPriceType', 'carrierPriceType' ], includeRelations: true })", "properties": { "agingDate": { "type": "string", "format": "date-time" }, "paymentInitiated": { "type": "string", "format": "date-time", "nullable": true }, "attachment": { "type": "string" }, "notes": { "type": "string", "nullable": true }, "paymentStatus": { "type": "number" }, "brokerName": { "type": "string", "nullable": true }, "qpStatus": { "type": "number" }, "amountUsd": { "type": "number" }, "amountCad": { "type": "number" }, "paymentType": { "type": "number" }, "paymentMethod": { "type": "string" }, "payTo": { "type": "number" }, "subject": { "type": "string", "nullable": true }, "message": { "type": "string", "nullable": true }, "qb_id": { "type": "string" }, "qb_status": { "type": "number" }, "doc_number": { "type": "string" }, "VlAsiDocNumber": { "type": "string" }, "oldPaymentDate": { "type": "string", "format": "date-time", "nullable": true }, "shipmentId": { "type": "number" }, "carriersId": { "type": "number" }, "apId": { "type": "number" }, "carrierAgingId": { "type": "number" }, "shipment": { "$ref": "#/components/schemas/ShipmentExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations" }, "foreignKey": {}, "carriers": { "$ref": "#/components/schemas/CarriersExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations" }, "user": { "$ref": "#/components/schemas/UserExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations" }, "ap": { "$ref": "#/components/schemas/UserExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations" }, "portal": { "$ref": "#/components/schemas/PortalExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations" }, "carrierAging": { "$ref": "#/components/schemas/CarrierAgingExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations" }, "apEmailToCarriers": { "type": "array", "items": { "$ref": "#/components/schemas/ApEmailToCarrierExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations" } } }, "additionalProperties": false, "x-typescript-type": "Omit" }, "RoleExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations": { "title": "RoleExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations", "type": "object", "description": "(tsType: Omit, schemaOptions: { exclude: [ 'id', 'userId', 'portalId', 'uid', 'carrierPriceCad', 'shipperPriceCad', 'shipperPriceType', 'carrierPriceType' ], includeRelations: true })", "properties": { "name": { "type": "string" }, "permissions": { "type": "array", "items": { "type": "string" } }, "role_key": { "type": "number" }, "type": { "type": "number" }, "defaultPermissions": { "type": "array", "items": { "type": "string" } }, "portal": { "$ref": "#/components/schemas/PortalExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations" }, "foreignKey": {}, "users": { "type": "array", "items": { "$ref": "#/components/schemas/UserExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations" } } }, "required": [ "name" ], "additionalProperties": false, "x-typescript-type": "Omit" }, "ShippersExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations": { "title": "ShippersExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations", "type": "object", "description": "(tsType: Omit, schemaOptions: { exclude: [ 'id', 'userId', 'portalId', 'uid', 'carrierPriceCad', 'shipperPriceCad', 'shipperPriceType', 'carrierPriceType' ], includeRelations: true })", "properties": { "oldShipperId": { "type": "number", "nullable": true }, "name": { "type": "string", "nullable": true }, "shipperQuote": { "type": "string", "nullable": true }, "phone_no": { "type": "string", "nullable": true }, "address": { "type": "string", "nullable": true }, "fax": { "type": "string", "nullable": true }, "zip": { "type": "string", "nullable": true }, "contact_name": { "type": "string", "nullable": true }, "instructions": { "type": "string", "nullable": true }, "insurance_name": { "type": "string", "nullable": true }, "setupType": { "type": "string", "nullable": true }, "shipperType": { "type": "string", "nullable": true }, "FromDate": { "type": "string", "format": "date-time" }, "ToDate": { "type": "string", "format": "date-time" }, "shipper_status": { "type": "number" }, "shipperCommunicationType": { "type": "number" }, "assignTo": { "type": "number" }, "secure_limit": { "type": "number", "nullable": true }, "unsecure_limit": { "type": "number", "nullable": true }, "reApprovalStatus": { "type": "number", "nullable": true }, "insurance_status": { "type": "string", "nullable": true }, "url": { "type": "string", "nullable": true }, "creditApp": { "type": "string", "nullable": true }, "quotationProof": { "type": "string", "nullable": true }, "creditLimitDoc": { "type": "string", "nullable": true }, "insurance_exp_date": { "type": "string", "format": "date-time" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "oldLimit": { "type": "number", "nullable": true }, "ace_qb_id": { "type": "string", "nullable": true }, "ace_qb_status": { "type": "string", "nullable": true }, "vl_qb_id": { "type": "string", "nullable": true }, "vl_qb_status": { "type": "string", "nullable": true }, "asi_qb_id": { "type": "string", "nullable": true }, "asi_qb_status": { "type": "string", "nullable": true }, "callingType": { "type": "string", "nullable": true }, "equipmentId": { "type": "number" }, "zipCodesId": { "type": "number" }, "shipperContactsId": { "type": "number" }, "allocate_churn_customer": { "type": "number" }, "invoiceSend": { "type": "number" }, "sessional_shipper": { "type": "number" }, "shipperHistoryId": { "type": "number" }, "commoditiesId": { "type": "number" }, "apId": { "type": "number" }, "user": { "$ref": "#/components/schemas/UserExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations" }, "foreignKey": {}, "portal": { "$ref": "#/components/schemas/PortalExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations" }, "equipment": { "$ref": "#/components/schemas/EquipmentExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations" }, "zipCodes": { "$ref": "#/components/schemas/ZipCodesExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations" }, "shipperContacts": { "type": "array", "items": { "$ref": "#/components/schemas/ShipperContactsExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations" } }, "shipperHistory": { "$ref": "#/components/schemas/ShipperHistoryExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations" }, "commodities": { "$ref": "#/components/schemas/CommoditiesExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations" }, "companiesInsurances": { "type": "array", "items": { "$ref": "#/components/schemas/CompaniesInsuranceExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations" } }, "shippersCompaniesInsurances": { "type": "array", "items": { "$ref": "#/components/schemas/ShippersCompaniesInsuranceExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations" } }, "shipmentsList": { "type": "array", "items": { "$ref": "#/components/schemas/ShipmentExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations" } }, "shippersinvoiceslist": { "type": "array", "items": { "$ref": "#/components/schemas/InvoicesExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations" } }, "ap": { "$ref": "#/components/schemas/UserExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations" } }, "additionalProperties": false, "x-typescript-type": "Omit" }, "UserExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations": { "title": "UserExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations", "type": "object", "description": "(tsType: Omit, schemaOptions: { exclude: [ 'id', 'userId', 'portalId', 'uid', 'carrierPriceCad', 'shipperPriceCad', 'shipperPriceType', 'carrierPriceType' ], includeRelations: true })", "properties": { "name": { "type": "string" }, "first_name": { "type": "string", "nullable": true }, "last_name": { "type": "string", "nullable": true }, "real_name": { "type": "string", "nullable": true }, "phone": { "type": "string", "nullable": true }, "ext": { "type": "string", "nullable": true }, "fax": { "type": "string", "nullable": true }, "avatar": { "type": "string", "nullable": true }, "status": { "type": "number", "enum": [ 0, 1, 2 ] }, "optNumber": { "type": "string", "nullable": true }, "twoFactor": { "type": "number", "enum": [ 0, 1 ] }, "arTypeUser": { "type": "number", "enum": [ 0, 1 ] }, "email_verified_at": { "type": "string", "format": "date-time" }, "email": { "type": "string" }, "AccEmail": { "type": "string", "nullable": true }, "password": { "type": "string" }, "realPassword": { "type": "string" }, "created": { "type": "string", "format": "date-time" }, "modified": { "type": "string", "format": "date-time" }, "realm": { "type": "string", "nullable": true }, "username": { "type": "string", "nullable": true }, "emailVerified": { "type": "boolean" }, "verificationToken": { "type": "boolean" }, "type": { "type": "number" }, "drayage": { "type": "boolean" }, "s_gross": { "type": "number" }, "BrokerPolicyDate": { "type": "string", "format": "date-time" }, "brokerIncentivePolicy": { "type": "number", "enum": [ 0, 1 ] }, "vl_user": { "type": "string", "nullable": true }, "vl_phone": { "type": "string", "nullable": true }, "vl_fax": { "type": "string", "nullable": true }, "vl_ext": { "type": "string", "nullable": true }, "bulkEmailAccess": { "type": "string", "nullable": true }, "onboardingDate": { "type": "string", "format": "date-time" }, "lobType": { "type": "number" }, "attrite": { "type": "number" }, "pipType": { "type": "number" }, "vonage_ext": { "type": "number", "nullable": true }, "aliance_ext": { "type": "number", "nullable": true }, "dids_number": { "type": "string", "nullable": true }, "apId": { "type": "number" }, "employeeId": { "type": "string", "nullable": true }, "socketId": { "type": "string" }, "roleId": { "type": "number" }, "smeMcVerification": { "type": "array", "items": { "$ref": "#/components/schemas/McVerificationExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations" } }, "semCprApproved": { "type": "array", "items": { "$ref": "#/components/schemas/CprRequestExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations" } }, "carrierPaymentDones": { "type": "array", "items": { "$ref": "#/components/schemas/CarrierPaymentDoneExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations" } }, "AssignApToBroker": { "$ref": "#/components/schemas/UserExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations" }, "foreignKey": {}, "apincentives": { "type": "array", "items": { "$ref": "#/components/schemas/CarrierPaymentExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations" } }, "role": { "$ref": "#/components/schemas/RoleExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations" }, "portal": { "$ref": "#/components/schemas/PortalExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations" }, "shippers": { "type": "array", "items": { "$ref": "#/components/schemas/ShippersExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations" } } }, "required": [ "name", "status", "twoFactor", "arTypeUser", "email", "password", "type", "brokerIncentivePolicy" ], "additionalProperties": false, "x-typescript-type": "Omit" }, "CommoditiesExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations": { "title": "CommoditiesExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations", "type": "object", "description": "(tsType: Omit, schemaOptions: { exclude: [ 'id', 'userId', 'portalId', 'uid', 'carrierPriceCad', 'shipperPriceCad', 'shipperPriceType', 'carrierPriceType' ], includeRelations: true })", "properties": { "name": { "type": "string" }, "status": { "type": "number", "enum": [ 0, 1, 2 ] }, "EstimatedValue": { "type": "string", "nullable": true }, "created": { "type": "string", "format": "date-time" }, "user_id": { "type": "number" }, "modified": { "type": "string", "format": "date-time" }, "Broker": { "$ref": "#/components/schemas/UserExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations" }, "foreignKey": {} }, "required": [ "name", "status" ], "additionalProperties": false, "x-typescript-type": "Omit" }, "ShipmentDocsExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations": { "title": "ShipmentDocsExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations", "type": "object", "description": "(tsType: Omit, schemaOptions: { exclude: [ 'id', 'userId', 'portalId', 'uid', 'carrierPriceCad', 'shipperPriceCad', 'shipperPriceType', 'carrierPriceType' ], includeRelations: true })", "properties": { "url": { "type": "string" }, "type": { "type": "string" }, "PortalBased": { "type": "string" }, "created": { "type": "string", "format": "date-time" }, "modified": { "type": "string", "format": "date-time" }, "shipmentId": { "type": "number" }, "user": { "$ref": "#/components/schemas/UserExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations" }, "foreignKey": {} }, "required": [ "url", "type" ], "additionalProperties": false, "x-typescript-type": "Omit" }, "CarriersExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations": { "title": "CarriersExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations", "type": "object", "description": "(tsType: Omit, schemaOptions: { exclude: [ 'id', 'userId', 'portalId', 'uid', 'carrierPriceCad', 'shipperPriceCad', 'shipperPriceType', 'carrierPriceType' ], includeRelations: true })", "properties": { "mc": { "type": "string", "nullable": true }, "dot": { "type": "string", "nullable": true }, "nsc": { "type": "string", "nullable": true }, "company_name": { "type": "string" }, "address": { "type": "string" }, "phone_no": { "type": "string" }, "fax": { "type": "string" }, "email": { "type": "string", "format": "email", "minLength": 5, "maxLength": 50, "transform": [ "toLowerCase" ], "nullable": true }, "dispatcher": { "type": "string" }, "zip": { "type": "string" }, "cargo_amount": { "type": "number" }, "cargo_expires": { "type": "string", "format": "date-time" }, "trailer_interchange_expires": { "type": "string", "format": "date-time", "nullable": true }, "cargo_deductable": { "type": "number" }, "liability_amount": { "type": "number" }, "liability_expires": { "type": "string", "format": "date-time" }, "gen_liability_amount": { "type": "number" }, "gen_liab_expires": { "type": "string", "format": "date-time" }, "trailer_interchange_amount": { "type": "number", "nullable": true }, "reefer_breakdown": { "type": "number", "enum": [ 0, 1 ] }, "reefer_breakdown_deduct": { "type": "number", "nullable": true }, "contact_authority": { "type": "string", "nullable": true }, "common_authority": { "type": "string", "nullable": true }, "safety_rating": { "type": "string", "nullable": true }, "driver_name": { "type": "string", "nullable": true }, "driver_phone": { "type": "string", "nullable": true }, "w9_w8_type": { "type": "string" }, "tin_type": { "type": "string" }, "ein_ssn_number": { "type": "string" }, "carrier_type": { "type": "string" }, "carrier_email": { "type": "string", "format": "email", "minLength": 5, "maxLength": 50, "transform": [ "toLowerCase" ] }, "pcf_besic_company_email": { "type": "string", "format": "email", "minLength": 5, "maxLength": 50, "transform": [ "toLowerCase" ] }, "pcf_besic_address": { "type": "string" }, "is_pcf": { "type": "number", "enum": [ 0, 1 ] }, "pcf_besic_phone": { "type": "string" }, "pcf_besic_fax": { "type": "string" }, "pcf_besic_concern_person": { "type": "string" }, "noa_pdf": { "type": "string" }, "pcf_additional_company_name": { "type": "string", "nullable": true }, "pcf_additional_w9_pdf": { "type": "string" }, "pcf_additional_signature_pdf": { "type": "string" }, "pcf_additional_ach_pdf": { "type": "string" }, "pcf_additional_cacci_pdf": { "type": "string" }, "pcf_additional_address": { "type": "string" }, "pcf_additional_phone": { "type": "string", "nullable": true }, "pcf_additional_fax": { "type": "string", "nullable": true }, "pcf_additional_email": { "type": "string", "nullable": true }, "pcf_additional_contact_person": { "type": "string", "nullable": true }, "status": { "type": "number", "enum": [ 0, 1, 2 ] }, "factoringPayTo": { "type": "number", "nullable": true, "additionalProperties": true }, "payTo": { "type": "number" }, "firstApproval": { "type": "number" }, "email_marketing_status": { "type": "number" }, "qb_id": { "type": "string" }, "qb_status": { "type": "number" }, "pcf_qb_id": { "type": "string" }, "pcf_qb_status": { "type": "number" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "pcf_additional_zipCodeId": { "type": "number" }, "city": { "type": "number" }, "equipment_type": { "type": "number" }, "zipCodesId": { "type": "number" }, "factoringId": { "type": "number" }, "pcf_besic_zipCodeId": { "type": "number" }, "user": { "$ref": "#/components/schemas/UserExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations" }, "foreignKey": {}, "portal": { "$ref": "#/components/schemas/PortalExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations" }, "pcf_additional_zipCode": { "$ref": "#/components/schemas/ZipCodesExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations" }, "cities": { "$ref": "#/components/schemas/CitiesExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations" }, "equipments": { "$ref": "#/components/schemas/EquipmentExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations" }, "zipCodes": { "$ref": "#/components/schemas/ZipCodesExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations" }, "factoring": { "$ref": "#/components/schemas/FactoringDetailsExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations" }, "paymentMethods": { "$ref": "#/components/schemas/PaymentMethodsExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations" }, "pcf_besic_zipCode": { "$ref": "#/components/schemas/ZipCodesExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations" }, "apDetails": { "$ref": "#/components/schemas/ApDetailsExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations" }, "carrierAging": { "type": "array", "items": { "$ref": "#/components/schemas/CarrierAgingExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations" } }, "shipments": { "type": "array", "items": { "$ref": "#/components/schemas/ShipmentExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations" } } }, "required": [ "email", "cargo_amount", "cargo_expires", "cargo_deductable", "liability_amount", "gen_liability_amount", "reefer_breakdown", "status" ], "additionalProperties": false, "x-typescript-type": "Omit" }, "ShipmentCarrierExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations": { "title": "ShipmentCarrierExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations", "type": "object", "description": "(tsType: Omit, schemaOptions: { exclude: [ 'id', 'userId', 'portalId', 'uid', 'carrierPriceCad', 'shipperPriceCad', 'shipperPriceType', 'carrierPriceType' ], includeRelations: true })", "properties": { "mc": { "type": "string", "nullable": true }, "dot": { "type": "string", "nullable": true }, "nsc": { "type": "string", "nullable": true }, "dispatcher": { "type": "string" }, "name": { "type": "string" }, "address": { "type": "string" }, "phone": { "type": "string" }, "email": { "type": "string" }, "cacciPhone": { "type": "string" }, "cacciEmail": { "type": "string" }, "truck": { "type": "string" }, "trailer": { "type": "string" }, "trailerImg": { "type": "string" }, "driverName": { "type": "string" }, "DriverPhone": { "type": "string" }, "created": { "type": "string", "format": "date-time" }, "modified": { "type": "string", "format": "date-time" }, "shipmentId": { "type": "number" }, "type": { "type": "string" }, "pickCity": { "type": "string" }, "pickState": { "type": "string" }, "dropCity": { "type": "string" }, "dropState": { "type": "string" } }, "required": [ "name" ], "additionalProperties": false, "x-typescript-type": "Omit" }, "ShipmentTimelineExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations": { "title": "ShipmentTimelineExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations", "type": "object", "description": "(tsType: Omit, schemaOptions: { exclude: [ 'id', 'userId', 'portalId', 'uid', 'carrierPriceCad', 'shipperPriceCad', 'shipperPriceType', 'carrierPriceType' ], includeRelations: true })", "properties": { "status": { "type": "string" }, "date": { "type": "string", "format": "date-time" }, "msg": { "type": "string" }, "shipmentId": { "type": "number" } }, "required": [ "status", "date" ], "additionalProperties": false, "x-typescript-type": "Omit" }, "CprRequestExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations": { "title": "CprRequestExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations", "type": "object", "description": "(tsType: Omit, schemaOptions: { exclude: [ 'id', 'userId', 'portalId', 'uid', 'carrierPriceCad', 'shipperPriceCad', 'shipperPriceType', 'carrierPriceType' ], includeRelations: true })", "properties": { "status": { "type": "number" }, "reApprovalStatus": { "type": "number" }, "sendDate": { "type": "string", "format": "date-time" }, "approvedDate": { "type": "string", "format": "date-time" }, "mc": { "type": "string", "nullable": true }, "checkedById": { "type": "number" }, "dot": { "type": "string", "nullable": true }, "marginStatus": { "type": "number" }, "nsc": { "type": "string", "nullable": true }, "timeDiffrence": { "type": "number", "nullable": true }, "totalIncentive": { "type": "number", "nullable": true }, "signeDocumentID": { "type": "string", "nullable": true }, "emailViewed": { "type": "number", "nullable": true }, "docViewed": { "type": "number", "nullable": true }, "secondApprovedBySmeId": { "type": "number" }, "secondCheckedBySmeId": { "type": "number" }, "signedOn": { "type": "string", "format": "date-time" }, "emailStatus": { "type": "number" }, "etaEmailStatus": { "type": "number" }, "documentSigned": { "type": "number", "nullable": true }, "carrierId": { "type": "number" }, "shipmentId": { "type": "number" }, "ApprovedBySmsId": { "type": "number" }, "managerComments": { "type": "string", "nullable": true }, "approvalType": { "type": "string", "nullable": true }, "cprDoneFor": { "type": "string", "nullable": true }, "spokesTo": { "type": "string", "nullable": true }, "insuranceDocuments": { "type": "string", "nullable": true }, "cacciDocuments": { "type": "string", "nullable": true }, "managerApproveId": { "type": "number" }, "callStatus": { "type": "number" }, "mcNotesCall": { "type": "string", "maxLength": 5000, "nullable": true }, "pickupPhoneVerified": { "type": "number" }, "loadMatchComments": { "type": "string", "nullable": true }, "checkedBy": { "$ref": "#/components/schemas/UserExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations" }, "foreignKey": {}, "portal": { "$ref": "#/components/schemas/PortalExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations" }, "secondApprovedBySme": { "$ref": "#/components/schemas/UserExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations" }, "secondCheckedBySme": { "$ref": "#/components/schemas/UserExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations" }, "user": { "$ref": "#/components/schemas/UserExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations" }, "carrier": { "$ref": "#/components/schemas/CarriersExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations" }, "shipment": { "$ref": "#/components/schemas/ShipmentExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations" }, "ApprovedBySms": { "$ref": "#/components/schemas/UserExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations" } }, "additionalProperties": false, "x-typescript-type": "Omit" }, "GtgHistoryExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations": { "title": "GtgHistoryExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations", "type": "object", "description": "(tsType: Omit, schemaOptions: { exclude: [ 'id', 'userId', 'portalId', 'uid', 'carrierPriceCad', 'shipperPriceCad', 'shipperPriceType', 'carrierPriceType' ], includeRelations: true })", "properties": { "message": { "type": "string" }, "date": { "type": "string", "format": "date-time" }, "for": { "type": "number", "enum": [ 0, 1 ] }, "shipmentId": { "type": "number" }, "user": { "$ref": "#/components/schemas/UserExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations" }, "foreignKey": {}, "gtgHistory": { "$ref": "#/components/schemas/ShipmentExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations" } }, "additionalProperties": false, "x-typescript-type": "Omit" }, "McReVerificationExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations": { "title": "McReVerificationExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations", "type": "object", "description": "(tsType: Omit, schemaOptions: { exclude: [ 'id', 'userId', 'portalId', 'uid', 'carrierPriceCad', 'shipperPriceCad', 'shipperPriceType', 'carrierPriceType' ], includeRelations: true })", "properties": { "carrierNumber": { "type": "string" }, "carrierEmail": { "type": "string" }, "mcNumber": { "type": "string", "nullable": true }, "dotNumber": { "type": "string", "nullable": true }, "nscNumber": { "type": "string", "nullable": true }, "smeStatus": { "type": "number" }, "smeId": { "type": "number" }, "sendDate": { "type": "string", "format": "date-time" }, "approvalDate": { "type": "string", "format": "date-time" }, "verifiedType": { "type": "string", "nullable": true }, "shipmentId": { "type": "number" }, "shipment": { "$ref": "#/components/schemas/ShipmentExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations" }, "foreignKey": {} }, "required": [ "carrierEmail", "smeStatus" ], "additionalProperties": false, "x-typescript-type": "Omit" }, "CarrierAgingExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations": { "title": "CarrierAgingExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations", "type": "object", "description": "(tsType: Omit, schemaOptions: { exclude: [ 'id', 'userId', 'portalId', 'uid', 'carrierPriceCad', 'shipperPriceCad', 'shipperPriceType', 'carrierPriceType' ], includeRelations: true })", "properties": { "ap_agent_id": { "type": "number" }, "age_date": { "type": "string", "format": "date-time" }, "invoice_number": { "type": "string" }, "invoice_date": { "type": "string", "format": "date-time" }, "advance_payment_date": { "type": "string", "format": "date-time" }, "advance_pay_usd": { "type": "number" }, "advance_pay_cad": { "type": "number" }, "advance_pay_type": { "type": "string" }, "advance_pay_status": { "type": "number" }, "payable_amount_usd": { "type": "number" }, "payable_amount_cad": { "type": "number" }, "quick_book_invoice_status": { "type": "number" }, "quick_book_invoice_date": { "type": "string", "format": "date-time" }, "request_status": { "type": "number", "nullable": true }, "advance_pay_label": { "type": "string" }, "message": { "type": "string" }, "quick_pay": { "type": "number" }, "carriersId": { "type": "number" }, "shipmentId": { "type": "number" }, "auditCreatedAt": { "type": "string", "format": "date-time" }, "auditComment": { "type": "string", "nullable": true }, "auditStatus": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "carriers": { "$ref": "#/components/schemas/CarriersExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations" }, "foreignKey": {}, "user": { "$ref": "#/components/schemas/UserExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations" }, "portal": { "$ref": "#/components/schemas/PortalExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations" }, "shipment": { "$ref": "#/components/schemas/ShipmentExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations" } }, "additionalProperties": false, "x-typescript-type": "Omit" }, "SignDocExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations": { "title": "SignDocExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations", "type": "object", "description": "(tsType: Omit, schemaOptions: { exclude: [ 'id', 'userId', 'portalId', 'uid', 'carrierPriceCad', 'shipperPriceCad', 'shipperPriceType', 'carrierPriceType' ], includeRelations: true })", "properties": { "document": { "type": "string" }, "signedDoc": { "type": "string" }, "shipmentId": { "type": "number" }, "emailFrom": { "type": "string" }, "emailTo": { "type": "string" }, "docType": { "type": "string" }, "subject": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "number", "enum": [ 0, 1, 2 ] }, "carrierLoginId": { "type": "number" }, "container": { "type": "string" }, "readStatus": { "type": "number" }, "created": { "type": "string", "format": "date-time" }, "updated": { "type": "string", "format": "date-time" } }, "required": [ "document", "status" ], "additionalProperties": false, "x-typescript-type": "Omit" }, "ApIncentiveExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations": { "title": "ApIncentiveExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations", "type": "object", "description": "(tsType: Omit, schemaOptions: { exclude: [ 'id', 'userId', 'portalId', 'uid', 'carrierPriceCad', 'shipperPriceCad', 'shipperPriceType', 'carrierPriceType' ], includeRelations: true })", "properties": { "diliveryDate": { "type": "string", "format": "date-time" }, "podDate": { "type": "string", "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" }, "readyToInvoiceDate": { "type": "string", "format": "date-time" }, "ages": { "type": "number" }, "loadType": { "type": "string" }, "broker": { "type": "string" }, "apTeam": { "type": "string" }, "shipmentId": { "type": "number" }, "shipment": { "$ref": "#/components/schemas/ShipmentExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations" }, "foreignKey": {}, "user": { "$ref": "#/components/schemas/UserExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations" } }, "additionalProperties": false, "x-typescript-type": "Omit" }, "InvoicesExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations": { "title": "InvoicesExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations", "type": "object", "description": "(tsType: Omit, schemaOptions: { exclude: [ 'id', 'userId', 'portalId', 'uid', 'carrierPriceCad', 'shipperPriceCad', 'shipperPriceType', 'carrierPriceType' ], includeRelations: true })", "properties": { "shipmentId": { "type": "number" }, "shippersId": { "type": "number" }, "ArUserID": { "type": "number" }, "doc": { "type": "string", "nullable": true }, "invoicePayment": { "type": "number" }, "balance": { "type": "number" }, "paid": { "type": "number", "nullable": true }, "oldInvoiceId": { "type": "number", "nullable": true }, "payStatus": { "type": "number" }, "assignStatus": { "type": "number" }, "status": { "type": "number" }, "collectionStatus": { "type": "number" }, "aceFreight": { "type": "string", "nullable": true }, "assignTo": { "type": "number" }, "comments": { "type": "string", "nullable": true }, "invoiceDate": { "type": "string", "format": "date-time" }, "regenerateDate": { "type": "string", "format": "date-time" }, "regenerateStatus": { "type": "number" }, "emailStatus": { "type": "number" }, "lastReceivedDate": { "type": "string", "format": "date-time" }, "created": { "type": "string", "format": "date-time" }, "payMode": { "type": "string", "nullable": true }, "writeOffType": { "type": "string", "nullable": true }, "calim_received_percentage": { "type": "number", "nullable": true }, "customerInsurance": { "type": "string", "nullable": true }, "qb_status": { "type": "string", "nullable": true }, "qb_doc_number": { "type": "string", "nullable": true }, "oldQb": { "type": "string" }, "aceAsiStatus": { "type": "number" }, "aceAsiQBStatus": { "type": "string", "nullable": true }, "ace_qb_bill_status": { "type": "string" }, "ace_qb_bill_id": { "type": "number" }, "asi_qb_bill_status": { "type": "string" }, "asi_qb_bill_id": { "type": "number" }, "ecapitalPercentage": { "type": "number" }, "shipment": { "$ref": "#/components/schemas/ShipmentExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations" }, "foreignKey": {}, "shippers": { "$ref": "#/components/schemas/ShippersExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations" }, "user": { "$ref": "#/components/schemas/UserExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations" }, "portal": { "$ref": "#/components/schemas/PortalExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations" }, "aruser": { "$ref": "#/components/schemas/UserExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations" }, "invoicePayments": { "type": "array", "items": { "$ref": "#/components/schemas/InvoicePaymentExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations" } }, "invoiceRegenrationRequests": { "type": "array", "items": { "$ref": "#/components/schemas/InvoiceRegenrationRequestsExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations" } }, "BadDebtsHistory": { "type": "array", "items": { "$ref": "#/components/schemas/BadDebtsHistoryExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations" } } }, "additionalProperties": false, "x-typescript-type": "Omit" }, "ShipmentPriceExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations": { "title": "ShipmentPriceExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations", "type": "object", "description": "(tsType: Omit, schemaOptions: { exclude: [ 'id', 'userId', 'portalId', 'uid', 'carrierPriceCad', 'shipperPriceCad', 'shipperPriceType', 'carrierPriceType' ], includeRelations: true })", "properties": { "label": { "type": "string" }, "cusd": { "type": "number", "nullable": true }, "ccad": { "type": "number", "nullable": true }, "susd": { "type": "number", "nullable": true }, "scad": { "type": "number", "nullable": true }, "created": { "type": "string", "format": "date-time" }, "modified": { "type": "string", "format": "date-time" }, "shipmentId": { "type": "number" }, "shipment": { "$ref": "#/components/schemas/ShipmentExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations" }, "foreignKey": {} }, "required": [ "label" ], "additionalProperties": false, "x-typescript-type": "Omit" }, "ShipmentPicksExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations": { "title": "ShipmentPicksExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations", "type": "object", "description": "(tsType: Omit, schemaOptions: { exclude: [ 'id', 'userId', 'portalId', 'uid', 'carrierPriceCad', 'shipperPriceCad', 'shipperPriceType', 'carrierPriceType' ], includeRelations: true })", "properties": { "index": { "type": "number", "nullable": true }, "name": { "type": "string", "nullable": true }, "address": { "type": "string", "nullable": true }, "contact": { "type": "string", "nullable": true }, "ref": { "type": "string" }, "oldPickId": { "type": "number", "nullable": true }, "phone": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "pickupDate": { "type": "string", "format": "date-time" }, "dateonly": { "type": "boolean", "nullable": true }, "apptDate": { "type": "string", "format": "date-time", "nullable": true }, "apptNote": { "type": "string" }, "created": { "type": "string", "format": "date-time" }, "modified": { "type": "string", "format": "date-time" }, "shipmentId": { "type": "number" }, "zipCodesId": { "type": "number" }, "shipment": { "$ref": "#/components/schemas/ShipmentExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations" }, "foreignKey": {}, "city": { "$ref": "#/components/schemas/ZipCodesExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations" } }, "required": [ "ref", "pickupDate" ], "additionalProperties": false, "x-typescript-type": "Omit" }, "ShipmentDropsExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations": { "title": "ShipmentDropsExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations", "type": "object", "description": "(tsType: Omit, schemaOptions: { exclude: [ 'id', 'userId', 'portalId', 'uid', 'carrierPriceCad', 'shipperPriceCad', 'shipperPriceType', 'carrierPriceType' ], includeRelations: true })", "properties": { "index": { "type": "number", "nullable": true }, "name": { "type": "string", "nullable": true }, "address": { "type": "string", "nullable": true }, "contact": { "type": "string", "nullable": true }, "ref": { "type": "string", "nullable": true }, "phone": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "dropDate": { "type": "string", "format": "date-time" }, "dateonly": { "type": "boolean", "nullable": true }, "zipCodesId": { "type": "number" }, "apptDate": { "type": "string", "format": "date-time", "nullable": true }, "emptyDate": { "type": "string", "format": "date-time", "nullable": true }, "apptNote": { "type": "string" }, "oldDropId": { "type": "number" }, "created": { "type": "string", "format": "date-time" }, "modified": { "type": "string", "format": "date-time" }, "shipmentId": { "type": "number" }, "city": { "$ref": "#/components/schemas/ZipCodesExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations" }, "foreignKey": {}, "shipment": { "$ref": "#/components/schemas/ShipmentExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations" } }, "required": [ "dropDate" ], "additionalProperties": false, "x-typescript-type": "Omit" }, "ShipmentDetailsExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations": { "title": "ShipmentDetailsExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations", "type": "object", "description": "(tsType: Omit, schemaOptions: { exclude: [ 'id', 'userId', 'portalId', 'uid', 'carrierPriceCad', 'shipperPriceCad', 'shipperPriceType', 'carrierPriceType' ], includeRelations: true })", "properties": { "insuranceEmail": { "type": "string" }, "AoneFFPriceQuoteNo": { "type": "string" }, "AoneFFShipmentLoadNo": { "type": "string" }, "invoiceMarginStatus": { "type": "number" }, "loadStatus": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time" }, "shipmentId": { "type": "number" } }, "additionalProperties": false, "x-typescript-type": "Omit" }, "AuditVerifyCprExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations": { "title": "AuditVerifyCprExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations", "type": "object", "description": "(tsType: Omit, schemaOptions: { exclude: [ 'id', 'userId', 'portalId', 'uid', 'carrierPriceCad', 'shipperPriceCad', 'shipperPriceType', 'carrierPriceType' ], includeRelations: true })", "properties": { "type": { "type": "string" }, "comment": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "shipmentId": { "type": "number" }, "user": { "$ref": "#/components/schemas/UserExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations" }, "foreignKey": {} }, "additionalProperties": false, "x-typescript-type": "Omit" }, "AuditVerifyCommodityExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations": { "title": "AuditVerifyCommodityExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations", "type": "object", "description": "(tsType: Omit, schemaOptions: { exclude: [ 'id', 'userId', 'portalId', 'uid', 'carrierPriceCad', 'shipperPriceCad', 'shipperPriceType', 'carrierPriceType' ], includeRelations: true })", "properties": { "type": { "type": "string" }, "comment": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "shipmentId": { "type": "number" }, "user": { "$ref": "#/components/schemas/UserExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations" }, "foreignKey": {} }, "additionalProperties": false, "x-typescript-type": "Omit" }, "CarrierConfirmDeliveryExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations": { "title": "CarrierConfirmDeliveryExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations", "type": "object", "description": "(tsType: Omit, schemaOptions: { exclude: [ 'id', 'userId', 'portalId', 'uid', 'carrierPriceCad', 'shipperPriceCad', 'shipperPriceType', 'carrierPriceType' ], includeRelations: true })", "properties": { "confirmDoc": { "type": "string" }, "stoppedDoc": { "type": "string" }, "confirmedAt": { "type": "string", "format": "date-time" }, "stoppedAt": { "type": "string", "format": "date-time" }, "status": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "carrierLoginId": { "type": "number" }, "shipmentId": { "type": "number" }, "carrierLogin": { "$ref": "#/components/schemas/CarrierLoginExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations" }, "foreignKey": {}, "shipment": { "$ref": "#/components/schemas/ShipmentExcluding_id-userId-portalId-uid-carrierPriceCad-shipperPriceCad-shipperPriceType-carrierPriceType_WithRelations" } }, "additionalProperties": false, "x-typescript-type": "Omit" }, "NewShipment": { "title": "NewShipment", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewShipment', exclude: [ 'id' ] })", "properties": { "shipmentNo": { "type": "number" }, "uid": { "type": "string" }, "status": { "type": "number" }, "tonuStatus": { "type": "number" }, "loadNo": { "type": "string" }, "containerNo": { "type": "string" }, "loadType": { "type": "string" }, "cdlNumber": { "type": "string", "nullable": true }, "vinNumber": { "type": "string", "nullable": true }, "pickupPhone": { "type": "string", "nullable": true }, "brokerSelfConfirmation": { "type": "string", "nullable": true }, "mc": { "type": "string", "nullable": true }, "dot": { "type": "string", "nullable": true }, "nsc": { "type": "string", "nullable": true }, "ar_gtg": { "type": "number" }, "ap_gtg": { "type": "number" }, "aone_ff_sync": { "type": "number" }, "cmt": { "type": "boolean" }, "commodityValue": { "type": "number" }, "weight": { "type": "string", "nullable": true }, "mode": { "type": "string" }, "footage": { "type": "string", "nullable": true }, "pallet": { "type": "number", "nullable": true }, "miles": { "type": "number", "nullable": true }, "minTemp": { "type": "string", "nullable": true }, "maxTemp": { "type": "string", "nullable": true }, "precoolTemp": { "type": "string", "nullable": true }, "carrierPayMode": { "type": "number" }, "shipperPayMode": { "type": "number" }, "carrierCommunicationPortalid": { "type": "number" }, "carrierInstrctions": { "type": "string" }, "shipperInstrctions": { "type": "string" }, "carrierPrice": { "type": "number" }, "carrierPriceCad": { "type": "number" }, "shipperPrice": { "type": "number" }, "shipperPriceCad": { "type": "number" }, "carrierPriceType": { "type": "number" }, "shipperPriceType": { "type": "number" }, "carrierUint": { "type": "number", "nullable": true }, "carrierUnitPrice": { "type": "number", "nullable": true }, "ShipperUnit": { "type": "number", "nullable": true }, "shipperUnitPrice": { "type": "number", "nullable": true }, "billingDetail": { "type": "object", "nullable": true }, "auditComment": { "type": "string", "nullable": true }, "VinPickupPhoneComment": { "type": "string", "nullable": true }, "auditCreatedAt": { "type": "string", "format": "date-time" }, "auditVinNumberCreatedAt": { "type": "string", "format": "date-time" }, "ai_commodity_value": { "type": "string", "nullable": true }, "ai_doc_id": { "type": "string", "nullable": true }, "vinEmailStatus": { "type": "number" }, "equipmentId": { "type": "number" }, "commoditiesId": { "type": "number" }, "carriersId": { "type": "number" }, "conversionRateUsd": { "type": "number", "nullable": true }, "conversionRateCsd": { "type": "number", "nullable": true }, "carrierRc": { "type": "boolean", "nullable": true }, "shipperRc": { "type": "boolean", "nullable": true }, "bol": { "type": "boolean", "nullable": true }, "apHold": { "type": "boolean", "nullable": true }, "tonuApproval": { "type": "number" }, "loadCof": { "type": "boolean", "nullable": true }, "reminderStatus": { "type": "boolean", "nullable": true }, "managerId": { "type": "number" }, "teamId": { "type": "number" }, "refPortalId": { "type": "number" }, "holdCarrierAmt": { "type": "boolean", "nullable": true }, "created": { "type": "string", "format": "date-time" }, "modified": { "type": "string", "format": "date-time" }, "verifyCommodity": { "type": "number" }, "verifyCpr": { "type": "number" }, "verifyVinNumber": { "type": "number" }, "verifyPickupPhone": { "type": "number" }, "userId": { "type": "number" }, "portalId": { "type": "number" }, "shippersId": { "type": "number" }, "managerComments": { "type": "string", "nullable": true }, "managerApproveId": { "type": "number" }, "invMarginStatus": { "type": "number" }, "invCommunicationType": { "type": "number" }, "invCommunicationApproveId": { "type": "number" }, "credit_exception": { "type": "number" }, "rateNotFinalizedDrayageStatus": { "type": "number", "nullable": true }, "rateNotFinalizedDrayageComment": { "type": "string", "nullable": true } }, "required": [ "shipmentNo", "uid", "status", "commodityValue", "carrierPayMode", "shipperPayMode", "carrierPrice", "carrierPriceCad", "shipperPrice", "shipperPriceCad", "carrierPriceType", "shipperPriceType" ], "additionalProperties": false, "x-typescript-type": "Omit" }, "ShipmentPartial": { "title": "ShipmentPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number" }, "shipmentNo": { "type": "number" }, "uid": { "type": "string" }, "status": { "type": "number" }, "tonuStatus": { "type": "number" }, "loadNo": { "type": "string" }, "containerNo": { "type": "string" }, "loadType": { "type": "string" }, "cdlNumber": { "type": "string", "nullable": true }, "vinNumber": { "type": "string", "nullable": true }, "pickupPhone": { "type": "string", "nullable": true }, "brokerSelfConfirmation": { "type": "string", "nullable": true }, "mc": { "type": "string", "nullable": true }, "dot": { "type": "string", "nullable": true }, "nsc": { "type": "string", "nullable": true }, "ar_gtg": { "type": "number" }, "ap_gtg": { "type": "number" }, "aone_ff_sync": { "type": "number" }, "cmt": { "type": "boolean" }, "commodityValue": { "type": "number" }, "weight": { "type": "string", "nullable": true }, "mode": { "type": "string" }, "footage": { "type": "string", "nullable": true }, "pallet": { "type": "number", "nullable": true }, "miles": { "type": "number", "nullable": true }, "minTemp": { "type": "string", "nullable": true }, "maxTemp": { "type": "string", "nullable": true }, "precoolTemp": { "type": "string", "nullable": true }, "carrierPayMode": { "type": "number" }, "shipperPayMode": { "type": "number" }, "carrierCommunicationPortalid": { "type": "number" }, "carrierInstrctions": { "type": "string" }, "shipperInstrctions": { "type": "string" }, "carrierPrice": { "type": "number" }, "carrierPriceCad": { "type": "number" }, "shipperPrice": { "type": "number" }, "shipperPriceCad": { "type": "number" }, "carrierPriceType": { "type": "number" }, "shipperPriceType": { "type": "number" }, "carrierUint": { "type": "number", "nullable": true }, "carrierUnitPrice": { "type": "number", "nullable": true }, "ShipperUnit": { "type": "number", "nullable": true }, "shipperUnitPrice": { "type": "number", "nullable": true }, "billingDetail": { "type": "object", "nullable": true }, "auditComment": { "type": "string", "nullable": true }, "VinPickupPhoneComment": { "type": "string", "nullable": true }, "auditCreatedAt": { "type": "string", "format": "date-time" }, "auditVinNumberCreatedAt": { "type": "string", "format": "date-time" }, "ai_commodity_value": { "type": "string", "nullable": true }, "ai_doc_id": { "type": "string", "nullable": true }, "vinEmailStatus": { "type": "number" }, "equipmentId": { "type": "number" }, "commoditiesId": { "type": "number" }, "carriersId": { "type": "number" }, "conversionRateUsd": { "type": "number", "nullable": true }, "conversionRateCsd": { "type": "number", "nullable": true }, "carrierRc": { "type": "boolean", "nullable": true }, "shipperRc": { "type": "boolean", "nullable": true }, "bol": { "type": "boolean", "nullable": true }, "apHold": { "type": "boolean", "nullable": true }, "tonuApproval": { "type": "number" }, "loadCof": { "type": "boolean", "nullable": true }, "reminderStatus": { "type": "boolean", "nullable": true }, "managerId": { "type": "number" }, "teamId": { "type": "number" }, "refPortalId": { "type": "number" }, "holdCarrierAmt": { "type": "boolean", "nullable": true }, "created": { "type": "string", "format": "date-time" }, "modified": { "type": "string", "format": "date-time" }, "verifyCommodity": { "type": "number" }, "verifyCpr": { "type": "number" }, "verifyVinNumber": { "type": "number" }, "verifyPickupPhone": { "type": "number" }, "userId": { "type": "number" }, "portalId": { "type": "number" }, "shippersId": { "type": "number" }, "managerComments": { "type": "string", "nullable": true }, "managerApproveId": { "type": "number" }, "invMarginStatus": { "type": "number" }, "invCommunicationType": { "type": "number" }, "invCommunicationApproveId": { "type": "number" }, "credit_exception": { "type": "number" }, "rateNotFinalizedDrayageStatus": { "type": "number", "nullable": true }, "rateNotFinalizedDrayageComment": { "type": "string", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "ShipmentTracking": { "title": "ShipmentTracking", "type": "object", "properties": { "id": { "type": "number" }, "byServer": { "type": "number", "nullable": true }, "trackingId": { "type": "string" }, "mapLink": { "type": "string" }, "timeStamp": { "type": "string", "format": "date-time" }, "trackingMethod": { "type": "string" }, "statusPageLink": { "type": "string" }, "trackingStatus": { "type": "string" }, "uid": { "type": "string" }, "latitude": { "type": "number", "nullable": true }, "longitude": { "type": "number", "nullable": true }, "accuracy": { "type": "number", "nullable": true }, "code": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "address": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "lastlocationUpdate": { "type": "string", "format": "date-time", "nullable": true }, "shipmentId": { "type": "number" } }, "required": [ "trackingId" ], "additionalProperties": false }, "ShipmentTrackingWithRelations": { "title": "ShipmentTrackingWithRelations", "type": "object", "description": "(tsType: ShipmentTrackingWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "byServer": { "type": "number", "nullable": true }, "trackingId": { "type": "string" }, "mapLink": { "type": "string" }, "timeStamp": { "type": "string", "format": "date-time" }, "trackingMethod": { "type": "string" }, "statusPageLink": { "type": "string" }, "trackingStatus": { "type": "string" }, "uid": { "type": "string" }, "latitude": { "type": "number", "nullable": true }, "longitude": { "type": "number", "nullable": true }, "accuracy": { "type": "number", "nullable": true }, "code": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "address": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "lastlocationUpdate": { "type": "string", "format": "date-time", "nullable": true }, "shipmentId": { "type": "number" }, "shipment": { "$ref": "#/components/schemas/ShipmentWithRelations" }, "foreignKey": {} }, "required": [ "trackingId" ], "additionalProperties": false, "x-typescript-type": "ShipmentTrackingWithRelations" }, "ShipmentTrackingPartial": { "title": "ShipmentTrackingPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number" }, "byServer": { "type": "number", "nullable": true }, "trackingId": { "type": "string" }, "mapLink": { "type": "string" }, "timeStamp": { "type": "string", "format": "date-time" }, "trackingMethod": { "type": "string" }, "statusPageLink": { "type": "string" }, "trackingStatus": { "type": "string" }, "uid": { "type": "string" }, "latitude": { "type": "number", "nullable": true }, "longitude": { "type": "number", "nullable": true }, "accuracy": { "type": "number", "nullable": true }, "code": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "address": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "lastlocationUpdate": { "type": "string", "format": "date-time", "nullable": true }, "shipmentId": { "type": "number" } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "NewSignDocInShipment": { "title": "NewSignDocInShipment", "type": "object", "description": "(tsType: @loopback/repository-json-schema#Optional, 'shipmentId'>, schemaOptions: { title: 'NewSignDocInShipment', exclude: [ 'id' ], optional: [ 'shipmentId' ] })", "properties": { "uid": { "type": "string" }, "document": { "type": "string" }, "signedDoc": { "type": "string" }, "shipmentId": { "type": "number" }, "emailFrom": { "type": "string" }, "emailTo": { "type": "string" }, "docType": { "type": "string" }, "subject": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "number", "enum": [ 0, 1, 2 ] }, "carrierLoginId": { "type": "number" }, "portalId": { "type": "number" }, "container": { "type": "string" }, "readStatus": { "type": "number" }, "created": { "type": "string", "format": "date-time" }, "updated": { "type": "string", "format": "date-time" } }, "required": [ "uid", "document", "status" ], "additionalProperties": false, "x-typescript-type": "@loopback/repository-json-schema#Optional, 'shipmentId'>" }, "SignDocPartial": { "title": "SignDocPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number" }, "uid": { "type": "string" }, "document": { "type": "string" }, "signedDoc": { "type": "string" }, "shipmentId": { "type": "number" }, "emailFrom": { "type": "string" }, "emailTo": { "type": "string" }, "docType": { "type": "string" }, "subject": { "type": "string" }, "message": { "type": "string" }, "status": { "type": "number", "enum": [ 0, 1, 2 ] }, "carrierLoginId": { "type": "number" }, "portalId": { "type": "number" }, "container": { "type": "string" }, "readStatus": { "type": "number" }, "created": { "type": "string", "format": "date-time" }, "updated": { "type": "string", "format": "date-time" } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "ShipmentTimeline": { "title": "ShipmentTimeline", "type": "object", "properties": { "id": { "type": "number" }, "status": { "type": "string" }, "date": { "type": "string", "format": "date-time" }, "msg": { "type": "string" }, "shipmentId": { "type": "number" } }, "required": [ "status", "date" ], "additionalProperties": false }, "NewShipmentTimelineInShipment": { "title": "NewShipmentTimelineInShipment", "type": "object", "description": "(tsType: @loopback/repository-json-schema#Optional, 'shipmentId'>, schemaOptions: { title: 'NewShipmentTimelineInShipment', exclude: [ 'id' ], optional: [ 'shipmentId' ] })", "properties": { "status": { "type": "string" }, "date": { "type": "string", "format": "date-time" }, "msg": { "type": "string" }, "shipmentId": { "type": "number" } }, "required": [ "status", "date" ], "additionalProperties": false, "x-typescript-type": "@loopback/repository-json-schema#Optional, 'shipmentId'>" }, "ShipmentTimelinePartial": { "title": "ShipmentTimelinePartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number" }, "status": { "type": "string" }, "date": { "type": "string", "format": "date-time" }, "msg": { "type": "string" }, "shipmentId": { "type": "number" } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "ShipmentPrice": { "title": "ShipmentPrice", "type": "object", "properties": { "id": { "type": "number" }, "label": { "type": "string" }, "cusd": { "type": "number", "nullable": true }, "ccad": { "type": "number", "nullable": true }, "susd": { "type": "number", "nullable": true }, "scad": { "type": "number", "nullable": true }, "created": { "type": "string", "format": "date-time" }, "modified": { "type": "string", "format": "date-time" }, "shipmentId": { "type": "number" } }, "required": [ "label" ], "additionalProperties": false }, "NewShipmentPriceInShipment": { "title": "NewShipmentPriceInShipment", "type": "object", "description": "(tsType: @loopback/repository-json-schema#Optional, 'shipmentId'>, schemaOptions: { title: 'NewShipmentPriceInShipment', exclude: [ 'id' ], optional: [ 'shipmentId' ] })", "properties": { "label": { "type": "string" }, "cusd": { "type": "number", "nullable": true }, "ccad": { "type": "number", "nullable": true }, "susd": { "type": "number", "nullable": true }, "scad": { "type": "number", "nullable": true }, "created": { "type": "string", "format": "date-time" }, "modified": { "type": "string", "format": "date-time" }, "shipmentId": { "type": "number" } }, "required": [ "label" ], "additionalProperties": false, "x-typescript-type": "@loopback/repository-json-schema#Optional, 'shipmentId'>" }, "ShipmentPricePartial": { "title": "ShipmentPricePartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number" }, "label": { "type": "string" }, "cusd": { "type": "number", "nullable": true }, "ccad": { "type": "number", "nullable": true }, "susd": { "type": "number", "nullable": true }, "scad": { "type": "number", "nullable": true }, "created": { "type": "string", "format": "date-time" }, "modified": { "type": "string", "format": "date-time" }, "shipmentId": { "type": "number" } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "ShipmentPicks": { "title": "ShipmentPicks", "type": "object", "properties": { "id": { "type": "number" }, "index": { "type": "number", "nullable": true }, "name": { "type": "string", "nullable": true }, "address": { "type": "string", "nullable": true }, "contact": { "type": "string", "nullable": true }, "ref": { "type": "string" }, "oldPickId": { "type": "number", "nullable": true }, "phone": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "pickupDate": { "type": "string", "format": "date-time" }, "dateonly": { "type": "boolean", "nullable": true }, "apptDate": { "type": "string", "format": "date-time", "nullable": true }, "apptNote": { "type": "string" }, "created": { "type": "string", "format": "date-time" }, "modified": { "type": "string", "format": "date-time" }, "shipmentId": { "type": "number" }, "zipCodesId": { "type": "number" } }, "required": [ "ref", "pickupDate" ], "additionalProperties": false }, "NewShipmentPicksInShipment": { "title": "NewShipmentPicksInShipment", "type": "object", "description": "(tsType: @loopback/repository-json-schema#Optional, 'shipmentId'>, schemaOptions: { title: 'NewShipmentPicksInShipment', exclude: [ 'id' ], optional: [ 'shipmentId' ] })", "properties": { "index": { "type": "number", "nullable": true }, "name": { "type": "string", "nullable": true }, "address": { "type": "string", "nullable": true }, "contact": { "type": "string", "nullable": true }, "ref": { "type": "string" }, "oldPickId": { "type": "number", "nullable": true }, "phone": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "pickupDate": { "type": "string", "format": "date-time" }, "dateonly": { "type": "boolean", "nullable": true }, "apptDate": { "type": "string", "format": "date-time", "nullable": true }, "apptNote": { "type": "string" }, "created": { "type": "string", "format": "date-time" }, "modified": { "type": "string", "format": "date-time" }, "shipmentId": { "type": "number" }, "zipCodesId": { "type": "number" } }, "required": [ "ref", "pickupDate" ], "additionalProperties": false, "x-typescript-type": "@loopback/repository-json-schema#Optional, 'shipmentId'>" }, "ShipmentPicksPartial": { "title": "ShipmentPicksPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number" }, "index": { "type": "number", "nullable": true }, "name": { "type": "string", "nullable": true }, "address": { "type": "string", "nullable": true }, "contact": { "type": "string", "nullable": true }, "ref": { "type": "string" }, "oldPickId": { "type": "number", "nullable": true }, "phone": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "pickupDate": { "type": "string", "format": "date-time" }, "dateonly": { "type": "boolean", "nullable": true }, "apptDate": { "type": "string", "format": "date-time", "nullable": true }, "apptNote": { "type": "string" }, "created": { "type": "string", "format": "date-time" }, "modified": { "type": "string", "format": "date-time" }, "shipmentId": { "type": "number" }, "zipCodesId": { "type": "number" } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "ShipmentDrops": { "title": "ShipmentDrops", "type": "object", "properties": { "id": { "type": "number" }, "index": { "type": "number", "nullable": true }, "name": { "type": "string", "nullable": true }, "address": { "type": "string", "nullable": true }, "contact": { "type": "string", "nullable": true }, "ref": { "type": "string", "nullable": true }, "phone": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "dropDate": { "type": "string", "format": "date-time" }, "dateonly": { "type": "boolean", "nullable": true }, "zipCodesId": { "type": "number" }, "apptDate": { "type": "string", "format": "date-time", "nullable": true }, "emptyDate": { "type": "string", "format": "date-time", "nullable": true }, "apptNote": { "type": "string" }, "oldDropId": { "type": "number" }, "created": { "type": "string", "format": "date-time" }, "modified": { "type": "string", "format": "date-time" }, "shipmentId": { "type": "number" } }, "required": [ "dropDate" ], "additionalProperties": false }, "NewShipmentDropsInShipment": { "title": "NewShipmentDropsInShipment", "type": "object", "description": "(tsType: @loopback/repository-json-schema#Optional, 'shipmentId'>, schemaOptions: { title: 'NewShipmentDropsInShipment', exclude: [ 'id' ], optional: [ 'shipmentId' ] })", "properties": { "index": { "type": "number", "nullable": true }, "name": { "type": "string", "nullable": true }, "address": { "type": "string", "nullable": true }, "contact": { "type": "string", "nullable": true }, "ref": { "type": "string", "nullable": true }, "phone": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "dropDate": { "type": "string", "format": "date-time" }, "dateonly": { "type": "boolean", "nullable": true }, "zipCodesId": { "type": "number" }, "apptDate": { "type": "string", "format": "date-time", "nullable": true }, "emptyDate": { "type": "string", "format": "date-time", "nullable": true }, "apptNote": { "type": "string" }, "oldDropId": { "type": "number" }, "created": { "type": "string", "format": "date-time" }, "modified": { "type": "string", "format": "date-time" }, "shipmentId": { "type": "number" } }, "required": [ "dropDate" ], "additionalProperties": false, "x-typescript-type": "@loopback/repository-json-schema#Optional, 'shipmentId'>" }, "ShipmentDropsPartial": { "title": "ShipmentDropsPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number" }, "index": { "type": "number", "nullable": true }, "name": { "type": "string", "nullable": true }, "address": { "type": "string", "nullable": true }, "contact": { "type": "string", "nullable": true }, "ref": { "type": "string", "nullable": true }, "phone": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "dropDate": { "type": "string", "format": "date-time" }, "dateonly": { "type": "boolean", "nullable": true }, "zipCodesId": { "type": "number" }, "apptDate": { "type": "string", "format": "date-time", "nullable": true }, "emptyDate": { "type": "string", "format": "date-time", "nullable": true }, "apptNote": { "type": "string" }, "oldDropId": { "type": "number" }, "created": { "type": "string", "format": "date-time" }, "modified": { "type": "string", "format": "date-time" }, "shipmentId": { "type": "number" } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "ShipmentDocs": { "title": "ShipmentDocs", "type": "object", "properties": { "id": { "type": "number" }, "url": { "type": "string" }, "type": { "type": "string" }, "PortalBased": { "type": "string" }, "created": { "type": "string", "format": "date-time" }, "modified": { "type": "string", "format": "date-time" }, "shipmentId": { "type": "number" }, "userId": { "type": "number" } }, "required": [ "url", "type" ], "additionalProperties": false }, "NewShipmentDocsInShipment": { "title": "NewShipmentDocsInShipment", "type": "object", "description": "(tsType: @loopback/repository-json-schema#Optional, 'shipmentId'>, schemaOptions: { title: 'NewShipmentDocsInShipment', exclude: [ 'id' ], optional: [ 'shipmentId' ] })", "properties": { "url": { "type": "string" }, "type": { "type": "string" }, "PortalBased": { "type": "string" }, "created": { "type": "string", "format": "date-time" }, "modified": { "type": "string", "format": "date-time" }, "shipmentId": { "type": "number" }, "userId": { "type": "number" } }, "required": [ "url", "type" ], "additionalProperties": false, "x-typescript-type": "@loopback/repository-json-schema#Optional, 'shipmentId'>" }, "ShipmentDocsPartial": { "title": "ShipmentDocsPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number" }, "url": { "type": "string" }, "type": { "type": "string" }, "PortalBased": { "type": "string" }, "created": { "type": "string", "format": "date-time" }, "modified": { "type": "string", "format": "date-time" }, "shipmentId": { "type": "number" }, "userId": { "type": "number" } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "ShipmentDetails": { "title": "ShipmentDetails", "type": "object", "properties": { "id": { "type": "number" }, "insuranceEmail": { "type": "string" }, "AoneFFPriceQuoteNo": { "type": "string" }, "AoneFFShipmentLoadNo": { "type": "string" }, "invoiceMarginStatus": { "type": "number" }, "loadStatus": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time" }, "shipmentId": { "type": "number" } }, "additionalProperties": false }, "NewShipmentDetailsInShipment": { "title": "NewShipmentDetailsInShipment", "type": "object", "description": "(tsType: @loopback/repository-json-schema#Optional, 'shipmentId'>, schemaOptions: { title: 'NewShipmentDetailsInShipment', exclude: [ 'id' ], optional: [ 'shipmentId' ] })", "properties": { "insuranceEmail": { "type": "string" }, "AoneFFPriceQuoteNo": { "type": "string" }, "AoneFFShipmentLoadNo": { "type": "string" }, "invoiceMarginStatus": { "type": "number" }, "loadStatus": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time" }, "shipmentId": { "type": "number" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository-json-schema#Optional, 'shipmentId'>" }, "ShipmentDetailsPartial": { "title": "ShipmentDetailsPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number" }, "insuranceEmail": { "type": "string" }, "AoneFFPriceQuoteNo": { "type": "string" }, "AoneFFShipmentLoadNo": { "type": "string" }, "invoiceMarginStatus": { "type": "number" }, "loadStatus": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time" }, "shipmentId": { "type": "number" } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "ShipmentCarrier": { "title": "ShipmentCarrier", "type": "object", "properties": { "id": { "type": "number" }, "mc": { "type": "string", "nullable": true }, "dot": { "type": "string", "nullable": true }, "nsc": { "type": "string", "nullable": true }, "dispatcher": { "type": "string" }, "name": { "type": "string" }, "address": { "type": "string" }, "phone": { "type": "string" }, "email": { "type": "string" }, "cacciPhone": { "type": "string" }, "cacciEmail": { "type": "string" }, "truck": { "type": "string" }, "trailer": { "type": "string" }, "trailerImg": { "type": "string" }, "driverName": { "type": "string" }, "DriverPhone": { "type": "string" }, "created": { "type": "string", "format": "date-time" }, "modified": { "type": "string", "format": "date-time" }, "shipmentId": { "type": "number" }, "type": { "type": "string" }, "pickCity": { "type": "string" }, "pickState": { "type": "string" }, "dropCity": { "type": "string" }, "dropState": { "type": "string" } }, "required": [ "name" ], "additionalProperties": false }, "NewShipmentCarrierInShipment": { "title": "NewShipmentCarrierInShipment", "type": "object", "description": "(tsType: @loopback/repository-json-schema#Optional, 'shipmentId'>, schemaOptions: { title: 'NewShipmentCarrierInShipment', exclude: [ 'id' ], optional: [ 'shipmentId' ] })", "properties": { "mc": { "type": "string", "nullable": true }, "dot": { "type": "string", "nullable": true }, "nsc": { "type": "string", "nullable": true }, "dispatcher": { "type": "string" }, "name": { "type": "string" }, "address": { "type": "string" }, "phone": { "type": "string" }, "email": { "type": "string" }, "cacciPhone": { "type": "string" }, "cacciEmail": { "type": "string" }, "truck": { "type": "string" }, "trailer": { "type": "string" }, "trailerImg": { "type": "string" }, "driverName": { "type": "string" }, "DriverPhone": { "type": "string" }, "created": { "type": "string", "format": "date-time" }, "modified": { "type": "string", "format": "date-time" }, "shipmentId": { "type": "number" }, "type": { "type": "string" }, "pickCity": { "type": "string" }, "pickState": { "type": "string" }, "dropCity": { "type": "string" }, "dropState": { "type": "string" } }, "required": [ "name" ], "additionalProperties": false, "x-typescript-type": "@loopback/repository-json-schema#Optional, 'shipmentId'>" }, "ShipmentCarrierPartial": { "title": "ShipmentCarrierPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number" }, "mc": { "type": "string", "nullable": true }, "dot": { "type": "string", "nullable": true }, "nsc": { "type": "string", "nullable": true }, "dispatcher": { "type": "string" }, "name": { "type": "string" }, "address": { "type": "string" }, "phone": { "type": "string" }, "email": { "type": "string" }, "cacciPhone": { "type": "string" }, "cacciEmail": { "type": "string" }, "truck": { "type": "string" }, "trailer": { "type": "string" }, "trailerImg": { "type": "string" }, "driverName": { "type": "string" }, "DriverPhone": { "type": "string" }, "created": { "type": "string", "format": "date-time" }, "modified": { "type": "string", "format": "date-time" }, "shipmentId": { "type": "number" }, "type": { "type": "string" }, "pickCity": { "type": "string" }, "pickState": { "type": "string" }, "dropCity": { "type": "string" }, "dropState": { "type": "string" } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "McReVerification": { "title": "McReVerification", "type": "object", "properties": { "id": { "type": "number" }, "portalId": { "type": "number" }, "carrierNumber": { "type": "string" }, "carrierEmail": { "type": "string" }, "mcNumber": { "type": "string", "nullable": true }, "dotNumber": { "type": "string", "nullable": true }, "nscNumber": { "type": "string", "nullable": true }, "smeStatus": { "type": "number" }, "smeId": { "type": "number" }, "sendDate": { "type": "string", "format": "date-time" }, "approvalDate": { "type": "string", "format": "date-time" }, "verifiedType": { "type": "string", "nullable": true }, "shipmentId": { "type": "number" } }, "required": [ "portalId", "carrierEmail", "smeStatus" ], "additionalProperties": false }, "NewMcReVerificationInShipment": { "title": "NewMcReVerificationInShipment", "type": "object", "description": "(tsType: @loopback/repository-json-schema#Optional, 'shipmentId'>, schemaOptions: { title: 'NewMcReVerificationInShipment', exclude: [ 'id' ], optional: [ 'shipmentId' ] })", "properties": { "portalId": { "type": "number" }, "carrierNumber": { "type": "string" }, "carrierEmail": { "type": "string" }, "mcNumber": { "type": "string", "nullable": true }, "dotNumber": { "type": "string", "nullable": true }, "nscNumber": { "type": "string", "nullable": true }, "smeStatus": { "type": "number" }, "smeId": { "type": "number" }, "sendDate": { "type": "string", "format": "date-time" }, "approvalDate": { "type": "string", "format": "date-time" }, "verifiedType": { "type": "string", "nullable": true }, "shipmentId": { "type": "number" } }, "required": [ "portalId", "carrierEmail", "smeStatus" ], "additionalProperties": false, "x-typescript-type": "@loopback/repository-json-schema#Optional, 'shipmentId'>" }, "McReVerificationPartial": { "title": "McReVerificationPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number" }, "portalId": { "type": "number" }, "carrierNumber": { "type": "string" }, "carrierEmail": { "type": "string" }, "mcNumber": { "type": "string", "nullable": true }, "dotNumber": { "type": "string", "nullable": true }, "nscNumber": { "type": "string", "nullable": true }, "smeStatus": { "type": "number" }, "smeId": { "type": "number" }, "sendDate": { "type": "string", "format": "date-time" }, "approvalDate": { "type": "string", "format": "date-time" }, "verifiedType": { "type": "string", "nullable": true }, "shipmentId": { "type": "number" } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "NewInvoicesInShipment": { "title": "NewInvoicesInShipment", "type": "object", "description": "(tsType: @loopback/repository-json-schema#Optional, 'shipmentId'>, schemaOptions: { title: 'NewInvoicesInShipment', exclude: [ 'id' ], optional: [ 'shipmentId' ] })", "properties": { "uid": { "type": "string" }, "shipmentId": { "type": "number" }, "shippersId": { "type": "number" }, "userId": { "type": "number" }, "portalId": { "type": "number" }, "ArUserID": { "type": "number" }, "doc": { "type": "string", "nullable": true }, "invoicePayment": { "type": "number" }, "balance": { "type": "number" }, "paid": { "type": "number", "nullable": true }, "oldInvoiceId": { "type": "number", "nullable": true }, "payStatus": { "type": "number" }, "assignStatus": { "type": "number" }, "status": { "type": "number" }, "collectionStatus": { "type": "number" }, "aceFreight": { "type": "string", "nullable": true }, "assignTo": { "type": "number" }, "comments": { "type": "string", "nullable": true }, "invoiceDate": { "type": "string", "format": "date-time" }, "regenerateDate": { "type": "string", "format": "date-time" }, "regenerateStatus": { "type": "number" }, "emailStatus": { "type": "number" }, "lastReceivedDate": { "type": "string", "format": "date-time" }, "created": { "type": "string", "format": "date-time" }, "payMode": { "type": "string", "nullable": true }, "writeOffType": { "type": "string", "nullable": true }, "calim_received_percentage": { "type": "number", "nullable": true }, "customerInsurance": { "type": "string", "nullable": true }, "qb_status": { "type": "string", "nullable": true }, "qb_doc_number": { "type": "string", "nullable": true }, "oldQb": { "type": "string" }, "aceAsiStatus": { "type": "number" }, "aceAsiQBStatus": { "type": "string", "nullable": true }, "ace_qb_bill_status": { "type": "string" }, "ace_qb_bill_id": { "type": "number" }, "asi_qb_bill_status": { "type": "string" }, "asi_qb_bill_id": { "type": "number" }, "ecapitalPercentage": { "type": "number" } }, "required": [ "uid" ], "additionalProperties": false, "x-typescript-type": "@loopback/repository-json-schema#Optional, 'shipmentId'>" }, "GtgHistory": { "title": "GtgHistory", "type": "object", "properties": { "id": { "type": "number" }, "message": { "type": "string" }, "date": { "type": "string", "format": "date-time" }, "for": { "type": "number", "enum": [ 0, 1 ] }, "userId": { "type": "number" }, "shipmentId": { "type": "number" } }, "additionalProperties": false }, "NewGtgHistoryInShipment": { "title": "NewGtgHistoryInShipment", "type": "object", "description": "(tsType: @loopback/repository-json-schema#Optional, 'shipmentId'>, schemaOptions: { title: 'NewGtgHistoryInShipment', exclude: [ 'id' ], optional: [ 'shipmentId' ] })", "properties": { "message": { "type": "string" }, "date": { "type": "string", "format": "date-time" }, "for": { "type": "number", "enum": [ 0, 1 ] }, "userId": { "type": "number" }, "shipmentId": { "type": "number" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository-json-schema#Optional, 'shipmentId'>" }, "GtgHistoryPartial": { "title": "GtgHistoryPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number" }, "message": { "type": "string" }, "date": { "type": "string", "format": "date-time" }, "for": { "type": "number", "enum": [ 0, 1 ] }, "userId": { "type": "number" }, "shipmentId": { "type": "number" } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "GoodToGoHistory": { "title": "GoodToGoHistory", "type": "object", "properties": { "good_to_go_history_id": { "type": "number" }, "user_id": { "type": "number" }, "by_name": { "type": "string" }, "shipment_id": { "type": "number" }, "carriers_id": { "type": "number" }, "companies_id": { "type": "number" }, "comment": { "type": "string" }, "team": { "type": "number" }, "date_time": { "type": "string" }, "ap_hold_status": {}, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } }, "required": [ "companies_id", "comment", "team", "ap_hold_status", "created_at", "updated_at" ], "additionalProperties": false }, "ShipmentPicksWithRelations": { "title": "ShipmentPicksWithRelations", "type": "object", "description": "(tsType: ShipmentPicksWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "index": { "type": "number", "nullable": true }, "name": { "type": "string", "nullable": true }, "address": { "type": "string", "nullable": true }, "contact": { "type": "string", "nullable": true }, "ref": { "type": "string" }, "oldPickId": { "type": "number", "nullable": true }, "phone": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "pickupDate": { "type": "string", "format": "date-time" }, "dateonly": { "type": "boolean", "nullable": true }, "apptDate": { "type": "string", "format": "date-time", "nullable": true }, "apptNote": { "type": "string" }, "created": { "type": "string", "format": "date-time" }, "modified": { "type": "string", "format": "date-time" }, "shipmentId": { "type": "number" }, "zipCodesId": { "type": "number" }, "shipment": { "$ref": "#/components/schemas/ShipmentWithRelations" }, "foreignKey": {}, "city": { "$ref": "#/components/schemas/ZipCodesWithRelations" } }, "required": [ "ref", "pickupDate" ], "additionalProperties": false, "x-typescript-type": "ShipmentPicksWithRelations" }, "NewCarrierPaymentInShipment": { "title": "NewCarrierPaymentInShipment", "type": "object", "description": "(tsType: @loopback/repository-json-schema#Optional, 'shipmentId'>, schemaOptions: { title: 'NewCarrierPaymentInShipment', exclude: [ 'id' ], optional: [ 'shipmentId' ] })", "properties": { "agingDate": { "type": "string", "format": "date-time" }, "paymentInitiated": { "type": "string", "format": "date-time", "nullable": true }, "attachment": { "type": "string" }, "notes": { "type": "string", "nullable": true }, "paymentStatus": { "type": "number" }, "brokerName": { "type": "string", "nullable": true }, "qpStatus": { "type": "number" }, "amountUsd": { "type": "number" }, "amountCad": { "type": "number" }, "paymentType": { "type": "number" }, "paymentMethod": { "type": "string" }, "payTo": { "type": "number" }, "subject": { "type": "string", "nullable": true }, "message": { "type": "string", "nullable": true }, "qb_id": { "type": "string" }, "qb_status": { "type": "number" }, "doc_number": { "type": "string" }, "VlAsiDocNumber": { "type": "string" }, "oldPaymentDate": { "type": "string", "format": "date-time", "nullable": true }, "shipmentId": { "type": "number" }, "carriersId": { "type": "number" }, "userId": { "type": "number" }, "apId": { "type": "number" }, "portalId": { "type": "number" }, "carrierAgingId": { "type": "number" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository-json-schema#Optional, 'shipmentId'>" }, "CarrierAging": { "title": "CarrierAging", "type": "object", "properties": { "id": { "type": "number" }, "ap_agent_id": { "type": "number" }, "age_date": { "type": "string", "format": "date-time" }, "invoice_number": { "type": "string" }, "invoice_date": { "type": "string", "format": "date-time" }, "advance_payment_date": { "type": "string", "format": "date-time" }, "advance_pay_usd": { "type": "number" }, "advance_pay_cad": { "type": "number" }, "advance_pay_type": { "type": "string" }, "advance_pay_status": { "type": "number" }, "payable_amount_usd": { "type": "number" }, "payable_amount_cad": { "type": "number" }, "quick_book_invoice_status": { "type": "number" }, "quick_book_invoice_date": { "type": "string", "format": "date-time" }, "request_status": { "type": "number", "nullable": true }, "advance_pay_label": { "type": "string" }, "message": { "type": "string" }, "quick_pay": { "type": "number" }, "carriersId": { "type": "number" }, "userId": { "type": "number" }, "portalId": { "type": "number" }, "shipmentId": { "type": "number" }, "auditCreatedAt": { "type": "string", "format": "date-time" }, "auditComment": { "type": "string", "nullable": true }, "auditStatus": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "NewCarrierAgingInShipment": { "title": "NewCarrierAgingInShipment", "type": "object", "description": "(tsType: @loopback/repository-json-schema#Optional, 'shipmentId'>, schemaOptions: { title: 'NewCarrierAgingInShipment', exclude: [ 'id' ], optional: [ 'shipmentId' ] })", "properties": { "ap_agent_id": { "type": "number" }, "age_date": { "type": "string", "format": "date-time" }, "invoice_number": { "type": "string" }, "invoice_date": { "type": "string", "format": "date-time" }, "advance_payment_date": { "type": "string", "format": "date-time" }, "advance_pay_usd": { "type": "number" }, "advance_pay_cad": { "type": "number" }, "advance_pay_type": { "type": "string" }, "advance_pay_status": { "type": "number" }, "payable_amount_usd": { "type": "number" }, "payable_amount_cad": { "type": "number" }, "quick_book_invoice_status": { "type": "number" }, "quick_book_invoice_date": { "type": "string", "format": "date-time" }, "request_status": { "type": "number", "nullable": true }, "advance_pay_label": { "type": "string" }, "message": { "type": "string" }, "quick_pay": { "type": "number" }, "carriersId": { "type": "number" }, "userId": { "type": "number" }, "portalId": { "type": "number" }, "shipmentId": { "type": "number" }, "auditCreatedAt": { "type": "string", "format": "date-time" }, "auditComment": { "type": "string", "nullable": true }, "auditStatus": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository-json-schema#Optional, 'shipmentId'>" }, "CarrierAgingPartial": { "title": "CarrierAgingPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number" }, "ap_agent_id": { "type": "number" }, "age_date": { "type": "string", "format": "date-time" }, "invoice_number": { "type": "string" }, "invoice_date": { "type": "string", "format": "date-time" }, "advance_payment_date": { "type": "string", "format": "date-time" }, "advance_pay_usd": { "type": "number" }, "advance_pay_cad": { "type": "number" }, "advance_pay_type": { "type": "string" }, "advance_pay_status": { "type": "number" }, "payable_amount_usd": { "type": "number" }, "payable_amount_cad": { "type": "number" }, "quick_book_invoice_status": { "type": "number" }, "quick_book_invoice_date": { "type": "string", "format": "date-time" }, "request_status": { "type": "number", "nullable": true }, "advance_pay_label": { "type": "string" }, "message": { "type": "string" }, "quick_pay": { "type": "number" }, "carriersId": { "type": "number" }, "userId": { "type": "number" }, "portalId": { "type": "number" }, "shipmentId": { "type": "number" }, "auditCreatedAt": { "type": "string", "format": "date-time" }, "auditComment": { "type": "string", "nullable": true }, "auditStatus": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "AuditVerifyCpr": { "title": "AuditVerifyCpr", "type": "object", "properties": { "id": { "type": "number" }, "type": { "type": "string" }, "comment": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "shipmentId": { "type": "number" }, "userId": { "type": "number" } }, "additionalProperties": false }, "NewAuditVerifyCprInShipment": { "title": "NewAuditVerifyCprInShipment", "type": "object", "description": "(tsType: @loopback/repository-json-schema#Optional, 'shipmentId'>, schemaOptions: { title: 'NewAuditVerifyCprInShipment', exclude: [ 'id' ], optional: [ 'shipmentId' ] })", "properties": { "type": { "type": "string" }, "comment": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "shipmentId": { "type": "number" }, "userId": { "type": "number" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository-json-schema#Optional, 'shipmentId'>" }, "AuditVerifyCprPartial": { "title": "AuditVerifyCprPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number" }, "type": { "type": "string" }, "comment": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "shipmentId": { "type": "number" }, "userId": { "type": "number" } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "AuditVerifyCommodity": { "title": "AuditVerifyCommodity", "type": "object", "properties": { "id": { "type": "number" }, "type": { "type": "string" }, "comment": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "shipmentId": { "type": "number" }, "userId": { "type": "number" } }, "additionalProperties": false }, "NewAuditVerifyCommodityInShipment": { "title": "NewAuditVerifyCommodityInShipment", "type": "object", "description": "(tsType: @loopback/repository-json-schema#Optional, 'shipmentId'>, schemaOptions: { title: 'NewAuditVerifyCommodityInShipment', exclude: [ 'id' ], optional: [ 'shipmentId' ] })", "properties": { "type": { "type": "string" }, "comment": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "shipmentId": { "type": "number" }, "userId": { "type": "number" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository-json-schema#Optional, 'shipmentId'>" }, "AuditVerifyCommodityPartial": { "title": "AuditVerifyCommodityPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number" }, "type": { "type": "string" }, "comment": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "shipmentId": { "type": "number" }, "userId": { "type": "number" } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "ApIncentive": { "title": "ApIncentive", "type": "object", "properties": { "id": { "type": "number" }, "diliveryDate": { "type": "string", "format": "date-time" }, "podDate": { "type": "string", "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" }, "readyToInvoiceDate": { "type": "string", "format": "date-time" }, "ages": { "type": "number" }, "loadType": { "type": "string" }, "broker": { "type": "string" }, "apTeam": { "type": "string" }, "shipmentId": { "type": "number" }, "userId": { "type": "number" } }, "additionalProperties": false }, "NewApIncentiveInShipment": { "title": "NewApIncentiveInShipment", "type": "object", "description": "(tsType: @loopback/repository-json-schema#Optional, 'shipmentId'>, schemaOptions: { title: 'NewApIncentiveInShipment', exclude: [ 'id' ], optional: [ 'shipmentId' ] })", "properties": { "diliveryDate": { "type": "string", "format": "date-time" }, "podDate": { "type": "string", "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" }, "readyToInvoiceDate": { "type": "string", "format": "date-time" }, "ages": { "type": "number" }, "loadType": { "type": "string" }, "broker": { "type": "string" }, "apTeam": { "type": "string" }, "shipmentId": { "type": "number" }, "userId": { "type": "number" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository-json-schema#Optional, 'shipmentId'>" }, "ApIncentivePartial": { "title": "ApIncentivePartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number" }, "diliveryDate": { "type": "string", "format": "date-time" }, "podDate": { "type": "string", "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" }, "readyToInvoiceDate": { "type": "string", "format": "date-time" }, "ages": { "type": "number" }, "loadType": { "type": "string" }, "broker": { "type": "string" }, "apTeam": { "type": "string" }, "shipmentId": { "type": "number" }, "userId": { "type": "number" } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "NewUserInRole": { "title": "NewUserInRole", "type": "object", "description": "(tsType: @loopback/repository-json-schema#Optional, 'roleId'>, schemaOptions: { title: 'NewUserInRole', exclude: [ 'id' ], optional: [ 'roleId' ] })", "properties": { "name": { "type": "string" }, "first_name": { "type": "string", "nullable": true }, "last_name": { "type": "string", "nullable": true }, "real_name": { "type": "string", "nullable": true }, "phone": { "type": "string", "nullable": true }, "ext": { "type": "string", "nullable": true }, "fax": { "type": "string", "nullable": true }, "avatar": { "type": "string", "nullable": true }, "status": { "type": "number", "enum": [ 0, 1, 2 ] }, "optNumber": { "type": "string", "nullable": true }, "twoFactor": { "type": "number", "enum": [ 0, 1 ] }, "arTypeUser": { "type": "number", "enum": [ 0, 1 ] }, "email_verified_at": { "type": "string", "format": "date-time" }, "email": { "type": "string" }, "AccEmail": { "type": "string", "nullable": true }, "password": { "type": "string" }, "realPassword": { "type": "string" }, "created": { "type": "string", "format": "date-time" }, "modified": { "type": "string", "format": "date-time" }, "realm": { "type": "string", "nullable": true }, "username": { "type": "string", "nullable": true }, "emailVerified": { "type": "boolean" }, "verificationToken": { "type": "boolean" }, "type": { "type": "number" }, "drayage": { "type": "boolean" }, "s_gross": { "type": "number" }, "BrokerPolicyDate": { "type": "string", "format": "date-time" }, "brokerIncentivePolicy": { "type": "number", "enum": [ 0, 1 ] }, "vl_user": { "type": "string", "nullable": true }, "vl_phone": { "type": "string", "nullable": true }, "vl_fax": { "type": "string", "nullable": true }, "vl_ext": { "type": "string", "nullable": true }, "bulkEmailAccess": { "type": "string", "nullable": true }, "onboardingDate": { "type": "string", "format": "date-time" }, "lobType": { "type": "number" }, "attrite": { "type": "number" }, "pipType": { "type": "number" }, "vonage_ext": { "type": "number", "nullable": true }, "aliance_ext": { "type": "number", "nullable": true }, "dids_number": { "type": "string", "nullable": true }, "apId": { "type": "number" }, "employeeId": { "type": "string", "nullable": true }, "socketId": { "type": "string" }, "roleId": { "type": "number" }, "portalId": { "type": "number" } }, "required": [ "name", "status", "twoFactor", "arTypeUser", "email", "password", "type", "brokerIncentivePolicy" ], "additionalProperties": false, "x-typescript-type": "@loopback/repository-json-schema#Optional, 'roleId'>" }, "UserPartial": { "title": "UserPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "first_name": { "type": "string", "nullable": true }, "last_name": { "type": "string", "nullable": true }, "real_name": { "type": "string", "nullable": true }, "phone": { "type": "string", "nullable": true }, "ext": { "type": "string", "nullable": true }, "fax": { "type": "string", "nullable": true }, "avatar": { "type": "string", "nullable": true }, "status": { "type": "number", "enum": [ 0, 1, 2 ] }, "optNumber": { "type": "string", "nullable": true }, "twoFactor": { "type": "number", "enum": [ 0, 1 ] }, "arTypeUser": { "type": "number", "enum": [ 0, 1 ] }, "email_verified_at": { "type": "string", "format": "date-time" }, "email": { "type": "string" }, "AccEmail": { "type": "string", "nullable": true }, "password": { "type": "string" }, "realPassword": { "type": "string" }, "created": { "type": "string", "format": "date-time" }, "modified": { "type": "string", "format": "date-time" }, "realm": { "type": "string", "nullable": true }, "username": { "type": "string", "nullable": true }, "emailVerified": { "type": "boolean" }, "verificationToken": { "type": "boolean" }, "type": { "type": "number" }, "drayage": { "type": "boolean" }, "s_gross": { "type": "number" }, "BrokerPolicyDate": { "type": "string", "format": "date-time" }, "brokerIncentivePolicy": { "type": "number", "enum": [ 0, 1 ] }, "vl_user": { "type": "string", "nullable": true }, "vl_phone": { "type": "string", "nullable": true }, "vl_fax": { "type": "string", "nullable": true }, "vl_ext": { "type": "string", "nullable": true }, "bulkEmailAccess": { "type": "string", "nullable": true }, "onboardingDate": { "type": "string", "format": "date-time" }, "lobType": { "type": "number" }, "attrite": { "type": "number" }, "pipType": { "type": "number" }, "vonage_ext": { "type": "number", "nullable": true }, "aliance_ext": { "type": "number", "nullable": true }, "dids_number": { "type": "string", "nullable": true }, "apId": { "type": "number" }, "employeeId": { "type": "string", "nullable": true }, "socketId": { "type": "string" }, "roleId": { "type": "number" }, "portalId": { "type": "number" } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "RedFlags": { "title": "RedFlags", "type": "object", "properties": { "id": { "type": "number" }, "old_c_total": { "type": "number" }, "old_s_total": { "type": "number" }, "c_total": { "type": "number" }, "s_total": { "type": "number" }, "old_margin": { "type": "number" }, "current_margin": { "type": "number" }, "difference": { "type": "number" }, "change_date": { "type": "string", "format": "date-time" }, "red_for": { "type": "string", "format": "date-time" }, "pickup_date": { "type": "string", "format": "date-time" }, "msg": { "type": "string" }, "apAPId": { "type": "number", "nullable": true }, "ArId": { "type": "number", "nullable": true }, "created_at": { "type": "string", "format": "date-time" }, "redflag_type": { "type": "number" }, "shipmentId": { "type": "number" }, "userId": { "type": "number" } }, "additionalProperties": false }, "NewRedFlags": { "title": "NewRedFlags", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewRedFlags', exclude: [ 'id' ] })", "properties": { "old_c_total": { "type": "number" }, "old_s_total": { "type": "number" }, "c_total": { "type": "number" }, "s_total": { "type": "number" }, "old_margin": { "type": "number" }, "current_margin": { "type": "number" }, "difference": { "type": "number" }, "change_date": { "type": "string", "format": "date-time" }, "red_for": { "type": "string", "format": "date-time" }, "pickup_date": { "type": "string", "format": "date-time" }, "msg": { "type": "string" }, "apAPId": { "type": "number", "nullable": true }, "ArId": { "type": "number", "nullable": true }, "created_at": { "type": "string", "format": "date-time" }, "redflag_type": { "type": "number" }, "shipmentId": { "type": "number" }, "userId": { "type": "number" } }, "additionalProperties": false, "x-typescript-type": "Omit" }, "UserCredentialsWithRelations": { "title": "UserCredentialsWithRelations", "type": "object", "description": "(tsType: UserCredentialsWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "string" }, "password": { "type": "string" }, "userId": { "type": "string" } }, "required": [ "password", "userId" ], "additionalProperties": true, "x-typescript-type": "UserCredentialsWithRelations" }, "RedFlagsWithRelations": { "title": "RedFlagsWithRelations", "type": "object", "description": "(tsType: RedFlagsWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "old_c_total": { "type": "number" }, "old_s_total": { "type": "number" }, "c_total": { "type": "number" }, "s_total": { "type": "number" }, "old_margin": { "type": "number" }, "current_margin": { "type": "number" }, "difference": { "type": "number" }, "change_date": { "type": "string", "format": "date-time" }, "red_for": { "type": "string", "format": "date-time" }, "pickup_date": { "type": "string", "format": "date-time" }, "msg": { "type": "string" }, "apAPId": { "type": "number", "nullable": true }, "ArId": { "type": "number", "nullable": true }, "created_at": { "type": "string", "format": "date-time" }, "redflag_type": { "type": "number" }, "shipmentId": { "type": "number" }, "userId": { "type": "number" }, "shipment": { "$ref": "#/components/schemas/ShipmentWithRelations" }, "foreignKey": {}, "user": { "$ref": "#/components/schemas/UserWithRelations" } }, "additionalProperties": false, "x-typescript-type": "RedFlagsWithRelations" }, "RedFlagsPartial": { "title": "RedFlagsPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number" }, "old_c_total": { "type": "number" }, "old_s_total": { "type": "number" }, "c_total": { "type": "number" }, "s_total": { "type": "number" }, "old_margin": { "type": "number" }, "current_margin": { "type": "number" }, "difference": { "type": "number" }, "change_date": { "type": "string", "format": "date-time" }, "red_for": { "type": "string", "format": "date-time" }, "pickup_date": { "type": "string", "format": "date-time" }, "msg": { "type": "string" }, "apAPId": { "type": "number", "nullable": true }, "ArId": { "type": "number", "nullable": true }, "created_at": { "type": "string", "format": "date-time" }, "redflag_type": { "type": "number" }, "shipmentId": { "type": "number" }, "userId": { "type": "number" } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "NewUserInPortal": { "title": "NewUserInPortal", "type": "object", "description": "(tsType: @loopback/repository-json-schema#Optional, 'portalId'>, schemaOptions: { title: 'NewUserInPortal', exclude: [ 'id' ], optional: [ 'portalId' ] })", "properties": { "name": { "type": "string" }, "first_name": { "type": "string", "nullable": true }, "last_name": { "type": "string", "nullable": true }, "real_name": { "type": "string", "nullable": true }, "phone": { "type": "string", "nullable": true }, "ext": { "type": "string", "nullable": true }, "fax": { "type": "string", "nullable": true }, "avatar": { "type": "string", "nullable": true }, "status": { "type": "number", "enum": [ 0, 1, 2 ] }, "optNumber": { "type": "string", "nullable": true }, "twoFactor": { "type": "number", "enum": [ 0, 1 ] }, "arTypeUser": { "type": "number", "enum": [ 0, 1 ] }, "email_verified_at": { "type": "string", "format": "date-time" }, "email": { "type": "string" }, "AccEmail": { "type": "string", "nullable": true }, "password": { "type": "string" }, "realPassword": { "type": "string" }, "created": { "type": "string", "format": "date-time" }, "modified": { "type": "string", "format": "date-time" }, "realm": { "type": "string", "nullable": true }, "username": { "type": "string", "nullable": true }, "emailVerified": { "type": "boolean" }, "verificationToken": { "type": "boolean" }, "type": { "type": "number" }, "drayage": { "type": "boolean" }, "s_gross": { "type": "number" }, "BrokerPolicyDate": { "type": "string", "format": "date-time" }, "brokerIncentivePolicy": { "type": "number", "enum": [ 0, 1 ] }, "vl_user": { "type": "string", "nullable": true }, "vl_phone": { "type": "string", "nullable": true }, "vl_fax": { "type": "string", "nullable": true }, "vl_ext": { "type": "string", "nullable": true }, "bulkEmailAccess": { "type": "string", "nullable": true }, "onboardingDate": { "type": "string", "format": "date-time" }, "lobType": { "type": "number" }, "attrite": { "type": "number" }, "pipType": { "type": "number" }, "vonage_ext": { "type": "number", "nullable": true }, "aliance_ext": { "type": "number", "nullable": true }, "dids_number": { "type": "string", "nullable": true }, "apId": { "type": "number" }, "employeeId": { "type": "string", "nullable": true }, "socketId": { "type": "string" }, "roleId": { "type": "number" }, "portalId": { "type": "number" } }, "required": [ "name", "status", "twoFactor", "arTypeUser", "email", "password", "type", "brokerIncentivePolicy" ], "additionalProperties": false, "x-typescript-type": "@loopback/repository-json-schema#Optional, 'portalId'>" }, "PotralRole": { "title": "PotralRole", "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "permissions": { "type": "array", "items": { "type": "string" } }, "role_key": { "type": "number" } }, "required": [ "name" ], "additionalProperties": false }, "PortalBankDetails": { "title": "PortalBankDetails", "type": "object", "properties": { "id": { "type": "number" }, "bankName": { "type": "string" }, "accountName": { "type": "string" }, "accountNumber": { "type": "string" }, "achRoutingNumber": { "type": "string" }, "wireTransferRoutingNumber": { "type": "string" }, "swiftCode": { "type": "string" }, "bankAddress": { "type": "string" }, "invoice_address": { "type": "string" }, "zellePay": { "type": "string" }, "checkMailAddress": { "type": "string" }, "portalId": { "type": "number" } }, "additionalProperties": false }, "ShipperPaymentRemittance": { "title": "ShipperPaymentRemittance", "type": "object", "properties": { "id": { "type": "number" }, "portalId": { "type": "number" }, "invoices": { "type": "string" }, "paidAmount": { "type": "string" }, "paidTo": { "type": "string" }, "paymentMode": { "type": "string" }, "sent": { "type": "number" }, "eCheck": { "type": "number" }, "checkNumber": { "type": "string" }, "paymentDate": { "type": "string", "format": "date-time" }, "arName": { "type": "string" }, "submitDate": { "type": "string", "format": "date-time" }, "isDeleted": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "shippersId": { "type": "number" } }, "additionalProperties": false }, "PaymentMethods": { "title": "PaymentMethods", "type": "object", "properties": { "id": { "type": "number" }, "pay_by_ach": { "type": "boolean" }, "ach_bank_name": { "type": "string" }, "ach_account_number": { "type": "string" }, "ach_account_type": { "type": "string" }, "ach_routing_number": { "type": "string" }, "ach_bank_type": { "type": "string" }, "pay_by_wire": { "type": "boolean" }, "wire_bank_name": { "type": "string" }, "wire_account_number": { "type": "string" }, "wire_account_type": { "type": "string" }, "wire_rating_number": { "type": "string" }, "wire_swift_code": { "type": "string" }, "wire_bank_type": { "type": "string" }, "pay_by_credit_card": { "type": "boolean" }, "credit_card_comment": { "type": "string" }, "primery_method": { "type": "string" }, "carriersId": { "type": "number" }, "factoringId": { "type": "number" } }, "additionalProperties": false }, "NewPaymentMethods": { "title": "NewPaymentMethods", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewPaymentMethods', exclude: [ 'id' ] })", "properties": { "pay_by_ach": { "type": "boolean" }, "ach_bank_name": { "type": "string" }, "ach_account_number": { "type": "string" }, "ach_account_type": { "type": "string" }, "ach_routing_number": { "type": "string" }, "ach_bank_type": { "type": "string" }, "pay_by_wire": { "type": "boolean" }, "wire_bank_name": { "type": "string" }, "wire_account_number": { "type": "string" }, "wire_account_type": { "type": "string" }, "wire_rating_number": { "type": "string" }, "wire_swift_code": { "type": "string" }, "wire_bank_type": { "type": "string" }, "pay_by_credit_card": { "type": "boolean" }, "credit_card_comment": { "type": "string" }, "primery_method": { "type": "string" }, "carriersId": { "type": "number" }, "factoringId": { "type": "number" } }, "additionalProperties": false, "x-typescript-type": "Omit" }, "PaymentMethodsWithRelations": { "title": "PaymentMethodsWithRelations", "type": "object", "description": "(tsType: PaymentMethodsWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "pay_by_ach": { "type": "boolean" }, "ach_bank_name": { "type": "string" }, "ach_account_number": { "type": "string" }, "ach_account_type": { "type": "string" }, "ach_routing_number": { "type": "string" }, "ach_bank_type": { "type": "string" }, "pay_by_wire": { "type": "boolean" }, "wire_bank_name": { "type": "string" }, "wire_account_number": { "type": "string" }, "wire_account_type": { "type": "string" }, "wire_rating_number": { "type": "string" }, "wire_swift_code": { "type": "string" }, "wire_bank_type": { "type": "string" }, "pay_by_credit_card": { "type": "boolean" }, "credit_card_comment": { "type": "string" }, "primery_method": { "type": "string" }, "carriersId": { "type": "number" }, "factoringId": { "type": "number" }, "carriers": { "$ref": "#/components/schemas/CarriersWithRelations" }, "foreignKey": {}, "factoring": { "$ref": "#/components/schemas/FactoringDetailsWithRelations" } }, "additionalProperties": false, "x-typescript-type": "PaymentMethodsWithRelations" }, "PaymentMethodsPartial": { "title": "PaymentMethodsPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number" }, "pay_by_ach": { "type": "boolean" }, "ach_bank_name": { "type": "string" }, "ach_account_number": { "type": "string" }, "ach_account_type": { "type": "string" }, "ach_routing_number": { "type": "string" }, "ach_bank_type": { "type": "string" }, "pay_by_wire": { "type": "boolean" }, "wire_bank_name": { "type": "string" }, "wire_account_number": { "type": "string" }, "wire_account_type": { "type": "string" }, "wire_rating_number": { "type": "string" }, "wire_swift_code": { "type": "string" }, "wire_bank_type": { "type": "string" }, "pay_by_credit_card": { "type": "boolean" }, "credit_card_comment": { "type": "string" }, "primery_method": { "type": "string" }, "carriersId": { "type": "number" }, "factoringId": { "type": "number" } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "FactoringDetails": { "title": "FactoringDetails", "type": "object", "properties": { "id": { "type": "number" }, "factoring_w9_form": { "type": "string" }, "factoring_signature_card": { "type": "string" }, "factoring_company_name": { "type": "string" }, "factoring_address": { "type": "string" }, "factoring_phone": { "type": "string" }, "factoring_fax": { "type": "string" }, "factoring_email": { "type": "string" }, "factoring_concern_person": { "type": "string" }, "pay_by_ach": { "type": "boolean" }, "ach_bank_name": { "type": "string" }, "ach_account_number": { "type": "string" }, "ach_account_type": { "type": "string" }, "ach_routing_number": { "type": "string" }, "ach_bank_type": { "type": "string" }, "portalId": { "type": "number" }, "pay_by_wire": { "type": "boolean" }, "wire_bank_name": { "type": "string" }, "wire_account_number": { "type": "string" }, "wire_account_type": { "type": "string" }, "wire_rating_number": { "type": "string" }, "wire_swift_code": { "type": "string" }, "wire_bank_type": { "type": "string" }, "pay_by_credit_card": { "type": "boolean" }, "credit_card_comment": { "type": "string" }, "primery_method": { "type": "string" }, "qb_id": { "type": "string" }, "qb_status": { "type": "number" }, "created_at": { "type": "string", "format": "date-time" }, "modified": { "type": "string", "format": "date-time" }, "zipCodesId": { "type": "number" }, "userId": { "type": "number" } }, "required": [ "factoring_w9_form", "factoring_company_name", "factoring_address", "factoring_phone", "factoring_fax", "factoring_email", "factoring_concern_person" ], "additionalProperties": false }, "Date": {}, "OpenProHistory": { "title": "OpenProHistory", "type": "object", "properties": { "id": { "type": "number" }, "uid": { "type": "string" }, "shipmentId": { "type": "number" }, "portalId": { "type": "number" }, "cprRequestId": { "type": "number" }, "change_request_for": { "type": "number" }, "sendDate": { "type": "string", "format": "date-time" }, "request_for_reason": { "type": "string" }, "approvedByReason": { "type": "string" }, "oldShipperPrice": { "type": "string" }, "oldCarrierPrice": { "type": "string" }, "newShipperPrice": { "type": "string" }, "newCarrierPrice": { "type": "string" }, "oldCommodityValue": { "type": "string" }, "shipmentStatus": { "type": "string" }, "newCommodityValue": { "type": "string" }, "oldPickDate": { "type": "string", "format": "date-time" }, "newPickDate": { "type": "string", "format": "date-time" }, "oldDropDate": { "type": "string", "format": "date-time" }, "newDropDate": { "type": "string", "format": "date-time" }, "approvedById": { "type": "number" }, "status": { "type": "number" }, "userId": { "type": "number" } }, "required": [ "uid", "shipmentId", "portalId" ], "additionalProperties": false }, "NewOpenProHistory": { "title": "NewOpenProHistory", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewOpenProHistory', exclude: [ 'id', 'userId', 'portalId', 'uid' ] })", "properties": { "shipmentId": { "type": "number" }, "cprRequestId": { "type": "number" }, "change_request_for": { "type": "number" }, "sendDate": { "type": "string", "format": "date-time" }, "request_for_reason": { "type": "string" }, "approvedByReason": { "type": "string" }, "oldShipperPrice": { "type": "string" }, "oldCarrierPrice": { "type": "string" }, "newShipperPrice": { "type": "string" }, "newCarrierPrice": { "type": "string" }, "oldCommodityValue": { "type": "string" }, "shipmentStatus": { "type": "string" }, "newCommodityValue": { "type": "string" }, "oldPickDate": { "type": "string", "format": "date-time" }, "newPickDate": { "type": "string", "format": "date-time" }, "oldDropDate": { "type": "string", "format": "date-time" }, "newDropDate": { "type": "string", "format": "date-time" }, "approvedById": { "type": "number" }, "status": { "type": "number" } }, "required": [ "shipmentId" ], "additionalProperties": false, "x-typescript-type": "Omit" }, "OpenProHistoryWithRelations": { "title": "OpenProHistoryWithRelations", "type": "object", "description": "(tsType: OpenProHistoryWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "uid": { "type": "string" }, "shipmentId": { "type": "number" }, "portalId": { "type": "number" }, "cprRequestId": { "type": "number" }, "change_request_for": { "type": "number" }, "sendDate": { "type": "string", "format": "date-time" }, "request_for_reason": { "type": "string" }, "approvedByReason": { "type": "string" }, "oldShipperPrice": { "type": "string" }, "oldCarrierPrice": { "type": "string" }, "newShipperPrice": { "type": "string" }, "newCarrierPrice": { "type": "string" }, "oldCommodityValue": { "type": "string" }, "shipmentStatus": { "type": "string" }, "newCommodityValue": { "type": "string" }, "oldPickDate": { "type": "string", "format": "date-time" }, "newPickDate": { "type": "string", "format": "date-time" }, "oldDropDate": { "type": "string", "format": "date-time" }, "newDropDate": { "type": "string", "format": "date-time" }, "approvedById": { "type": "number" }, "status": { "type": "number" }, "userId": { "type": "number" }, "user": { "$ref": "#/components/schemas/UserWithRelations" }, "foreignKey": {} }, "required": [ "uid", "shipmentId", "portalId" ], "additionalProperties": false, "x-typescript-type": "OpenProHistoryWithRelations" }, "OpenProHistoryPartial": { "title": "OpenProHistoryPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number" }, "uid": { "type": "string" }, "shipmentId": { "type": "number" }, "portalId": { "type": "number" }, "cprRequestId": { "type": "number" }, "change_request_for": { "type": "number" }, "sendDate": { "type": "string", "format": "date-time" }, "request_for_reason": { "type": "string" }, "approvedByReason": { "type": "string" }, "oldShipperPrice": { "type": "string" }, "oldCarrierPrice": { "type": "string" }, "newShipperPrice": { "type": "string" }, "newCarrierPrice": { "type": "string" }, "oldCommodityValue": { "type": "string" }, "shipmentStatus": { "type": "string" }, "newCommodityValue": { "type": "string" }, "oldPickDate": { "type": "string", "format": "date-time" }, "newPickDate": { "type": "string", "format": "date-time" }, "oldDropDate": { "type": "string", "format": "date-time" }, "newDropDate": { "type": "string", "format": "date-time" }, "approvedById": { "type": "number" }, "status": { "type": "number" }, "userId": { "type": "number" } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "Notifications": { "title": "Notifications", "type": "object", "properties": { "id": { "type": "number" }, "from": { "type": "number" }, "to": { "type": "number" }, "link": { "type": "string" }, "title": { "type": "string" }, "message": { "type": "string" }, "created": { "type": "string", "format": "date-time" }, "readStatus": { "type": "number" } }, "required": [ "to" ], "additionalProperties": false }, "NewNotifications": { "title": "NewNotifications", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewNotifications', exclude: [ 'id' ] })", "properties": { "from": { "type": "number" }, "to": { "type": "number" }, "link": { "type": "string" }, "title": { "type": "string" }, "message": { "type": "string" }, "created": { "type": "string", "format": "date-time" }, "readStatus": { "type": "number" } }, "required": [ "to" ], "additionalProperties": false, "x-typescript-type": "Omit" }, "NotificationsWithRelations": { "title": "NotificationsWithRelations", "type": "object", "description": "(tsType: NotificationsWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "from": { "type": "number" }, "to": { "type": "number" }, "link": { "type": "string" }, "title": { "type": "string" }, "message": { "type": "string" }, "created": { "type": "string", "format": "date-time" }, "readStatus": { "type": "number" } }, "required": [ "to" ], "additionalProperties": false, "x-typescript-type": "NotificationsWithRelations" }, "NotificationsPartial": { "title": "NotificationsPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number" }, "from": { "type": "number" }, "to": { "type": "number" }, "link": { "type": "string" }, "title": { "type": "string" }, "message": { "type": "string" }, "created": { "type": "string", "format": "date-time" }, "readStatus": { "type": "number" } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "NewMcVerification": { "title": "NewMcVerification", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewMcVerification', exclude: [ 'id', 'uid', 'portalId', 'userId', 'mcSentTime', 'smeStatus' ] })", "properties": { "mcCategory": { "type": "string" }, "requestType": { "type": "string" }, "exceptionType": { "type": "string", "nullable": true }, "mcNumber": { "type": "string", "nullable": true }, "dotNumber": { "type": "string", "nullable": true }, "nscNumber": { "type": "string", "nullable": true }, "mcCarrierSetUp": { "type": "number", "enum": [ 1, 2 ] }, "mcTruckType": { "type": "string" }, "mcApproveNotes": { "type": "string", "maxLength": 2000, "nullable": true }, "approveTime": { "type": "string", "format": "date-time", "nullable": true }, "timeDiffrence": { "type": "number", "nullable": true }, "totalIncentive": { "type": "number", "nullable": true }, "VerifiedCarrierName": { "type": "string", "nullable": true }, "FmcsaPhoneNumber": { "type": "string", "nullable": true }, "CacciPhoneNumber": { "type": "string", "nullable": true }, "VerifiedCacciEmail": { "type": "string", "nullable": true }, "VerifiedCarrier411Email": { "type": "string", "nullable": true }, "VerifiedCarrierCity": { "type": "string", "nullable": true }, "VerifiedCarrierState": { "type": "string", "nullable": true }, "VerifiedCarrierZip": { "type": "string", "nullable": true }, "VerifiedCarrierCountry": { "type": "string", "nullable": true }, "VerifiedFullAddress": { "type": "string", "nullable": true }, "checkedById": { "type": "number" }, "ReverifyCarrierEmail": { "type": "string", "nullable": true }, "ReverifyCarrierPhoneNumber": { "type": "number", "nullable": true }, "McStatus": { "type": "string", "nullable": true }, "TotalInspections": { "type": "string", "nullable": true }, "InsuranceStatus": { "type": "string", "nullable": true }, "TotalTrucks": { "type": "string", "nullable": true }, "VictimIdentityTheft": { "type": "string", "nullable": true }, "TotalActiveTime": { "type": "string", "nullable": true }, "comment": {}, "ApprovedBySmeId": { "type": "number" } }, "required": [ "mcCategory", "requestType", "mcCarrierSetUp", "mcTruckType" ], "additionalProperties": false, "x-typescript-type": "Omit" }, "McReVerificationWithRelations": { "title": "McReVerificationWithRelations", "type": "object", "description": "(tsType: McReVerificationWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "portalId": { "type": "number" }, "carrierNumber": { "type": "string" }, "carrierEmail": { "type": "string" }, "mcNumber": { "type": "string", "nullable": true }, "dotNumber": { "type": "string", "nullable": true }, "nscNumber": { "type": "string", "nullable": true }, "smeStatus": { "type": "number" }, "smeId": { "type": "number" }, "sendDate": { "type": "string", "format": "date-time" }, "approvalDate": { "type": "string", "format": "date-time" }, "verifiedType": { "type": "string", "nullable": true }, "shipmentId": { "type": "number" }, "shipment": { "$ref": "#/components/schemas/ShipmentWithRelations" }, "foreignKey": {} }, "required": [ "portalId", "carrierEmail", "smeStatus" ], "additionalProperties": false, "x-typescript-type": "McReVerificationWithRelations" }, "McExceptionWeekendEmail": { "title": "McExceptionWeekendEmail", "type": "object", "properties": { "id": { "type": "number" }, "manager_email": { "type": "string" }, "manager_id": { "type": "number" }, "start_date": { "type": "string", "format": "date-time" }, "end_date": { "type": "string", "format": "date-time" }, "status": { "type": "number" }, "drayage": { "type": "number" }, "created_at": { "type": "string", "format": "date-time" }, "portalId": { "type": "number" } }, "required": [ "manager_email", "manager_id", "start_date", "end_date" ], "additionalProperties": false }, "NewMcExceptionWeekendEmail": { "title": "NewMcExceptionWeekendEmail", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewMcExceptionWeekendEmail', exclude: [ 'id' ] })", "properties": { "manager_email": { "type": "string" }, "manager_id": { "type": "number" }, "start_date": { "type": "string", "format": "date-time" }, "end_date": { "type": "string", "format": "date-time" }, "status": { "type": "number" }, "drayage": { "type": "number" }, "created_at": { "type": "string", "format": "date-time" }, "portalId": { "type": "number" } }, "required": [ "manager_email", "manager_id", "start_date", "end_date" ], "additionalProperties": false, "x-typescript-type": "Omit" }, "McExceptionWeekendEmailWithRelations": { "title": "McExceptionWeekendEmailWithRelations", "type": "object", "description": "(tsType: McExceptionWeekendEmailWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "manager_email": { "type": "string" }, "manager_id": { "type": "number" }, "start_date": { "type": "string", "format": "date-time" }, "end_date": { "type": "string", "format": "date-time" }, "status": { "type": "number" }, "drayage": { "type": "number" }, "created_at": { "type": "string", "format": "date-time" }, "portalId": { "type": "number" }, "portal": { "$ref": "#/components/schemas/PortalWithRelations" }, "foreignKey": {} }, "required": [ "manager_email", "manager_id", "start_date", "end_date" ], "additionalProperties": false, "x-typescript-type": "McExceptionWeekendEmailWithRelations" }, "McExceptionWeekendEmailPartial": { "title": "McExceptionWeekendEmailPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number" }, "manager_email": { "type": "string" }, "manager_id": { "type": "number" }, "start_date": { "type": "string", "format": "date-time" }, "end_date": { "type": "string", "format": "date-time" }, "status": { "type": "number" }, "drayage": { "type": "number" }, "created_at": { "type": "string", "format": "date-time" }, "portalId": { "type": "number" } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "Loads": { "title": "Loads", "type": "object", "properties": { "id": { "type": "number" }, "uid": { "type": "string" }, "portalId": { "type": "number" }, "load_dat_id": { "type": "string" }, "load_ts_id": { "type": "string" }, "pick_up_date": { "type": "string", "format": "date-time" }, "full_partial_tl_ltl": { "type": "string" }, "length_load": { "type": "number" }, "delivery_date": { "type": "string", "format": "date-time" }, "distance": { "type": "number" }, "ref_no": { "type": "string" }, "load_status": { "type": "number" }, "carrier_price": { "type": "number" }, "weight_load": { "type": "number" }, "pallets": { "type": "string" }, "special_requirement": { "type": "string" }, "commodity": { "type": "string" }, "post_carrier_price": { "type": "number" }, "rate_type": { "type": "number" }, "shipper_price": { "type": "number" }, "rate_range_from": { "type": "number" }, "rate_range_to": { "type": "number" }, "internal_comment": { "type": "string" }, "age": { "type": "string" }, "rate_base_on": { "type": "string" }, "load_hight_inches": { "type": "string" }, "cubic_feet_load": { "type": "string" }, "equipment_classes": { "type": "string" }, "equipment_spotrates": { "type": "string" }, "equipment_postevrywhere": { "type": "string" }, "equipment_ts": { "type": "string" }, "equipment_ts_id": { "type": "string" }, "dat_pick_date": { "type": "string", "format": "date-time" }, "dat_drop_date": { "type": "string", "format": "date-time" }, "p_u_hours": { "type": "string" }, "delivery_hours": { "type": "string" }, "MessageEnable": { "type": "number", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "originId": { "type": "number" }, "userId": { "type": "number" }, "destiID": { "type": "number" }, "equipmentId": { "type": "number" }, "commoditiesId": { "type": "number" } }, "required": [ "uid", "portalId", "load_dat_id", "pick_up_date", "delivery_date", "ref_no", "load_status" ], "additionalProperties": false }, "NewLoads": { "title": "NewLoads", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewLoads', exclude: [ 'id', 'userId', 'portalId', 'uid' ] })", "properties": { "load_dat_id": { "type": "string" }, "load_ts_id": { "type": "string" }, "pick_up_date": { "type": "string", "format": "date-time" }, "full_partial_tl_ltl": { "type": "string" }, "length_load": { "type": "number" }, "delivery_date": { "type": "string", "format": "date-time" }, "distance": { "type": "number" }, "ref_no": { "type": "string" }, "load_status": { "type": "number" }, "carrier_price": { "type": "number" }, "weight_load": { "type": "number" }, "pallets": { "type": "string" }, "special_requirement": { "type": "string" }, "commodity": { "type": "string" }, "post_carrier_price": { "type": "number" }, "rate_type": { "type": "number" }, "shipper_price": { "type": "number" }, "rate_range_from": { "type": "number" }, "rate_range_to": { "type": "number" }, "internal_comment": { "type": "string" }, "age": { "type": "string" }, "rate_base_on": { "type": "string" }, "load_hight_inches": { "type": "string" }, "cubic_feet_load": { "type": "string" }, "equipment_classes": { "type": "string" }, "equipment_spotrates": { "type": "string" }, "equipment_postevrywhere": { "type": "string" }, "equipment_ts": { "type": "string" }, "equipment_ts_id": { "type": "string" }, "dat_pick_date": { "type": "string", "format": "date-time" }, "dat_drop_date": { "type": "string", "format": "date-time" }, "p_u_hours": { "type": "string" }, "delivery_hours": { "type": "string" }, "MessageEnable": { "type": "number", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "originId": { "type": "number" }, "destiID": { "type": "number" }, "equipmentId": { "type": "number" }, "commoditiesId": { "type": "number" } }, "required": [ "load_dat_id", "pick_up_date", "delivery_date", "ref_no", "load_status" ], "additionalProperties": false, "x-typescript-type": "Omit" }, "LoadCommentsWithRelations": { "title": "LoadCommentsWithRelations", "type": "object", "description": "(tsType: LoadCommentsWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "message": { "type": "string" }, "date": { "type": "string", "format": "date-time" }, "messageType": { "type": "number" }, "notificationStatus": { "type": "number" }, "readStatus": { "type": "number" }, "loadsId": { "type": "number" }, "userId": { "type": "number" }, "loads": { "$ref": "#/components/schemas/LoadsWithRelations" }, "foreignKey": {}, "user": { "$ref": "#/components/schemas/UserWithRelations" } }, "additionalProperties": false, "x-typescript-type": "LoadCommentsWithRelations" }, "EquipmentWithRelations": { "title": "EquipmentWithRelations", "type": "object", "description": "(tsType: EquipmentWithRelations, schemaOptions: { includeRelations: true })", "properties": { "name": { "type": "string" }, "id": { "type": "number" }, "equip_type": { "type": "string" }, "spot_equip": { "type": "string" }, "pst_evrywre": { "type": "string" }, "ts_equip": { "type": "string" }, "cat_ts": { "type": "string" }, "ts_id": { "type": "string" }, "dat_id": { "type": "string" }, "status": { "type": "boolean" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "deleted_at": { "type": "string", "format": "date-time" } }, "required": [ "name", "equip_type" ], "additionalProperties": false, "x-typescript-type": "EquipmentWithRelations" }, "CommoditiesWithRelations": { "title": "CommoditiesWithRelations", "type": "object", "description": "(tsType: CommoditiesWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "status": { "type": "number", "enum": [ 0, 1, 2 ] }, "EstimatedValue": { "type": "string", "nullable": true }, "created": { "type": "string", "format": "date-time" }, "user_id": { "type": "number" }, "modified": { "type": "string", "format": "date-time" }, "Broker": { "$ref": "#/components/schemas/UserWithRelations" }, "foreignKey": {} }, "required": [ "name", "status" ], "additionalProperties": false, "x-typescript-type": "CommoditiesWithRelations" }, "LoadsWithRelations": { "title": "LoadsWithRelations", "type": "object", "description": "(tsType: LoadsWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "uid": { "type": "string" }, "portalId": { "type": "number" }, "load_dat_id": { "type": "string" }, "load_ts_id": { "type": "string" }, "pick_up_date": { "type": "string", "format": "date-time" }, "full_partial_tl_ltl": { "type": "string" }, "length_load": { "type": "number" }, "delivery_date": { "type": "string", "format": "date-time" }, "distance": { "type": "number" }, "ref_no": { "type": "string" }, "load_status": { "type": "number" }, "carrier_price": { "type": "number" }, "weight_load": { "type": "number" }, "pallets": { "type": "string" }, "special_requirement": { "type": "string" }, "commodity": { "type": "string" }, "post_carrier_price": { "type": "number" }, "rate_type": { "type": "number" }, "shipper_price": { "type": "number" }, "rate_range_from": { "type": "number" }, "rate_range_to": { "type": "number" }, "internal_comment": { "type": "string" }, "age": { "type": "string" }, "rate_base_on": { "type": "string" }, "load_hight_inches": { "type": "string" }, "cubic_feet_load": { "type": "string" }, "equipment_classes": { "type": "string" }, "equipment_spotrates": { "type": "string" }, "equipment_postevrywhere": { "type": "string" }, "equipment_ts": { "type": "string" }, "equipment_ts_id": { "type": "string" }, "dat_pick_date": { "type": "string", "format": "date-time" }, "dat_drop_date": { "type": "string", "format": "date-time" }, "p_u_hours": { "type": "string" }, "delivery_hours": { "type": "string" }, "MessageEnable": { "type": "number", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "originId": { "type": "number" }, "userId": { "type": "number" }, "destiID": { "type": "number" }, "equipmentId": { "type": "number" }, "commoditiesId": { "type": "number" }, "loadComments": { "type": "array", "items": { "$ref": "#/components/schemas/LoadCommentsWithRelations" } }, "origin": { "$ref": "#/components/schemas/ZipCodesWithRelations" }, "foreignKey": {}, "user": { "$ref": "#/components/schemas/UserWithRelations" }, "desti": { "$ref": "#/components/schemas/ZipCodesWithRelations" }, "equipment": { "$ref": "#/components/schemas/EquipmentWithRelations" }, "commodities": { "$ref": "#/components/schemas/CommoditiesWithRelations" } }, "required": [ "uid", "portalId", "load_dat_id", "pick_up_date", "delivery_date", "ref_no", "load_status" ], "additionalProperties": false, "x-typescript-type": "LoadsWithRelations" }, "LoadsPartial": { "title": "LoadsPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number" }, "uid": { "type": "string" }, "portalId": { "type": "number" }, "load_dat_id": { "type": "string" }, "load_ts_id": { "type": "string" }, "pick_up_date": { "type": "string", "format": "date-time" }, "full_partial_tl_ltl": { "type": "string" }, "length_load": { "type": "number" }, "delivery_date": { "type": "string", "format": "date-time" }, "distance": { "type": "number" }, "ref_no": { "type": "string" }, "load_status": { "type": "number" }, "carrier_price": { "type": "number" }, "weight_load": { "type": "number" }, "pallets": { "type": "string" }, "special_requirement": { "type": "string" }, "commodity": { "type": "string" }, "post_carrier_price": { "type": "number" }, "rate_type": { "type": "number" }, "shipper_price": { "type": "number" }, "rate_range_from": { "type": "number" }, "rate_range_to": { "type": "number" }, "internal_comment": { "type": "string" }, "age": { "type": "string" }, "rate_base_on": { "type": "string" }, "load_hight_inches": { "type": "string" }, "cubic_feet_load": { "type": "string" }, "equipment_classes": { "type": "string" }, "equipment_spotrates": { "type": "string" }, "equipment_postevrywhere": { "type": "string" }, "equipment_ts": { "type": "string" }, "equipment_ts_id": { "type": "string" }, "dat_pick_date": { "type": "string", "format": "date-time" }, "dat_drop_date": { "type": "string", "format": "date-time" }, "p_u_hours": { "type": "string" }, "delivery_hours": { "type": "string" }, "MessageEnable": { "type": "number", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "originId": { "type": "number" }, "userId": { "type": "number" }, "destiID": { "type": "number" }, "equipmentId": { "type": "number" }, "commoditiesId": { "type": "number" } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "AiModelLoads": { "title": "AiModelLoads", "type": "object", "properties": { "id": { "type": "number" }, "portalId": { "type": "number" }, "loads_id": { "type": "number" }, "pick_location": { "type": "string" }, "drop_location": { "type": "string" }, "equipment": { "type": "string" }, "commodity_type": { "type": "string" }, "full_partial": { "type": "number" }, "is_high_paid_lane": { "type": "number" }, "cost": { "type": "number" }, "distance": { "type": "number" }, "surge_price": { "type": "number" }, "fuel_cost": { "type": "number" }, "lane_price": { "type": "number" }, "shipper_price": { "type": "number" }, "carrier_price_from": { "type": "number" }, "carrier_price_to": { "type": "number" }, "available_loads": { "type": "number" }, "available_carrier": { "type": "number" }, "pick_up_date": { "type": "string", "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" }, "userId": { "type": "number" } }, "required": [ "portalId", "loads_id" ], "additionalProperties": false }, "LoadComments": { "title": "LoadComments", "type": "object", "properties": { "id": { "type": "number" }, "message": { "type": "string" }, "date": { "type": "string", "format": "date-time" }, "messageType": { "type": "number" }, "notificationStatus": { "type": "number" }, "readStatus": { "type": "number" }, "loadsId": { "type": "number" }, "userId": { "type": "number" } }, "additionalProperties": false }, "NewLoadCommentsInLoads": { "title": "NewLoadCommentsInLoads", "type": "object", "description": "(tsType: @loopback/repository-json-schema#Optional, 'loadsId'>, schemaOptions: { title: 'NewLoadCommentsInLoads', exclude: [ 'id' ], optional: [ 'loadsId' ] })", "properties": { "message": { "type": "string" }, "date": { "type": "string", "format": "date-time" }, "messageType": { "type": "number" }, "notificationStatus": { "type": "number" }, "readStatus": { "type": "number" }, "loadsId": { "type": "number" }, "userId": { "type": "number" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository-json-schema#Optional, 'loadsId'>" }, "LoadCommentsPartial": { "title": "LoadCommentsPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number" }, "message": { "type": "string" }, "date": { "type": "string", "format": "date-time" }, "messageType": { "type": "number" }, "notificationStatus": { "type": "number" }, "readStatus": { "type": "number" }, "loadsId": { "type": "number" }, "userId": { "type": "number" } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "IncentiveHoldWithRelations": { "title": "IncentiveHoldWithRelations", "type": "object", "description": "(tsType: IncentiveHoldWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "shipmentId": { "type": "number" }, "type": { "type": "string" }, "userId": { "type": "number" }, "total": { "type": "number" }, "pending": { "type": "number" }, "received": { "type": "number" }, "spDate": { "type": "string", "format": "date-time" }, "spr": { "type": "number" }, "sprDate": { "type": "string", "format": "date-time" }, "hp": { "type": "number" }, "hpDate": { "type": "string", "format": "date-time" }, "hpr": { "type": "number" }, "hprDate": { "type": "string", "format": "date-time" }, "carrier": { "type": "number" }, "shipper": { "type": "number" }, "margin": { "type": "number" }, "pickDate": { "type": "string", "format": "date-time" }, "invoiceDate": { "type": "string", "format": "date-time" }, "hpFor": { "type": "string", "format": "date-time" }, "hprFor": { "type": "string", "format": "date-time" }, "spFor": { "type": "string", "format": "date-time" }, "sprFor": { "type": "string", "format": "date-time" }, "captureDate": { "type": "string", "format": "date-time" }, "invoiceId": { "type": "number" }, "invoice": { "$ref": "#/components/schemas/InvoicesWithRelations" }, "foreignKey": {} }, "required": [ "shipmentId", "type", "userId", "carrier", "shipper", "margin", "pickDate", "captureDate" ], "additionalProperties": false, "x-typescript-type": "IncentiveHoldWithRelations" }, "InvoicePayment": { "title": "InvoicePayment", "type": "object", "properties": { "id": { "type": "number" }, "uid": { "type": "string" }, "invoicesId": { "type": "number" }, "ArUserID": { "type": "number" }, "paidAmount": { "type": "number", "nullable": true }, "balanceDue": { "type": "number", "nullable": true }, "bankCharges": { "type": "string", "nullable": true }, "checkNumber": { "type": "string", "nullable": true }, "oldInvoicePaymentId": { "type": "number", "nullable": true }, "checkDate": { "type": "string", "format": "date-time" }, "dateReceived": { "type": "string", "format": "date-time" }, "payMode": { "type": "string", "nullable": true }, "bankType": { "type": "string", "nullable": true }, "depositDate": { "type": "string", "format": "date-time" }, "assignStatus": { "type": "number" }, "writeOffType": { "type": "string", "nullable": true }, "comments": { "type": "string", "nullable": true }, "created": { "type": "string", "format": "date-time" } }, "required": [ "uid" ], "additionalProperties": false }, "NewInvoicePaymentInInvoices": { "title": "NewInvoicePaymentInInvoices", "type": "object", "description": "(tsType: @loopback/repository-json-schema#Optional, 'invoicesId'>, schemaOptions: { title: 'NewInvoicePaymentInInvoices', exclude: [ 'id' ], optional: [ 'invoicesId' ] })", "properties": { "uid": { "type": "string" }, "invoicesId": { "type": "number" }, "ArUserID": { "type": "number" }, "paidAmount": { "type": "number", "nullable": true }, "balanceDue": { "type": "number", "nullable": true }, "bankCharges": { "type": "string", "nullable": true }, "checkNumber": { "type": "string", "nullable": true }, "oldInvoicePaymentId": { "type": "number", "nullable": true }, "checkDate": { "type": "string", "format": "date-time" }, "dateReceived": { "type": "string", "format": "date-time" }, "payMode": { "type": "string", "nullable": true }, "bankType": { "type": "string", "nullable": true }, "depositDate": { "type": "string", "format": "date-time" }, "assignStatus": { "type": "number" }, "writeOffType": { "type": "string", "nullable": true }, "comments": { "type": "string", "nullable": true }, "created": { "type": "string", "format": "date-time" } }, "required": [ "uid" ], "additionalProperties": false, "x-typescript-type": "@loopback/repository-json-schema#Optional, 'invoicesId'>" }, "InvoicePaymentPartial": { "title": "InvoicePaymentPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number" }, "uid": { "type": "string" }, "invoicesId": { "type": "number" }, "ArUserID": { "type": "number" }, "paidAmount": { "type": "number", "nullable": true }, "balanceDue": { "type": "number", "nullable": true }, "bankCharges": { "type": "string", "nullable": true }, "checkNumber": { "type": "string", "nullable": true }, "oldInvoicePaymentId": { "type": "number", "nullable": true }, "checkDate": { "type": "string", "format": "date-time" }, "dateReceived": { "type": "string", "format": "date-time" }, "payMode": { "type": "string", "nullable": true }, "bankType": { "type": "string", "nullable": true }, "depositDate": { "type": "string", "format": "date-time" }, "assignStatus": { "type": "number" }, "writeOffType": { "type": "string", "nullable": true }, "comments": { "type": "string", "nullable": true }, "created": { "type": "string", "format": "date-time" } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "NewGoodToGoHistory": { "title": "NewGoodToGoHistory", "type": "object", "description": "(tsType: GoodToGoHistory, schemaOptions: { title: 'NewGoodToGoHistory' })", "properties": { "good_to_go_history_id": { "type": "number" }, "user_id": { "type": "number" }, "by_name": { "type": "string" }, "shipment_id": { "type": "number" }, "carriers_id": { "type": "number" }, "companies_id": { "type": "number" }, "comment": { "type": "string" }, "team": { "type": "number" }, "date_time": { "type": "string" }, "ap_hold_status": {}, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } }, "required": [ "companies_id", "comment", "team", "ap_hold_status", "created_at", "updated_at" ], "additionalProperties": false, "x-typescript-type": "GoodToGoHistory" }, "GoodToGoHistoryWithRelations": { "title": "GoodToGoHistoryWithRelations", "type": "object", "description": "(tsType: GoodToGoHistoryWithRelations, schemaOptions: { includeRelations: true })", "properties": { "good_to_go_history_id": { "type": "number" }, "user_id": { "type": "number" }, "by_name": { "type": "string" }, "shipment_id": { "type": "number" }, "carriers_id": { "type": "number" }, "companies_id": { "type": "number" }, "comment": { "type": "string" }, "team": { "type": "number" }, "date_time": { "type": "string" }, "ap_hold_status": {}, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } }, "required": [ "companies_id", "comment", "team", "ap_hold_status", "created_at", "updated_at" ], "additionalProperties": false, "x-typescript-type": "GoodToGoHistoryWithRelations" }, "GoodToGoHistoryPartial": { "title": "GoodToGoHistoryPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "good_to_go_history_id": { "type": "number" }, "user_id": { "type": "number" }, "by_name": { "type": "string" }, "shipment_id": { "type": "number" }, "carriers_id": { "type": "number" }, "companies_id": { "type": "number" }, "comment": { "type": "string" }, "team": { "type": "number" }, "date_time": { "type": "string" }, "ap_hold_status": {}, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "NewFactoringDetails": { "title": "NewFactoringDetails", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewFactoringDetails', exclude: [ 'id' ] })", "properties": { "factoring_w9_form": { "type": "string" }, "factoring_signature_card": { "type": "string" }, "factoring_company_name": { "type": "string" }, "factoring_address": { "type": "string" }, "factoring_phone": { "type": "string" }, "factoring_fax": { "type": "string" }, "factoring_email": { "type": "string" }, "factoring_concern_person": { "type": "string" }, "pay_by_ach": { "type": "boolean" }, "ach_bank_name": { "type": "string" }, "ach_account_number": { "type": "string" }, "ach_account_type": { "type": "string" }, "ach_routing_number": { "type": "string" }, "ach_bank_type": { "type": "string" }, "portalId": { "type": "number" }, "pay_by_wire": { "type": "boolean" }, "wire_bank_name": { "type": "string" }, "wire_account_number": { "type": "string" }, "wire_account_type": { "type": "string" }, "wire_rating_number": { "type": "string" }, "wire_swift_code": { "type": "string" }, "wire_bank_type": { "type": "string" }, "pay_by_credit_card": { "type": "boolean" }, "credit_card_comment": { "type": "string" }, "primery_method": { "type": "string" }, "qb_id": { "type": "string" }, "qb_status": { "type": "number" }, "created_at": { "type": "string", "format": "date-time" }, "modified": { "type": "string", "format": "date-time" }, "zipCodesId": { "type": "number" }, "userId": { "type": "number" } }, "required": [ "factoring_w9_form", "factoring_company_name", "factoring_address", "factoring_phone", "factoring_fax", "factoring_email", "factoring_concern_person" ], "additionalProperties": false, "x-typescript-type": "Omit" }, "FactoringDetailsWithRelations": { "title": "FactoringDetailsWithRelations", "type": "object", "description": "(tsType: FactoringDetailsWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "factoring_w9_form": { "type": "string" }, "factoring_signature_card": { "type": "string" }, "factoring_company_name": { "type": "string" }, "factoring_address": { "type": "string" }, "factoring_phone": { "type": "string" }, "factoring_fax": { "type": "string" }, "factoring_email": { "type": "string" }, "factoring_concern_person": { "type": "string" }, "pay_by_ach": { "type": "boolean" }, "ach_bank_name": { "type": "string" }, "ach_account_number": { "type": "string" }, "ach_account_type": { "type": "string" }, "ach_routing_number": { "type": "string" }, "ach_bank_type": { "type": "string" }, "portalId": { "type": "number" }, "pay_by_wire": { "type": "boolean" }, "wire_bank_name": { "type": "string" }, "wire_account_number": { "type": "string" }, "wire_account_type": { "type": "string" }, "wire_rating_number": { "type": "string" }, "wire_swift_code": { "type": "string" }, "wire_bank_type": { "type": "string" }, "pay_by_credit_card": { "type": "boolean" }, "credit_card_comment": { "type": "string" }, "primery_method": { "type": "string" }, "qb_id": { "type": "string" }, "qb_status": { "type": "number" }, "created_at": { "type": "string", "format": "date-time" }, "modified": { "type": "string", "format": "date-time" }, "zipCodesId": { "type": "number" }, "userId": { "type": "number" }, "portal": { "$ref": "#/components/schemas/PortalWithRelations" }, "foreignKey": {}, "zipCodes": { "$ref": "#/components/schemas/ZipCodesWithRelations" }, "user": { "$ref": "#/components/schemas/UserWithRelations" } }, "required": [ "factoring_w9_form", "factoring_company_name", "factoring_address", "factoring_phone", "factoring_fax", "factoring_email", "factoring_concern_person" ], "additionalProperties": false, "x-typescript-type": "FactoringDetailsWithRelations" }, "FactoringDetailsPartial": { "title": "FactoringDetailsPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number" }, "factoring_w9_form": { "type": "string" }, "factoring_signature_card": { "type": "string" }, "factoring_company_name": { "type": "string" }, "factoring_address": { "type": "string" }, "factoring_phone": { "type": "string" }, "factoring_fax": { "type": "string" }, "factoring_email": { "type": "string" }, "factoring_concern_person": { "type": "string" }, "pay_by_ach": { "type": "boolean" }, "ach_bank_name": { "type": "string" }, "ach_account_number": { "type": "string" }, "ach_account_type": { "type": "string" }, "ach_routing_number": { "type": "string" }, "ach_bank_type": { "type": "string" }, "portalId": { "type": "number" }, "pay_by_wire": { "type": "boolean" }, "wire_bank_name": { "type": "string" }, "wire_account_number": { "type": "string" }, "wire_account_type": { "type": "string" }, "wire_rating_number": { "type": "string" }, "wire_swift_code": { "type": "string" }, "wire_bank_type": { "type": "string" }, "pay_by_credit_card": { "type": "boolean" }, "credit_card_comment": { "type": "string" }, "primery_method": { "type": "string" }, "qb_id": { "type": "string" }, "qb_status": { "type": "number" }, "created_at": { "type": "string", "format": "date-time" }, "modified": { "type": "string", "format": "date-time" }, "zipCodesId": { "type": "number" }, "userId": { "type": "number" } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "ExceptionsRequestLogs": { "title": "ExceptionsRequestLogs", "type": "object", "properties": { "id": { "type": "number" }, "message": { "type": "string", "nullable": true }, "McNo": { "type": "string", "nullable": true }, "DotNo": { "type": "string", "nullable": true }, "NscNo": { "type": "string", "nullable": true }, "type": { "type": "number" }, "McId": { "type": "number" }, "BrokerId": { "type": "number" }, "TeamId": { "type": "number" }, "ApprovedById": { "type": "number" }, "status": { "type": "number" }, "created": { "type": "string", "format": "date-time" }, "updated": { "type": "string", "format": "date-time" }, "portalId": { "type": "number" } }, "additionalProperties": false }, "NewEquipment": { "title": "NewEquipment", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewEquipment', exclude: [ 'id' ] })", "properties": { "name": { "type": "string" }, "equip_type": { "type": "string" }, "spot_equip": { "type": "string" }, "pst_evrywre": { "type": "string" }, "ts_equip": { "type": "string" }, "cat_ts": { "type": "string" }, "ts_id": { "type": "string" }, "dat_id": { "type": "string" }, "status": { "type": "boolean" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "deleted_at": { "type": "string", "format": "date-time" } }, "required": [ "name", "equip_type" ], "additionalProperties": false, "x-typescript-type": "Omit" }, "EquipmentPartial": { "title": "EquipmentPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "name": { "type": "string" }, "id": { "type": "number" }, "equip_type": { "type": "string" }, "spot_equip": { "type": "string" }, "pst_evrywre": { "type": "string" }, "ts_equip": { "type": "string" }, "cat_ts": { "type": "string" }, "ts_id": { "type": "string" }, "dat_id": { "type": "string" }, "status": { "type": "boolean" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "deleted_at": { "type": "string", "format": "date-time" } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "EmpAlignment": { "title": "EmpAlignment", "type": "object", "properties": { "id": { "type": "number" }, "date": { "type": "string", "format": "date-time" }, "activeStatus": { "type": "boolean" }, "portalId": { "type": "number" }, "userId": { "type": "number" }, "tlId": { "type": "number" }, "managerId": { "type": "number" } }, "required": [ "date", "activeStatus" ], "additionalProperties": false }, "New Employee Alignment": { "title": "New Employee Alignment", "type": "object", "description": "(tsType: @loopback/repository-json-schema#Optional, schemaOptions: { title: 'New Employee Alignment', optional: [ 'date', 'portalId' ] })", "properties": { "id": { "type": "number" }, "date": { "type": "string", "format": "date-time" }, "activeStatus": { "type": "boolean" }, "portalId": { "type": "number" }, "userId": { "type": "number" }, "tlId": { "type": "number" }, "managerId": { "type": "number" } }, "required": [ "activeStatus" ], "additionalProperties": false, "x-typescript-type": "@loopback/repository-json-schema#Optional" }, "EmpAlignmentWithRelations": { "title": "EmpAlignmentWithRelations", "type": "object", "description": "(tsType: EmpAlignmentWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "date": { "type": "string", "format": "date-time" }, "activeStatus": { "type": "boolean" }, "portalId": { "type": "number" }, "userId": { "type": "number" }, "tlId": { "type": "number" }, "managerId": { "type": "number" }, "user": { "$ref": "#/components/schemas/UserWithRelations" }, "foreignKey": {}, "tl": { "$ref": "#/components/schemas/UserWithRelations" }, "manager": { "$ref": "#/components/schemas/UserWithRelations" } }, "required": [ "date", "activeStatus" ], "additionalProperties": false, "x-typescript-type": "EmpAlignmentWithRelations" }, "EmpAlignmentPartial": { "title": "EmpAlignmentPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number" }, "date": { "type": "string", "format": "date-time" }, "activeStatus": { "type": "boolean" }, "portalId": { "type": "number" }, "userId": { "type": "number" }, "tlId": { "type": "number" }, "managerId": { "type": "number" } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "EmailMarketingWithRelations": { "title": "EmailMarketingWithRelations", "type": "object", "description": "(tsType: EmailMarketingWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "subject": { "type": "string" }, "type": { "type": "string" }, "customMails": { "type": "string" }, "content": { "type": "string" }, "status": { "type": "number" }, "schedule_date": { "type": "string" }, "schedule_time": { "type": "string" }, "is_sent": { "type": "number" }, "sent_by_broker": { "type": "number" }, "group_id": { "type": "number" }, "created": { "type": "string", "format": "date-time" }, "updated": { "type": "string", "format": "date-time" }, "sent_from": { "type": "string" }, "campaign_id": { "type": "string" }, "follow_up_campaign_id": { "type": "number" }, "follow_up": { "type": "number" }, "customFirstNames": { "type": "string" }, "is_sent_follow_up": { "type": "number" }, "userId": { "type": "number" }, "user": { "$ref": "#/components/schemas/UserWithRelations" }, "foreignKey": {} }, "required": [ "subject", "type", "content" ], "additionalProperties": false, "x-typescript-type": "EmailMarketingWithRelations" }, "Datonboardcarrier": { "title": "Datonboardcarrier", "type": "object", "properties": { "id": { "type": "number" }, "carrierId": { "type": "string" }, "carrierMC": { "type": "number" }, "carrierDOT": { "type": "number" }, "dateVisited": { "type": "string", "format": "date-time" }, "dateVisited_old": { "type": "string", "format": "date-time" }, "company": { "type": "string" }, "physicalAddress": { "type": "string" }, "mailingAddress": { "type": "string" }, "portalId": { "type": "number" } }, "required": [ "carrierId" ], "additionalProperties": false }, "NewDatonboardcarrier": { "title": "NewDatonboardcarrier", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewDatonboardcarrier', exclude: [ 'id' ] })", "properties": { "carrierId": { "type": "string" }, "carrierMC": { "type": "number" }, "carrierDOT": { "type": "number" }, "dateVisited": { "type": "string", "format": "date-time" }, "dateVisited_old": { "type": "string", "format": "date-time" }, "company": { "type": "string" }, "physicalAddress": { "type": "string" }, "mailingAddress": { "type": "string" }, "portalId": { "type": "number" } }, "required": [ "carrierId" ], "additionalProperties": false, "x-typescript-type": "Omit" }, "DatonboardcarrierWithRelations": { "title": "DatonboardcarrierWithRelations", "type": "object", "description": "(tsType: DatonboardcarrierWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "carrierId": { "type": "string" }, "carrierMC": { "type": "number" }, "carrierDOT": { "type": "number" }, "dateVisited": { "type": "string", "format": "date-time" }, "dateVisited_old": { "type": "string", "format": "date-time" }, "company": { "type": "string" }, "physicalAddress": { "type": "string" }, "mailingAddress": { "type": "string" }, "portalId": { "type": "number" } }, "required": [ "carrierId" ], "additionalProperties": false, "x-typescript-type": "DatonboardcarrierWithRelations" }, "DatonboardcarrierPartial": { "title": "DatonboardcarrierPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number" }, "carrierId": { "type": "string" }, "carrierMC": { "type": "number" }, "carrierDOT": { "type": "number" }, "dateVisited": { "type": "string", "format": "date-time" }, "dateVisited_old": { "type": "string", "format": "date-time" }, "company": { "type": "string" }, "physicalAddress": { "type": "string" }, "mailingAddress": { "type": "string" }, "portalId": { "type": "number" } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "DatKeys": { "title": "DatKeys", "type": "object", "properties": { "id": { "type": "number" }, "portalId": { "type": "number" }, "primary_token": { "type": "string" }, "secondary_token": { "type": "string" }, "expiration": { "type": "string" }, "status": { "type": "number" }, "token_type": { "type": "string" }, "dat_header": { "type": "string" }, "sub_user": { "type": "string" }, "managerId": { "type": "number" } }, "required": [ "portalId", "primary_token", "secondary_token", "expiration", "token_type", "dat_header", "sub_user", "managerId" ], "additionalProperties": false }, "NewDatKeys": { "title": "NewDatKeys", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewDatKeys', exclude: [ 'id' ] })", "properties": { "portalId": { "type": "number" }, "primary_token": { "type": "string" }, "secondary_token": { "type": "string" }, "expiration": { "type": "string" }, "status": { "type": "number" }, "token_type": { "type": "string" }, "dat_header": { "type": "string" }, "sub_user": { "type": "string" }, "managerId": { "type": "number" } }, "required": [ "portalId", "primary_token", "secondary_token", "expiration", "token_type", "dat_header", "sub_user", "managerId" ], "additionalProperties": false, "x-typescript-type": "Omit" }, "DatKeysWithRelations": { "title": "DatKeysWithRelations", "type": "object", "description": "(tsType: DatKeysWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "portalId": { "type": "number" }, "primary_token": { "type": "string" }, "secondary_token": { "type": "string" }, "expiration": { "type": "string" }, "status": { "type": "number" }, "token_type": { "type": "string" }, "dat_header": { "type": "string" }, "sub_user": { "type": "string" }, "managerId": { "type": "number" } }, "required": [ "portalId", "primary_token", "secondary_token", "expiration", "token_type", "dat_header", "sub_user", "managerId" ], "additionalProperties": false, "x-typescript-type": "DatKeysWithRelations" }, "DatKeysPartial": { "title": "DatKeysPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number" }, "portalId": { "type": "number" }, "primary_token": { "type": "string" }, "secondary_token": { "type": "string" }, "expiration": { "type": "string" }, "status": { "type": "number" }, "token_type": { "type": "string" }, "dat_header": { "type": "string" }, "sub_user": { "type": "string" }, "managerId": { "type": "number" } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "Countries": { "title": "Countries", "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "iso3": { "type": "string" }, "numeric_code": { "type": "string" }, "iso2": { "type": "string" }, "phonecode": { "type": "string" }, "capital": { "type": "string" }, "currency": { "type": "string" }, "currency_name": { "type": "string" }, "currency_symbol": { "type": "string" }, "tld": { "type": "string" }, "native": { "type": "string" }, "region": { "type": "string" }, "subregion": { "type": "string" }, "nationality": { "type": "string" }, "timezones": { "type": "object" }, "translations": { "type": "object" }, "latitude": { "type": "string" }, "longitude": { "type": "string" }, "emojiU": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "flag": { "type": "number" }, "wikiDataId": { "type": "string" } }, "required": [ "name" ], "additionalProperties": false }, "NewCountries": { "title": "NewCountries", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewCountries', exclude: [ 'id' ] })", "properties": { "name": { "type": "string" }, "iso3": { "type": "string" }, "numeric_code": { "type": "string" }, "iso2": { "type": "string" }, "phonecode": { "type": "string" }, "capital": { "type": "string" }, "currency": { "type": "string" }, "currency_name": { "type": "string" }, "currency_symbol": { "type": "string" }, "tld": { "type": "string" }, "native": { "type": "string" }, "region": { "type": "string" }, "subregion": { "type": "string" }, "nationality": { "type": "string" }, "timezones": { "type": "object" }, "translations": { "type": "object" }, "latitude": { "type": "string" }, "longitude": { "type": "string" }, "emojiU": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "flag": { "type": "number" }, "wikiDataId": { "type": "string" } }, "required": [ "name" ], "additionalProperties": false, "x-typescript-type": "Omit" }, "CountriesWithRelations": { "title": "CountriesWithRelations", "type": "object", "description": "(tsType: CountriesWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "iso3": { "type": "string" }, "numeric_code": { "type": "string" }, "iso2": { "type": "string" }, "phonecode": { "type": "string" }, "capital": { "type": "string" }, "currency": { "type": "string" }, "currency_name": { "type": "string" }, "currency_symbol": { "type": "string" }, "tld": { "type": "string" }, "native": { "type": "string" }, "region": { "type": "string" }, "subregion": { "type": "string" }, "nationality": { "type": "string" }, "timezones": { "type": "object" }, "translations": { "type": "object" }, "latitude": { "type": "string" }, "longitude": { "type": "string" }, "emojiU": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "flag": { "type": "number" }, "wikiDataId": { "type": "string" }, "states": { "type": "array", "items": { "$ref": "#/components/schemas/StatesWithRelations" } } }, "required": [ "name" ], "additionalProperties": false, "x-typescript-type": "CountriesWithRelations" }, "CountriesPartial": { "title": "CountriesPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "iso3": { "type": "string" }, "numeric_code": { "type": "string" }, "iso2": { "type": "string" }, "phonecode": { "type": "string" }, "capital": { "type": "string" }, "currency": { "type": "string" }, "currency_name": { "type": "string" }, "currency_symbol": { "type": "string" }, "tld": { "type": "string" }, "native": { "type": "string" }, "region": { "type": "string" }, "subregion": { "type": "string" }, "nationality": { "type": "string" }, "timezones": { "type": "object" }, "translations": { "type": "object" }, "latitude": { "type": "string" }, "longitude": { "type": "string" }, "emojiU": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "flag": { "type": "number" }, "wikiDataId": { "type": "string" } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "States": { "title": "States", "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "country_code": { "type": "string" }, "fips_code": { "type": "string" }, "iso2": { "type": "string" }, "latitude": { "type": "string" }, "longitude": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "flag": { "type": "number" }, "wikiDataId": { "type": "string" }, "countriesId": { "type": "number" } }, "required": [ "name", "country_code" ], "additionalProperties": false }, "NewStatesInCountries": { "title": "NewStatesInCountries", "type": "object", "description": "(tsType: @loopback/repository-json-schema#Optional, 'countriesId'>, schemaOptions: { title: 'NewStatesInCountries', exclude: [ 'id' ], optional: [ 'countriesId' ] })", "properties": { "name": { "type": "string" }, "country_code": { "type": "string" }, "fips_code": { "type": "string" }, "iso2": { "type": "string" }, "latitude": { "type": "string" }, "longitude": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "flag": { "type": "number" }, "wikiDataId": { "type": "string" }, "countriesId": { "type": "number" } }, "required": [ "name", "country_code" ], "additionalProperties": false, "x-typescript-type": "@loopback/repository-json-schema#Optional, 'countriesId'>" }, "StatesPartial": { "title": "StatesPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "country_code": { "type": "string" }, "fips_code": { "type": "string" }, "iso2": { "type": "string" }, "latitude": { "type": "string" }, "longitude": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "flag": { "type": "number" }, "wikiDataId": { "type": "string" }, "countriesId": { "type": "number" } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "NewCompaniesInsurance": { "title": "NewCompaniesInsurance", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewCompaniesInsurance', exclude: [ 'id' ] })", "properties": { "name": { "type": "string" }, "status": { "type": "number" }, "portalId": { "type": "number" } }, "required": [ "portalId" ], "additionalProperties": false, "x-typescript-type": "Omit" }, "CompaniesInsuranceWithRelations": { "title": "CompaniesInsuranceWithRelations", "type": "object", "description": "(tsType: CompaniesInsuranceWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "status": { "type": "number" }, "portalId": { "type": "number" } }, "required": [ "portalId" ], "additionalProperties": false, "x-typescript-type": "CompaniesInsuranceWithRelations" }, "NewCommodities": { "title": "NewCommodities", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewCommodities', exclude: [ 'id' ] })", "properties": { "name": { "type": "string" }, "status": { "type": "number", "enum": [ 0, 1, 2 ] }, "EstimatedValue": { "type": "string", "nullable": true }, "created": { "type": "string", "format": "date-time" }, "user_id": { "type": "number" }, "modified": { "type": "string", "format": "date-time" } }, "required": [ "name", "status" ], "additionalProperties": false, "x-typescript-type": "Omit" }, "CommoditiesPartial": { "title": "CommoditiesPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "status": { "type": "number", "enum": [ 0, 1, 2 ] }, "EstimatedValue": { "type": "string", "nullable": true }, "created": { "type": "string", "format": "date-time" }, "user_id": { "type": "number" }, "modified": { "type": "string", "format": "date-time" } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "CollectionNotes": { "title": "CollectionNotes", "type": "object", "properties": { "id": { "type": "number" }, "uid": { "type": "string" }, "shippersId": { "type": "number" }, "userId": { "type": "number" }, "portalId": { "type": "number" }, "ArUserID": { "type": "number" }, "spokeTo": { "type": "string", "nullable": true }, "date": { "type": "string", "format": "date-time" }, "reason": { "type": "string", "nullable": true }, "pendingAmount": { "type": "number", "nullable": true }, "receivedAmount": { "type": "number", "nullable": true }, "insuranceCharge": { "type": "number", "nullable": true }, "time": { "type": "string", "format": "date-time" }, "status": { "type": "number" }, "created": { "type": "string", "format": "date-time" } }, "required": [ "uid" ], "additionalProperties": false }, "Cmt": { "title": "Cmt", "type": "object", "properties": { "id": { "type": "number" }, "shipmentId": { "type": "number" }, "from": { "type": "number" }, "to": { "type": "number" }, "shipper": { "type": "number" }, "carrier": { "type": "number" }, "margin": { "type": "number" }, "cmt": { "type": "number" }, "percentage": { "type": "number" }, "comment": { "type": "string" }, "cmtFor": { "type": "string", "format": "date-time" }, "created": { "type": "string", "format": "date-time" }, "updated": { "type": "string", "format": "date-time" } }, "required": [ "shipmentId", "from", "to", "cmtFor" ], "additionalProperties": false }, "CmtWithRelations": { "title": "CmtWithRelations", "type": "object", "description": "(tsType: CmtWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "shipmentId": { "type": "number" }, "from": { "type": "number" }, "to": { "type": "number" }, "shipper": { "type": "number" }, "carrier": { "type": "number" }, "margin": { "type": "number" }, "cmt": { "type": "number" }, "percentage": { "type": "number" }, "comment": { "type": "string" }, "cmtFor": { "type": "string", "format": "date-time" }, "created": { "type": "string", "format": "date-time" }, "updated": { "type": "string", "format": "date-time" } }, "required": [ "shipmentId", "from", "to", "cmtFor" ], "additionalProperties": false, "x-typescript-type": "CmtWithRelations" }, "CmtPartial": { "title": "CmtPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number" }, "shipmentId": { "type": "number" }, "from": { "type": "number" }, "to": { "type": "number" }, "shipper": { "type": "number" }, "carrier": { "type": "number" }, "margin": { "type": "number" }, "cmt": { "type": "number" }, "percentage": { "type": "number" }, "comment": { "type": "string" }, "cmtFor": { "type": "string", "format": "date-time" }, "created": { "type": "string", "format": "date-time" }, "updated": { "type": "string", "format": "date-time" } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "NewCities": { "title": "NewCities", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewCities', exclude: [ 'id' ] })", "properties": { "name": { "type": "string" }, "state_code": { "type": "string" }, "country_code": { "type": "string" }, "latitude": { "type": "string" }, "longitude": { "type": "string" }, "updated_at": { "type": "string", "format": "date-time" }, "created_at": { "type": "string", "format": "date-time" }, "flag": { "type": "number" }, "wikiDataId": { "type": "string" }, "statesId": { "type": "number" }, "countriesId": { "type": "number" } }, "required": [ "name" ], "additionalProperties": false, "x-typescript-type": "Omit" }, "CitiesWithRelations": { "title": "CitiesWithRelations", "type": "object", "description": "(tsType: CitiesWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "state_code": { "type": "string" }, "country_code": { "type": "string" }, "latitude": { "type": "string" }, "longitude": { "type": "string" }, "updated_at": { "type": "string", "format": "date-time" }, "created_at": { "type": "string", "format": "date-time" }, "flag": { "type": "number" }, "wikiDataId": { "type": "string" }, "statesId": { "type": "number" }, "countriesId": { "type": "number" }, "states": { "$ref": "#/components/schemas/StatesWithRelations" }, "foreignKey": {}, "countries": { "$ref": "#/components/schemas/CountriesWithRelations" } }, "required": [ "name" ], "additionalProperties": false, "x-typescript-type": "CitiesWithRelations" }, "NewCarriers": { "title": "NewCarriers", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewCarriers', exclude: [ 'id', 'portalId', 'userId', 'uid', 'status' ] })", "properties": { "mc": { "type": "string", "nullable": true }, "dot": { "type": "string", "nullable": true }, "nsc": { "type": "string", "nullable": true }, "company_name": { "type": "string" }, "address": { "type": "string" }, "phone_no": { "type": "string" }, "fax": { "type": "string" }, "email": { "type": "string", "format": "email", "minLength": 5, "maxLength": 50, "transform": [ "toLowerCase" ], "nullable": true }, "dispatcher": { "type": "string" }, "zip": { "type": "string" }, "cargo_amount": { "type": "number" }, "cargo_expires": { "type": "string", "format": "date-time" }, "trailer_interchange_expires": { "type": "string", "format": "date-time", "nullable": true }, "cargo_deductable": { "type": "number" }, "liability_amount": { "type": "number" }, "liability_expires": { "type": "string", "format": "date-time" }, "gen_liability_amount": { "type": "number" }, "gen_liab_expires": { "type": "string", "format": "date-time" }, "trailer_interchange_amount": { "type": "number", "nullable": true }, "reefer_breakdown": { "type": "number", "enum": [ 0, 1 ] }, "reefer_breakdown_deduct": { "type": "number", "nullable": true }, "contact_authority": { "type": "string", "nullable": true }, "common_authority": { "type": "string", "nullable": true }, "safety_rating": { "type": "string", "nullable": true }, "driver_name": { "type": "string", "nullable": true }, "driver_phone": { "type": "string", "nullable": true }, "w9_w8_type": { "type": "string" }, "tin_type": { "type": "string" }, "ein_ssn_number": { "type": "string" }, "carrier_type": { "type": "string" }, "carrier_email": { "type": "string", "format": "email", "minLength": 5, "maxLength": 50, "transform": [ "toLowerCase" ] }, "pcf_besic_company_email": { "type": "string", "format": "email", "minLength": 5, "maxLength": 50, "transform": [ "toLowerCase" ] }, "pcf_besic_address": { "type": "string" }, "is_pcf": { "type": "number", "enum": [ 0, 1 ] }, "pcf_besic_phone": { "type": "string" }, "pcf_besic_fax": { "type": "string" }, "pcf_besic_concern_person": { "type": "string" }, "noa_pdf": { "type": "string" }, "pcf_additional_company_name": { "type": "string", "nullable": true }, "pcf_additional_w9_pdf": { "type": "string" }, "pcf_additional_signature_pdf": { "type": "string" }, "pcf_additional_ach_pdf": { "type": "string" }, "pcf_additional_cacci_pdf": { "type": "string" }, "pcf_additional_address": { "type": "string" }, "pcf_additional_phone": { "type": "string", "nullable": true }, "pcf_additional_fax": { "type": "string", "nullable": true }, "pcf_additional_email": { "type": "string", "nullable": true }, "pcf_additional_contact_person": { "type": "string", "nullable": true }, "factoringPayTo": { "type": "number", "nullable": true, "additionalProperties": true }, "payTo": { "type": "number" }, "firstApproval": { "type": "number" }, "email_marketing_status": { "type": "number" }, "qb_id": { "type": "string" }, "qb_status": { "type": "number" }, "pcf_qb_id": { "type": "string" }, "pcf_qb_status": { "type": "number" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "pcf_additional_zipCodeId": { "type": "number" }, "city": { "type": "number" }, "equipment_type": { "type": "number" }, "zipCodesId": { "type": "number" }, "factoringId": { "type": "number" }, "pcf_besic_zipCodeId": { "type": "number" } }, "required": [ "email", "cargo_amount", "cargo_expires", "cargo_deductable", "liability_amount", "gen_liability_amount", "reefer_breakdown" ], "additionalProperties": false, "x-typescript-type": "Omit" }, "CarrierPaymentWithRelations": { "title": "CarrierPaymentWithRelations", "type": "object", "description": "(tsType: CarrierPaymentWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "agingDate": { "type": "string", "format": "date-time" }, "paymentInitiated": { "type": "string", "format": "date-time", "nullable": true }, "attachment": { "type": "string" }, "notes": { "type": "string", "nullable": true }, "paymentStatus": { "type": "number" }, "brokerName": { "type": "string", "nullable": true }, "qpStatus": { "type": "number" }, "amountUsd": { "type": "number" }, "amountCad": { "type": "number" }, "paymentType": { "type": "number" }, "paymentMethod": { "type": "string" }, "payTo": { "type": "number" }, "subject": { "type": "string", "nullable": true }, "message": { "type": "string", "nullable": true }, "qb_id": { "type": "string" }, "qb_status": { "type": "number" }, "doc_number": { "type": "string" }, "VlAsiDocNumber": { "type": "string" }, "oldPaymentDate": { "type": "string", "format": "date-time", "nullable": true }, "shipmentId": { "type": "number" }, "carriersId": { "type": "number" }, "userId": { "type": "number" }, "apId": { "type": "number" }, "portalId": { "type": "number" }, "carrierAgingId": { "type": "number" }, "shipment": { "$ref": "#/components/schemas/ShipmentWithRelations" }, "foreignKey": {}, "carriers": { "$ref": "#/components/schemas/CarriersWithRelations" }, "user": { "$ref": "#/components/schemas/UserWithRelations" }, "ap": { "$ref": "#/components/schemas/UserWithRelations" }, "portal": { "$ref": "#/components/schemas/PortalWithRelations" }, "carrierAging": { "$ref": "#/components/schemas/CarrierAgingWithRelations" }, "apEmailToCarriers": { "type": "array", "items": { "$ref": "#/components/schemas/ApEmailToCarrierWithRelations" } } }, "additionalProperties": false, "x-typescript-type": "CarrierPaymentWithRelations" }, "RoleWithRelations": { "title": "RoleWithRelations", "type": "object", "description": "(tsType: RoleWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "permissions": { "type": "array", "items": { "type": "string" } }, "role_key": { "type": "number" }, "type": { "type": "number" }, "defaultPermissions": { "type": "array", "items": { "type": "string" } }, "portalId": { "type": "number" }, "portal": { "$ref": "#/components/schemas/PortalWithRelations" }, "foreignKey": {}, "users": { "type": "array", "items": { "$ref": "#/components/schemas/UserWithRelations" } } }, "required": [ "name" ], "additionalProperties": false, "x-typescript-type": "RoleWithRelations" }, "StatesWithRelations": { "title": "StatesWithRelations", "type": "object", "description": "(tsType: StatesWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "country_code": { "type": "string" }, "fips_code": { "type": "string" }, "iso2": { "type": "string" }, "latitude": { "type": "string" }, "longitude": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "flag": { "type": "number" }, "wikiDataId": { "type": "string" }, "countriesId": { "type": "number" }, "cities": { "type": "array", "items": { "$ref": "#/components/schemas/CitiesWithRelations" } } }, "required": [ "name", "country_code" ], "additionalProperties": false, "x-typescript-type": "StatesWithRelations" }, "ApDetailsWithRelations": { "title": "ApDetailsWithRelations", "type": "object", "description": "(tsType: ApDetailsWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "payTo": { "type": "number", "nullable": true }, "achBankName": { "type": "string", "nullable": true }, "achAccountNumber": { "type": "string", "nullable": true }, "achAccountType": { "type": "string", "nullable": true }, "achRoutingNumber": { "type": "string", "nullable": true }, "achBankType": { "type": "string", "nullable": true }, "wireBankName": { "type": "string", "nullable": true }, "wireAccountNumber": { "type": "string", "nullable": true }, "wireAccountType": { "type": "string", "nullable": true }, "wireRoutingNumber": { "type": "string", "nullable": true }, "wireSwiftCode": { "type": "string", "nullable": true }, "wireBankType": { "type": "string", "nullable": true }, "creditComment": { "type": "string", "nullable": true }, "primary_method": { "type": "string", "nullable": true }, "carriersId": { "type": "number" }, "carriers": { "$ref": "#/components/schemas/CarriersWithRelations" }, "foreignKey": {} }, "additionalProperties": false, "x-typescript-type": "ApDetailsWithRelations" }, "CarrierAgingWithRelations": { "title": "CarrierAgingWithRelations", "type": "object", "description": "(tsType: CarrierAgingWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "ap_agent_id": { "type": "number" }, "age_date": { "type": "string", "format": "date-time" }, "invoice_number": { "type": "string" }, "invoice_date": { "type": "string", "format": "date-time" }, "advance_payment_date": { "type": "string", "format": "date-time" }, "advance_pay_usd": { "type": "number" }, "advance_pay_cad": { "type": "number" }, "advance_pay_type": { "type": "string" }, "advance_pay_status": { "type": "number" }, "payable_amount_usd": { "type": "number" }, "payable_amount_cad": { "type": "number" }, "quick_book_invoice_status": { "type": "number" }, "quick_book_invoice_date": { "type": "string", "format": "date-time" }, "request_status": { "type": "number", "nullable": true }, "advance_pay_label": { "type": "string" }, "message": { "type": "string" }, "quick_pay": { "type": "number" }, "carriersId": { "type": "number" }, "userId": { "type": "number" }, "portalId": { "type": "number" }, "shipmentId": { "type": "number" }, "auditCreatedAt": { "type": "string", "format": "date-time" }, "auditComment": { "type": "string", "nullable": true }, "auditStatus": { "type": "string", "nullable": true }, "createdAt": { "type": "string", "format": "date-time" }, "carriers": { "$ref": "#/components/schemas/CarriersWithRelations" }, "foreignKey": {}, "user": { "$ref": "#/components/schemas/UserWithRelations" }, "portal": { "$ref": "#/components/schemas/PortalWithRelations" }, "shipment": { "$ref": "#/components/schemas/ShipmentWithRelations" } }, "additionalProperties": false, "x-typescript-type": "CarrierAgingWithRelations" }, "CarriersWithRelations": { "title": "CarriersWithRelations", "type": "object", "description": "(tsType: CarriersWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "uid": { "type": "string" }, "mc": { "type": "string", "nullable": true }, "dot": { "type": "string", "nullable": true }, "nsc": { "type": "string", "nullable": true }, "company_name": { "type": "string" }, "address": { "type": "string" }, "phone_no": { "type": "string" }, "fax": { "type": "string" }, "email": { "type": "string", "format": "email", "minLength": 5, "maxLength": 50, "transform": [ "toLowerCase" ], "nullable": true }, "dispatcher": { "type": "string" }, "zip": { "type": "string" }, "cargo_amount": { "type": "number" }, "cargo_expires": { "type": "string", "format": "date-time" }, "trailer_interchange_expires": { "type": "string", "format": "date-time", "nullable": true }, "cargo_deductable": { "type": "number" }, "liability_amount": { "type": "number" }, "liability_expires": { "type": "string", "format": "date-time" }, "gen_liability_amount": { "type": "number" }, "gen_liab_expires": { "type": "string", "format": "date-time" }, "trailer_interchange_amount": { "type": "number", "nullable": true }, "reefer_breakdown": { "type": "number", "enum": [ 0, 1 ] }, "reefer_breakdown_deduct": { "type": "number", "nullable": true }, "contact_authority": { "type": "string", "nullable": true }, "common_authority": { "type": "string", "nullable": true }, "safety_rating": { "type": "string", "nullable": true }, "driver_name": { "type": "string", "nullable": true }, "driver_phone": { "type": "string", "nullable": true }, "w9_w8_type": { "type": "string" }, "tin_type": { "type": "string" }, "ein_ssn_number": { "type": "string" }, "carrier_type": { "type": "string" }, "carrier_email": { "type": "string", "format": "email", "minLength": 5, "maxLength": 50, "transform": [ "toLowerCase" ] }, "pcf_besic_company_email": { "type": "string", "format": "email", "minLength": 5, "maxLength": 50, "transform": [ "toLowerCase" ] }, "pcf_besic_address": { "type": "string" }, "is_pcf": { "type": "number", "enum": [ 0, 1 ] }, "pcf_besic_phone": { "type": "string" }, "pcf_besic_fax": { "type": "string" }, "pcf_besic_concern_person": { "type": "string" }, "noa_pdf": { "type": "string" }, "pcf_additional_company_name": { "type": "string", "nullable": true }, "pcf_additional_w9_pdf": { "type": "string" }, "pcf_additional_signature_pdf": { "type": "string" }, "pcf_additional_ach_pdf": { "type": "string" }, "pcf_additional_cacci_pdf": { "type": "string" }, "pcf_additional_address": { "type": "string" }, "pcf_additional_phone": { "type": "string", "nullable": true }, "pcf_additional_fax": { "type": "string", "nullable": true }, "pcf_additional_email": { "type": "string", "nullable": true }, "pcf_additional_contact_person": { "type": "string", "nullable": true }, "status": { "type": "number", "enum": [ 0, 1, 2 ] }, "factoringPayTo": { "type": "number", "nullable": true, "additionalProperties": true }, "payTo": { "type": "number" }, "firstApproval": { "type": "number" }, "email_marketing_status": { "type": "number" }, "qb_id": { "type": "string" }, "qb_status": { "type": "number" }, "pcf_qb_id": { "type": "string" }, "pcf_qb_status": { "type": "number" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "userId": { "type": "number" }, "portalId": { "type": "number" }, "pcf_additional_zipCodeId": { "type": "number" }, "city": { "type": "number" }, "equipment_type": { "type": "number" }, "zipCodesId": { "type": "number" }, "factoringId": { "type": "number" }, "pcf_besic_zipCodeId": { "type": "number" }, "user": { "$ref": "#/components/schemas/UserWithRelations" }, "foreignKey": {}, "portal": { "$ref": "#/components/schemas/PortalWithRelations" }, "pcf_additional_zipCode": { "$ref": "#/components/schemas/ZipCodesWithRelations" }, "cities": { "$ref": "#/components/schemas/CitiesWithRelations" }, "equipments": { "$ref": "#/components/schemas/EquipmentWithRelations" }, "zipCodes": { "$ref": "#/components/schemas/ZipCodesWithRelations" }, "factoring": { "$ref": "#/components/schemas/FactoringDetailsWithRelations" }, "paymentMethods": { "$ref": "#/components/schemas/PaymentMethodsWithRelations" }, "pcf_besic_zipCode": { "$ref": "#/components/schemas/ZipCodesWithRelations" }, "apDetails": { "$ref": "#/components/schemas/ApDetailsWithRelations" }, "carrierAging": { "type": "array", "items": { "$ref": "#/components/schemas/CarrierAgingWithRelations" } }, "shipments": { "type": "array", "items": { "$ref": "#/components/schemas/ShipmentWithRelations" } } }, "required": [ "uid", "email", "cargo_amount", "cargo_expires", "cargo_deductable", "liability_amount", "gen_liability_amount", "reefer_breakdown", "status" ], "additionalProperties": false, "x-typescript-type": "CarriersWithRelations" }, "CarriersPartial": { "title": "CarriersPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number" }, "uid": { "type": "string" }, "mc": { "type": "string", "nullable": true }, "dot": { "type": "string", "nullable": true }, "nsc": { "type": "string", "nullable": true }, "company_name": { "type": "string" }, "address": { "type": "string" }, "phone_no": { "type": "string" }, "fax": { "type": "string" }, "email": { "type": "string", "format": "email", "minLength": 5, "maxLength": 50, "transform": [ "toLowerCase" ], "nullable": true }, "dispatcher": { "type": "string" }, "zip": { "type": "string" }, "cargo_amount": { "type": "number" }, "cargo_expires": { "type": "string", "format": "date-time" }, "trailer_interchange_expires": { "type": "string", "format": "date-time", "nullable": true }, "cargo_deductable": { "type": "number" }, "liability_amount": { "type": "number" }, "liability_expires": { "type": "string", "format": "date-time" }, "gen_liability_amount": { "type": "number" }, "gen_liab_expires": { "type": "string", "format": "date-time" }, "trailer_interchange_amount": { "type": "number", "nullable": true }, "reefer_breakdown": { "type": "number", "enum": [ 0, 1 ] }, "reefer_breakdown_deduct": { "type": "number", "nullable": true }, "contact_authority": { "type": "string", "nullable": true }, "common_authority": { "type": "string", "nullable": true }, "safety_rating": { "type": "string", "nullable": true }, "driver_name": { "type": "string", "nullable": true }, "driver_phone": { "type": "string", "nullable": true }, "w9_w8_type": { "type": "string" }, "tin_type": { "type": "string" }, "ein_ssn_number": { "type": "string" }, "carrier_type": { "type": "string" }, "carrier_email": { "type": "string", "format": "email", "minLength": 5, "maxLength": 50, "transform": [ "toLowerCase" ] }, "pcf_besic_company_email": { "type": "string", "format": "email", "minLength": 5, "maxLength": 50, "transform": [ "toLowerCase" ] }, "pcf_besic_address": { "type": "string" }, "is_pcf": { "type": "number", "enum": [ 0, 1 ] }, "pcf_besic_phone": { "type": "string" }, "pcf_besic_fax": { "type": "string" }, "pcf_besic_concern_person": { "type": "string" }, "noa_pdf": { "type": "string" }, "pcf_additional_company_name": { "type": "string", "nullable": true }, "pcf_additional_w9_pdf": { "type": "string" }, "pcf_additional_signature_pdf": { "type": "string" }, "pcf_additional_ach_pdf": { "type": "string" }, "pcf_additional_cacci_pdf": { "type": "string" }, "pcf_additional_address": { "type": "string" }, "pcf_additional_phone": { "type": "string", "nullable": true }, "pcf_additional_fax": { "type": "string", "nullable": true }, "pcf_additional_email": { "type": "string", "nullable": true }, "pcf_additional_contact_person": { "type": "string", "nullable": true }, "status": { "type": "number", "enum": [ 0, 1, 2 ] }, "factoringPayTo": { "type": "number", "nullable": true, "additionalProperties": true }, "payTo": { "type": "number" }, "firstApproval": { "type": "number" }, "email_marketing_status": { "type": "number" }, "qb_id": { "type": "string" }, "qb_status": { "type": "number" }, "pcf_qb_id": { "type": "string" }, "pcf_qb_status": { "type": "number" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "userId": { "type": "number" }, "portalId": { "type": "number" }, "pcf_additional_zipCodeId": { "type": "number" }, "city": { "type": "number" }, "equipment_type": { "type": "number" }, "zipCodesId": { "type": "number" }, "factoringId": { "type": "number" }, "pcf_besic_zipCodeId": { "type": "number" } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "ApDetailsPartial": { "title": "ApDetailsPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number" }, "payTo": { "type": "number", "nullable": true }, "achBankName": { "type": "string", "nullable": true }, "achAccountNumber": { "type": "string", "nullable": true }, "achAccountType": { "type": "string", "nullable": true }, "achRoutingNumber": { "type": "string", "nullable": true }, "achBankType": { "type": "string", "nullable": true }, "wireBankName": { "type": "string", "nullable": true }, "wireAccountNumber": { "type": "string", "nullable": true }, "wireAccountType": { "type": "string", "nullable": true }, "wireRoutingNumber": { "type": "string", "nullable": true }, "wireSwiftCode": { "type": "string", "nullable": true }, "wireBankType": { "type": "string", "nullable": true }, "creditComment": { "type": "string", "nullable": true }, "primary_method": { "type": "string", "nullable": true }, "carriersId": { "type": "number" } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "CarrierDocs": { "title": "CarrierDocs", "type": "object", "properties": { "id": { "type": "number" }, "podDoc": { "type": "string" }, "podDocStatus": { "type": "number" }, "lumperDoc": { "type": "string" }, "lumperDocStatus": { "type": "number" }, "triDoc": { "type": "string" }, "triDocStatus": { "type": "number" }, "otherDoc": { "type": "string" }, "otherDocStatus": { "type": "number" }, "invoiceDoc": { "type": "string" }, "invoiceDocStatus": { "type": "number" }, "invoiceNumber": { "type": "string" }, "invoiceDate": { "type": "string", "format": "date-time" }, "isApproved": { "type": "number" }, "remark": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "carrierLoginId": { "type": "number" }, "shipmentId": { "type": "number" } }, "additionalProperties": false }, "NewPaymentMethodsInCarriers": { "title": "NewPaymentMethodsInCarriers", "type": "object", "description": "(tsType: @loopback/repository-json-schema#Optional, 'carriersId'>, schemaOptions: { title: 'NewPaymentMethodsInCarriers', exclude: [ 'id' ], optional: [ 'carriersId' ] })", "properties": { "pay_by_ach": { "type": "boolean" }, "ach_bank_name": { "type": "string" }, "ach_account_number": { "type": "string" }, "ach_account_type": { "type": "string" }, "ach_routing_number": { "type": "string" }, "ach_bank_type": { "type": "string" }, "pay_by_wire": { "type": "boolean" }, "wire_bank_name": { "type": "string" }, "wire_account_number": { "type": "string" }, "wire_account_type": { "type": "string" }, "wire_rating_number": { "type": "string" }, "wire_swift_code": { "type": "string" }, "wire_bank_type": { "type": "string" }, "pay_by_credit_card": { "type": "boolean" }, "credit_card_comment": { "type": "string" }, "primery_method": { "type": "string" }, "carriersId": { "type": "number" }, "factoringId": { "type": "number" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository-json-schema#Optional, 'carriersId'>" }, "ApDetails": { "title": "ApDetails", "type": "object", "properties": { "id": { "type": "number" }, "payTo": { "type": "number", "nullable": true }, "achBankName": { "type": "string", "nullable": true }, "achAccountNumber": { "type": "string", "nullable": true }, "achAccountType": { "type": "string", "nullable": true }, "achRoutingNumber": { "type": "string", "nullable": true }, "achBankType": { "type": "string", "nullable": true }, "wireBankName": { "type": "string", "nullable": true }, "wireAccountNumber": { "type": "string", "nullable": true }, "wireAccountType": { "type": "string", "nullable": true }, "wireRoutingNumber": { "type": "string", "nullable": true }, "wireSwiftCode": { "type": "string", "nullable": true }, "wireBankType": { "type": "string", "nullable": true }, "creditComment": { "type": "string", "nullable": true }, "primary_method": { "type": "string", "nullable": true }, "carriersId": { "type": "number" } }, "additionalProperties": false }, "NewApDetailsInCarriers": { "title": "NewApDetailsInCarriers", "type": "object", "description": "(tsType: @loopback/repository-json-schema#Optional, 'carriersId'>, schemaOptions: { title: 'NewApDetailsInCarriers', exclude: [ 'id' ], optional: [ 'carriersId' ] })", "properties": { "payTo": { "type": "number", "nullable": true }, "achBankName": { "type": "string", "nullable": true }, "achAccountNumber": { "type": "string", "nullable": true }, "achAccountType": { "type": "string", "nullable": true }, "achRoutingNumber": { "type": "string", "nullable": true }, "achBankType": { "type": "string", "nullable": true }, "wireBankName": { "type": "string", "nullable": true }, "wireAccountNumber": { "type": "string", "nullable": true }, "wireAccountType": { "type": "string", "nullable": true }, "wireRoutingNumber": { "type": "string", "nullable": true }, "wireSwiftCode": { "type": "string", "nullable": true }, "wireBankType": { "type": "string", "nullable": true }, "creditComment": { "type": "string", "nullable": true }, "primary_method": { "type": "string", "nullable": true }, "carriersId": { "type": "number" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository-json-schema#Optional, 'carriersId'>" }, "CarrierRateConReport": { "title": "CarrierRateConReport", "type": "object", "properties": { "id": { "type": "number" }, "uid": { "type": "string" }, "toEmail": { "type": "string" }, "signeDocumentID": { "type": "string" }, "emailViewed": { "type": "string" }, "docViewed": { "type": "string" }, "signedOn": { "type": "string" }, "documentSigned": { "type": "string" }, "emailStatus": { "type": "number" }, "cprStatus": { "type": "number" }, "sendForStatus": { "type": "number" }, "portalId": { "type": "number" }, "carrierCommunicationPortalid": { "type": "number" }, "sendDate": { "type": "string", "format": "date-time" }, "signedDoc": { "type": "string" }, "userId": { "type": "number" }, "shipmentId": { "type": "number" } }, "required": [ "uid" ], "additionalProperties": false }, "NewCarrierRateConReport": { "title": "NewCarrierRateConReport", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewCarrierRateConReport', exclude: [ 'id' ] })", "properties": { "uid": { "type": "string" }, "toEmail": { "type": "string" }, "signeDocumentID": { "type": "string" }, "emailViewed": { "type": "string" }, "docViewed": { "type": "string" }, "signedOn": { "type": "string" }, "documentSigned": { "type": "string" }, "emailStatus": { "type": "number" }, "cprStatus": { "type": "number" }, "sendForStatus": { "type": "number" }, "portalId": { "type": "number" }, "carrierCommunicationPortalid": { "type": "number" }, "sendDate": { "type": "string", "format": "date-time" }, "signedDoc": { "type": "string" }, "userId": { "type": "number" }, "shipmentId": { "type": "number" } }, "required": [ "uid" ], "additionalProperties": false, "x-typescript-type": "Omit" }, "CarrierRateConReportWithRelations": { "title": "CarrierRateConReportWithRelations", "type": "object", "description": "(tsType: CarrierRateConReportWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "uid": { "type": "string" }, "toEmail": { "type": "string" }, "signeDocumentID": { "type": "string" }, "emailViewed": { "type": "string" }, "docViewed": { "type": "string" }, "signedOn": { "type": "string" }, "documentSigned": { "type": "string" }, "emailStatus": { "type": "number" }, "cprStatus": { "type": "number" }, "sendForStatus": { "type": "number" }, "portalId": { "type": "number" }, "carrierCommunicationPortalid": { "type": "number" }, "sendDate": { "type": "string", "format": "date-time" }, "signedDoc": { "type": "string" }, "userId": { "type": "number" }, "shipmentId": { "type": "number" }, "user": { "$ref": "#/components/schemas/UserWithRelations" }, "foreignKey": {}, "shipment": { "$ref": "#/components/schemas/ShipmentWithRelations" } }, "required": [ "uid" ], "additionalProperties": false, "x-typescript-type": "CarrierRateConReportWithRelations" }, "CarrierRateConReportPartial": { "title": "CarrierRateConReportPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number" }, "uid": { "type": "string" }, "toEmail": { "type": "string" }, "signeDocumentID": { "type": "string" }, "emailViewed": { "type": "string" }, "docViewed": { "type": "string" }, "signedOn": { "type": "string" }, "documentSigned": { "type": "string" }, "emailStatus": { "type": "number" }, "cprStatus": { "type": "number" }, "sendForStatus": { "type": "number" }, "portalId": { "type": "number" }, "carrierCommunicationPortalid": { "type": "number" }, "sendDate": { "type": "string", "format": "date-time" }, "signedDoc": { "type": "string" }, "userId": { "type": "number" }, "shipmentId": { "type": "number" } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "ApMessagesHistoryWithRelations": { "title": "ApMessagesHistoryWithRelations", "type": "object", "description": "(tsType: ApMessagesHistoryWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "message": { "type": "string" }, "regarding": { "type": "string" }, "created": { "type": "string", "format": "date-time" }, "userId": { "type": "number" }, "shipmentId": { "type": "number" }, "carriersId": { "type": "number" }, "user": { "$ref": "#/components/schemas/UserWithRelations" }, "foreignKey": {}, "shipment": { "$ref": "#/components/schemas/ShipmentWithRelations" }, "carriers": { "$ref": "#/components/schemas/CarriersWithRelations" } }, "additionalProperties": false, "x-typescript-type": "ApMessagesHistoryWithRelations" }, "CarrierPaymentHoldRequestHistory": { "title": "CarrierPaymentHoldRequestHistory", "type": "object", "properties": { "id": { "type": "number" }, "message": { "type": "string" }, "status": { "type": "number" }, "created": { "type": "string", "format": "date-time" }, "updated": { "type": "string", "format": "date-time" }, "BrokerId": { "type": "number" }, "portalId": { "type": "number" }, "shipmentId": { "type": "number" }, "firstApprovalId": { "type": "number" }, "managerApprovalId": { "type": "number" } }, "additionalProperties": false }, "CarrierPaymentHoldRequestHistoryWithRelations": { "title": "CarrierPaymentHoldRequestHistoryWithRelations", "type": "object", "description": "(tsType: CarrierPaymentHoldRequestHistoryWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "message": { "type": "string" }, "status": { "type": "number" }, "created": { "type": "string", "format": "date-time" }, "updated": { "type": "string", "format": "date-time" }, "BrokerId": { "type": "number" }, "portalId": { "type": "number" }, "shipmentId": { "type": "number" }, "firstApprovalId": { "type": "number" }, "managerApprovalId": { "type": "number" }, "Broker": { "$ref": "#/components/schemas/UserWithRelations" }, "foreignKey": {}, "portal": { "$ref": "#/components/schemas/PortalWithRelations" }, "shipment": { "$ref": "#/components/schemas/ShipmentWithRelations" }, "firstApproval": { "$ref": "#/components/schemas/UserWithRelations" }, "managerApproval": { "$ref": "#/components/schemas/UserWithRelations" } }, "additionalProperties": false, "x-typescript-type": "CarrierPaymentHoldRequestHistoryWithRelations" }, "ApEmailToCarrier": { "title": "ApEmailToCarrier", "type": "object", "properties": { "id": { "type": "number" }, "paymentType": { "type": "number", "nullable": true }, "paymentMethod": { "type": "string", "nullable": true }, "paymentInitiated": { "type": "string", "format": "date-time", "nullable": true }, "brokerEmail": { "type": "string", "nullable": true }, "carrierEmail": { "type": "string", "nullable": true }, "notes": { "type": "string", "nullable": true }, "containerNo": { "type": "string", "nullable": true }, "carrierInvoiceNumber": { "type": "string", "nullable": true }, "fcarrierName": { "type": "string", "nullable": true }, "cName": { "type": "string", "nullable": true }, "acName": { "type": "string", "nullable": true }, "achAccountNo": { "type": "string", "nullable": true }, "wireAccountNo": { "type": "string", "nullable": true }, "amountUsd": { "type": "number", "nullable": true }, "amountCad": { "type": "number", "nullable": true }, "address": { "type": "string", "nullable": true }, "emailStatus": { "type": "string", "nullable": true }, "quickPay": { "type": "number", "nullable": true }, "batchNumber": { "type": "string", "nullable": true }, "attachment": { "type": "string", "nullable": true }, "zipCodesId": { "type": "number", "nullable": true }, "createdAt": { "type": "string", "format": "date-time", "nullable": true }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true }, "portalId": { "type": "number" }, "carriersId": { "type": "number" }, "shipmentId": { "type": "number" }, "carrierPaymentId": { "type": "number" } }, "additionalProperties": false }, "NewApEmailToCarrierInCarrierPayment": { "title": "NewApEmailToCarrierInCarrierPayment", "type": "object", "description": "(tsType: @loopback/repository-json-schema#Optional, 'carrierPaymentId'>, schemaOptions: { title: 'NewApEmailToCarrierInCarrierPayment', exclude: [ 'id' ], optional: [ 'carrierPaymentId' ] })", "properties": { "paymentType": { "type": "number", "nullable": true }, "paymentMethod": { "type": "string", "nullable": true }, "paymentInitiated": { "type": "string", "format": "date-time", "nullable": true }, "brokerEmail": { "type": "string", "nullable": true }, "carrierEmail": { "type": "string", "nullable": true }, "notes": { "type": "string", "nullable": true }, "containerNo": { "type": "string", "nullable": true }, "carrierInvoiceNumber": { "type": "string", "nullable": true }, "fcarrierName": { "type": "string", "nullable": true }, "cName": { "type": "string", "nullable": true }, "acName": { "type": "string", "nullable": true }, "achAccountNo": { "type": "string", "nullable": true }, "wireAccountNo": { "type": "string", "nullable": true }, "amountUsd": { "type": "number", "nullable": true }, "amountCad": { "type": "number", "nullable": true }, "address": { "type": "string", "nullable": true }, "emailStatus": { "type": "string", "nullable": true }, "quickPay": { "type": "number", "nullable": true }, "batchNumber": { "type": "string", "nullable": true }, "attachment": { "type": "string", "nullable": true }, "zipCodesId": { "type": "number", "nullable": true }, "createdAt": { "type": "string", "format": "date-time", "nullable": true }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true }, "portalId": { "type": "number" }, "carriersId": { "type": "number" }, "shipmentId": { "type": "number" }, "carrierPaymentId": { "type": "number" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository-json-schema#Optional, 'carrierPaymentId'>" }, "ApEmailToCarrierPartial": { "title": "ApEmailToCarrierPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number" }, "paymentType": { "type": "number", "nullable": true }, "paymentMethod": { "type": "string", "nullable": true }, "paymentInitiated": { "type": "string", "format": "date-time", "nullable": true }, "brokerEmail": { "type": "string", "nullable": true }, "carrierEmail": { "type": "string", "nullable": true }, "notes": { "type": "string", "nullable": true }, "containerNo": { "type": "string", "nullable": true }, "carrierInvoiceNumber": { "type": "string", "nullable": true }, "fcarrierName": { "type": "string", "nullable": true }, "cName": { "type": "string", "nullable": true }, "acName": { "type": "string", "nullable": true }, "achAccountNo": { "type": "string", "nullable": true }, "wireAccountNo": { "type": "string", "nullable": true }, "amountUsd": { "type": "number", "nullable": true }, "amountCad": { "type": "number", "nullable": true }, "address": { "type": "string", "nullable": true }, "emailStatus": { "type": "string", "nullable": true }, "quickPay": { "type": "number", "nullable": true }, "batchNumber": { "type": "string", "nullable": true }, "attachment": { "type": "string", "nullable": true }, "zipCodesId": { "type": "number", "nullable": true }, "createdAt": { "type": "string", "format": "date-time", "nullable": true }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true }, "portalId": { "type": "number" }, "carriersId": { "type": "number" }, "shipmentId": { "type": "number" }, "carrierPaymentId": { "type": "number" } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "CarrierLogin": { "title": "CarrierLogin", "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "email": { "type": "string" }, "phone": { "type": "string" }, "profile_image": { "type": "string" }, "cdl_doc": { "type": "string" }, "company_logo": { "type": "string" }, "otp": { "type": "string" }, "role": { "type": "number" }, "switchRole": { "type": "number" }, "password": { "type": "string" }, "realPassword": { "type": "string" }, "inviteCode": { "type": "string" }, "deviceToken": { "type": "string", "nullable": true }, "deviceTokenIos": { "type": "string", "nullable": true }, "twoFactor": { "type": "number", "enum": [ 0, 1 ] }, "status": { "type": "number" }, "portalId": { "type": "number" }, "carrier_id": { "type": "number" }, "created_at": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "email", "twoFactor" ], "additionalProperties": false }, "NewCarrierLogin": { "title": "NewCarrierLogin", "type": "object", "description": "(tsType: @loopback/repository-json-schema#Optional, 'name' | 'phone' | 'cdl_doc' | 'email' | 'status'>, schemaOptions: { title: 'NewCarrierLogin', exclude: [ 'id', 'portalId', 'created_at' ], optional: [ 'name', 'phone', 'cdl_doc', 'email', 'status' ] })", "properties": { "name": { "type": "string" }, "email": { "type": "string" }, "phone": { "type": "string" }, "profile_image": { "type": "string" }, "cdl_doc": { "type": "string" }, "company_logo": { "type": "string" }, "otp": { "type": "string" }, "role": { "type": "number" }, "switchRole": { "type": "number" }, "password": { "type": "string" }, "realPassword": { "type": "string" }, "inviteCode": { "type": "string" }, "deviceToken": { "type": "string", "nullable": true }, "deviceTokenIos": { "type": "string", "nullable": true }, "twoFactor": { "type": "number", "enum": [ 0, 1 ] }, "status": { "type": "number" }, "carrier_id": { "type": "number" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "twoFactor" ], "additionalProperties": false, "x-typescript-type": "@loopback/repository-json-schema#Optional, 'name' | 'phone' | 'cdl_doc' | 'email' | 'status'>" }, "CarrierLoginWithRelations": { "title": "CarrierLoginWithRelations", "type": "object", "description": "(tsType: CarrierLoginWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "email": { "type": "string" }, "phone": { "type": "string" }, "profile_image": { "type": "string" }, "cdl_doc": { "type": "string" }, "company_logo": { "type": "string" }, "otp": { "type": "string" }, "role": { "type": "number" }, "switchRole": { "type": "number" }, "password": { "type": "string" }, "realPassword": { "type": "string" }, "inviteCode": { "type": "string" }, "deviceToken": { "type": "string", "nullable": true }, "deviceTokenIos": { "type": "string", "nullable": true }, "twoFactor": { "type": "number", "enum": [ 0, 1 ] }, "status": { "type": "number" }, "portalId": { "type": "number" }, "carrier_id": { "type": "number" }, "created_at": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "portal": { "$ref": "#/components/schemas/PortalWithRelations" }, "foreignKey": {}, "carrier": { "$ref": "#/components/schemas/CarriersWithRelations" }, "carrierCdlData": { "$ref": "#/components/schemas/CarrierCdlDataWithRelations" } }, "required": [ "email", "twoFactor" ], "additionalProperties": false, "x-typescript-type": "CarrierLoginWithRelations" }, "CarrierLoginPartial": { "title": "CarrierLoginPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "email": { "type": "string" }, "phone": { "type": "string" }, "profile_image": { "type": "string" }, "cdl_doc": { "type": "string" }, "company_logo": { "type": "string" }, "otp": { "type": "string" }, "role": { "type": "number" }, "switchRole": { "type": "number" }, "password": { "type": "string" }, "realPassword": { "type": "string" }, "inviteCode": { "type": "string" }, "deviceToken": { "type": "string", "nullable": true }, "deviceTokenIos": { "type": "string", "nullable": true }, "twoFactor": { "type": "number", "enum": [ 0, 1 ] }, "status": { "type": "number" }, "portalId": { "type": "number" }, "carrier_id": { "type": "number" }, "created_at": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "CarrierHoldMessageWithRelations": { "title": "CarrierHoldMessageWithRelations", "type": "object", "description": "(tsType: CarrierHoldMessageWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "message": { "type": "string" }, "created": { "type": "string", "format": "date-time" }, "carrierAgingId": { "type": "number" }, "userId": { "type": "number" }, "carrierAging": { "$ref": "#/components/schemas/CarrierAgingWithRelations" }, "foreignKey": {}, "user": { "$ref": "#/components/schemas/UserWithRelations" } }, "additionalProperties": false, "x-typescript-type": "CarrierHoldMessageWithRelations" }, "BrokerVlOtrLockedIncentives": { "title": "BrokerVlOtrLockedIncentives", "type": "object", "properties": { "id": { "type": "number" }, "userId": { "type": "number" }, "incentiveDate": { "type": "string", "format": "date-time" }, "employeeId": { "type": "number" }, "total_hpFor_margin": { "type": "number" }, "total_hprFor_margin": { "type": "number" }, "total_spFor_margin": { "type": "number" }, "total_sprFor_margin": { "type": "number" }, "realName": { "type": "string" }, "name": { "type": "string" }, "tlName": { "type": "string" }, "tmName": { "type": "string" }, "managerId": { "type": "number" }, "teamId": { "type": "number" }, "totalPending": { "type": "number" }, "companyMargin": { "type": "number" }, "brokerMargin": { "type": "number" }, "incentive": { "type": "number" }, "redFlags": { "type": "number" }, "cmt": { "type": "number" }, "negativeInr": { "type": "number" }, "inr": { "type": "number" }, "npinr": { "type": "number" } }, "required": [ "incentiveDate" ], "additionalProperties": false }, "NewBrokerVlOtrLockedIncentives": { "title": "NewBrokerVlOtrLockedIncentives", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewBrokerVlOtrLockedIncentives', exclude: [ 'id' ] })", "properties": { "userId": { "type": "number" }, "incentiveDate": { "type": "string", "format": "date-time" }, "employeeId": { "type": "number" }, "total_hpFor_margin": { "type": "number" }, "total_hprFor_margin": { "type": "number" }, "total_spFor_margin": { "type": "number" }, "total_sprFor_margin": { "type": "number" }, "realName": { "type": "string" }, "name": { "type": "string" }, "tlName": { "type": "string" }, "tmName": { "type": "string" }, "managerId": { "type": "number" }, "teamId": { "type": "number" }, "totalPending": { "type": "number" }, "companyMargin": { "type": "number" }, "brokerMargin": { "type": "number" }, "incentive": { "type": "number" }, "redFlags": { "type": "number" }, "cmt": { "type": "number" }, "negativeInr": { "type": "number" }, "inr": { "type": "number" }, "npinr": { "type": "number" } }, "required": [ "incentiveDate" ], "additionalProperties": false, "x-typescript-type": "Omit" }, "BrokerVlOtrLockedIncentivesWithRelations": { "title": "BrokerVlOtrLockedIncentivesWithRelations", "type": "object", "description": "(tsType: BrokerVlOtrLockedIncentivesWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "userId": { "type": "number" }, "incentiveDate": { "type": "string", "format": "date-time" }, "employeeId": { "type": "number" }, "total_hpFor_margin": { "type": "number" }, "total_hprFor_margin": { "type": "number" }, "total_spFor_margin": { "type": "number" }, "total_sprFor_margin": { "type": "number" }, "realName": { "type": "string" }, "name": { "type": "string" }, "tlName": { "type": "string" }, "tmName": { "type": "string" }, "managerId": { "type": "number" }, "teamId": { "type": "number" }, "totalPending": { "type": "number" }, "companyMargin": { "type": "number" }, "brokerMargin": { "type": "number" }, "incentive": { "type": "number" }, "redFlags": { "type": "number" }, "cmt": { "type": "number" }, "negativeInr": { "type": "number" }, "inr": { "type": "number" }, "npinr": { "type": "number" } }, "required": [ "incentiveDate" ], "additionalProperties": false, "x-typescript-type": "BrokerVlOtrLockedIncentivesWithRelations" }, "BrokerVlOtrLockedIncentivesPartial": { "title": "BrokerVlOtrLockedIncentivesPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number" }, "userId": { "type": "number" }, "incentiveDate": { "type": "string", "format": "date-time" }, "employeeId": { "type": "number" }, "total_hpFor_margin": { "type": "number" }, "total_hprFor_margin": { "type": "number" }, "total_spFor_margin": { "type": "number" }, "total_sprFor_margin": { "type": "number" }, "realName": { "type": "string" }, "name": { "type": "string" }, "tlName": { "type": "string" }, "tmName": { "type": "string" }, "managerId": { "type": "number" }, "teamId": { "type": "number" }, "totalPending": { "type": "number" }, "companyMargin": { "type": "number" }, "brokerMargin": { "type": "number" }, "incentive": { "type": "number" }, "redFlags": { "type": "number" }, "cmt": { "type": "number" }, "negativeInr": { "type": "number" }, "inr": { "type": "number" }, "npinr": { "type": "number" } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "BrokerVlOtrIncentives": { "title": "BrokerVlOtrIncentives", "type": "object", "properties": { "id": { "type": "number" }, "shipmentId": { "type": "number" }, "invoiceId": { "type": "number" }, "total": { "type": "number" }, "pending": { "type": "number" }, "received": { "type": "number" }, "type": { "type": "string", "nullable": true }, "IncentiveDate": { "type": "string", "format": "date-time", "nullable": true }, "payReceivedDate": { "type": "string", "format": "date-time", "nullable": true }, "shipper": { "type": "number" }, "carrier": { "type": "number" }, "margin": { "type": "number" }, "monthSlabCount": { "type": "number" }, "incentive": { "type": "number" }, "disburseLastMonthIncentive": { "type": "number" }, "slabPercentage": { "type": "number" }, "captureDate": { "type": "string", "format": "date-time" }, "invoiceDate": { "type": "string", "format": "date-time" }, "pickupDate": { "type": "string", "format": "date-time" }, "BrokerId": { "type": "number" }, "description": { "type": "string", "nullable": true } }, "required": [ "shipmentId", "invoiceId", "shipper", "carrier", "margin", "monthSlabCount", "captureDate", "invoiceDate" ], "additionalProperties": false }, "NewBrokerVlOtrIncentives": { "title": "NewBrokerVlOtrIncentives", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewBrokerVlOtrIncentives', exclude: [ 'id' ] })", "properties": { "shipmentId": { "type": "number" }, "invoiceId": { "type": "number" }, "total": { "type": "number" }, "pending": { "type": "number" }, "received": { "type": "number" }, "type": { "type": "string", "nullable": true }, "IncentiveDate": { "type": "string", "format": "date-time", "nullable": true }, "payReceivedDate": { "type": "string", "format": "date-time", "nullable": true }, "shipper": { "type": "number" }, "carrier": { "type": "number" }, "margin": { "type": "number" }, "monthSlabCount": { "type": "number" }, "incentive": { "type": "number" }, "disburseLastMonthIncentive": { "type": "number" }, "slabPercentage": { "type": "number" }, "captureDate": { "type": "string", "format": "date-time" }, "invoiceDate": { "type": "string", "format": "date-time" }, "pickupDate": { "type": "string", "format": "date-time" }, "BrokerId": { "type": "number" }, "description": { "type": "string", "nullable": true } }, "required": [ "shipmentId", "invoiceId", "shipper", "carrier", "margin", "monthSlabCount", "captureDate", "invoiceDate" ], "additionalProperties": false, "x-typescript-type": "Omit" }, "BrokerVlOtrIncentivesWithRelations": { "title": "BrokerVlOtrIncentivesWithRelations", "type": "object", "description": "(tsType: BrokerVlOtrIncentivesWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "shipmentId": { "type": "number" }, "invoiceId": { "type": "number" }, "total": { "type": "number" }, "pending": { "type": "number" }, "received": { "type": "number" }, "type": { "type": "string", "nullable": true }, "IncentiveDate": { "type": "string", "format": "date-time", "nullable": true }, "payReceivedDate": { "type": "string", "format": "date-time", "nullable": true }, "shipper": { "type": "number" }, "carrier": { "type": "number" }, "margin": { "type": "number" }, "monthSlabCount": { "type": "number" }, "incentive": { "type": "number" }, "disburseLastMonthIncentive": { "type": "number" }, "slabPercentage": { "type": "number" }, "captureDate": { "type": "string", "format": "date-time" }, "invoiceDate": { "type": "string", "format": "date-time" }, "pickupDate": { "type": "string", "format": "date-time" }, "BrokerId": { "type": "number" }, "description": { "type": "string", "nullable": true } }, "required": [ "shipmentId", "invoiceId", "shipper", "carrier", "margin", "monthSlabCount", "captureDate", "invoiceDate" ], "additionalProperties": false, "x-typescript-type": "BrokerVlOtrIncentivesWithRelations" }, "BrokerVlOtrIncentivesPartial": { "title": "BrokerVlOtrIncentivesPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number" }, "shipmentId": { "type": "number" }, "invoiceId": { "type": "number" }, "total": { "type": "number" }, "pending": { "type": "number" }, "received": { "type": "number" }, "type": { "type": "string", "nullable": true }, "IncentiveDate": { "type": "string", "format": "date-time", "nullable": true }, "payReceivedDate": { "type": "string", "format": "date-time", "nullable": true }, "shipper": { "type": "number" }, "carrier": { "type": "number" }, "margin": { "type": "number" }, "monthSlabCount": { "type": "number" }, "incentive": { "type": "number" }, "disburseLastMonthIncentive": { "type": "number" }, "slabPercentage": { "type": "number" }, "captureDate": { "type": "string", "format": "date-time" }, "invoiceDate": { "type": "string", "format": "date-time" }, "pickupDate": { "type": "string", "format": "date-time" }, "BrokerId": { "type": "number" }, "description": { "type": "string", "nullable": true } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "BrokerVlOtrIncentivesTm": { "title": "BrokerVlOtrIncentivesTm", "type": "object", "properties": { "id": { "type": "number" }, "userId": { "type": "number" }, "incentiveDate": { "type": "string", "format": "date-time" }, "total_hpFor_margin": { "type": "number" }, "total_hprFor_margin": { "type": "number" }, "total_spFor_margin": { "type": "number" }, "total_sprFor_margin": { "type": "number" }, "totalPending": { "type": "number" }, "companyMargin": { "type": "number" }, "margin": { "type": "number" }, "afterslab": { "type": "number" }, "total_hpFor_margin_indirect": { "type": "number" }, "total_hprFor_margin_indirect": { "type": "number" }, "total_spFor_margin_indirect": { "type": "number" }, "total_sprFor_margin_indirect": { "type": "number" }, "totalPending_indirect": { "type": "number" }, "companyMargin_indirect": { "type": "number" }, "margin_indirect": { "type": "number" }, "afterslab_indirect": { "type": "number" }, "white_indirect": { "type": "number" }, "tlName": { "type": "string" }, "tmName": { "type": "string" }, "userType": { "type": "number" } }, "required": [ "incentiveDate" ], "additionalProperties": false }, "NewBrokerVlOtrIncentivesTm": { "title": "NewBrokerVlOtrIncentivesTm", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewBrokerVlOtrIncentivesTm', exclude: [ 'id' ] })", "properties": { "userId": { "type": "number" }, "incentiveDate": { "type": "string", "format": "date-time" }, "total_hpFor_margin": { "type": "number" }, "total_hprFor_margin": { "type": "number" }, "total_spFor_margin": { "type": "number" }, "total_sprFor_margin": { "type": "number" }, "totalPending": { "type": "number" }, "companyMargin": { "type": "number" }, "margin": { "type": "number" }, "afterslab": { "type": "number" }, "total_hpFor_margin_indirect": { "type": "number" }, "total_hprFor_margin_indirect": { "type": "number" }, "total_spFor_margin_indirect": { "type": "number" }, "total_sprFor_margin_indirect": { "type": "number" }, "totalPending_indirect": { "type": "number" }, "companyMargin_indirect": { "type": "number" }, "margin_indirect": { "type": "number" }, "afterslab_indirect": { "type": "number" }, "white_indirect": { "type": "number" }, "tlName": { "type": "string" }, "tmName": { "type": "string" }, "userType": { "type": "number" } }, "required": [ "incentiveDate" ], "additionalProperties": false, "x-typescript-type": "Omit" }, "BrokerVlOtrIncentivesTmWithRelations": { "title": "BrokerVlOtrIncentivesTmWithRelations", "type": "object", "description": "(tsType: BrokerVlOtrIncentivesTmWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "userId": { "type": "number" }, "incentiveDate": { "type": "string", "format": "date-time" }, "total_hpFor_margin": { "type": "number" }, "total_hprFor_margin": { "type": "number" }, "total_spFor_margin": { "type": "number" }, "total_sprFor_margin": { "type": "number" }, "totalPending": { "type": "number" }, "companyMargin": { "type": "number" }, "margin": { "type": "number" }, "afterslab": { "type": "number" }, "total_hpFor_margin_indirect": { "type": "number" }, "total_hprFor_margin_indirect": { "type": "number" }, "total_spFor_margin_indirect": { "type": "number" }, "total_sprFor_margin_indirect": { "type": "number" }, "totalPending_indirect": { "type": "number" }, "companyMargin_indirect": { "type": "number" }, "margin_indirect": { "type": "number" }, "afterslab_indirect": { "type": "number" }, "white_indirect": { "type": "number" }, "tlName": { "type": "string" }, "tmName": { "type": "string" }, "userType": { "type": "number" } }, "required": [ "incentiveDate" ], "additionalProperties": false, "x-typescript-type": "BrokerVlOtrIncentivesTmWithRelations" }, "BrokerVlOtrIncentivesTmPartial": { "title": "BrokerVlOtrIncentivesTmPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number" }, "userId": { "type": "number" }, "incentiveDate": { "type": "string", "format": "date-time" }, "total_hpFor_margin": { "type": "number" }, "total_hprFor_margin": { "type": "number" }, "total_spFor_margin": { "type": "number" }, "total_sprFor_margin": { "type": "number" }, "totalPending": { "type": "number" }, "companyMargin": { "type": "number" }, "margin": { "type": "number" }, "afterslab": { "type": "number" }, "total_hpFor_margin_indirect": { "type": "number" }, "total_hprFor_margin_indirect": { "type": "number" }, "total_spFor_margin_indirect": { "type": "number" }, "total_sprFor_margin_indirect": { "type": "number" }, "totalPending_indirect": { "type": "number" }, "companyMargin_indirect": { "type": "number" }, "margin_indirect": { "type": "number" }, "afterslab_indirect": { "type": "number" }, "white_indirect": { "type": "number" }, "tlName": { "type": "string" }, "tmName": { "type": "string" }, "userType": { "type": "number" } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "BrokerVlOtrIncentivesTl": { "title": "BrokerVlOtrIncentivesTl", "type": "object", "properties": { "id": { "type": "number" }, "userId": { "type": "number" }, "incentiveDate": { "type": "string", "format": "date-time" }, "total_hpFor_margin": { "type": "number" }, "total_hprFor_margin": { "type": "number" }, "total_spFor_margin": { "type": "number" }, "total_sprFor_margin": { "type": "number" }, "totalPending": { "type": "number" }, "companyMargin": { "type": "number" }, "cmt": { "type": "number" }, "margin": { "type": "number" }, "afterslab": { "type": "number" }, "tlName": { "type": "string" }, "tmName": { "type": "string" }, "userType": { "type": "number" } }, "required": [ "incentiveDate" ], "additionalProperties": false }, "NewBrokerVlOtrIncentivesTl": { "title": "NewBrokerVlOtrIncentivesTl", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewBrokerVlOtrIncentivesTl', exclude: [ 'id' ] })", "properties": { "userId": { "type": "number" }, "incentiveDate": { "type": "string", "format": "date-time" }, "total_hpFor_margin": { "type": "number" }, "total_hprFor_margin": { "type": "number" }, "total_spFor_margin": { "type": "number" }, "total_sprFor_margin": { "type": "number" }, "totalPending": { "type": "number" }, "companyMargin": { "type": "number" }, "cmt": { "type": "number" }, "margin": { "type": "number" }, "afterslab": { "type": "number" }, "tlName": { "type": "string" }, "tmName": { "type": "string" }, "userType": { "type": "number" } }, "required": [ "incentiveDate" ], "additionalProperties": false, "x-typescript-type": "Omit" }, "BrokerVlOtrIncentivesTlWithRelations": { "title": "BrokerVlOtrIncentivesTlWithRelations", "type": "object", "description": "(tsType: BrokerVlOtrIncentivesTlWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "userId": { "type": "number" }, "incentiveDate": { "type": "string", "format": "date-time" }, "total_hpFor_margin": { "type": "number" }, "total_hprFor_margin": { "type": "number" }, "total_spFor_margin": { "type": "number" }, "total_sprFor_margin": { "type": "number" }, "totalPending": { "type": "number" }, "companyMargin": { "type": "number" }, "cmt": { "type": "number" }, "margin": { "type": "number" }, "afterslab": { "type": "number" }, "tlName": { "type": "string" }, "tmName": { "type": "string" }, "userType": { "type": "number" } }, "required": [ "incentiveDate" ], "additionalProperties": false, "x-typescript-type": "BrokerVlOtrIncentivesTlWithRelations" }, "BrokerVlOtrIncentivesTlPartial": { "title": "BrokerVlOtrIncentivesTlPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number" }, "userId": { "type": "number" }, "incentiveDate": { "type": "string", "format": "date-time" }, "total_hpFor_margin": { "type": "number" }, "total_hprFor_margin": { "type": "number" }, "total_spFor_margin": { "type": "number" }, "total_sprFor_margin": { "type": "number" }, "totalPending": { "type": "number" }, "companyMargin": { "type": "number" }, "cmt": { "type": "number" }, "margin": { "type": "number" }, "afterslab": { "type": "number" }, "tlName": { "type": "string" }, "tmName": { "type": "string" }, "userType": { "type": "number" } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "BrokerVlOtrIncentivesNew": { "title": "BrokerVlOtrIncentivesNew", "type": "object", "properties": { "id": { "type": "number" }, "userId": { "type": "number" }, "shipmentId": { "type": "number" }, "tlID": { "type": "number" }, "managerID": { "type": "number" }, "shipperPrice": { "type": "number" }, "carrierPrice": { "type": "number" }, "companyMargin": { "type": "number" }, "brokerMargin": { "type": "number" }, "lastReceivedDate": { "type": "string", "format": "date-time" }, "incentiveDate": { "type": "string", "format": "date-time" }, "slabMonth": { "type": "string", "format": "date-time" }, "slabMargin": { "type": "number" }, "slabPercentage": { "type": "number" }, "created": { "type": "string", "format": "date-time" }, "modified": { "type": "string", "format": "date-time" }, "slabProCount": { "type": "number" }, "slabDescription": { "type": "string" } }, "required": [ "userId", "shipmentId" ], "additionalProperties": false }, "NewBrokerVlOtrIncentivesNew": { "title": "NewBrokerVlOtrIncentivesNew", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewBrokerVlOtrIncentivesNew', exclude: [ 'id' ] })", "properties": { "userId": { "type": "number" }, "shipmentId": { "type": "number" }, "tlID": { "type": "number" }, "managerID": { "type": "number" }, "shipperPrice": { "type": "number" }, "carrierPrice": { "type": "number" }, "companyMargin": { "type": "number" }, "brokerMargin": { "type": "number" }, "lastReceivedDate": { "type": "string", "format": "date-time" }, "incentiveDate": { "type": "string", "format": "date-time" }, "slabMonth": { "type": "string", "format": "date-time" }, "slabMargin": { "type": "number" }, "slabPercentage": { "type": "number" }, "created": { "type": "string", "format": "date-time" }, "modified": { "type": "string", "format": "date-time" }, "slabProCount": { "type": "number" }, "slabDescription": { "type": "string" } }, "required": [ "userId", "shipmentId" ], "additionalProperties": false, "x-typescript-type": "Omit" }, "BrokerVlOtrIncentivesNewWithRelations": { "title": "BrokerVlOtrIncentivesNewWithRelations", "type": "object", "description": "(tsType: BrokerVlOtrIncentivesNewWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "userId": { "type": "number" }, "shipmentId": { "type": "number" }, "tlID": { "type": "number" }, "managerID": { "type": "number" }, "shipperPrice": { "type": "number" }, "carrierPrice": { "type": "number" }, "companyMargin": { "type": "number" }, "brokerMargin": { "type": "number" }, "lastReceivedDate": { "type": "string", "format": "date-time" }, "incentiveDate": { "type": "string", "format": "date-time" }, "slabMonth": { "type": "string", "format": "date-time" }, "slabMargin": { "type": "number" }, "slabPercentage": { "type": "number" }, "created": { "type": "string", "format": "date-time" }, "modified": { "type": "string", "format": "date-time" }, "slabProCount": { "type": "number" }, "slabDescription": { "type": "string" } }, "required": [ "userId", "shipmentId" ], "additionalProperties": false, "x-typescript-type": "BrokerVlOtrIncentivesNewWithRelations" }, "BrokerVlOtrIncentivesNewPartial": { "title": "BrokerVlOtrIncentivesNewPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number" }, "userId": { "type": "number" }, "shipmentId": { "type": "number" }, "tlID": { "type": "number" }, "managerID": { "type": "number" }, "shipperPrice": { "type": "number" }, "carrierPrice": { "type": "number" }, "companyMargin": { "type": "number" }, "brokerMargin": { "type": "number" }, "lastReceivedDate": { "type": "string", "format": "date-time" }, "incentiveDate": { "type": "string", "format": "date-time" }, "slabMonth": { "type": "string", "format": "date-time" }, "slabMargin": { "type": "number" }, "slabPercentage": { "type": "number" }, "created": { "type": "string", "format": "date-time" }, "modified": { "type": "string", "format": "date-time" }, "slabProCount": { "type": "number" }, "slabDescription": { "type": "string" } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "BrokerVlIncentives": { "title": "BrokerVlIncentives", "type": "object", "properties": { "id": { "type": "number" }, "userId": { "type": "number" }, "shipmentId": { "type": "number" }, "tlID": { "type": "number" }, "managerID": { "type": "number" }, "shipperPrice": { "type": "number" }, "carrierPrice": { "type": "number" }, "companyMargin": { "type": "number" }, "brokerMargin": { "type": "number" }, "lastReceivedDate": { "type": "string", "format": "date-time" }, "incentiveDate": { "type": "string", "format": "date-time" }, "PickupDate": { "type": "string", "format": "date-time" }, "incentiveStatus": { "type": "number", "enum": [ 0, 1 ] }, "paidStatus": { "type": "number", "enum": [ 0, 1 ] }, "incentivePaidDate": { "type": "string", "format": "date-time" }, "created": { "type": "string", "format": "date-time" }, "modified": { "type": "string", "format": "date-time" } }, "required": [ "userId", "shipmentId", "incentiveStatus", "paidStatus" ], "additionalProperties": false }, "NewBrokerVlIncentives": { "title": "NewBrokerVlIncentives", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewBrokerVlIncentives', exclude: [ 'id' ] })", "properties": { "userId": { "type": "number" }, "shipmentId": { "type": "number" }, "tlID": { "type": "number" }, "managerID": { "type": "number" }, "shipperPrice": { "type": "number" }, "carrierPrice": { "type": "number" }, "companyMargin": { "type": "number" }, "brokerMargin": { "type": "number" }, "lastReceivedDate": { "type": "string", "format": "date-time" }, "incentiveDate": { "type": "string", "format": "date-time" }, "PickupDate": { "type": "string", "format": "date-time" }, "incentiveStatus": { "type": "number", "enum": [ 0, 1 ] }, "paidStatus": { "type": "number", "enum": [ 0, 1 ] }, "incentivePaidDate": { "type": "string", "format": "date-time" }, "created": { "type": "string", "format": "date-time" }, "modified": { "type": "string", "format": "date-time" } }, "required": [ "userId", "shipmentId", "incentiveStatus", "paidStatus" ], "additionalProperties": false, "x-typescript-type": "Omit" }, "BrokerVlIncentivesWithRelations": { "title": "BrokerVlIncentivesWithRelations", "type": "object", "description": "(tsType: BrokerVlIncentivesWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "userId": { "type": "number" }, "shipmentId": { "type": "number" }, "tlID": { "type": "number" }, "managerID": { "type": "number" }, "shipperPrice": { "type": "number" }, "carrierPrice": { "type": "number" }, "companyMargin": { "type": "number" }, "brokerMargin": { "type": "number" }, "lastReceivedDate": { "type": "string", "format": "date-time" }, "incentiveDate": { "type": "string", "format": "date-time" }, "PickupDate": { "type": "string", "format": "date-time" }, "incentiveStatus": { "type": "number", "enum": [ 0, 1 ] }, "paidStatus": { "type": "number", "enum": [ 0, 1 ] }, "incentivePaidDate": { "type": "string", "format": "date-time" }, "created": { "type": "string", "format": "date-time" }, "modified": { "type": "string", "format": "date-time" } }, "required": [ "userId", "shipmentId", "incentiveStatus", "paidStatus" ], "additionalProperties": false, "x-typescript-type": "BrokerVlIncentivesWithRelations" }, "BrokerVlIncentivesPartial": { "title": "BrokerVlIncentivesPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number" }, "userId": { "type": "number" }, "shipmentId": { "type": "number" }, "tlID": { "type": "number" }, "managerID": { "type": "number" }, "shipperPrice": { "type": "number" }, "carrierPrice": { "type": "number" }, "companyMargin": { "type": "number" }, "brokerMargin": { "type": "number" }, "lastReceivedDate": { "type": "string", "format": "date-time" }, "incentiveDate": { "type": "string", "format": "date-time" }, "PickupDate": { "type": "string", "format": "date-time" }, "incentiveStatus": { "type": "number", "enum": [ 0, 1 ] }, "paidStatus": { "type": "number", "enum": [ 0, 1 ] }, "incentivePaidDate": { "type": "string", "format": "date-time" }, "created": { "type": "string", "format": "date-time" }, "modified": { "type": "string", "format": "date-time" } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "BrokerVlIncentivesCalender": { "title": "BrokerVlIncentivesCalender", "type": "object", "properties": { "id": { "type": "number" }, "userId": { "type": "number" }, "year": { "type": "number" }, "january": { "type": "string", "format": "date-time" }, "januaryDeduction": { "type": "number" }, "february": { "type": "string", "format": "date-time" }, "februaryDeduction": { "type": "number" }, "march": { "type": "string", "format": "date-time" }, "marchDeduction": { "type": "number" }, "april": { "type": "string", "format": "date-time" }, "aprilDeduction": { "type": "number" }, "may": { "type": "string", "format": "date-time" }, "mayDeduction": { "type": "number" }, "june": { "type": "string", "format": "date-time" }, "juneDeduction": { "type": "number" }, "july": { "type": "string", "format": "date-time" }, "julyDeduction": { "type": "number" }, "august": { "type": "string", "format": "date-time" }, "augustDeduction": { "type": "number" }, "september": { "type": "string", "format": "date-time" }, "septemberDeduction": { "type": "number" }, "october": { "type": "string", "format": "date-time" }, "octoberDeduction": { "type": "number" }, "november": { "type": "string", "format": "date-time" }, "novemberDeduction": { "type": "number" }, "december": { "type": "string", "format": "date-time" }, "decemberDeduction": { "type": "number" } }, "required": [ "userId" ], "additionalProperties": false }, "NewBrokerVlIncentivesCalender": { "title": "NewBrokerVlIncentivesCalender", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewBrokerVlIncentivesCalender', exclude: [ 'id' ] })", "properties": { "userId": { "type": "number" }, "year": { "type": "number" }, "january": { "type": "string", "format": "date-time" }, "januaryDeduction": { "type": "number" }, "february": { "type": "string", "format": "date-time" }, "februaryDeduction": { "type": "number" }, "march": { "type": "string", "format": "date-time" }, "marchDeduction": { "type": "number" }, "april": { "type": "string", "format": "date-time" }, "aprilDeduction": { "type": "number" }, "may": { "type": "string", "format": "date-time" }, "mayDeduction": { "type": "number" }, "june": { "type": "string", "format": "date-time" }, "juneDeduction": { "type": "number" }, "july": { "type": "string", "format": "date-time" }, "julyDeduction": { "type": "number" }, "august": { "type": "string", "format": "date-time" }, "augustDeduction": { "type": "number" }, "september": { "type": "string", "format": "date-time" }, "septemberDeduction": { "type": "number" }, "october": { "type": "string", "format": "date-time" }, "octoberDeduction": { "type": "number" }, "november": { "type": "string", "format": "date-time" }, "novemberDeduction": { "type": "number" }, "december": { "type": "string", "format": "date-time" }, "decemberDeduction": { "type": "number" } }, "required": [ "userId" ], "additionalProperties": false, "x-typescript-type": "Omit" }, "BrokerVlIncentivesCalenderWithRelations": { "title": "BrokerVlIncentivesCalenderWithRelations", "type": "object", "description": "(tsType: BrokerVlIncentivesCalenderWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "userId": { "type": "number" }, "year": { "type": "number" }, "january": { "type": "string", "format": "date-time" }, "januaryDeduction": { "type": "number" }, "february": { "type": "string", "format": "date-time" }, "februaryDeduction": { "type": "number" }, "march": { "type": "string", "format": "date-time" }, "marchDeduction": { "type": "number" }, "april": { "type": "string", "format": "date-time" }, "aprilDeduction": { "type": "number" }, "may": { "type": "string", "format": "date-time" }, "mayDeduction": { "type": "number" }, "june": { "type": "string", "format": "date-time" }, "juneDeduction": { "type": "number" }, "july": { "type": "string", "format": "date-time" }, "julyDeduction": { "type": "number" }, "august": { "type": "string", "format": "date-time" }, "augustDeduction": { "type": "number" }, "september": { "type": "string", "format": "date-time" }, "septemberDeduction": { "type": "number" }, "october": { "type": "string", "format": "date-time" }, "octoberDeduction": { "type": "number" }, "november": { "type": "string", "format": "date-time" }, "novemberDeduction": { "type": "number" }, "december": { "type": "string", "format": "date-time" }, "decemberDeduction": { "type": "number" } }, "required": [ "userId" ], "additionalProperties": false, "x-typescript-type": "BrokerVlIncentivesCalenderWithRelations" }, "BrokerVlIncentivesCalenderPartial": { "title": "BrokerVlIncentivesCalenderPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number" }, "userId": { "type": "number" }, "year": { "type": "number" }, "january": { "type": "string", "format": "date-time" }, "januaryDeduction": { "type": "number" }, "february": { "type": "string", "format": "date-time" }, "februaryDeduction": { "type": "number" }, "march": { "type": "string", "format": "date-time" }, "marchDeduction": { "type": "number" }, "april": { "type": "string", "format": "date-time" }, "aprilDeduction": { "type": "number" }, "may": { "type": "string", "format": "date-time" }, "mayDeduction": { "type": "number" }, "june": { "type": "string", "format": "date-time" }, "juneDeduction": { "type": "number" }, "july": { "type": "string", "format": "date-time" }, "julyDeduction": { "type": "number" }, "august": { "type": "string", "format": "date-time" }, "augustDeduction": { "type": "number" }, "september": { "type": "string", "format": "date-time" }, "septemberDeduction": { "type": "number" }, "october": { "type": "string", "format": "date-time" }, "octoberDeduction": { "type": "number" }, "november": { "type": "string", "format": "date-time" }, "novemberDeduction": { "type": "number" }, "december": { "type": "string", "format": "date-time" }, "decemberDeduction": { "type": "number" } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "Notes": { "title": "Notes", "type": "object", "properties": { "id": { "type": "number" }, "uid": { "type": "string" }, "spokeTo": { "type": "string", "nullable": true }, "date": { "type": "string", "format": "date-time" }, "status": { "type": "number" }, "setReminder": { "type": "number" }, "for": { "type": "number", "enum": [ 0, 1 ] }, "note": { "type": "string", "nullable": true }, "created": { "type": "string", "format": "date-time" }, "time": { "type": "string", "format": "date-time" }, "oldNoteId": { "type": "number" }, "type": { "type": "number", "enum": [ 1, 2, 3, 4, 5 ] }, "arName": { "type": "string", "nullable": true }, "collectionAmount": { "type": "number", "nullable": true }, "invoicesId": { "type": "number" }, "shippersId": { "type": "number" }, "shipmentId": { "type": "number" }, "userId": { "type": "number" }, "portalId": { "type": "number" }, "ArUserID": { "type": "number" } }, "required": [ "uid" ], "additionalProperties": false }, "BrokerAsiIncentives": { "title": "BrokerAsiIncentives", "type": "object", "properties": { "id": { "type": "number" }, "userId": { "type": "number" }, "shipmentId": { "type": "number" }, "tlID": { "type": "number" }, "managerID": { "type": "number" }, "shipperPrice": { "type": "number" }, "carrierPrice": { "type": "number" }, "companyMargin": { "type": "number" }, "brokerMargin": { "type": "number" }, "lastReceivedDate": { "type": "string", "format": "date-time" }, "incentiveDate": { "type": "string", "format": "date-time" }, "slabMonth": { "type": "string", "format": "date-time" }, "slabMargin": { "type": "number" }, "slabPercentage": { "type": "number" }, "created": { "type": "string", "format": "date-time" }, "modified": { "type": "string", "format": "date-time" }, "slabProCount": { "type": "number" }, "slabDescription": { "type": "string" } }, "required": [ "userId", "shipmentId" ], "additionalProperties": false }, "NewBrokerAsiIncentives": { "title": "NewBrokerAsiIncentives", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewBrokerAsiIncentives', exclude: [ 'id' ] })", "properties": { "userId": { "type": "number" }, "shipmentId": { "type": "number" }, "tlID": { "type": "number" }, "managerID": { "type": "number" }, "shipperPrice": { "type": "number" }, "carrierPrice": { "type": "number" }, "companyMargin": { "type": "number" }, "brokerMargin": { "type": "number" }, "lastReceivedDate": { "type": "string", "format": "date-time" }, "incentiveDate": { "type": "string", "format": "date-time" }, "slabMonth": { "type": "string", "format": "date-time" }, "slabMargin": { "type": "number" }, "slabPercentage": { "type": "number" }, "created": { "type": "string", "format": "date-time" }, "modified": { "type": "string", "format": "date-time" }, "slabProCount": { "type": "number" }, "slabDescription": { "type": "string" } }, "required": [ "userId", "shipmentId" ], "additionalProperties": false, "x-typescript-type": "Omit" }, "BrokerAsiIncentivesWithRelations": { "title": "BrokerAsiIncentivesWithRelations", "type": "object", "description": "(tsType: BrokerAsiIncentivesWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "userId": { "type": "number" }, "shipmentId": { "type": "number" }, "tlID": { "type": "number" }, "managerID": { "type": "number" }, "shipperPrice": { "type": "number" }, "carrierPrice": { "type": "number" }, "companyMargin": { "type": "number" }, "brokerMargin": { "type": "number" }, "lastReceivedDate": { "type": "string", "format": "date-time" }, "incentiveDate": { "type": "string", "format": "date-time" }, "slabMonth": { "type": "string", "format": "date-time" }, "slabMargin": { "type": "number" }, "slabPercentage": { "type": "number" }, "created": { "type": "string", "format": "date-time" }, "modified": { "type": "string", "format": "date-time" }, "slabProCount": { "type": "number" }, "slabDescription": { "type": "string" } }, "required": [ "userId", "shipmentId" ], "additionalProperties": false, "x-typescript-type": "BrokerAsiIncentivesWithRelations" }, "BrokerAsiIncentivesPartial": { "title": "BrokerAsiIncentivesPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number" }, "userId": { "type": "number" }, "shipmentId": { "type": "number" }, "tlID": { "type": "number" }, "managerID": { "type": "number" }, "shipperPrice": { "type": "number" }, "carrierPrice": { "type": "number" }, "companyMargin": { "type": "number" }, "brokerMargin": { "type": "number" }, "lastReceivedDate": { "type": "string", "format": "date-time" }, "incentiveDate": { "type": "string", "format": "date-time" }, "slabMonth": { "type": "string", "format": "date-time" }, "slabMargin": { "type": "number" }, "slabPercentage": { "type": "number" }, "created": { "type": "string", "format": "date-time" }, "modified": { "type": "string", "format": "date-time" }, "slabProCount": { "type": "number" }, "slabDescription": { "type": "string" } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "ShipperHistory": { "title": "ShipperHistory", "type": "object", "properties": { "id": { "type": "number" }, "reason": { "type": "string" }, "status": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time" }, "type": { "type": "number" }, "image_url": { "type": "string", "nullable": true }, "creditApp": { "type": "string", "nullable": true }, "quotationProof": { "type": "string", "nullable": true }, "approval_limit": { "type": "number", "nullable": true }, "shippersId": { "type": "number" }, "userId": { "type": "number" }, "portalId": { "type": "number" }, "ArUserID": { "type": "number" } }, "additionalProperties": false }, "Shippers History": { "title": "Shippers History", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'Shippers History', exclude: [ 'id', 'userId', 'portalId' ] })", "properties": { "reason": { "type": "string" }, "status": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time" }, "type": { "type": "number" }, "image_url": { "type": "string", "nullable": true }, "creditApp": { "type": "string", "nullable": true }, "quotationProof": { "type": "string", "nullable": true }, "approval_limit": { "type": "number", "nullable": true }, "shippersId": { "type": "number" }, "ArUserID": { "type": "number" } }, "additionalProperties": false, "x-typescript-type": "Omit" }, "ShipperHistoryWithRelations": { "title": "ShipperHistoryWithRelations", "type": "object", "description": "(tsType: ShipperHistoryWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "reason": { "type": "string" }, "status": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time" }, "type": { "type": "number" }, "image_url": { "type": "string", "nullable": true }, "creditApp": { "type": "string", "nullable": true }, "quotationProof": { "type": "string", "nullable": true }, "approval_limit": { "type": "number", "nullable": true }, "shippersId": { "type": "number" }, "userId": { "type": "number" }, "portalId": { "type": "number" }, "ArUserID": { "type": "number" }, "shippers": { "$ref": "#/components/schemas/ShippersWithRelations" }, "foreignKey": {}, "user": { "$ref": "#/components/schemas/UserWithRelations" }, "portal": { "$ref": "#/components/schemas/PortalWithRelations" }, "arusers": { "$ref": "#/components/schemas/UserWithRelations" } }, "additionalProperties": false, "x-typescript-type": "ShipperHistoryWithRelations" }, "PortalPartialExcluding_id-userId-portalId_WithRelations": { "title": "PortalPartialExcluding_id-userId-portalId_WithRelations", "type": "object", "description": "(tsType: Omit, 'id' | 'userId' | 'portalId'>, schemaOptions: { exclude: [ 'id', 'userId', 'portalId' ], includeRelations: true, partial: true })", "properties": { "name": { "type": "string" }, "domain": { "type": "string", "nullable": true }, "company_email": { "type": "string" }, "email": { "type": "string" }, "password": { "type": "string" }, "company_logo": { "type": "string" }, "company_name": { "type": "string" }, "corporate_number": { "type": "string" }, "fax_number": { "type": "string" }, "company_address": { "type": "string" }, "description": { "type": "string", "nullable": true }, "phoneNumber": { "type": "string" }, "mciNumber": { "type": "string" }, "corporate_address": { "type": "string" }, "status": { "type": "number", "description": "0 deactive | 1 active| 2 blocked", "enum": [ 0, 1, 2 ] }, "second_email_login": { "type": "string", "nullable": true }, "potralRoleId": { "type": "number" }, "user": { "$ref": "#/components/schemas/UserPartialExcluding_id-userId-portalId_WithRelations" }, "users": { "type": "array", "items": { "$ref": "#/components/schemas/UserPartialExcluding_id-userId-portalId_WithRelations" } }, "potralRole": { "$ref": "#/components/schemas/PotralRolePartialExcluding_id-userId-portalId_WithRelations" }, "foreignKey": {} }, "additionalProperties": false, "x-typescript-type": "Omit, 'id' | 'userId' | 'portalId'>" }, "CarrierPaymentPartialExcluding_id-userId-portalId_WithRelations": { "title": "CarrierPaymentPartialExcluding_id-userId-portalId_WithRelations", "type": "object", "description": "(tsType: Omit, 'id' | 'userId' | 'portalId'>, schemaOptions: { exclude: [ 'id', 'userId', 'portalId' ], includeRelations: true, partial: true })", "properties": { "agingDate": { "type": "string", "format": "date-time" }, "paymentInitiated": { "type": "string", "format": "date-time", "nullable": true }, "attachment": { "type": "string" }, "notes": { "type": "string", "nullable": true }, "paymentStatus": { "type": "number" }, "brokerName": { "type": "string", "nullable": true }, "qpStatus": { "type": "number" }, "amountUsd": { "type": "number" }, "amountCad": { "type": "number" }, "paymentType": { "type": "number" }, "paymentMethod": { "type": "string" }, "payTo": { "type": "number" }, "subject": { "type": "string", "nullable": true }, "message": { "type": "string", "nullable": true }, "qb_id": { "type": "string" }, "qb_status": { "type": "number" }, "doc_number": { "type": "string" }, "VlAsiDocNumber": { "type": "string" }, "oldPaymentDate": { "type": "string", "format": "date-time", "nullable": true }, "shipmentId": { "type": "number" }, "carriersId": { "type": "number" }, "apId": { "type": "number" }, "carrierAgingId": { "type": "number" }, "shipment": { "$ref": "#/components/schemas/ShipmentPartialExcluding_id-userId-portalId_WithRelations" }, "foreignKey": {}, "carriers": { "$ref": "#/components/schemas/CarriersPartialExcluding_id-userId-portalId_WithRelations" }, "user": { "$ref": "#/components/schemas/UserPartialExcluding_id-userId-portalId_WithRelations" }, "ap": { "$ref": "#/components/schemas/UserPartialExcluding_id-userId-portalId_WithRelations" }, "portal": { "$ref": "#/components/schemas/PortalPartialExcluding_id-userId-portalId_WithRelations" }, "carrierAging": { "$ref": "#/components/schemas/CarrierAgingPartialExcluding_id-userId-portalId_WithRelations" }, "apEmailToCarriers": { "type": "array", "items": { "$ref": "#/components/schemas/ApEmailToCarrierPartialExcluding_id-userId-portalId_WithRelations" } } }, "additionalProperties": false, "x-typescript-type": "Omit, 'id' | 'userId' | 'portalId'>" }, "RolePartialExcluding_id-userId-portalId_WithRelations": { "title": "RolePartialExcluding_id-userId-portalId_WithRelations", "type": "object", "description": "(tsType: Omit, 'id' | 'userId' | 'portalId'>, schemaOptions: { exclude: [ 'id', 'userId', 'portalId' ], includeRelations: true, partial: true })", "properties": { "name": { "type": "string" }, "permissions": { "type": "array", "items": { "type": "string" } }, "role_key": { "type": "number" }, "type": { "type": "number" }, "defaultPermissions": { "type": "array", "items": { "type": "string" } }, "portal": { "$ref": "#/components/schemas/PortalPartialExcluding_id-userId-portalId_WithRelations" }, "foreignKey": {}, "users": { "type": "array", "items": { "$ref": "#/components/schemas/UserPartialExcluding_id-userId-portalId_WithRelations" } } }, "additionalProperties": false, "x-typescript-type": "Omit, 'id' | 'userId' | 'portalId'>" }, "ShippersPartialExcluding_id-userId-portalId_WithRelations": { "title": "ShippersPartialExcluding_id-userId-portalId_WithRelations", "type": "object", "description": "(tsType: Omit, 'id' | 'userId' | 'portalId'>, schemaOptions: { exclude: [ 'id', 'userId', 'portalId' ], includeRelations: true, partial: true })", "properties": { "oldShipperId": { "type": "number", "nullable": true }, "name": { "type": "string", "nullable": true }, "shipperQuote": { "type": "string", "nullable": true }, "phone_no": { "type": "string", "nullable": true }, "address": { "type": "string", "nullable": true }, "fax": { "type": "string", "nullable": true }, "zip": { "type": "string", "nullable": true }, "contact_name": { "type": "string", "nullable": true }, "instructions": { "type": "string", "nullable": true }, "insurance_name": { "type": "string", "nullable": true }, "setupType": { "type": "string", "nullable": true }, "shipperType": { "type": "string", "nullable": true }, "FromDate": { "type": "string", "format": "date-time" }, "ToDate": { "type": "string", "format": "date-time" }, "shipper_status": { "type": "number" }, "shipperCommunicationType": { "type": "number" }, "assignTo": { "type": "number" }, "secure_limit": { "type": "number", "nullable": true }, "unsecure_limit": { "type": "number", "nullable": true }, "reApprovalStatus": { "type": "number", "nullable": true }, "insurance_status": { "type": "string", "nullable": true }, "url": { "type": "string", "nullable": true }, "creditApp": { "type": "string", "nullable": true }, "quotationProof": { "type": "string", "nullable": true }, "creditLimitDoc": { "type": "string", "nullable": true }, "insurance_exp_date": { "type": "string", "format": "date-time" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "uid": { "type": "string" }, "oldLimit": { "type": "number", "nullable": true }, "ace_qb_id": { "type": "string", "nullable": true }, "ace_qb_status": { "type": "string", "nullable": true }, "vl_qb_id": { "type": "string", "nullable": true }, "vl_qb_status": { "type": "string", "nullable": true }, "asi_qb_id": { "type": "string", "nullable": true }, "asi_qb_status": { "type": "string", "nullable": true }, "callingType": { "type": "string", "nullable": true }, "equipmentId": { "type": "number" }, "zipCodesId": { "type": "number" }, "shipperContactsId": { "type": "number" }, "allocate_churn_customer": { "type": "number" }, "invoiceSend": { "type": "number" }, "sessional_shipper": { "type": "number" }, "shipperHistoryId": { "type": "number" }, "commoditiesId": { "type": "number" }, "apId": { "type": "number" }, "user": { "$ref": "#/components/schemas/UserPartialExcluding_id-userId-portalId_WithRelations" }, "foreignKey": {}, "portal": { "$ref": "#/components/schemas/PortalPartialExcluding_id-userId-portalId_WithRelations" }, "equipment": { "$ref": "#/components/schemas/EquipmentPartialExcluding_id-userId-portalId_WithRelations" }, "zipCodes": { "$ref": "#/components/schemas/ZipCodesPartialExcluding_id-userId-portalId_WithRelations" }, "shipperContacts": { "type": "array", "items": { "$ref": "#/components/schemas/ShipperContactsPartialExcluding_id-userId-portalId_WithRelations" } }, "shipperHistory": { "$ref": "#/components/schemas/ShipperHistoryPartialExcluding_id-userId-portalId_WithRelations" }, "commodities": { "$ref": "#/components/schemas/CommoditiesPartialExcluding_id-userId-portalId_WithRelations" }, "companiesInsurances": { "type": "array", "items": { "$ref": "#/components/schemas/CompaniesInsurancePartialExcluding_id-userId-portalId_WithRelations" } }, "shippersCompaniesInsurances": { "type": "array", "items": { "$ref": "#/components/schemas/ShippersCompaniesInsurancePartialExcluding_id-userId-portalId_WithRelations" } }, "shipmentsList": { "type": "array", "items": { "$ref": "#/components/schemas/ShipmentPartialExcluding_id-userId-portalId_WithRelations" } }, "shippersinvoiceslist": { "type": "array", "items": { "$ref": "#/components/schemas/InvoicesPartialExcluding_id-userId-portalId_WithRelations" } }, "ap": { "$ref": "#/components/schemas/UserPartialExcluding_id-userId-portalId_WithRelations" } }, "additionalProperties": false, "x-typescript-type": "Omit, 'id' | 'userId' | 'portalId'>" }, "UserPartialExcluding_id-userId-portalId_WithRelations": { "title": "UserPartialExcluding_id-userId-portalId_WithRelations", "type": "object", "description": "(tsType: Omit, 'id' | 'userId' | 'portalId'>, schemaOptions: { exclude: [ 'id', 'userId', 'portalId' ], includeRelations: true, partial: true })", "properties": { "name": { "type": "string" }, "first_name": { "type": "string", "nullable": true }, "last_name": { "type": "string", "nullable": true }, "real_name": { "type": "string", "nullable": true }, "phone": { "type": "string", "nullable": true }, "ext": { "type": "string", "nullable": true }, "fax": { "type": "string", "nullable": true }, "avatar": { "type": "string", "nullable": true }, "status": { "type": "number", "enum": [ 0, 1, 2 ] }, "optNumber": { "type": "string", "nullable": true }, "twoFactor": { "type": "number", "enum": [ 0, 1 ] }, "arTypeUser": { "type": "number", "enum": [ 0, 1 ] }, "email_verified_at": { "type": "string", "format": "date-time" }, "email": { "type": "string" }, "AccEmail": { "type": "string", "nullable": true }, "password": { "type": "string" }, "realPassword": { "type": "string" }, "created": { "type": "string", "format": "date-time" }, "modified": { "type": "string", "format": "date-time" }, "realm": { "type": "string", "nullable": true }, "username": { "type": "string", "nullable": true }, "emailVerified": { "type": "boolean" }, "verificationToken": { "type": "boolean" }, "type": { "type": "number" }, "drayage": { "type": "boolean" }, "s_gross": { "type": "number" }, "BrokerPolicyDate": { "type": "string", "format": "date-time" }, "brokerIncentivePolicy": { "type": "number", "enum": [ 0, 1 ] }, "vl_user": { "type": "string", "nullable": true }, "vl_phone": { "type": "string", "nullable": true }, "vl_fax": { "type": "string", "nullable": true }, "vl_ext": { "type": "string", "nullable": true }, "bulkEmailAccess": { "type": "string", "nullable": true }, "onboardingDate": { "type": "string", "format": "date-time" }, "lobType": { "type": "number" }, "attrite": { "type": "number" }, "pipType": { "type": "number" }, "vonage_ext": { "type": "number", "nullable": true }, "aliance_ext": { "type": "number", "nullable": true }, "dids_number": { "type": "string", "nullable": true }, "apId": { "type": "number" }, "employeeId": { "type": "string", "nullable": true }, "socketId": { "type": "string" }, "roleId": { "type": "number" }, "smeMcVerification": { "type": "array", "items": { "$ref": "#/components/schemas/McVerificationPartialExcluding_id-userId-portalId_WithRelations" } }, "semCprApproved": { "type": "array", "items": { "$ref": "#/components/schemas/CprRequestPartialExcluding_id-userId-portalId_WithRelations" } }, "carrierPaymentDones": { "type": "array", "items": { "$ref": "#/components/schemas/CarrierPaymentDonePartialExcluding_id-userId-portalId_WithRelations" } }, "AssignApToBroker": { "$ref": "#/components/schemas/UserPartialExcluding_id-userId-portalId_WithRelations" }, "foreignKey": {}, "apincentives": { "type": "array", "items": { "$ref": "#/components/schemas/CarrierPaymentPartialExcluding_id-userId-portalId_WithRelations" } }, "role": { "$ref": "#/components/schemas/RolePartialExcluding_id-userId-portalId_WithRelations" }, "portal": { "$ref": "#/components/schemas/PortalPartialExcluding_id-userId-portalId_WithRelations" }, "shippers": { "type": "array", "items": { "$ref": "#/components/schemas/ShippersPartialExcluding_id-userId-portalId_WithRelations" } } }, "additionalProperties": false, "x-typescript-type": "Omit, 'id' | 'userId' | 'portalId'>" }, "ShipperLimitsPartialExcluding_id-userId-portalId_WithRelations": { "title": "ShipperLimitsPartialExcluding_id-userId-portalId_WithRelations", "type": "object", "description": "(tsType: Omit, 'id' | 'userId' | 'portalId'>, schemaOptions: { exclude: [ 'id', 'userId', 'portalId' ], includeRelations: true, partial: true })", "properties": { "shippersId": { "type": "number" }, "request_limit": { "type": "number", "nullable": true }, "secure_limit": { "type": "number", "nullable": true }, "un_secured_limit": { "type": "number", "nullable": true }, "approval_limit": { "type": "number", "nullable": true }, "un_approval_limit": { "type": "number", "nullable": true }, "reason_ar": { "type": "string" }, "reason_broker": { "type": "string" }, "type": { "type": "number" }, "status": { "type": "number" }, "limitType": { "type": "number" }, "creditLimitDoc": { "type": "string", "nullable": true }, "manager_id": { "type": "number", "nullable": true }, "approved_communication_type": { "type": "number", "nullable": true }, "manager_comments": { "type": "string" }, "created": { "type": "string", "format": "date-time" }, "ArUserID": { "type": "number" }, "user": { "$ref": "#/components/schemas/UserPartialExcluding_id-userId-portalId_WithRelations" }, "foreignKey": {}, "portal": { "$ref": "#/components/schemas/PortalPartialExcluding_id-userId-portalId_WithRelations" }, "shippers": { "$ref": "#/components/schemas/ShippersPartialExcluding_id-userId-portalId_WithRelations" }, "arusers": { "$ref": "#/components/schemas/UserPartialExcluding_id-userId-portalId_WithRelations" } }, "additionalProperties": false, "x-typescript-type": "Omit, 'id' | 'userId' | 'portalId'>" }, "ShipperSmallClaimWithRelations": { "title": "ShipperSmallClaimWithRelations", "type": "object", "description": "(tsType: ShipperSmallClaimWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "shippersId": { "type": "number" }, "shipmentId": { "type": "number" }, "balance": { "type": "number" }, "claimedAmount": { "type": "number" }, "claimReceivedAmount": { "type": "number" }, "insuranceCharges": { "type": "number" }, "claimDate": { "type": "string", "format": "date-time" }, "claimReceived": { "type": "string", "format": "date-time" }, "spokesTo": { "type": "string" }, "ar_name": { "type": "string" }, "ar_id": { "type": "number" }, "time": { "type": "string" }, "invoiceAmount": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "arComments": { "type": "string" }, "status": { "type": "number" }, "customerInsurance": { "type": "string" }, "allocatedTo": { "type": "string" }, "allocationDate": { "type": "string", "format": "date-time" }, "claimSubmittedTo": { "type": "string" }, "invoicesId": { "type": "number" }, "invoices": { "$ref": "#/components/schemas/InvoicesWithRelations" }, "foreignKey": {} }, "additionalProperties": false, "x-typescript-type": "ShipperSmallClaimWithRelations" }, "ShipperSmallClaim": { "title": "ShipperSmallClaim", "type": "object", "properties": { "id": { "type": "number" }, "shippersId": { "type": "number" }, "shipmentId": { "type": "number" }, "balance": { "type": "number" }, "claimedAmount": { "type": "number" }, "claimReceivedAmount": { "type": "number" }, "insuranceCharges": { "type": "number" }, "claimDate": { "type": "string", "format": "date-time" }, "claimReceived": { "type": "string", "format": "date-time" }, "spokesTo": { "type": "string" }, "ar_name": { "type": "string" }, "ar_id": { "type": "number" }, "time": { "type": "string" }, "invoiceAmount": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "arComments": { "type": "string" }, "status": { "type": "number" }, "customerInsurance": { "type": "string" }, "allocatedTo": { "type": "string" }, "allocationDate": { "type": "string", "format": "date-time" }, "claimSubmittedTo": { "type": "string" }, "invoicesId": { "type": "number" } }, "additionalProperties": false }, "ClaimArInvoice": { "title": "ClaimArInvoice", "type": "object", "properties": { "id": { "type": "number" }, "company_id": { "type": "number" }, "number": { "type": "string" }, "report_message": { "type": "string" }, "report_file": { "type": "string" }, "claim_message": { "type": "string" }, "claim_file": { "type": "string" }, "report_date": { "type": "string", "format": "date-time" }, "claim_date": { "type": "string", "format": "date-time" }, "user_id": { "type": "number" }, "customerInsurance": { "type": "string" }, "allocatedTo": { "type": "string" }, "allocationDate": { "type": "string", "format": "date-time" }, "claimSubmittedTo": { "type": "string" }, "claim_settled": { "type": "string" } }, "additionalProperties": false }, "InsuranceDocumentsWithRelations": { "title": "InsuranceDocumentsWithRelations", "type": "object", "description": "(tsType: InsuranceDocumentsWithRelations, schemaOptions: { includeRelations: true })", "properties": { "document_id": { "type": "number" }, "document_name": { "type": "string" }, "document_url": { "type": "string" }, "document_type": { "type": "string" }, "expiry_date": { "type": "string", "format": "date-time" }, "amount": { "type": "number" }, "doc_status": { "type": "number" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "uploaded_id": { "type": "number" }, "userDetails": { "$ref": "#/components/schemas/UserWithRelations" }, "foreignKey": {} }, "required": [ "document_url", "doc_status" ], "additionalProperties": false, "x-typescript-type": "InsuranceDocumentsWithRelations" }, "InsuranceDocuments": { "title": "InsuranceDocuments", "type": "object", "description": "(tsType: InsuranceDocuments, schemaOptions: { includeRelations: false })", "properties": { "document_id": { "type": "number" }, "document_name": { "type": "string" }, "document_url": { "type": "string" }, "document_type": { "type": "string" }, "expiry_date": { "type": "string", "format": "date-time" }, "amount": { "type": "number" }, "doc_status": { "type": "number" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "uploaded_id": { "type": "number" } }, "required": [ "document_url", "doc_status" ], "additionalProperties": false, "x-typescript-type": "InsuranceDocuments" }, "CollectionNotesWithRelations": { "title": "CollectionNotesWithRelations", "type": "object", "description": "(tsType: CollectionNotesWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "uid": { "type": "string" }, "shippersId": { "type": "number" }, "userId": { "type": "number" }, "portalId": { "type": "number" }, "ArUserID": { "type": "number" }, "spokeTo": { "type": "string", "nullable": true }, "date": { "type": "string", "format": "date-time" }, "reason": { "type": "string", "nullable": true }, "pendingAmount": { "type": "number", "nullable": true }, "receivedAmount": { "type": "number", "nullable": true }, "insuranceCharge": { "type": "number", "nullable": true }, "time": { "type": "string", "format": "date-time" }, "status": { "type": "number" }, "created": { "type": "string", "format": "date-time" }, "shippers": { "$ref": "#/components/schemas/ShippersWithRelations" }, "foreignKey": {}, "user": { "$ref": "#/components/schemas/UserWithRelations" }, "portal": { "$ref": "#/components/schemas/PortalWithRelations" }, "aruser": { "$ref": "#/components/schemas/UserWithRelations" } }, "required": [ "uid" ], "additionalProperties": false, "x-typescript-type": "CollectionNotesWithRelations" }, "CollectionSettleWithRelations": { "title": "CollectionSettleWithRelations", "type": "object", "description": "(tsType: CollectionSettleWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "invoicesId": { "type": "number" }, "shipmentId": { "type": "number" }, "shippersId": { "type": "number" }, "userId": { "type": "number" }, "portalId": { "type": "number" }, "ArUserID": { "type": "number" }, "collectionNotesId": { "type": "number" }, "pendingAmount": { "type": "number", "nullable": true }, "receivedAmount": { "type": "number", "nullable": true }, "insuranceCharge": { "type": "number", "nullable": true }, "status": { "type": "number" }, "reason": { "type": "string", "nullable": true }, "created": { "type": "string", "format": "date-time" }, "invoices": { "$ref": "#/components/schemas/InvoicesWithRelations" }, "foreignKey": {}, "shipment": { "$ref": "#/components/schemas/ShipmentWithRelations" }, "shippers": { "$ref": "#/components/schemas/ShippersWithRelations" }, "user": { "$ref": "#/components/schemas/UserWithRelations" }, "portal": { "$ref": "#/components/schemas/PortalWithRelations" }, "aruser": { "$ref": "#/components/schemas/UserWithRelations" }, "collectionNotes": { "$ref": "#/components/schemas/CollectionNotesWithRelations" } }, "additionalProperties": false, "x-typescript-type": "CollectionSettleWithRelations" }, "CollectionSettle": { "title": "CollectionSettle", "type": "object", "properties": { "id": { "type": "number" }, "invoicesId": { "type": "number" }, "shipmentId": { "type": "number" }, "shippersId": { "type": "number" }, "userId": { "type": "number" }, "portalId": { "type": "number" }, "ArUserID": { "type": "number" }, "collectionNotesId": { "type": "number" }, "pendingAmount": { "type": "number", "nullable": true }, "receivedAmount": { "type": "number", "nullable": true }, "insuranceCharge": { "type": "number", "nullable": true }, "status": { "type": "number" }, "reason": { "type": "string", "nullable": true }, "created": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "ClaimArInvoiceProWithRelations": { "title": "ClaimArInvoiceProWithRelations", "type": "object", "description": "(tsType: ClaimArInvoiceProWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "claim_id": { "type": "number" }, "pro_id": { "type": "number" }, "below_90": { "type": "number" }, "claim_received": { "type": "string", "enum": [ "1", "2" ] }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } }, "required": [ "claim_received" ], "additionalProperties": false, "x-typescript-type": "ClaimArInvoiceProWithRelations" }, "ClaimArInvoiceWithRelations": { "title": "ClaimArInvoiceWithRelations", "type": "object", "description": "(tsType: ClaimArInvoiceWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "company_id": { "type": "number" }, "number": { "type": "string" }, "report_message": { "type": "string" }, "report_file": { "type": "string" }, "claim_message": { "type": "string" }, "claim_file": { "type": "string" }, "report_date": { "type": "string", "format": "date-time" }, "claim_date": { "type": "string", "format": "date-time" }, "user_id": { "type": "number" }, "customerInsurance": { "type": "string" }, "allocatedTo": { "type": "string" }, "allocationDate": { "type": "string", "format": "date-time" }, "claimSubmittedTo": { "type": "string" }, "claim_settled": { "type": "string" }, "claimArInvoicePros": { "type": "array", "items": { "$ref": "#/components/schemas/ClaimArInvoiceProWithRelations" } } }, "additionalProperties": false, "x-typescript-type": "ClaimArInvoiceWithRelations" }, "ArApLockedIncentive": { "title": "ArApLockedIncentive", "type": "object", "properties": { "id": { "type": "number" }, "userId": { "type": "number" }, "comments": { "type": "string" }, "amount": { "type": "number" }, "incentiveDate": { "type": "string", "format": "date-time" } }, "required": [ "userId", "amount" ], "additionalProperties": false }, "NewArApLockedIncentive": { "title": "NewArApLockedIncentive", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewArApLockedIncentive', exclude: [ 'id' ] })", "properties": { "userId": { "type": "number" }, "comments": { "type": "string" }, "amount": { "type": "number" }, "incentiveDate": { "type": "string", "format": "date-time" } }, "required": [ "userId", "amount" ], "additionalProperties": false, "x-typescript-type": "Omit" }, "ArApLockedIncentiveWithRelations": { "title": "ArApLockedIncentiveWithRelations", "type": "object", "description": "(tsType: ArApLockedIncentiveWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "userId": { "type": "number" }, "comments": { "type": "string" }, "amount": { "type": "number" }, "incentiveDate": { "type": "string", "format": "date-time" } }, "required": [ "userId", "amount" ], "additionalProperties": false, "x-typescript-type": "ArApLockedIncentiveWithRelations" }, "ArApLockedIncentivePartial": { "title": "ArApLockedIncentivePartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number" }, "userId": { "type": "number" }, "comments": { "type": "string" }, "amount": { "type": "number" }, "incentiveDate": { "type": "string", "format": "date-time" } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "ApSendPayment": { "title": "ApSendPayment", "type": "object", "properties": { "id": { "type": "number" }, "sendEmail": { "type": "number" }, "status": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "shipmentId": { "type": "number" }, "carrierPaymentId": { "type": "number" }, "ApId": { "type": "number" }, "portalId": { "type": "number" } }, "additionalProperties": false }, "ApSendPaymentWithRelations": { "title": "ApSendPaymentWithRelations", "type": "object", "description": "(tsType: ApSendPaymentWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "sendEmail": { "type": "number" }, "status": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "shipmentId": { "type": "number" }, "carrierPaymentId": { "type": "number" }, "ApId": { "type": "number" }, "portalId": { "type": "number" }, "shipment": { "$ref": "#/components/schemas/ShipmentWithRelations" }, "foreignKey": {}, "carrierPayment": { "$ref": "#/components/schemas/CarrierPaymentWithRelations" }, "Ap": { "$ref": "#/components/schemas/UserWithRelations" }, "portal": { "$ref": "#/components/schemas/PortalWithRelations" } }, "additionalProperties": false, "x-typescript-type": "ApSendPaymentWithRelations" }, "RemittanceApWithRelations": { "title": "RemittanceApWithRelations", "type": "object", "description": "(tsType: RemittanceApWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "message": { "type": "string" }, "amount": { "type": "number", "nullable": true }, "paymentMethod": { "type": "string" }, "status": { "type": "number", "nullable": true }, "remittanceFile": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "shipmentId": { "type": "number" }, "carriersId": { "type": "number" }, "portalId": { "type": "number" }, "shipment": { "$ref": "#/components/schemas/ShipmentWithRelations" }, "foreignKey": {}, "carriers": { "$ref": "#/components/schemas/CarriersWithRelations" }, "portal": { "$ref": "#/components/schemas/PortalWithRelations" } }, "additionalProperties": false, "x-typescript-type": "RemittanceApWithRelations" }, "ApMessagesHistory": { "title": "ApMessagesHistory", "type": "object", "properties": { "id": { "type": "number" }, "message": { "type": "string" }, "regarding": { "type": "string" }, "created": { "type": "string", "format": "date-time" }, "userId": { "type": "number" }, "shipmentId": { "type": "number" }, "carriersId": { "type": "number" } }, "additionalProperties": false }, "NewApMessagesHistory": { "title": "NewApMessagesHistory", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewApMessagesHistory', exclude: [ 'id' ] })", "properties": { "message": { "type": "string" }, "regarding": { "type": "string" }, "created": { "type": "string", "format": "date-time" }, "userId": { "type": "number" }, "shipmentId": { "type": "number" }, "carriersId": { "type": "number" } }, "additionalProperties": false, "x-typescript-type": "Omit" }, "ApMessagesHistoryPartial": { "title": "ApMessagesHistoryPartial", "type": "object", "description": "(tsType: Partial, schemaOptions: { partial: true })", "properties": { "id": { "type": "number" }, "message": { "type": "string" }, "regarding": { "type": "string" }, "created": { "type": "string", "format": "date-time" }, "userId": { "type": "number" }, "shipmentId": { "type": "number" }, "carriersId": { "type": "number" } }, "additionalProperties": false, "x-typescript-type": "Partial" }, "ApEmailToCarrierWithRelations": { "title": "ApEmailToCarrierWithRelations", "type": "object", "description": "(tsType: ApEmailToCarrierWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "paymentType": { "type": "number", "nullable": true }, "paymentMethod": { "type": "string", "nullable": true }, "paymentInitiated": { "type": "string", "format": "date-time", "nullable": true }, "brokerEmail": { "type": "string", "nullable": true }, "carrierEmail": { "type": "string", "nullable": true }, "notes": { "type": "string", "nullable": true }, "containerNo": { "type": "string", "nullable": true }, "carrierInvoiceNumber": { "type": "string", "nullable": true }, "fcarrierName": { "type": "string", "nullable": true }, "cName": { "type": "string", "nullable": true }, "acName": { "type": "string", "nullable": true }, "achAccountNo": { "type": "string", "nullable": true }, "wireAccountNo": { "type": "string", "nullable": true }, "amountUsd": { "type": "number", "nullable": true }, "amountCad": { "type": "number", "nullable": true }, "address": { "type": "string", "nullable": true }, "emailStatus": { "type": "string", "nullable": true }, "quickPay": { "type": "number", "nullable": true }, "batchNumber": { "type": "string", "nullable": true }, "attachment": { "type": "string", "nullable": true }, "zipCodesId": { "type": "number", "nullable": true }, "createdAt": { "type": "string", "format": "date-time", "nullable": true }, "updatedAt": { "type": "string", "format": "date-time", "nullable": true }, "portalId": { "type": "number" }, "carriersId": { "type": "number" }, "shipmentId": { "type": "number" }, "carrierPaymentId": { "type": "number" }, "portal": { "$ref": "#/components/schemas/PortalWithRelations" }, "foreignKey": {}, "carriers": { "$ref": "#/components/schemas/CarriersWithRelations" }, "shipment": { "$ref": "#/components/schemas/ShipmentWithRelations" } }, "additionalProperties": false, "x-typescript-type": "ApEmailToCarrierWithRelations" }, "NewCarrierPaymentDone": { "title": "NewCarrierPaymentDone", "type": "object", "description": "(tsType: Omit, schemaOptions: { title: 'NewCarrierPaymentDone', exclude: [ 'id' ] })", "properties": { "carrier_id": { "type": "number" }, "shipmentNo": { "type": "number" }, "carrier_name": { "type": "string" }, "portal_id": { "type": "number" }, "age_date": { "type": "string", "format": "date-time" }, "invoice_number": { "type": "number" }, "invoice_date": { "type": "string", "format": "date-time" }, "advance_payment_date": { "type": "string", "format": "date-time" }, "advance_pay_usd": { "type": "number" }, "advance_pay_cad": { "type": "number" }, "advance_pay_type": { "type": "string" }, "payable_amount_usd": { "type": "number" }, "payable_amount_cad": { "type": "number" }, "quick_book_invoice_status": { "type": "number" }, "quick_book_invoice_date": { "type": "string", "format": "date-time" }, "status": { "type": "number", "enum": [ 0, 1, 2, 3 ] }, "agent_name": { "type": "string" }, "quick_pay": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "shipmentId": { "type": "number" }, "carriersId": { "type": "number" }, "userId": { "type": "number" } }, "required": [ "status" ], "additionalProperties": false, "x-typescript-type": "Omit" }, "CarrierPaymentDoneWithRelations": { "title": "CarrierPaymentDoneWithRelations", "type": "object", "description": "(tsType: CarrierPaymentDoneWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "carrier_id": { "type": "number" }, "shipmentNo": { "type": "number" }, "carrier_name": { "type": "string" }, "portal_id": { "type": "number" }, "age_date": { "type": "string", "format": "date-time" }, "invoice_number": { "type": "number" }, "invoice_date": { "type": "string", "format": "date-time" }, "advance_payment_date": { "type": "string", "format": "date-time" }, "advance_pay_usd": { "type": "number" }, "advance_pay_cad": { "type": "number" }, "advance_pay_type": { "type": "string" }, "payable_amount_usd": { "type": "number" }, "payable_amount_cad": { "type": "number" }, "quick_book_invoice_status": { "type": "number" }, "quick_book_invoice_date": { "type": "string", "format": "date-time" }, "status": { "type": "number", "enum": [ 0, 1, 2, 3 ] }, "agent_name": { "type": "string" }, "quick_pay": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "shipmentId": { "type": "number" }, "carriersId": { "type": "number" }, "userId": { "type": "number" }, "shipment": { "$ref": "#/components/schemas/ShipmentWithRelations" }, "foreignKey": {}, "carriers": { "$ref": "#/components/schemas/CarriersWithRelations" }, "user": { "$ref": "#/components/schemas/UserWithRelations" } }, "required": [ "status" ], "additionalProperties": false, "x-typescript-type": "CarrierPaymentDoneWithRelations" }, "AdvancePayCarrierPaymentWithRelations": { "title": "AdvancePayCarrierPaymentWithRelations", "type": "object", "description": "(tsType: AdvancePayCarrierPaymentWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "shipmentId": { "type": "number" }, "paymentMethod": { "type": "string" }, "amount": { "type": "number" }, "description": { "type": "string" }, "addedBy": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "amount" ], "additionalProperties": false, "x-typescript-type": "AdvancePayCarrierPaymentWithRelations" }, "AdvancePayCarrierPayment": { "title": "AdvancePayCarrierPayment", "type": "object", "properties": { "id": { "type": "number" }, "shipmentId": { "type": "number" }, "paymentMethod": { "type": "string" }, "amount": { "type": "number" }, "description": { "type": "string" }, "addedBy": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "amount" ], "additionalProperties": false }, "CarrierShipmentTracking": { "title": "CarrierShipmentTracking", "type": "object", "properties": { "id": { "type": "number" }, "latitude": { "type": "string" }, "longitude": { "type": "string" }, "status": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "carrierLoginId": { "type": "number" } }, "additionalProperties": false }, "CarrierConfirmDelivery": { "title": "CarrierConfirmDelivery", "type": "object", "properties": { "id": { "type": "number" }, "confirmDoc": { "type": "string" }, "stoppedDoc": { "type": "string" }, "confirmedAt": { "type": "string", "format": "date-time" }, "stoppedAt": { "type": "string", "format": "date-time" }, "status": { "type": "number" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "carrierLoginId": { "type": "number" }, "shipmentId": { "type": "number" } }, "additionalProperties": false }, "AppSettingsWithRelations": { "title": "AppSettingsWithRelations", "type": "object", "description": "(tsType: AppSettingsWithRelations, schemaOptions: { includeRelations: true })", "properties": { "id": { "type": "number" }, "type": { "type": "string" }, "platform": { "type": "string" }, "version": { "type": "string" }, "description": { "type": "string" }, "confirm_pickup_radius": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "type", "platform" ], "additionalProperties": false, "x-typescript-type": "AppSettingsWithRelations" }, "loopback.Count": { "type": "object", "title": "loopback.Count", "x-typescript-type": "@loopback/repository#Count", "properties": { "count": { "type": "number" } } }, "ApEmailToCarrier.ScopeFilter": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": {}, "additionalProperties": true }, { "type": "array", "items": { "type": "string" }, "uniqueItems": true } ] }, "include": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true } } }, "additionalProperties": false, "title": "ApEmailToCarrier.ScopeFilter" }, "ApEmailToCarrier.IncludeFilter.Items": { "title": "ApEmailToCarrier.IncludeFilter.Items", "type": "object", "properties": { "relation": { "type": "string", "enum": [ "portal", "carriers", "shipment" ] }, "scope": { "$ref": "#/components/schemas/ApEmailToCarrier.ScopeFilter" } } }, "ApEmailToCarrier.Filter": { "type": "object", "title": "ApEmailToCarrier.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "paymentType": { "type": "boolean" }, "paymentMethod": { "type": "boolean" }, "paymentInitiated": { "type": "boolean" }, "brokerEmail": { "type": "boolean" }, "carrierEmail": { "type": "boolean" }, "notes": { "type": "boolean" }, "containerNo": { "type": "boolean" }, "carrierInvoiceNumber": { "type": "boolean" }, "fcarrierName": { "type": "boolean" }, "cName": { "type": "boolean" }, "acName": { "type": "boolean" }, "achAccountNo": { "type": "boolean" }, "wireAccountNo": { "type": "boolean" }, "amountUsd": { "type": "boolean" }, "amountCad": { "type": "boolean" }, "address": { "type": "boolean" }, "emailStatus": { "type": "boolean" }, "quickPay": { "type": "boolean" }, "batchNumber": { "type": "boolean" }, "attachment": { "type": "boolean" }, "zipCodesId": { "type": "boolean" }, "createdAt": { "type": "boolean" }, "updatedAt": { "type": "boolean" }, "portalId": { "type": "boolean" }, "carriersId": { "type": "boolean" }, "shipmentId": { "type": "boolean" }, "carrierPaymentId": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "paymentType", "paymentMethod", "paymentInitiated", "brokerEmail", "carrierEmail", "notes", "containerNo", "carrierInvoiceNumber", "fcarrierName", "cName", "acName", "achAccountNo", "wireAccountNo", "amountUsd", "amountCad", "address", "emailStatus", "quickPay", "batchNumber", "attachment", "zipCodesId", "createdAt", "updatedAt", "portalId", "carriersId", "shipmentId", "carrierPaymentId" ], "example": "id" }, "uniqueItems": true } ], "title": "ApEmailToCarrier.Fields" }, "include": { "title": "ApEmailToCarrier.IncludeFilter", "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/ApEmailToCarrier.IncludeFilter.Items" }, { "type": "string" } ] } } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "ApEmailToCarrier.Filter1": { "type": "object", "title": "ApEmailToCarrier.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "ApEmailToCarrier.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "paymentType": { "type": "boolean" }, "paymentMethod": { "type": "boolean" }, "paymentInitiated": { "type": "boolean" }, "brokerEmail": { "type": "boolean" }, "carrierEmail": { "type": "boolean" }, "notes": { "type": "boolean" }, "containerNo": { "type": "boolean" }, "carrierInvoiceNumber": { "type": "boolean" }, "fcarrierName": { "type": "boolean" }, "cName": { "type": "boolean" }, "acName": { "type": "boolean" }, "achAccountNo": { "type": "boolean" }, "wireAccountNo": { "type": "boolean" }, "amountUsd": { "type": "boolean" }, "amountCad": { "type": "boolean" }, "address": { "type": "boolean" }, "emailStatus": { "type": "boolean" }, "quickPay": { "type": "boolean" }, "batchNumber": { "type": "boolean" }, "attachment": { "type": "boolean" }, "zipCodesId": { "type": "boolean" }, "createdAt": { "type": "boolean" }, "updatedAt": { "type": "boolean" }, "portalId": { "type": "boolean" }, "carriersId": { "type": "boolean" }, "shipmentId": { "type": "boolean" }, "carrierPaymentId": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "paymentType", "paymentMethod", "paymentInitiated", "brokerEmail", "carrierEmail", "notes", "containerNo", "carrierInvoiceNumber", "fcarrierName", "cName", "acName", "achAccountNo", "wireAccountNo", "amountUsd", "amountCad", "address", "emailStatus", "quickPay", "batchNumber", "attachment", "zipCodesId", "createdAt", "updatedAt", "portalId", "carriersId", "shipmentId", "carrierPaymentId" ], "example": "id" }, "uniqueItems": true } ], "title": "ApEmailToCarrier.Fields" }, "include": { "title": "ApEmailToCarrier.IncludeFilter", "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/ApEmailToCarrier.IncludeFilter.Items" }, { "type": "string" } ] } } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "ApMessagesHistory.ScopeFilter": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": {}, "additionalProperties": true }, { "type": "array", "items": { "type": "string" }, "uniqueItems": true } ] }, "include": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true } } }, "additionalProperties": false, "title": "ApMessagesHistory.ScopeFilter" }, "ApMessagesHistory.IncludeFilter.Items": { "title": "ApMessagesHistory.IncludeFilter.Items", "type": "object", "properties": { "relation": { "type": "string", "enum": [ "user", "shipment", "carriers" ] }, "scope": { "$ref": "#/components/schemas/ApMessagesHistory.ScopeFilter" } } }, "ApMessagesHistory.Filter": { "type": "object", "title": "ApMessagesHistory.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "message": { "type": "boolean" }, "regarding": { "type": "boolean" }, "created": { "type": "boolean" }, "userId": { "type": "boolean" }, "shipmentId": { "type": "boolean" }, "carriersId": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "message", "regarding", "created", "userId", "shipmentId", "carriersId" ], "example": "id" }, "uniqueItems": true } ], "title": "ApMessagesHistory.Fields" }, "include": { "title": "ApMessagesHistory.IncludeFilter", "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/ApMessagesHistory.IncludeFilter.Items" }, { "type": "string" } ] } } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "ApMessagesHistory.Filter1": { "type": "object", "title": "ApMessagesHistory.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "ApMessagesHistory.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "message": { "type": "boolean" }, "regarding": { "type": "boolean" }, "created": { "type": "boolean" }, "userId": { "type": "boolean" }, "shipmentId": { "type": "boolean" }, "carriersId": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "message", "regarding", "created", "userId", "shipmentId", "carriersId" ], "example": "id" }, "uniqueItems": true } ], "title": "ApMessagesHistory.Fields" }, "include": { "title": "ApMessagesHistory.IncludeFilter", "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/ApMessagesHistory.IncludeFilter.Items" }, { "type": "string" } ] } } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "ArApLockedIncentive.Filter": { "type": "object", "title": "ArApLockedIncentive.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "userId": { "type": "boolean" }, "comments": { "type": "boolean" }, "amount": { "type": "boolean" }, "incentiveDate": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "userId", "comments", "amount", "incentiveDate" ], "example": "id" }, "uniqueItems": true } ], "title": "ArApLockedIncentive.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "ArApLockedIncentive.Filter1": { "type": "object", "title": "ArApLockedIncentive.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "ArApLockedIncentive.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "userId": { "type": "boolean" }, "comments": { "type": "boolean" }, "amount": { "type": "boolean" }, "incentiveDate": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "userId", "comments", "amount", "incentiveDate" ], "example": "id" }, "uniqueItems": true } ], "title": "ArApLockedIncentive.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "BrokerAsiIncentives.Filter": { "type": "object", "title": "BrokerAsiIncentives.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "userId": { "type": "boolean" }, "shipmentId": { "type": "boolean" }, "tlID": { "type": "boolean" }, "managerID": { "type": "boolean" }, "shipperPrice": { "type": "boolean" }, "carrierPrice": { "type": "boolean" }, "companyMargin": { "type": "boolean" }, "brokerMargin": { "type": "boolean" }, "lastReceivedDate": { "type": "boolean" }, "incentiveDate": { "type": "boolean" }, "slabMonth": { "type": "boolean" }, "slabMargin": { "type": "boolean" }, "slabPercentage": { "type": "boolean" }, "created": { "type": "boolean" }, "modified": { "type": "boolean" }, "slabProCount": { "type": "boolean" }, "slabDescription": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "userId", "shipmentId", "tlID", "managerID", "shipperPrice", "carrierPrice", "companyMargin", "brokerMargin", "lastReceivedDate", "incentiveDate", "slabMonth", "slabMargin", "slabPercentage", "created", "modified", "slabProCount", "slabDescription" ], "example": "id" }, "uniqueItems": true } ], "title": "BrokerAsiIncentives.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "BrokerAsiIncentives.Filter1": { "type": "object", "title": "BrokerAsiIncentives.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "BrokerAsiIncentives.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "userId": { "type": "boolean" }, "shipmentId": { "type": "boolean" }, "tlID": { "type": "boolean" }, "managerID": { "type": "boolean" }, "shipperPrice": { "type": "boolean" }, "carrierPrice": { "type": "boolean" }, "companyMargin": { "type": "boolean" }, "brokerMargin": { "type": "boolean" }, "lastReceivedDate": { "type": "boolean" }, "incentiveDate": { "type": "boolean" }, "slabMonth": { "type": "boolean" }, "slabMargin": { "type": "boolean" }, "slabPercentage": { "type": "boolean" }, "created": { "type": "boolean" }, "modified": { "type": "boolean" }, "slabProCount": { "type": "boolean" }, "slabDescription": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "userId", "shipmentId", "tlID", "managerID", "shipperPrice", "carrierPrice", "companyMargin", "brokerMargin", "lastReceivedDate", "incentiveDate", "slabMonth", "slabMargin", "slabPercentage", "created", "modified", "slabProCount", "slabDescription" ], "example": "id" }, "uniqueItems": true } ], "title": "BrokerAsiIncentives.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "BrokerVlIncentives.Filter": { "type": "object", "title": "BrokerVlIncentives.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "userId": { "type": "boolean" }, "shipmentId": { "type": "boolean" }, "tlID": { "type": "boolean" }, "managerID": { "type": "boolean" }, "shipperPrice": { "type": "boolean" }, "carrierPrice": { "type": "boolean" }, "companyMargin": { "type": "boolean" }, "brokerMargin": { "type": "boolean" }, "lastReceivedDate": { "type": "boolean" }, "incentiveDate": { "type": "boolean" }, "PickupDate": { "type": "boolean" }, "incentiveStatus": { "type": "boolean" }, "paidStatus": { "type": "boolean" }, "incentivePaidDate": { "type": "boolean" }, "created": { "type": "boolean" }, "modified": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "userId", "shipmentId", "tlID", "managerID", "shipperPrice", "carrierPrice", "companyMargin", "brokerMargin", "lastReceivedDate", "incentiveDate", "PickupDate", "incentiveStatus", "paidStatus", "incentivePaidDate", "created", "modified" ], "example": "id" }, "uniqueItems": true } ], "title": "BrokerVlIncentives.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "BrokerVlIncentives.Filter1": { "type": "object", "title": "BrokerVlIncentives.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "BrokerVlIncentives.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "userId": { "type": "boolean" }, "shipmentId": { "type": "boolean" }, "tlID": { "type": "boolean" }, "managerID": { "type": "boolean" }, "shipperPrice": { "type": "boolean" }, "carrierPrice": { "type": "boolean" }, "companyMargin": { "type": "boolean" }, "brokerMargin": { "type": "boolean" }, "lastReceivedDate": { "type": "boolean" }, "incentiveDate": { "type": "boolean" }, "PickupDate": { "type": "boolean" }, "incentiveStatus": { "type": "boolean" }, "paidStatus": { "type": "boolean" }, "incentivePaidDate": { "type": "boolean" }, "created": { "type": "boolean" }, "modified": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "userId", "shipmentId", "tlID", "managerID", "shipperPrice", "carrierPrice", "companyMargin", "brokerMargin", "lastReceivedDate", "incentiveDate", "PickupDate", "incentiveStatus", "paidStatus", "incentivePaidDate", "created", "modified" ], "example": "id" }, "uniqueItems": true } ], "title": "BrokerVlIncentives.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "BrokerVlIncentivesCalender.Filter": { "type": "object", "title": "BrokerVlIncentivesCalender.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "userId": { "type": "boolean" }, "year": { "type": "boolean" }, "january": { "type": "boolean" }, "januaryDeduction": { "type": "boolean" }, "february": { "type": "boolean" }, "februaryDeduction": { "type": "boolean" }, "march": { "type": "boolean" }, "marchDeduction": { "type": "boolean" }, "april": { "type": "boolean" }, "aprilDeduction": { "type": "boolean" }, "may": { "type": "boolean" }, "mayDeduction": { "type": "boolean" }, "june": { "type": "boolean" }, "juneDeduction": { "type": "boolean" }, "july": { "type": "boolean" }, "julyDeduction": { "type": "boolean" }, "august": { "type": "boolean" }, "augustDeduction": { "type": "boolean" }, "september": { "type": "boolean" }, "septemberDeduction": { "type": "boolean" }, "october": { "type": "boolean" }, "octoberDeduction": { "type": "boolean" }, "november": { "type": "boolean" }, "novemberDeduction": { "type": "boolean" }, "december": { "type": "boolean" }, "decemberDeduction": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "userId", "year", "january", "januaryDeduction", "february", "februaryDeduction", "march", "marchDeduction", "april", "aprilDeduction", "may", "mayDeduction", "june", "juneDeduction", "july", "julyDeduction", "august", "augustDeduction", "september", "septemberDeduction", "october", "octoberDeduction", "november", "novemberDeduction", "december", "decemberDeduction" ], "example": "id" }, "uniqueItems": true } ], "title": "BrokerVlIncentivesCalender.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "BrokerVlIncentivesCalender.Filter1": { "type": "object", "title": "BrokerVlIncentivesCalender.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "BrokerVlIncentivesCalender.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "userId": { "type": "boolean" }, "year": { "type": "boolean" }, "january": { "type": "boolean" }, "januaryDeduction": { "type": "boolean" }, "february": { "type": "boolean" }, "februaryDeduction": { "type": "boolean" }, "march": { "type": "boolean" }, "marchDeduction": { "type": "boolean" }, "april": { "type": "boolean" }, "aprilDeduction": { "type": "boolean" }, "may": { "type": "boolean" }, "mayDeduction": { "type": "boolean" }, "june": { "type": "boolean" }, "juneDeduction": { "type": "boolean" }, "july": { "type": "boolean" }, "julyDeduction": { "type": "boolean" }, "august": { "type": "boolean" }, "augustDeduction": { "type": "boolean" }, "september": { "type": "boolean" }, "septemberDeduction": { "type": "boolean" }, "october": { "type": "boolean" }, "octoberDeduction": { "type": "boolean" }, "november": { "type": "boolean" }, "novemberDeduction": { "type": "boolean" }, "december": { "type": "boolean" }, "decemberDeduction": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "userId", "year", "january", "januaryDeduction", "february", "februaryDeduction", "march", "marchDeduction", "april", "aprilDeduction", "may", "mayDeduction", "june", "juneDeduction", "july", "julyDeduction", "august", "augustDeduction", "september", "septemberDeduction", "october", "octoberDeduction", "november", "novemberDeduction", "december", "decemberDeduction" ], "example": "id" }, "uniqueItems": true } ], "title": "BrokerVlIncentivesCalender.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "BrokerVlOtrIncentives.Filter": { "type": "object", "title": "BrokerVlOtrIncentives.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "shipmentId": { "type": "boolean" }, "invoiceId": { "type": "boolean" }, "total": { "type": "boolean" }, "pending": { "type": "boolean" }, "received": { "type": "boolean" }, "type": { "type": "boolean" }, "IncentiveDate": { "type": "boolean" }, "payReceivedDate": { "type": "boolean" }, "shipper": { "type": "boolean" }, "carrier": { "type": "boolean" }, "margin": { "type": "boolean" }, "monthSlabCount": { "type": "boolean" }, "incentive": { "type": "boolean" }, "disburseLastMonthIncentive": { "type": "boolean" }, "slabPercentage": { "type": "boolean" }, "captureDate": { "type": "boolean" }, "invoiceDate": { "type": "boolean" }, "pickupDate": { "type": "boolean" }, "BrokerId": { "type": "boolean" }, "description": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "shipmentId", "invoiceId", "total", "pending", "received", "type", "IncentiveDate", "payReceivedDate", "shipper", "carrier", "margin", "monthSlabCount", "incentive", "disburseLastMonthIncentive", "slabPercentage", "captureDate", "invoiceDate", "pickupDate", "BrokerId", "description" ], "example": "id" }, "uniqueItems": true } ], "title": "BrokerVlOtrIncentives.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "BrokerVlOtrIncentives.Filter1": { "type": "object", "title": "BrokerVlOtrIncentives.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "BrokerVlOtrIncentives.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "shipmentId": { "type": "boolean" }, "invoiceId": { "type": "boolean" }, "total": { "type": "boolean" }, "pending": { "type": "boolean" }, "received": { "type": "boolean" }, "type": { "type": "boolean" }, "IncentiveDate": { "type": "boolean" }, "payReceivedDate": { "type": "boolean" }, "shipper": { "type": "boolean" }, "carrier": { "type": "boolean" }, "margin": { "type": "boolean" }, "monthSlabCount": { "type": "boolean" }, "incentive": { "type": "boolean" }, "disburseLastMonthIncentive": { "type": "boolean" }, "slabPercentage": { "type": "boolean" }, "captureDate": { "type": "boolean" }, "invoiceDate": { "type": "boolean" }, "pickupDate": { "type": "boolean" }, "BrokerId": { "type": "boolean" }, "description": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "shipmentId", "invoiceId", "total", "pending", "received", "type", "IncentiveDate", "payReceivedDate", "shipper", "carrier", "margin", "monthSlabCount", "incentive", "disburseLastMonthIncentive", "slabPercentage", "captureDate", "invoiceDate", "pickupDate", "BrokerId", "description" ], "example": "id" }, "uniqueItems": true } ], "title": "BrokerVlOtrIncentives.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "BrokerVlOtrIncentivesNew.Filter": { "type": "object", "title": "BrokerVlOtrIncentivesNew.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "userId": { "type": "boolean" }, "shipmentId": { "type": "boolean" }, "tlID": { "type": "boolean" }, "managerID": { "type": "boolean" }, "shipperPrice": { "type": "boolean" }, "carrierPrice": { "type": "boolean" }, "companyMargin": { "type": "boolean" }, "brokerMargin": { "type": "boolean" }, "lastReceivedDate": { "type": "boolean" }, "incentiveDate": { "type": "boolean" }, "slabMonth": { "type": "boolean" }, "slabMargin": { "type": "boolean" }, "slabPercentage": { "type": "boolean" }, "created": { "type": "boolean" }, "modified": { "type": "boolean" }, "slabProCount": { "type": "boolean" }, "slabDescription": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "userId", "shipmentId", "tlID", "managerID", "shipperPrice", "carrierPrice", "companyMargin", "brokerMargin", "lastReceivedDate", "incentiveDate", "slabMonth", "slabMargin", "slabPercentage", "created", "modified", "slabProCount", "slabDescription" ], "example": "id" }, "uniqueItems": true } ], "title": "BrokerVlOtrIncentivesNew.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "BrokerVlOtrIncentivesNew.Filter1": { "type": "object", "title": "BrokerVlOtrIncentivesNew.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "BrokerVlOtrIncentivesNew.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "userId": { "type": "boolean" }, "shipmentId": { "type": "boolean" }, "tlID": { "type": "boolean" }, "managerID": { "type": "boolean" }, "shipperPrice": { "type": "boolean" }, "carrierPrice": { "type": "boolean" }, "companyMargin": { "type": "boolean" }, "brokerMargin": { "type": "boolean" }, "lastReceivedDate": { "type": "boolean" }, "incentiveDate": { "type": "boolean" }, "slabMonth": { "type": "boolean" }, "slabMargin": { "type": "boolean" }, "slabPercentage": { "type": "boolean" }, "created": { "type": "boolean" }, "modified": { "type": "boolean" }, "slabProCount": { "type": "boolean" }, "slabDescription": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "userId", "shipmentId", "tlID", "managerID", "shipperPrice", "carrierPrice", "companyMargin", "brokerMargin", "lastReceivedDate", "incentiveDate", "slabMonth", "slabMargin", "slabPercentage", "created", "modified", "slabProCount", "slabDescription" ], "example": "id" }, "uniqueItems": true } ], "title": "BrokerVlOtrIncentivesNew.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "BrokerVlOtrIncentivesTl.Filter": { "type": "object", "title": "BrokerVlOtrIncentivesTl.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "userId": { "type": "boolean" }, "incentiveDate": { "type": "boolean" }, "total_hpFor_margin": { "type": "boolean" }, "total_hprFor_margin": { "type": "boolean" }, "total_spFor_margin": { "type": "boolean" }, "total_sprFor_margin": { "type": "boolean" }, "totalPending": { "type": "boolean" }, "companyMargin": { "type": "boolean" }, "cmt": { "type": "boolean" }, "margin": { "type": "boolean" }, "afterslab": { "type": "boolean" }, "tlName": { "type": "boolean" }, "tmName": { "type": "boolean" }, "userType": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "userId", "incentiveDate", "total_hpFor_margin", "total_hprFor_margin", "total_spFor_margin", "total_sprFor_margin", "totalPending", "companyMargin", "cmt", "margin", "afterslab", "tlName", "tmName", "userType" ], "example": "id" }, "uniqueItems": true } ], "title": "BrokerVlOtrIncentivesTl.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "BrokerVlOtrIncentivesTl.Filter1": { "type": "object", "title": "BrokerVlOtrIncentivesTl.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "BrokerVlOtrIncentivesTl.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "userId": { "type": "boolean" }, "incentiveDate": { "type": "boolean" }, "total_hpFor_margin": { "type": "boolean" }, "total_hprFor_margin": { "type": "boolean" }, "total_spFor_margin": { "type": "boolean" }, "total_sprFor_margin": { "type": "boolean" }, "totalPending": { "type": "boolean" }, "companyMargin": { "type": "boolean" }, "cmt": { "type": "boolean" }, "margin": { "type": "boolean" }, "afterslab": { "type": "boolean" }, "tlName": { "type": "boolean" }, "tmName": { "type": "boolean" }, "userType": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "userId", "incentiveDate", "total_hpFor_margin", "total_hprFor_margin", "total_spFor_margin", "total_sprFor_margin", "totalPending", "companyMargin", "cmt", "margin", "afterslab", "tlName", "tmName", "userType" ], "example": "id" }, "uniqueItems": true } ], "title": "BrokerVlOtrIncentivesTl.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "BrokerVlOtrIncentivesTm.Filter": { "type": "object", "title": "BrokerVlOtrIncentivesTm.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "userId": { "type": "boolean" }, "incentiveDate": { "type": "boolean" }, "total_hpFor_margin": { "type": "boolean" }, "total_hprFor_margin": { "type": "boolean" }, "total_spFor_margin": { "type": "boolean" }, "total_sprFor_margin": { "type": "boolean" }, "totalPending": { "type": "boolean" }, "companyMargin": { "type": "boolean" }, "margin": { "type": "boolean" }, "afterslab": { "type": "boolean" }, "total_hpFor_margin_indirect": { "type": "boolean" }, "total_hprFor_margin_indirect": { "type": "boolean" }, "total_spFor_margin_indirect": { "type": "boolean" }, "total_sprFor_margin_indirect": { "type": "boolean" }, "totalPending_indirect": { "type": "boolean" }, "companyMargin_indirect": { "type": "boolean" }, "margin_indirect": { "type": "boolean" }, "afterslab_indirect": { "type": "boolean" }, "white_indirect": { "type": "boolean" }, "tlName": { "type": "boolean" }, "tmName": { "type": "boolean" }, "userType": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "userId", "incentiveDate", "total_hpFor_margin", "total_hprFor_margin", "total_spFor_margin", "total_sprFor_margin", "totalPending", "companyMargin", "margin", "afterslab", "total_hpFor_margin_indirect", "total_hprFor_margin_indirect", "total_spFor_margin_indirect", "total_sprFor_margin_indirect", "totalPending_indirect", "companyMargin_indirect", "margin_indirect", "afterslab_indirect", "white_indirect", "tlName", "tmName", "userType" ], "example": "id" }, "uniqueItems": true } ], "title": "BrokerVlOtrIncentivesTm.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "BrokerVlOtrIncentivesTm.Filter1": { "type": "object", "title": "BrokerVlOtrIncentivesTm.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "BrokerVlOtrIncentivesTm.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "userId": { "type": "boolean" }, "incentiveDate": { "type": "boolean" }, "total_hpFor_margin": { "type": "boolean" }, "total_hprFor_margin": { "type": "boolean" }, "total_spFor_margin": { "type": "boolean" }, "total_sprFor_margin": { "type": "boolean" }, "totalPending": { "type": "boolean" }, "companyMargin": { "type": "boolean" }, "margin": { "type": "boolean" }, "afterslab": { "type": "boolean" }, "total_hpFor_margin_indirect": { "type": "boolean" }, "total_hprFor_margin_indirect": { "type": "boolean" }, "total_spFor_margin_indirect": { "type": "boolean" }, "total_sprFor_margin_indirect": { "type": "boolean" }, "totalPending_indirect": { "type": "boolean" }, "companyMargin_indirect": { "type": "boolean" }, "margin_indirect": { "type": "boolean" }, "afterslab_indirect": { "type": "boolean" }, "white_indirect": { "type": "boolean" }, "tlName": { "type": "boolean" }, "tmName": { "type": "boolean" }, "userType": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "userId", "incentiveDate", "total_hpFor_margin", "total_hprFor_margin", "total_spFor_margin", "total_sprFor_margin", "totalPending", "companyMargin", "margin", "afterslab", "total_hpFor_margin_indirect", "total_hprFor_margin_indirect", "total_spFor_margin_indirect", "total_sprFor_margin_indirect", "totalPending_indirect", "companyMargin_indirect", "margin_indirect", "afterslab_indirect", "white_indirect", "tlName", "tmName", "userType" ], "example": "id" }, "uniqueItems": true } ], "title": "BrokerVlOtrIncentivesTm.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "BrokerVlOtrLockedIncentives.Filter": { "type": "object", "title": "BrokerVlOtrLockedIncentives.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "userId": { "type": "boolean" }, "incentiveDate": { "type": "boolean" }, "employeeId": { "type": "boolean" }, "total_hpFor_margin": { "type": "boolean" }, "total_hprFor_margin": { "type": "boolean" }, "total_spFor_margin": { "type": "boolean" }, "total_sprFor_margin": { "type": "boolean" }, "realName": { "type": "boolean" }, "name": { "type": "boolean" }, "tlName": { "type": "boolean" }, "tmName": { "type": "boolean" }, "managerId": { "type": "boolean" }, "teamId": { "type": "boolean" }, "totalPending": { "type": "boolean" }, "companyMargin": { "type": "boolean" }, "brokerMargin": { "type": "boolean" }, "incentive": { "type": "boolean" }, "redFlags": { "type": "boolean" }, "cmt": { "type": "boolean" }, "negativeInr": { "type": "boolean" }, "inr": { "type": "boolean" }, "npinr": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "userId", "incentiveDate", "employeeId", "total_hpFor_margin", "total_hprFor_margin", "total_spFor_margin", "total_sprFor_margin", "realName", "name", "tlName", "tmName", "managerId", "teamId", "totalPending", "companyMargin", "brokerMargin", "incentive", "redFlags", "cmt", "negativeInr", "inr", "npinr" ], "example": "id" }, "uniqueItems": true } ], "title": "BrokerVlOtrLockedIncentives.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "BrokerVlOtrLockedIncentives.Filter1": { "type": "object", "title": "BrokerVlOtrLockedIncentives.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "BrokerVlOtrLockedIncentives.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "userId": { "type": "boolean" }, "incentiveDate": { "type": "boolean" }, "employeeId": { "type": "boolean" }, "total_hpFor_margin": { "type": "boolean" }, "total_hprFor_margin": { "type": "boolean" }, "total_spFor_margin": { "type": "boolean" }, "total_sprFor_margin": { "type": "boolean" }, "realName": { "type": "boolean" }, "name": { "type": "boolean" }, "tlName": { "type": "boolean" }, "tmName": { "type": "boolean" }, "managerId": { "type": "boolean" }, "teamId": { "type": "boolean" }, "totalPending": { "type": "boolean" }, "companyMargin": { "type": "boolean" }, "brokerMargin": { "type": "boolean" }, "incentive": { "type": "boolean" }, "redFlags": { "type": "boolean" }, "cmt": { "type": "boolean" }, "negativeInr": { "type": "boolean" }, "inr": { "type": "boolean" }, "npinr": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "userId", "incentiveDate", "employeeId", "total_hpFor_margin", "total_hprFor_margin", "total_spFor_margin", "total_sprFor_margin", "realName", "name", "tlName", "tmName", "managerId", "teamId", "totalPending", "companyMargin", "brokerMargin", "incentive", "redFlags", "cmt", "negativeInr", "inr", "npinr" ], "example": "id" }, "uniqueItems": true } ], "title": "BrokerVlOtrLockedIncentives.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "CarrierAging.ScopeFilter": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": {}, "additionalProperties": true }, { "type": "array", "items": { "type": "string" }, "uniqueItems": true } ] }, "include": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true } } }, "additionalProperties": false, "title": "CarrierAging.ScopeFilter" }, "CarrierAging.IncludeFilter.Items": { "title": "CarrierAging.IncludeFilter.Items", "type": "object", "properties": { "relation": { "type": "string", "enum": [ "carriers", "user", "portal", "shipment" ] }, "scope": { "$ref": "#/components/schemas/CarrierAging.ScopeFilter" } } }, "CarrierAging.Filter": { "type": "object", "title": "CarrierAging.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "ap_agent_id": { "type": "boolean" }, "age_date": { "type": "boolean" }, "invoice_number": { "type": "boolean" }, "invoice_date": { "type": "boolean" }, "advance_payment_date": { "type": "boolean" }, "advance_pay_usd": { "type": "boolean" }, "advance_pay_cad": { "type": "boolean" }, "advance_pay_type": { "type": "boolean" }, "advance_pay_status": { "type": "boolean" }, "payable_amount_usd": { "type": "boolean" }, "payable_amount_cad": { "type": "boolean" }, "quick_book_invoice_status": { "type": "boolean" }, "quick_book_invoice_date": { "type": "boolean" }, "request_status": { "type": "boolean" }, "advance_pay_label": { "type": "boolean" }, "message": { "type": "boolean" }, "quick_pay": { "type": "boolean" }, "carriersId": { "type": "boolean" }, "userId": { "type": "boolean" }, "portalId": { "type": "boolean" }, "shipmentId": { "type": "boolean" }, "auditCreatedAt": { "type": "boolean" }, "auditComment": { "type": "boolean" }, "auditStatus": { "type": "boolean" }, "createdAt": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "ap_agent_id", "age_date", "invoice_number", "invoice_date", "advance_payment_date", "advance_pay_usd", "advance_pay_cad", "advance_pay_type", "advance_pay_status", "payable_amount_usd", "payable_amount_cad", "quick_book_invoice_status", "quick_book_invoice_date", "request_status", "advance_pay_label", "message", "quick_pay", "carriersId", "userId", "portalId", "shipmentId", "auditCreatedAt", "auditComment", "auditStatus", "createdAt" ], "example": "id" }, "uniqueItems": true } ], "title": "CarrierAging.Fields" }, "include": { "title": "CarrierAging.IncludeFilter", "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/CarrierAging.IncludeFilter.Items" }, { "type": "string" } ] } } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "CarrierAging.Filter1": { "type": "object", "title": "CarrierAging.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "CarrierAging.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "ap_agent_id": { "type": "boolean" }, "age_date": { "type": "boolean" }, "invoice_number": { "type": "boolean" }, "invoice_date": { "type": "boolean" }, "advance_payment_date": { "type": "boolean" }, "advance_pay_usd": { "type": "boolean" }, "advance_pay_cad": { "type": "boolean" }, "advance_pay_type": { "type": "boolean" }, "advance_pay_status": { "type": "boolean" }, "payable_amount_usd": { "type": "boolean" }, "payable_amount_cad": { "type": "boolean" }, "quick_book_invoice_status": { "type": "boolean" }, "quick_book_invoice_date": { "type": "boolean" }, "request_status": { "type": "boolean" }, "advance_pay_label": { "type": "boolean" }, "message": { "type": "boolean" }, "quick_pay": { "type": "boolean" }, "carriersId": { "type": "boolean" }, "userId": { "type": "boolean" }, "portalId": { "type": "boolean" }, "shipmentId": { "type": "boolean" }, "auditCreatedAt": { "type": "boolean" }, "auditComment": { "type": "boolean" }, "auditStatus": { "type": "boolean" }, "createdAt": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "ap_agent_id", "age_date", "invoice_number", "invoice_date", "advance_payment_date", "advance_pay_usd", "advance_pay_cad", "advance_pay_type", "advance_pay_status", "payable_amount_usd", "payable_amount_cad", "quick_book_invoice_status", "quick_book_invoice_date", "request_status", "advance_pay_label", "message", "quick_pay", "carriersId", "userId", "portalId", "shipmentId", "auditCreatedAt", "auditComment", "auditStatus", "createdAt" ], "example": "id" }, "uniqueItems": true } ], "title": "CarrierAging.Fields" }, "include": { "title": "CarrierAging.IncludeFilter", "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/CarrierAging.IncludeFilter.Items" }, { "type": "string" } ] } } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "CarrierLogin.ScopeFilter": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": {}, "additionalProperties": true }, { "type": "array", "items": { "type": "string" }, "uniqueItems": true } ] }, "include": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true } } }, "additionalProperties": false, "title": "CarrierLogin.ScopeFilter" }, "CarrierLogin.IncludeFilter.Items": { "title": "CarrierLogin.IncludeFilter.Items", "type": "object", "properties": { "relation": { "type": "string", "enum": [ "portal", "carrier", "carrierCdlData" ] }, "scope": { "$ref": "#/components/schemas/CarrierLogin.ScopeFilter" } } }, "CarrierLogin.Filter": { "type": "object", "title": "CarrierLogin.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "name": { "type": "boolean" }, "email": { "type": "boolean" }, "phone": { "type": "boolean" }, "profile_image": { "type": "boolean" }, "cdl_doc": { "type": "boolean" }, "company_logo": { "type": "boolean" }, "otp": { "type": "boolean" }, "role": { "type": "boolean" }, "switchRole": { "type": "boolean" }, "password": { "type": "boolean" }, "realPassword": { "type": "boolean" }, "inviteCode": { "type": "boolean" }, "deviceToken": { "type": "boolean" }, "deviceTokenIos": { "type": "boolean" }, "twoFactor": { "type": "boolean" }, "status": { "type": "boolean" }, "portalId": { "type": "boolean" }, "carrier_id": { "type": "boolean" }, "created_at": { "type": "boolean" }, "updatedAt": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "name", "email", "phone", "profile_image", "cdl_doc", "company_logo", "otp", "role", "switchRole", "password", "realPassword", "inviteCode", "deviceToken", "deviceTokenIos", "twoFactor", "status", "portalId", "carrier_id", "created_at", "updatedAt" ], "example": "id" }, "uniqueItems": true } ], "title": "CarrierLogin.Fields" }, "include": { "title": "CarrierLogin.IncludeFilter", "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/CarrierLogin.IncludeFilter.Items" }, { "type": "string" } ] } } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "CarrierLogin.Filter1": { "type": "object", "title": "CarrierLogin.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "CarrierLogin.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "name": { "type": "boolean" }, "email": { "type": "boolean" }, "phone": { "type": "boolean" }, "profile_image": { "type": "boolean" }, "cdl_doc": { "type": "boolean" }, "company_logo": { "type": "boolean" }, "otp": { "type": "boolean" }, "role": { "type": "boolean" }, "switchRole": { "type": "boolean" }, "password": { "type": "boolean" }, "realPassword": { "type": "boolean" }, "inviteCode": { "type": "boolean" }, "deviceToken": { "type": "boolean" }, "deviceTokenIos": { "type": "boolean" }, "twoFactor": { "type": "boolean" }, "status": { "type": "boolean" }, "portalId": { "type": "boolean" }, "carrier_id": { "type": "boolean" }, "created_at": { "type": "boolean" }, "updatedAt": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "name", "email", "phone", "profile_image", "cdl_doc", "company_logo", "otp", "role", "switchRole", "password", "realPassword", "inviteCode", "deviceToken", "deviceTokenIos", "twoFactor", "status", "portalId", "carrier_id", "created_at", "updatedAt" ], "example": "id" }, "uniqueItems": true } ], "title": "CarrierLogin.Fields" }, "include": { "title": "CarrierLogin.IncludeFilter", "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/CarrierLogin.IncludeFilter.Items" }, { "type": "string" } ] } } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "CarrierPaymentDone.ScopeFilter": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": {}, "additionalProperties": true }, { "type": "array", "items": { "type": "string" }, "uniqueItems": true } ] }, "include": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true } } }, "additionalProperties": false, "title": "CarrierPaymentDone.ScopeFilter" }, "CarrierPaymentDone.IncludeFilter.Items": { "title": "CarrierPaymentDone.IncludeFilter.Items", "type": "object", "properties": { "relation": { "type": "string", "enum": [ "shipment", "carriers", "user" ] }, "scope": { "$ref": "#/components/schemas/CarrierPaymentDone.ScopeFilter" } } }, "CarrierPaymentDone.Filter": { "type": "object", "title": "CarrierPaymentDone.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "carrier_id": { "type": "boolean" }, "shipmentNo": { "type": "boolean" }, "carrier_name": { "type": "boolean" }, "portal_id": { "type": "boolean" }, "age_date": { "type": "boolean" }, "invoice_number": { "type": "boolean" }, "invoice_date": { "type": "boolean" }, "advance_payment_date": { "type": "boolean" }, "advance_pay_usd": { "type": "boolean" }, "advance_pay_cad": { "type": "boolean" }, "advance_pay_type": { "type": "boolean" }, "payable_amount_usd": { "type": "boolean" }, "payable_amount_cad": { "type": "boolean" }, "quick_book_invoice_status": { "type": "boolean" }, "quick_book_invoice_date": { "type": "boolean" }, "status": { "type": "boolean" }, "agent_name": { "type": "boolean" }, "quick_pay": { "type": "boolean" }, "createdAt": { "type": "boolean" }, "updatedAt": { "type": "boolean" }, "shipmentId": { "type": "boolean" }, "carriersId": { "type": "boolean" }, "userId": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "carrier_id", "shipmentNo", "carrier_name", "portal_id", "age_date", "invoice_number", "invoice_date", "advance_payment_date", "advance_pay_usd", "advance_pay_cad", "advance_pay_type", "payable_amount_usd", "payable_amount_cad", "quick_book_invoice_status", "quick_book_invoice_date", "status", "agent_name", "quick_pay", "createdAt", "updatedAt", "shipmentId", "carriersId", "userId" ], "example": "id" }, "uniqueItems": true } ], "title": "CarrierPaymentDone.Fields" }, "include": { "title": "CarrierPaymentDone.IncludeFilter", "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/CarrierPaymentDone.IncludeFilter.Items" }, { "type": "string" } ] } } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "CarrierRateConReport.ScopeFilter": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": {}, "additionalProperties": true }, { "type": "array", "items": { "type": "string" }, "uniqueItems": true } ] }, "include": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true } } }, "additionalProperties": false, "title": "CarrierRateConReport.ScopeFilter" }, "CarrierRateConReport.IncludeFilter.Items": { "title": "CarrierRateConReport.IncludeFilter.Items", "type": "object", "properties": { "relation": { "type": "string", "enum": [ "user", "shipment" ] }, "scope": { "$ref": "#/components/schemas/CarrierRateConReport.ScopeFilter" } } }, "CarrierRateConReport.Filter": { "type": "object", "title": "CarrierRateConReport.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "uid": { "type": "boolean" }, "toEmail": { "type": "boolean" }, "signeDocumentID": { "type": "boolean" }, "emailViewed": { "type": "boolean" }, "docViewed": { "type": "boolean" }, "signedOn": { "type": "boolean" }, "documentSigned": { "type": "boolean" }, "emailStatus": { "type": "boolean" }, "cprStatus": { "type": "boolean" }, "sendForStatus": { "type": "boolean" }, "portalId": { "type": "boolean" }, "carrierCommunicationPortalid": { "type": "boolean" }, "sendDate": { "type": "boolean" }, "signedDoc": { "type": "boolean" }, "userId": { "type": "boolean" }, "shipmentId": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "uid", "toEmail", "signeDocumentID", "emailViewed", "docViewed", "signedOn", "documentSigned", "emailStatus", "cprStatus", "sendForStatus", "portalId", "carrierCommunicationPortalid", "sendDate", "signedDoc", "userId", "shipmentId" ], "example": "id" }, "uniqueItems": true } ], "title": "CarrierRateConReport.Fields" }, "include": { "title": "CarrierRateConReport.IncludeFilter", "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/CarrierRateConReport.IncludeFilter.Items" }, { "type": "string" } ] } } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "Cities.ScopeFilter": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": {}, "additionalProperties": true }, { "type": "array", "items": { "type": "string" }, "uniqueItems": true } ] }, "include": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true } } }, "additionalProperties": false, "title": "Cities.ScopeFilter" }, "Cities.IncludeFilter.Items": { "title": "Cities.IncludeFilter.Items", "type": "object", "properties": { "relation": { "type": "string", "enum": [ "states", "countries" ] }, "scope": { "$ref": "#/components/schemas/Cities.ScopeFilter" } } }, "Cities.Filter": { "type": "object", "title": "Cities.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "name": { "type": "boolean" }, "state_code": { "type": "boolean" }, "country_code": { "type": "boolean" }, "latitude": { "type": "boolean" }, "longitude": { "type": "boolean" }, "updated_at": { "type": "boolean" }, "created_at": { "type": "boolean" }, "flag": { "type": "boolean" }, "wikiDataId": { "type": "boolean" }, "statesId": { "type": "boolean" }, "countriesId": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "name", "state_code", "country_code", "latitude", "longitude", "updated_at", "created_at", "flag", "wikiDataId", "statesId", "countriesId" ], "example": "id" }, "uniqueItems": true } ], "title": "Cities.Fields" }, "include": { "title": "Cities.IncludeFilter", "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/Cities.IncludeFilter.Items" }, { "type": "string" } ] } } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "Cities.Filter1": { "type": "object", "title": "Cities.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "Cities.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "name": { "type": "boolean" }, "state_code": { "type": "boolean" }, "country_code": { "type": "boolean" }, "latitude": { "type": "boolean" }, "longitude": { "type": "boolean" }, "updated_at": { "type": "boolean" }, "created_at": { "type": "boolean" }, "flag": { "type": "boolean" }, "wikiDataId": { "type": "boolean" }, "statesId": { "type": "boolean" }, "countriesId": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "name", "state_code", "country_code", "latitude", "longitude", "updated_at", "created_at", "flag", "wikiDataId", "statesId", "countriesId" ], "example": "id" }, "uniqueItems": true } ], "title": "Cities.Fields" }, "include": { "title": "Cities.IncludeFilter", "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/Cities.IncludeFilter.Items" }, { "type": "string" } ] } } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "Cmt.Filter": { "type": "object", "title": "Cmt.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "shipmentId": { "type": "boolean" }, "from": { "type": "boolean" }, "to": { "type": "boolean" }, "shipper": { "type": "boolean" }, "carrier": { "type": "boolean" }, "margin": { "type": "boolean" }, "cmt": { "type": "boolean" }, "percentage": { "type": "boolean" }, "comment": { "type": "boolean" }, "cmtFor": { "type": "boolean" }, "created": { "type": "boolean" }, "updated": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "shipmentId", "from", "to", "shipper", "carrier", "margin", "cmt", "percentage", "comment", "cmtFor", "created", "updated" ], "example": "id" }, "uniqueItems": true } ], "title": "Cmt.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "Cmt.Filter1": { "type": "object", "title": "Cmt.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "Cmt.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "shipmentId": { "type": "boolean" }, "from": { "type": "boolean" }, "to": { "type": "boolean" }, "shipper": { "type": "boolean" }, "carrier": { "type": "boolean" }, "margin": { "type": "boolean" }, "cmt": { "type": "boolean" }, "percentage": { "type": "boolean" }, "comment": { "type": "boolean" }, "cmtFor": { "type": "boolean" }, "created": { "type": "boolean" }, "updated": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "shipmentId", "from", "to", "shipper", "carrier", "margin", "cmt", "percentage", "comment", "cmtFor", "created", "updated" ], "example": "id" }, "uniqueItems": true } ], "title": "Cmt.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "Commodities.ScopeFilter": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": {}, "additionalProperties": true }, { "type": "array", "items": { "type": "string" }, "uniqueItems": true } ] }, "include": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true } } }, "additionalProperties": false, "title": "Commodities.ScopeFilter" }, "Commodities.IncludeFilter.Items": { "title": "Commodities.IncludeFilter.Items", "type": "object", "properties": { "relation": { "type": "string", "enum": [ "Broker" ] }, "scope": { "$ref": "#/components/schemas/Commodities.ScopeFilter" } } }, "Commodities.Filter": { "type": "object", "title": "Commodities.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "name": { "type": "boolean" }, "status": { "type": "boolean" }, "EstimatedValue": { "type": "boolean" }, "created": { "type": "boolean" }, "user_id": { "type": "boolean" }, "modified": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "name", "status", "EstimatedValue", "created", "user_id", "modified" ], "example": "id" }, "uniqueItems": true } ], "title": "Commodities.Fields" }, "include": { "title": "Commodities.IncludeFilter", "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/Commodities.IncludeFilter.Items" }, { "type": "string" } ] } } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "Commodities.Filter1": { "type": "object", "title": "Commodities.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "Commodities.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "name": { "type": "boolean" }, "status": { "type": "boolean" }, "EstimatedValue": { "type": "boolean" }, "created": { "type": "boolean" }, "user_id": { "type": "boolean" }, "modified": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "name", "status", "EstimatedValue", "created", "user_id", "modified" ], "example": "id" }, "uniqueItems": true } ], "title": "Commodities.Fields" }, "include": { "title": "Commodities.IncludeFilter", "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/Commodities.IncludeFilter.Items" }, { "type": "string" } ] } } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "CompaniesInsurance.Filter": { "type": "object", "title": "CompaniesInsurance.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "name": { "type": "boolean" }, "status": { "type": "boolean" }, "portalId": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "name", "status", "portalId" ], "example": "id" }, "uniqueItems": true } ], "title": "CompaniesInsurance.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "CompaniesInsurance.Filter1": { "type": "object", "title": "CompaniesInsurance.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "CompaniesInsurance.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "name": { "type": "boolean" }, "status": { "type": "boolean" }, "portalId": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "name", "status", "portalId" ], "example": "id" }, "uniqueItems": true } ], "title": "CompaniesInsurance.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "States.ScopeFilter": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": {}, "additionalProperties": true }, { "type": "array", "items": { "type": "string" }, "uniqueItems": true } ] }, "include": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true } } }, "additionalProperties": false, "title": "States.ScopeFilter" }, "States.IncludeFilter.Items": { "title": "States.IncludeFilter.Items", "type": "object", "properties": { "relation": { "type": "string", "enum": [ "cities" ] }, "scope": { "$ref": "#/components/schemas/States.ScopeFilter" } } }, "States.Filter": { "type": "object", "title": "States.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "States.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "name": { "type": "boolean" }, "country_code": { "type": "boolean" }, "fips_code": { "type": "boolean" }, "iso2": { "type": "boolean" }, "latitude": { "type": "boolean" }, "longitude": { "type": "boolean" }, "created_at": { "type": "boolean" }, "updated_at": { "type": "boolean" }, "flag": { "type": "boolean" }, "wikiDataId": { "type": "boolean" }, "countriesId": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "name", "country_code", "fips_code", "iso2", "latitude", "longitude", "created_at", "updated_at", "flag", "wikiDataId", "countriesId" ], "example": "id" }, "uniqueItems": true } ], "title": "States.Fields" }, "include": { "title": "States.IncludeFilter", "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/States.IncludeFilter.Items" }, { "type": "string" } ] } } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "Countries.ScopeFilter": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": {}, "additionalProperties": true }, { "type": "array", "items": { "type": "string" }, "uniqueItems": true } ] }, "include": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true } } }, "additionalProperties": false, "title": "Countries.ScopeFilter" }, "Countries.IncludeFilter.Items": { "title": "Countries.IncludeFilter.Items", "type": "object", "properties": { "relation": { "type": "string", "enum": [ "states" ] }, "scope": { "$ref": "#/components/schemas/Countries.ScopeFilter" } } }, "Countries.Filter": { "type": "object", "title": "Countries.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "name": { "type": "boolean" }, "iso3": { "type": "boolean" }, "numeric_code": { "type": "boolean" }, "iso2": { "type": "boolean" }, "phonecode": { "type": "boolean" }, "capital": { "type": "boolean" }, "currency": { "type": "boolean" }, "currency_name": { "type": "boolean" }, "currency_symbol": { "type": "boolean" }, "tld": { "type": "boolean" }, "native": { "type": "boolean" }, "region": { "type": "boolean" }, "subregion": { "type": "boolean" }, "nationality": { "type": "boolean" }, "timezones": { "type": "boolean" }, "translations": { "type": "boolean" }, "latitude": { "type": "boolean" }, "longitude": { "type": "boolean" }, "emojiU": { "type": "boolean" }, "created_at": { "type": "boolean" }, "updated_at": { "type": "boolean" }, "flag": { "type": "boolean" }, "wikiDataId": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "name", "iso3", "numeric_code", "iso2", "phonecode", "capital", "currency", "currency_name", "currency_symbol", "tld", "native", "region", "subregion", "nationality", "timezones", "translations", "latitude", "longitude", "emojiU", "created_at", "updated_at", "flag", "wikiDataId" ], "example": "id" }, "uniqueItems": true } ], "title": "Countries.Fields" }, "include": { "title": "Countries.IncludeFilter", "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/Countries.IncludeFilter.Items" }, { "type": "string" } ] } } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "Countries.Filter1": { "type": "object", "title": "Countries.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "Countries.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "name": { "type": "boolean" }, "iso3": { "type": "boolean" }, "numeric_code": { "type": "boolean" }, "iso2": { "type": "boolean" }, "phonecode": { "type": "boolean" }, "capital": { "type": "boolean" }, "currency": { "type": "boolean" }, "currency_name": { "type": "boolean" }, "currency_symbol": { "type": "boolean" }, "tld": { "type": "boolean" }, "native": { "type": "boolean" }, "region": { "type": "boolean" }, "subregion": { "type": "boolean" }, "nationality": { "type": "boolean" }, "timezones": { "type": "boolean" }, "translations": { "type": "boolean" }, "latitude": { "type": "boolean" }, "longitude": { "type": "boolean" }, "emojiU": { "type": "boolean" }, "created_at": { "type": "boolean" }, "updated_at": { "type": "boolean" }, "flag": { "type": "boolean" }, "wikiDataId": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "name", "iso3", "numeric_code", "iso2", "phonecode", "capital", "currency", "currency_name", "currency_symbol", "tld", "native", "region", "subregion", "nationality", "timezones", "translations", "latitude", "longitude", "emojiU", "created_at", "updated_at", "flag", "wikiDataId" ], "example": "id" }, "uniqueItems": true } ], "title": "Countries.Fields" }, "include": { "title": "Countries.IncludeFilter", "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/Countries.IncludeFilter.Items" }, { "type": "string" } ] } } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "DatKeys.Filter": { "type": "object", "title": "DatKeys.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "DatKeys.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "portalId": { "type": "boolean" }, "primary_token": { "type": "boolean" }, "secondary_token": { "type": "boolean" }, "expiration": { "type": "boolean" }, "status": { "type": "boolean" }, "token_type": { "type": "boolean" }, "dat_header": { "type": "boolean" }, "sub_user": { "type": "boolean" }, "managerId": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "portalId", "primary_token", "secondary_token", "expiration", "status", "token_type", "dat_header", "sub_user", "managerId" ], "example": "id" }, "uniqueItems": true } ], "title": "DatKeys.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "Datonboardcarrier.Filter": { "type": "object", "title": "Datonboardcarrier.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "Datonboardcarrier.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "carrierId": { "type": "boolean" }, "carrierMC": { "type": "boolean" }, "carrierDOT": { "type": "boolean" }, "dateVisited": { "type": "boolean" }, "dateVisited_old": { "type": "boolean" }, "company": { "type": "boolean" }, "physicalAddress": { "type": "boolean" }, "mailingAddress": { "type": "boolean" }, "portalId": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "carrierId", "carrierMC", "carrierDOT", "dateVisited", "dateVisited_old", "company", "physicalAddress", "mailingAddress", "portalId" ], "example": "id" }, "uniqueItems": true } ], "title": "Datonboardcarrier.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "Equipment.Filter": { "type": "object", "title": "Equipment.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "name": { "type": "boolean" }, "id": { "type": "boolean" }, "equip_type": { "type": "boolean" }, "spot_equip": { "type": "boolean" }, "pst_evrywre": { "type": "boolean" }, "ts_equip": { "type": "boolean" }, "cat_ts": { "type": "boolean" }, "ts_id": { "type": "boolean" }, "dat_id": { "type": "boolean" }, "status": { "type": "boolean" }, "created_at": { "type": "boolean" }, "updated_at": { "type": "boolean" }, "deleted_at": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "name", "id", "equip_type", "spot_equip", "pst_evrywre", "ts_equip", "cat_ts", "ts_id", "dat_id", "status", "created_at", "updated_at", "deleted_at" ], "example": "name" }, "uniqueItems": true } ], "title": "Equipment.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "Equipment.Filter1": { "type": "object", "title": "Equipment.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "Equipment.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "name": { "type": "boolean" }, "id": { "type": "boolean" }, "equip_type": { "type": "boolean" }, "spot_equip": { "type": "boolean" }, "pst_evrywre": { "type": "boolean" }, "ts_equip": { "type": "boolean" }, "cat_ts": { "type": "boolean" }, "ts_id": { "type": "boolean" }, "dat_id": { "type": "boolean" }, "status": { "type": "boolean" }, "created_at": { "type": "boolean" }, "updated_at": { "type": "boolean" }, "deleted_at": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "name", "id", "equip_type", "spot_equip", "pst_evrywre", "ts_equip", "cat_ts", "ts_id", "dat_id", "status", "created_at", "updated_at", "deleted_at" ], "example": "name" }, "uniqueItems": true } ], "title": "Equipment.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "FactoringDetails.ScopeFilter": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": {}, "additionalProperties": true }, { "type": "array", "items": { "type": "string" }, "uniqueItems": true } ] }, "include": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true } } }, "additionalProperties": false, "title": "FactoringDetails.ScopeFilter" }, "FactoringDetails.IncludeFilter.Items": { "title": "FactoringDetails.IncludeFilter.Items", "type": "object", "properties": { "relation": { "type": "string", "enum": [ "portal", "zipCodes", "user" ] }, "scope": { "$ref": "#/components/schemas/FactoringDetails.ScopeFilter" } } }, "FactoringDetails.Filter": { "type": "object", "title": "FactoringDetails.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "factoring_w9_form": { "type": "boolean" }, "factoring_signature_card": { "type": "boolean" }, "factoring_company_name": { "type": "boolean" }, "factoring_address": { "type": "boolean" }, "factoring_phone": { "type": "boolean" }, "factoring_fax": { "type": "boolean" }, "factoring_email": { "type": "boolean" }, "factoring_concern_person": { "type": "boolean" }, "pay_by_ach": { "type": "boolean" }, "ach_bank_name": { "type": "boolean" }, "ach_account_number": { "type": "boolean" }, "ach_account_type": { "type": "boolean" }, "ach_routing_number": { "type": "boolean" }, "ach_bank_type": { "type": "boolean" }, "portalId": { "type": "boolean" }, "pay_by_wire": { "type": "boolean" }, "wire_bank_name": { "type": "boolean" }, "wire_account_number": { "type": "boolean" }, "wire_account_type": { "type": "boolean" }, "wire_rating_number": { "type": "boolean" }, "wire_swift_code": { "type": "boolean" }, "wire_bank_type": { "type": "boolean" }, "pay_by_credit_card": { "type": "boolean" }, "credit_card_comment": { "type": "boolean" }, "primery_method": { "type": "boolean" }, "qb_id": { "type": "boolean" }, "qb_status": { "type": "boolean" }, "created_at": { "type": "boolean" }, "modified": { "type": "boolean" }, "zipCodesId": { "type": "boolean" }, "userId": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "factoring_w9_form", "factoring_signature_card", "factoring_company_name", "factoring_address", "factoring_phone", "factoring_fax", "factoring_email", "factoring_concern_person", "pay_by_ach", "ach_bank_name", "ach_account_number", "ach_account_type", "ach_routing_number", "ach_bank_type", "portalId", "pay_by_wire", "wire_bank_name", "wire_account_number", "wire_account_type", "wire_rating_number", "wire_swift_code", "wire_bank_type", "pay_by_credit_card", "credit_card_comment", "primery_method", "qb_id", "qb_status", "created_at", "modified", "zipCodesId", "userId" ], "example": "id" }, "uniqueItems": true } ], "title": "FactoringDetails.Fields" }, "include": { "title": "FactoringDetails.IncludeFilter", "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/FactoringDetails.IncludeFilter.Items" }, { "type": "string" } ] } } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "UserGroup.Filter": { "type": "object", "title": "UserGroup.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "UserGroup.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "group_name": { "type": "boolean" }, "description": { "type": "boolean" }, "status": { "type": "boolean" }, "file_url": { "type": "boolean" }, "userId": { "type": "boolean" }, "created": { "type": "boolean" }, "updated": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "group_name", "description", "status", "file_url", "userId", "created", "updated" ], "example": "id" }, "uniqueItems": true } ], "title": "UserGroup.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "GoodToGoHistory.Filter": { "type": "object", "title": "GoodToGoHistory.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "good_to_go_history_id": { "type": "boolean" }, "user_id": { "type": "boolean" }, "by_name": { "type": "boolean" }, "shipment_id": { "type": "boolean" }, "carriers_id": { "type": "boolean" }, "companies_id": { "type": "boolean" }, "comment": { "type": "boolean" }, "team": { "type": "boolean" }, "date_time": { "type": "boolean" }, "ap_hold_status": { "type": "boolean" }, "created_at": { "type": "boolean" }, "updated_at": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "good_to_go_history_id", "user_id", "by_name", "shipment_id", "carriers_id", "companies_id", "comment", "team", "date_time", "ap_hold_status", "created_at", "updated_at" ], "example": "good_to_go_history_id" }, "uniqueItems": true } ], "title": "GoodToGoHistory.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "GoodToGoHistory.Filter1": { "type": "object", "title": "GoodToGoHistory.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "GoodToGoHistory.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "good_to_go_history_id": { "type": "boolean" }, "user_id": { "type": "boolean" }, "by_name": { "type": "boolean" }, "shipment_id": { "type": "boolean" }, "carriers_id": { "type": "boolean" }, "companies_id": { "type": "boolean" }, "comment": { "type": "boolean" }, "team": { "type": "boolean" }, "date_time": { "type": "boolean" }, "ap_hold_status": { "type": "boolean" }, "created_at": { "type": "boolean" }, "updated_at": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "good_to_go_history_id", "user_id", "by_name", "shipment_id", "carriers_id", "companies_id", "comment", "team", "date_time", "ap_hold_status", "created_at", "updated_at" ], "example": "good_to_go_history_id" }, "uniqueItems": true } ], "title": "GoodToGoHistory.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "insurance_documents.ScopeFilter": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": {}, "additionalProperties": true }, { "type": "array", "items": { "type": "string" }, "uniqueItems": true } ] }, "include": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true } } }, "additionalProperties": false, "title": "insurance_documents.ScopeFilter" }, "insurance_documents.IncludeFilter.Items": { "title": "insurance_documents.IncludeFilter.Items", "type": "object", "properties": { "relation": { "type": "string", "enum": [ "userDetails" ] }, "scope": { "$ref": "#/components/schemas/insurance_documents.ScopeFilter" } } }, "insurance_documents.Filter": { "type": "object", "title": "insurance_documents.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "insurance_documents.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "document_id": { "type": "boolean" }, "document_name": { "type": "boolean" }, "document_url": { "type": "boolean" }, "document_type": { "type": "boolean" }, "expiry_date": { "type": "boolean" }, "amount": { "type": "boolean" }, "doc_status": { "type": "boolean" }, "created_at": { "type": "boolean" }, "updated_at": { "type": "boolean" }, "uploaded_id": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "document_id", "document_name", "document_url", "document_type", "expiry_date", "amount", "doc_status", "created_at", "updated_at", "uploaded_id" ], "example": "document_id" }, "uniqueItems": true } ], "title": "insurance_documents.Fields" }, "include": { "title": "insurance_documents.IncludeFilter", "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/insurance_documents.IncludeFilter.Items" }, { "type": "string" } ] } } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "McExceptionWeekendEmail.ScopeFilter": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": {}, "additionalProperties": true }, { "type": "array", "items": { "type": "string" }, "uniqueItems": true } ] }, "include": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true } } }, "additionalProperties": false, "title": "McExceptionWeekendEmail.ScopeFilter" }, "McExceptionWeekendEmail.IncludeFilter.Items": { "title": "McExceptionWeekendEmail.IncludeFilter.Items", "type": "object", "properties": { "relation": { "type": "string", "enum": [ "portal" ] }, "scope": { "$ref": "#/components/schemas/McExceptionWeekendEmail.ScopeFilter" } } }, "McExceptionWeekendEmail.Filter": { "type": "object", "title": "McExceptionWeekendEmail.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "manager_email": { "type": "boolean" }, "manager_id": { "type": "boolean" }, "start_date": { "type": "boolean" }, "end_date": { "type": "boolean" }, "status": { "type": "boolean" }, "drayage": { "type": "boolean" }, "created_at": { "type": "boolean" }, "portalId": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "manager_email", "manager_id", "start_date", "end_date", "status", "drayage", "created_at", "portalId" ], "example": "id" }, "uniqueItems": true } ], "title": "McExceptionWeekendEmail.Fields" }, "include": { "title": "McExceptionWeekendEmail.IncludeFilter", "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/McExceptionWeekendEmail.IncludeFilter.Items" }, { "type": "string" } ] } } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "McExceptionWeekendEmail.Filter1": { "type": "object", "title": "McExceptionWeekendEmail.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "McExceptionWeekendEmail.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "manager_email": { "type": "boolean" }, "manager_id": { "type": "boolean" }, "start_date": { "type": "boolean" }, "end_date": { "type": "boolean" }, "status": { "type": "boolean" }, "drayage": { "type": "boolean" }, "created_at": { "type": "boolean" }, "portalId": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "manager_email", "manager_id", "start_date", "end_date", "status", "drayage", "created_at", "portalId" ], "example": "id" }, "uniqueItems": true } ], "title": "McExceptionWeekendEmail.Fields" }, "include": { "title": "McExceptionWeekendEmail.IncludeFilter", "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/McExceptionWeekendEmail.IncludeFilter.Items" }, { "type": "string" } ] } } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "McVerification.ScopeFilter": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": {}, "additionalProperties": true }, { "type": "array", "items": { "type": "string" }, "uniqueItems": true } ] }, "include": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true } } }, "additionalProperties": false, "title": "McVerification.ScopeFilter" }, "McVerification.IncludeFilter.Items": { "title": "McVerification.IncludeFilter.Items", "type": "object", "properties": { "relation": { "type": "string", "enum": [ "checkedBy", "user", "ApprovedBySme" ] }, "scope": { "$ref": "#/components/schemas/McVerification.ScopeFilter" } } }, "McVerification.Filter": { "type": "object", "title": "McVerification.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "McVerification.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "uid": { "type": "boolean" }, "portalId": { "type": "boolean" }, "mcCategory": { "type": "boolean" }, "requestType": { "type": "boolean" }, "exceptionType": { "type": "boolean" }, "smeStatus": { "type": "boolean" }, "mcNumber": { "type": "boolean" }, "dotNumber": { "type": "boolean" }, "nscNumber": { "type": "boolean" }, "mcCarrierSetUp": { "type": "boolean" }, "mcTruckType": { "type": "boolean" }, "mcApproveNotes": { "type": "boolean" }, "approveTime": { "type": "boolean" }, "timeDiffrence": { "type": "boolean" }, "totalIncentive": { "type": "boolean" }, "mcSentTime": { "type": "boolean" }, "VerifiedCarrierName": { "type": "boolean" }, "FmcsaPhoneNumber": { "type": "boolean" }, "CacciPhoneNumber": { "type": "boolean" }, "VerifiedCacciEmail": { "type": "boolean" }, "VerifiedCarrier411Email": { "type": "boolean" }, "VerifiedCarrierCity": { "type": "boolean" }, "VerifiedCarrierState": { "type": "boolean" }, "VerifiedCarrierZip": { "type": "boolean" }, "VerifiedCarrierCountry": { "type": "boolean" }, "VerifiedFullAddress": { "type": "boolean" }, "checkedById": { "type": "boolean" }, "ReverifyCarrierEmail": { "type": "boolean" }, "ReverifyCarrierPhoneNumber": { "type": "boolean" }, "McStatus": { "type": "boolean" }, "TotalInspections": { "type": "boolean" }, "InsuranceStatus": { "type": "boolean" }, "TotalTrucks": { "type": "boolean" }, "VictimIdentityTheft": { "type": "boolean" }, "TotalActiveTime": { "type": "boolean" }, "comment": { "type": "boolean" }, "userId": { "type": "boolean" }, "ApprovedBySmeId": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "uid", "portalId", "mcCategory", "requestType", "exceptionType", "smeStatus", "mcNumber", "dotNumber", "nscNumber", "mcCarrierSetUp", "mcTruckType", "mcApproveNotes", "approveTime", "timeDiffrence", "totalIncentive", "mcSentTime", "VerifiedCarrierName", "FmcsaPhoneNumber", "CacciPhoneNumber", "VerifiedCacciEmail", "VerifiedCarrier411Email", "VerifiedCarrierCity", "VerifiedCarrierState", "VerifiedCarrierZip", "VerifiedCarrierCountry", "VerifiedFullAddress", "checkedById", "ReverifyCarrierEmail", "ReverifyCarrierPhoneNumber", "McStatus", "TotalInspections", "InsuranceStatus", "TotalTrucks", "VictimIdentityTheft", "TotalActiveTime", "comment", "userId", "ApprovedBySmeId" ], "example": "id" }, "uniqueItems": true } ], "title": "McVerification.Fields" }, "include": { "title": "McVerification.IncludeFilter", "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/McVerification.IncludeFilter.Items" }, { "type": "string" } ] } } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "Notifications.Filter": { "type": "object", "title": "Notifications.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "from": { "type": "boolean" }, "to": { "type": "boolean" }, "link": { "type": "boolean" }, "title": { "type": "boolean" }, "message": { "type": "boolean" }, "created": { "type": "boolean" }, "readStatus": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "from", "to", "link", "title", "message", "created", "readStatus" ], "example": "id" }, "uniqueItems": true } ], "title": "Notifications.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "OpenProHistory.ScopeFilter": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": {}, "additionalProperties": true }, { "type": "array", "items": { "type": "string" }, "uniqueItems": true } ] }, "include": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true } } }, "additionalProperties": false, "title": "OpenProHistory.ScopeFilter" }, "OpenProHistory.IncludeFilter.Items": { "title": "OpenProHistory.IncludeFilter.Items", "type": "object", "properties": { "relation": { "type": "string", "enum": [ "user" ] }, "scope": { "$ref": "#/components/schemas/OpenProHistory.ScopeFilter" } } }, "OpenProHistory.Filter": { "type": "object", "title": "OpenProHistory.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "uid": { "type": "boolean" }, "shipmentId": { "type": "boolean" }, "portalId": { "type": "boolean" }, "cprRequestId": { "type": "boolean" }, "change_request_for": { "type": "boolean" }, "sendDate": { "type": "boolean" }, "request_for_reason": { "type": "boolean" }, "approvedByReason": { "type": "boolean" }, "oldShipperPrice": { "type": "boolean" }, "oldCarrierPrice": { "type": "boolean" }, "newShipperPrice": { "type": "boolean" }, "newCarrierPrice": { "type": "boolean" }, "oldCommodityValue": { "type": "boolean" }, "shipmentStatus": { "type": "boolean" }, "newCommodityValue": { "type": "boolean" }, "oldPickDate": { "type": "boolean" }, "newPickDate": { "type": "boolean" }, "oldDropDate": { "type": "boolean" }, "newDropDate": { "type": "boolean" }, "approvedById": { "type": "boolean" }, "status": { "type": "boolean" }, "userId": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "uid", "shipmentId", "portalId", "cprRequestId", "change_request_for", "sendDate", "request_for_reason", "approvedByReason", "oldShipperPrice", "oldCarrierPrice", "newShipperPrice", "newCarrierPrice", "oldCommodityValue", "shipmentStatus", "newCommodityValue", "oldPickDate", "newPickDate", "oldDropDate", "newDropDate", "approvedById", "status", "userId" ], "example": "id" }, "uniqueItems": true } ], "title": "OpenProHistory.Fields" }, "include": { "title": "OpenProHistory.IncludeFilter", "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/OpenProHistory.IncludeFilter.Items" }, { "type": "string" } ] } } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "PaymentMethods.ScopeFilter": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": {}, "additionalProperties": true }, { "type": "array", "items": { "type": "string" }, "uniqueItems": true } ] }, "include": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true } } }, "additionalProperties": false, "title": "PaymentMethods.ScopeFilter" }, "PaymentMethods.IncludeFilter.Items": { "title": "PaymentMethods.IncludeFilter.Items", "type": "object", "properties": { "relation": { "type": "string", "enum": [ "carriers", "factoring" ] }, "scope": { "$ref": "#/components/schemas/PaymentMethods.ScopeFilter" } } }, "PaymentMethods.Filter": { "type": "object", "title": "PaymentMethods.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "pay_by_ach": { "type": "boolean" }, "ach_bank_name": { "type": "boolean" }, "ach_account_number": { "type": "boolean" }, "ach_account_type": { "type": "boolean" }, "ach_routing_number": { "type": "boolean" }, "ach_bank_type": { "type": "boolean" }, "pay_by_wire": { "type": "boolean" }, "wire_bank_name": { "type": "boolean" }, "wire_account_number": { "type": "boolean" }, "wire_account_type": { "type": "boolean" }, "wire_rating_number": { "type": "boolean" }, "wire_swift_code": { "type": "boolean" }, "wire_bank_type": { "type": "boolean" }, "pay_by_credit_card": { "type": "boolean" }, "credit_card_comment": { "type": "boolean" }, "primery_method": { "type": "boolean" }, "carriersId": { "type": "boolean" }, "factoringId": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "pay_by_ach", "ach_bank_name", "ach_account_number", "ach_account_type", "ach_routing_number", "ach_bank_type", "pay_by_wire", "wire_bank_name", "wire_account_number", "wire_account_type", "wire_rating_number", "wire_swift_code", "wire_bank_type", "pay_by_credit_card", "credit_card_comment", "primery_method", "carriersId", "factoringId" ], "example": "id" }, "uniqueItems": true } ], "title": "PaymentMethods.Fields" }, "include": { "title": "PaymentMethods.IncludeFilter", "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/PaymentMethods.IncludeFilter.Items" }, { "type": "string" } ] } } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "PaymentMethods.Filter1": { "type": "object", "title": "PaymentMethods.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "PaymentMethods.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "pay_by_ach": { "type": "boolean" }, "ach_bank_name": { "type": "boolean" }, "ach_account_number": { "type": "boolean" }, "ach_account_type": { "type": "boolean" }, "ach_routing_number": { "type": "boolean" }, "ach_bank_type": { "type": "boolean" }, "pay_by_wire": { "type": "boolean" }, "wire_bank_name": { "type": "boolean" }, "wire_account_number": { "type": "boolean" }, "wire_account_type": { "type": "boolean" }, "wire_rating_number": { "type": "boolean" }, "wire_swift_code": { "type": "boolean" }, "wire_bank_type": { "type": "boolean" }, "pay_by_credit_card": { "type": "boolean" }, "credit_card_comment": { "type": "boolean" }, "primery_method": { "type": "boolean" }, "carriersId": { "type": "boolean" }, "factoringId": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "pay_by_ach", "ach_bank_name", "ach_account_number", "ach_account_type", "ach_routing_number", "ach_bank_type", "pay_by_wire", "wire_bank_name", "wire_account_number", "wire_account_type", "wire_rating_number", "wire_swift_code", "wire_bank_type", "pay_by_credit_card", "credit_card_comment", "primery_method", "carriersId", "factoringId" ], "example": "id" }, "uniqueItems": true } ], "title": "PaymentMethods.Fields" }, "include": { "title": "PaymentMethods.IncludeFilter", "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/PaymentMethods.IncludeFilter.Items" }, { "type": "string" } ] } } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "PingResponse": { "type": "object", "title": "PingResponse", "properties": { "greeting": { "type": "string" }, "date": { "type": "string" }, "url": { "type": "string" }, "headers": { "type": "object", "properties": { "Content-Type": { "type": "string" } }, "additionalProperties": true } } }, "McReVerification.ScopeFilter": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": {}, "additionalProperties": true }, { "type": "array", "items": { "type": "string" }, "uniqueItems": true } ] }, "include": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true } } }, "additionalProperties": false, "title": "McReVerification.ScopeFilter" }, "McReVerification.IncludeFilter.Items": { "title": "McReVerification.IncludeFilter.Items", "type": "object", "properties": { "relation": { "type": "string", "enum": [ "shipment" ] }, "scope": { "$ref": "#/components/schemas/McReVerification.ScopeFilter" } } }, "McReVerification.Filter": { "type": "object", "title": "McReVerification.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "McReVerification.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "portalId": { "type": "boolean" }, "carrierNumber": { "type": "boolean" }, "carrierEmail": { "type": "boolean" }, "mcNumber": { "type": "boolean" }, "dotNumber": { "type": "boolean" }, "nscNumber": { "type": "boolean" }, "smeStatus": { "type": "boolean" }, "smeId": { "type": "boolean" }, "sendDate": { "type": "boolean" }, "approvalDate": { "type": "boolean" }, "verifiedType": { "type": "boolean" }, "shipmentId": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "portalId", "carrierNumber", "carrierEmail", "mcNumber", "dotNumber", "nscNumber", "smeStatus", "smeId", "sendDate", "approvalDate", "verifiedType", "shipmentId" ], "example": "id" }, "uniqueItems": true } ], "title": "McReVerification.Fields" }, "include": { "title": "McReVerification.IncludeFilter", "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/McReVerification.IncludeFilter.Items" }, { "type": "string" } ] } } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "RedFlags.ScopeFilter": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": {}, "additionalProperties": true }, { "type": "array", "items": { "type": "string" }, "uniqueItems": true } ] }, "include": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true } } }, "additionalProperties": false, "title": "RedFlags.ScopeFilter" }, "RedFlags.IncludeFilter.Items": { "title": "RedFlags.IncludeFilter.Items", "type": "object", "properties": { "relation": { "type": "string", "enum": [ "shipment", "user" ] }, "scope": { "$ref": "#/components/schemas/RedFlags.ScopeFilter" } } }, "RedFlags.Filter": { "type": "object", "title": "RedFlags.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "old_c_total": { "type": "boolean" }, "old_s_total": { "type": "boolean" }, "c_total": { "type": "boolean" }, "s_total": { "type": "boolean" }, "old_margin": { "type": "boolean" }, "current_margin": { "type": "boolean" }, "difference": { "type": "boolean" }, "change_date": { "type": "boolean" }, "red_for": { "type": "boolean" }, "pickup_date": { "type": "boolean" }, "msg": { "type": "boolean" }, "apAPId": { "type": "boolean" }, "ArId": { "type": "boolean" }, "created_at": { "type": "boolean" }, "redflag_type": { "type": "boolean" }, "shipmentId": { "type": "boolean" }, "userId": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "old_c_total", "old_s_total", "c_total", "s_total", "old_margin", "current_margin", "difference", "change_date", "red_for", "pickup_date", "msg", "apAPId", "ArId", "created_at", "redflag_type", "shipmentId", "userId" ], "example": "id" }, "uniqueItems": true } ], "title": "RedFlags.Fields" }, "include": { "title": "RedFlags.IncludeFilter", "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/RedFlags.IncludeFilter.Items" }, { "type": "string" } ] } } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "RedFlags.Filter1": { "type": "object", "title": "RedFlags.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "RedFlags.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "old_c_total": { "type": "boolean" }, "old_s_total": { "type": "boolean" }, "c_total": { "type": "boolean" }, "s_total": { "type": "boolean" }, "old_margin": { "type": "boolean" }, "current_margin": { "type": "boolean" }, "difference": { "type": "boolean" }, "change_date": { "type": "boolean" }, "red_for": { "type": "boolean" }, "pickup_date": { "type": "boolean" }, "msg": { "type": "boolean" }, "apAPId": { "type": "boolean" }, "ArId": { "type": "boolean" }, "created_at": { "type": "boolean" }, "redflag_type": { "type": "boolean" }, "shipmentId": { "type": "boolean" }, "userId": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "old_c_total", "old_s_total", "c_total", "s_total", "old_margin", "current_margin", "difference", "change_date", "red_for", "pickup_date", "msg", "apAPId", "ArId", "created_at", "redflag_type", "shipmentId", "userId" ], "example": "id" }, "uniqueItems": true } ], "title": "RedFlags.Fields" }, "include": { "title": "RedFlags.IncludeFilter", "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/RedFlags.IncludeFilter.Items" }, { "type": "string" } ] } } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "ShipmentTracking.ScopeFilter": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": {}, "additionalProperties": true }, { "type": "array", "items": { "type": "string" }, "uniqueItems": true } ] }, "include": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true } } }, "additionalProperties": false, "title": "ShipmentTracking.ScopeFilter" }, "ShipmentTracking.IncludeFilter.Items": { "title": "ShipmentTracking.IncludeFilter.Items", "type": "object", "properties": { "relation": { "type": "string", "enum": [ "shipment" ] }, "scope": { "$ref": "#/components/schemas/ShipmentTracking.ScopeFilter" } } }, "ShipmentTracking.Filter": { "type": "object", "title": "ShipmentTracking.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "ShipmentTracking.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "byServer": { "type": "boolean" }, "trackingId": { "type": "boolean" }, "mapLink": { "type": "boolean" }, "timeStamp": { "type": "boolean" }, "trackingMethod": { "type": "boolean" }, "statusPageLink": { "type": "boolean" }, "trackingStatus": { "type": "boolean" }, "uid": { "type": "boolean" }, "latitude": { "type": "boolean" }, "longitude": { "type": "boolean" }, "accuracy": { "type": "boolean" }, "code": { "type": "boolean" }, "name": { "type": "boolean" }, "address": { "type": "boolean" }, "status": { "type": "boolean" }, "lastlocationUpdate": { "type": "boolean" }, "shipmentId": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "byServer", "trackingId", "mapLink", "timeStamp", "trackingMethod", "statusPageLink", "trackingStatus", "uid", "latitude", "longitude", "accuracy", "code", "name", "address", "status", "lastlocationUpdate", "shipmentId" ], "example": "id" }, "uniqueItems": true } ], "title": "ShipmentTracking.Fields" }, "include": { "title": "ShipmentTracking.IncludeFilter", "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/ShipmentTracking.IncludeFilter.Items" }, { "type": "string" } ] } } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "Shipment.ScopeFilter": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": {}, "additionalProperties": true }, { "type": "array", "items": { "type": "string" }, "uniqueItems": true } ] }, "include": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true } } }, "additionalProperties": false, "title": "Shipment.ScopeFilter" }, "Shipment.IncludeFilter.Items": { "title": "Shipment.IncludeFilter.Items", "type": "object", "properties": { "relation": { "type": "string", "enum": [ "equipment", "commodities", "shipmentDocs", "carriers", "shipmentCarrier", "shipmentTimelines", "cprRequest", "gtgHistory", "mcReVerification", "carrierAgings", "carrierAging", "carrierPayment", "manager", "team", "signDoc", "refPortal", "user", "apIncentive", "invoices", "portal", "shipmentPrices", "shipmentPicks", "shipmentDrops", "shipmentDetails", "auditVerifyCprs", "auditVerifyCommodities", "carrierConfirmDelivery", "shippers" ] }, "scope": { "$ref": "#/components/schemas/Shipment.ScopeFilter" } } }, "Shipment.Filter": { "type": "object", "title": "Shipment.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "shipmentNo": { "type": "boolean" }, "uid": { "type": "boolean" }, "status": { "type": "boolean" }, "tonuStatus": { "type": "boolean" }, "loadNo": { "type": "boolean" }, "containerNo": { "type": "boolean" }, "loadType": { "type": "boolean" }, "cdlNumber": { "type": "boolean" }, "vinNumber": { "type": "boolean" }, "pickupPhone": { "type": "boolean" }, "brokerSelfConfirmation": { "type": "boolean" }, "mc": { "type": "boolean" }, "dot": { "type": "boolean" }, "nsc": { "type": "boolean" }, "ar_gtg": { "type": "boolean" }, "ap_gtg": { "type": "boolean" }, "aone_ff_sync": { "type": "boolean" }, "cmt": { "type": "boolean" }, "commodityValue": { "type": "boolean" }, "weight": { "type": "boolean" }, "mode": { "type": "boolean" }, "footage": { "type": "boolean" }, "pallet": { "type": "boolean" }, "miles": { "type": "boolean" }, "minTemp": { "type": "boolean" }, "maxTemp": { "type": "boolean" }, "precoolTemp": { "type": "boolean" }, "carrierPayMode": { "type": "boolean" }, "shipperPayMode": { "type": "boolean" }, "carrierCommunicationPortalid": { "type": "boolean" }, "carrierInstrctions": { "type": "boolean" }, "shipperInstrctions": { "type": "boolean" }, "carrierPrice": { "type": "boolean" }, "carrierPriceCad": { "type": "boolean" }, "shipperPrice": { "type": "boolean" }, "shipperPriceCad": { "type": "boolean" }, "carrierPriceType": { "type": "boolean" }, "shipperPriceType": { "type": "boolean" }, "carrierUint": { "type": "boolean" }, "carrierUnitPrice": { "type": "boolean" }, "ShipperUnit": { "type": "boolean" }, "shipperUnitPrice": { "type": "boolean" }, "billingDetail": { "type": "boolean" }, "auditComment": { "type": "boolean" }, "VinPickupPhoneComment": { "type": "boolean" }, "auditCreatedAt": { "type": "boolean" }, "auditVinNumberCreatedAt": { "type": "boolean" }, "ai_commodity_value": { "type": "boolean" }, "ai_doc_id": { "type": "boolean" }, "vinEmailStatus": { "type": "boolean" }, "equipmentId": { "type": "boolean" }, "commoditiesId": { "type": "boolean" }, "carriersId": { "type": "boolean" }, "conversionRateUsd": { "type": "boolean" }, "conversionRateCsd": { "type": "boolean" }, "carrierRc": { "type": "boolean" }, "shipperRc": { "type": "boolean" }, "bol": { "type": "boolean" }, "apHold": { "type": "boolean" }, "tonuApproval": { "type": "boolean" }, "loadCof": { "type": "boolean" }, "reminderStatus": { "type": "boolean" }, "managerId": { "type": "boolean" }, "teamId": { "type": "boolean" }, "refPortalId": { "type": "boolean" }, "holdCarrierAmt": { "type": "boolean" }, "created": { "type": "boolean" }, "modified": { "type": "boolean" }, "verifyCommodity": { "type": "boolean" }, "verifyCpr": { "type": "boolean" }, "verifyVinNumber": { "type": "boolean" }, "verifyPickupPhone": { "type": "boolean" }, "userId": { "type": "boolean" }, "portalId": { "type": "boolean" }, "shippersId": { "type": "boolean" }, "managerComments": { "type": "boolean" }, "managerApproveId": { "type": "boolean" }, "invMarginStatus": { "type": "boolean" }, "invCommunicationType": { "type": "boolean" }, "invCommunicationApproveId": { "type": "boolean" }, "credit_exception": { "type": "boolean" }, "rateNotFinalizedDrayageStatus": { "type": "boolean" }, "rateNotFinalizedDrayageComment": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "shipmentNo", "uid", "status", "tonuStatus", "loadNo", "containerNo", "loadType", "cdlNumber", "vinNumber", "pickupPhone", "brokerSelfConfirmation", "mc", "dot", "nsc", "ar_gtg", "ap_gtg", "aone_ff_sync", "cmt", "commodityValue", "weight", "mode", "footage", "pallet", "miles", "minTemp", "maxTemp", "precoolTemp", "carrierPayMode", "shipperPayMode", "carrierCommunicationPortalid", "carrierInstrctions", "shipperInstrctions", "carrierPrice", "carrierPriceCad", "shipperPrice", "shipperPriceCad", "carrierPriceType", "shipperPriceType", "carrierUint", "carrierUnitPrice", "ShipperUnit", "shipperUnitPrice", "billingDetail", "auditComment", "VinPickupPhoneComment", "auditCreatedAt", "auditVinNumberCreatedAt", "ai_commodity_value", "ai_doc_id", "vinEmailStatus", "equipmentId", "commoditiesId", "carriersId", "conversionRateUsd", "conversionRateCsd", "carrierRc", "shipperRc", "bol", "apHold", "tonuApproval", "loadCof", "reminderStatus", "managerId", "teamId", "refPortalId", "holdCarrierAmt", "created", "modified", "verifyCommodity", "verifyCpr", "verifyVinNumber", "verifyPickupPhone", "userId", "portalId", "shippersId", "managerComments", "managerApproveId", "invMarginStatus", "invCommunicationType", "invCommunicationApproveId", "credit_exception", "rateNotFinalizedDrayageStatus", "rateNotFinalizedDrayageComment" ], "example": "id" }, "uniqueItems": true } ], "title": "Shipment.Fields" }, "include": { "title": "Shipment.IncludeFilter", "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/Shipment.IncludeFilter.Items" }, { "type": "string" } ] } } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "ShipperUnknownPayment.Filter": { "type": "object", "title": "ShipperUnknownPayment.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "paymentReceivedDate": { "type": "boolean" }, "paymentReceivedFrom": { "type": "boolean" }, "customerName": { "type": "boolean" }, "currency": { "type": "boolean" }, "modeOfPayment": { "type": "boolean" }, "checkNumber": { "type": "boolean" }, "checkDate": { "type": "boolean" }, "receivedAmount": { "type": "boolean" }, "paymentStatus": { "type": "boolean" }, "invoiceNumber": { "type": "boolean" }, "communication": { "type": "boolean" }, "openCredit": { "type": "boolean" }, "mainComment": { "type": "boolean" }, "arComment": { "type": "boolean" }, "isDeleted": { "type": "boolean" }, "amountRefunded": { "type": "boolean" }, "addedBy": { "type": "boolean" }, "updatedBy": { "type": "boolean" }, "createdAt": { "type": "boolean" }, "updatedAt": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "paymentReceivedDate", "paymentReceivedFrom", "customerName", "currency", "modeOfPayment", "checkNumber", "checkDate", "receivedAmount", "paymentStatus", "invoiceNumber", "communication", "openCredit", "mainComment", "arComment", "isDeleted", "amountRefunded", "addedBy", "updatedBy", "createdAt", "updatedAt" ], "example": "id" }, "uniqueItems": true } ], "title": "ShipperUnknownPayment.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "ShippersBankruptcy.Filter": { "type": "object", "title": "ShippersBankruptcy.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "company_name": { "type": "boolean" }, "mc_number": { "type": "boolean" }, "address": { "type": "boolean" }, "added_by": { "type": "boolean" }, "is_active": { "type": "boolean" }, "created_at": { "type": "boolean" }, "updated_at": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "company_name", "mc_number", "address", "added_by", "is_active", "created_at", "updated_at" ], "example": "id" }, "uniqueItems": true } ], "title": "ShippersBankruptcy.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "ShippersBankruptcy.Filter1": { "type": "object", "title": "ShippersBankruptcy.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "ShippersBankruptcy.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "company_name": { "type": "boolean" }, "mc_number": { "type": "boolean" }, "address": { "type": "boolean" }, "added_by": { "type": "boolean" }, "is_active": { "type": "boolean" }, "created_at": { "type": "boolean" }, "updated_at": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "company_name", "mc_number", "address", "added_by", "is_active", "created_at", "updated_at" ], "example": "id" }, "uniqueItems": true } ], "title": "ShippersBankruptcy.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "SmeMcComments.ScopeFilter": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": {}, "additionalProperties": true }, { "type": "array", "items": { "type": "string" }, "uniqueItems": true } ] }, "include": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true } } }, "additionalProperties": false, "title": "SmeMcComments.ScopeFilter" }, "SmeMcComments.IncludeFilter.Items": { "title": "SmeMcComments.IncludeFilter.Items", "type": "object", "properties": { "relation": { "type": "string", "enum": [ "mcVerification", "cprRequest", "ApprovedBySms" ] }, "scope": { "$ref": "#/components/schemas/SmeMcComments.ScopeFilter" } } }, "SmeMcComments.Filter": { "type": "object", "title": "SmeMcComments.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "portalId": { "type": "boolean" }, "userId": { "type": "boolean" }, "mcNumber": { "type": "boolean" }, "dotNumber": { "type": "boolean" }, "nscNumber": { "type": "boolean" }, "mcTruckType": { "type": "boolean" }, "mcVerificationId": { "type": "boolean" }, "cprRequestId": { "type": "boolean" }, "ApprovedBySmsId": { "type": "boolean" }, "mcApproveNotes": { "type": "boolean" }, "loadMatchComments": { "type": "boolean" }, "approveTime": { "type": "boolean" }, "smeStatus": { "type": "boolean" }, "approveBy": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "portalId", "userId", "mcNumber", "dotNumber", "nscNumber", "mcTruckType", "mcVerificationId", "cprRequestId", "ApprovedBySmsId", "mcApproveNotes", "loadMatchComments", "approveTime", "smeStatus", "approveBy" ], "example": "id" }, "uniqueItems": true } ], "title": "SmeMcComments.Fields" }, "include": { "title": "SmeMcComments.IncludeFilter", "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/SmeMcComments.IncludeFilter.Items" }, { "type": "string" } ] } } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "SmeMcComments.Filter1": { "type": "object", "title": "SmeMcComments.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "SmeMcComments.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "portalId": { "type": "boolean" }, "userId": { "type": "boolean" }, "mcNumber": { "type": "boolean" }, "dotNumber": { "type": "boolean" }, "nscNumber": { "type": "boolean" }, "mcTruckType": { "type": "boolean" }, "mcVerificationId": { "type": "boolean" }, "cprRequestId": { "type": "boolean" }, "ApprovedBySmsId": { "type": "boolean" }, "mcApproveNotes": { "type": "boolean" }, "loadMatchComments": { "type": "boolean" }, "approveTime": { "type": "boolean" }, "smeStatus": { "type": "boolean" }, "approveBy": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "portalId", "userId", "mcNumber", "dotNumber", "nscNumber", "mcTruckType", "mcVerificationId", "cprRequestId", "ApprovedBySmsId", "mcApproveNotes", "loadMatchComments", "approveTime", "smeStatus", "approveBy" ], "example": "id" }, "uniqueItems": true } ], "title": "SmeMcComments.Fields" }, "include": { "title": "SmeMcComments.IncludeFilter", "type": "array", "items": { "anyOf": [ { "$ref": "#/components/schemas/SmeMcComments.IncludeFilter.Items" }, { "type": "string" } ] } } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "ThirdPartyUsers.Filter": { "type": "object", "title": "ThirdPartyUsers.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "keyId": { "type": "boolean" }, "userName": { "type": "boolean" }, "realUserName": { "type": "boolean" }, "realPassword": { "type": "boolean" }, "userType": { "type": "boolean" }, "portalId": { "type": "boolean" }, "dat_header": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "keyId", "userName", "realUserName", "realPassword", "userType", "portalId", "dat_header" ], "example": "id" }, "uniqueItems": true } ], "title": "ThirdPartyUsers.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "ThirdPartyUsers.Filter1": { "type": "object", "title": "ThirdPartyUsers.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "ThirdPartyUsers.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "keyId": { "type": "boolean" }, "userName": { "type": "boolean" }, "realUserName": { "type": "boolean" }, "realPassword": { "type": "boolean" }, "userType": { "type": "boolean" }, "portalId": { "type": "boolean" }, "dat_header": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "keyId", "userName", "realUserName", "realPassword", "userType", "portalId", "dat_header" ], "example": "id" }, "uniqueItems": true } ], "title": "ThirdPartyUsers.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "TruckStopsKey.Filter": { "type": "object", "title": "TruckStopsKey.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "TruckStopsKey.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "email": { "type": "boolean" }, "password": { "type": "boolean" }, "primary_token": { "type": "boolean" }, "secondary_token": { "type": "boolean" }, "portalId": { "type": "boolean" }, "dta": { "type": "boolean" }, "token_type": { "type": "boolean" }, "status": { "type": "boolean" }, "managerId": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "email", "password", "primary_token", "secondary_token", "portalId", "dta", "token_type", "status", "managerId" ], "example": "id" }, "uniqueItems": true } ], "title": "TruckStopsKey.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "Workbook.Filter": { "type": "object", "title": "Workbook.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "name": { "type": "boolean" }, "sheets": { "type": "boolean" }, "activeSheetId": { "type": "boolean" }, "userId": { "type": "boolean" }, "createdAt": { "type": "boolean" }, "updatedAt": { "type": "boolean" }, "deletedAt": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "name", "sheets", "activeSheetId", "userId", "createdAt", "updatedAt", "deletedAt" ], "example": "id" }, "uniqueItems": true } ], "title": "Workbook.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "Workbook.Filter1": { "type": "object", "title": "Workbook.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "Workbook.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "name": { "type": "boolean" }, "sheets": { "type": "boolean" }, "activeSheetId": { "type": "boolean" }, "userId": { "type": "boolean" }, "createdAt": { "type": "boolean" }, "updatedAt": { "type": "boolean" }, "deletedAt": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "name", "sheets", "activeSheetId", "userId", "createdAt", "updatedAt", "deletedAt" ], "example": "id" }, "uniqueItems": true } ], "title": "Workbook.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "ZipCodes.Filter": { "type": "object", "title": "ZipCodes.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "city_id": { "type": "boolean" }, "name": { "type": "boolean" }, "state_code": { "type": "boolean" }, "zip": { "type": "boolean" }, "latitude": { "type": "boolean" }, "longitude": { "type": "boolean" }, "county": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "city_id", "name", "state_code", "zip", "latitude", "longitude", "county" ], "example": "id" }, "uniqueItems": true } ], "title": "ZipCodes.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" }, "ZipCodes.Filter1": { "type": "object", "title": "ZipCodes.Filter", "properties": { "offset": { "type": "integer", "minimum": 0 }, "limit": { "type": "integer", "minimum": 1, "example": 100 }, "skip": { "type": "integer", "minimum": 0 }, "order": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "where": { "title": "ZipCodes.WhereFilter", "type": "object", "additionalProperties": true }, "fields": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "boolean" }, "city_id": { "type": "boolean" }, "name": { "type": "boolean" }, "state_code": { "type": "boolean" }, "zip": { "type": "boolean" }, "latitude": { "type": "boolean" }, "longitude": { "type": "boolean" }, "county": { "type": "boolean" } }, "additionalProperties": false }, { "type": "array", "items": { "type": "string", "enum": [ "id", "city_id", "name", "state_code", "zip", "latitude", "longitude", "county" ], "example": "id" }, "uniqueItems": true } ], "title": "ZipCodes.Fields" } }, "additionalProperties": false, "x-typescript-type": "@loopback/repository#Filter" } }, "securitySchemes": { "jwt": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT" } } }, "security": [ { "jwt": [] } ] }