{"swagger":"2.0","info":{"description":"Generate an API Key in FireTMS. You can do it in FireTMS user profile.\n If you are a FireTMS admin, you can also generate API Keys for other users.","version":"1.0","title":"fireTMS","contact":{},"license":{}},"host":"app.firetms.com","basePath":"/api","tags":[{"name":"Client orders","description":"Methods related with client orders"},{"name":"Contractors","description":"Methods related with contractors"},{"name":"Currency tables","description":"Methods related with currency tables"},{"name":"Departments","description":"Methods related with departments"},{"name":"Internal transport","description":"Methods related with internal trucks, drivers and semitrailers"},{"name":"Invoices","description":"Methods related with invoices."},{"name":"Notes","description":"Methods related with notes"},{"name":"Offers","description":"Methods related with offers"},{"name":"Orders","description":"Methods related with carrier, transport and inhouse orders"},{"name":"Payments","description":"Methods related with payments"},{"name":"Purchase VAT rates","description":"Methods related with purchase VAT rates"},{"name":"Purchase service type","description":"Methods related with purchase service types"},{"name":"Units of measure","description":"Methods related with units of measure"}],"paths":{"/contractors":{"get":{"tags":["Contractors"],"summary":"Allow to get all contractors","description":"This resource contains only part of the data which are accessible through web application. Contractor contains all its contact persons.\nPagination works as in SQL. There is a limit and an offset. Page number starts with 1. See listing example for maximum and minimum page size and other constraints.\n\nEach listing response includes paging field, that contains information as:\n- firstItemIndex - index of first contractor on given page (starting with 0). On 3rd page with 200 size it will be 600th element\n- totalItems - in this resource it returns count of fetched items on particular page, not the count of all items matching given query\n\nNormalizations\n\nSome of fields are formatted, called as normalized.\n\n\n\n
FieldNormalization
normalizedTaxIdNo spaces, no special characters
normalizedVatEuIdNo spaces, no special characters
address.normalizedZipCode\tNo spaces, no special characters, two letter country code at beginning, REGEX =([A-Za-z]{2})([a-zA-Z0-9]+)
\n\n","operationId":"getAllContractorsUsingGET","produces":["*/*"],"parameters":[{"name":"contractorNumbers","in":"query","description":"contractorNumbers","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"page","in":"query","description":"page","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"pageSize","required":false,"type":"integer","default":50,"format":"int32"},{"name":"taxId","in":"query","description":"taxId","required":false,"type":"string"},{"name":"vatEuId","in":"query","description":"vatEuId","required":false,"type":"string"}],"responses":{"200":{"description":"Successful GET command","schema":{"$ref":"#/definitions/ContractorApiList"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"API Key authorization":["global"]}],"deprecated":false},"post":{"tags":["Contractors"],"summary":"Allow to create contractor","operationId":"createContractorUsingPOST","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"createContractorRequest","description":"createContractorRequest","required":true,"schema":{"$ref":"#/definitions/CreateContractorRequest"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ResponseEntity"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"API Key authorization":["global"]}],"deprecated":false}},"/contractors/count":{"get":{"tags":["Contractors"],"summary":"Allow to count contractors","operationId":"getContractorsCountUsingGET","produces":["*/*"],"parameters":[{"name":"contractorNumbers","in":"query","description":"contractorNumbers","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"taxId","in":"query","description":"taxId","required":false,"type":"string"},{"name":"vatEuId","in":"query","description":"vatEuId","required":false,"type":"string"}],"responses":{"200":{"description":"Successful GET command","schema":{"type":"integer","format":"int32"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"API Key authorization":["global"]}],"deprecated":false}},"/contractors/{id}/bank-accounts":{"get":{"tags":["Contractors"],"summary":"Get contractor bank accounts","operationId":"getBankAccountsUsingGET","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"string","x-example":"Contractor ID"}],"responses":{"200":{"description":"Successful GET command","schema":{"$ref":"#/definitions/ContractorBankAccountResponseList"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"API Key authorization":["global"]}],"deprecated":false}},"/currency-tables":{"get":{"tags":["Currency tables"],"summary":"Query and list currency table rates","description":"

Filters with usage example. Multiple filters must be separated by comma

\n

Sortable properties

","operationId":"listUsingGET_1","produces":["*/*"],"parameters":[{"name":"page","in":"query","description":"Results page you want to retrieve (0..N)","required":false,"type":"ref"},{"name":"query","in":"query","description":"RSQL query","required":false,"type":"string","allowEmptyValue":false,"x-example":"tableNumber == 102/A/NBP/2025, authority == NBP, tableDate < 2025-12-30"},{"name":"size","in":"query","description":"Number of records per page.","required":false,"type":"ref"},{"name":"sort","in":"query","description":"Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"Successful GET command","schema":{"$ref":"#/definitions/CurrencyTableResponseList"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"API Key authorization":["global"]}],"deprecated":false}},"/departments":{"get":{"tags":["Departments"],"summary":"Query and list departments","description":"

Filters with usage example. Multiple filters must be separated by comma

\n","operationId":"listUsingGET_2","produces":["*/*"],"parameters":[{"name":"page","in":"query","description":"Results page you want to retrieve (0..N)","required":false,"type":"ref"},{"name":"query","in":"query","description":"RSQL query","required":false,"type":"string","allowEmptyValue":false,"x-example":"name == \"fire TMS\""},{"name":"size","in":"query","description":"Number of records per page.","required":false,"type":"ref"},{"name":"sort","in":"query","description":"Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"Successful GET command","schema":{"$ref":"#/definitions/DepartmentResponseList"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"API Key authorization":["global"]}],"deprecated":false},"post":{"tags":["Departments"],"summary":"Create department","operationId":"createUsingPOST","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"createRequest","description":"createRequest","required":true,"schema":{"$ref":"#/definitions/CreateDepartmentRequest"}}],"responses":{"200":{"description":"OK"},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"API Key authorization":["global"]}],"deprecated":false}},"/departments/{id}":{"get":{"tags":["Departments"],"summary":"Get department details","operationId":"fetchUsingGET","produces":["*/*"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/DepartmentDetailedResponse"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"API Key authorization":["global"]}],"deprecated":false},"post":{"tags":["Departments"],"summary":"Update department","operationId":"updateUsingPOST","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"departmentUpdateRequest","description":"departmentUpdateRequest","required":true,"schema":{"$ref":"#/definitions/UpdateDepartmentRequest"}},{"name":"id","in":"path","description":"id","required":true,"type":"string"}],"responses":{"200":{"description":"OK"},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"API Key authorization":["global"]}],"deprecated":false}},"/internal-drivers":{"get":{"tags":["Internal transport"],"summary":"Query and list internal drivers","description":"

Filters with usage example. Multiple filters must be separated by comma

\n","operationId":"listUsingGET_3","produces":["*/*"],"parameters":[{"name":"page","in":"query","description":"Results page you want to retrieve (0..N)","required":false,"type":"ref"},{"name":"query","in":"query","description":"RSQL query","required":false,"type":"string","allowEmptyValue":false,"x-example":"name == \"John Doe\""},{"name":"size","in":"query","description":"Number of records per page.","required":false,"type":"ref"}],"responses":{"200":{"description":"Successful GET command","schema":{"$ref":"#/definitions/InternalDriverResponseList"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"API Key authorization":["global"]}],"deprecated":false}},"/internal-expense":{"get":{"tags":["Internal transport"],"summary":"Query and list internal transport expenses","description":"

Filters with usage example. Multiple filters must be separated by comma

\n

Sortable properties

","operationId":"listUsingGET_5","produces":["*/*"],"parameters":[{"name":"page","in":"query","description":"Results page you want to retrieve (0..N)","required":false,"type":"ref"},{"name":"query","in":"query","description":"RSQL query","required":false,"type":"string","allowEmptyValue":false,"x-example":"truckRegNumber == \"SR12345\", searchField == Fuel"},{"name":"size","in":"query","description":"Number of records per page.","required":false,"type":"ref"},{"name":"sort","in":"query","description":"Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"Successful GET command","schema":{"$ref":"#/definitions/InternalTransportExpenseResponseList"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"API Key authorization":["global"]}],"deprecated":false}},"/internal-semitrailers":{"get":{"tags":["Internal transport"],"summary":"Query and list internal semitrailers","description":"

Filters with usage example. Multiple filters must be separated by comma

\n","operationId":"listUsingGET_4","produces":["*/*"],"parameters":[{"name":"page","in":"query","description":"Results page you want to retrieve (0..N)","required":false,"type":"ref"},{"name":"query","in":"query","description":"RSQL query","required":false,"type":"string","allowEmptyValue":false,"x-example":"regNumber == \"SR12345\""},{"name":"size","in":"query","description":"Number of records per page.","required":false,"type":"ref"}],"responses":{"200":{"description":"Successful GET command","schema":{"$ref":"#/definitions/InternalSemitrailerResponseList"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"API Key authorization":["global"]}],"deprecated":false}},"/internal-trucks":{"get":{"tags":["Internal transport"],"summary":"Query and list internal trucks","description":"

Filters with usage example. Multiple filters must be separated by comma

\n

Sortable properties

","operationId":"listUsingGET_6","produces":["*/*"],"parameters":[{"name":"page","in":"query","description":"Results page you want to retrieve (0..N)","required":false,"type":"ref"},{"name":"query","in":"query","description":"RSQL query","required":false,"type":"string","allowEmptyValue":false,"x-example":"regNumber == \"SR12345\""},{"name":"size","in":"query","description":"Number of records per page.","required":false,"type":"ref"},{"name":"sort","in":"query","description":"Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"Successful GET command","schema":{"$ref":"#/definitions/InternalTruckResponseList"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"API Key authorization":["global"]}],"deprecated":false}},"/invoices/purchase":{"put":{"tags":["Invoices"],"summary":"Create purchase invoice draft","description":"

Notes

\n \n \n \n \n\n \n \n \n \n\n \n \n \n \n\n \n \n \n \n\n \n \n \n \n\n \n \n \n \n\n \n \n \n \n\n \n \n \n \n\n \n \n \n \n\n \n \n \n \n\n \n \n \n \n
FieldDescription
currencyWhen empty, \"Default invoice currency\" from contractor is used. If not defined, an error is thrown.
documentNumberIf \"Check uniqueness of document number\" in System configuration > Accounting is set to \"Block\", an error can be thrown.
paymentMethodWhen empty, contractor's \"Default payment method for purchase documents\" is used. If missing, \"CASH\" is assumed.
sellerBankAccountIdBank account currency must match invoice currency. When empty, a bank account is auto-selected from contractor’s accounts. Field not used when paymentMethod does not use bank accounts.
departmentIdWhen empty, payerId is used.
paymentTermWhen empty, contractor's \"Default payment term for purchase invoices\" is used. If missing, default is 30/INVOICE_CREATION/SET_AMOUNT_OF_DAYS.
items.taxRateWhen empty, contractor's \"Default VAT rate for transport (purchase) invoices and credit notes\" is used. If not defined, an error is thrown.
items.ordersAn order cannot be assigned to multiple items. Orders must have correct status and type for invoice assignment.
items.currencyTableWhen empty, currency table is auto-selected based on seller, payer, and currency conversion settings. Contractor settings have priority. Automatic selection is highly recommended.
loadsMust have correct status for invoice assignment.
","operationId":"createPurchaseInvoiceDraftUsingPUT","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"request","description":"request","required":true,"schema":{"$ref":"#/definitions/CreatePurchaseInvoiceRequest"}}],"responses":{"200":{"description":"OK"},"201":{"description":"Successful operation"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"API Key authorization":["global"]}],"deprecated":false}},"/invoices/purchase/corrective":{"get":{"tags":["Invoices"],"summary":"Allow to get purchase corrective invoice list","operationId":"getCorrectivePurchaseInvoiceListUsingGET","produces":["*/*"],"parameters":[{"name":"asc","in":"query","description":"asc","required":false,"type":"boolean","default":true},{"name":"contractorNumbers","in":"query","description":"contractorNumbers","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"dateOfIssueFrom","in":"query","description":"dateOfIssueFrom","required":false,"type":"string","format":"date-time"},{"name":"dateOfIssueTo","in":"query","description":"dateOfIssueTo","required":false,"type":"string","format":"date-time"},{"name":"dateOfSaleFrom","in":"query","description":"dateOfSaleFrom","required":false,"type":"string","format":"date-time"},{"name":"dateOfSaleTo","in":"query","description":"dateOfSaleTo","required":false,"type":"string","format":"date-time"},{"name":"page","in":"query","description":"page","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"pageSize","required":false,"type":"integer","default":25,"format":"int32"},{"name":"showExchangeRate","in":"query","description":"showExchangeRate","required":false,"type":"boolean"},{"name":"sortBy","in":"query","description":"sortBy","required":false,"type":"string","default":"id","enum":["sellDate","issuanceDate","totalNet","totalTax","totalGross","calculatedPaymentTerm","totalPaidGross","outstandingToPay","status","id"]}],"responses":{"200":{"description":"Successful GET command","schema":{"$ref":"#/definitions/InvoiceApiList"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"API Key authorization":["global"]}],"deprecated":false}},"/invoices/purchase/corrective/draft":{"get":{"tags":["Invoices"],"summary":"Allow to get draft purchase corrective invoice list","operationId":"getDraftCorrectivePurchaseInvoiceListUsingGET","produces":["*/*"],"parameters":[{"name":"asc","in":"query","description":"asc","required":false,"type":"boolean","default":true},{"name":"contractorNumbers","in":"query","description":"contractorNumbers","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"dateOfSaleFrom","in":"query","description":"dateOfSaleFrom","required":false,"type":"string","format":"date-time"},{"name":"dateOfSaleTo","in":"query","description":"dateOfSaleTo","required":false,"type":"string","format":"date-time"},{"name":"page","in":"query","description":"page","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"pageSize","required":false,"type":"integer","default":25,"format":"int32"},{"name":"showExchangeRate","in":"query","description":"showExchangeRate","required":false,"type":"boolean"},{"name":"sortBy","in":"query","description":"sortBy","required":false,"type":"string","default":"id","enum":["sellDate","issuanceDate","totalNet","totalTax","totalGross","calculatedPaymentTerm","totalPaidGross","outstandingToPay","status","id"]}],"responses":{"200":{"description":"Successful GET command","schema":{"$ref":"#/definitions/InvoiceApiList"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"API Key authorization":["global"]}],"deprecated":false}},"/invoices/purchase/draft":{"get":{"tags":["Invoices"],"summary":"Allow to get draft purchase invoice list","operationId":"getPurchaseDraftInvoiceListUsingGET","produces":["*/*"],"parameters":[{"name":"asc","in":"query","description":"asc","required":false,"type":"boolean","default":true},{"name":"contractorNumbers","in":"query","description":"contractorNumbers","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"dateOfSaleFrom","in":"query","description":"dateOfSaleFrom","required":false,"type":"string","format":"date-time"},{"name":"dateOfSaleTo","in":"query","description":"dateOfSaleTo","required":false,"type":"string","format":"date-time"},{"name":"page","in":"query","description":"page","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"pageSize","required":false,"type":"integer","default":25,"format":"int32"},{"name":"showExchangeRate","in":"query","description":"showExchangeRate","required":false,"type":"boolean"},{"name":"sortBy","in":"query","description":"sortBy","required":false,"type":"string","default":"id","enum":["sellDate","issuanceDate","totalNet","totalTax","totalGross","calculatedPaymentTerm","totalPaidGross","outstandingToPay","status","id"]}],"responses":{"200":{"description":"Successful GET command","schema":{"$ref":"#/definitions/InvoiceApiList"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"API Key authorization":["global"]}],"deprecated":false}},"/invoices/purchase/issued":{"get":{"tags":["Invoices"],"summary":"Allow to get purchase invoice list","operationId":"getPurchaseInvoiceListUsingGET","produces":["*/*"],"parameters":[{"name":"asc","in":"query","description":"asc","required":false,"type":"boolean","default":true},{"name":"contractorNumbers","in":"query","description":"contractorNumbers","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"dateOfIssueFrom","in":"query","description":"dateOfIssueFrom","required":false,"type":"string","format":"date-time"},{"name":"dateOfIssueTo","in":"query","description":"dateOfIssueTo","required":false,"type":"string","format":"date-time"},{"name":"dateOfSaleFrom","in":"query","description":"dateOfSaleFrom","required":false,"type":"string","format":"date-time"},{"name":"dateOfSaleTo","in":"query","description":"dateOfSaleTo","required":false,"type":"string","format":"date-time"},{"name":"page","in":"query","description":"page","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"pageSize","required":false,"type":"integer","default":25,"format":"int32"},{"name":"showExchangeRate","in":"query","description":"showExchangeRate","required":false,"type":"boolean"},{"name":"sortBy","in":"query","description":"sortBy","required":false,"type":"string","default":"id","enum":["sellDate","issuanceDate","totalNet","totalTax","totalGross","calculatedPaymentTerm","totalPaidGross","outstandingToPay","status","id"]}],"responses":{"200":{"description":"Successful GET command","schema":{"$ref":"#/definitions/InvoiceApiList"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"API Key authorization":["global"]}],"deprecated":false}},"/invoices/sales/corrective":{"get":{"tags":["Invoices"],"summary":"Allow to get sales corrective issued invoice list","operationId":"getCorrectiveInvoiceListUsingGET","produces":["*/*"],"parameters":[{"name":"asc","in":"query","description":"asc","required":false,"type":"boolean","default":true},{"name":"contractorNumbers","in":"query","description":"contractorNumbers","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"dateOfIssueFrom","in":"query","description":"dateOfIssueFrom","required":false,"type":"string","format":"date-time"},{"name":"dateOfIssueTo","in":"query","description":"dateOfIssueTo","required":false,"type":"string","format":"date-time"},{"name":"dateOfSaleFrom","in":"query","description":"dateOfSaleFrom","required":false,"type":"string","format":"date-time"},{"name":"dateOfSaleTo","in":"query","description":"dateOfSaleTo","required":false,"type":"string","format":"date-time"},{"name":"page","in":"query","description":"page","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"pageSize","required":false,"type":"integer","default":25,"format":"int32"},{"name":"showCostCenter","in":"query","description":"showCostCenter","required":false,"type":"boolean"},{"name":"showExchangeRate","in":"query","description":"showExchangeRate","required":false,"type":"boolean"},{"name":"sortBy","in":"query","description":"sortBy","required":false,"type":"string","default":"id","enum":["sellDate","issuanceDate","totalNet","totalTax","totalGross","calculatedPaymentTerm","totalPaidGross","outstandingToPay","status","id"]}],"responses":{"200":{"description":"Successful GET command","schema":{"$ref":"#/definitions/InvoiceApiList"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"API Key authorization":["global"]}],"deprecated":false}},"/invoices/sales/draft":{"get":{"tags":["Invoices"],"summary":"Allow to get sales draft invoice list","operationId":"getDraftInvoiceListUsingGET","produces":["*/*"],"parameters":[{"name":"asc","in":"query","description":"asc","required":false,"type":"boolean","default":true},{"name":"contractorNumbers","in":"query","description":"contractorNumbers","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"dateOfSaleFrom","in":"query","description":"dateOfSaleFrom","required":false,"type":"string","format":"date-time"},{"name":"dateOfSaleTo","in":"query","description":"dateOfSaleTo","required":false,"type":"string","format":"date-time"},{"name":"page","in":"query","description":"page","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"pageSize","required":false,"type":"integer","default":25,"format":"int32"},{"name":"showCostCenter","in":"query","description":"showCostCenter","required":false,"type":"boolean"},{"name":"showExchangeRate","in":"query","description":"showExchangeRate","required":false,"type":"boolean"},{"name":"sortBy","in":"query","description":"sortBy","required":false,"type":"string","default":"id","enum":["sellDate","issuanceDate","totalNet","totalTax","totalGross","calculatedPaymentTerm","totalPaidGross","outstandingToPay","status","id"]}],"responses":{"200":{"description":"Successful GET command","schema":{"$ref":"#/definitions/InvoiceApiList"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"API Key authorization":["global"]}],"deprecated":false},"put":{"tags":["Invoices"],"summary":"Sales invoice confirmation","operationId":"issueDraftInvoiceUsingPUT","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"comment","in":"query","description":"comment","required":false,"type":"string"},{"name":"docNumber","in":"query","description":"docNumber","required":false,"type":"string"},{"name":"documentId","in":"query","description":"documentId","required":true,"type":"string"},{"name":"issuanceDate","in":"query","description":"issuanceDate","required":false,"type":"string","format":"date-time"}],"responses":{"200":{"description":"Successful PUT command","schema":{"$ref":"#/definitions/InvoiceApiDto"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"API Key authorization":["global"]}],"deprecated":false}},"/invoices/sales/issued":{"get":{"tags":["Invoices"],"summary":"Allow to get sales issued invoice list","operationId":"getInvoiceListUsingGET","produces":["*/*"],"parameters":[{"name":"asc","in":"query","description":"asc","required":false,"type":"boolean","default":true},{"name":"contractorNumbers","in":"query","description":"contractorNumbers","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"dateOfIssueFrom","in":"query","description":"dateOfIssueFrom","required":false,"type":"string","format":"date-time"},{"name":"dateOfIssueTo","in":"query","description":"dateOfIssueTo","required":false,"type":"string","format":"date-time"},{"name":"dateOfSaleFrom","in":"query","description":"dateOfSaleFrom","required":false,"type":"string","format":"date-time"},{"name":"dateOfSaleTo","in":"query","description":"dateOfSaleTo","required":false,"type":"string","format":"date-time"},{"name":"page","in":"query","description":"page","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"pageSize","required":false,"type":"integer","default":25,"format":"int32"},{"name":"showCostCenter","in":"query","description":"showCostCenter","required":false,"type":"boolean"},{"name":"showExchangeRate","in":"query","description":"showExchangeRate","required":false,"type":"boolean"},{"name":"sortBy","in":"query","description":"sortBy","required":false,"type":"string","default":"id","enum":["sellDate","issuanceDate","totalNet","totalTax","totalGross","calculatedPaymentTerm","totalPaidGross","outstandingToPay","status","id"]}],"responses":{"200":{"description":"Successful GET command","schema":{"$ref":"#/definitions/InvoiceApiList"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"API Key authorization":["global"]}],"deprecated":false}},"/loads":{"get":{"tags":["Client orders"],"summary":"Query and list loads","description":"

Filter properties with examples

\n \n\n

Sort properties

\n ","operationId":"listUsingGET","produces":["*/*"],"parameters":[{"name":"page","in":"query","description":"Results page you want to retrieve (0..N)","required":false,"type":"ref"},{"name":"query","in":"query","description":"RSQL query","required":false,"type":"string","allowEmptyValue":false,"x-example":"orderNumber == 01/01/2025"},{"name":"size","in":"query","description":"Number of records per page.","required":false,"type":"ref"},{"name":"sort","in":"query","description":"Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"Successful GET command","schema":{"$ref":"#/definitions/ClientOrderResponseList"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"API Key authorization":["global"]}],"deprecated":false},"post":{"tags":["Client orders"],"summary":"Allow to add new client orders","description":"API allows creating a load similar to the web application.\nLoad Structure Description\n\nA load consists of basic data and cargo handlings. Cargo handlings are simply points within the load, such as LOADING, ATTACH_SEMITRAILER, UNLOADING, and LEAVE_SEMITRAILER.Each load requires at least one pair of LOADING/ATTACH_SEMITRAILER and UNLOADING/LEAVE_SEMITRAILER.\nOnly LOADING and UNLOADING may contain cargo (transported goods).\n\nConstraints\n\nThe request body shares requirements with the web application.\nSubmitting a body with invalid constraints or missing required fields will result in a 400 BAD_REQUEST response.\nThere are exceptions—fields marked as \"required but accepted empty\" that, when left blank, will result in a load with DRAFT status, as indicated in the response message.\nA DRAFT load must be manually edited to fill in the missing data.\n\n\"Required but accepted empty\" fields:\n\n\n\n\n\n\n\n\n\n\n\n
FieldCondition
clientOrderNumberRequirement based on system configuration (not required by default)
client.taxIdif vatEuId is not given
client.vatEuIdif taxId is not given
client.contactPerson.firstNamefirst name of contact person. Must match given contractor's client first name
client.contactPerson.lastNamelast name of contact person. Must match given contractor's client last name
cargoHandlings.address.placeId if addressType is ID
cargoHandlings.address.zipCode if addressType is FULL or CMR
cargoHandlings.address.city if addressType is FULL or CMR
cargoHandlings.address.streetWithNumber if addressType is FULL
cargoHandlings.address.companyNameif addressType is FULL
cargoHandlings.cargos.adrClassif adr is true
requirements.semitrailerTypeOptional value for semitrailer
\n\nValidation\n\nLoads must pass validation, with some requirements depending on system configuration. Failing validation will result in a 422 UNPROCESSABLE_ENTITY response. Below is a list of such cases:\n- Trade credit: When the given client exceeds the configured trade credit and the system configuration specifies blocking load creation.\n- Contractor grade: When the client's grade is set to \"blocked\".\n- Corresponding cargos mismatch: When the loaded and unloaded goods do not sum up correctly, or any corresponding load-unload cargo differs in data (e.g., the loaded cargo 'BRICKS' is marked as 'XYZ' for load size, and unloaded as 'LDM' for size). Cargo must match within the same correlationId, if specified, and cargo linking is enabled\n- Non-existent client: When a client with the provided taxId or vatEuId does not exist.\n- Unknown currency code: When the currency code in price.currencyCode is unknown.\n- Non-existent unit: When a unit with the given unitName does not exist in the tenant's units dictionary.\n\nImportant: If any ATTACH_SEMITRAILER or LEAVE_SEMITRAILER cargo handling is present, the cargo summary will not be validated.\nIf restrictions on entering loads are configured and active, then in case of exceeding the limitations (price per km), an acceptance task is created for the new load.","operationId":"postClientOrderUsingPOST","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"allowClientOrderNumberDuplicates","in":"query","description":"allowClientOrderNumberDuplicates","required":false,"type":"boolean","default":true},{"in":"body","name":"dto","description":"dto","required":true,"schema":{"$ref":"#/definitions/PublicApiClientOrderDto"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ResponseEntity"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"API Key authorization":["global"]}],"deprecated":false}},"/loads/own":{"post":{"tags":["Client orders"],"summary":"Allow to add new own client orders","description":"Loads API allows to create own load similarly to the web application.\n\nLoad structure description\n\nLoad consists of basic data and cargo handlings. Cargo handlings are simply the points of the load. Load requires at least one pair of LOADING and UNLOADING. In this requirement ATTACH_SEMITRAILER counts as LOADING, and LEAVE_SEMITRAILER as UNLOADING.\n\nCargo handlings of type LOADING/UNLOADING may but doesn't need to contain cargos, which are the transported goods. All other types CANNOT have cargos.\n\nConstraints\n\nRequest body requires all fields that are required in the web application. Body with invalid constraints or missing required fields will result in 400 BAD_REQUEST. However, there are exceptions, where API allows creation without field that is required. Leaving \"required, but accepted empty\" fields blank will result in creating load in DRAFT status, so will be stated in response message. Such load must be edited manually to fill missing data.\n\nList of \"required, but accepted empty\" fields:\n- clientOrderNumber - which is required depending on tenants system configuration\n\nSome fields are CONDITIONALLY REQUIRED, which means that they are required in specific cases. Table of fields and requirement conditions:\n\n\n\n\n
FieldCondition
cargoHandlings.address.streetWithNumberif addressType is FULL
cargoHandlings.address.companyNameif addressType is FULL
cargoHandlings.cargos.adrClassif adr is true
requirements.semitrailerTypeOptional value for semitrailer
\n\nValidation\n\nLoads must pass validation, some of requirements depend on tenant's system configuration. Failing validation will result in 422 UNPROCESSABLE_ENTITY. List of failing situations:\n- Corresponding cargos aren't matching - if loaded and unloaded goods aren't summing up, or any of corresponding load-unload cargos differ in data (ex. loaded cargo 'BRICKS' is marked as 'XYZ' load size, and unloaded as 'LDM' size).\n\nImportant: if any ATTACH_SEMITRAILER or LEAVE_SEMITRAILER cargo handling is present, cargos summary won't be validated\n\nIf restrictions on entering loads are configured and active, then in case of exceeding the limitations (price per km), an acceptance task is created for the new load\nErrors\n\nSystem may return 422 UNPROCESSABLE_ENTITY in case of invalid data, like:\n\n- unknown currency code for price.currencyCode\n- unit with given unitName doesn't exist in tenant's units dictionary\n","operationId":"postOwnClientOrderUsingPOST","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"dto","description":"dto","required":true,"schema":{"$ref":"#/definitions/PublicApiOwnClientOrderDto"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ResponseEntity"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"API Key authorization":["global"]}],"deprecated":false}},"/loads/{loadId}":{"put":{"tags":["Client orders"],"summary":"Update load","description":"Update load. Same rules apply as with load creation","operationId":"updateUsingPUT","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"allowClientOrderNumberDuplicates","in":"query","required":false,"type":"boolean"},{"name":"loadId","in":"path","description":"loadId","required":true,"type":"string"},{"in":"body","name":"updateLoadRequest","description":"updateLoadRequest","required":true,"schema":{"$ref":"#/definitions/UpdateLoadRequest"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ResponseInfo"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"API Key authorization":["global"]}],"deprecated":false}},"/notes/credit/income":{"get":{"tags":["Notes"],"summary":"Allow to get income debit notes","operationId":"getIncomeCreditNotesUsingGET","produces":["*/*"],"parameters":[{"name":"asc","in":"query","description":"asc","required":false,"type":"boolean","default":true},{"name":"contractorNumbers","in":"query","description":"contractorNumbers","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"dateOfIssueFrom","in":"query","description":"dateOfIssueFrom","required":false,"type":"string","format":"date-time"},{"name":"dateOfIssueTo","in":"query","description":"dateOfIssueTo","required":false,"type":"string","format":"date-time"},{"name":"dateOfSalesFrom","in":"query","description":"dateOfSalesFrom","required":false,"type":"string","format":"date-time"},{"name":"dateOfSalesTo","in":"query","description":"dateOfSalesTo","required":false,"type":"string","format":"date-time"},{"name":"page","in":"query","description":"page","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"pageSize","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"sortBy","required":false,"type":"string","default":"id","enum":["sellDate","issuanceDate","totalNet","totalTax","totalGross","calculatedPaymentTerm","totalPaidGross","outstandingToPay","status","id"]}],"responses":{"200":{"description":"Successful GET command","schema":{"$ref":"#/definitions/SalesCreditNoteApiList"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"API Key authorization":["global"]}],"deprecated":false}},"/notes/debit/cost":{"get":{"tags":["Notes"],"summary":"Allow to get cost debit notes","operationId":"getCostDebitNotesUsingGET","produces":["*/*"],"parameters":[{"name":"asc","in":"query","description":"asc","required":false,"type":"boolean","default":true},{"name":"contractorNumbers","in":"query","description":"contractorNumbers","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"dateOfIssueFrom","in":"query","description":"dateOfIssueFrom","required":false,"type":"string","format":"date-time"},{"name":"dateOfIssueTo","in":"query","description":"dateOfIssueTo","required":false,"type":"string","format":"date-time"},{"name":"page","in":"query","description":"page","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"pageSize","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"sortBy","required":false,"type":"string","default":"id","enum":["sellDate","issuanceDate","totalNet","totalTax","totalGross","calculatedPaymentTerm","totalPaidGross","outstandingToPay","status","id"]}],"responses":{"200":{"description":"Successful GET command","schema":{"$ref":"#/definitions/CostDebitNoteApiList"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"API Key authorization":["global"]}],"deprecated":false}},"/notes/debit/income":{"get":{"tags":["Notes"],"summary":"Allow to get income debit notes","operationId":"getIncomeDebitNotesUsingGET","produces":["*/*"],"parameters":[{"name":"asc","in":"query","description":"asc","required":false,"type":"boolean","default":true},{"name":"contractorNumbers","in":"query","description":"contractorNumbers","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"dateOfIssueFrom","in":"query","description":"dateOfIssueFrom","required":false,"type":"string","format":"date-time"},{"name":"dateOfIssueTo","in":"query","description":"dateOfIssueTo","required":false,"type":"string","format":"date-time"},{"name":"page","in":"query","description":"page","required":false,"type":"integer","default":1,"format":"int32"},{"name":"pageSize","in":"query","description":"pageSize","required":false,"type":"integer","default":25,"format":"int32"},{"name":"sortBy","in":"query","description":"sortBy","required":false,"type":"string","default":"id","enum":["sellDate","issuanceDate","totalNet","totalTax","totalGross","calculatedPaymentTerm","totalPaidGross","outstandingToPay","status","id"]}],"responses":{"200":{"description":"Successful GET command","schema":{"$ref":"#/definitions/IncomeDebitNoteApiList"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"API Key authorization":["global"]}],"deprecated":false}},"/offers":{"post":{"tags":["Offers"],"summary":"Allow to create offer","operationId":"createOfferUsingPOST","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"offerDetails","description":"offerDetails","required":true,"schema":{"$ref":"#/definitions/CreateOfferDto"}}],"responses":{"200":{"description":"OK","schema":{"type":"object"}},"201":{"description":"Successful create command","schema":{"$ref":"#/definitions/CreateOfferResponse"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"API Key authorization":["global"]}],"deprecated":false}},"/offers/{tms-offer-id}":{"delete":{"tags":["Offers"],"summary":"Allow to delete offer","operationId":"deleteOfferUsingDELETE","produces":["*/*"],"parameters":[{"name":"tms-offer-id","in":"path","description":"tms-offer-id","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}},"204":{"description":"No Content"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"security":[{"API Key authorization":["global"]}],"deprecated":false}},"/offers/{tms-offer-id}/publications/{exchange-offer-id}":{"delete":{"tags":["Offers"],"summary":"Allow to delete publication of offer","operationId":"deletePublicationOnExchangeOfferUsingDELETE","produces":["*/*"],"parameters":[{"name":"exchange-offer-id","in":"path","description":"exchange-offer-id","required":true,"type":"string"},{"name":"tms-offer-id","in":"path","description":"tms-offer-id","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}},"204":{"description":"No Content"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}},"security":[{"API Key authorization":["global"]}],"deprecated":false}},"/offers/{tmsOfferId}":{"put":{"tags":["Offers"],"summary":"Allow to update offer","operationId":"updateOfferUsingPUT","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"tmsOfferId","in":"path","description":"tmsOfferId","required":true,"type":"string"},{"in":"body","name":"updateOfferRequest","description":"updateOfferRequest","required":true,"schema":{"$ref":"#/definitions/UpdateOfferRequest"}}],"responses":{"200":{"description":"OK"},"201":{"description":"Successful update command"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"API Key authorization":["global"]}],"deprecated":false}},"/offers/{tmsOfferId}/publications/{exchangeOfferId}":{"put":{"tags":["Offers"],"summary":"Allow to update offer publications","operationId":"updateOfferUsingPUT_1","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"exchangeOfferId","in":"path","description":"exchangeOfferId","required":true,"type":"string"},{"name":"tmsOfferId","in":"path","description":"tmsOfferId","required":true,"type":"string"},{"in":"body","name":"updateOfferPublicationRequest","description":"updateOfferPublicationRequest","required":true,"schema":{"$ref":"#/definitions/UpdateOfferPublicationRequest"}}],"responses":{"200":{"description":"OK"},"201":{"description":"Successful update command"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"API Key authorization":["global"]}],"deprecated":false}},"/orders":{"get":{"tags":["Orders"],"summary":"Query and list carrier, transport and inhouse orders","description":"

Filters with usage example. Multiple filters must be separated by comma

\n

Sortable properties

","operationId":"listUsingGET_7","produces":["*/*"],"parameters":[{"name":"page","in":"query","description":"Results page you want to retrieve (0..N)","required":false,"type":"ref"},{"name":"query","in":"query","description":"RSQL query","required":false,"type":"string","allowEmptyValue":false,"x-example":"carrierPrice > '100 EUR', creationDate > 2025-01-01, creationDate < 2026-01-01, orderNumber == 01/01"},{"name":"size","in":"query","description":"Number of records per page.","required":false,"type":"ref"},{"name":"sort","in":"query","description":"Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"Successful GET command","schema":{"$ref":"#/definitions/OrderList"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"API Key authorization":["global"]}],"deprecated":false}},"/payment":{"put":{"tags":["Payments"],"summary":"Allow to mark payments","operationId":"markPaymentUsingPUT","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"markPaymentDto","description":"markPaymentDto","required":true,"schema":{"$ref":"#/definitions/MarkPaymentDto"}}],"responses":{"200":{"description":"Successful PUT command","schema":{"$ref":"#/definitions/MarkPaymentResponseDto"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"API Key authorization":["global"]}],"deprecated":false}},"/purchase-service-type":{"get":{"tags":["Purchase service type"],"summary":"Query and list purchase service types","description":"

Filters with usage example. Multiple filters must be separated by comma

\n","operationId":"listUsingGET_8","produces":["*/*"],"parameters":[{"name":"page","in":"query","description":"Results page you want to retrieve (0..N)","required":false,"type":"ref"},{"name":"query","in":"query","description":"RSQL query","required":false,"type":"string","allowEmptyValue":false,"x-example":"name == \"Transport service\""},{"name":"size","in":"query","description":"Number of records per page.","required":false,"type":"ref"}],"responses":{"200":{"description":"Successful GET command","schema":{"$ref":"#/definitions/PurchaseServiceTypeResponseList"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"API Key authorization":["global"]}],"deprecated":false}},"/purchase-tax-rates":{"get":{"tags":["Purchase VAT rates"],"summary":"Query and list purchase VAT rates","description":"

Filters with usage example. Multiple filters must be separated by comma

\n","operationId":"listUsingGET_9","produces":["*/*"],"parameters":[{"name":"page","in":"query","description":"Results page you want to retrieve (0..N)","required":false,"type":"ref"},{"name":"query","in":"query","description":"RSQL query","required":false,"type":"string","allowEmptyValue":false,"x-example":"name == \"23%\""},{"name":"size","in":"query","description":"Number of records per page.","required":false,"type":"ref"}],"responses":{"200":{"description":"Successful GET command","schema":{"$ref":"#/definitions/PurchaseTaxRateResponseList"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"API Key authorization":["global"]}],"deprecated":false}},"/transport-order":{"post":{"tags":["Orders"],"summary":"Create transport order","description":"Create confirmed transport order. Route points are automatically sorted based on date and time. If truck is provided, semitrailer and drivers are automatically updated based on default transport set. Total cost is calculated based on truck parameters. Initial truck position is automatically selected. Order may not be confirmed, if a confirmation request is required by an account administrator","operationId":"createTransportOrderUsingPOST","consumes":["application/json"],"produces":["*/*"],"parameters":[{"in":"body","name":"request","description":"request","required":true,"schema":{"$ref":"#/definitions/CreateTransportOrderRequest"}}],"responses":{"201":{"description":"Created","schema":{"$ref":"#/definitions/CreateTransportOrderResponse"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"API Key authorization":["global"]}],"deprecated":false}},"/unit-of-measure":{"get":{"tags":["Units of measure"],"summary":"Query and list purchase service types","description":"

Filters with usage example. Multiple filters must be separated by comma

\n","operationId":"listUsingGET_10","produces":["*/*"],"parameters":[{"name":"page","in":"query","description":"Results page you want to retrieve (0..N)","required":false,"type":"ref"},{"name":"query","in":"query","description":"RSQL query","required":false,"type":"string","allowEmptyValue":false,"x-example":"searchField == \"Big-Bag\""},{"name":"size","in":"query","description":"Number of records per page.","required":false,"type":"ref"}],"responses":{"200":{"description":"Successful GET command","schema":{"$ref":"#/definitions/UnitOfMeasureResponseList"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"security":[{"API Key authorization":["global"]}],"deprecated":false}}},"securityDefinitions":{"API Key authorization":{"type":"apiKey","name":"apikey","in":"header"}},"definitions":{"AccountingDocumentItemApiDto":{"type":"object","properties":{"comment":{"type":"string","example":"comment"},"correctiveItemType":{"type":"string","example":"BEFORE_CORRECTION","enum":["BEFORE_CORRECTION","AFTER_CORRECTION"]},"currencyConversion":{"type":"boolean","example":false},"currencyExchangeRate":{"type":"number","example":4.26},"currencyTableDate":{"type":"string","format":"date","example":"2019-06-21"},"currencyTableNumber":{"type":"string","example":"119/A/NBP/2019"},"expense":{"$ref":"#/definitions/ObjectRefApiDto"},"moneyInOriginalCurrency":{"$ref":"#/definitions/InvoiceItemMoneyApiDto"},"moneyInTargetCurrency":{"$ref":"#/definitions/InvoiceItemMoneyApiDto"},"quantity":{"type":"number","example":1.0},"salesServiceTypeCode":{"type":"string","example":"GTU_13"},"serviceTypeName":{"type":"string","example":"Usługa transportowa"},"taxRate":{"$ref":"#/definitions/TaxRateApiDto"},"transportServiceData":{"$ref":"#/definitions/TransportServiceApiDto"},"unitOfMeasure":{"type":"string","example":"Europaleta"}},"title":"AccountingDocumentItemApiDto"},"AddressApiDto":{"type":"object","properties":{"area":{"type":"string","example":"śląskie"},"city":{"type":"string","example":"Katowice"},"countryCode":{"type":"string","example":"PL"},"normalizedZipCode":{"type":"string","example":"PL40225"},"originalZipCode":{"type":"string","example":"40-225"},"streetWithNumber":{"type":"string","example":"3-go Maja 10"}},"title":"AddressApiDto"},"AddressDto":{"type":"object","properties":{"area":{"type":"string","example":"śląskie"},"city":{"type":"string","example":"Katowice"},"countryCode":{"type":"string","example":"PL"},"defined":{"type":"boolean"},"streetWithNumber":{"type":"string","example":"3-go Maja 10"},"zipCode":{"type":"string","example":"PL40225"}},"title":"AddressDto"},"BankAccountApiDto":{"type":"object","properties":{"accountOwner":{"type":"string","example":"Jan Kowalski"},"bankCode":{"type":"string","example":12345678},"bankName":{"type":"string","example":"ING"},"currency":{"type":"string","example":"PLN"},"iban":{"type":"string","example":"PL61109010140000071219812874"},"number":{"type":"string","example":1234567890},"swift":{"type":"string","example":"ABCDPLPK"}},"title":"BankAccountApiDto"},"BankAccountResponse":{"type":"object","properties":{"accountNumber":{"type":"string"},"accountOwner":{"type":"string"},"bankCode":{"type":"string"},"bankName":{"type":"string"},"currencyCode":{"type":"string","example":"PL"},"defaultAccount":{"type":"boolean"},"iban":{"type":"string"},"id":{"type":"string","example":"b9bc1394-6692-463b-85f7-f96bac02c461"},"swift":{"type":"string"}},"title":"BankAccountResponse"},"ClientOrderResponse":{"type":"object","properties":{"assignedClientOrderContactPerson":{"type":"string"},"assignedIssuedOrderCostShare":{"type":"string"},"cargoNamesWithDescriptions":{"type":"string"},"carrierOrderNumber":{"type":"string"},"carrierShortName":{"type":"string"},"carrierVatEuId":{"type":"string"},"client":{"type":"string"},"clientSideOrderNumber":{"type":"string"},"costCenterName":{"type":"string"},"department":{"type":"string"},"dimensions":{"type":"string"},"externalSupplierVatEuId":{"type":"string"},"id":{"type":"string"},"loadingsDescr":{"type":"string"},"orderCreateDate":{"type":"string","format":"date-time"},"orderNumber":{"type":"string"},"payerSum":{"type":"string"},"publicationOnExchange":{"type":"string"},"purchaseInvoiceNumber":{"type":"string"},"salesInvoiceNumber":{"type":"string"},"semitrailerRegistrationNumber":{"type":"string"},"speditor":{"type":"string"},"statusDescription":{"type":"string"},"tags":{"type":"string"},"totalLdm":{"type":"string"},"totalWeight":{"type":"string"},"truckRegistrationNumber":{"type":"string"},"unloadingsDescr":{"type":"string"}},"title":"ClientOrderResponse"},"ClientOrderResponseList":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/definitions/ClientOrderResponse"}},"maxPageNumber":{"type":"integer","format":"int32"},"paging":{"$ref":"#/definitions/Paging"},"totalItems":{"type":"integer","format":"int32"}},"title":"ClientOrderResponseList"},"ContactPersonApiDto":{"type":"object","properties":{"email":{"type":"string","example":"jk@jk.pl"},"firstName":{"type":"string","example":"Jan"},"lastName":{"type":"string","example":"Kowalski"},"mobile":{"type":"string","example":"(48) 897413453"},"phone":{"type":"string","example":"(48) 897413453"}},"title":"ContactPersonApiDto"},"ContactPersonDto":{"type":"object","properties":{"email":{"type":"string","example":"example@firetms.com"},"email2":{"type":"string","example":"example@firetms.com"},"email3":{"type":"string","example":"example@firetms.com"},"fax":{"type":"string","example":"123-123-123"},"firstName":{"type":"string","example":"Jan"},"lastName":{"type":"string","example":"Kowalski"},"mainContactPerson":{"type":"boolean","example":true},"mobile":{"type":"string","example":"+48 123-123-123"},"phone":{"type":"string","example":"123-123-123"},"position":{"type":"string","example":"driver"},"transEuId":{"type":"string","example":101}},"title":"ContactPersonDto"},"ContractorApiList":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/definitions/PublicApiAccountingContractorDto"}},"paging":{"$ref":"#/definitions/PublicApiPaging"},"totalItems":{"type":"integer","format":"int32"}},"title":"ContractorApiList"},"ContractorBankAccountResponseList":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/definitions/BankAccountResponse"}},"maxPageNumber":{"type":"integer","format":"int32"},"paging":{"$ref":"#/definitions/Paging"},"totalItems":{"type":"integer","format":"int32"}},"title":"ContractorBankAccountResponseList"},"Coordinate":{"type":"object","properties":{"latitude":{"type":"number","format":"double"},"longitude":{"type":"number","format":"double"}},"title":"Coordinate"},"CorrespondenceDataApiDto":{"type":"object","properties":{"correspondenceMethod":{"type":"string","example":"POST","enum":["POST","EMAIL"]},"correspondenceStatus":{"type":"string","example":"DELIVERED","enum":["SENT","DELIVERED","DELIVERY_FAILED","RETURNED"]},"lastStatus":{"type":"string","example":"SENT"},"postProvider":{"type":"string","example":"POLISH_POST","enum":["POLISH_POST","GLS"]},"postingDate":{"type":"string","format":"date","example":"2019-08-17"},"receiptDate":{"type":"string","format":"date","example":"2019-08-20"},"trackingNumber":{"type":"string","example":23243424646}},"title":"CorrespondenceDataApiDto"},"CostDebitNoteApiList":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/definitions/PurchaseAccountingNoteApiDto"}},"maxPageNumber":{"type":"integer","format":"int32"},"paging":{"$ref":"#/definitions/Paging"},"totalItems":{"type":"integer","format":"int32"}},"title":"CostDebitNoteApiList"},"CreateContractorRequest":{"type":"object","properties":{"contactPersons":{"type":"array","items":{"$ref":"#/definitions/ContactPersonDto"}},"name":{"type":"string","example":"Contractor name"},"officialArea":{"type":"string","example":"Official area"},"paymentTermForCarrier":{"$ref":"#/definitions/PaymentTermApiDto"},"paymentTermForClient":{"$ref":"#/definitions/PaymentTermApiDto"},"primaryAddress":{"$ref":"#/definitions/AddressApiDto"},"regon":{"type":"string","example":123456789},"shortName":{"type":"string","example":"Short name"},"subOfficialArea":{"type":"string","example":"Sub official area"},"taxId":{"type":"string","example":123456789},"timocomId":{"type":"string","example":1},"transEuId":{"type":"string","example":1},"vatEuId":{"type":"string","example":987654321}},"title":"CreateContractorRequest"},"CreateDepartmentRequest":{"type":"object","properties":{"address":{"$ref":"#/definitions/AddressApiDto"},"availableCurrencies":{"type":"array","example":["PLN"],"items":{"type":"string"}},"carrierOrderRemarks":{"type":"array","items":{"$ref":"#/definitions/RemarkApiDto"}},"changeInvoiceIssuanceDatePermissions":{"type":"boolean"},"clientOrderRemarks":{"type":"array","items":{"$ref":"#/definitions/RemarkApiDto"}},"commencementDate":{"type":"string","format":"date-time"},"companyName":{"type":"string","example":"fireTMS"},"debitNoteRemarks":{"type":"array","items":{"$ref":"#/definitions/RemarkApiDto"}},"description":{"type":"string","example":"Description"},"docNumberGroupingCode":{"type":"string","example":"MD"},"fax":{"type":"string","example":"123123123"},"invoiceRemarks":{"type":"array","items":{"$ref":"#/definitions/RemarkApiDto"}},"issuanceDateValidation":{"type":"boolean"},"name":{"type":"string","example":"Main department"},"nativeCurrency":{"type":"string","example":"PLN"},"phone":{"type":"string","example":"+48123123123"},"placeOfInvoiceIssue":{"type":"string","example":"Rybnik"},"placeOfOrderIssue":{"type":"string","example":"Rybnik"},"regon":{"type":"string","example":"382380050"},"sellingDepartmentId":{"type":"string","example":"b9bc1394-6692-463b-85f7-f96bac02c461"},"taxId":{"type":"string","example":"8961583774"},"vatEuId":{"type":"string","example":"0000767863"}},"title":"CreateDepartmentRequest"},"CreateOfferDto":{"type":"object","properties":{"exchangeDetails":{"$ref":"#/definitions/PublicApiPublicationOnExchangeDetailsDto"},"offer":{"$ref":"#/definitions/PublicApiOfferDto"}},"title":"CreateOfferDto"},"CreateOfferResponse":{"type":"object","properties":{"exchangeOfferId":{"type":"string","example":"a6017ca9-efa1-4540-959e-591d4004c858"},"tmsOfferId":{"type":"string","example":"a52ce181-b978-4dfc-bf88-133b658afcc9"}},"title":"CreateOfferResponse"},"CreatePurchaseInvoiceRequest":{"type":"object","properties":{"comment":{"type":"string","example":"Invoice comment"},"currency":{"type":"string","example":"EUR"},"departmentId":{"type":"string","example":"56c52cba-10a0-41c4-9637-4da7f746e8f9"},"discount":{"type":"number","example":10.0},"documentNumber":{"type":"string","example":"FAK/01/01/2025"},"eInvoiceSystemMetadata":{"$ref":"#/definitions/EInvoiceSystemMetadata"},"issueDate":{"type":"string","format":"date-time"},"items":{"type":"array","items":{"$ref":"#/definitions/Item"}},"loads":{"type":"array","example":["aa91a507-84b3-4817-98c3-4c1eb4dd5730"],"items":{"type":"string"}},"orders":{"type":"array","example":["3cb7c369-3523-4ceb-b67c-9f7706c3bbb2"],"items":{"type":"string"}},"payerId":{"type":"string","example":"56c52cba-10a0-41c4-9637-4da7f746e8f9"},"paymentMethod":{"type":"string","enum":["BANK_TRANSFER","CASH","DEBIT","STANDING_ORDER","CARD","BLIK","OTHER"]},"paymentTerm":{"$ref":"#/definitions/PaymentTermApiDto"},"receiptDate":{"type":"string","format":"date-time"},"saleDate":{"type":"string","format":"date-time"},"sellerBankAccountId":{"type":"string","example":"fda21973-4e83-468f-923f-ade42cbf80fe"},"sellerId":{"type":"string","example":"b2dd77ab-6c4b-4a3e-86a1-aa42ae4eba59"}},"title":"CreatePurchaseInvoiceRequest"},"CreateTransportOrderRequest":{"type":"object","properties":{"loadIds":{"type":"array","example":["fe9b5b2d-956f-45d7-bafd-8d8351c346c1"],"items":{"type":"string"}},"truckId":{"type":"string","example":"b9bc1394-6692-463b-85f7-f96bac02c461"}},"title":"CreateTransportOrderRequest"},"CreateTransportOrderResponse":{"type":"object","properties":{"id":{"type":"string","example":"b9bc1394-6692-463b-85f7-f96bac02c461"},"orderNumber":{"type":"string","example":"01/01/2026"}},"title":"CreateTransportOrderResponse"},"Currency":{"type":"object","properties":{"code":{"type":"string"},"idColumnValue":{"type":"integer","format":"int64"},"name":{"type":"string"},"uniqueIdentifier":{"type":"object"}},"title":"Currency"},"CurrencyRate":{"type":"object","properties":{"currency":{"type":"string"},"rate":{"type":"number"}},"title":"CurrencyRate"},"CurrencyTableResponse":{"type":"object","properties":{"authority":{"type":"string","enum":["CNB","NBP","NBR","ECB","HCB","NBRB","NBU","BNM"]},"currencyRates":{"type":"array","items":{"$ref":"#/definitions/CurrencyRate"}},"default":{"type":"boolean"},"id":{"type":"string"},"tableDate":{"type":"string","format":"date"},"tableNumber":{"type":"string"}},"title":"CurrencyTableResponse"},"CurrencyTableResponseList":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/definitions/CurrencyTableResponse"}},"maxPageNumber":{"type":"integer","format":"int32"},"paging":{"$ref":"#/definitions/Paging"},"totalItems":{"type":"integer","format":"int32"}},"title":"CurrencyTableResponseList"},"DebitNoteApiDto":{"type":"object","properties":{"calculatedPaymentTerm":{"type":"string","format":"date-time","example":"2019-09-21T09:17:22.775+02:00"},"correspondenceData":{"$ref":"#/definitions/CorrespondenceDataApiDto"},"documentConfirmationDate":{"type":"string","format":"date-time","example":"2021-09-10T15:32:11.978+02:00"},"documentId":{"type":"string","example":"SI:0872cef0-1749-4e20-8507-9d966f0292d3"},"documentNumber":{"type":"string","example":"0002/06/2019"},"issuanceDate":{"type":"string","format":"date-time","example":"2019-08-22T09:17:22.775+02:00"},"issuer":{"$ref":"#/definitions/LegalEntityApiDto"},"items":{"type":"array","items":{"$ref":"#/definitions/DebitNoteItemApiDto"}},"outstandingToPay":{"$ref":"#/definitions/MoneyDto"},"payer":{"$ref":"#/definitions/LegalEntityApiDto"},"payerBankAccountData":{"$ref":"#/definitions/BankAccountApiDto"},"payerOriginalCurrencyBankAccountData":{"$ref":"#/definitions/BankAccountApiDto"},"paymentMethod":{"type":"string","example":"BANK_TRANSFER","enum":["BANK_TRANSFER","CASH","DEBIT","STANDING_ORDER","CARD","BLIK","OTHER"]},"paymentTerm":{"$ref":"#/definitions/PaymentTermApiDto"},"recipient":{"$ref":"#/definitions/LegalEntityApiDto"},"relatedDataNumbers":{"type":"string","example":"ZL/003/06/2019"},"status":{"type":"string","example":"CONFIRMED","enum":["REMOVABLE_DRAFT","NEW","NEW_CANCELED","CONFIRMED","PAID","CANCELED","REISSUED_AFTER_CANCELLATION","CORRECTED","CORRECTED_PAID","CANCELED_AS_CORRECTED_TO_ZERO"]},"total":{"$ref":"#/definitions/MoneyDto"},"totalInOriginalCurrency":{"$ref":"#/definitions/MoneyDto"},"totalPaid":{"$ref":"#/definitions/MoneyDto"}},"title":"DebitNoteApiDto"},"DebitNoteItemApiDto":{"type":"object","properties":{"comment":{"type":"string","example":"Rekompensata za uszkodzenie"},"content":{"type":"string","example":"Rekompensata"},"currencyRate":{"type":"number","example":1.15},"moneyInOriginalCurrency":{"$ref":"#/definitions/MoneyDto"},"moneyInTargetCurrency":{"$ref":"#/definitions/MoneyDto"},"serviceTypeName":{"type":"string","example":"Transport"}},"title":"DebitNoteItemApiDto"},"DepartmentDetailedResponse":{"type":"object","properties":{"address":{"$ref":"#/definitions/AddressApiDto"},"availableCurrencies":{"type":"array","example":["PLN"],"items":{"type":"string"}},"changeInvoiceIssuanceDatePermissions":{"type":"boolean"},"commencementDate":{"type":"string","format":"date-time"},"companyName":{"type":"string","example":"fireTMS"},"countryCode":{"type":"string","example":"PL"},"departmentId":{"type":"string","example":"b9bc1394-6692-463b-85f7-f96bac02c461"},"description":{"type":"string","example":"Description"},"docNumberGroupingCode":{"type":"string","example":"MD"},"fax":{"type":"string","example":"123123123"},"issuanceDateValidation":{"type":"boolean"},"name":{"type":"string","example":"Main department"},"nativeCurrency":{"example":"PLN","$ref":"#/definitions/Currency"},"phone":{"type":"string","example":"+48123123123"},"placeOfInvoiceIssue":{"type":"string","example":"Rybnik"},"placeOfOrderIssue":{"type":"string","example":"Rybnik"},"regon":{"type":"string","example":"382380050"},"sellingDepartmentId":{"type":"string","example":"b9bc1394-6692-463b-85f7-f96bac02c461"},"taxId":{"type":"string","example":"8961583774"},"vatEuId":{"type":"string","example":"0000767863"}},"title":"DepartmentDetailedResponse"},"DepartmentResponse":{"type":"object","properties":{"companyName":{"type":"string","example":"fireTMS"},"countryCode":{"type":"string","example":"PL"},"description":{"type":"string","example":"Main department description"},"docNumberGroupingCode":{"type":"string","example":"MD"},"id":{"type":"string","example":"b9bc1394-6692-463b-85f7-f96bac02c461"},"name":{"type":"string","example":"Main department"},"nativeCurrency":{"type":"string","example":"PLN"},"regon":{"type":"string","example":"382380050"},"taxId":{"type":"string","example":"8961583774"},"vatEuId":{"type":"string","example":"0000767863"}},"title":"DepartmentResponse"},"DepartmentResponseList":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/definitions/DepartmentResponse"}},"maxPageNumber":{"type":"integer","format":"int32"},"paging":{"$ref":"#/definitions/Paging"},"totalItems":{"type":"integer","format":"int32"}},"title":"DepartmentResponseList"},"EInvoiceSystemMetadata":{"type":"object","properties":{"eInvoiceSystemType":{"type":"string","example":"KSEF","enum":["KSEF"]},"number":{"type":"string","example":"9999999999-IZ202602-FFFFFFFFFFFF-FF"}},"title":"EInvoiceSystemMetadata"},"ExpenseAssignment":{"type":"object","properties":{"assignedToType":{"type":"string","enum":["TRUCK","SEMITRAILER","DRIVER"]},"expenseForId":{"type":"string","example":"6153f35b-7932-4404-922a-3c8d542596b3"}},"title":"ExpenseAssignment"},"IncomeDebitNoteApiList":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/definitions/DebitNoteApiDto"}},"maxPageNumber":{"type":"integer","format":"int32"},"paging":{"$ref":"#/definitions/Paging"},"totalItems":{"type":"integer","format":"int32"}},"title":"IncomeDebitNoteApiList"},"InternalDriverResponse":{"type":"object","properties":{"dateOfEmployment":{"type":"string","format":"date-time"},"driverAppEnabled":{"type":"boolean"},"id":{"type":"string","example":"b9bc1394-6692-463b-85f7-f96bac02c461"},"name":{"type":"string"},"passportNumber":{"type":"string"},"personalId":{"type":"string"},"phoneNumber":{"type":"string"}},"title":"InternalDriverResponse"},"InternalDriverResponseList":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/definitions/InternalDriverResponse"}},"maxPageNumber":{"type":"integer","format":"int32"},"paging":{"$ref":"#/definitions/Paging"},"totalItems":{"type":"integer","format":"int32"}},"title":"InternalDriverResponseList"},"InternalSemitrailerResponse":{"type":"object","properties":{"id":{"type":"string","example":"b9bc1394-6692-463b-85f7-f96bac02c461"},"regNumber":{"type":"string","example":"SR12345"},"type":{"type":"string","example":"b9bc1394-6692-463b-85f7-f96bac02c461"}},"title":"InternalSemitrailerResponse"},"InternalSemitrailerResponseList":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/definitions/InternalSemitrailerResponse"}},"maxPageNumber":{"type":"integer","format":"int32"},"paging":{"$ref":"#/definitions/Paging"},"totalItems":{"type":"integer","format":"int32"}},"title":"InternalSemitrailerResponseList"},"InternalTransportExpenseResponse":{"type":"object","properties":{"cost":{"type":"number","example":10.0},"currency":{"type":"string","example":"PLN"},"date":{"type":"string","format":"date-time"},"documentNumber":{"type":"string","example":"01/01/25"},"expenseType":{"type":"string","example":"Food"},"fuelAmount":{"type":"number","example":200.0},"id":{"type":"string","example":"b9bc1394-6692-463b-85f7-f96bac02c461"},"kilometerLog":{"type":"integer","format":"int32","example":2000},"routeCardNumber":{"type":"string","example":"RC12345"},"sourceDocumentNumber":{"type":"string","example":"RC12/34/5"},"transportSetSubject":{"$ref":"#/definitions/TransportSetSubject"}},"title":"InternalTransportExpenseResponse"},"InternalTransportExpenseResponseList":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/definitions/InternalTransportExpenseResponseRoot"}},"maxPageNumber":{"type":"integer","format":"int32"},"paging":{"$ref":"#/definitions/Paging"},"totalItems":{"type":"integer","format":"int32"}},"title":"InternalTransportExpenseResponseList"},"InternalTransportExpenseResponseRoot":{"type":"object","properties":{"children":{"type":"array","items":{"$ref":"#/definitions/InternalTransportExpenseResponse"}},"contractorId":{"type":"string","example":"b9bc1394-6692-463b-85f7-f96bac02c461"},"cost":{"type":"number","example":10.0},"currency":{"type":"string","example":"PLN"},"date":{"type":"string","format":"date-time"},"description":{"type":"string","example":"description"},"documentNumber":{"type":"string","example":"01/01/25"},"expenseType":{"type":"string","example":"Food"},"fuelAmount":{"type":"number","example":200.0},"id":{"type":"string","example":"b9bc1394-6692-463b-85f7-f96bac02c461"},"kilometerLog":{"type":"integer","format":"int32","example":2000},"routeCardNumber":{"type":"string","example":"RC12345"},"sourceDocumentNumber":{"type":"string","example":"RC12/34/5"},"transportSetSubject":{"$ref":"#/definitions/TransportSetSubject"}},"title":"InternalTransportExpenseResponseRoot"},"InternalTruckResponse":{"type":"object","properties":{"adr":{"type":"boolean"},"atsDeviceId":{"type":"string"},"depot":{"type":"string"},"driverAppEnabled":{"type":"boolean"},"id":{"type":"string","example":"b9bc1394-6692-463b-85f7-f96bac02c461"},"numberOfPallets":{"type":"integer","format":"int32"},"phoneNumber":{"type":"string"},"regNumber":{"type":"string","example":"SR12345"},"truckGroupName":{"type":"string"},"vehicleSideNumber":{"type":"string"}},"title":"InternalTruckResponse"},"InternalTruckResponseList":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/definitions/InternalTruckResponse"}},"maxPageNumber":{"type":"integer","format":"int32"},"paging":{"$ref":"#/definitions/Paging"},"totalItems":{"type":"integer","format":"int32"}},"title":"InternalTruckResponseList"},"InvoiceApiDto":{"type":"object","properties":{"bankAccount":{"$ref":"#/definitions/BankAccountApiDto"},"calculatedPaymentTerm":{"type":"string","format":"date-time","example":"2019-06-30T08:23:08.087+02:00"},"client":{"$ref":"#/definitions/LegalEntityApiDto"},"comment":{"type":"string","example":"my comment"},"correctedDocumentId":{"type":"string","example":"SI:8ea06470-e435-422e-babf-0efb3483382e"},"correctedDocumentNumber":{"type":"string","example":"0001/04/2019"},"correspondenceData":{"$ref":"#/definitions/CorrespondenceDataApiDto"},"costCenter":{"type":"string","example":"my cost center"},"documentId":{"type":"string","example":"SI:0872cef0-1749-4e20-8507-9d966f0292d3"},"documentNumber":{"type":"string","example":"0002/06/2019"},"exportedInvoiceFileNames":{"type":"array","example":["invoice.pdf"],"description":"List of files imported as invoices","items":{"type":"string"}},"issuanceDate":{"type":"string","format":"date-time","example":"2019-06-28T08:21:08.087+02:00"},"items":{"type":"array","items":{"$ref":"#/definitions/AccountingDocumentItemApiDto"}},"ksefNumber":{"example":"Ksef data","$ref":"#/definitions/KsefDataApiDto"},"originalCurrencyBankAccount":{"$ref":"#/definitions/BankAccountApiDto"},"outstandingToPay":{"$ref":"#/definitions/MoneyDto"},"payer":{"$ref":"#/definitions/LegalEntityApiDto"},"paymentMethod":{"type":"string","example":"BANK_TRANSFER","enum":["BANK_TRANSFER","CASH","DEBIT","STANDING_ORDER","CARD","BLIK","OTHER"]},"paymentTerm":{"$ref":"#/definitions/PaymentTermApiDto"},"receptionDate":{"type":"string","format":"date-time","example":"2019-06-27T08:22:08.087+02:00"},"relatedOrderNumber":{"type":"string","example":"ZL/003/06/2019"},"sellDate":{"type":"string","format":"date-time","example":"2019-06-29T08:20:08.087+02:00"},"seller":{"$ref":"#/definitions/LegalEntityApiDto"},"splitPayment":{"type":"boolean"},"splitPaymentBankAccount":{"$ref":"#/definitions/BankAccountApiDto"},"status":{"type":"string","example":"ISSUED","enum":["DRAFT","ISSUED","PAID","CORRECTED","CORRECTED_PAID","CANCELED_AS_CORRECTED_TO_ZERO","REGISTERED","CANCELED"]},"taxRateSummaries":{"type":"array","items":{"$ref":"#/definitions/TaxRateSummaryApiDto"}},"totalGross":{"$ref":"#/definitions/MoneyDto"},"totalNet":{"$ref":"#/definitions/MoneyDto"},"totalTax":{"$ref":"#/definitions/MoneyDto"}},"title":"InvoiceApiDto"},"InvoiceApiList":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/definitions/InvoiceApiDto"}},"maxPageNumber":{"type":"integer","format":"int32"},"paging":{"$ref":"#/definitions/Paging"},"totalItems":{"type":"integer","format":"int32"}},"title":"InvoiceApiList"},"InvoiceItemMoneyApiDto":{"type":"object","properties":{"totalPriceGross":{"$ref":"#/definitions/MoneyDto"},"totalPriceNet":{"$ref":"#/definitions/MoneyDto"},"totalTax":{"$ref":"#/definitions/MoneyDto"},"unitPriceNet":{"$ref":"#/definitions/MoneyDto"}},"title":"InvoiceItemMoneyApiDto"},"Item":{"type":"object","properties":{"amount":{"$ref":"#/definitions/Money"},"comment":{"type":"string","example":"Item comment"},"currencyTableId":{"type":"string","example":"d16ff822-1ed6-4f6e-b864-8f857fac35a7"},"expenseFor":{"$ref":"#/definitions/ExpenseAssignment"},"orders":{"type":"array","example":["3cb7c369-3523-4ceb-b67c-9f7706c3bbb2"],"items":{"type":"string"}},"quantity":{"type":"number","example":1.0},"serviceId":{"type":"string","example":"30a6b545-5433-432d-bc81-1df57ff2b7d0"},"taxRateId":{"type":"string","example":"51d9a540-64cc-48a7-b867-26afb44ebbc5"},"unitOfMeasureId":{"type":"string","example":"e39cd3b9-0648-4971-ab31-7b147a791f64"}},"title":"Item"},"KsefDataApiDto":{"type":"object","properties":{"issueDate":{"type":"string","format":"date-time","example":"2019-06-28T08:21:08.087+02:00"},"number":{"type":"string","example":"9999999999-IZ202602-FFFFFFFFFFFF-FF"}},"title":"KsefDataApiDto"},"LegalEntityApiDto":{"type":"object","properties":{"companyName":{"type":"string","example":"Agm Group Sp.z.o.o"},"contact":{"type":"string","example":"Jan Kowalski"},"contractorNumber":{"type":"string","example":"FK"},"correspondenceAddress":{"$ref":"#/definitions/AddressDto"},"correspondenceAddressDifferentThanPrimary":{"type":"boolean","example":false},"costLedgerAccountNumber":{"type":"string"},"description":{"type":"string","example":"Agm Group Sp.z.o.o - 3-go Maja 10, Katowice, 40-000"},"primaryAddress":{"$ref":"#/definitions/AddressDto"},"revenueLedgerAccountNumber":{"type":"string"},"taxId":{"$ref":"#/definitions/TaxIdApiDto"},"vatEuId":{"$ref":"#/definitions/VatEuIdApiDto"}},"title":"LegalEntityApiDto"},"MarkPaymentDto":{"type":"object","properties":{"dateOfPayment":{"type":"string","format":"date-time"},"invoiceId":{"type":"string","example":"SI:8ea06470-e435-422e-babf-0efb3483382e"},"totalGross":{"$ref":"#/definitions/MoneyDto"},"totalNet":{"$ref":"#/definitions/MoneyDto"},"totalTax":{"$ref":"#/definitions/MoneyDto"}},"title":"MarkPaymentDto"},"MarkPaymentResponseDto":{"type":"object","properties":{"error":{"type":"string","example":"Could not mark payment"},"invoiceId":{"type":"string","example":"SI:8ea06470-e435-422e-babf-0efb3483382e"},"toPay":{"$ref":"#/definitions/MoneyDto"}},"title":"MarkPaymentResponseDto"},"Money":{"type":"object","properties":{"amount":{"type":"number","example":10500.0},"currencyCode":{"type":"string","example":"EUR"}},"title":"Money"},"MoneyDto":{"type":"object","properties":{"amount":{"type":"number","example":10500.0},"currencyCode":{"type":"string","example":"EUR"}},"title":"MoneyDto"},"ObjectRefApiDto":{"type":"object","properties":{"type":{"type":"string","example":"VEHICLE","enum":["VEHICLE","DRIVER","SEMITRAILER"]},"value":{"type":"string","example":"objectRef"}},"title":"ObjectRefApiDto"},"OrderList":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/definitions/OrderResponse"}},"maxPageNumber":{"type":"integer","format":"int32"},"paging":{"$ref":"#/definitions/Paging"},"totalItems":{"type":"integer","format":"int32"}},"title":"OrderList"},"OrderResponse":{"type":"object","properties":{"atsStatus":{"type":"string","enum":["NEW","INTERNAL_RECEIVED_BY_DEVICE","SENT_TO_DEVICE","ACCEPTED_BY_DRIVER","FINISHED","ARCHIVED","READ_BY_DRIVER","REJECTED_BY_DRIVER","INTERNAL_IN_PROGRESS"]},"cargoNames":{"type":"string"},"carrierName":{"type":"string"},"client":{"type":"string"},"clientOrderNumbers":{"type":"string"},"clientOrderSpeditors":{"type":"string"},"clientPricePerLoadedKm":{"type":"string"},"clientPricePerTotalKm":{"type":"string"},"clientPrices":{"type":"string"},"completionRiskDto":{"type":"string","enum":["SAFE","ENDANGERED","DELAYED"]},"contactPerson":{"type":"string"},"contactPhone":{"type":"string"},"createDate":{"type":"string","format":"date-time"},"departmentName":{"type":"string"},"driverName":{"type":"string"},"emptyKm":{"type":"string"},"expenses":{"type":"string"},"id":{"type":"string"},"lastAtsStatusChangeCause":{"type":"string"},"loadedKm":{"type":"string"},"loadingsDescription":{"type":"string"},"mileageOutsideCorridor":{"type":"number"},"notes":{"type":"string"},"orderNumber":{"type":"string"},"price":{"type":"string"},"provision":{"type":"string"},"realEmptyMileage":{"type":"number"},"realLoadedMileage":{"type":"number"},"realMileage":{"type":"number"},"secondDriverName":{"type":"string"},"semitrailerRegistrationNumber":{"type":"string"},"speditor":{"type":"string"},"status":{"type":"string","enum":["REMOVABLE_DRAFT","NEW","FORWARDED_TO_PARTNER","CONFIRMED","NEEDS_CONFIRMATION","COMPLETED","CANCELLED","NEW_CANCELLED","SOME_INVOICES_ISSUED","INVOICES_PAID"]},"subStatuses":{"type":"string"},"tags":{"type":"string"},"totalKm":{"type":"string"},"totalLdm":{"type":"string"},"totalWeightInKg":{"type":"string"},"truckRegistrationNumber":{"type":"string"},"truckStatus":{"type":"string"},"unloadingsDescription":{"type":"string"}},"title":"OrderResponse"},"Paging":{"type":"object","properties":{"firstItemIndex":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"}},"title":"Paging"},"PaymentTermApiDto":{"type":"object","properties":{"basePoint":{"type":"string","example":"INVOICE_RECEIPT","enum":["INVOICE_CREATION","INVOICE_ISSUANCE","INVOICE_RECEIPT"]},"daysOffset":{"type":"integer","format":"int32","example":50},"offsetType":{"type":"string","example":"SET_AMOUNT_OF_DAYS","enum":["SET_AMOUNT_OF_DAYS","DAYS_AFTER_END_OF_MONTH","END_OF_MONTH_AFTER_SET_AMOUNT_OF_DAYS"]}},"title":"PaymentTermApiDto"},"PublicApiAccountingContractorDto":{"type":"object","properties":{"address":{"$ref":"#/definitions/AddressApiDto"},"carrier":{"type":"boolean","example":false},"client":{"type":"boolean","example":true},"contactPersons":{"type":"array","items":{"$ref":"#/definitions/ContactPersonApiDto"}},"contractorNumber":{"type":"string","example":"FK"},"currency":{"type":"string","example":"PLN"},"id":{"type":"string","example":"51d9a540-64cc-48a7-b867-26afb44ebbc5"},"name":{"type":"string","example":"JSTRANS"},"normalizedTaxId":{"type":"string","example":9491925610},"normalizedVatEuId":{"type":"string","example":"PL9491925610"},"purchasePaymentMethod":{"type":"string","example":"BANK_TRANSFER","enum":["BANK_TRANSFER","CASH","DEBIT","STANDING_ORDER","CARD","BLIK","OTHER"]},"purchasePaymentTerm":{"$ref":"#/definitions/PaymentTermApiDto"},"salesPaymentMethod":{"type":"string","example":"BANK_TRANSFER","enum":["BANK_TRANSFER","CASH","DEBIT","STANDING_ORDER","CARD","BLIK","OTHER"]},"salesPaymentTerm":{"$ref":"#/definitions/PaymentTermApiDto"}},"title":"PublicApiAccountingContractorDto"},"PublicApiAssignedContactPerson":{"type":"object","properties":{"firstName":{"type":"string","example":"Jan"},"lastName":{"type":"string","example":"Kowalski"}},"title":"PublicApiAssignedContactPerson"},"PublicApiClientOrderAddress":{"type":"object","properties":{"addressType":{"type":"string","example":"FULL","description":"Type of address (e.g., CMR, FULL, ID).","enum":["CMR","FULL","ID"]},"area":{"type":"string","example":"Śródmieście","description":"Additional area or district information for the address."},"city":{"type":"string","example":"Warszawa","description":"City or town name for the address."},"companyName":{"type":"string","example":"Poczta Polska S.A.","description":"Name of the company or organization at the address."},"coordinate":{"example":{"latitude":52.2319581,"longitude":21.0067249},"description":"Geographical coordinate (latitude and longitude) for the address.","$ref":"#/definitions/Coordinate"},"descriptionCMR":{"type":"string","example":"Delivery to the main office on the second floor.","description":"Description or special instructions for the CMR document related to the address."},"placeId":{"type":"string","example":"unique id place","description":"Unique identifier for the place."},"streetWithNumber":{"type":"string","example":"Marszałkowska 1/103","description":"Street name with the building or house number."},"zipCode":{"type":"string","example":"PL00001","description":"Postal code for the address."}},"title":"PublicApiClientOrderAddress"},"PublicApiClientOrderCargo":{"type":"object","properties":{"adr":{"type":"boolean","example":false,"description":"Indicates whether the cargo is classified as ADR (dangerous goods)."},"adrClass":{"type":"string","example":3,"description":"Class of ADR (dangerous goods classification) if the cargo is ADR."},"cargoName":{"type":"string","example":"Tools and accessories","description":"Name of the cargo being transported or delivered."},"correlationId":{"type":"integer","format":"int32","example":1,"description":"Unique identifier for correlation between related orders or items."},"description":{"type":"string","example":"High-value mechanical tools packed in wooden crates.","description":"Detailed description or any additional information about the cargo."},"height":{"type":"number","example":1.8,"description":"Height of the cargo in meters."},"ldm":{"type":"number","example":2.5,"description":"Total length of the cargo in loading meters (LDM)."},"length":{"type":"number","example":3.0,"description":"Length of the cargo in meters."},"loadSizeType":{"type":"string","example":"DESCRIPTION","description":"Load size type for the order, which specifies whether the load is partial or full","enum":["DESCRIPTION","LDM","XYZ"]},"packageExchange":{"type":"boolean","example":true,"description":"Indicates whether package exchange is required, typically for pallets or reusable packaging."},"quantity":{"type":"number","example":200.0,"description":"Quantity of the cargo items, typically specifying the number of units."},"referenceCode":{"type":"string","example":"REF12345","description":"Reference code associated with the cargo or order."},"unitName":{"type":"string","example":"Box","description":"Unit of measurement used for the cargo quantity. Example values you can find in fireTMS configuration menu under 'unit od measure'."},"weight":{"type":"number","example":1500.75,"description":"Weight of the cargo in kilograms."},"width":{"type":"number","example":1.2,"description":"Width of the cargo in meters."}},"title":"PublicApiClientOrderCargo"},"PublicApiClientOrderCargoHandling":{"type":"object","properties":{"address":{"$ref":"#/definitions/PublicApiClientOrderAddress"},"cargoHandlingType":{"type":"string","enum":["LOADING","UNLOADING","PLACE","PETROL_STATION","CUSTOMS_CLEARANCE","LEAVE_SEMITRAILER","ATTACH_SEMITRAILER"]},"cargos":{"type":"array","items":{"$ref":"#/definitions/PublicApiClientOrderCargo"}},"comment":{"type":"string"},"term":{"type":"string","format":"date-time"},"termComment":{"type":"string"},"timeWindow":{"$ref":"#/definitions/PublicApiClientOrderRetrievalTimeWindow"}},"title":"PublicApiClientOrderCargoHandling"},"PublicApiClientOrderClient":{"type":"object","properties":{"contactPerson":{"$ref":"#/definitions/PublicApiAssignedContactPerson"},"taxId":{"type":"string","example":"0123456789"},"vatEuId":{"type":"string","example":"PL0123456789"}},"title":"PublicApiClientOrderClient"},"PublicApiClientOrderDto":{"type":"object","properties":{"cargoHandlings":{"type":"array","example":[{"address": {"addressType": "CMR", "area": "Silesia", "city": "Rybnik", "companyName": "CompanyA","coordinate": {"latitude": 50.07,"longitude": 18.35},"descriptionCMR": "Big red house","streetWithNumber": "Mikołowska 100","zipCode": "PL44200"},"cargoHandlingType": "LOADING","cargos": [{"adr": true,"adrClass": "1","cargoName": "LPG","description": "Gas cylinders","height": 2,"ldm": 0,"length": 8.4,"loadSizeType": "LDM","packageExchange": true,"quantity": 1,"referenceCode": "0000", "correlationId": 1, "unitName": "Big-Bag","weight": 2000,"width": 4}],"comment": "Remember to call client","term": "2024-09-09T10:00:00.000Z","termComment": "Don't be late","timeWindow": {"enabled": true,"end": "14:30:00","start": "10:00:00"}},{ "address": {"addressType": "CMR","area": "Silesia","city": "Katowice","companyName": "CompanyB","coordinate": {"latitude": 50.2452,"longitude": 19.0512},"descriptionCMR": "Big blue house","streetWithNumber": "Gospodarcza 100","zipCode": "PL40000"},"cargoHandlingType": "UNLOADING","cargos": [{ "adr": true,"adrClass": "1","cargoName": "LPG","description": "Gas cylinders","height": 2,"ldm": 0,"length": 8.4,"loadSizeType": "LDM","packageExchange": true,"quantity": 1,"referenceCode": "0000", "correlationId": 1, "unitName": "Big-Bag","weight": 2000,"width": 4}], "comment": "Remember to call client", "term": "2024-09-10T09:00:00.000Z", "termComment": "Don't be late","timeWindow": {"enabled": true,"end": "16:00:00","start":"12:00:00"}}],"items":{"$ref":"#/definitions/PublicApiClientOrderCargoHandling"}},"client":{"$ref":"#/definitions/PublicApiClientOrderClient"},"clientOrderNumber":{"type":"string","example":"001"},"internalNote":{"type":"string","example":"Important load"},"price":{"$ref":"#/definitions/MoneyDto"},"receptionDate":{"type":"string","format":"date-time"},"requirements":{"$ref":"#/definitions/PublicApiClientOrderRequirement"},"temperatureRange":{"$ref":"#/definitions/PublicApiClientOrderTemperatureRange"}},"title":"PublicApiClientOrderDto"},"PublicApiClientOrderRequirement":{"type":"object","properties":{"semitrailerType":{"type":"string","example":"MEGA","enum":["MEGA","TAUTLINER","SIDEBOARDED","JUMBO","COOLER","TENT","DUMP_TRUCK","VAN","CHEMICAL_TANKER","GAS_TANKER","PETROLEUM_TANKER","FOOD_TANKER","LOG_TRAILER","HOOK_LIFT","ISOTHERM","KOFFER","CONTAINER","CONTAINER_20_40","CAR_TRANSPORTER","FURNITURE_TRAILER","LOW_SUSPENSION","PLATFORM","OVERSIZED_CARGO","SPACIOUS","WALKING_FLOOR","SILOS","SWAP_BODY_SYSTEM","OTHER","COILMULDE","FRIGO_KOFFER","COOLER_STANDARD","DOUBLE_DECKER","FLOWER_TRAILER","T7_7M_7_7M","T15_4M","HOOKS_COOLER","BI_TEMPERATURE_COOLER","SOLO","BUS","DUMP_TRUCK_WITH_BLOWOUT"]}},"title":"PublicApiClientOrderRequirement"},"PublicApiClientOrderRetrievalTimeWindow":{"type":"object","properties":{"enabled":{"type":"boolean"},"end":{"type":"string","example":"14:30:15"},"start":{"type":"string","example":"14:30:15"}},"title":"PublicApiClientOrderRetrievalTimeWindow"},"PublicApiClientOrderTemperatureRange":{"type":"object","properties":{"details":{"type":"string","example":"Lower temperature, means lower chance to burn"},"from":{"type":"number","example":0.0},"to":{"type":"number","example":10.0}},"title":"PublicApiClientOrderTemperatureRange"},"PublicApiOfferCargoHandling":{"type":"object","properties":{"address":{"$ref":"#/definitions/PublicApiClientOrderAddress"},"comment":{"type":"string","example":"example comment"},"end":{"type":"string","example":"14:30"},"handlingTime":{"type":"string","format":"date-time","example":"2025-05-15"},"start":{"type":"string","example":"10:00"}},"title":"PublicApiOfferCargoHandling"},"PublicApiOfferDto":{"type":"object","properties":{"cargos":{"type":"array","items":{"$ref":"#/definitions/PublicApiClientOrderCargo"}},"client":{"$ref":"#/definitions/PublicApiClientOrderClient"},"description":{"type":"string"},"expireDate":{"type":"string","format":"date-time","example":"2025-05-15"},"externalId":{"type":"string"},"loadingSpot":{"$ref":"#/definitions/PublicApiOfferCargoHandling"},"price":{"$ref":"#/definitions/MoneyDto"},"semitrailerType":{"type":"array","example":["MEGA", "COOLER", "DUMP_TRUCK", "FOOD_TANKER"],"description":"Type of trailers allowed or applicable for the operation","items":{"type":"string","enum":["MEGA","TAUTLINER","SIDEBOARDED","JUMBO","COOLER","TENT","DUMP_TRUCK","VAN","CHEMICAL_TANKER","GAS_TANKER","PETROLEUM_TANKER","FOOD_TANKER","LOG_TRAILER","HOOK_LIFT","ISOTHERM","KOFFER","CONTAINER","CONTAINER_20_40","CAR_TRANSPORTER","FURNITURE_TRAILER","LOW_SUSPENSION","PLATFORM","OVERSIZED_CARGO","SPACIOUS","WALKING_FLOOR","SILOS","SWAP_BODY_SYSTEM","OTHER","COILMULDE","FRIGO_KOFFER","COOLER_STANDARD","DOUBLE_DECKER","FLOWER_TRAILER","T7_7M_7_7M","T15_4M","HOOKS_COOLER","BI_TEMPERATURE_COOLER","SOLO","BUS","DUMP_TRUCK_WITH_BLOWOUT"]}},"unloadSpot":{"$ref":"#/definitions/PublicApiOfferCargoHandling"}},"title":"PublicApiOfferDto"},"PublicApiOwnClientOrderDto":{"type":"object","properties":{"cargoHandlings":{"type":"array","items":{"$ref":"#/definitions/PublicApiClientOrderCargoHandling"}},"clientOrderNumber":{"type":"string"},"internalNote":{"type":"string"},"price":{"$ref":"#/definitions/MoneyDto"},"receptionDate":{"type":"string","format":"date-time"},"requirements":{"$ref":"#/definitions/PublicApiClientOrderRequirement"},"temperatureRange":{"$ref":"#/definitions/PublicApiClientOrderTemperatureRange"}},"title":"PublicApiOwnClientOrderDto"},"PublicApiPagedList«ClientOrderResponse»":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/definitions/ClientOrderResponse"}},"maxPageNumber":{"type":"integer","format":"int32"},"paging":{"$ref":"#/definitions/Paging"},"totalItems":{"type":"integer","format":"int32"}},"title":"PublicApiPagedList«ClientOrderResponse»"},"PublicApiPagedList«CurrencyTableResponse»":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/definitions/CurrencyTableResponse"}},"maxPageNumber":{"type":"integer","format":"int32"},"paging":{"$ref":"#/definitions/Paging"},"totalItems":{"type":"integer","format":"int32"}},"title":"PublicApiPagedList«CurrencyTableResponse»"},"PublicApiPagedList«DepartmentResponse»":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/definitions/DepartmentResponse"}},"maxPageNumber":{"type":"integer","format":"int32"},"paging":{"$ref":"#/definitions/Paging"},"totalItems":{"type":"integer","format":"int32"}},"title":"PublicApiPagedList«DepartmentResponse»"},"PublicApiPagedList«InternalDriverResponse»":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/definitions/InternalDriverResponse"}},"maxPageNumber":{"type":"integer","format":"int32"},"paging":{"$ref":"#/definitions/Paging"},"totalItems":{"type":"integer","format":"int32"}},"title":"PublicApiPagedList«InternalDriverResponse»"},"PublicApiPagedList«InternalSemitrailerResponse»":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/definitions/InternalSemitrailerResponse"}},"maxPageNumber":{"type":"integer","format":"int32"},"paging":{"$ref":"#/definitions/Paging"},"totalItems":{"type":"integer","format":"int32"}},"title":"PublicApiPagedList«InternalSemitrailerResponse»"},"PublicApiPagedList«InternalTransportExpenseResponse»":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/definitions/InternalTransportExpenseResponse"}},"maxPageNumber":{"type":"integer","format":"int32"},"paging":{"$ref":"#/definitions/Paging"},"totalItems":{"type":"integer","format":"int32"}},"title":"PublicApiPagedList«InternalTransportExpenseResponse»"},"PublicApiPagedList«InternalTruckResponse»":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/definitions/InternalTruckResponse"}},"maxPageNumber":{"type":"integer","format":"int32"},"paging":{"$ref":"#/definitions/Paging"},"totalItems":{"type":"integer","format":"int32"}},"title":"PublicApiPagedList«InternalTruckResponse»"},"PublicApiPagedList«OrderResponse»":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/definitions/OrderResponse"}},"maxPageNumber":{"type":"integer","format":"int32"},"paging":{"$ref":"#/definitions/Paging"},"totalItems":{"type":"integer","format":"int32"}},"title":"PublicApiPagedList«OrderResponse»"},"PublicApiPagedList«PurchaseServiceTypeResponse»":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/definitions/PurchaseServiceTypeResponse"}},"maxPageNumber":{"type":"integer","format":"int32"},"paging":{"$ref":"#/definitions/Paging"},"totalItems":{"type":"integer","format":"int32"}},"title":"PublicApiPagedList«PurchaseServiceTypeResponse»"},"PublicApiPagedList«PurchaseTaxRateResponse»":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/definitions/PurchaseTaxRateResponse"}},"maxPageNumber":{"type":"integer","format":"int32"},"paging":{"$ref":"#/definitions/Paging"},"totalItems":{"type":"integer","format":"int32"}},"title":"PublicApiPagedList«PurchaseTaxRateResponse»"},"PublicApiPagedList«UnitOfMeasureResponse»":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/definitions/UnitOfMeasureResponse"}},"maxPageNumber":{"type":"integer","format":"int32"},"paging":{"$ref":"#/definitions/Paging"},"totalItems":{"type":"integer","format":"int32"}},"title":"PublicApiPagedList«UnitOfMeasureResponse»"},"PublicApiPaging":{"type":"object","properties":{"firstItemIndex":{"type":"integer","format":"int32"},"pageNumber":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"}},"title":"PublicApiPaging"},"PublicApiPaymentDetailsDto":{"type":"object","properties":{"buyNow":{"type":"boolean"},"deferredDays":{"type":"integer","format":"int64","example":1},"hideOfferPrice":{"type":"boolean"},"hidePaymentType":{"type":"boolean"},"paymentType":{"type":"string","enum":["DEFERRED","ON_LOADING","ON_UNLOADING"]}},"title":"PublicApiPaymentDetailsDto"},"PublicApiPublicationOnExchangeDetailsDto":{"type":"object","properties":{"additionalInformation":{"type":"string","example":"Some additional information"},"enableWebCommunication":{"type":"boolean","example":false},"paymentDetails":{"$ref":"#/definitions/PublicApiPaymentDetailsDto"},"publishOnFireXgo":{"type":"boolean"}},"title":"PublicApiPublicationOnExchangeDetailsDto"},"PurchaseAccountingNoteApiDto":{"type":"object","properties":{"bankAccount":{"$ref":"#/definitions/BankAccountApiDto"},"calculatedPaymentTerm":{"type":"string","format":"date-time","example":"2019-09-20T09:17:22.775+02:00"},"comment":{"type":"string","example":"Rekompensata"},"correspondenceData":{"$ref":"#/definitions/CorrespondenceDataApiDto"},"documentId":{"type":"string","example":"SI:0872cef0-1749-4e20-8507-9d966f0292d3"},"documentIssuanceDate":{"type":"string","format":"date-time","example":"2019-09-23T09:17:22.775+02:00"},"documentNumber":{"type":"string","example":"0002/06/2019"},"items":{"type":"array","items":{"$ref":"#/definitions/AccountingDocumentItemApiDto"}},"outstandingToPay":{"$ref":"#/definitions/MoneyDto"},"payer":{"$ref":"#/definitions/LegalEntityApiDto"},"paymentMethod":{"type":"string","example":"BANK_TRANSFER","enum":["BANK_TRANSFER","CASH","DEBIT","STANDING_ORDER","CARD","BLIK","OTHER"]},"paymentTerm":{"$ref":"#/definitions/PaymentTermApiDto"},"receptionDate":{"type":"string","format":"date-time","example":"2019-09-22T09:17:22.775+02:00"},"relatedOrderNumber":{"type":"string","example":"ZL/003/06/2019"},"seller":{"$ref":"#/definitions/LegalEntityApiDto"},"status":{"type":"string","example":"REGISTERED","enum":["DRAFT","ISSUED","PAID","CORRECTED","CORRECTED_PAID","CANCELED_AS_CORRECTED_TO_ZERO","REGISTERED","CANCELED"]},"totalGross":{"$ref":"#/definitions/MoneyDto"},"totalNet":{"$ref":"#/definitions/MoneyDto"},"totalTax":{"$ref":"#/definitions/MoneyDto"}},"title":"PurchaseAccountingNoteApiDto"},"PurchaseServiceTypeResponse":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"title":"PurchaseServiceTypeResponse"},"PurchaseServiceTypeResponseList":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/definitions/PurchaseServiceTypeResponse"}},"maxPageNumber":{"type":"integer","format":"int32"},"paging":{"$ref":"#/definitions/Paging"},"totalItems":{"type":"integer","format":"int32"}},"title":"PurchaseServiceTypeResponseList"},"PurchaseTaxRateResponse":{"type":"object","properties":{"id":{"type":"string","example":"b9bc1394-6692-463b-85f7-f96bac02c461"},"name":{"type":"string","example":"Transport service"},"rate":{"type":"number","example":0.23},"tax":{"type":"number","example":23.0}},"title":"PurchaseTaxRateResponse"},"PurchaseTaxRateResponseList":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/definitions/PurchaseTaxRateResponse"}},"maxPageNumber":{"type":"integer","format":"int32"},"paging":{"$ref":"#/definitions/Paging"},"totalItems":{"type":"integer","format":"int32"}},"title":"PurchaseTaxRateResponseList"},"RemarkApiDto":{"type":"object","properties":{"language":{"type":"string","example":"EN"},"remark":{"type":"string","example":"Remark example"}},"title":"RemarkApiDto"},"ResponseEntity":{"type":"object","properties":{"body":{"type":"object"},"statusCode":{"type":"string","enum":["CONTINUE","SWITCHING_PROTOCOLS","PROCESSING","CHECKPOINT","OK","CREATED","ACCEPTED","NON_AUTHORITATIVE_INFORMATION","NO_CONTENT","RESET_CONTENT","PARTIAL_CONTENT","MULTI_STATUS","ALREADY_REPORTED","IM_USED","MULTIPLE_CHOICES","MOVED_PERMANENTLY","FOUND","MOVED_TEMPORARILY","SEE_OTHER","NOT_MODIFIED","USE_PROXY","TEMPORARY_REDIRECT","PERMANENT_REDIRECT","BAD_REQUEST","UNAUTHORIZED","PAYMENT_REQUIRED","FORBIDDEN","NOT_FOUND","METHOD_NOT_ALLOWED","NOT_ACCEPTABLE","PROXY_AUTHENTICATION_REQUIRED","REQUEST_TIMEOUT","CONFLICT","GONE","LENGTH_REQUIRED","PRECONDITION_FAILED","PAYLOAD_TOO_LARGE","REQUEST_ENTITY_TOO_LARGE","URI_TOO_LONG","REQUEST_URI_TOO_LONG","UNSUPPORTED_MEDIA_TYPE","REQUESTED_RANGE_NOT_SATISFIABLE","EXPECTATION_FAILED","I_AM_A_TEAPOT","INSUFFICIENT_SPACE_ON_RESOURCE","METHOD_FAILURE","DESTINATION_LOCKED","UNPROCESSABLE_ENTITY","LOCKED","FAILED_DEPENDENCY","UPGRADE_REQUIRED","PRECONDITION_REQUIRED","TOO_MANY_REQUESTS","REQUEST_HEADER_FIELDS_TOO_LARGE","UNAVAILABLE_FOR_LEGAL_REASONS","INTERNAL_SERVER_ERROR","NOT_IMPLEMENTED","BAD_GATEWAY","SERVICE_UNAVAILABLE","GATEWAY_TIMEOUT","HTTP_VERSION_NOT_SUPPORTED","VARIANT_ALSO_NEGOTIATES","INSUFFICIENT_STORAGE","LOOP_DETECTED","BANDWIDTH_LIMIT_EXCEEDED","NOT_EXTENDED","NETWORK_AUTHENTICATION_REQUIRED"]},"statusCodeValue":{"type":"integer","format":"int32"}},"title":"ResponseEntity"},"ResponseInfo":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}},"infos":{"type":"array","items":{"type":"string"}},"message":{"type":"string"},"warns":{"type":"array","items":{"type":"string"}}},"title":"ResponseInfo"},"SalesCreditNoteApiDto":{"type":"object","properties":{"calculatedPaymentTerm":{"type":"string","format":"date-time","example":"2019-09-21T09:17:22.775+02:00"},"client":{"$ref":"#/definitions/LegalEntityApiDto"},"correspondenceData":{"$ref":"#/definitions/CorrespondenceDataApiDto"},"documentConfirmationDate":{"type":"string","format":"date-time","example":"2021-09-10T15:32:11.978+02:00"},"documentId":{"type":"string","example":"SI:0872cef0-1749-4e20-8507-9d966f0292d3"},"documentNumber":{"type":"string","example":"0002/06/2019"},"issuanceDate":{"type":"string","format":"date-time","example":"2019-08-22T09:17:22.775+02:00"},"items":{"type":"array","items":{"$ref":"#/definitions/SalesCreditNoteItemApiDto"}},"outstandingToPayGross":{"$ref":"#/definitions/MoneyDto"},"payer":{"$ref":"#/definitions/LegalEntityApiDto"},"payerBankAccountData":{"$ref":"#/definitions/BankAccountApiDto"},"payerOriginalCurrencyBankAccountData":{"$ref":"#/definitions/BankAccountApiDto"},"paymentMethod":{"type":"string","example":"BANK_TRANSFER","enum":["BANK_TRANSFER","CASH","DEBIT","STANDING_ORDER","CARD","BLIK","OTHER"]},"paymentTerm":{"$ref":"#/definitions/PaymentTermApiDto"},"relatedDataNumbers":{"type":"string","example":"ZL/003/06/2019"},"remarks":{"type":"string","example":"remarks"},"sellDate":{"type":"string","format":"date-time","example":"2019-08-22T09:17:22.775+02:00"},"seller":{"$ref":"#/definitions/LegalEntityApiDto"},"status":{"type":"string","example":"CONFIRMED","enum":["NEW","NEW_CANCELED","DOCUMENT_REGISTERED","CONFIRMED","PAID","CANCELED","REISSUED_AFTER_CANCELLATION"]},"totalGross":{"$ref":"#/definitions/MoneyDto"},"totalNet":{"$ref":"#/definitions/MoneyDto"},"totalPaidGross":{"$ref":"#/definitions/MoneyDto"},"totalTax":{"$ref":"#/definitions/MoneyDto"}},"title":"SalesCreditNoteApiDto"},"SalesCreditNoteApiList":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/definitions/SalesCreditNoteApiDto"}},"maxPageNumber":{"type":"integer","format":"int32"},"paging":{"$ref":"#/definitions/Paging"},"totalItems":{"type":"integer","format":"int32"}},"title":"SalesCreditNoteApiList"},"SalesCreditNoteItemApiDto":{"type":"object","properties":{"carrierOrderDocNumber":{"type":"string","example":"ZL0004/07/2024"},"clientOrderDocNumber":{"type":"string","example":"0075/2024"},"clientOrderNumber":{"type":"string","example":"00043/05/2019"},"comment":{"type":"string","example":"commnet"},"currencyConversion":{"type":"boolean","example":false},"currencyRate":{"type":"number","example":1.15},"currencyTableDate":{"type":"string","format":"date","example":"2019-06-21"},"currencyTableNumber":{"type":"string","example":"119/A/NBP/2019"},"moneyInOriginalCurrency":{"$ref":"#/definitions/InvoiceItemMoneyApiDto"},"moneyInTargetCurrency":{"$ref":"#/definitions/InvoiceItemMoneyApiDto"},"quantity":{"type":"number","example":1.0},"serviceTypeName":{"type":"string","example":"Transport"},"taxRate":{"$ref":"#/definitions/TaxRateApiDto"},"unitOfMeasure":{"type":"string","example":"Europaleta"}},"title":"SalesCreditNoteItemApiDto"},"TaxIdApiDto":{"type":"object","properties":{"defined":{"type":"boolean","example":true},"normalizedTaxId":{"type":"string","example":6342819462},"taxId":{"type":"string","example":"634 281 94 62"},"valid":{"type":"boolean","example":true}},"title":"TaxIdApiDto"},"TaxRateApiDto":{"type":"object","properties":{"legalBasis":{"type":"string","example":"Odwrotne obciążenie (Reverse charge)"},"name":{"type":"string","example":"NP"},"notApplicable":{"type":"boolean","example":true},"rate":{"type":"number","example":0.0}},"title":"TaxRateApiDto"},"TaxRateSummaryApiDto":{"type":"object","properties":{"grossAmount":{"$ref":"#/definitions/MoneyDto"},"idColumnValue":{"type":"integer","format":"int64"},"netAmount":{"$ref":"#/definitions/MoneyDto"},"taxAmount":{"$ref":"#/definitions/MoneyDto"},"taxRate":{"type":"string","example":"23%"}},"title":"TaxRateSummaryApiDto"},"TransportServiceApiDto":{"type":"object","properties":{"cargos":{"type":"string","example":"load"},"carrierOrderDocNumber":{"type":"string","example":"T/005/01/2019/RY"},"clientOrderDocNumber":{"type":"string","example":"00005/2019"},"clientOrderNumber":{"type":"string","example":"00043/05/2019"},"completionDate":{"type":"string","format":"date-time","example":"2019-06-30T08:23:08.087+02:00"},"loadings":{"type":"string","example":"DE99310 Arndstadt (14.01.2019)"},"registrationNumbers":{"type":"string","example":"DFGSD"},"unloadings":{"type":"string","example":"CZ36401 Toužim (15.01.2019)"}},"title":"TransportServiceApiDto"},"TransportSetSubject":{"type":"object","properties":{"id":{"type":"string","example":"b9bc1394-6692-463b-85f7-f96bac02c461"},"name":{"type":"string","example":"SR12345"},"type":{"type":"string","enum":["TRUCK","SEMITRAILER","DRIVER","ORDER"]}},"title":"TransportSetSubject"},"UnitOfMeasureResponse":{"type":"object","properties":{"capacity":{"type":"string"},"defaultName":{"type":"string"},"defaultUnit":{"type":"boolean"},"id":{"type":"string"},"palletExchangePossible":{"type":"boolean"},"type":{"type":"string","enum":["DISTANCE","PALLET","EURO_PALLET","OTHER"]}},"title":"UnitOfMeasureResponse"},"UnitOfMeasureResponseList":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/definitions/UnitOfMeasureResponse"}},"maxPageNumber":{"type":"integer","format":"int32"},"paging":{"$ref":"#/definitions/Paging"},"totalItems":{"type":"integer","format":"int32"}},"title":"UnitOfMeasureResponseList"},"UpdateDepartmentRequest":{"type":"object","properties":{"address":{"$ref":"#/definitions/AddressApiDto"},"availableCurrencies":{"type":"array","example":["PLN"],"items":{"type":"string"}},"changeInvoiceIssuanceDatePermissions":{"type":"boolean"},"commencementDate":{"type":"string","format":"date-time"},"companyName":{"type":"string","example":"fireTMS"},"costCenter":{"type":"string","example":"Cost center"},"departmentCarrierOrderRemarks":{"type":"array","items":{"$ref":"#/definitions/RemarkApiDto"}},"departmentClientOrderRemarks":{"type":"array","items":{"$ref":"#/definitions/RemarkApiDto"}},"departmentDebitNoteRemarks":{"type":"array","items":{"$ref":"#/definitions/RemarkApiDto"}},"departmentInvoiceRemarks":{"type":"array","items":{"$ref":"#/definitions/RemarkApiDto"}},"description":{"type":"string","example":"Description"},"docNumberGroupingCode":{"type":"string","example":"MD"},"fax":{"type":"string","example":"123123123"},"issuanceDateValidation":{"type":"boolean"},"name":{"type":"string","example":"Main department"},"nativeCurrency":{"type":"string","example":"PLN"},"phone":{"type":"string","example":"+48123123123"},"placeOfInvoiceIssue":{"type":"string","example":"Rybnik"},"placeOfOrderIssue":{"type":"string","example":"Rybnik"},"regon":{"type":"string","example":"382380050"},"sellingDepartment":{"type":"string","example":"b9bc1394-6692-463b-85f7-f96bac02c461"},"taxId":{"type":"string","example":"8961583774"},"vatEuId":{"type":"string","example":"0000767863"}},"title":"UpdateDepartmentRequest"},"UpdateLoadRequest":{"type":"object","properties":{"cargoHandlings":{"type":"array","example":[{"address": {"addressType": "CMR", "area": "Silesia", "city": "Rybnik", "companyName": "CompanyA","coordinate": {"latitude": 50.07,"longitude": 18.35},"descriptionCMR": "Big red house","streetWithNumber": "Mikołowska 100","zipCode": "PL44200"},"cargoHandlingType": "LOADING","cargos": [{"adr": true,"adrClass": "1","cargoName": "LPG","description": "Gas cylinders","height": 2,"ldm": 0,"length": 8.4,"loadSizeType": "LDM","packageExchange": true,"quantity": 1,"referenceCode": "0000", "correlationId": 1, "unitName": "Big-Bag","weight": 2000,"width": 4}],"comment": "Remember to call client","term": "2024-09-09T10:00:00.000Z","termComment": "Don't be late","timeWindow": {"enabled": true,"end": "14:30:00","start": "10:00:00"}},{ "address": {"addressType": "CMR","area": "Silesia","city": "Katowice","companyName": "CompanyB","coordinate": {"latitude": 50.2452,"longitude": 19.0512},"descriptionCMR": "Big blue house","streetWithNumber": "Gospodarcza 100","zipCode": "PL40000"},"cargoHandlingType": "UNLOADING","cargos": [{ "adr": true,"adrClass": "1","cargoName": "LPG","description": "Gas cylinders","height": 2,"ldm": 0,"length": 8.4,"loadSizeType": "LDM","packageExchange": true,"quantity": 1,"referenceCode": "0000", "correlationId": 1, "unitName": "Big-Bag","weight": 2000,"width": 4}], "comment": "Remember to call client", "term": "2024-09-10T09:00:00.000Z", "termComment": "Don't be late","timeWindow": {"enabled": true,"end": "16:00:00","start":"12:00:00"}}],"items":{"$ref":"#/definitions/PublicApiClientOrderCargoHandling"}},"client":{"$ref":"#/definitions/PublicApiClientOrderClient"},"clientOrderNumber":{"type":"string","example":"001"},"internalNote":{"type":"string","example":"Important load"},"price":{"$ref":"#/definitions/MoneyDto"},"requirements":{"$ref":"#/definitions/PublicApiClientOrderRequirement"},"temperatureRange":{"$ref":"#/definitions/PublicApiClientOrderTemperatureRange"}},"title":"UpdateLoadRequest"},"UpdateOfferPublicationRequest":{"type":"object","properties":{"additionalInformation":{"type":"string","example":"Some additional information"},"departmentId":{"type":"string"},"enableWebCommunication":{"type":"boolean","example":false},"offer":{"$ref":"#/definitions/PublicApiOfferDto"},"paymentDetails":{"$ref":"#/definitions/PublicApiPaymentDetailsDto"}},"title":"UpdateOfferPublicationRequest"},"UpdateOfferRequest":{"type":"object","properties":{"departmentId":{"type":"string"},"offer":{"$ref":"#/definitions/PublicApiOfferDto"}},"title":"UpdateOfferRequest"},"VatEuIdApiDto":{"type":"object","properties":{"defined":{"type":"boolean","example":true},"normalizedValue":{"type":"string","example":"PL6783148063"},"vatEuId":{"type":"string","example":"PL 6783148063"}},"title":"VatEuIdApiDto"}}}