Maritech API (1.0.0)

Download OpenAPI specification:

Accounting

GetAccountingBatches

query Parameters

accountId required	string <guid>
domainId required	string <guid>
SentToAccounting	boolean or null
Skip	integer or null <int32> Number of records to skip before returning data, used in conjunction with Take to provide Paging
Take	integer or null <int32> Max number of records to return. Default is 20
FromVoucherDate	string or null <date> VoucherDate is the invoice date, credit note date, settlement date etc, use the FromVoucherDate and ToVoucherDate to filter on a date region for invoices
ToVoucherDate	string or null <date>
InvoiceType	string or null Filter on invoice/voucher type. Valid options : SalesInvoice, SalesCreditNote, PurchaseInvoice, PurchaseCreditNote, CurrencyContract
userId	string <guid>
traceId	string <guid>

Responses

Response samples

200
default

Content type

application/json

[{"id": "string",
"batchNo": 0,
"isPosted": true,
"createdAt": "2019-08-24T14:15:22Z",
"vouchers": [{"id": "string",
"sourceId": "string",
"sourceInformation": {"externalRef": "string",
"invoiceNo": "string",
"purchaseOrderNumbers": ["string"
],
"salesOrderNumbers": ["string"
],
"factoringCustomerNo": "string",
"factoringCustomerName": "string"
},
"type": "SalesInvoice",
"voucherNo": 0,
"voucherDate": "2019-08-24",
"dueDate": "2019-08-24",
"paymentId": "string",
"entryDate": "2019-08-24",
"entries": [{"id": "string",
"accountNo": "string",
"accountName": "string",
"actorNo": "string",
"actorId": "string",
"transactionType": "Customer",
"netAmount": 0,
"grossAmount": 0,
"currencyNetAmount": 0,
"currencyGrossAmount": 0,
"vatCode": "string",
"vatAmount": 0,
"currencyVatAmount": 0,
"currency": "string",
"exchangeRate": 0,
"dimensions": [{"dimensionId": "string",
"dimensionType": "string",
"dimensionDetailId": "string",
"dimensionDetailCode": "string",
"dimensionDetailName": "string"
}
],
"tags": [{"name": "string",
"value": "string"
}
]
}
]
}
]
}
]

GetAccountingBatch

path Parameters

batch

required

string

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

200
404
500
default

Content type

application/json

{"id": "string",
"batchNo": 0,
"isPosted": true,
"createdAt": "2019-08-24T14:15:22Z",
"vouchers": [{"id": "string",
"sourceId": "string",
"sourceInformation": {"externalRef": "string",
"invoiceNo": "string",
"purchaseOrderNumbers": ["string"
],
"salesOrderNumbers": ["string"
],
"factoringCustomerNo": "string",
"factoringCustomerName": "string"
},
"type": "SalesInvoice",
"voucherNo": 0,
"voucherDate": "2019-08-24",
"dueDate": "2019-08-24",
"paymentId": "string",
"entryDate": "2019-08-24",
"entries": [{"id": "string",
"accountNo": "string",
"accountName": "string",
"actorNo": "string",
"actorId": "string",
"transactionType": "Customer",
"netAmount": 0,
"grossAmount": 0,
"currencyNetAmount": 0,
"currencyGrossAmount": 0,
"vatCode": "string",
"vatAmount": 0,
"currencyVatAmount": 0,
"currency": "string",
"exchangeRate": 0,
"dimensions": [{"dimensionId": "string",
"dimensionType": "string",
"dimensionDetailId": "string",
"dimensionDetailCode": "string",
"dimensionDetailName": "string"
}
],
"tags": [{"name": "string",
"value": "string"
}
]
}
]
}
]
}

GetAccountingBatchForDebug

query Parameters

accountId required	string <guid>
domainId required	string <guid>
BatchId	string or null <guid>
BatchNo	integer or null <int32>
InvoiceNo	integer or null <int32>
InvoiceId	string or null <guid>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

200
404
500
default

Content type

application/json

{"id": "string",
"batchNo": 0,
"isPosted": true,
"createdAt": "2019-08-24T14:15:22Z",
"vouchers": [{"id": "string",
"sourceId": "string",
"sourceInformation": {"externalRef": "string",
"invoiceNo": "string",
"purchaseOrderNumbers": ["string"
],
"salesOrderNumbers": ["string"
],
"factoringCustomerNo": "string",
"factoringCustomerName": "string"
},
"type": "SalesInvoice",
"voucherNo": 0,
"voucherDate": "2019-08-24",
"dueDate": "2019-08-24",
"paymentId": "string",
"entryDate": "2019-08-24",
"entries": [{"id": "string",
"accountNo": "string",
"accountName": "string",
"actorNo": "string",
"actorId": "string",
"transactionType": "Customer",
"netAmount": 0,
"grossAmount": 0,
"currencyNetAmount": 0,
"currencyGrossAmount": 0,
"vatCode": "string",
"vatAmount": 0,
"currencyVatAmount": 0,
"currency": "string",
"exchangeRate": 0,
"dimensions": [{"dimensionId": "string",
"dimensionType": "string",
"dimensionDetailId": "string",
"dimensionDetailCode": "string",
"dimensionDetailName": "string"
}
],
"tags": [{"name": "string",
"value": "string"
}
]
}
]
}
]
}

UpdateAccountingBatchStatus

path Parameters

batch

required

string

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

404
500
default

Content type

application/json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"property1": null,
"property2": null
}

Allocation

Allocate to sales order

Allocate matching boxes to sales order.

query Parameters

accountId required	string <guid>
domainId required	string <guid>
salesOrder	string or null
customerOrderNo	string or null
allowPartial	boolean or null
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

Array

palletNo	integer or null <int32>
boxNo	integer or null <int32>
palletSscc	string or null
boxSscc	string or null
itemCode	string or null
purchaseOrder	string or null
batchNo	string or null
lotNo	string or null
useBy	string or null <date>
boxCount	integer or null <int32>
netWeight	number or null <decimal>

Responses

Request samples

Payload

Content type

application/json

[{"palletNo": 0,
"boxNo": 0,
"palletSscc": "string",
"boxSscc": "string",
"itemCode": "string",
"purchaseOrder": "string",
"batchNo": "string",
"lotNo": "string",
"useBy": "2019-08-24",
"boxCount": 0,
"netWeight": 0
}
]

Response samples

200
204
default

Content type

application/json

{"requestedAllocations": 0,
"completedAllocations": 0,
"failedAllocations": 0,
"totalBoxesBooked": 0,
"totalBoxesAllocated": 0,
"property1": null,
"property2": null
}

CatchField

GetCatchFields

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

200
204
default

Content type

application/json

[{"catchFieldId": "string",
"catchFieldCode": "string",
"catchFieldName": "string"
}
]

Configuration

GetClientConfig

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

200
204
default

Content type

application/json

{"vendorIdType": "Guid",
"customerIdType": "Guid",
"transporterIdType": "Guid",
"exporterIdType": "Guid",
"employeeIdType": "Guid"
}

PutClientConfig

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

vendorIdType required	string (IdType) Enum: "Guid" "Number" "Text"
customerIdType required	string (IdType) Enum: "Guid" "Number" "Text"
transporterIdType required	string (IdType) Enum: "Guid" "Number" "Text"
exporterIdType required	string (IdType) Enum: "Guid" "Number" "Text"
employeeIdType required	string (IdType) Enum: "Guid" "Number" "Text"

Responses

Request samples

Payload

Content type

application/json

{"vendorIdType": "Guid",
"customerIdType": "Guid",
"transporterIdType": "Guid",
"exporterIdType": "Guid",
"employeeIdType": "Guid"
}

Response samples

default

Content type

application/json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"property1": null,
"property2": null
}

GetIntegrationConfig

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

200
204
default

Content type

application/json

{"salesOrderStatuses": [{"orderStatus": 0,
"statusName": "string",
"subStatusId": "string",
"statusColor": "string"
}
],
"purchaseOrderStatuses": [{"orderStatus": 0,
"statusName": "string",
"subStatusId": "string",
"statusColor": "string"
}
],
"importToConfirmedInventoryPO": true,
"importBoxesAsFixedWeightPallets": true,
"queueFailedImports": true,
"includeProductionOrders": true,
"lotNoPropertyName": "string",
"useSingleItemsOnBox": true,
"isTwoWaySync": true
}

GetRateLimitConfig

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

200
204
default

Content type

application/json

{"limit": 0,
"window": "string"
}

PutRateLimitConfig

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

limit required	integer <int32>
window required	string <duration>

Responses

Request samples

Payload

Content type

application/json

{"limit": 0,
"window": "string"
}

Response samples

200
204
default

Content type

application/json

{"limit": 0,
"window": "string"
}

Contacts

GetContacts

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

200
default

Content type

application/json

[{"contactId": "string",
"firstName": "string",
"lastName": "string",
"primaryEmail": "string",
"secondaryEmail": "string",
"phone": "string",
"mobilePhone": "string"
}
]

CostSetup

Get cost setups

Get cost/price line definitions configured under Configuration > Orders > Costs.

query Parameters

accountId required	string <guid>
domainId required	string <guid>
Skip	integer or null <int32>
Take	integer or null <int32>
includeDiscounts	boolean or null
userId	string <guid>
traceId	string <guid>

Responses

Response samples

200
204
default

Content type

application/json

{"items": [{"costId": "string",
"description": "string",
"costTypeId": "string",
"calculationMethod": "string",
"distributionMethod": "string",
"isActive": true,
"isInternalCost": true,
"value": 0,
"affectMargins": true,
"allowOnPurchaseOrder": true,
"allowOnSalesOrder": true,
"allowOnTransferOrder": true,
"ledgerGroupId": "string",
"isReadOnly": true,
"isInUse": true,
"currencyId": "string",
"vendorId": "string",
"sortOrder": 0
}
],
"skip": 0,
"totalResults": 0
}

Create cost setup

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

costId	string or null <guid>
description	string or null
costTypeId	string or null <guid>
calculationMethod	string or null
distributionMethod	string or null
isActive	boolean or null
isInternalCost	boolean or null
value	number or null <decimal>
affectMargins	boolean or null
allowOnPurchaseOrder	boolean or null
allowOnSalesOrder	boolean or null
allowOnTransferOrder	boolean or null
ledgerGroupId	string or null <guid>
isReadOnly	boolean or null
isInUse	boolean or null
currencyId	string or null
vendorId	string or null <guid>
sortOrder	integer or null <int32>

Responses

Request samples

Payload

Content type

application/json

{"costId": "string",
"description": "string",
"costTypeId": "string",
"calculationMethod": "string",
"distributionMethod": "string",
"isActive": true,
"isInternalCost": true,
"value": 0,
"affectMargins": true,
"allowOnPurchaseOrder": true,
"allowOnSalesOrder": true,
"allowOnTransferOrder": true,
"ledgerGroupId": "string",
"isReadOnly": true,
"isInUse": true,
"currencyId": "string",
"vendorId": "string",
"sortOrder": 0
}

Response samples

201
default

Content type

application/json

{"costId": "string",
"description": "string",
"costTypeId": "string",
"calculationMethod": "string",
"distributionMethod": "string",
"isActive": true,
"isInternalCost": true,
"value": 0,
"affectMargins": true,
"allowOnPurchaseOrder": true,
"allowOnSalesOrder": true,
"allowOnTransferOrder": true,
"ledgerGroupId": "string",
"isReadOnly": true,
"isInUse": true,
"currencyId": "string",
"vendorId": "string",
"sortOrder": 0
}

Get a cost setup

path Parameters

required

string <guid>

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

200
204
404
default

Content type

application/json

{"costId": "string",
"description": "string",
"costTypeId": "string",
"calculationMethod": "string",
"distributionMethod": "string",
"isActive": true,
"isInternalCost": true,
"value": 0,
"affectMargins": true,
"allowOnPurchaseOrder": true,
"allowOnSalesOrder": true,
"allowOnTransferOrder": true,
"ledgerGroupId": "string",
"isReadOnly": true,
"isInUse": true,
"currencyId": "string",
"vendorId": "string",
"sortOrder": 0
}

Patch cost setup

path Parameters

required

string <guid>

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

costId	string or null <guid>
description	string or null
costTypeId	string or null <guid>
calculationMethod	string or null
distributionMethod	string or null
isActive	boolean or null
isInternalCost	boolean or null
value	number or null <decimal>
affectMargins	boolean or null
allowOnPurchaseOrder	boolean or null
allowOnSalesOrder	boolean or null
allowOnTransferOrder	boolean or null
ledgerGroupId	string or null <guid>
isReadOnly	boolean or null
isInUse	boolean or null
currencyId	string or null
vendorId	string or null <guid>
sortOrder	integer or null <int32>

Responses

Request samples

Payload

Content type

application/json

{"costId": "string",
"description": "string",
"costTypeId": "string",
"calculationMethod": "string",
"distributionMethod": "string",
"isActive": true,
"isInternalCost": true,
"value": 0,
"affectMargins": true,
"allowOnPurchaseOrder": true,
"allowOnSalesOrder": true,
"allowOnTransferOrder": true,
"ledgerGroupId": "string",
"isReadOnly": true,
"isInUse": true,
"currencyId": "string",
"vendorId": "string",
"sortOrder": 0
}

Response samples

200
204
404
default

Content type

application/json

{"costId": "string",
"description": "string",
"costTypeId": "string",
"calculationMethod": "string",
"distributionMethod": "string",
"isActive": true,
"isInternalCost": true,
"value": 0,
"affectMargins": true,
"allowOnPurchaseOrder": true,
"allowOnSalesOrder": true,
"allowOnTransferOrder": true,
"ledgerGroupId": "string",
"isReadOnly": true,
"isInUse": true,
"currencyId": "string",
"vendorId": "string",
"sortOrder": 0
}

Country

GetCountries

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

200
400
default

Content type

application/json

[{"countryCode": "string",
"name": "string",
"memberCode": "string",
"postalPrefix": "string",
"hasKid": true
}
]

Crew

ListCrewActors

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

200
400
default

Content type

application/json

[{"id": "string",
"crewNumber": 0,
"externalCrewNumber": "string",
"active": true,
"firstName": "string",
"middleName": "string",
"lastName": "string",
"primaryEmail": "string",
"secondaryEmail": "string",
"phone": "string",
"mobilePhone": "string",
"address": {"addressId": "string",
"type": "Unspecified",
"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"address4": "string",
"zipCode": "string",
"city": "string",
"state": "string",
"countryCode": "string",
"gln": "string",
"routeNumber": "string"
}
}
]

CreateOrUpdateCrewActorsIdempotent

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

Array

id required	string <guid>
crewNumber	integer or null <int32>
externalCrewNumber	string or null
active required	boolean
firstName	string or null
middleName	string or null
lastName	string or null
primaryEmail	string or null
secondaryEmail	string or null
phone	string or null
mobilePhone	string or null
	(Address (object or null))

Responses

Request samples

Payload

Content type

application/json

[{"id": "string",
"crewNumber": 0,
"externalCrewNumber": "string",
"active": true,
"firstName": "string",
"middleName": "string",
"lastName": "string",
"primaryEmail": "string",
"secondaryEmail": "string",
"phone": "string",
"mobilePhone": "string",
"address": {"addressId": "string",
"type": "Unspecified",
"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"address4": "string",
"zipCode": "string",
"city": "string",
"state": "string",
"countryCode": "string",
"gln": "string",
"routeNumber": "string"
}
}
]

Response samples

200
400
default

Content type

application/json

[{"id": "string",
"crewNumber": 0,
"externalCrewNumber": "string",
"active": true,
"firstName": "string",
"middleName": "string",
"lastName": "string",
"primaryEmail": "string",
"secondaryEmail": "string",
"phone": "string",
"mobilePhone": "string",
"address": {"addressId": "string",
"type": "Unspecified",
"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"address4": "string",
"zipCode": "string",
"city": "string",
"state": "string",
"countryCode": "string",
"gln": "string",
"routeNumber": "string"
}
}
]

GetCrewActorById

path Parameters

crewId

required

string <guid>

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

200
400
404
default

Content type

application/json

{"id": "string",
"crewNumber": 0,
"externalCrewNumber": "string",
"active": true,
"firstName": "string",
"middleName": "string",
"lastName": "string",
"primaryEmail": "string",
"secondaryEmail": "string",
"phone": "string",
"mobilePhone": "string",
"address": {"addressId": "string",
"type": "Unspecified",
"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"address4": "string",
"zipCode": "string",
"city": "string",
"state": "string",
"countryCode": "string",
"gln": "string",
"routeNumber": "string"
}
}

UpdateCrewActor

path Parameters

required

string

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

id required	string <guid>
crewNumber	integer or null <int32>
externalCrewNumber	string or null
active required	boolean
firstName	string or null
middleName	string or null
lastName	string or null
primaryEmail	string or null
secondaryEmail	string or null
phone	string or null
mobilePhone	string or null
	(Address (object or null))

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"crewNumber": 0,
"externalCrewNumber": "string",
"active": true,
"firstName": "string",
"middleName": "string",
"lastName": "string",
"primaryEmail": "string",
"secondaryEmail": "string",
"phone": "string",
"mobilePhone": "string",
"address": {"addressId": "string",
"type": "Unspecified",
"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"address4": "string",
"zipCode": "string",
"city": "string",
"state": "string",
"countryCode": "string",
"gln": "string",
"routeNumber": "string"
}
}

Response samples

Content type

application/json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"property1": null,
"property2": null
}

Currency

GetCurrencies

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

200
default

Content type

application/json

[{"currencyCode": "string",
"currencyRate": 0,
"validFrom": "2019-08-24"
}
]

PostCurrencies

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

Array

currencyCode	string or null
currencyRate required	number <decimal>
validFrom	string or null <date>

Responses

Request samples

Payload

Content type

application/json

[{"currencyCode": "string",
"currencyRate": 0,
"validFrom": "2019-08-24"
}
]

Response samples

default

Content type

application/json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"property1": null,
"property2": null
}

GetCurrencyAsync

path Parameters

currencyCode

required

string

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

200
204
default

Content type

application/json

{"currencyCode": "string",
"currencyRate": 0,
"validFrom": "2019-08-24"
}

PutCurrency

path Parameters

currencyCode

required

string

query Parameters

accountId required	string <guid>
domainId required	string <guid>
currencyRate required	number <decimal>
validFrom	string or null <date>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

200
default

Content type

application/json

{"currencyCode": "string",
"currencyRate": 0,
"validFrom": "2019-08-24"
}

Customer

GetCustomers

query Parameters

accountId required	string <guid>
domainId required	string <guid>
CustomerNo	integer or null <int32>
CustomerId	string or null <guid>
GLN	string or null
CountryCode	string or null
ExternalNo	string or null
DimensionDetailId	string or null
DimensionName	string or null
DimensionValue	string or null
ChangedSince	string or null <date-time>
IncludeDeleted	boolean or null #90382: include deactivated customers in the result. Default: active only.
userId	string <guid>
traceId	string <guid>

Responses

Response samples

200
default

Content type

application/json

[{"id": "string",
"customerNo": 0,
"externalCustomerNo": "string",
"name": "string",
"active": true,
"organizationNo": "string",
"vatIdentificationNo": "string",
"currencyCode": "string",
"languageCode": "string",
"primaryEmail": "string",
"secondaryEmail": "string",
"phone": "string",
"mobilePhone": "string",
"ledgerNo": "string",
"eori": "string",
"vatRequired": true,
"factoringCustomer": true,
"paymentTerms": "string",
"deliveryTerms": "string",
"electronicInvoiceType": "None",
"addresses": [{"addressId": "string",
"type": "Unspecified",
"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"address4": "string",
"zipCode": "string",
"city": "string",
"state": "string",
"countryCode": "string",
"gln": "string",
"routeNumber": "string"
}
],
"contactInformation": [{"contactId": "string",
"firstName": "string",
"lastName": "string",
"primaryEmail": "string",
"secondaryEmail": "string",
"phone": "string",
"mobilePhone": "string"
}
],
"dimensions": [{"dimensionType": {"name": "string"
},
"value": "string",
"dimensionName": "string",
"description": "string"
}
],
"privateOrCompany": "string",
"creditLimit": 0,
"insuranceLimit": 0,
"lastModifiedAt": "2019-08-24T14:15:22Z"
}
]

PostCustomer

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

Array

id	string or null <guid>
customerNo	integer or null <int32>
externalCustomerNo	string or null
name	string or null
active required	boolean
organizationNo	string or null
vatIdentificationNo	string or null
currencyCode	string or null
languageCode	string or null
primaryEmail	string or null
secondaryEmail	string or null
phone	string or null
mobilePhone	string or null
ledgerNo	string or null
eori	string or null
vatRequired required	boolean
factoringCustomer required	boolean
paymentTerms	string or null
deliveryTerms	string or null
	(ElectronicInvoiceTypes (string or null))
	Array of objects or null (Address)
	Array of objects or null (ContactInformation)
	Array of objects or null (ActorDimension)
privateOrCompany	string or null Can be P = Private or C = Company. If not filled out, interpret as C = Company.
creditLimit	number or null <decimal>
insuranceLimit	number or null <decimal>
lastModifiedAt	string or null <date-time>

Responses

Request samples

Payload

Content type

application/json

[{"id": "string",
"customerNo": 0,
"externalCustomerNo": "string",
"name": "string",
"active": true,
"organizationNo": "string",
"vatIdentificationNo": "string",
"currencyCode": "string",
"languageCode": "string",
"primaryEmail": "string",
"secondaryEmail": "string",
"phone": "string",
"mobilePhone": "string",
"ledgerNo": "string",
"eori": "string",
"vatRequired": true,
"factoringCustomer": true,
"paymentTerms": "string",
"deliveryTerms": "string",
"electronicInvoiceType": "None",
"addresses": [{"addressId": "string",
"type": "Unspecified",
"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"address4": "string",
"zipCode": "string",
"city": "string",
"state": "string",
"countryCode": "string",
"gln": "string",
"routeNumber": "string"
}
],
"contactInformation": [{"contactId": "string",
"firstName": "string",
"lastName": "string",
"primaryEmail": "string",
"secondaryEmail": "string",
"phone": "string",
"mobilePhone": "string"
}
],
"dimensions": [{"dimensionType": {"name": "string"
},
"value": "string",
"dimensionName": "string",
"description": "string"
}
],
"privateOrCompany": "string",
"creditLimit": 0,
"insuranceLimit": 0,
"lastModifiedAt": "2019-08-24T14:15:22Z"
}
]

Response samples

200
default

Content type

application/json

[{"id": "string",
"customerNo": 0,
"externalCustomerNo": "string",
"name": "string",
"active": true,
"organizationNo": "string",
"vatIdentificationNo": "string",
"currencyCode": "string",
"languageCode": "string",
"primaryEmail": "string",
"secondaryEmail": "string",
"phone": "string",
"mobilePhone": "string",
"ledgerNo": "string",
"eori": "string",
"vatRequired": true,
"factoringCustomer": true,
"paymentTerms": "string",
"deliveryTerms": "string",
"electronicInvoiceType": "None",
"addresses": [{"addressId": "string",
"type": "Unspecified",
"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"address4": "string",
"zipCode": "string",
"city": "string",
"state": "string",
"countryCode": "string",
"gln": "string",
"routeNumber": "string"
}
],
"contactInformation": [{"contactId": "string",
"firstName": "string",
"lastName": "string",
"primaryEmail": "string",
"secondaryEmail": "string",
"phone": "string",
"mobilePhone": "string"
}
],
"dimensions": [{"dimensionType": {"name": "string"
},
"value": "string",
"dimensionName": "string",
"description": "string"
}
],
"privateOrCompany": "string",
"creditLimit": 0,
"insuranceLimit": 0,
"lastModifiedAt": "2019-08-24T14:15:22Z"
}
]

Patch customer. Available properties: Id, OpenBalance, OpenBalanceOverDue, OpenBalanceXDaysOverDue, CreditLimit, InsuranceLimit, Active

query Parameters

accountId required	string <guid>
domainId required	string <guid>
processPartial	boolean Default: false
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

Array

property name*

additional property

any

Responses

Request samples

Payload

Content type

application/json

[{"property1": null,
"property2": null
}
]

Response samples

200
400
default

Content type

application/json

"string"

Get single customer

path Parameters

required

string

The customer's identifier: either its customerNo/external number (per this account's configured id format) or its id (UUID). Both are accepted regardless of configuration.

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

200
204
default

Content type

application/json

{"id": "string",
"customerNo": 0,
"externalCustomerNo": "string",
"name": "string",
"active": true,
"organizationNo": "string",
"vatIdentificationNo": "string",
"currencyCode": "string",
"languageCode": "string",
"primaryEmail": "string",
"secondaryEmail": "string",
"phone": "string",
"mobilePhone": "string",
"ledgerNo": "string",
"eori": "string",
"vatRequired": true,
"factoringCustomer": true,
"paymentTerms": "string",
"deliveryTerms": "string",
"electronicInvoiceType": "None",
"addresses": [{"addressId": "string",
"type": "Unspecified",
"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"address4": "string",
"zipCode": "string",
"city": "string",
"state": "string",
"countryCode": "string",
"gln": "string",
"routeNumber": "string"
}
],
"contactInformation": [{"contactId": "string",
"firstName": "string",
"lastName": "string",
"primaryEmail": "string",
"secondaryEmail": "string",
"phone": "string",
"mobilePhone": "string"
}
],
"dimensions": [{"dimensionType": {"name": "string"
},
"value": "string",
"dimensionName": "string",
"description": "string"
}
],
"privateOrCompany": "string",
"creditLimit": 0,
"insuranceLimit": 0,
"lastModifiedAt": "2019-08-24T14:15:22Z"
}

Update an existing customer

path Parameters

required

string

The customer's identifier: either its customerNo/external number (per this account's configured id format) or its id (UUID). Both are accepted regardless of configuration.

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

id	string or null <guid>
customerNo	integer or null <int32>
externalCustomerNo	string or null
name	string or null
active required	boolean
organizationNo	string or null
vatIdentificationNo	string or null
currencyCode	string or null
languageCode	string or null
primaryEmail	string or null
secondaryEmail	string or null
phone	string or null
mobilePhone	string or null
ledgerNo	string or null
eori	string or null
vatRequired required	boolean
factoringCustomer required	boolean
paymentTerms	string or null
deliveryTerms	string or null
	(ElectronicInvoiceTypes (string or null))
	Array of objects or null (Address)
	Array of objects or null (ContactInformation)
	Array of objects or null (ActorDimension)
privateOrCompany	string or null Can be P = Private or C = Company. If not filled out, interpret as C = Company.
creditLimit	number or null <decimal>
insuranceLimit	number or null <decimal>
lastModifiedAt	string or null <date-time>

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"customerNo": 0,
"externalCustomerNo": "string",
"name": "string",
"active": true,
"organizationNo": "string",
"vatIdentificationNo": "string",
"currencyCode": "string",
"languageCode": "string",
"primaryEmail": "string",
"secondaryEmail": "string",
"phone": "string",
"mobilePhone": "string",
"ledgerNo": "string",
"eori": "string",
"vatRequired": true,
"factoringCustomer": true,
"paymentTerms": "string",
"deliveryTerms": "string",
"electronicInvoiceType": "None",
"addresses": [{"addressId": "string",
"type": "Unspecified",
"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"address4": "string",
"zipCode": "string",
"city": "string",
"state": "string",
"countryCode": "string",
"gln": "string",
"routeNumber": "string"
}
],
"contactInformation": [{"contactId": "string",
"firstName": "string",
"lastName": "string",
"primaryEmail": "string",
"secondaryEmail": "string",
"phone": "string",
"mobilePhone": "string"
}
],
"dimensions": [{"dimensionType": {"name": "string"
},
"value": "string",
"dimensionName": "string",
"description": "string"
}
],
"privateOrCompany": "string",
"creditLimit": 0,
"insuranceLimit": 0,
"lastModifiedAt": "2019-08-24T14:15:22Z"
}

Response samples

200
204
default

Content type

application/json

{"id": "string",
"customerNo": 0,
"externalCustomerNo": "string",
"name": "string",
"active": true,
"organizationNo": "string",
"vatIdentificationNo": "string",
"currencyCode": "string",
"languageCode": "string",
"primaryEmail": "string",
"secondaryEmail": "string",
"phone": "string",
"mobilePhone": "string",
"ledgerNo": "string",
"eori": "string",
"vatRequired": true,
"factoringCustomer": true,
"paymentTerms": "string",
"deliveryTerms": "string",
"electronicInvoiceType": "None",
"addresses": [{"addressId": "string",
"type": "Unspecified",
"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"address4": "string",
"zipCode": "string",
"city": "string",
"state": "string",
"countryCode": "string",
"gln": "string",
"routeNumber": "string"
}
],
"contactInformation": [{"contactId": "string",
"firstName": "string",
"lastName": "string",
"primaryEmail": "string",
"secondaryEmail": "string",
"phone": "string",
"mobilePhone": "string"
}
],
"dimensions": [{"dimensionType": {"name": "string"
},
"value": "string",
"dimensionName": "string",
"description": "string"
}
],
"privateOrCompany": "string",
"creditLimit": 0,
"insuranceLimit": 0,
"lastModifiedAt": "2019-08-24T14:15:22Z"
}

Get single customer by external number

path Parameters

extNo

required

string

The customer's external number (externalCustomerNo). Searched as text only, never as customerNo or id.

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

200
204
default

Content type

application/json

{"id": "string",
"customerNo": 0,
"externalCustomerNo": "string",
"name": "string",
"active": true,
"organizationNo": "string",
"vatIdentificationNo": "string",
"currencyCode": "string",
"languageCode": "string",
"primaryEmail": "string",
"secondaryEmail": "string",
"phone": "string",
"mobilePhone": "string",
"ledgerNo": "string",
"eori": "string",
"vatRequired": true,
"factoringCustomer": true,
"paymentTerms": "string",
"deliveryTerms": "string",
"electronicInvoiceType": "None",
"addresses": [{"addressId": "string",
"type": "Unspecified",
"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"address4": "string",
"zipCode": "string",
"city": "string",
"state": "string",
"countryCode": "string",
"gln": "string",
"routeNumber": "string"
}
],
"contactInformation": [{"contactId": "string",
"firstName": "string",
"lastName": "string",
"primaryEmail": "string",
"secondaryEmail": "string",
"phone": "string",
"mobilePhone": "string"
}
],
"dimensions": [{"dimensionType": {"name": "string"
},
"value": "string",
"dimensionName": "string",
"description": "string"
}
],
"privateOrCompany": "string",
"creditLimit": 0,
"insuranceLimit": 0,
"lastModifiedAt": "2019-08-24T14:15:22Z"
}

GetCustomerAddresses

path Parameters

required

string

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

200
default

Content type

application/json

[{"addressId": "string",
"type": "Unspecified",
"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"address4": "string",
"zipCode": "string",
"city": "string",
"state": "string",
"countryCode": "string",
"gln": "string",
"routeNumber": "string"
}
]

PostCustomerAddresses

path Parameters

required

string

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

Array

addressId	string or null <guid>
type required	string (AddressType) Enum: "Unspecified" "InvoiceAddress" "DeliveryAddress"
name	string or null
address1	string or null
address2	string or null
address3	string or null
address4	string or null
zipCode	string or null
city	string or null
state	string or null
countryCode	string or null
gln	string or null
routeNumber	string or null

Responses

Request samples

Payload

Content type

application/json

[{"addressId": "string",
"type": "Unspecified",
"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"address4": "string",
"zipCode": "string",
"city": "string",
"state": "string",
"countryCode": "string",
"gln": "string",
"routeNumber": "string"
}
]

Response samples

default

Content type

application/json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"property1": null,
"property2": null
}

PutCustomerAddresses

path Parameters

required

string

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

Array

addressId	string or null <guid>
type required	string (AddressType) Enum: "Unspecified" "InvoiceAddress" "DeliveryAddress"
name	string or null
address1	string or null
address2	string or null
address3	string or null
address4	string or null
zipCode	string or null
city	string or null
state	string or null
countryCode	string or null
gln	string or null
routeNumber	string or null

Responses

Request samples

Payload

Content type

application/json

[{"addressId": "string",
"type": "Unspecified",
"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"address4": "string",
"zipCode": "string",
"city": "string",
"state": "string",
"countryCode": "string",
"gln": "string",
"routeNumber": "string"
}
]

Response samples

default

Content type

application/json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"property1": null,
"property2": null
}

Get all contacts for customer

path Parameters

customerId

required

string

The customer id

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

200
default

Content type

application/json

[{"contactId": "string",
"firstName": "string",
"lastName": "string",
"primaryEmail": "string",
"secondaryEmail": "string",
"phone": "string",
"mobilePhone": "string"
}
]

Add new single contact at customer

path Parameters

customerId

required

string

The customer id

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

contactId	string or null <guid>
firstName	string or null
lastName	string or null
primaryEmail	string or null
secondaryEmail	string or null
phone	string or null
mobilePhone	string or null

Responses

Request samples

Payload

Content type

application/json

{"contactId": "string",
"firstName": "string",
"lastName": "string",
"primaryEmail": "string",
"secondaryEmail": "string",
"phone": "string",
"mobilePhone": "string"
}

Response samples

200
204
default

Content type

application/json

{"contactId": "string",
"firstName": "string",
"lastName": "string",
"primaryEmail": "string",
"secondaryEmail": "string",
"phone": "string",
"mobilePhone": "string"
}

Update single contact at customer

path Parameters

customerId

required

string

The customer id

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

contactId	string or null <guid>
firstName	string or null
lastName	string or null
primaryEmail	string or null
secondaryEmail	string or null
phone	string or null
mobilePhone	string or null

Responses

Request samples

Payload

Content type

application/json

{"contactId": "string",
"firstName": "string",
"lastName": "string",
"primaryEmail": "string",
"secondaryEmail": "string",
"phone": "string",
"mobilePhone": "string"
}

Response samples

default

Content type

application/json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"property1": null,
"property2": null
}

PostCustomerBalance

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

Array

customerNo	string or null
openBalance	number or null <decimal>
openBalanceOverDue	number or null <decimal>
openBalanceXDaysOverDue	number or null <decimal>

Responses

Request samples

Payload

Content type

application/json

[{"customerNo": "string",
"openBalance": 0,
"openBalanceOverDue": 0,
"openBalanceXDaysOverDue": 0
}
]

Response samples

default

Content type

application/json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"property1": null,
"property2": null
}

DataImport

ImportVendor

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

default

Content type

application/json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"property1": null,
"property2": null
}

ImportCustomer

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

default

Content type

application/json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"property1": null,
"property2": null
}

ImportCurrency

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

default

Content type

application/json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"property1": null,
"property2": null
}

ImportInvoiceStatus

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

default

Content type

application/json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"property1": null,
"property2": null
}

Dimensions

GetDimensions

query Parameters

accountId required	string <guid>
domainId required	string <guid>
	(DimensionSetupTypeEnum (string or null))
	(DimensionType2 (object or null))
dimensionName	string or null
dimensionValueChangedSince	string or null <date-time>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

200
400
default

Content type

application/json

[{"name": "string",
"dimensionType": "string",
"lastModifiedAt": "2019-08-24T14:15:22Z",
"values": [{"code": "string",
"name": "string",
"latinName": "string",
"minSize": 0,
"maxSize": 0,
"weightUnitId": "string",
"lastModifiedAt": "2019-08-24T14:15:22Z"
}
]
}
]

Use to add or update

query Parameters

accountId required	string <guid>
domainId required	string <guid>
required	(DimensionType2 (object or null))
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

Array

code	string or null
name	string or null
latinName	string or null
minSize	number or null <decimal>
maxSize	number or null <decimal>
weightUnitId	string or null
lastModifiedAt	string or null <date-time>

Responses

Request samples

Payload

Content type

application/json

[{"code": "string",
"name": "string",
"latinName": "string",
"minSize": 0,
"maxSize": 0,
"weightUnitId": "string",
"lastModifiedAt": "2019-08-24T14:15:22Z"
}
]

Response samples

200
204
400
default

Content type

application/json

{"name": "string",
"dimensionType": "string",
"lastModifiedAt": "2019-08-24T14:15:22Z",
"values": [{"code": "string",
"name": "string",
"latinName": "string",
"minSize": 0,
"maxSize": 0,
"weightUnitId": "string",
"lastModifiedAt": "2019-08-24T14:15:22Z"
}
]
}

DeleteDimensionValues

query Parameters

accountId required	string <guid>
domainId required	string <guid>
required	(DimensionType2 (object or null))
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

Array

string

Responses

Request samples

Payload

Content type

application/json

["string"
]

Response samples

400
default

Content type

application/json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"applicationId": ["string"
],
"errors": {"property1": ["string"
],
"property2": ["string"
]
},
"property1": null,
"property2": null
}

Document

GetInvoiceAsync

path Parameters

invoiceNo

required

integer <int32>

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

default

Content type

application/json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"property1": null,
"property2": null
}

GetPurchaseInvoiceAsync

query Parameters

accountId required	string <guid>
domainId required	string <guid>
invoiceNo	string or null
vendor	string or null
userId	string <guid>
traceId	string <guid>

Responses

Response samples

400
404
default

Content type

application/json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"property1": null,
"property2": null
}

GetDocument

path Parameters

documentId

required

string <guid>

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

404
default

Content type

application/json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"property1": null,
"property2": null
}

Employee

GetEmployees

query Parameters

accountId required	string <guid>
domainId required	string <guid>
includeDeleted	boolean or null
userId	string <guid>
traceId	string <guid>

Responses

Response samples

200
default

Content type

application/json

[{"id": "string",
"employeeNo": 0,
"externalEmployeeNo": "string",
"active": true,
"firstName": "string",
"middleName": "string",
"lastName": "string",
"primaryEmail": "string",
"secondaryEmail": "string",
"phone": "string",
"mobilePhone": "string",
"address": {"addressId": "string",
"type": "Unspecified",
"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"address4": "string",
"zipCode": "string",
"city": "string",
"state": "string",
"countryCode": "string",
"gln": "string",
"routeNumber": "string"
}
}
]

PostEmployee

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

Array

id	string or null <guid>
employeeNo	integer or null <int32>
externalEmployeeNo	string or null
active required	boolean
firstName	string or null
middleName	string or null
lastName	string or null
primaryEmail	string or null
secondaryEmail	string or null
phone	string or null
mobilePhone	string or null
	(Address (object or null))

Responses

Request samples

Payload

Content type

application/json

[{"id": "string",
"employeeNo": 0,
"externalEmployeeNo": "string",
"active": true,
"firstName": "string",
"middleName": "string",
"lastName": "string",
"primaryEmail": "string",
"secondaryEmail": "string",
"phone": "string",
"mobilePhone": "string",
"address": {"addressId": "string",
"type": "Unspecified",
"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"address4": "string",
"zipCode": "string",
"city": "string",
"state": "string",
"countryCode": "string",
"gln": "string",
"routeNumber": "string"
}
}
]

Response samples

default

Content type

application/json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"property1": null,
"property2": null
}

GetEmployee

path Parameters

required

string

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

200
204
default

Content type

application/json

{"id": "string",
"employeeNo": 0,
"externalEmployeeNo": "string",
"active": true,
"firstName": "string",
"middleName": "string",
"lastName": "string",
"primaryEmail": "string",
"secondaryEmail": "string",
"phone": "string",
"mobilePhone": "string",
"address": {"addressId": "string",
"type": "Unspecified",
"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"address4": "string",
"zipCode": "string",
"city": "string",
"state": "string",
"countryCode": "string",
"gln": "string",
"routeNumber": "string"
}
}

PutEmployee

path Parameters

required

string

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

id	string or null <guid>
employeeNo	integer or null <int32>
externalEmployeeNo	string or null
active required	boolean
firstName	string or null
middleName	string or null
lastName	string or null
primaryEmail	string or null
secondaryEmail	string or null
phone	string or null
mobilePhone	string or null
	(Address (object or null))

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"employeeNo": 0,
"externalEmployeeNo": "string",
"active": true,
"firstName": "string",
"middleName": "string",
"lastName": "string",
"primaryEmail": "string",
"secondaryEmail": "string",
"phone": "string",
"mobilePhone": "string",
"address": {"addressId": "string",
"type": "Unspecified",
"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"address4": "string",
"zipCode": "string",
"city": "string",
"state": "string",
"countryCode": "string",
"gln": "string",
"routeNumber": "string"
}
}

Response samples

default

Content type

application/json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"property1": null,
"property2": null
}

ExpenseRegistration

GetById

path Parameters

expenseRegistrationId

required

string <guid>

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

Content type

application/json

{"expenseRegistrationId": "string",
"expenseRegistrationIdParent": "string",
"expenseRegistrationIdReversedBy": "string",
"documentNumber": "string",
"customerCode": "string",
"customerName": "string",
"type": "Invoice",
"description": "string",
"quantity": 0,
"unitPrice": 0,
"amount": 0,
"expenseItemId": "string",
"payrollCodeId": "string",
"datePosted": "2019-08-24",
"vesselId": "string",
"crewActorId": "string",
"fromERP": true,
"settlementHeaderId": "string",
"writeOnly": {"invoiceDocumentNumber": "string",
"crewNumber": "string",
"property1": null,
"property2": null
},
"readOnly": {"balance": 0,
"expenseItemCode": "string",
"expenseItemDescription": "string",
"payrollCode": "string",
"payrollDescription": "string",
"vesselCode": "string",
"vesselName": "string",
"crewName": "string",
"crewNumber": "string",
"parentDocumentNumber": "string",
"parentDescription": "string",
"settlementNo": "string",
"property1": null,
"property2": null
},
"property1": null,
"property2": null
}

Delete

path Parameters

expenseRegistrationId

required

string <guid>

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

Content type

application/json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"property1": null,
"property2": null
}

FindPaged

query Parameters

accountId required	string <guid>
domainId required	string <guid>
expenseRegistrationId	string or null <guid>
payrollCodeId	string or null <guid>
documentNumber	string or null
fromPostingDate	string or null <date>
toPostingDate	string or null <date>
vesselId	string or null <guid>
crewActorId	string or null <guid>
isPostedToLedger	boolean or null
isBalanceZero	boolean or null
	((ExpenseRegistrationType (string or null)))
skip	integer or null <int32>
take	integer or null <int32>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

Content type

application/json

{"items": [{"expenseRegistrationId": "string",
"expenseRegistrationIdParent": "string",
"expenseRegistrationIdReversedBy": "string",
"documentNumber": "string",
"customerCode": "string",
"customerName": "string",
"type": "Invoice",
"description": "string",
"quantity": 0,
"unitPrice": 0,
"amount": 0,
"expenseItemId": "string",
"payrollCodeId": "string",
"datePosted": "2019-08-24",
"vesselId": "string",
"crewActorId": "string",
"fromERP": true,
"settlementHeaderId": "string",
"writeOnly": {"invoiceDocumentNumber": "string",
"crewNumber": "string",
"property1": null,
"property2": null
},
"readOnly": {"balance": 0,
"expenseItemCode": "string",
"expenseItemDescription": "string",
"payrollCode": "string",
"payrollDescription": "string",
"vesselCode": "string",
"vesselName": "string",
"crewName": "string",
"crewNumber": "string",
"parentDocumentNumber": "string",
"parentDescription": "string",
"settlementNo": "string",
"property1": null,
"property2": null
},
"property1": null,
"property2": null
}
],
"skip": 0,
"totalResults": 0,
"property1": null,
"property2": null
}

Create

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

Array

expenseRegistrationId required	string <guid>
expenseRegistrationIdParent	string or null <guid> For Applied to Expense Registration
expenseRegistrationIdReversedBy	string or null <guid> When settlements are re-opened we need to create reversing ledger entries. This tracks whether or not an entry has already being reversed, while simultaneously giving us an audit trail on which entry is cancelling out which.
documentNumber	string or null
customerCode	string or null
customerName	string or null
type required	string (ExpenseRegistrationType) Enum: "Invoice" "Payment"
description	string or null
quantity required	number <decimal>
unitPrice required	number <decimal>
amount required	number <decimal> Always returns Quantity * UnitPrice
expenseItemId	string or null <guid>
payrollCodeId	string or null <guid>
datePosted	string or null <date> When DatePosted is non-null, this expense registration goes into the ledger.
vesselId	string or null <guid>
crewActorId	string or null <guid>
fromERP required	boolean
settlementHeaderId	string or null <guid>
	(WriteOnlyAttributes (object or null))
	(ReadOnlyAttributes3 (object or null))
property name* additional property	any or null

Responses

Request samples

Payload

Content type

application/json

[{"expenseRegistrationId": "string",
"expenseRegistrationIdParent": "string",
"expenseRegistrationIdReversedBy": "string",
"documentNumber": "string",
"customerCode": "string",
"customerName": "string",
"type": "Invoice",
"description": "string",
"quantity": 0,
"unitPrice": 0,
"amount": 0,
"expenseItemId": "string",
"payrollCodeId": "string",
"datePosted": "2019-08-24",
"vesselId": "string",
"crewActorId": "string",
"fromERP": true,
"settlementHeaderId": "string",
"writeOnly": {"invoiceDocumentNumber": "string",
"crewNumber": "string",
"property1": null,
"property2": null
},
"readOnly": {"balance": 0,
"expenseItemCode": "string",
"expenseItemDescription": "string",
"payrollCode": "string",
"payrollDescription": "string",
"vesselCode": "string",
"vesselName": "string",
"crewName": "string",
"crewNumber": "string",
"parentDocumentNumber": "string",
"parentDescription": "string",
"settlementNo": "string",
"property1": null,
"property2": null
},
"property1": null,
"property2": null
}
]

Response samples

Content type

application/json

[{"expenseRegistrationId": "string",
"expenseRegistrationIdParent": "string",
"expenseRegistrationIdReversedBy": "string",
"documentNumber": "string",
"customerCode": "string",
"customerName": "string",
"type": "Invoice",
"description": "string",
"quantity": 0,
"unitPrice": 0,
"amount": 0,
"expenseItemId": "string",
"payrollCodeId": "string",
"datePosted": "2019-08-24",
"vesselId": "string",
"crewActorId": "string",
"fromERP": true,
"settlementHeaderId": "string",
"writeOnly": {"invoiceDocumentNumber": "string",
"crewNumber": "string",
"property1": null,
"property2": null
},
"readOnly": {"balance": 0,
"expenseItemCode": "string",
"expenseItemDescription": "string",
"payrollCode": "string",
"payrollDescription": "string",
"vesselCode": "string",
"vesselName": "string",
"crewName": "string",
"crewNumber": "string",
"parentDocumentNumber": "string",
"parentDescription": "string",
"settlementNo": "string",
"property1": null,
"property2": null
},
"property1": null,
"property2": null
}
]

Update

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

Array

expenseRegistrationId required	string <guid>
expenseRegistrationIdParent	string or null <guid> For Applied to Expense Registration
expenseRegistrationIdReversedBy	string or null <guid> When settlements are re-opened we need to create reversing ledger entries. This tracks whether or not an entry has already being reversed, while simultaneously giving us an audit trail on which entry is cancelling out which.
documentNumber	string or null
customerCode	string or null
customerName	string or null
type required	string (ExpenseRegistrationType) Enum: "Invoice" "Payment"
description	string or null
quantity required	number <decimal>
unitPrice required	number <decimal>
amount required	number <decimal> Always returns Quantity * UnitPrice
expenseItemId	string or null <guid>
payrollCodeId	string or null <guid>
datePosted	string or null <date> When DatePosted is non-null, this expense registration goes into the ledger.
vesselId	string or null <guid>
crewActorId	string or null <guid>
fromERP required	boolean
settlementHeaderId	string or null <guid>
	(WriteOnlyAttributes (object or null))
	(ReadOnlyAttributes3 (object or null))
property name* additional property	any or null

Responses

Request samples

Payload

Content type

application/json

[{"expenseRegistrationId": "string",
"expenseRegistrationIdParent": "string",
"expenseRegistrationIdReversedBy": "string",
"documentNumber": "string",
"customerCode": "string",
"customerName": "string",
"type": "Invoice",
"description": "string",
"quantity": 0,
"unitPrice": 0,
"amount": 0,
"expenseItemId": "string",
"payrollCodeId": "string",
"datePosted": "2019-08-24",
"vesselId": "string",
"crewActorId": "string",
"fromERP": true,
"settlementHeaderId": "string",
"writeOnly": {"invoiceDocumentNumber": "string",
"crewNumber": "string",
"property1": null,
"property2": null
},
"readOnly": {"balance": 0,
"expenseItemCode": "string",
"expenseItemDescription": "string",
"payrollCode": "string",
"payrollDescription": "string",
"vesselCode": "string",
"vesselName": "string",
"crewName": "string",
"crewNumber": "string",
"parentDocumentNumber": "string",
"parentDescription": "string",
"settlementNo": "string",
"property1": null,
"property2": null
},
"property1": null,
"property2": null
}
]

Response samples

Content type

application/json

[{"expenseRegistrationId": "string",
"expenseRegistrationIdParent": "string",
"expenseRegistrationIdReversedBy": "string",
"documentNumber": "string",
"customerCode": "string",
"customerName": "string",
"type": "Invoice",
"description": "string",
"quantity": 0,
"unitPrice": 0,
"amount": 0,
"expenseItemId": "string",
"payrollCodeId": "string",
"datePosted": "2019-08-24",
"vesselId": "string",
"crewActorId": "string",
"fromERP": true,
"settlementHeaderId": "string",
"writeOnly": {"invoiceDocumentNumber": "string",
"crewNumber": "string",
"property1": null,
"property2": null
},
"readOnly": {"balance": 0,
"expenseItemCode": "string",
"expenseItemDescription": "string",
"payrollCode": "string",
"payrollDescription": "string",
"vesselCode": "string",
"vesselName": "string",
"crewName": "string",
"crewNumber": "string",
"parentDocumentNumber": "string",
"parentDescription": "string",
"settlementNo": "string",
"property1": null,
"property2": null
},
"property1": null,
"property2": null
}
]

PostToLedger

query Parameters

accountId required	string <guid>
domainId required	string <guid>
localDate	string <date>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

Array

string <guid>

Responses

Request samples

Payload

Content type

application/json

["string"
]

Response samples

Content type

application/json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"property1": null,
"property2": null
}

Exporter

GetExporters

query Parameters

accountId required	string <guid>
domainId required	string <guid>
exporterNo	integer or null <int32>
changedSince	string or null <date-time>
includeDeleted	boolean or null
userId	string <guid>
traceId	string <guid>

Responses

Response samples

200
default

Content type

application/json

[{"id": "string",
"exporterNo": 0,
"externalExporterNo": "string",
"name": "string",
"active": true,
"organizationNo": "string",
"vatIdentificationNo": "string",
"currencyCode": "string",
"languageCode": "string",
"primaryEmail": "string",
"secondaryEmail": "string",
"phone": "string",
"mobilePhone": "string",
"ledgerNo": "string",
"eori": "string",
"vatRequired": true,
"addresses": [{"addressId": "string",
"type": "Unspecified",
"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"address4": "string",
"zipCode": "string",
"city": "string",
"state": "string",
"countryCode": "string",
"gln": "string",
"routeNumber": "string"
}
],
"contactInformation": [{"contactId": "string",
"firstName": "string",
"lastName": "string",
"primaryEmail": "string",
"secondaryEmail": "string",
"phone": "string",
"mobilePhone": "string"
}
],
"lastModifiedAt": "2019-08-24T14:15:22Z"
}
]

PostExporter

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

Array

id	string or null <guid>
exporterNo	integer or null <int32>
externalExporterNo	string or null
name	string or null
active required	boolean
organizationNo	string or null
vatIdentificationNo	string or null
currencyCode	string or null
languageCode	string or null
primaryEmail	string or null
secondaryEmail	string or null
phone	string or null
mobilePhone	string or null
ledgerNo	string or null
eori	string or null
vatRequired required	boolean
	Array of objects or null (Address)
	Array of objects or null (ContactInformation)
lastModifiedAt	string or null <date-time>

Responses

Request samples

Payload

Content type

application/json

[{"id": "string",
"exporterNo": 0,
"externalExporterNo": "string",
"name": "string",
"active": true,
"organizationNo": "string",
"vatIdentificationNo": "string",
"currencyCode": "string",
"languageCode": "string",
"primaryEmail": "string",
"secondaryEmail": "string",
"phone": "string",
"mobilePhone": "string",
"ledgerNo": "string",
"eori": "string",
"vatRequired": true,
"addresses": [{"addressId": "string",
"type": "Unspecified",
"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"address4": "string",
"zipCode": "string",
"city": "string",
"state": "string",
"countryCode": "string",
"gln": "string",
"routeNumber": "string"
}
],
"contactInformation": [{"contactId": "string",
"firstName": "string",
"lastName": "string",
"primaryEmail": "string",
"secondaryEmail": "string",
"phone": "string",
"mobilePhone": "string"
}
],
"lastModifiedAt": "2019-08-24T14:15:22Z"
}
]

Response samples

default

Content type

application/json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"property1": null,
"property2": null
}

GetExporter

path Parameters

required

string

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

200
204
default

Content type

application/json

{"id": "string",
"exporterNo": 0,
"externalExporterNo": "string",
"name": "string",
"active": true,
"organizationNo": "string",
"vatIdentificationNo": "string",
"currencyCode": "string",
"languageCode": "string",
"primaryEmail": "string",
"secondaryEmail": "string",
"phone": "string",
"mobilePhone": "string",
"ledgerNo": "string",
"eori": "string",
"vatRequired": true,
"addresses": [{"addressId": "string",
"type": "Unspecified",
"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"address4": "string",
"zipCode": "string",
"city": "string",
"state": "string",
"countryCode": "string",
"gln": "string",
"routeNumber": "string"
}
],
"contactInformation": [{"contactId": "string",
"firstName": "string",
"lastName": "string",
"primaryEmail": "string",
"secondaryEmail": "string",
"phone": "string",
"mobilePhone": "string"
}
],
"lastModifiedAt": "2019-08-24T14:15:22Z"
}

PutExporter

path Parameters

required

string

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

id	string or null <guid>
exporterNo	integer or null <int32>
externalExporterNo	string or null
name	string or null
active required	boolean
organizationNo	string or null
vatIdentificationNo	string or null
currencyCode	string or null
languageCode	string or null
primaryEmail	string or null
secondaryEmail	string or null
phone	string or null
mobilePhone	string or null
ledgerNo	string or null
eori	string or null
vatRequired required	boolean
	Array of objects or null (Address)
	Array of objects or null (ContactInformation)
lastModifiedAt	string or null <date-time>

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"exporterNo": 0,
"externalExporterNo": "string",
"name": "string",
"active": true,
"organizationNo": "string",
"vatIdentificationNo": "string",
"currencyCode": "string",
"languageCode": "string",
"primaryEmail": "string",
"secondaryEmail": "string",
"phone": "string",
"mobilePhone": "string",
"ledgerNo": "string",
"eori": "string",
"vatRequired": true,
"addresses": [{"addressId": "string",
"type": "Unspecified",
"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"address4": "string",
"zipCode": "string",
"city": "string",
"state": "string",
"countryCode": "string",
"gln": "string",
"routeNumber": "string"
}
],
"contactInformation": [{"contactId": "string",
"firstName": "string",
"lastName": "string",
"primaryEmail": "string",
"secondaryEmail": "string",
"phone": "string",
"mobilePhone": "string"
}
],
"lastModifiedAt": "2019-08-24T14:15:22Z"
}

Response samples

default

Content type

application/json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"property1": null,
"property2": null
}

GetExporterAddresses

path Parameters

required

string

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

200
default

Content type

application/json

[{"addressId": "string",
"type": "Unspecified",
"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"address4": "string",
"zipCode": "string",
"city": "string",
"state": "string",
"countryCode": "string",
"gln": "string",
"routeNumber": "string"
}
]

PostExporterAddresses

path Parameters

required

string

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

Array

addressId	string or null <guid>
type required	string (AddressType) Enum: "Unspecified" "InvoiceAddress" "DeliveryAddress"
name	string or null
address1	string or null
address2	string or null
address3	string or null
address4	string or null
zipCode	string or null
city	string or null
state	string or null
countryCode	string or null
gln	string or null
routeNumber	string or null

Responses

Request samples

Payload

Content type

application/json

[{"addressId": "string",
"type": "Unspecified",
"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"address4": "string",
"zipCode": "string",
"city": "string",
"state": "string",
"countryCode": "string",
"gln": "string",
"routeNumber": "string"
}
]

Response samples

default

Content type

application/json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"property1": null,
"property2": null
}

PutExporterAddresses

path Parameters

required

string

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

Array

addressId	string or null <guid>
type required	string (AddressType) Enum: "Unspecified" "InvoiceAddress" "DeliveryAddress"
name	string or null
address1	string or null
address2	string or null
address3	string or null
address4	string or null
zipCode	string or null
city	string or null
state	string or null
countryCode	string or null
gln	string or null
routeNumber	string or null

Responses

Request samples

Payload

Content type

application/json

[{"addressId": "string",
"type": "Unspecified",
"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"address4": "string",
"zipCode": "string",
"city": "string",
"state": "string",
"countryCode": "string",
"gln": "string",
"routeNumber": "string"
}
]

Response samples

default

Content type

application/json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"property1": null,
"property2": null
}

ExternalApiCall

Debug external api calls

Accept external api call and forward them to a message in the messageing system

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

default

Content type

application/json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"property1": null,
"property2": null
}

Debug external api calls

Accept external api call and forward them to a message in the messageing system

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

default

Content type

application/json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"property1": null,
"property2": null
}

Debug external api calls

Accept external api call and forward them to a message in the messageing system

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

default

Content type

application/json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"property1": null,
"property2": null
}

Debug external api calls

Accept external api call and forward them to a message in the messageing system

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

default

Content type

application/json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"property1": null,
"property2": null
}

Factoring

GetSalesInvoices

query Parameters

accountId required	string <guid>
domainId required	string <guid>
Type	string or null
InvoiceStatus	Array of strings (InvoiceStatus) Items Enum: "Draft" "Sent" "Posted"
FactoringStatus	Array of strings or null (FactoringStatus) Enum: "NotReady" "Ready" "Factored"
CustomerNo	Array of integers <int32> [ items <int32 > ]
FromInvoiceDate	string or null <date>
ToInvoiceDate	string or null <date>
FromPostingDate	string or null <date>
ToPostingDate	string or null <date>
PostedSince	string or null <date-time> Get invoices posted since this timestamp
SentSince	string or null <date-time> Get invoices sent since this timestamp
FromDueDate	string or null <date>
ToDueDate	string or null <date>
InvoiceNos	Array of integers or null <int32> [ items <int32 > ]
InvoiceIds	Array of strings or null <guid> [ items <guid > ]
IsFactoring	boolean or null
IsCreditNote	boolean or null
FromFactoringDate	string or null <date>
ToFactoringDate	string or null <date>
ContinuationToken	string or null Used to request the next page of results
Limit	integer <int32> Maximum number of results to return
userId	string <guid>
traceId	string <guid>

Responses

Response samples

200
204
default

Content type

application/json

{"data": [{"id": "string",
"number": 0,
"isCreditNote": true,
"status": "string",
"date": "2019-08-24",
"dueDate": "2019-08-24",
"currency": "str",
"exchangeRate": 0,
"address": {"description": "string",
"line1": "string",
"line2": "string",
"line3": "string",
"line4": "string",
"postCode": "string",
"country": "st",
"city": "string",
"state": "string"
},
"kid": "string",
"paymentTerms": {"name": "string"
},
"totalNetAmount": 0,
"totalGrossAmount": 0,
"totalVatAmounts": [{"amount": 0,
"rate": {"id": "string",
"percent": 0,
"description": "string"
},
"taxableAmount": 0
}
],
"lines": [{"id": "string",
"orderId": "string",
"orderLineId": ["string"
],
"description": "string",
"netAmount": 0,
"grossAmount": 0,
"vatRate": {"id": "string",
"percent": 0,
"description": "string"
},
"price": 0,
"quantity": 0,
"itemId": "string"
}
],
"orders": [{"id": "string",
"number": 0,
"date": "2019-08-24",
"arrivalDate": "2019-08-24",
"shipmentDate": "2019-08-24",
"deliveryAddress": {"description": "string",
"line1": "string",
"line2": "string",
"line3": "string",
"line4": "string",
"postCode": "string",
"country": "st",
"city": "string",
"state": "string"
},
"dimensions": [{"dimensionId": "string",
"dimensionName": "string",
"dimensionDetailId": "string",
"dimensionDetailName": "string"
}
]
}
],
"type": "string",
"customer": {"id": "string",
"number": "string",
"externalNumber": "string",
"name": "string",
"organizationNumber": "string",
"vatNumber": "string",
"eori": "string",
"email": "string",
"phone": "string"
},
"yourReference": "string",
"ourReference": "string",
"isFactoring": true,
"factoringStatus": "string",
"customsReceiptNo": "string"
}
]
}

UpdateFactoringStatus

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

Array

invoiceId	string or null <guid>
invoiceNo	integer or null <int32>
isComplete	boolean or null

Responses

Request samples

Payload

Content type

application/json

[{"invoiceId": "string",
"invoiceNo": 0,
"isComplete": true
}
]

Response samples

200
204
default

Content type

application/json

{"data": [{"invoiceId": "string",
"invoiceNo": 0,
"isComplete": true
}
]
}

FishingTrip

GetById2

path Parameters

fishingTripHeaderId

required

string <guid>

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

Content type

application/json

{"fishingTripHeaderId": "string",
"fishingTripStatus": "Open",
"fishingTripNo": "string",
"fishTicketNo": "string",
"vesselId": "string",
"quotaPermitId": "string",
"quotaDescription": "string",
"tenderVesselCode": "string",
"fishingEquipmentId": "string",
"fishingAreaId": "string",
"speciesId": "string",
"startDate": "2019-08-24",
"endDate": "2019-08-24",
"landingDate": "2019-08-24",
"etaDate": "2019-08-24",
"noOfDays": 0,
"portOfLandingId": "string",
"warehouseId": "string",
"packingPlantId": "string",
"defaultLotNo": "string",
"settlementHeaderId": "string",
"purchaseOrderId": "string",
"purchaseOrderNo": "string",
"postedBy": "string",
"postedAt": "2019-08-24T14:15:22Z",
"fishingTripItems": [{"id": "string",
"accountId": "string",
"domainId": "string",
"createdBy": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"updatedAt": "2019-08-24T14:15:22Z",
"isDeleted": true,
"property1": null,
"property2": null,
"fishingTripItemLineId": "string",
"fishingTripHeaderId": "string",
"lineNo": 0,
"itemId": "string",
"itemCode": "string",
"itemName": "string",
"nofUnits": 0,
"grossWeight": 0,
"netWeight": 0,
"price": 0,
"amount": 0,
"isDiscard": true
}
],
"fishingTripFees": [{"id": "string",
"accountId": "string",
"domainId": "string",
"createdBy": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"updatedAt": "2019-08-24T14:15:22Z",
"isDeleted": true,
"property1": null,
"property2": null,
"fishingTripLandingFeeId": "string",
"fishingTripHeaderId": "string",
"lineNo": 0,
"landingFeeId": "string",
"quantity": 0,
"costPerQty": 0,
"amount": 0,
"isSystemGenerated": true,
"isModified": true
}
],
"property1": null,
"property2": null
}

Delete2

path Parameters

fishingTripHeaderId

required

string <guid>

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

Content type

application/json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"property1": null,
"property2": null
}

FindPaged2

query Parameters

accountId required	string <guid>
domainId required	string <guid>
FishingTripHeaderId	string or null Comma separated list of fishingTripHeaderId
SettlementHeaderId	string or null <guid>
IsSettlementHeaderIdNull	boolean or null
	(FishingTripStatus (string or null))
FishingTripNo	string or null
FishTicketNo	string or null
VesselId	string or null <guid>
FromStartDate	string or null <date>
ToStartDate	string or null <date>
FromEndDate	string or null <date>
ToEndDate	string or null <date>
FromLandingDate	string or null <date>
ToLandingDate	string or null <date>
Species	string or null
PurchaseOrderNo	string or null
VendorId	string or null <guid>
Skip	integer or null <int32>
Take	integer or null <int32>
OrderBy	string or null
	object or null
userId	string <guid>
traceId	string <guid>

Responses

Response samples

Content type

application/json

{"items": [{"fishingTripHeaderId": "string",
"fishingTripStatus": "Open",
"fishingTripNo": "string",
"fishTicketNo": "string",
"vesselId": "string",
"vesselCode": "string",
"vesselName": "string",
"startDate": "2019-08-24",
"endDate": "2019-08-24",
"landingDate": "2019-08-24",
"postedBy": "string",
"postedAt": "2019-08-24T14:15:22Z",
"tripsWithinYear": 0,
"fishingAreaId": "string",
"fishingEquipmentId": "string",
"fishingEquipmentDescription": "string",
"portOfLandingId": "string",
"settlementHeaderId": "string",
"settlementNo": "string",
"settlementStatus": "Open",
"purchaseOrderId": "string",
"purchaseOrderNo": "string",
"species": ["string"
],
"vendorId": "string",
"vendorNumber": "string",
"vendorName": "string",
"property1": null,
"property2": null
}
],
"skip": 0,
"totalResults": 0,
"property1": null,
"property2": null
}

Import

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

	Array of objects or null (Item)
flags required	string (FishingTripImportFlags) Enum: "NotSet" "ContinueOnError" "Logging"
property name* additional property	any or null

Responses

Request samples

Payload

Content type

application/json

{"items": [{"ticketNumber": "string",
"vesselCode": "string",
"quotaPermitCode": "string",
"startDate": "2019-08-24",
"endDate": "2019-08-24",
"landingDate": "2019-08-24",
"etaDate": "2019-08-24",
"portOfLandingCode": "string",
"fishingAreaCode": "string",
"warehouseCode": "string",
"itemLineNumber": 0,
"itemCode": "string",
"itemQty": 0,
"itemPrice": 0,
"deleteAction": "NotSet",
"property1": null,
"property2": null
}
],
"flags": "NotSet",
"property1": null,
"property2": null
}

Response samples

Content type

application/json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"property1": null,
"property2": null
}

Create2

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

Array

fishingTripHeaderId required	string <guid>
fishingTripStatus required	string (FishingTripStatus) Enum: "Open" "Posted"
fishingTripNo	string or null
fishTicketNo	string or null
vesselId	string or null <guid>
quotaPermitId	string or null <guid>
quotaDescription	string or null
tenderVesselCode	string or null
fishingEquipmentId	string or null <guid>
fishingAreaId	string or null <guid>
speciesId	string or null <guid>
startDate	string or null <date>
endDate	string or null <date>
landingDate	string or null <date>
etaDate	string or null <date>
noOfDays	integer or null <int32>
portOfLandingId	string or null <guid>
warehouseId	string or null <guid>
packingPlantId	string or null <guid>
defaultLotNo	string or null
settlementHeaderId	string or null <guid>
purchaseOrderId	string or null <guid>
purchaseOrderNo	string or null
postedBy	string or null <guid>
postedAt	string or null <date-time>
	Array of objects or null (FishingTripItemLineEntity)
	Array of objects or null (FishingTripLandingFeeEntity)
property name* additional property	any or null

Responses

Request samples

Payload

Content type

application/json

[{"fishingTripHeaderId": "string",
"fishingTripStatus": "Open",
"fishingTripNo": "string",
"fishTicketNo": "string",
"vesselId": "string",
"quotaPermitId": "string",
"quotaDescription": "string",
"tenderVesselCode": "string",
"fishingEquipmentId": "string",
"fishingAreaId": "string",
"speciesId": "string",
"startDate": "2019-08-24",
"endDate": "2019-08-24",
"landingDate": "2019-08-24",
"etaDate": "2019-08-24",
"noOfDays": 0,
"portOfLandingId": "string",
"warehouseId": "string",
"packingPlantId": "string",
"defaultLotNo": "string",
"settlementHeaderId": "string",
"purchaseOrderId": "string",
"purchaseOrderNo": "string",
"postedBy": "string",
"postedAt": "2019-08-24T14:15:22Z",
"fishingTripItems": [{"id": "string",
"accountId": "string",
"domainId": "string",
"createdBy": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"updatedAt": "2019-08-24T14:15:22Z",
"isDeleted": true,
"property1": null,
"property2": null,
"fishingTripItemLineId": "string",
"fishingTripHeaderId": "string",
"lineNo": 0,
"itemId": "string",
"itemCode": "string",
"itemName": "string",
"nofUnits": 0,
"grossWeight": 0,
"netWeight": 0,
"price": 0,
"amount": 0,
"isDiscard": true
}
],
"fishingTripFees": [{"id": "string",
"accountId": "string",
"domainId": "string",
"createdBy": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"updatedAt": "2019-08-24T14:15:22Z",
"isDeleted": true,
"property1": null,
"property2": null,
"fishingTripLandingFeeId": "string",
"fishingTripHeaderId": "string",
"lineNo": 0,
"landingFeeId": "string",
"quantity": 0,
"costPerQty": 0,
"amount": 0,
"isSystemGenerated": true,
"isModified": true
}
],
"property1": null,
"property2": null
}
]

Response samples

Content type

application/json

[{"fishingTripHeaderId": "string",
"fishingTripStatus": "Open",
"fishingTripNo": "string",
"fishTicketNo": "string",
"vesselId": "string",
"quotaPermitId": "string",
"quotaDescription": "string",
"tenderVesselCode": "string",
"fishingEquipmentId": "string",
"fishingAreaId": "string",
"speciesId": "string",
"startDate": "2019-08-24",
"endDate": "2019-08-24",
"landingDate": "2019-08-24",
"etaDate": "2019-08-24",
"noOfDays": 0,
"portOfLandingId": "string",
"warehouseId": "string",
"packingPlantId": "string",
"defaultLotNo": "string",
"settlementHeaderId": "string",
"purchaseOrderId": "string",
"purchaseOrderNo": "string",
"postedBy": "string",
"postedAt": "2019-08-24T14:15:22Z",
"fishingTripItems": [{"id": "string",
"accountId": "string",
"domainId": "string",
"createdBy": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"updatedAt": "2019-08-24T14:15:22Z",
"isDeleted": true,
"property1": null,
"property2": null,
"fishingTripItemLineId": "string",
"fishingTripHeaderId": "string",
"lineNo": 0,
"itemId": "string",
"itemCode": "string",
"itemName": "string",
"nofUnits": 0,
"grossWeight": 0,
"netWeight": 0,
"price": 0,
"amount": 0,
"isDiscard": true
}
],
"fishingTripFees": [{"id": "string",
"accountId": "string",
"domainId": "string",
"createdBy": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"updatedAt": "2019-08-24T14:15:22Z",
"isDeleted": true,
"property1": null,
"property2": null,
"fishingTripLandingFeeId": "string",
"fishingTripHeaderId": "string",
"lineNo": 0,
"landingFeeId": "string",
"quantity": 0,
"costPerQty": 0,
"amount": 0,
"isSystemGenerated": true,
"isModified": true
}
],
"property1": null,
"property2": null
}
]

Update2

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

Array

fishingTripHeaderId required	string <guid>
fishingTripStatus required	string (FishingTripStatus) Enum: "Open" "Posted"
fishingTripNo	string or null
fishTicketNo	string or null
vesselId	string or null <guid>
quotaPermitId	string or null <guid>
quotaDescription	string or null
tenderVesselCode	string or null
fishingEquipmentId	string or null <guid>
fishingAreaId	string or null <guid>
speciesId	string or null <guid>
startDate	string or null <date>
endDate	string or null <date>
landingDate	string or null <date>
etaDate	string or null <date>
noOfDays	integer or null <int32>
portOfLandingId	string or null <guid>
warehouseId	string or null <guid>
packingPlantId	string or null <guid>
defaultLotNo	string or null
settlementHeaderId	string or null <guid>
purchaseOrderId	string or null <guid>
purchaseOrderNo	string or null
postedBy	string or null <guid>
postedAt	string or null <date-time>
	Array of objects or null (FishingTripItemLineEntity)
	Array of objects or null (FishingTripLandingFeeEntity)
property name* additional property	any or null

Responses

Request samples

Payload

Content type

application/json

[{"fishingTripHeaderId": "string",
"fishingTripStatus": "Open",
"fishingTripNo": "string",
"fishTicketNo": "string",
"vesselId": "string",
"quotaPermitId": "string",
"quotaDescription": "string",
"tenderVesselCode": "string",
"fishingEquipmentId": "string",
"fishingAreaId": "string",
"speciesId": "string",
"startDate": "2019-08-24",
"endDate": "2019-08-24",
"landingDate": "2019-08-24",
"etaDate": "2019-08-24",
"noOfDays": 0,
"portOfLandingId": "string",
"warehouseId": "string",
"packingPlantId": "string",
"defaultLotNo": "string",
"settlementHeaderId": "string",
"purchaseOrderId": "string",
"purchaseOrderNo": "string",
"postedBy": "string",
"postedAt": "2019-08-24T14:15:22Z",
"fishingTripItems": [{"id": "string",
"accountId": "string",
"domainId": "string",
"createdBy": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"updatedAt": "2019-08-24T14:15:22Z",
"isDeleted": true,
"property1": null,
"property2": null,
"fishingTripItemLineId": "string",
"fishingTripHeaderId": "string",
"lineNo": 0,
"itemId": "string",
"itemCode": "string",
"itemName": "string",
"nofUnits": 0,
"grossWeight": 0,
"netWeight": 0,
"price": 0,
"amount": 0,
"isDiscard": true
}
],
"fishingTripFees": [{"id": "string",
"accountId": "string",
"domainId": "string",
"createdBy": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"updatedAt": "2019-08-24T14:15:22Z",
"isDeleted": true,
"property1": null,
"property2": null,
"fishingTripLandingFeeId": "string",
"fishingTripHeaderId": "string",
"lineNo": 0,
"landingFeeId": "string",
"quantity": 0,
"costPerQty": 0,
"amount": 0,
"isSystemGenerated": true,
"isModified": true
}
],
"property1": null,
"property2": null
}
]

Response samples

Content type

application/json

[{"fishingTripHeaderId": "string",
"fishingTripStatus": "Open",
"fishingTripNo": "string",
"fishTicketNo": "string",
"vesselId": "string",
"quotaPermitId": "string",
"quotaDescription": "string",
"tenderVesselCode": "string",
"fishingEquipmentId": "string",
"fishingAreaId": "string",
"speciesId": "string",
"startDate": "2019-08-24",
"endDate": "2019-08-24",
"landingDate": "2019-08-24",
"etaDate": "2019-08-24",
"noOfDays": 0,
"portOfLandingId": "string",
"warehouseId": "string",
"packingPlantId": "string",
"defaultLotNo": "string",
"settlementHeaderId": "string",
"purchaseOrderId": "string",
"purchaseOrderNo": "string",
"postedBy": "string",
"postedAt": "2019-08-24T14:15:22Z",
"fishingTripItems": [{"id": "string",
"accountId": "string",
"domainId": "string",
"createdBy": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"updatedAt": "2019-08-24T14:15:22Z",
"isDeleted": true,
"property1": null,
"property2": null,
"fishingTripItemLineId": "string",
"fishingTripHeaderId": "string",
"lineNo": 0,
"itemId": "string",
"itemCode": "string",
"itemName": "string",
"nofUnits": 0,
"grossWeight": 0,
"netWeight": 0,
"price": 0,
"amount": 0,
"isDiscard": true
}
],
"fishingTripFees": [{"id": "string",
"accountId": "string",
"domainId": "string",
"createdBy": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"updatedAt": "2019-08-24T14:15:22Z",
"isDeleted": true,
"property1": null,
"property2": null,
"fishingTripLandingFeeId": "string",
"fishingTripHeaderId": "string",
"lineNo": 0,
"landingFeeId": "string",
"quantity": 0,
"costPerQty": 0,
"amount": 0,
"isSystemGenerated": true,
"isModified": true
}
],
"property1": null,
"property2": null
}
]

ForexHedge

PostSb1MContract

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

transEx required	integer <int64>
ordNumber	string or null
originalTransactionNumber	string or null
transactionCancellationFlag required	integer <int32>
createTimeStamp required	string <date-time>
changeTimeStamp required	string <date-time>
actualTransactionStatus required	integer <int32>
transactionCode	string or null
channel	string or null
freeCom	string or null
bruker	string or null
instrumentType required	integer <int32>
portfolio	string or null
counterparty	string or null
tradeDate required	string <date-time>
paymentDate required	string <date-time>
currencyCross	string or null
ticsFactor required	integer <int32>
currencyLeg1	string or null
currencyLeg2	string or null
nominalLeg1 required	number <decimal>
nominalLeg2 required	number <decimal>
maturityDateLeg1 required	string <date-time>
maturityDateLeg2 required	string <date-time>
spotRateLeg1 required	number <decimal>
ticsLeg1 required	number <decimal>
forwardRateLeg1 required	number <decimal>
quasarFwdPips required	number <decimal>
quasarSpotPips required	number <decimal>
dealer	string or null
owner	string or null
kbSpotBps required	number <decimal>
kdFwdBps required	number <decimal>
orgNo	string or null
forretning	string or null

Responses

Request samples

Payload

Content type

application/json

{"transEx": 20220701000001,
"ordNumber": "6371:4514",
"originalTransactionNumber": "10010677",
"transactionCancellationFlag": 0,
"createTimeStamp": "2022-07-01",
"changeTimeStamp": "2022-07-01",
"actualTransactionStatus": 5,
"transactionCode": "SellFXSpot",
"channel": "TEST_APH",
"freeCom": "Test spot 01072022",
"bruker": null,
"instrumentType": 14,
"portfolio": "SMN VALUTA",
"counterparty": "INTERN FX SMN",
"tradeDate": "2022-07-01",
"paymentDate": "2022-07-05",
"currencyCross": "EUR/NOK",
"ticsFactor": 1,
"currencyLeg1": "EUR",
"currencyLeg2": "NOK",
"nominalLeg1": 4000000,
"nominalLeg2": 41568800,
"maturityDateLeg1": "2022-07-05",
"maturityDateLeg2": "2022-07-05",
"spotRateLeg1": 10.3922,
"ticsLeg1": 0,
"forwardRateLeg1": 10.3922,
"quasarFwdPips": 0,
"quasarSpotPips": 60,
"dealer": "WG",
"owner": "WG",
"kbSpotBps": 27,
"kdFwdBps": 0,
"orgNo": "123123123",
"forretning": "FX Spot + FX Derivatives + Maritech"
}

Response samples

200
204
400
default

Content type

application/json

{"id": "string",
"dealId": "string",
"amount": 0,
"exchangedAmount": 0,
"exchangedCurrencyId": "string",
"currencyId": "string",
"exchangeRate": 0,
"contractDate": "2019-08-24",
"settlementDate": "2019-08-24",
"comment": "string",
"status": "Unconfirmed",
"tradeProduct": "string",
"userName": "string",
"tradeStatus": "string",
"settlementId": "string",
"vendorId": "string",
"vendorName": "string",
"bundleId": "string",
"transferredFromBundleId": "string",
"transferredToBundleId": "string",
"bankId": "string",
"bankName": "string",
"property1": null,
"property2": null
}

PostContract

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

amount required	number <decimal>
currencyId	string
exchangeRate required	number <decimal>
exchangedCurrencyId	string or null
exchangedAmount	number or null <decimal>
contractDate required	string <date>
settlementDate required	string <date>
bundleId	string or null <guid>
vendorId	string or null <guid>
dealId	string or null
bankId	string or null
comment	string or null
tradeProduct	string or null
userName	string or null
tradeStatus	string or null
settlementId	string or null
property name* additional property	any

Responses

Request samples

Payload

Content type

application/json

{"amount": 0,
"currencyId": "string",
"exchangeRate": 0,
"exchangedCurrencyId": "string",
"exchangedAmount": 0,
"contractDate": "2019-08-24",
"settlementDate": "2019-08-24",
"bundleId": "string",
"vendorId": "string",
"dealId": "string",
"bankId": "string",
"comment": "string",
"tradeProduct": "string",
"userName": "string",
"tradeStatus": "string",
"settlementId": "string",
"property1": null,
"property2": null
}

Response samples

200
204
400
default

Content type

application/json

{"id": "string",
"dealId": "string",
"amount": 0,
"exchangedAmount": 0,
"exchangedCurrencyId": "string",
"currencyId": "string",
"exchangeRate": 0,
"contractDate": "2019-08-24",
"settlementDate": "2019-08-24",
"comment": "string",
"status": "Unconfirmed",
"tradeProduct": "string",
"userName": "string",
"tradeStatus": "string",
"settlementId": "string",
"vendorId": "string",
"vendorName": "string",
"bundleId": "string",
"transferredFromBundleId": "string",
"transferredToBundleId": "string",
"bankId": "string",
"bankName": "string",
"property1": null,
"property2": null
}

FxTradeImport

Import one or more FX trades and create corresponding currency hedge contracts.

Each trade in the request is processed individually. The response always contains one FxTradeImportResult per trade, regardless of whether that trade succeeded or failed.

The DealtCurrency field determines which side of the trade is used as the contract amount: If DealtCurrency matches SellCurrency, the sell side becomes the contract amount. If DealtCurrency matches BuyCurrency, the buy side becomes the contract amount.

Each FxTradeImportResult contains: Id — The unique identifier of the created contract (null on failure). DealId — The bank deal identifier echoed back from the request. Success — Whether the trade was imported successfully. Error — Error detail if the trade failed (null on success).

Status codes: 200 — All trades were imported successfully. 207 — Partial success. One or more trades failed; inspect individual results for details.

Clients should check the Success property on each result and retry only failed DealId values.

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

The FX trade import request containing one or more trades.

required

Array of objects (FXTrade) non-empty

Responses

Request samples

Payload

Content type

application/json

{"trades": [{"dealId": "string",
"tradeDate": "2019-08-24T14:15:22Z",
"valueDate": "2019-08-24",
"buyAmount": 0,
"buyCurrency": "str",
"sellAmount": 0,
"sellCurrency": "str",
"spotRate": 0,
"allInRate": 0,
"forwardPoints": 0,
"company": "string",
"dealtCurrency": "str",
"productType": "string",
"currencyPair": "string",
"customerReference": "string",
"bankId": "string",
"userName": "string"
}
]
}

Response samples

Content type

application/json

[{"id": "string",
"dealId": "string",
"success": true,
"error": "string"
}
]

GeneralLedger

GetGeneralLedgers

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

200
default

Content type

application/json

[{"ledgerNo": "string",
"name": "string",
"active": true,
"vatCode": "string",
"ledgerType": "Sale"
}
]

PostGeneralLedgers

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

Array

ledgerNo	string or null
name	string or null
active required	boolean
vatCode	string or null
ledgerType required	string (LedgerType) Enum: "Sale" "Purchase" "Cost" "Vat" "CashRounding" "Currency"

Responses

Request samples

Payload

Content type

application/json

[{"ledgerNo": "string",
"name": "string",
"active": true,
"vatCode": "string",
"ledgerType": "Sale"
}
]

Response samples

200
default

Content type

application/json

[{"ledgerNo": "string",
"name": "string",
"active": true,
"vatCode": "string",
"ledgerType": "Sale"
}
]

GetGeneralLedgers2

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

200
default

Content type

application/json

[{"ledgerNo": "string",
"name": "string",
"active": true,
"vatCode": "string",
"ledgerType": "Sale"
}
]

PostGeneralLedgers2

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

Array

ledgerNo	string or null
name	string or null
active required	boolean
vatCode	string or null
ledgerType required	string (LedgerType) Enum: "Sale" "Purchase" "Cost" "Vat" "CashRounding" "Currency"

Responses

Request samples

Payload

Content type

application/json

[{"ledgerNo": "string",
"name": "string",
"active": true,
"vatCode": "string",
"ledgerType": "Sale"
}
]

Response samples

200
default

Content type

application/json

[{"ledgerNo": "string",
"name": "string",
"active": true,
"vatCode": "string",
"ledgerType": "Sale"
}
]

GetGeneralLedger

path Parameters

ledgerNo

required

string

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

200
default

Content type

application/json

{"ledgerNo": "string",
"name": "string",
"active": true,
"vatCode": "string",
"ledgerType": "Sale"
}

PutGeneralLedger

path Parameters

ledgerNo

required

string

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

name	string or null
active required	boolean
vatCode	string or null
ledgerType required	string (LedgerType) Enum: "Sale" "Purchase" "Cost" "Vat" "CashRounding" "Currency"

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"active": true,
"vatCode": "string",
"ledgerType": "Sale"
}

Response samples

200
204
404
default

Content type

application/json

{"ledgerNo": "string",
"name": "string",
"active": true,
"vatCode": "string",
"ledgerType": "Sale"
}

GetGeneralLedger2

path Parameters

ledgerNo

required

string

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

200
default

Content type

application/json

{"ledgerNo": "string",
"name": "string",
"active": true,
"vatCode": "string",
"ledgerType": "Sale"
}

PutGeneralLedger2

path Parameters

ledgerNo

required

string

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

name	string or null
active required	boolean
vatCode	string or null
ledgerType required	string (LedgerType) Enum: "Sale" "Purchase" "Cost" "Vat" "CashRounding" "Currency"

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"active": true,
"vatCode": "string",
"ledgerType": "Sale"
}

Response samples

200
204
404
default

Content type

application/json

{"ledgerNo": "string",
"name": "string",
"active": true,
"vatCode": "string",
"ledgerType": "Sale"
}

HarvestPlan

GetHarvestPlanOrders

query Parameters

accountId required	string <guid>
domainId required	string <guid>
fromDate required	string <date>
toDate required	string <date>
vendor	string or null
template	string or null
packingPlant	string or null
userId	string <guid>
traceId	string <guid>

Responses

Response samples

200
default

Content type

application/json

[{"harvestPlanOrderId": "string",
"harvestDate": "2019-08-24",
"template": "string",
"vendor": "string",
"packingPlant": "string",
"localityNo": "string",
"localityName": "string",
"cageNo": "string",
"tags": ["string"
],
"units": 0,
"netWeight": 0,
"sizeDistribution": [{"min": 0,
"max": 0,
"percentage": 0
}
],
"qualityDistribution": [{"quality": "string",
"percentage": 0
}
],
"purchaseOrderId": "string",
"purchaseOrderNo": "string"
}
]

CreateHarvestPlanOrders

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

Array

harvestPlanOrderId	string or null <guid>
harvestDate required	string <date>
template	string or null
vendor	string or null
packingPlant	string or null
localityNo	string or null
localityName	string or null
cageNo	string or null
tags	Array of strings or null
units	integer or null <int32>
netWeight	number or null <decimal>
	Array of objects or null (SizeDistribution)
	Array of objects or null (QualityDistribution)
purchaseOrderId	string or null <guid>
purchaseOrderNo	string or null

Responses

Request samples

Payload

Content type

application/json

[{"harvestPlanOrderId": "string",
"harvestDate": "2019-08-24",
"template": "string",
"vendor": "string",
"packingPlant": "string",
"localityNo": "string",
"localityName": "string",
"cageNo": "string",
"tags": ["string"
],
"units": 0,
"netWeight": 0,
"sizeDistribution": [{"min": 0,
"max": 0,
"percentage": 0
}
],
"qualityDistribution": [{"quality": "string",
"percentage": 0
}
],
"purchaseOrderId": "string",
"purchaseOrderNo": "string"
}
]

Response samples

200
default

Content type

application/json

[{"harvestPlanOrderId": "string",
"harvestDate": "2019-08-24",
"template": "string",
"vendor": "string",
"packingPlant": "string",
"localityNo": "string",
"localityName": "string",
"cageNo": "string",
"tags": ["string"
],
"units": 0,
"netWeight": 0,
"sizeDistribution": [{"min": 0,
"max": 0,
"percentage": 0
}
],
"qualityDistribution": [{"quality": "string",
"percentage": 0
}
],
"purchaseOrderId": "string",
"purchaseOrderNo": "string"
}
]

UpdateHarvestPlanOrders

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

Array

harvestPlanOrderId	string or null <guid>
harvestDate required	string <date>
template	string or null
vendor	string or null
packingPlant	string or null
localityNo	string or null
localityName	string or null
cageNo	string or null
tags	Array of strings or null
units	integer or null <int32>
netWeight	number or null <decimal>
	Array of objects or null (SizeDistribution)
	Array of objects or null (QualityDistribution)
purchaseOrderId	string or null <guid>
purchaseOrderNo	string or null

Responses

Request samples

Payload

Content type

application/json

[{"harvestPlanOrderId": "string",
"harvestDate": "2019-08-24",
"template": "string",
"vendor": "string",
"packingPlant": "string",
"localityNo": "string",
"localityName": "string",
"cageNo": "string",
"tags": ["string"
],
"units": 0,
"netWeight": 0,
"sizeDistribution": [{"min": 0,
"max": 0,
"percentage": 0
}
],
"qualityDistribution": [{"quality": "string",
"percentage": 0
}
],
"purchaseOrderId": "string",
"purchaseOrderNo": "string"
}
]

Response samples

200
default

Content type

application/json

[{"harvestPlanOrderId": "string",
"harvestDate": "2019-08-24",
"template": "string",
"vendor": "string",
"packingPlant": "string",
"localityNo": "string",
"localityName": "string",
"cageNo": "string",
"tags": ["string"
],
"units": 0,
"netWeight": 0,
"sizeDistribution": [{"min": 0,
"max": 0,
"percentage": 0
}
],
"qualityDistribution": [{"quality": "string",
"percentage": 0
}
],
"purchaseOrderId": "string",
"purchaseOrderNo": "string"
}
]

DeleteHarvestPlanOrder

query Parameters

accountId required	string <guid>
domainId required	string <guid>
harvestPlantOrderId required	string <guid>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

default

Content type

application/json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"property1": null,
"property2": null
}

Import

Buildt to handle many small requests rather than big chunks of imported boxes

query Parameters

accountId required	string <guid>
domainId required	string <guid>
ignoreNonExistingSO	boolean or null If SO specified does not exist ignore, and import to PO only
ignoreConfirmedSO	boolean or null If SO specified is confirmed, ignore the SO and import to PO only
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

List of boxes to add

Array

packingPlant required	string Packing plant id (aka packing label). Mandatory field.
warehouse	string or null Warehosue code or name.
itemCode required	string Item code. Mandatory field.
batchNo	string or null
lotNo	string or null
purchaseOrderNo required	string The purchase order number. Mandatory field.
salesOrderNo	string or null
refPurchaseOrderNo	string or null
refSalesOrderNo	string or null
catchDate	string or null <date>
packingDate required	string <date> Packing date. Mandatory field.
useBy	string or null <date>
freezeDate	string or null <date>
palletNo	string or null
palletSscc	string or null
boxNo	string or null
boxSscc	string or null
refBoxId	string or null
netWeight required	number <decimal> Net weight of box. Mandatory field.
grossWeight	number or null <decimal>
fishCount	integer or null <int32> Number of items in the box
weightUnit required	string The weight unit. Ex: KG, LBS
duplicateUnits	integer or null <int32> Number of boxes. Default will be 1. If same fixed weight per box, duplicate units can work as number of boxes with same weight. NetWeight/GrossWeight will then be total for all units. If bulk, the the same rule apply for weights, but you do not know each box weight.
isBulk	boolean or null
certifications	Array of strings or null
landingNotes	Array of strings or null
vesselNo	string or null
areaCode	string or null
catchField	string or null
equipmentCategories	Array of strings or null Equipment used (fishing gear).

Responses

Request samples

Payload

Content type

application/json

[{"packingPlant": "string",
"warehouse": "string",
"itemCode": "string",
"batchNo": "string",
"lotNo": "string",
"purchaseOrderNo": "string",
"salesOrderNo": "string",
"refPurchaseOrderNo": "string",
"refSalesOrderNo": "string",
"catchDate": "2019-08-24",
"packingDate": "2019-08-24",
"useBy": "2019-08-24",
"freezeDate": "2019-08-24",
"palletNo": "string",
"palletSscc": "string",
"boxNo": "string",
"boxSscc": "string",
"refBoxId": "string",
"netWeight": 0,
"grossWeight": 0,
"fishCount": 0,
"weightUnit": "string",
"duplicateUnits": 0,
"isBulk": true,
"certifications": ["string"
],
"landingNotes": ["string"
],
"vesselNo": "string",
"areaCode": "string",
"catchField": "string",
"equipmentCategories": ["string"
]
}
]

Response samples

400
default

Content type

application/json

"string"

DeleteBoxes

query Parameters

accountId required	string <guid>
domainId required	string <guid>
ignoreNonExistingSO	boolean or null
ignoreConfirmedSO	boolean or null
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

Array

packingPlant required	string Packing plant id (aka packing label). Mandatory field.
warehouse	string or null Warehosue code or name.
itemCode required	string Item code. Mandatory field.
batchNo	string or null
lotNo	string or null
purchaseOrderNo required	string The purchase order number. Mandatory field.
salesOrderNo	string or null
refPurchaseOrderNo	string or null
refSalesOrderNo	string or null
catchDate	string or null <date>
packingDate required	string <date> Packing date. Mandatory field.
useBy	string or null <date>
freezeDate	string or null <date>
palletNo	string or null
palletSscc	string or null
boxNo	string or null
boxSscc	string or null
refBoxId	string or null
netWeight required	number <decimal> Net weight of box. Mandatory field.
grossWeight	number or null <decimal>
fishCount	integer or null <int32> Number of items in the box
weightUnit required	string The weight unit. Ex: KG, LBS
duplicateUnits	integer or null <int32> Number of boxes. Default will be 1. If same fixed weight per box, duplicate units can work as number of boxes with same weight. NetWeight/GrossWeight will then be total for all units. If bulk, the the same rule apply for weights, but you do not know each box weight.
isBulk	boolean or null
certifications	Array of strings or null
landingNotes	Array of strings or null
vesselNo	string or null
areaCode	string or null
catchField	string or null
equipmentCategories	Array of strings or null Equipment used (fishing gear).

Responses

Request samples

Payload

Content type

application/json

[{"packingPlant": "string",
"warehouse": "string",
"itemCode": "string",
"batchNo": "string",
"lotNo": "string",
"purchaseOrderNo": "string",
"salesOrderNo": "string",
"refPurchaseOrderNo": "string",
"refSalesOrderNo": "string",
"catchDate": "2019-08-24",
"packingDate": "2019-08-24",
"useBy": "2019-08-24",
"freezeDate": "2019-08-24",
"palletNo": "string",
"palletSscc": "string",
"boxNo": "string",
"boxSscc": "string",
"refBoxId": "string",
"netWeight": 0,
"grossWeight": 0,
"fishCount": 0,
"weightUnit": "string",
"duplicateUnits": 0,
"isBulk": true,
"certifications": ["string"
],
"landingNotes": ["string"
],
"vesselNo": "string",
"areaCode": "string",
"catchField": "string",
"equipmentCategories": ["string"
]
}
]

Response samples

404
default

Content type

application/json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"property1": null,
"property2": null
}

IncomingInvoice

PostInvoice

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

Array

vendorNo	string or null
invoiceNo	string or null
invoiceType required	string (InvoiceType) Enum: "Invoice" "CreditNote"
	(InvoiceKindEnum (string or null))
invoiceDate required	string <date>
dueDate required	string <date>
postingDate	string or null <date>
kid	string or null
currencyCode	string or null
exchangeRate	number or null <decimal>
totalPayableAmount required	number <decimal>
totalNetAmount required	number <decimal>
totalAmountSubjectToVAT required	number <decimal>
externalRef	string or null
	Array of objects or null (IncomingInvoiceLine)
invoicePDF	string or null <byte> Can be tested in swagger by sending in a Base64 encoded string

Responses

Request samples

Payload

Content type

application/json

[{"vendorNo": "string",
"invoiceNo": "string",
"invoiceType": "Invoice",
"invoiceKind": "GoodsInvoice",
"invoiceDate": "2019-08-24",
"dueDate": "2019-08-24",
"postingDate": "2019-08-24",
"kid": "string",
"currencyCode": "string",
"exchangeRate": 0,
"totalPayableAmount": 0,
"totalNetAmount": 0,
"totalAmountSubjectToVAT": 0,
"externalRef": "string",
"invoiceLines": [{"lineNo": 0,
"description": "string",
"referenceNo": "string",
"netAmount": 0,
"grossAmount": 0,
"vatCode": "string",
"vatRate": 0
}
],
"invoicePDF": "string"
}
]

Response samples

200
204
default

Content type

application/json

[{"vendorNo": "string",
"invoiceNo": "string",
"invoiceType": "Invoice",
"invoiceKind": "GoodsInvoice",
"invoiceDate": "2019-08-24",
"dueDate": "2019-08-24",
"postingDate": "2019-08-24",
"kid": "string",
"currencyCode": "string",
"exchangeRate": 0,
"totalPayableAmount": 0,
"totalNetAmount": 0,
"totalAmountSubjectToVAT": 0,
"externalRef": "string",
"invoiceId": "string",
"invoiceLines": [{"lineNo": 0,
"description": "string",
"referenceNo": "string",
"netAmount": 0,
"grossAmount": 0,
"vatCode": "string",
"vatRate": 0,
"status": "NotStarted",
"message": "string"
}
],
"status": "NotStarted",
"message": "string",
"voucherNo": 0
}
]

GetInvoicesAll

query Parameters

accountId required	string <guid>
domainId required	string <guid>
invoiceNo	string or null
invoiceIds	Array of strings or null <guid> [ items <guid > ]
	((StatusOpen (string or null)))
fromDate	string or null <date>
toDate	string or null <date>
changedSince	string or null <date-time>
externalRef	Array of strings or null
invoiceTypes	string or null
vendors	Array of strings or null
skip	integer or null <int32>
take	integer or null <int32>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

200
default

Content type

application/json

[{"vendorNo": "string",
"invoiceNo": "string",
"invoiceType": "Invoice",
"invoiceKind": "GoodsInvoice",
"invoiceDate": "2019-08-24",
"dueDate": "2019-08-24",
"postingDate": "2019-08-24",
"kid": "string",
"currencyCode": "string",
"exchangeRate": 0,
"totalPayableAmount": 0,
"totalNetAmount": 0,
"totalAmountSubjectToVAT": 0,
"externalRef": "string",
"invoiceId": "string",
"invoiceLines": [{"lineNo": 0,
"description": "string",
"referenceNo": "string",
"netAmount": 0,
"grossAmount": 0,
"vatCode": "string",
"vatRate": 0,
"status": "NotStarted",
"message": "string"
}
],
"status": "NotStarted",
"message": "string",
"voucherNo": 0
}
]

Inventory

GetInventoryBalance

query Parameters

accountId required	string <guid>
domainId required	string <guid>
warehouse required	string or null
IsSalesItem	boolean or null
IsPurchaseItem	boolean or null
IsProcessingItem	boolean or null
ItemNo	string or null
Name	string or null
ExternalItemNo	string or null
ExternalItemDescription	string or null
GTIN	string or null
DimensionDetailId	string or null
DimensionName	string or null
DimensionValue	string or null
ItemId	string or null
ChangedSince	string or null <date-time>
	(WeightType (string or null))
IncludeTranslations	boolean or null
IncludeTradeUnits	boolean or null Adds the trade unit level name and External Level to each item. Costs an extra call to the item service.
userId	string <guid>
traceId	string <guid>

Responses

Response samples

200
204
default

Content type

application/json

[{"itemId": "string",
"itemCode": "string",
"itemName": "string",
"bookedWeight": 0,
"bookedBoxes": 0,
"inventoryWeight": 0,
"inventoryBoxes": 0,
"inventoryPieces": 0,
"property1": null,
"property2": null
}
]

Patch inventory box

Sets properties on individual boxes identified by SSCC. Payload is a list of dictionaries with keys: sscc (required), subStatusId, subStatusName, extPalletNo. subStatusName is resolved to a sub-status if subStatusId is not supplied.

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

Array

sscc	string
extPalletNo	string
subStatusId	string or null <guid>
subStatusName	string or null

Responses

Request samples

Payload

Content type

application/json

[{"sscc": "string",
"extPalletNo": "string",
"subStatusId": "string",
"subStatusName": "string"
}
]

Response samples

default

Content type

application/json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"property1": null,
"property2": null
}

Patch inventory pallet

Sets properties on pallets identified by SSCC. Payload is a list of dictionaries with keys: sscc (required), subStatusId, subStatusName, extPalletNo. subStatusName is resolved to a sub-status if subStatusId is not supplied.

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

Array

sscc	string
extPalletNo	string
subStatusId	string or null <guid>
subStatusName	string or null

Responses

Request samples

Payload

Content type

application/json

[{"sscc": "string",
"extPalletNo": "string",
"subStatusId": "string",
"subStatusName": "string"
}
]

Response samples

default

Content type

application/json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"property1": null,
"property2": null
}

Get inventory sub-statuses

Returns the substatuses configured for Inventory, each with at least an id and a name.

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

200
default

Content type

application/json

[{"subStatusId": "string",
"systemStatus": "string",
"name": "string",
"description": "string"
}
]

ImportInventoryPackingData

query Parameters

accountId required	string <guid>
domainId required	string <guid>
allowDuplicates	boolean or null
autoNumber	boolean or null
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

	Array of objects or null (JsonImportBoxDto)
	Array of objects or null (JsonImportPalletDto)
property name* additional property	any or null

Responses

Request samples

Payload

Content type

application/json

{"boxes": [{"purchaseOrderNo": 0,
"salesOrderNo": 0,
"vendorOrderNo": 0,
"palletNo": "string",
"netWeight": 0,
"grossWeight": 0,
"packingDate": "2019-08-24",
"useBy": "2019-08-24",
"freezeDate": "2019-08-24",
"vendorItemCode": "string",
"itemCode": "string",
"cageNo": "string",
"locationName": "string",
"packingPlant": "string",
"lotNo": "string",
"batchNo": "string",
"palletSscc": "string",
"landingNotes": ["string"
],
"extLotNo": "string",
"extPalletNo": "string",
"catchCertificateNo": "string",
"arrivalDate": "2019-08-24",
"catchDate": "2019-08-24",
"fishingGear": ["string"
],
"refNo": "string",
"warehouseName": "string",
"weightUnit": "string",
"price": 0,
"priceLevel": "string",
"vessels": [{"vesselId": "string",
"vesselNo": "string",
"vesselName": "string",
"property1": null,
"property2": null
}
],
"property1": null,
"property2": null,
"boxNo": "string",
"boxSscc": "string",
"pieces": 0
}
],
"pallets": [{"purchaseOrderNo": 0,
"salesOrderNo": 0,
"vendorOrderNo": 0,
"palletNo": "string",
"netWeight": 0,
"grossWeight": 0,
"packingDate": "2019-08-24",
"useBy": "2019-08-24",
"freezeDate": "2019-08-24",
"vendorItemCode": "string",
"itemCode": "string",
"cageNo": "string",
"locationName": "string",
"packingPlant": "string",
"lotNo": "string",
"batchNo": "string",
"palletSscc": "string",
"landingNotes": ["string"
],
"extLotNo": "string",
"extPalletNo": "string",
"catchCertificateNo": "string",
"arrivalDate": "2019-08-24",
"catchDate": "2019-08-24",
"fishingGear": ["string"
],
"refNo": "string",
"warehouseName": "string",
"weightUnit": "string",
"price": 0,
"priceLevel": "string",
"vessels": [{"vesselId": "string",
"vesselNo": "string",
"vesselName": "string",
"property1": null,
"property2": null
}
],
"property1": null,
"property2": null,
"boxCount": 0
}
],
"property1": null,
"property2": null
}

Response samples

Content type

application/json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"property1": null,
"property2": null
}

Invoice

GetSalesInvoices2

query Parameters

accountId required	string <guid>
domainId required	string <guid>
Type	string or null
InvoiceStatus	Array of strings (InvoiceStatus) Items Enum: "Draft" "Sent" "Posted"
FactoringStatus	Array of strings or null (FactoringStatus) Enum: "NotReady" "Ready" "Factored"
CustomerNo	Array of integers <int32> [ items <int32 > ]
FromInvoiceDate	string or null <date>
ToInvoiceDate	string or null <date>
FromPostingDate	string or null <date>
ToPostingDate	string or null <date>
PostedSince	string or null <date-time> Get invoices posted since this timestamp
SentSince	string or null <date-time> Get invoices sent since this timestamp
FromDueDate	string or null <date>
ToDueDate	string or null <date>
InvoiceNos	Array of integers or null <int32> [ items <int32 > ]
InvoiceIds	Array of strings or null <guid> [ items <guid > ]
IsFactoring	boolean or null
IsCreditNote	boolean or null
FromFactoringDate	string or null <date>
ToFactoringDate	string or null <date>
ContinuationToken	string or null Used to request the next page of results
Limit	integer <int32> Maximum number of results to return
userId	string <guid>
traceId	string <guid>

Responses

Response samples

200
204
default

Content type

application/json

{"data": [{"id": "string",
"number": 0,
"isCreditNote": true,
"status": "string",
"date": "2019-08-24",
"dueDate": "2019-08-24",
"currency": "str",
"exchangeRate": 0,
"address": {"description": "string",
"line1": "string",
"line2": "string",
"line3": "string",
"line4": "string",
"postCode": "string",
"country": "st",
"city": "string",
"state": "string"
},
"kid": "string",
"paymentTerms": {"name": "string"
},
"totalNetAmount": 0,
"totalGrossAmount": 0,
"totalVatAmounts": [{"amount": 0,
"rate": {"id": "string",
"percent": 0,
"description": "string"
},
"taxableAmount": 0
}
],
"lines": [{"id": "string",
"orderId": "string",
"orderLineId": ["string"
],
"description": "string",
"netAmount": 0,
"grossAmount": 0,
"vatRate": {"id": "string",
"percent": 0,
"description": "string"
},
"price": 0,
"quantity": 0,
"itemId": "string"
}
],
"orders": [{"id": "string",
"number": 0,
"date": "2019-08-24",
"arrivalDate": "2019-08-24",
"shipmentDate": "2019-08-24",
"deliveryAddress": {"description": "string",
"line1": "string",
"line2": "string",
"line3": "string",
"line4": "string",
"postCode": "string",
"country": "st",
"city": "string",
"state": "string"
},
"dimensions": [{"dimensionId": "string",
"dimensionName": "string",
"dimensionDetailId": "string",
"dimensionDetailName": "string"
}
]
}
],
"type": "string",
"customer": {"id": "string",
"number": "string",
"externalNumber": "string",
"name": "string",
"organizationNumber": "string",
"vatNumber": "string",
"eori": "string",
"email": "string",
"phone": "string"
},
"yourReference": "string",
"ourReference": "string",
"isFactoring": true,
"factoringStatus": "string",
"customsReceiptNo": "string"
}
]
}

GetInvoices

query Parameters

accountId required	string <guid>
domainId required	string <guid>
Type	string or null
InvoiceStatus	Array of strings (InvoiceStatus) Items Enum: "Draft" "Sent" "Posted"
FactoringStatus	Array of strings or null (FactoringStatus) Enum: "NotReady" "Ready" "Factored"
CustomerNo	Array of integers <int32> [ items <int32 > ]
FromInvoiceDate	string or null <date>
ToInvoiceDate	string or null <date>
FromPostingDate	string or null <date>
ToPostingDate	string or null <date>
PostedSince	string or null <date-time> Get invoices posted since this timestamp
SentSince	string or null <date-time> Get invoices sent since this timestamp
FromDueDate	string or null <date>
ToDueDate	string or null <date>
InvoiceNos	Array of integers or null <int32> [ items <int32 > ]
InvoiceIds	Array of strings or null <guid> [ items <guid > ]
IsFactoring	boolean or null
IsCreditNote	boolean or null
FromFactoringDate	string or null <date>
ToFactoringDate	string or null <date>
ContinuationToken	string or null Used to request the next page of results
Limit	integer <int32> Maximum number of results to return
userId	string <guid>
traceId	string <guid>

Responses

Response samples

200
204
default

Content type

application/json

{"data": [{"id": "string",
"number": 0,
"isCreditNote": true,
"status": "string",
"date": "2019-08-24",
"dueDate": "2019-08-24",
"currency": "str",
"exchangeRate": 0,
"address": {"description": "string",
"line1": "string",
"line2": "string",
"line3": "string",
"line4": "string",
"postCode": "string",
"country": "st",
"city": "string",
"state": "string"
},
"kid": "string",
"paymentTerms": {"name": "string"
},
"totalNetAmount": 0,
"totalGrossAmount": 0,
"totalVatAmounts": [{"amount": 0,
"rate": {"id": "string",
"percent": 0,
"description": "string"
},
"taxableAmount": 0
}
],
"lines": [{"id": "string",
"orderId": "string",
"orderLineId": ["string"
],
"description": "string",
"netAmount": 0,
"grossAmount": 0,
"vatRate": {"id": "string",
"percent": 0,
"description": "string"
},
"price": 0,
"quantity": 0,
"itemId": "string"
}
],
"orders": [{"id": "string",
"number": 0,
"date": "2019-08-24",
"arrivalDate": "2019-08-24",
"shipmentDate": "2019-08-24",
"deliveryAddress": {"description": "string",
"line1": "string",
"line2": "string",
"line3": "string",
"line4": "string",
"postCode": "string",
"country": "st",
"city": "string",
"state": "string"
},
"dimensions": [{"dimensionId": "string",
"dimensionName": "string",
"dimensionDetailId": "string",
"dimensionDetailName": "string"
}
]
}
],
"type": "string"
}
]
}

GetInvoicesV0

query Parameters

accountId required	string <guid>
domainId required	string <guid>
fromInvoiceDate	string or null <date-time>
toInvoiceDate	string or null <date-time>
fromDueDate	string or null <date-time>
toDueDate	string or null <date-time>
	(InvoiceStatus (string or null))
customerNo	Array of strings or null
userId	string <guid>
traceId	string <guid>

Responses

Response samples

200
default

Content type

application/json

[{"id": "string",
"batchId": "string",
"invoiceNo": 0,
"invoiceDate": "2019-08-24",
"dueDate": "2019-08-24",
"status": "Draft",
"type": "Invoice",
"addressDescription": "string",
"addressLine1": "string",
"addressLine2": "string",
"addressLine3": "string",
"addressPostCode": "string",
"addressCity": "string",
"addressCountry": "string",
"deliveryPlaceCountry": "string",
"addressCountryName": "string",
"addressCountryMembershipCode": "string",
"addressCountryVatCurrencyCode": "string",
"addressState": "string",
"comment": "string",
"address": {"description": "string",
"line1": "string",
"line2": "string",
"line3": "string",
"line4": "string",
"country": "string",
"countryName": "string",
"countryMembershipCode": "string",
"postCode": "string",
"city": "string",
"state": "string",
"property1": null,
"property2": null
},
"customerReference": "string",
"headerText": "string",
"footerText": "string",
"personResponsibleId": "string",
"personResponsibleName": "string",
"personResponsibleSentBy": "string",
"personResponsibleSentByName": "string",
"sentBy": "string",
"sentAt": "2019-08-24T14:15:22Z",
"personResponsiblePostedBy": "string",
"personResponsiblePostedByName": "string",
"postedBy": "string",
"postedAt": "2019-08-24T14:15:22Z",
"paymentTermsId": "string",
"paymentTerms": "string",
"currency": "string",
"currencyRate": 0,
"exchangeRate": 0,
"isCustomExchangeRate": true,
"totalVat": 0,
"totalGrossAmount": 0,
"totalAmountWithVat": 0,
"orderNumbers": "string",
"salesOrderType": "Sales",
"salesOrders": [{"salesOrderId": "string",
"orderNo": 0,
"date": "2019-08-24",
"arrivalDate": "2019-08-24",
"shipmentDate": "2019-08-24",
"salesOrderType": "Sales",
"customerId": "string",
"customerName": "string",
"customerOrderNo": "string",
"customerPurchaseOrderNo": "string",
"deliveryPlaceCountry": "string",
"profitCenter": "string",
"department": "string",
"dimensions": [{"dimensionId": "string",
"dimensionName": "string",
"sortOrder": 0,
"dimensionDetailId": "string",
"dimensionFreeFormValue": "string",
"dimensionDetailName": "string",
"systemDimension": true,
"dimensionType": {"name": "string",
"systemType": true
},
"dimensionDataType": "NotSet",
"property1": null,
"property2": null
}
],
"forexHedgeBundleId": "string",
"systemStatus": "Unconfirmed",
"subStatusId": "string",
"subStatusName": "string",
"subStatusRgb": "string",
"deliveryTerms": "string",
"deliveryPlaceId": "string",
"destinationPlaceId": "string",
"tags": ["string"
],
"grossAmount": 0,
"orderDiscountAmount": 0,
"orderDiscountPrice": 0,
"orderDiscountType": "Weight",
"discountText": "string",
"modeOfTransportId": "string",
"comment": "string",
"refTransferOrderId": "string",
"refTransferOrderNo": 0,
"exchangeRate": 0,
"isCustomExchangeRate": true,
"isRemoteHedged": true,
"deliveryAddress": {"description": "string",
"line1": "string",
"line2": "string",
"line3": "string",
"line4": "string",
"country": "string",
"countryName": "string",
"countryMembershipCode": "string",
"postCode": "string",
"city": "string",
"state": "string",
"property1": null,
"property2": null
},
"containerNo": "string",
"sealNo": "string",
"personResponsible": {"actorId": "string",
"number": "string",
"name": "string",
"property1": null,
"property2": null
},
"keepInInventory": true,
"receivingPurchaseOrderNos": ["string"
],
"property1": null,
"property2": null
}
],
"lines": [{"id": 0,
"lineId": "string",
"lineNo": 0,
"type": "Item",
"salesOrderId": "string",
"salesBookingDetailId": "string",
"salesBookingDetailIdList": ["string"
],
"itemId": "string",
"salesOrderCostId": "string",
"costSetupId": "string",
"description": "string",
"boxes": 0,
"number": 0,
"netWeight": 0,
"grossWeight": 0,
"quantity": 0,
"price": 0,
"amount": 0,
"priceLevel": "Weight",
"vat": 0,
"vatRate": 0,
"vatRateId": "string",
"grossAmount": 0,
"amountWithVat": 0,
"ledgerGroupId": "string",
"calculationMethod": "Weight",
"costDistributionMethod": "Invoice",
"salesBookings": ["string"
],
"vatError": "string",
"itemCode": "string",
"customsTariffCode": "string",
"taxCode": "string",
"taxCodeId": "string",
"taxCodes": [{"id": "string",
"code": "string",
"percentage": {"inDecimalForm": 0,
"inPercentageForm": 0,
"value": 0
},
"validFrom": "2019-08-24"
}
],
"matched": true,
"discountAmount": 0,
"discountedAmount": 0,
"discountedGrossAmount": 0,
"discountText": "string",
"decimals": 0,
"lineDiscountPrice": 0,
"lineDiscountType": "Weight",
"discountLineAmount": 0,
"discountedLineAmount": 0,
"discountedLineGrossAmount": 0,
"fullDescription": "string",
"property1": null,
"property2": null
}
],
"customerId": "string",
"customerName": "string",
"customerNo": "string",
"sumsByVatRate": [{"vatRateId": "string",
"vatRate": 0,
"totalAmount": 0,
"totalAmountInBaseCurrency": 0,
"totalVat": 0,
"totalVatInBaseCurrency": 0,
"totalGrossAmount": 0,
"totalAmountWithVat": 0,
"taxCode": "string",
"taxCodeId": "string",
"property1": null,
"property2": null
}
],
"sumsByTaxCode": [{"taxCode": {"id": "string",
"code": "string",
"percentage": {"inDecimalForm": 0,
"inPercentageForm": 0,
"value": 0
},
"validFrom": "2019-08-24"
},
"taxableAmount": 0,
"taxRate": {"inDecimalForm": 0,
"inPercentageForm": 0,
"value": 0
},
"taxAmount": 0,
"exchangeRate": 0,
"decimals": 0,
"taxRateId": "string",
"totalGrossAmount": 0,
"taxableAmountInBaseCurrency": 0,
"taxAmountInBaseCurrency": 0,
"property1": null,
"property2": null
}
],
"isExport": true,
"isExportDeclaration": true,
"isExportPosting": true,
"isProforma": true,
"isFactoring": true,
"factoringDate": "2019-08-24",
"factoringBatchNo": 0,
"factoringBatchId": "string",
"factoringBatch": {"id": "string",
"batchNo": 0,
"location": "string",
"factoringDate": "2019-08-24",
"isDownload": true,
"property1": null,
"property2": null
},
"factoringStatus": "NotReady",
"kid": "string",
"refInvoiceId": "string",
"refInvoiceNo": 0,
"imported": true,
"customsOfficeCode": "string",
"ledgerNo": "string",
"invoiceDeclaration": true,
"cases": [{"caseId": "string",
"caseNumber": 0,
"property1": null,
"property2": null
}
],
"internalCustomer": true,
"customsReceiptNo": "string",
"customsStatus": "Unsent",
"customsDeclarationId": "string",
"isEhf": true,
"ehfStatus": "New",
"ehfStatusText": "string",
"cceStatus": "Draft",
"catchCertificateNumber": "string",
"isVatRequired": true,
"vatTextsId": "string",
"totalDiscountAmount": 0,
"totalDiscountedAmount": 0,
"totalAmount": 0,
"totalDiscountedGrossAmount": 0,
"warehouseIds": ["string"
],
"forexHedgeBundleId": "string",
"accountingEntryDate": "2019-08-24",
"containerNo": "string",
"sealNo": "string",
"decimals": 0,
"frozen": true,
"bankInformation": {"bankInformationId": "string",
"currencyCode": "string",
"bankName": "string",
"bankAddress": "string",
"bankGiro": "string",
"bankSWIFT": "string",
"bankIBAN": "string",
"type": "None",
"customerId": "string",
"clientNo": "string",
"property1": null,
"property2": null
},
"factoringCustomer": {"customerId": "string",
"name": "string",
"number": "string",
"paymentTermsId": "string",
"invoiceCurrency": "string",
"isFactoring": true,
"invoiceAddress": {"description": "string",
"line1": "string",
"line2": "string",
"line3": "string",
"line4": "string",
"country": "string",
"postCode": "string",
"city": "string",
"state": "string",
"property1": null,
"property2": null,
"countryName": "string",
"gln": "string"
},
"organizationNo": "string",
"vatNo": "string",
"eori": "string",
"languageCode": "string",
"ledgerNo": "string",
"invoiceReference": "string",
"invoiceDeclaration": true,
"isInternal": true,
"emailPrimary": "string",
"phone": "string",
"isVatRequired": true,
"electronicInvoiceType": "None",
"useElectronicInvoice": true,
"property1": null,
"property2": null
},
"basedOnCount": 0,
"originToCount": 0,
"isSample": true,
"electronicInvoiceType": "string",
"healthCertificateId": "string",
"sentToHC": true,
"foreignVatId": "string",
"vatTexts": ["string"
],
"hasSavedGrossAmount": true,
"property1": null,
"property2": null
}
]

GetInvoice

path Parameters

invoice

required

string

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

200
204
default

Content type

application/json

{"id": "string",
"batchId": "string",
"invoiceNo": 0,
"invoiceDate": "2019-08-24",
"dueDate": "2019-08-24",
"status": "Draft",
"type": "Invoice",
"addressDescription": "string",
"addressLine1": "string",
"addressLine2": "string",
"addressLine3": "string",
"addressPostCode": "string",
"addressCity": "string",
"addressCountry": "string",
"deliveryPlaceCountry": "string",
"addressCountryName": "string",
"addressCountryMembershipCode": "string",
"addressCountryVatCurrencyCode": "string",
"addressState": "string",
"comment": "string",
"address": {"description": "string",
"line1": "string",
"line2": "string",
"line3": "string",
"line4": "string",
"country": "string",
"countryName": "string",
"countryMembershipCode": "string",
"postCode": "string",
"city": "string",
"state": "string",
"property1": null,
"property2": null
},
"customerReference": "string",
"headerText": "string",
"footerText": "string",
"personResponsibleId": "string",
"personResponsibleName": "string",
"personResponsibleSentBy": "string",
"personResponsibleSentByName": "string",
"sentBy": "string",
"sentAt": "2019-08-24T14:15:22Z",
"personResponsiblePostedBy": "string",
"personResponsiblePostedByName": "string",
"postedBy": "string",
"postedAt": "2019-08-24T14:15:22Z",
"paymentTermsId": "string",
"paymentTerms": "string",
"currency": "string",
"currencyRate": 0,
"exchangeRate": 0,
"isCustomExchangeRate": true,
"totalVat": 0,
"totalGrossAmount": 0,
"totalAmountWithVat": 0,
"orderNumbers": "string",
"salesOrderType": "Sales",
"salesOrders": [{"salesOrderId": "string",
"orderNo": 0,
"date": "2019-08-24",
"arrivalDate": "2019-08-24",
"shipmentDate": "2019-08-24",
"salesOrderType": "Sales",
"customerId": "string",
"customerName": "string",
"customerOrderNo": "string",
"customerPurchaseOrderNo": "string",
"deliveryPlaceCountry": "string",
"profitCenter": "string",
"department": "string",
"dimensions": [{"dimensionId": "string",
"dimensionName": "string",
"sortOrder": 0,
"dimensionDetailId": "string",
"dimensionFreeFormValue": "string",
"dimensionDetailName": "string",
"systemDimension": true,
"dimensionType": {"name": "string",
"systemType": true
},
"dimensionDataType": "NotSet",
"property1": null,
"property2": null
}
],
"forexHedgeBundleId": "string",
"systemStatus": "Unconfirmed",
"subStatusId": "string",
"subStatusName": "string",
"subStatusRgb": "string",
"deliveryTerms": "string",
"deliveryPlaceId": "string",
"destinationPlaceId": "string",
"tags": ["string"
],
"grossAmount": 0,
"orderDiscountAmount": 0,
"orderDiscountPrice": 0,
"orderDiscountType": "Weight",
"discountText": "string",
"modeOfTransportId": "string",
"comment": "string",
"refTransferOrderId": "string",
"refTransferOrderNo": 0,
"exchangeRate": 0,
"isCustomExchangeRate": true,
"isRemoteHedged": true,
"deliveryAddress": {"description": "string",
"line1": "string",
"line2": "string",
"line3": "string",
"line4": "string",
"country": "string",
"countryName": "string",
"countryMembershipCode": "string",
"postCode": "string",
"city": "string",
"state": "string",
"property1": null,
"property2": null
},
"containerNo": "string",
"sealNo": "string",
"personResponsible": {"actorId": "string",
"number": "string",
"name": "string",
"property1": null,
"property2": null
},
"keepInInventory": true,
"receivingPurchaseOrderNos": ["string"
],
"property1": null,
"property2": null
}
],
"lines": [{"id": 0,
"lineId": "string",
"lineNo": 0,
"type": "Item",
"salesOrderId": "string",
"salesBookingDetailId": "string",
"salesBookingDetailIdList": ["string"
],
"itemId": "string",
"salesOrderCostId": "string",
"costSetupId": "string",
"description": "string",
"boxes": 0,
"number": 0,
"netWeight": 0,
"grossWeight": 0,
"quantity": 0,
"price": 0,
"amount": 0,
"priceLevel": "Weight",
"vat": 0,
"vatRate": 0,
"vatRateId": "string",
"grossAmount": 0,
"amountWithVat": 0,
"ledgerGroupId": "string",
"calculationMethod": "Weight",
"costDistributionMethod": "Invoice",
"salesBookings": ["string"
],
"vatError": "string",
"itemCode": "string",
"customsTariffCode": "string",
"taxCode": "string",
"taxCodeId": "string",
"taxCodes": [{"id": "string",
"code": "string",
"percentage": {"inDecimalForm": 0,
"inPercentageForm": 0,
"value": 0
},
"validFrom": "2019-08-24"
}
],
"matched": true,
"discountAmount": 0,
"discountedAmount": 0,
"discountedGrossAmount": 0,
"discountText": "string",
"decimals": 0,
"lineDiscountPrice": 0,
"lineDiscountType": "Weight",
"discountLineAmount": 0,
"discountedLineAmount": 0,
"discountedLineGrossAmount": 0,
"fullDescription": "string",
"property1": null,
"property2": null
}
],
"customerId": "string",
"customerName": "string",
"customerNo": "string",
"sumsByVatRate": [{"vatRateId": "string",
"vatRate": 0,
"totalAmount": 0,
"totalAmountInBaseCurrency": 0,
"totalVat": 0,
"totalVatInBaseCurrency": 0,
"totalGrossAmount": 0,
"totalAmountWithVat": 0,
"taxCode": "string",
"taxCodeId": "string",
"property1": null,
"property2": null
}
],
"sumsByTaxCode": [{"taxCode": {"id": "string",
"code": "string",
"percentage": {"inDecimalForm": 0,
"inPercentageForm": 0,
"value": 0
},
"validFrom": "2019-08-24"
},
"taxableAmount": 0,
"taxRate": {"inDecimalForm": 0,
"inPercentageForm": 0,
"value": 0
},
"taxAmount": 0,
"exchangeRate": 0,
"decimals": 0,
"taxRateId": "string",
"totalGrossAmount": 0,
"taxableAmountInBaseCurrency": 0,
"taxAmountInBaseCurrency": 0,
"property1": null,
"property2": null
}
],
"isExport": true,
"isExportDeclaration": true,
"isExportPosting": true,
"isProforma": true,
"isFactoring": true,
"factoringDate": "2019-08-24",
"factoringBatchNo": 0,
"factoringBatchId": "string",
"factoringBatch": {"id": "string",
"batchNo": 0,
"location": "string",
"factoringDate": "2019-08-24",
"isDownload": true,
"property1": null,
"property2": null
},
"factoringStatus": "NotReady",
"kid": "string",
"refInvoiceId": "string",
"refInvoiceNo": 0,
"imported": true,
"customsOfficeCode": "string",
"ledgerNo": "string",
"invoiceDeclaration": true,
"cases": [{"caseId": "string",
"caseNumber": 0,
"property1": null,
"property2": null
}
],
"internalCustomer": true,
"customsReceiptNo": "string",
"customsStatus": "Unsent",
"customsDeclarationId": "string",
"isEhf": true,
"ehfStatus": "New",
"ehfStatusText": "string",
"cceStatus": "Draft",
"catchCertificateNumber": "string",
"isVatRequired": true,
"vatTextsId": "string",
"totalDiscountAmount": 0,
"totalDiscountedAmount": 0,
"totalAmount": 0,
"totalDiscountedGrossAmount": 0,
"warehouseIds": ["string"
],
"forexHedgeBundleId": "string",
"accountingEntryDate": "2019-08-24",
"containerNo": "string",
"sealNo": "string",
"decimals": 0,
"frozen": true,
"bankInformation": {"bankInformationId": "string",
"currencyCode": "string",
"bankName": "string",
"bankAddress": "string",
"bankGiro": "string",
"bankSWIFT": "string",
"bankIBAN": "string",
"type": "None",
"customerId": "string",
"clientNo": "string",
"property1": null,
"property2": null
},
"factoringCustomer": {"customerId": "string",
"name": "string",
"number": "string",
"paymentTermsId": "string",
"invoiceCurrency": "string",
"isFactoring": true,
"invoiceAddress": {"description": "string",
"line1": "string",
"line2": "string",
"line3": "string",
"line4": "string",
"country": "string",
"postCode": "string",
"city": "string",
"state": "string",
"property1": null,
"property2": null,
"countryName": "string",
"gln": "string"
},
"organizationNo": "string",
"vatNo": "string",
"eori": "string",
"languageCode": "string",
"ledgerNo": "string",
"invoiceReference": "string",
"invoiceDeclaration": true,
"isInternal": true,
"emailPrimary": "string",
"phone": "string",
"isVatRequired": true,
"electronicInvoiceType": "None",
"useElectronicInvoice": true,
"property1": null,
"property2": null
},
"basedOnCount": 0,
"originToCount": 0,
"isSample": true,
"electronicInvoiceType": "string",
"healthCertificateId": "string",
"sentToHC": true,
"foreignVatId": "string",
"vatTexts": ["string"
],
"hasSavedGrossAmount": true,
"property1": null,
"property2": null
}

GetInvoiceV0

path Parameters

invoice

required

string

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

200
204
default

Content type

application/json

{"id": "string",
"batchId": "string",
"invoiceNo": 0,
"invoiceDate": "2019-08-24",
"dueDate": "2019-08-24",
"status": "Draft",
"type": "Invoice",
"addressDescription": "string",
"addressLine1": "string",
"addressLine2": "string",
"addressLine3": "string",
"addressPostCode": "string",
"addressCity": "string",
"addressCountry": "string",
"deliveryPlaceCountry": "string",
"addressCountryName": "string",
"addressCountryMembershipCode": "string",
"addressCountryVatCurrencyCode": "string",
"addressState": "string",
"comment": "string",
"address": {"description": "string",
"line1": "string",
"line2": "string",
"line3": "string",
"line4": "string",
"country": "string",
"countryName": "string",
"countryMembershipCode": "string",
"postCode": "string",
"city": "string",
"state": "string",
"property1": null,
"property2": null
},
"customerReference": "string",
"headerText": "string",
"footerText": "string",
"personResponsibleId": "string",
"personResponsibleName": "string",
"personResponsibleSentBy": "string",
"personResponsibleSentByName": "string",
"sentBy": "string",
"sentAt": "2019-08-24T14:15:22Z",
"personResponsiblePostedBy": "string",
"personResponsiblePostedByName": "string",
"postedBy": "string",
"postedAt": "2019-08-24T14:15:22Z",
"paymentTermsId": "string",
"paymentTerms": "string",
"currency": "string",
"currencyRate": 0,
"exchangeRate": 0,
"isCustomExchangeRate": true,
"totalVat": 0,
"totalGrossAmount": 0,
"totalAmountWithVat": 0,
"orderNumbers": "string",
"salesOrderType": "Sales",
"salesOrders": [{"salesOrderId": "string",
"orderNo": 0,
"date": "2019-08-24",
"arrivalDate": "2019-08-24",
"shipmentDate": "2019-08-24",
"salesOrderType": "Sales",
"customerId": "string",
"customerName": "string",
"customerOrderNo": "string",
"customerPurchaseOrderNo": "string",
"deliveryPlaceCountry": "string",
"profitCenter": "string",
"department": "string",
"dimensions": [{"dimensionId": "string",
"dimensionName": "string",
"sortOrder": 0,
"dimensionDetailId": "string",
"dimensionFreeFormValue": "string",
"dimensionDetailName": "string",
"systemDimension": true,
"dimensionType": {"name": "string",
"systemType": true
},
"dimensionDataType": "NotSet",
"property1": null,
"property2": null
}
],
"forexHedgeBundleId": "string",
"systemStatus": "Unconfirmed",
"subStatusId": "string",
"subStatusName": "string",
"subStatusRgb": "string",
"deliveryTerms": "string",
"deliveryPlaceId": "string",
"destinationPlaceId": "string",
"tags": ["string"
],
"grossAmount": 0,
"orderDiscountAmount": 0,
"orderDiscountPrice": 0,
"orderDiscountType": "Weight",
"discountText": "string",
"modeOfTransportId": "string",
"comment": "string",
"refTransferOrderId": "string",
"refTransferOrderNo": 0,
"exchangeRate": 0,
"isCustomExchangeRate": true,
"isRemoteHedged": true,
"deliveryAddress": {"description": "string",
"line1": "string",
"line2": "string",
"line3": "string",
"line4": "string",
"country": "string",
"countryName": "string",
"countryMembershipCode": "string",
"postCode": "string",
"city": "string",
"state": "string",
"property1": null,
"property2": null
},
"containerNo": "string",
"sealNo": "string",
"personResponsible": {"actorId": "string",
"number": "string",
"name": "string",
"property1": null,
"property2": null
},
"keepInInventory": true,
"receivingPurchaseOrderNos": ["string"
],
"property1": null,
"property2": null
}
],
"lines": [{"id": 0,
"lineId": "string",
"lineNo": 0,
"type": "Item",
"salesOrderId": "string",
"salesBookingDetailId": "string",
"salesBookingDetailIdList": ["string"
],
"itemId": "string",
"salesOrderCostId": "string",
"costSetupId": "string",
"description": "string",
"boxes": 0,
"number": 0,
"netWeight": 0,
"grossWeight": 0,
"quantity": 0,
"price": 0,
"amount": 0,
"priceLevel": "Weight",
"vat": 0,
"vatRate": 0,
"vatRateId": "string",
"grossAmount": 0,
"amountWithVat": 0,
"ledgerGroupId": "string",
"calculationMethod": "Weight",
"costDistributionMethod": "Invoice",
"salesBookings": ["string"
],
"vatError": "string",
"itemCode": "string",
"customsTariffCode": "string",
"taxCode": "string",
"taxCodeId": "string",
"taxCodes": [{"id": "string",
"code": "string",
"percentage": {"inDecimalForm": 0,
"inPercentageForm": 0,
"value": 0
},
"validFrom": "2019-08-24"
}
],
"matched": true,
"discountAmount": 0,
"discountedAmount": 0,
"discountedGrossAmount": 0,
"discountText": "string",
"decimals": 0,
"lineDiscountPrice": 0,
"lineDiscountType": "Weight",
"discountLineAmount": 0,
"discountedLineAmount": 0,
"discountedLineGrossAmount": 0,
"fullDescription": "string",
"property1": null,
"property2": null
}
],
"customerId": "string",
"customerName": "string",
"customerNo": "string",
"sumsByVatRate": [{"vatRateId": "string",
"vatRate": 0,
"totalAmount": 0,
"totalAmountInBaseCurrency": 0,
"totalVat": 0,
"totalVatInBaseCurrency": 0,
"totalGrossAmount": 0,
"totalAmountWithVat": 0,
"taxCode": "string",
"taxCodeId": "string",
"property1": null,
"property2": null
}
],
"sumsByTaxCode": [{"taxCode": {"id": "string",
"code": "string",
"percentage": {"inDecimalForm": 0,
"inPercentageForm": 0,
"value": 0
},
"validFrom": "2019-08-24"
},
"taxableAmount": 0,
"taxRate": {"inDecimalForm": 0,
"inPercentageForm": 0,
"value": 0
},
"taxAmount": 0,
"exchangeRate": 0,
"decimals": 0,
"taxRateId": "string",
"totalGrossAmount": 0,
"taxableAmountInBaseCurrency": 0,
"taxAmountInBaseCurrency": 0,
"property1": null,
"property2": null
}
],
"isExport": true,
"isExportDeclaration": true,
"isExportPosting": true,
"isProforma": true,
"isFactoring": true,
"factoringDate": "2019-08-24",
"factoringBatchNo": 0,
"factoringBatchId": "string",
"factoringBatch": {"id": "string",
"batchNo": 0,
"location": "string",
"factoringDate": "2019-08-24",
"isDownload": true,
"property1": null,
"property2": null
},
"factoringStatus": "NotReady",
"kid": "string",
"refInvoiceId": "string",
"refInvoiceNo": 0,
"imported": true,
"customsOfficeCode": "string",
"ledgerNo": "string",
"invoiceDeclaration": true,
"cases": [{"caseId": "string",
"caseNumber": 0,
"property1": null,
"property2": null
}
],
"internalCustomer": true,
"customsReceiptNo": "string",
"customsStatus": "Unsent",
"customsDeclarationId": "string",
"isEhf": true,
"ehfStatus": "New",
"ehfStatusText": "string",
"cceStatus": "Draft",
"catchCertificateNumber": "string",
"isVatRequired": true,
"vatTextsId": "string",
"totalDiscountAmount": 0,
"totalDiscountedAmount": 0,
"totalAmount": 0,
"totalDiscountedGrossAmount": 0,
"warehouseIds": ["string"
],
"forexHedgeBundleId": "string",
"accountingEntryDate": "2019-08-24",
"containerNo": "string",
"sealNo": "string",
"decimals": 0,
"frozen": true,
"bankInformation": {"bankInformationId": "string",
"currencyCode": "string",
"bankName": "string",
"bankAddress": "string",
"bankGiro": "string",
"bankSWIFT": "string",
"bankIBAN": "string",
"type": "None",
"customerId": "string",
"clientNo": "string",
"property1": null,
"property2": null
},
"factoringCustomer": {"customerId": "string",
"name": "string",
"number": "string",
"paymentTermsId": "string",
"invoiceCurrency": "string",
"isFactoring": true,
"invoiceAddress": {"description": "string",
"line1": "string",
"line2": "string",
"line3": "string",
"line4": "string",
"country": "string",
"postCode": "string",
"city": "string",
"state": "string",
"property1": null,
"property2": null,
"countryName": "string",
"gln": "string"
},
"organizationNo": "string",
"vatNo": "string",
"eori": "string",
"languageCode": "string",
"ledgerNo": "string",
"invoiceReference": "string",
"invoiceDeclaration": true,
"isInternal": true,
"emailPrimary": "string",
"phone": "string",
"isVatRequired": true,
"electronicInvoiceType": "None",
"useElectronicInvoice": true,
"property1": null,
"property2": null
},
"basedOnCount": 0,
"originToCount": 0,
"isSample": true,
"electronicInvoiceType": "string",
"healthCertificateId": "string",
"sentToHC": true,
"foreignVatId": "string",
"vatTexts": ["string"
],
"hasSavedGrossAmount": true,
"property1": null,
"property2": null
}

PatchInvoice

path Parameters

invoice

required

string

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

customsReceiptNo

string or null [ 0 .. 200 ] characters

Responses

Request samples

Payload

Content type

application/json

{"customsReceiptNo": "string"
}

Response samples

200
204
default

Content type

application/json

{"id": "string",
"number": 0,
"isCreditNote": true,
"status": "string",
"date": "2019-08-24",
"dueDate": "2019-08-24",
"currency": "str",
"exchangeRate": 0,
"address": {"description": "string",
"line1": "string",
"line2": "string",
"line3": "string",
"line4": "string",
"postCode": "string",
"country": "st",
"city": "string",
"state": "string"
},
"kid": "string",
"paymentTerms": {"name": "string"
},
"totalNetAmount": 0,
"totalGrossAmount": 0,
"totalVatAmounts": [{"amount": 0,
"rate": {"id": "string",
"percent": 0,
"description": "string"
},
"taxableAmount": 0
}
],
"lines": [{"id": "string",
"orderId": "string",
"orderLineId": ["string"
],
"description": "string",
"netAmount": 0,
"grossAmount": 0,
"vatRate": {"id": "string",
"percent": 0,
"description": "string"
},
"price": 0,
"quantity": 0,
"itemId": "string"
}
],
"orders": [{"id": "string",
"number": 0,
"date": "2019-08-24",
"arrivalDate": "2019-08-24",
"shipmentDate": "2019-08-24",
"deliveryAddress": {"description": "string",
"line1": "string",
"line2": "string",
"line3": "string",
"line4": "string",
"postCode": "string",
"country": "st",
"city": "string",
"state": "string"
},
"dimensions": [{"dimensionId": "string",
"dimensionName": "string",
"dimensionDetailId": "string",
"dimensionDetailName": "string"
}
]
}
],
"type": "string",
"customer": {"id": "string",
"number": "string",
"externalNumber": "string",
"name": "string",
"organizationNumber": "string",
"vatNumber": "string",
"eori": "string",
"email": "string",
"phone": "string"
},
"yourReference": "string",
"ourReference": "string",
"isFactoring": true,
"factoringStatus": "string",
"customsReceiptNo": "string"
}

Item

GetItems

query Parameters

accountId required	string <guid>
domainId required	string <guid>
IsSalesItem	boolean or null
IsPurchaseItem	boolean or null
IsProcessingItem	boolean or null
ItemNo	string or null
Name	string or null
ExternalItemNo	string or null
ExternalItemDescription	string or null
GTIN	string or null
DimensionDetailId	string or null
DimensionName	string or null
DimensionValue	string or null
ItemId	string or null
ChangedSince	string or null <date-time>
	(WeightType (string or null))
IncludeTranslations	boolean or null
IncludeTradeUnits	boolean or null Adds the trade unit level name and External Level to each item. Costs an extra call to the item service.
userId	string <guid>
traceId	string <guid>

Responses

Response samples

200
default

Content type

application/json

[{"itemNo": "string",
"externalItemNo": "string",
"externalItemDescription": "string",
"name": "string",
"gtin": "string",
"epdNo": "string",
"noOfPieces": 0,
"weight": 0,
"weightType": "Fixed",
"isSalesItem": true,
"isPurchaseItem": true,
"isProcessingItem": true,
"isIngredient": true,
"isCoProduct": true,
"isResultProduct": true,
"isPackaging": true,
"priceLevel": "Weight",
"weightUnit": "string",
"measureUnit": "string",
"unitsPerPallet": 0,
"useBy": 0,
"itemId": "string",
"dimensions": [{"dimensionType": {"name": "string"
},
"value": "string",
"dimensionName": "string",
"description": "string",
"minSize": 0,
"maxSize": 0,
"weightUnitId": "string"
}
],
"translations": {"property1": "string",
"property2": "string"
},
"lastModifiedAt": "2019-08-24T14:15:22Z",
"tradeUnitLevelName": "string",
"tradeUnitExternalLevel": "string",
"tradeUnitGroups": [{"rootItemId": "string",
"rootItemTradeUnitName": "string",
"rootItemTradeUnitExternalName": "string",
"name": "string",
"items": [{"tradeUnitName": "string",
"tradeUnitExternalName": "string",
"itemId": "string",
"rootItemQty": 0
}
]
}
]
}
]

PostItem

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

itemNo	string or null
externalItemNo	string or null
externalItemDescription	string or null
name	string or null
gtin	string or null
epdNo	string or null
noOfPieces required	integer <int32>
weight	number or null <decimal>
weightType required	string (WeightType2) Enum: "Fixed" "Estimated"
isSalesItem required	boolean
isPurchaseItem required	boolean
isProcessingItem required	boolean
isIngredient	boolean or null
isCoProduct	boolean or null
isResultProduct	boolean or null
isPackaging	boolean or null
priceLevel required	string (PriceLevelEnum) Enum: "Weight" "ConsumerPack" "Box"
weightUnit	string or null
measureUnit	string or null
unitsPerPallet	integer or null <int32>
useBy	integer or null <int32>
	Array of objects or null (ItemDimensionCore)

Responses

Request samples

Payload

Content type

application/json

{"itemNo": "string",
"externalItemNo": "string",
"externalItemDescription": "string",
"name": "string",
"gtin": "string",
"epdNo": "string",
"noOfPieces": 0,
"weight": 0,
"weightType": "Fixed",
"isSalesItem": true,
"isPurchaseItem": true,
"isProcessingItem": true,
"isIngredient": true,
"isCoProduct": true,
"isResultProduct": true,
"isPackaging": true,
"priceLevel": "Weight",
"weightUnit": "string",
"measureUnit": "string",
"unitsPerPallet": 0,
"useBy": 0,
"dimensions": [{"dimensionType": {"name": "string"
},
"value": "string"
}
]
}

Response samples

200
204
default

Content type

application/json

{"itemNo": "string",
"externalItemNo": "string",
"externalItemDescription": "string",
"name": "string",
"gtin": "string",
"epdNo": "string",
"noOfPieces": 0,
"weight": 0,
"weightType": "Fixed",
"isSalesItem": true,
"isPurchaseItem": true,
"isProcessingItem": true,
"isIngredient": true,
"isCoProduct": true,
"isResultProduct": true,
"isPackaging": true,
"priceLevel": "Weight",
"weightUnit": "string",
"measureUnit": "string",
"unitsPerPallet": 0,
"useBy": 0,
"itemId": "string",
"dimensions": [{"dimensionType": {"name": "string"
},
"value": "string",
"dimensionName": "string",
"description": "string",
"minSize": 0,
"maxSize": 0,
"weightUnitId": "string"
}
],
"translations": {"property1": "string",
"property2": "string"
},
"lastModifiedAt": "2019-08-24T14:15:22Z",
"tradeUnitLevelName": "string",
"tradeUnitExternalLevel": "string",
"tradeUnitGroups": [{"rootItemId": "string",
"rootItemTradeUnitName": "string",
"rootItemTradeUnitExternalName": "string",
"name": "string",
"items": [{"tradeUnitName": "string",
"tradeUnitExternalName": "string",
"itemId": "string",
"rootItemQty": 0
}
]
}
]
}

PutItem

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

itemNo	string or null
externalItemNo	string or null
externalItemDescription	string or null
name	string or null
gtin	string or null
epdNo	string or null
noOfPieces required	integer <int32>
weight	number or null <decimal>
weightType required	string (WeightType2) Enum: "Fixed" "Estimated"
isSalesItem required	boolean
isPurchaseItem required	boolean
isProcessingItem required	boolean
isIngredient	boolean or null
isCoProduct	boolean or null
isResultProduct	boolean or null
isPackaging	boolean or null
priceLevel required	string (PriceLevelEnum) Enum: "Weight" "ConsumerPack" "Box"
weightUnit	string or null
measureUnit	string or null
unitsPerPallet	integer or null <int32>
useBy	integer or null <int32>
	Array of objects or null (ItemDimensionCore)

Responses

Request samples

Payload

Content type

application/json

{"itemNo": "string",
"externalItemNo": "string",
"externalItemDescription": "string",
"name": "string",
"gtin": "string",
"epdNo": "string",
"noOfPieces": 0,
"weight": 0,
"weightType": "Fixed",
"isSalesItem": true,
"isPurchaseItem": true,
"isProcessingItem": true,
"isIngredient": true,
"isCoProduct": true,
"isResultProduct": true,
"isPackaging": true,
"priceLevel": "Weight",
"weightUnit": "string",
"measureUnit": "string",
"unitsPerPallet": 0,
"useBy": 0,
"dimensions": [{"dimensionType": {"name": "string"
},
"value": "string"
}
]
}

Response samples

200
204
default

Content type

application/json

{"itemNo": "string",
"externalItemNo": "string",
"externalItemDescription": "string",
"name": "string",
"gtin": "string",
"epdNo": "string",
"noOfPieces": 0,
"weight": 0,
"weightType": "Fixed",
"isSalesItem": true,
"isPurchaseItem": true,
"isProcessingItem": true,
"isIngredient": true,
"isCoProduct": true,
"isResultProduct": true,
"isPackaging": true,
"priceLevel": "Weight",
"weightUnit": "string",
"measureUnit": "string",
"unitsPerPallet": 0,
"useBy": 0,
"itemId": "string",
"dimensions": [{"dimensionType": {"name": "string"
},
"value": "string",
"dimensionName": "string",
"description": "string",
"minSize": 0,
"maxSize": 0,
"weightUnitId": "string"
}
],
"translations": {"property1": "string",
"property2": "string"
},
"lastModifiedAt": "2019-08-24T14:15:22Z",
"tradeUnitLevelName": "string",
"tradeUnitExternalLevel": "string",
"tradeUnitGroups": [{"rootItemId": "string",
"rootItemTradeUnitName": "string",
"rootItemTradeUnitExternalName": "string",
"name": "string",
"items": [{"tradeUnitName": "string",
"tradeUnitExternalName": "string",
"itemId": "string",
"rootItemQty": 0
}
]
}
]
}

DeleteItem

query Parameters

accountId required	string <guid>
domainId required	string <guid>
itemNo required	string or null
userId	string <guid>
traceId	string <guid>

Responses

Response samples

200
204
default

Content type

application/json

{"itemId": "string",
"deleted": true,
"error": "string",
"property1": null,
"property2": null
}

GetActorItemMappings

query Parameters

accountId required	string <guid>
domainId required	string <guid>
itemId required	string or null
userId	string <guid>
traceId	string <guid>

Responses

Response samples

200
default

Content type

application/json

[{"actorItemId": "string",
"actorItemNumber": "string",
"actorItemName": "string",
"actorId": "string",
"actorName": "string",
"actorNumber": "string",
"actorTypeId": "string",
"actorType": "string",
"itemId": "string"
}
]

Label

GetLabels

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

200
default

Content type

application/json

[{"labelId": "string",
"labelNo": 0,
"name": "string",
"printerType": "Pdf",
"labelType": "Box"
}
]

ImportLabels

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

Array

labelId required	string <guid>
labelNo required	integer <int32>
name	string or null
	(PrinterType (string or null))
	(LabelType (string or null))

Responses

Request samples

Payload

Content type

application/json

[{"labelId": "string",
"labelNo": 0,
"name": "string",
"printerType": "Pdf",
"labelType": "Box"
}
]

Response samples

default

Content type

application/json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"property1": null,
"property2": null
}

LandingNote

GetLandingNotes

query Parameters

accountId required	string <guid>
domainId required	string <guid>
SpeciesId	string or null <guid>
QualityFormId	string or null
Skip	integer or null <int32>
Take	integer or null <int32>
FacilityName	string or null
userId	string <guid>
traceId	string <guid>

Responses

Response samples

200
204
default

Content type

application/json

[{"landingNoteId": "string",
"facilityName": "string",
"vesselName": "string",
"lines": [{"speciesId": "string",
"speciesCode": "string",
"speciesName": "string",
"faoCode": "string",
"latinName": "string",
"netWeight": 0
}
],
"qualityFormId": "string"
}
]

PatchLandingNote

path Parameters

landingNoteId

required

string <guid>

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

qualityFormId

string or null

Responses

Request samples

Payload

Content type

application/json

{"qualityFormId": "string"
}

Language

GetLanguageCodes

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

200
default

Content type

application/json

[{"labelId": "string",
"labelNo": 0,
"name": "string",
"printerType": "Pdf",
"labelType": "Box"
}
]

MessageQueue

Create a new message on the message queue.

query Parameters

accountId required	string <guid>
domainId required	string <guid>
MessageType	string or null The message type identifier.
MessageText	string or null The message body text.
	object or null Optional metadata as key/value pairs. Use the 'md' prefix in the query string: ?md.key1=123&md.anotherkey=api For Swagger UI use JSON syntax: { "md.key1" : "value1", "md.key2" : "value2" }
userId	string <guid>
traceId	string <guid>

Responses

Response samples

200
204
default

Content type

application/json

{"messageId": "string",
"messageType": "string",
"status": "string",
"messageText": "string",
"time": "2019-08-24T14:15:22Z",
"size": 0,
"metadata": {"property1": "string",
"property2": "string"
}
}

GetFromMessageQueue

query Parameters

accountId required	string <guid>
domainId required	string <guid>
MessageType	string or null
MessageStatus	string or null
From	string or null <date-time>
To	string or null <date-time>
	object or null
IncludeReadMessages	boolean or null
userId	string <guid>
traceId	string <guid>

Responses

Response samples

200
default

Content type

application/json

[{"messageId": "string",
"messageType": "string",
"status": "string",
"messageText": "string",
"time": "2019-08-24T14:15:22Z",
"size": 0,
"metadata": {"property1": "string",
"property2": "string"
}
}
]

GetMessage

path Parameters

required

string <guid>

query Parameters

accountId required	string <guid>
domainId required	string <guid>
IncludeContent	boolean or null
userId	string <guid>
traceId	string <guid>

Responses

Response samples

200
204
default

Content type

application/json

{"messageId": "string",
"messageType": "string",
"status": "string",
"messageText": "string",
"time": "2019-08-24T14:15:22Z",
"size": 0,
"metadata": {"property1": "string",
"property2": "string"
},
"content": "string"
}

SetMessageRead

path Parameters

required

string <guid>

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

204
default

Content type

application/json

{"messageId": "string",
"messageType": "string",
"status": "string",
"messageText": "string",
"time": "2019-08-24T14:15:22Z",
"size": 0,
"metadata": {"property1": "string",
"property2": "string"
},
"content": "string"
}

GetMessageContent

path Parameters

required

string <guid>

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

default

Content type

application/json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"property1": null,
"property2": null
}

PaymentTerms

GetAllPaymentTerms

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

200
default

Content type

application/json

[{"id": "string",
"code": "string",
"name": "string",
"numberOfDays": 0,
"calculateFrom": "string"
}
]

PostPaymentTerm

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

Array

id	string or null <guid>
code	string or null
name	string or null
numberOfDays required	integer <int32>
calculateFrom	string or null

Responses

Request samples

Payload

Content type

application/json

[{"id": "string",
"code": "string",
"name": "string",
"numberOfDays": 0,
"calculateFrom": "string"
}
]

Response samples

default

Content type

application/json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"property1": null,
"property2": null
}

PutPaymentTerm

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

id	string or null <guid>
code	string or null
name	string or null
numberOfDays required	integer <int32>
calculateFrom	string or null

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"code": "string",
"name": "string",
"numberOfDays": 0,
"calculateFrom": "string"
}

Response samples

default

Content type

application/json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"property1": null,
"property2": null
}

GetPaymentTerm

path Parameters

required

string <guid>

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

200
204
default

Content type

application/json

{"id": "string",
"code": "string",
"name": "string",
"numberOfDays": 0,
"calculateFrom": "string"
}

PayrollCode

GetPayrollCodeById

path Parameters

payrollCodeId

required

string <guid>

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

200
204
400
default

Content type

application/json

{"payrollCodeId": "string",
"code": "string",
"description": "string",
"payrollCodeType": "Earnings",
"property1": null,
"property2": null
}

DeletePayrollCode

path Parameters

payrollCodeId

required

string <guid>

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

Content type

application/json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"property1": null,
"property2": null
}

FindPayrollCodes

query Parameters

accountId required	string <guid>
domainId required	string <guid>
payrollCodeId	string or null <guid>
code	string or null
	((PayrollType (string or null)))
skip	integer or null <int32>
take	integer or null <int32>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

200
204
400
default

Content type

application/json

{"items": [{"payrollCodeId": "string",
"code": "string",
"description": "string",
"payrollCodeType": "Earnings",
"property1": null,
"property2": null
}
],
"skip": 0,
"totalResults": 0,
"property1": null,
"property2": null
}

CreatePayrollCode

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

Array

payrollCodeId required	string <guid>
code	string or null
description	string or null
payrollCodeType required	string (PayrollType) Enum: "Earnings" "Deductions" "BoatGross" "CaptainNonEI" "Other"
property name* additional property	any or null

Responses

Request samples

Payload

Content type

application/json

[{"payrollCodeId": "string",
"code": "string",
"description": "string",
"payrollCodeType": "Earnings",
"property1": null,
"property2": null
}
]

Response samples

200
400
default

Content type

application/json

[{"payrollCodeId": "string",
"code": "string",
"description": "string",
"payrollCodeType": "Earnings",
"property1": null,
"property2": null
}
]

UpdatePayrollCodeAsync

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

Array

payrollCodeId required	string <guid>
code	string or null
description	string or null
payrollCodeType required	string (PayrollType) Enum: "Earnings" "Deductions" "BoatGross" "CaptainNonEI" "Other"
property name* additional property	any or null

Responses

Request samples

Payload

Content type

application/json

[{"payrollCodeId": "string",
"code": "string",
"description": "string",
"payrollCodeType": "Earnings",
"property1": null,
"property2": null
}
]

Response samples

Content type

application/json

[{"portOfLandingId": "string",
"code": "string",
"description": "string",
"property1": null,
"property2": null
}
]

Price

Get item prices

Get item prices for a given date

query Parameters

accountId required	string <guid>
domainId required	string <guid>
date	string or null <date-time>
	(PriceListType (string or null))
dimensionName	string or null
dimensionValue	string or null
actorNo	string or null
userId	string <guid>
traceId	string <guid>

Responses

Response samples

200
default

Content type

application/json

[{"itemId": "string",
"itemNo": "string",
"itemExtNo": "string",
"estimatedWeight": 0,
"fixedWeight": 0,
"currencyCode": "string",
"price": 0,
"priceUnit": "Weight",
"discount": 0,
"discountType": "Percent",
"actorId": "string",
"actorNo": "string",
"priceListId": "string",
"itemPriceId": "string",
"startDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z"
}
]

Production

Consume raw material

Consumes raw material from the specified purchase order and pallet.

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

purchaseOrder	string or null
palletSscc	string or null

Responses

Request samples

Payload

Content type

application/json

{"purchaseOrder": "string",
"palletSscc": "string"
}

Response samples

default

Content type

application/json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"property1": null,
"property2": null
}

Un-consume raw material

Un-consumes raw material for the specified pallet.

query Parameters

accountId required	string <guid>
domainId required	string <guid>
palletSscc required	string or null
userId	string <guid>
traceId	string <guid>

Responses

Response samples

default

Content type

application/json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"property1": null,
"property2": null
}

Get production orders

Gets production orders matching the provided search criteries.

query Parameters

accountId required	string <guid>
domainId required	string <guid>
Description	string or null
ProductionOrderNo	string or null
PurchaseOrderNo	string or null
DateFrom	string or null <date>
DateTo	string or null <date>
RecipeId	string or null <guid>
Skip	integer or null <int32>
Take	integer or null <int32>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

200
204
default

Content type

application/json

{"items": [{"description": "string",
"recipeVersionId": "string",
"numberOfEmployees": 0,
"productionLineId": "string",
"productionStart": "2019-08-24T14:15:22Z",
"productionEnd": "2019-08-24T14:15:22Z",
"personResponsibleId": "string",
"lotNo": "string",
"externalRefNo": "string",
"vendorId": "string",
"productionOrderId": "string",
"productionOrderNo": "string",
"purchaseOrderNo": "string",
"vendorName": "string",
"recipeId": "string",
"recipeName": "string",
"productionLineName": "string",
"chain": {"id": "string",
"parentId": "string",
"name": "string",
"children": [{ }
]
}
}
],
"skip": 0,
"totalResults": 0
}

Create production order

Creates a new production order.

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

description	string or null
recipeVersionId	string or null <guid>
numberOfEmployees	integer or null <int32>
productionLineId	string or null <guid>
productionStart	string or null <date-time>
productionEnd	string or null <date-time>
personResponsibleId	string or null <guid>
lotNo	string or null
externalRefNo	string or null
vendorId	string or null <guid>
isMultiStepDesired	boolean or null True if additional linked production orders should be created for each step in the recipe. Requires RecipeVersionId and ProductionLineId to have a matching number of prior steps.

Responses

Request samples

Payload

Content type

application/json

{"description": "string",
"recipeVersionId": "string",
"numberOfEmployees": 0,
"productionLineId": "string",
"productionStart": "2019-08-24T14:15:22Z",
"productionEnd": "2019-08-24T14:15:22Z",
"personResponsibleId": "string",
"lotNo": "string",
"externalRefNo": "string",
"vendorId": "string",
"isMultiStepDesired": true
}

Response samples

200
204
default

Content type

application/json

{"description": "string",
"recipeVersionId": "string",
"numberOfEmployees": 0,
"productionLineId": "string",
"productionStart": "2019-08-24T14:15:22Z",
"productionEnd": "2019-08-24T14:15:22Z",
"personResponsibleId": "string",
"lotNo": "string",
"externalRefNo": "string",
"vendorId": "string",
"productionOrderId": "string",
"productionOrderNo": "string",
"purchaseOrderNo": "string",
"vendorName": "string",
"recipeId": "string",
"recipeName": "string",
"productionLineName": "string",
"chain": {"id": "string",
"parentId": "string",
"name": "string",
"children": [{ }
]
}
}

Get production order

Get one specific production order. The order parameter can be either a production order number or production order id.

path Parameters

order

required

string

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

200
204
default

Content type

application/json

{"description": "string",
"recipeVersionId": "string",
"numberOfEmployees": 0,
"productionLineId": "string",
"productionStart": "2019-08-24T14:15:22Z",
"productionEnd": "2019-08-24T14:15:22Z",
"personResponsibleId": "string",
"lotNo": "string",
"externalRefNo": "string",
"vendorId": "string",
"productionOrderId": "string",
"productionOrderNo": "string",
"purchaseOrderNo": "string",
"vendorName": "string",
"recipeId": "string",
"recipeName": "string",
"productionLineName": "string",
"chain": {"id": "string",
"parentId": "string",
"name": "string",
"children": [{ }
]
}
}

Update production order

Updates details for a production order. The order parameter can be either a production order number or production order id.

path Parameters

order

required

string

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

description	string or null
recipeVersionId	string or null <guid>
numberOfEmployees	integer or null <int32>
productionLineId	string or null <guid>
productionStart	string or null <date-time>
productionEnd	string or null <date-time>
personResponsibleId	string or null <guid>
lotNo	string or null
externalRefNo	string or null
vendorId	string or null <guid>

Responses

Request samples

Payload

Content type

application/json

{"description": "string",
"recipeVersionId": "string",
"numberOfEmployees": 0,
"productionLineId": "string",
"productionStart": "2019-08-24T14:15:22Z",
"productionEnd": "2019-08-24T14:15:22Z",
"personResponsibleId": "string",
"lotNo": "string",
"externalRefNo": "string",
"vendorId": "string"
}

Response samples

200
204
default

Content type

application/json

{"description": "string",
"recipeVersionId": "string",
"numberOfEmployees": 0,
"productionLineId": "string",
"productionStart": "2019-08-24T14:15:22Z",
"productionEnd": "2019-08-24T14:15:22Z",
"personResponsibleId": "string",
"lotNo": "string",
"externalRefNo": "string",
"vendorId": "string",
"productionOrderId": "string",
"productionOrderNo": "string",
"purchaseOrderNo": "string",
"vendorName": "string",
"recipeId": "string",
"recipeName": "string",
"productionLineName": "string",
"chain": {"id": "string",
"parentId": "string",
"name": "string",
"children": [{ }
]
}
}

Patch production order

Updates details for a production order. The supported properties are the same as PUT. The order parameter can be either a production order number or production order id.

path Parameters

order

required

string

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

property name*

additional property

any

Responses

Request samples

Payload

Content type

application/json

{"property1": null,
"property2": null
}

Response samples

200
204
default

Content type

application/json

{"description": "string",
"recipeVersionId": "string",
"numberOfEmployees": 0,
"productionLineId": "string",
"productionStart": "2019-08-24T14:15:22Z",
"productionEnd": "2019-08-24T14:15:22Z",
"personResponsibleId": "string",
"lotNo": "string",
"externalRefNo": "string",
"vendorId": "string",
"productionOrderId": "string",
"productionOrderNo": "string",
"purchaseOrderNo": "string",
"vendorName": "string",
"recipeId": "string",
"recipeName": "string",
"productionLineName": "string",
"chain": {"id": "string",
"parentId": "string",
"name": "string",
"children": [{ }
]
}
}

Delete production order

Deletes a production order. The order parameter can be either a production order number or production order id.

path Parameters

order

required

string

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

default

Content type

application/json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"property1": null,
"property2": null
}

Get production lines

Gets a list of available production lines.

query Parameters

accountId required	string <guid>
domainId required	string <guid>
Skip	integer or null <int32>
Take	integer or null <int32>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

200
204
default

Content type

application/json

{"items": [{"productionLineId": "string",
"name": "string",
"chain": {"id": "string",
"parentId": "string",
"name": "string",
"children": [{ }
]
}
}
],
"skip": 0,
"totalResults": 0
}

Get recipes

Gets a list of available recipes.

query Parameters

accountId required	string <guid>
domainId required	string <guid>
Skip	integer or null <int32>
Take	integer or null <int32>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

200
204
default

Content type

application/json

{"items": [{"recipeId": "string",
"recipeVersionId": "string",
"name": "string",
"chain": {"id": "string",
"parentId": "string",
"name": "string",
"children": [{ }
]
}
}
],
"skip": 0,
"totalResults": 0
}

Get equipment groups

Gets a list of available equipment groups.

query Parameters

accountId required	string <guid>
domainId required	string <guid>
Skip	integer or null <int32>
Take	integer or null <int32>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

200
204
default

Content type

application/json

{"items": [{"equipmentGroupId": "string",
"name": "string",
"isSynced": true
}
],
"skip": 0,
"totalResults": 0
}

PurchaseOrder

Get purchase orders

Get all purchase orders matching date and order status criteries.

query Parameters

accountId required	string <guid>
domainId required	string <guid>
fromPoDate	string or null <date-time>
toPoDate	string or null <date-time>
orderStatus	string or null
orderSubStatus	integer or null <int32>
subStatus	string or null
dimensionName	string or null
dimensionValue	string or null
vendor	string or null
warehouse	string or null
externalReferenceNo	string or null
changedSince	string or null <date-time>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

200
default

Content type

application/json

[{"purchaseOrderNo": 0,
"purchaseOrderId": "string",
"vendorNo": 0,
"vendorId": "string",
"responsiblePersonId": "string",
"packingPlantId": "string",
"packingLabel": "string",
"packingDate": "2019-08-24",
"arrivalDate": "2019-08-24",
"shipmentDate": "2019-08-24",
"weightUnitId": "string",
"currencyId": "string",
"orderStatus": 0,
"orderSubStatusId": "string",
"subStatusId": "string",
"warehouseId": "string",
"comment": "string",
"externalReferenceNo": "string",
"vendorOrderNo": "string",
"vendorReference": "string",
"cageNo": "string",
"locationCode": "string",
"locationNo": 0,
"tags": ["string"
],
"landingNotes": ["string"
],
"forecasts": [{"itemId": "string",
"lineNo": 0,
"weight": 0,
"boxes": 0,
"price": 0,
"notes": "string"
}
],
"dimensions": [{"dimensionId": "string",
"dimensionName": "string",
"sortOrder": 0,
"dimensionDetailId": "string",
"dimensionDetailName": "string"
}
],
"boxes": [{"itemId": "string",
"itemCode": "string",
"palletNo": "string",
"boxNo": "string",
"pieces": 0,
"netWeight": 0,
"duplicateUnits": 0
}
]
}
]

Create purchase order

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

purchaseOrderNo	integer or null <int32>
purchaseOrderId	string or null <guid>
vendorNo	integer or null <int32>
vendorId	string or null <guid>
responsiblePersonId	string or null <guid>
packingPlantId	string or null <guid>
packingLabel	string or null
packingDate	string or null <date>
arrivalDate	string or null <date>
shipmentDate	string or null <date>
weightUnitId	string or null
currencyId	string or null
orderStatus	integer or null <int32>
orderSubStatusId	string or null <guid> Deprecated, use SubStatusId
subStatusId	string or null <guid>
warehouseId	string or null <guid>
comment	string or null
externalReferenceNo	string or null
vendorOrderNo	string or null
vendorReference	string or null
cageNo	string or null
locationCode	string or null
locationNo	integer or null <int64>
tags	Array of strings or null
landingNotes	Array of strings or null
	Array of objects or null (PurchaseOrderForecast)
	Array of objects or null (OrderDimension)
	Array of objects or null (PurchaseOrderBoxDto)

Responses

Request samples

Payload

Content type

application/json

{"purchaseOrderNo": 0,
"purchaseOrderId": "string",
"vendorNo": 0,
"vendorId": "string",
"responsiblePersonId": "string",
"packingPlantId": "string",
"packingLabel": "string",
"packingDate": "2019-08-24",
"arrivalDate": "2019-08-24",
"shipmentDate": "2019-08-24",
"weightUnitId": "string",
"currencyId": "string",
"orderStatus": 0,
"orderSubStatusId": "string",
"subStatusId": "string",
"warehouseId": "string",
"comment": "string",
"externalReferenceNo": "string",
"vendorOrderNo": "string",
"vendorReference": "string",
"cageNo": "string",
"locationCode": "string",
"locationNo": 0,
"tags": ["string"
],
"landingNotes": ["string"
],
"forecasts": [{"itemId": "string",
"lineNo": 0,
"weight": 0,
"boxes": 0,
"price": 0,
"notes": "string"
}
],
"dimensions": [{"dimensionId": "string",
"dimensionName": "string",
"sortOrder": 0,
"dimensionDetailId": "string",
"dimensionDetailName": "string"
}
],
"boxes": [{"itemId": "string",
"itemCode": "string",
"palletNo": "string",
"boxNo": "string",
"pieces": 0,
"netWeight": 0,
"duplicateUnits": 0
}
]
}

Response samples

200
204
default

Content type

application/json

{"purchaseOrderNo": 0,
"purchaseOrderId": "string",
"vendorNo": 0,
"vendorId": "string",
"responsiblePersonId": "string",
"packingPlantId": "string",
"packingLabel": "string",
"packingDate": "2019-08-24",
"arrivalDate": "2019-08-24",
"shipmentDate": "2019-08-24",
"weightUnitId": "string",
"currencyId": "string",
"orderStatus": 0,
"orderSubStatusId": "string",
"subStatusId": "string",
"warehouseId": "string",
"comment": "string",
"externalReferenceNo": "string",
"vendorOrderNo": "string",
"vendorReference": "string",
"cageNo": "string",
"locationCode": "string",
"locationNo": 0,
"tags": ["string"
],
"landingNotes": ["string"
],
"forecasts": [{"itemId": "string",
"lineNo": 0,
"weight": 0,
"boxes": 0,
"price": 0,
"notes": "string"
}
],
"dimensions": [{"dimensionId": "string",
"dimensionName": "string",
"sortOrder": 0,
"dimensionDetailId": "string",
"dimensionDetailName": "string"
}
],
"boxes": [{"itemId": "string",
"itemCode": "string",
"palletNo": "string",
"boxNo": "string",
"pieces": 0,
"netWeight": 0,
"duplicateUnits": 0
}
]
}

Update purchase order

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

purchaseOrderNo	integer or null <int32>
purchaseOrderId	string or null <guid>
vendorNo	integer or null <int32>
vendorId	string or null <guid>
responsiblePersonId	string or null <guid>
packingPlantId	string or null <guid>
packingLabel	string or null
packingDate	string or null <date>
arrivalDate	string or null <date>
shipmentDate	string or null <date>
weightUnitId	string or null
currencyId	string or null
orderStatus	integer or null <int32>
orderSubStatusId	string or null <guid> Deprecated, use SubStatusId
subStatusId	string or null <guid>
warehouseId	string or null <guid>
comment	string or null
externalReferenceNo	string or null
vendorOrderNo	string or null
vendorReference	string or null
cageNo	string or null
locationCode	string or null
locationNo	integer or null <int64>
tags	Array of strings or null
landingNotes	Array of strings or null
	Array of objects or null (PurchaseOrderForecast)
	Array of objects or null (OrderDimension)
	Array of objects or null (PurchaseOrderBoxDto)

Responses

Request samples

Payload

Content type

application/json

{"purchaseOrderNo": 0,
"purchaseOrderId": "string",
"vendorNo": 0,
"vendorId": "string",
"responsiblePersonId": "string",
"packingPlantId": "string",
"packingLabel": "string",
"packingDate": "2019-08-24",
"arrivalDate": "2019-08-24",
"shipmentDate": "2019-08-24",
"weightUnitId": "string",
"currencyId": "string",
"orderStatus": 0,
"orderSubStatusId": "string",
"subStatusId": "string",
"warehouseId": "string",
"comment": "string",
"externalReferenceNo": "string",
"vendorOrderNo": "string",
"vendorReference": "string",
"cageNo": "string",
"locationCode": "string",
"locationNo": 0,
"tags": ["string"
],
"landingNotes": ["string"
],
"forecasts": [{"itemId": "string",
"lineNo": 0,
"weight": 0,
"boxes": 0,
"price": 0,
"notes": "string"
}
],
"dimensions": [{"dimensionId": "string",
"dimensionName": "string",
"sortOrder": 0,
"dimensionDetailId": "string",
"dimensionDetailName": "string"
}
],
"boxes": [{"itemId": "string",
"itemCode": "string",
"palletNo": "string",
"boxNo": "string",
"pieces": 0,
"netWeight": 0,
"duplicateUnits": 0
}
]
}

Response samples

200
204
default

Content type

application/json

{"purchaseOrderNo": 0,
"purchaseOrderId": "string",
"vendorNo": 0,
"vendorId": "string",
"responsiblePersonId": "string",
"packingPlantId": "string",
"packingLabel": "string",
"packingDate": "2019-08-24",
"arrivalDate": "2019-08-24",
"shipmentDate": "2019-08-24",
"weightUnitId": "string",
"currencyId": "string",
"orderStatus": 0,
"orderSubStatusId": "string",
"subStatusId": "string",
"warehouseId": "string",
"comment": "string",
"externalReferenceNo": "string",
"vendorOrderNo": "string",
"vendorReference": "string",
"cageNo": "string",
"locationCode": "string",
"locationNo": 0,
"tags": ["string"
],
"landingNotes": ["string"
],
"forecasts": [{"itemId": "string",
"lineNo": 0,
"weight": 0,
"boxes": 0,
"price": 0,
"notes": "string"
}
],
"dimensions": [{"dimensionId": "string",
"dimensionName": "string",
"sortOrder": 0,
"dimensionDetailId": "string",
"dimensionDetailName": "string"
}
],
"boxes": [{"itemId": "string",
"itemCode": "string",
"palletNo": "string",
"boxNo": "string",
"pieces": 0,
"netWeight": 0,
"duplicateUnits": 0
}
]
}

Patch purchase order

Payload is sent as dictionary, entries in dictionary matches model from PUT. subStatusName may be supplied instead of subStatusId; it is resolved to a sub-status of the order's current system status.

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

property name*

additional property

any

Responses

Request samples

Payload

Content type

application/json

{"property1": null,
"property2": null
}

Response samples

200
204
default

Content type

application/json

{"purchaseOrderNo": 0,
"purchaseOrderId": "string",
"vendorNo": 0,
"vendorId": "string",
"responsiblePersonId": "string",
"packingPlantId": "string",
"packingLabel": "string",
"packingDate": "2019-08-24",
"arrivalDate": "2019-08-24",
"shipmentDate": "2019-08-24",
"weightUnitId": "string",
"currencyId": "string",
"orderStatus": 0,
"orderSubStatusId": "string",
"subStatusId": "string",
"warehouseId": "string",
"comment": "string",
"externalReferenceNo": "string",
"vendorOrderNo": "string",
"vendorReference": "string",
"cageNo": "string",
"locationCode": "string",
"locationNo": 0,
"tags": ["string"
],
"landingNotes": ["string"
],
"forecasts": [{"itemId": "string",
"lineNo": 0,
"weight": 0,
"boxes": 0,
"price": 0,
"notes": "string"
}
],
"dimensions": [{"dimensionId": "string",
"dimensionName": "string",
"sortOrder": 0,
"dimensionDetailId": "string",
"dimensionDetailName": "string"
}
],
"boxes": [{"itemId": "string",
"itemCode": "string",
"palletNo": "string",
"boxNo": "string",
"pieces": 0,
"netWeight": 0,
"duplicateUnits": 0
}
]
}

Get a purchase order

path Parameters

purchaseOrder

required

string

query Parameters

accountId required	string <guid>
domainId required	string <guid>
boxLevel	boolean or null
userId	string <guid>
traceId	string <guid>

Responses

Response samples

200
204
default

Content type

application/json

{"purchaseOrderNo": 0,
"purchaseOrderId": "string",
"vendorNo": 0,
"vendorId": "string",
"responsiblePersonId": "string",
"packingPlantId": "string",
"packingLabel": "string",
"packingDate": "2019-08-24",
"arrivalDate": "2019-08-24",
"shipmentDate": "2019-08-24",
"weightUnitId": "string",
"currencyId": "string",
"orderStatus": 0,
"orderSubStatusId": "string",
"subStatusId": "string",
"warehouseId": "string",
"comment": "string",
"externalReferenceNo": "string",
"vendorOrderNo": "string",
"vendorReference": "string",
"cageNo": "string",
"locationCode": "string",
"locationNo": 0,
"tags": ["string"
],
"landingNotes": ["string"
],
"forecasts": [{"itemId": "string",
"lineNo": 0,
"weight": 0,
"boxes": 0,
"price": 0,
"notes": "string"
}
],
"dimensions": [{"dimensionId": "string",
"dimensionName": "string",
"sortOrder": 0,
"dimensionDetailId": "string",
"dimensionDetailName": "string"
}
],
"boxes": [{"itemId": "string",
"itemCode": "string",
"palletNo": "string",
"boxNo": "string",
"pieces": 0,
"netWeight": 0,
"duplicateUnits": 0
}
]
}

Confirm purchase order

query Parameters

accountId required	string <guid>
domainId required	string <guid>
purchaseOrder	string or null
processAsync	boolean or null
userId	string <guid>
traceId	string <guid>

Responses

Response samples

200
204
default

Content type

application/json

{"salesOrderNo": 0,
"salesOrderId": "string",
"customerNo": 0,
"customerId": "string",
"responsiblePersonId": "string",
"vendorSalesOrderNo": "string",
"customerReference": "string",
"orderInfo": "string",
"awbNo": "string",
"flightRegNo": "string",
"transportRegNo": "string",
"transporterNo": 0,
"transporterId": "string",
"packingPlantId": "string",
"shipmentDate": "2019-08-24",
"packingPlantShipmentDate": "2019-08-24",
"eta": "2019-08-24T14:15:22Z",
"shipFromId": "string",
"orderStatus": 0,
"orderSubStatusId": "string",
"subStatusId": "string",
"subStatusName": "string",
"systemStatus": "string",
"isDeleted": true,
"currencyId": "string",
"weightUnitId": "string",
"customerOrderNo": "string",
"customerPurchaseOrderNo": "string",
"comment": "string",
"tags": ["string"
],
"deniedTags": ["string"
],
"deliveryPlaceId": "string",
"deliveryPlaceName": "string",
"deliveryPlaceAddress1": "string",
"deliveryPlaceAddress2": "string",
"deliveryPlaceAddress3": "string",
"deliveryPlaceAddress4": "string",
"deliveryPlacePostCode": "string",
"deliveryPlacePostalPlace": "string",
"deliveryPlaceState": "string",
"deliveryPlaceCountry": "string",
"deliveryTerms": "string",
"routeNumber": "string",
"deliveryRemarks": "string",
"paymentTermsId": "string",
"paymentTermsCode": "string",
"paymentTermsName": "string",
"orderLines": [{"orderLineId": "string",
"orderLineNo": 0,
"itemCode": "string",
"itemId": "string",
"gtin": "string",
"externalItemCode": "string",
"externalItemDescription": "string",
"bookedBoxes": 0,
"bookedWeight": 0,
"allocatedBoxes": 0,
"allocatedWeight": 0,
"allocateFromLot": "string",
"unitsPerPallet": 0,
"piecesPerUnit": 0,
"notes": "string",
"price": 0,
"priceUnit": 0,
"isDeleted": true
}
],
"dimensions": [{"dimensionId": "string",
"dimensionName": "string",
"sortOrder": 0,
"dimensionDetailId": "string",
"dimensionDetailName": "string"
}
],
"boxes": [{"itemId": "string",
"itemCode": "string",
"itemName": "string",
"palletNo": "string",
"palletSscc": "string",
"boxNo": "string",
"boxSscc": "string",
"useBy": "2019-08-24",
"netWeight": 0,
"duplicateUnits": 0,
"lotNo": "string",
"batchNo": "string",
"packingLabel": "string"
}
],
"lastModifiedAt": "2019-08-24T14:15:22Z",
"property1": null,
"property2": null
}

Get pallets and boxes from raw material storage

query Parameters

accountId required	string <guid>
domainId required	string <guid>
changedSince	string or null <date-time>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

200
204
default

Content type

application/json

[{"palletNo": "string",
"sscc": "string",
"itemCode": "string",
"itemName": "string",
"isDeleted": true,
"purchaseOrderNo": "string",
"vendorNo": "string",
"vendorName": "string",
"poDate": "2019-08-24",
"poEtaDate": "2019-08-24",
"netWeight": 0,
"pieces": 0,
"extBatchNo": "string",
"price": 0,
"priceUnit": 0,
"lastModifiedAt": "2019-08-24T14:15:22Z",
"boxes": [{"netWeight": 0,
"pieces": 0,
"boxNo": "string",
"sscc": "string",
"unit": "string",
"catchDate": "2019-08-24",
"productionDate": "2019-08-24",
"packingLabel": "string"
}
]
}
]

Get pallets and boxes from raw material storage

path Parameters

purchaseOrder

required

string

query Parameters

accountId required	string <guid>
domainId required	string <guid>
changedSince	string or null <date-time>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

200
204
default

Content type

application/json

[{"palletNo": "string",
"sscc": "string",
"itemCode": "string",
"itemName": "string",
"isDeleted": true,
"purchaseOrderNo": "string",
"vendorNo": "string",
"vendorName": "string",
"poDate": "2019-08-24",
"poEtaDate": "2019-08-24",
"netWeight": 0,
"pieces": 0,
"extBatchNo": "string",
"price": 0,
"priceUnit": 0,
"lastModifiedAt": "2019-08-24T14:15:22Z",
"boxes": [{"netWeight": 0,
"pieces": 0,
"boxNo": "string",
"sscc": "string",
"unit": "string",
"catchDate": "2019-08-24",
"productionDate": "2019-08-24",
"packingLabel": "string"
}
]
}
]

Get purchase orders

Get all purchase orders matching date and order status criteries.

query Parameters

accountId required	string <guid>
domainId required	string <guid>
FromShipmentDate	string or null <date>
ToShipmentDate	string or null <date>
FromPackingDate	string or null <date>
ToPackingDate	string or null <date>
FromArrivalDate	string or null <date>
ToArrivalDate	string or null <date>
	(OrderTypeEnum (string or null))
	(PurchaseOrderStatusEnum (string or null))
userId	string <guid>
traceId	string <guid>

Responses

Response samples

200
default

Content type

application/json

[{"purchaseOrderNo": 0,
"purchaseOrderId": "string",
"vendorNo": 0,
"vendorId": "string",
"responsiblePersonId": "string",
"packingPlantId": "string",
"packingLabel": "string",
"packingDate": "2019-08-24",
"arrivalDate": "2019-08-24",
"shipmentDate": "2019-08-24",
"weightUnitId": "string",
"currencyId": "string",
"orderStatus": 0,
"orderSubStatusId": "string",
"subStatusId": "string",
"warehouseId": "string",
"comment": "string",
"externalReferenceNo": "string",
"vendorOrderNo": "string",
"vendorReference": "string",
"cageNo": "string",
"locationCode": "string",
"locationNo": 0,
"tags": ["string"
],
"landingNotes": ["string"
],
"forecasts": [{"itemId": "string",
"lineNo": 0,
"weight": 0,
"boxes": 0,
"price": 0,
"notes": "string"
}
],
"dimensions": [{"dimensionId": "string",
"dimensionName": "string",
"sortOrder": 0,
"dimensionDetailId": "string",
"dimensionDetailName": "string"
}
],
"boxes": [{"itemId": "string",
"itemCode": "string",
"palletNo": "string",
"boxNo": "string",
"pieces": 0,
"netWeight": 0,
"duplicateUnits": 0
}
]
}
]

Get sub-statuses

query Parameters

accountId required	string <guid>
domainId required	string <guid>
systemStatus	string or null
userId	string <guid>
traceId	string <guid>

Responses

Response samples

200
204
default

Content type

application/json

[{"subStatusId": "string",
"systemStatus": "string",
"name": "string",
"description": "string"
}
]

Add purchase order document

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

purchaseOrderId	string or null <guid>
purchaseOrderNo	string or null
contentType	string or null
documentType	string or null
fileName	string or null
payLoad	string or null <byte>

Responses

Request samples

Payload

Content type

application/json

{"purchaseOrderId": "string",
"purchaseOrderNo": "string",
"contentType": "string",
"documentType": "string",
"fileName": "string",
"payLoad": "string"
}

Response samples

default

Content type

application/json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"property1": null,
"property2": null
}

RateLimit

GetRateLimitConfig

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

200
204
default

Content type

application/json

{"limit": 0,
"window": "string"
}

PutRateLimitConfig

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

limit required	integer <int32>
window required	string <duration>

Responses

Request samples

Payload

Content type

application/json

{"limit": 0,
"window": "string"
}

Response samples

200
204
default

Content type

application/json

{"limit": 0,
"window": "string"
}

GetRateLimitStatistics

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

200
204
default

Content type

application/json

{"currentAvailablePermits": 0,
"currentQueuedCount": 0,
"totalFailedLeases": 0,
"totalSuccessfulLeases": 0
}

ReceivingOrder

GetReceivingOrder

path Parameters

type required	string (ReceivingOrderType) Enum: "Invalid" "Purchase" "Transfer"
order required	string

query Parameters

accountId required	string <guid>
domainId required	string <guid>
boxLevel	boolean or null
includeItemDimensions	boolean or null
userId	string <guid>
traceId	string <guid>

Responses

Response samples

Content type

application/json

{"orderId": "string",
"orderNo": "string",
"orderType": "Invalid",
"vendor": {"vendorId": "string",
"number": "string",
"name": "string"
},
"responsiblePersonName": "string",
"packingPlant": {"packingPlantId": "string",
"packingLabel": "string",
"name": "string"
},
"warehouse": {"warehouseId": "string",
"name": "string"
},
"packingDate": "2019-08-24",
"eta": "2019-08-24T14:15:22Z",
"etd": "2019-08-24T14:15:22Z",
"weightUnitId": "string",
"tags": ["string"
],
"tripNo": "string",
"transportRegNo": "string",
"transporterNo": "string",
"transporterName": "string",
"externalOrderInformation": "string",
"awbNo": "string",
"subStatus": {"subStatusId": "string",
"name": "string",
"description": "string"
},
"systemStatus": "string",
"orderLines": [{"itemId": "string",
"itemCode": "string",
"itemName": "string",
"itemDimensions": {"conservation": "string"
},
"lineNo": 0,
"weight": 0,
"noOfUnits": 0,
"pieces": 0
}
],
"boxes": [{"itemId": "string",
"itemCode": "string",
"itemName": "string",
"palletNo": "string",
"palletSscc": "string",
"boxNo": "string",
"boxSscc": "string",
"useBy": "2019-08-24",
"netWeight": 0,
"duplicateUnits": 0,
"lotNo": "string",
"batchNo": "string",
"packingLabel": "string"
}
]
}

GetReceivingOrders

query Parameters

accountId required	string <guid>
domainId required	string <guid>
changedSince	string or null <date-time>
subStatusId	string or null <guid>
skip	integer or null <int32>
take	integer <int32>
boxLevel	boolean or null
includeItemDimensions	boolean or null
userId	string <guid>
traceId	string <guid>

Responses

Response samples

Content type

application/json

{"items": [{"orderId": "string",
"orderNo": "string",
"orderType": "Invalid",
"vendor": {"vendorId": "string",
"number": "string",
"name": "string"
},
"responsiblePersonName": "string",
"packingPlant": {"packingPlantId": "string",
"packingLabel": "string",
"name": "string"
},
"warehouse": {"warehouseId": "string",
"name": "string"
},
"packingDate": "2019-08-24",
"eta": "2019-08-24T14:15:22Z",
"etd": "2019-08-24T14:15:22Z",
"weightUnitId": "string",
"tags": ["string"
],
"tripNo": "string",
"transportRegNo": "string",
"transporterNo": "string",
"transporterName": "string",
"externalOrderInformation": "string",
"awbNo": "string",
"subStatus": {"subStatusId": "string",
"name": "string",
"description": "string"
},
"systemStatus": "string",
"orderLines": [{"itemId": "string",
"itemCode": "string",
"itemName": "string",
"itemDimensions": {"conservation": "string"
},
"lineNo": 0,
"weight": 0,
"noOfUnits": 0,
"pieces": 0
}
],
"boxes": [{"itemId": "string",
"itemCode": "string",
"itemName": "string",
"palletNo": "string",
"palletSscc": "string",
"boxNo": "string",
"boxSscc": "string",
"useBy": "2019-08-24",
"netWeight": 0,
"duplicateUnits": 0,
"lotNo": "string",
"batchNo": "string",
"packingLabel": "string"
}
]
}
],
"skip": 0,
"totalResults": 0
}

GetReceivingOrderDocuments

query Parameters

accountId required	string <guid>
domainId required	string <guid>
changedSince	string or null <date-time>
subStatusId	string or null <guid>
skip	integer or null <int32>
take	integer <int32>
boxLevel	boolean or null
userId	string <guid>
traceId	string <guid>

Responses

Response samples

Content type

application/json

{"items": [{"orderId": "string",
"orderType": "Invalid",
"orderNo": "string",
"documentType": "string",
"documentTypeId": "string",
"documentId": "string",
"name": "string",
"uri": "string"
}
],
"skip": 0,
"totalResults": 0
}

SalesOrder

Get sales orders

Get sales orders matching the date and order status criteries.

query Parameters

accountId required	string <guid>
domainId required	string <guid>
fromDate	string or null <date-time>
toDate	string or null <date-time>
systemStatus	string or null
orderSubStatus	integer or null <int32>
subStatus	string or null
dimensionName	string or null
dimensionValue	string or null
customerOrderNo	string or null
warehouse	string or null
boxLevel	boolean or null
packingPlant	string or null
changedSince	string or null <date-time>
includeDeleted	boolean or null
userId	string <guid>
traceId	string <guid>

Responses

Response samples

200
400
403
default

Content type

application/json

[{"salesOrderNo": 0,
"salesOrderId": "string",
"customerNo": 0,
"customerId": "string",
"responsiblePersonId": "string",
"vendorSalesOrderNo": "string",
"customerReference": "string",
"orderInfo": "string",
"awbNo": "string",
"flightRegNo": "string",
"transportRegNo": "string",
"transporterNo": 0,
"transporterId": "string",
"packingPlantId": "string",
"shipmentDate": "2019-08-24",
"packingPlantShipmentDate": "2019-08-24",
"eta": "2019-08-24T14:15:22Z",
"shipFromId": "string",
"orderStatus": 0,
"orderSubStatusId": "string",
"subStatusId": "string",
"subStatusName": "string",
"systemStatus": "string",
"isDeleted": true,
"currencyId": "string",
"weightUnitId": "string",
"customerOrderNo": "string",
"customerPurchaseOrderNo": "string",
"comment": "string",
"tags": ["string"
],
"deniedTags": ["string"
],
"deliveryPlaceId": "string",
"deliveryPlaceName": "string",
"deliveryPlaceAddress1": "string",
"deliveryPlaceAddress2": "string",
"deliveryPlaceAddress3": "string",
"deliveryPlaceAddress4": "string",
"deliveryPlacePostCode": "string",
"deliveryPlacePostalPlace": "string",
"deliveryPlaceState": "string",
"deliveryPlaceCountry": "string",
"deliveryTerms": "string",
"routeNumber": "string",
"deliveryRemarks": "string",
"paymentTermsId": "string",
"paymentTermsCode": "string",
"paymentTermsName": "string",
"orderLines": [{"orderLineId": "string",
"orderLineNo": 0,
"itemCode": "string",
"itemId": "string",
"gtin": "string",
"externalItemCode": "string",
"externalItemDescription": "string",
"bookedBoxes": 0,
"bookedWeight": 0,
"allocatedBoxes": 0,
"allocatedWeight": 0,
"allocateFromLot": "string",
"unitsPerPallet": 0,
"piecesPerUnit": 0,
"notes": "string",
"price": 0,
"priceUnit": 0,
"isDeleted": true
}
],
"dimensions": [{"dimensionId": "string",
"dimensionName": "string",
"sortOrder": 0,
"dimensionDetailId": "string",
"dimensionDetailName": "string"
}
],
"boxes": [{"itemId": "string",
"itemCode": "string",
"itemName": "string",
"palletNo": "string",
"palletSscc": "string",
"boxNo": "string",
"boxSscc": "string",
"useBy": "2019-08-24",
"netWeight": 0,
"duplicateUnits": 0,
"lotNo": "string",
"batchNo": "string",
"packingLabel": "string"
}
],
"lastModifiedAt": "2019-08-24T14:15:22Z",
"property1": null,
"property2": null
}
]

Create sales order

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

salesOrderNo	integer or null <int32>
salesOrderId	string or null <guid>
customerNo	integer or null <int32>
customerId	string or null <guid>
responsiblePersonId	string or null <guid>
vendorSalesOrderNo	string or null
customerReference	string or null
orderInfo	string or null
awbNo	string or null
flightRegNo	string or null
transportRegNo	string or null
transporterNo	integer or null <int32>
transporterId	string or null <guid>
packingPlantId	string or null <guid>
shipmentDate	string or null <date>
packingPlantShipmentDate	string or null <date>
eta	string or null <date-time>
shipFromId	string or null <guid>
orderStatus	integer or null <int32>
orderSubStatusId	string or null <guid> Deprecated, use SubStatusId
subStatusId	string or null <guid>
subStatusName	string or null Alternative to SubStatusId - the substatus display name (case-insensitive). Ignored if SubStatusId or OrderSubStatusId is also given.
systemStatus	string or null
isDeleted	boolean or null
currencyId	string or null
weightUnitId	string or null
customerOrderNo	string or null
customerPurchaseOrderNo	string or null
comment	string or null
tags	Array of strings or null
deniedTags	Array of strings or null
deliveryPlaceId	string or null <guid>
deliveryPlaceName	string or null
deliveryPlaceAddress1	string or null
deliveryPlaceAddress2	string or null
deliveryPlaceAddress3	string or null
deliveryPlaceAddress4	string or null
deliveryPlacePostCode	string or null
deliveryPlacePostalPlace	string or null
deliveryPlaceState	string or null
deliveryPlaceCountry	string or null
deliveryTerms	string or null Delivery terms code, e.g. DAP, DDP, FCA etc.
routeNumber	string or null
deliveryRemarks	string or null
paymentTermsId	string or null <guid>
paymentTermsCode	string or null
paymentTermsName	string or null
	Array of objects or null (SalesOrderLine)
	Array of objects or null (OrderDimension)
	Array of objects or null (SalesOrderBox)
lastModifiedAt required	string <date-time>
gln	string or null
organizationNo	string or null
deliveryGLN	string or null
property name* additional property	any or null

Responses

Request samples

Payload

Content type

application/json

{"salesOrderNo": 0,
"salesOrderId": "string",
"customerNo": 0,
"customerId": "string",
"responsiblePersonId": "string",
"vendorSalesOrderNo": "string",
"customerReference": "string",
"orderInfo": "string",
"awbNo": "string",
"flightRegNo": "string",
"transportRegNo": "string",
"transporterNo": 0,
"transporterId": "string",
"packingPlantId": "string",
"shipmentDate": "2019-08-24",
"packingPlantShipmentDate": "2019-08-24",
"eta": "2019-08-24T14:15:22Z",
"shipFromId": "string",
"orderStatus": 0,
"orderSubStatusId": "string",
"subStatusId": "string",
"subStatusName": "string",
"systemStatus": "string",
"isDeleted": true,
"currencyId": "string",
"weightUnitId": "string",
"customerOrderNo": "string",
"customerPurchaseOrderNo": "string",
"comment": "string",
"tags": ["string"
],
"deniedTags": ["string"
],
"deliveryPlaceId": "string",
"deliveryPlaceName": "string",
"deliveryPlaceAddress1": "string",
"deliveryPlaceAddress2": "string",
"deliveryPlaceAddress3": "string",
"deliveryPlaceAddress4": "string",
"deliveryPlacePostCode": "string",
"deliveryPlacePostalPlace": "string",
"deliveryPlaceState": "string",
"deliveryPlaceCountry": "string",
"deliveryTerms": "string",
"routeNumber": "string",
"deliveryRemarks": "string",
"paymentTermsId": "string",
"paymentTermsCode": "string",
"paymentTermsName": "string",
"orderLines": [{"orderLineId": "string",
"orderLineNo": 0,
"itemCode": "string",
"itemId": "string",
"gtin": "string",
"externalItemCode": "string",
"externalItemDescription": "string",
"bookedBoxes": 0,
"bookedWeight": 0,
"allocatedBoxes": 0,
"allocatedWeight": 0,
"allocateFromLot": "string",
"unitsPerPallet": 0,
"piecesPerUnit": 0,
"notes": "string",
"price": 0,
"priceUnit": 0,
"isDeleted": true
}
],
"dimensions": [{"dimensionId": "string",
"dimensionName": "string",
"sortOrder": 0,
"dimensionDetailId": "string",
"dimensionDetailName": "string"
}
],
"boxes": [{"itemId": "string",
"itemCode": "string",
"itemName": "string",
"palletNo": "string",
"palletSscc": "string",
"boxNo": "string",
"boxSscc": "string",
"useBy": "2019-08-24",
"netWeight": 0,
"duplicateUnits": 0,
"lotNo": "string",
"batchNo": "string",
"packingLabel": "string"
}
],
"lastModifiedAt": "2019-08-24T14:15:22Z",
"property1": null,
"property2": null,
"gln": "string",
"organizationNo": "string",
"deliveryGLN": "string"
}

Response samples

200
204
default

Content type

application/json

{"salesOrderNo": 0,
"salesOrderId": "string",
"customerNo": 0,
"customerId": "string",
"responsiblePersonId": "string",
"vendorSalesOrderNo": "string",
"customerReference": "string",
"orderInfo": "string",
"awbNo": "string",
"flightRegNo": "string",
"transportRegNo": "string",
"transporterNo": 0,
"transporterId": "string",
"packingPlantId": "string",
"shipmentDate": "2019-08-24",
"packingPlantShipmentDate": "2019-08-24",
"eta": "2019-08-24T14:15:22Z",
"shipFromId": "string",
"orderStatus": 0,
"orderSubStatusId": "string",
"subStatusId": "string",
"subStatusName": "string",
"systemStatus": "string",
"isDeleted": true,
"currencyId": "string",
"weightUnitId": "string",
"customerOrderNo": "string",
"customerPurchaseOrderNo": "string",
"comment": "string",
"tags": ["string"
],
"deniedTags": ["string"
],
"deliveryPlaceId": "string",
"deliveryPlaceName": "string",
"deliveryPlaceAddress1": "string",
"deliveryPlaceAddress2": "string",
"deliveryPlaceAddress3": "string",
"deliveryPlaceAddress4": "string",
"deliveryPlacePostCode": "string",
"deliveryPlacePostalPlace": "string",
"deliveryPlaceState": "string",
"deliveryPlaceCountry": "string",
"deliveryTerms": "string",
"routeNumber": "string",
"deliveryRemarks": "string",
"paymentTermsId": "string",
"paymentTermsCode": "string",
"paymentTermsName": "string",
"orderLines": [{"orderLineId": "string",
"orderLineNo": 0,
"itemCode": "string",
"itemId": "string",
"gtin": "string",
"externalItemCode": "string",
"externalItemDescription": "string",
"bookedBoxes": 0,
"bookedWeight": 0,
"allocatedBoxes": 0,
"allocatedWeight": 0,
"allocateFromLot": "string",
"unitsPerPallet": 0,
"piecesPerUnit": 0,
"notes": "string",
"price": 0,
"priceUnit": 0,
"isDeleted": true
}
],
"dimensions": [{"dimensionId": "string",
"dimensionName": "string",
"sortOrder": 0,
"dimensionDetailId": "string",
"dimensionDetailName": "string"
}
],
"boxes": [{"itemId": "string",
"itemCode": "string",
"itemName": "string",
"palletNo": "string",
"palletSscc": "string",
"boxNo": "string",
"boxSscc": "string",
"useBy": "2019-08-24",
"netWeight": 0,
"duplicateUnits": 0,
"lotNo": "string",
"batchNo": "string",
"packingLabel": "string"
}
],
"lastModifiedAt": "2019-08-24T14:15:22Z",
"property1": null,
"property2": null
}

Update sales order - NOT IMPLEMENTED

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

salesOrderNo	integer or null <int32>
salesOrderId	string or null <guid>
customerNo	integer or null <int32>
customerId	string or null <guid>
responsiblePersonId	string or null <guid>
vendorSalesOrderNo	string or null
customerReference	string or null
orderInfo	string or null
awbNo	string or null
flightRegNo	string or null
transportRegNo	string or null
transporterNo	integer or null <int32>
transporterId	string or null <guid>
packingPlantId	string or null <guid>
shipmentDate	string or null <date>
packingPlantShipmentDate	string or null <date>
eta	string or null <date-time>
shipFromId	string or null <guid>
orderStatus	integer or null <int32>
orderSubStatusId	string or null <guid> Deprecated, use SubStatusId
subStatusId	string or null <guid>
subStatusName	string or null Alternative to SubStatusId - the substatus display name (case-insensitive). Ignored if SubStatusId or OrderSubStatusId is also given.
systemStatus	string or null
isDeleted	boolean or null
currencyId	string or null
weightUnitId	string or null
customerOrderNo	string or null
customerPurchaseOrderNo	string or null
comment	string or null
tags	Array of strings or null
deniedTags	Array of strings or null
deliveryPlaceId	string or null <guid>
deliveryPlaceName	string or null
deliveryPlaceAddress1	string or null
deliveryPlaceAddress2	string or null
deliveryPlaceAddress3	string or null
deliveryPlaceAddress4	string or null
deliveryPlacePostCode	string or null
deliveryPlacePostalPlace	string or null
deliveryPlaceState	string or null
deliveryPlaceCountry	string or null
deliveryTerms	string or null Delivery terms code, e.g. DAP, DDP, FCA etc.
routeNumber	string or null
deliveryRemarks	string or null
paymentTermsId	string or null <guid>
paymentTermsCode	string or null
paymentTermsName	string or null
	Array of objects or null (SalesOrderLine)
	Array of objects or null (OrderDimension)
	Array of objects or null (SalesOrderBox)
lastModifiedAt required	string <date-time>
property name* additional property	any or null

Responses

Request samples

Payload

Content type

application/json

{"salesOrderNo": 0,
"salesOrderId": "string",
"customerNo": 0,
"customerId": "string",
"responsiblePersonId": "string",
"vendorSalesOrderNo": "string",
"customerReference": "string",
"orderInfo": "string",
"awbNo": "string",
"flightRegNo": "string",
"transportRegNo": "string",
"transporterNo": 0,
"transporterId": "string",
"packingPlantId": "string",
"shipmentDate": "2019-08-24",
"packingPlantShipmentDate": "2019-08-24",
"eta": "2019-08-24T14:15:22Z",
"shipFromId": "string",
"orderStatus": 0,
"orderSubStatusId": "string",
"subStatusId": "string",
"subStatusName": "string",
"systemStatus": "string",
"isDeleted": true,
"currencyId": "string",
"weightUnitId": "string",
"customerOrderNo": "string",
"customerPurchaseOrderNo": "string",
"comment": "string",
"tags": ["string"
],
"deniedTags": ["string"
],
"deliveryPlaceId": "string",
"deliveryPlaceName": "string",
"deliveryPlaceAddress1": "string",
"deliveryPlaceAddress2": "string",
"deliveryPlaceAddress3": "string",
"deliveryPlaceAddress4": "string",
"deliveryPlacePostCode": "string",
"deliveryPlacePostalPlace": "string",
"deliveryPlaceState": "string",
"deliveryPlaceCountry": "string",
"deliveryTerms": "string",
"routeNumber": "string",
"deliveryRemarks": "string",
"paymentTermsId": "string",
"paymentTermsCode": "string",
"paymentTermsName": "string",
"orderLines": [{"orderLineId": "string",
"orderLineNo": 0,
"itemCode": "string",
"itemId": "string",
"gtin": "string",
"externalItemCode": "string",
"externalItemDescription": "string",
"bookedBoxes": 0,
"bookedWeight": 0,
"allocatedBoxes": 0,
"allocatedWeight": 0,
"allocateFromLot": "string",
"unitsPerPallet": 0,
"piecesPerUnit": 0,
"notes": "string",
"price": 0,
"priceUnit": 0,
"isDeleted": true
}
],
"dimensions": [{"dimensionId": "string",
"dimensionName": "string",
"sortOrder": 0,
"dimensionDetailId": "string",
"dimensionDetailName": "string"
}
],
"boxes": [{"itemId": "string",
"itemCode": "string",
"itemName": "string",
"palletNo": "string",
"palletSscc": "string",
"boxNo": "string",
"boxSscc": "string",
"useBy": "2019-08-24",
"netWeight": 0,
"duplicateUnits": 0,
"lotNo": "string",
"batchNo": "string",
"packingLabel": "string"
}
],
"lastModifiedAt": "2019-08-24T14:15:22Z",
"property1": null,
"property2": null
}

Response samples

200
204
default

Content type

application/json

{"salesOrderNo": 0,
"salesOrderId": "string",
"customerNo": 0,
"customerId": "string",
"responsiblePersonId": "string",
"vendorSalesOrderNo": "string",
"customerReference": "string",
"orderInfo": "string",
"awbNo": "string",
"flightRegNo": "string",
"transportRegNo": "string",
"transporterNo": 0,
"transporterId": "string",
"packingPlantId": "string",
"shipmentDate": "2019-08-24",
"packingPlantShipmentDate": "2019-08-24",
"eta": "2019-08-24T14:15:22Z",
"shipFromId": "string",
"orderStatus": 0,
"orderSubStatusId": "string",
"subStatusId": "string",
"subStatusName": "string",
"systemStatus": "string",
"isDeleted": true,
"currencyId": "string",
"weightUnitId": "string",
"customerOrderNo": "string",
"customerPurchaseOrderNo": "string",
"comment": "string",
"tags": ["string"
],
"deniedTags": ["string"
],
"deliveryPlaceId": "string",
"deliveryPlaceName": "string",
"deliveryPlaceAddress1": "string",
"deliveryPlaceAddress2": "string",
"deliveryPlaceAddress3": "string",
"deliveryPlaceAddress4": "string",
"deliveryPlacePostCode": "string",
"deliveryPlacePostalPlace": "string",
"deliveryPlaceState": "string",
"deliveryPlaceCountry": "string",
"deliveryTerms": "string",
"routeNumber": "string",
"deliveryRemarks": "string",
"paymentTermsId": "string",
"paymentTermsCode": "string",
"paymentTermsName": "string",
"orderLines": [{"orderLineId": "string",
"orderLineNo": 0,
"itemCode": "string",
"itemId": "string",
"gtin": "string",
"externalItemCode": "string",
"externalItemDescription": "string",
"bookedBoxes": 0,
"bookedWeight": 0,
"allocatedBoxes": 0,
"allocatedWeight": 0,
"allocateFromLot": "string",
"unitsPerPallet": 0,
"piecesPerUnit": 0,
"notes": "string",
"price": 0,
"priceUnit": 0,
"isDeleted": true
}
],
"dimensions": [{"dimensionId": "string",
"dimensionName": "string",
"sortOrder": 0,
"dimensionDetailId": "string",
"dimensionDetailName": "string"
}
],
"boxes": [{"itemId": "string",
"itemCode": "string",
"itemName": "string",
"palletNo": "string",
"palletSscc": "string",
"boxNo": "string",
"boxSscc": "string",
"useBy": "2019-08-24",
"netWeight": 0,
"duplicateUnits": 0,
"lotNo": "string",
"batchNo": "string",
"packingLabel": "string"
}
],
"lastModifiedAt": "2019-08-24T14:15:22Z",
"property1": null,
"property2": null
}

Patch sales order

Payload is sent as dictionary, entries in dictionary matches model from PUT. subStatusName may be supplied instead of subStatusId; it is resolved to a sub-status of the order's current system status.

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

property name*

additional property

any

Responses

Request samples

Payload

Content type

application/json

{"property1": null,
"property2": null
}

Response samples

200
204
default

Content type

application/json

{"salesOrderNo": 0,
"salesOrderId": "string",
"customerNo": 0,
"customerId": "string",
"responsiblePersonId": "string",
"vendorSalesOrderNo": "string",
"customerReference": "string",
"orderInfo": "string",
"awbNo": "string",
"flightRegNo": "string",
"transportRegNo": "string",
"transporterNo": 0,
"transporterId": "string",
"packingPlantId": "string",
"shipmentDate": "2019-08-24",
"packingPlantShipmentDate": "2019-08-24",
"eta": "2019-08-24T14:15:22Z",
"shipFromId": "string",
"orderStatus": 0,
"orderSubStatusId": "string",
"subStatusId": "string",
"subStatusName": "string",
"systemStatus": "string",
"isDeleted": true,
"currencyId": "string",
"weightUnitId": "string",
"customerOrderNo": "string",
"customerPurchaseOrderNo": "string",
"comment": "string",
"tags": ["string"
],
"deniedTags": ["string"
],
"deliveryPlaceId": "string",
"deliveryPlaceName": "string",
"deliveryPlaceAddress1": "string",
"deliveryPlaceAddress2": "string",
"deliveryPlaceAddress3": "string",
"deliveryPlaceAddress4": "string",
"deliveryPlacePostCode": "string",
"deliveryPlacePostalPlace": "string",
"deliveryPlaceState": "string",
"deliveryPlaceCountry": "string",
"deliveryTerms": "string",
"routeNumber": "string",
"deliveryRemarks": "string",
"paymentTermsId": "string",
"paymentTermsCode": "string",
"paymentTermsName": "string",
"orderLines": [{"orderLineId": "string",
"orderLineNo": 0,
"itemCode": "string",
"itemId": "string",
"gtin": "string",
"externalItemCode": "string",
"externalItemDescription": "string",
"bookedBoxes": 0,
"bookedWeight": 0,
"allocatedBoxes": 0,
"allocatedWeight": 0,
"allocateFromLot": "string",
"unitsPerPallet": 0,
"piecesPerUnit": 0,
"notes": "string",
"price": 0,
"priceUnit": 0,
"isDeleted": true
}
],
"dimensions": [{"dimensionId": "string",
"dimensionName": "string",
"sortOrder": 0,
"dimensionDetailId": "string",
"dimensionDetailName": "string"
}
],
"boxes": [{"itemId": "string",
"itemCode": "string",
"itemName": "string",
"palletNo": "string",
"palletSscc": "string",
"boxNo": "string",
"boxSscc": "string",
"useBy": "2019-08-24",
"netWeight": 0,
"duplicateUnits": 0,
"lotNo": "string",
"batchNo": "string",
"packingLabel": "string"
}
],
"lastModifiedAt": "2019-08-24T14:15:22Z",
"property1": null,
"property2": null
}

Get sales order

Get one specific sales order. SalesOrder parameter can be sales order number or sales order id.

path Parameters

salesOrder

required

string

query Parameters

accountId required	string <guid>
domainId required	string <guid>
customerOrderNo	string or null
boxLevel	boolean or null
allocated	boolean or null
userId	string <guid>
traceId	string <guid>

Responses

Response samples

200
204
default

Content type

application/json

{"salesOrderNo": 0,
"salesOrderId": "string",
"customerNo": 0,
"customerId": "string",
"responsiblePersonId": "string",
"vendorSalesOrderNo": "string",
"customerReference": "string",
"orderInfo": "string",
"awbNo": "string",
"flightRegNo": "string",
"transportRegNo": "string",
"transporterNo": 0,
"transporterId": "string",
"packingPlantId": "string",
"shipmentDate": "2019-08-24",
"packingPlantShipmentDate": "2019-08-24",
"eta": "2019-08-24T14:15:22Z",
"shipFromId": "string",
"orderStatus": 0,
"orderSubStatusId": "string",
"subStatusId": "string",
"subStatusName": "string",
"systemStatus": "string",
"isDeleted": true,
"currencyId": "string",
"weightUnitId": "string",
"customerOrderNo": "string",
"customerPurchaseOrderNo": "string",
"comment": "string",
"tags": ["string"
],
"deniedTags": ["string"
],
"deliveryPlaceId": "string",
"deliveryPlaceName": "string",
"deliveryPlaceAddress1": "string",
"deliveryPlaceAddress2": "string",
"deliveryPlaceAddress3": "string",
"deliveryPlaceAddress4": "string",
"deliveryPlacePostCode": "string",
"deliveryPlacePostalPlace": "string",
"deliveryPlaceState": "string",
"deliveryPlaceCountry": "string",
"deliveryTerms": "string",
"routeNumber": "string",
"deliveryRemarks": "string",
"paymentTermsId": "string",
"paymentTermsCode": "string",
"paymentTermsName": "string",
"orderLines": [{"orderLineId": "string",
"orderLineNo": 0,
"itemCode": "string",
"itemId": "string",
"gtin": "string",
"externalItemCode": "string",
"externalItemDescription": "string",
"bookedBoxes": 0,
"bookedWeight": 0,
"allocatedBoxes": 0,
"allocatedWeight": 0,
"allocateFromLot": "string",
"unitsPerPallet": 0,
"piecesPerUnit": 0,
"notes": "string",
"price": 0,
"priceUnit": 0,
"isDeleted": true
}
],
"dimensions": [{"dimensionId": "string",
"dimensionName": "string",
"sortOrder": 0,
"dimensionDetailId": "string",
"dimensionDetailName": "string"
}
],
"boxes": [{"itemId": "string",
"itemCode": "string",
"itemName": "string",
"palletNo": "string",
"palletSscc": "string",
"boxNo": "string",
"boxSscc": "string",
"useBy": "2019-08-24",
"netWeight": 0,
"duplicateUnits": 0,
"lotNo": "string",
"batchNo": "string",
"packingLabel": "string"
}
],
"lastModifiedAt": "2019-08-24T14:15:22Z",
"property1": null,
"property2": null
}

Confirm sales order

query Parameters

accountId required	string <guid>
domainId required	string <guid>
salesOrder	string or null
customerOrderNo	string or null
processAsync	boolean or null
ignoreIfConfirmed	boolean or null
checkBooking	boolean or null
userId	string <guid>
traceId	string <guid>

Responses

Response samples

200
204
default

Content type

application/json

{"salesOrderNo": 0,
"salesOrderId": "string",
"customerNo": 0,
"customerId": "string",
"responsiblePersonId": "string",
"vendorSalesOrderNo": "string",
"customerReference": "string",
"orderInfo": "string",
"awbNo": "string",
"flightRegNo": "string",
"transportRegNo": "string",
"transporterNo": 0,
"transporterId": "string",
"packingPlantId": "string",
"shipmentDate": "2019-08-24",
"packingPlantShipmentDate": "2019-08-24",
"eta": "2019-08-24T14:15:22Z",
"shipFromId": "string",
"orderStatus": 0,
"orderSubStatusId": "string",
"subStatusId": "string",
"subStatusName": "string",
"systemStatus": "string",
"isDeleted": true,
"currencyId": "string",
"weightUnitId": "string",
"customerOrderNo": "string",
"customerPurchaseOrderNo": "string",
"comment": "string",
"tags": ["string"
],
"deniedTags": ["string"
],
"deliveryPlaceId": "string",
"deliveryPlaceName": "string",
"deliveryPlaceAddress1": "string",
"deliveryPlaceAddress2": "string",
"deliveryPlaceAddress3": "string",
"deliveryPlaceAddress4": "string",
"deliveryPlacePostCode": "string",
"deliveryPlacePostalPlace": "string",
"deliveryPlaceState": "string",
"deliveryPlaceCountry": "string",
"deliveryTerms": "string",
"routeNumber": "string",
"deliveryRemarks": "string",
"paymentTermsId": "string",
"paymentTermsCode": "string",
"paymentTermsName": "string",
"orderLines": [{"orderLineId": "string",
"orderLineNo": 0,
"itemCode": "string",
"itemId": "string",
"gtin": "string",
"externalItemCode": "string",
"externalItemDescription": "string",
"bookedBoxes": 0,
"bookedWeight": 0,
"allocatedBoxes": 0,
"allocatedWeight": 0,
"allocateFromLot": "string",
"unitsPerPallet": 0,
"piecesPerUnit": 0,
"notes": "string",
"price": 0,
"priceUnit": 0,
"isDeleted": true
}
],
"dimensions": [{"dimensionId": "string",
"dimensionName": "string",
"sortOrder": 0,
"dimensionDetailId": "string",
"dimensionDetailName": "string"
}
],
"boxes": [{"itemId": "string",
"itemCode": "string",
"itemName": "string",
"palletNo": "string",
"palletSscc": "string",
"boxNo": "string",
"boxSscc": "string",
"useBy": "2019-08-24",
"netWeight": 0,
"duplicateUnits": 0,
"lotNo": "string",
"batchNo": "string",
"packingLabel": "string"
}
],
"lastModifiedAt": "2019-08-24T14:15:22Z",
"property1": null,
"property2": null
}

Get sub-statuses

query Parameters

accountId required	string <guid>
domainId required	string <guid>
systemStatus	string or null
userId	string <guid>
traceId	string <guid>

Responses

Response samples

200
204
default

Content type

application/json

[{"subStatusId": "string",
"systemStatus": "string",
"name": "string",
"description": "string"
}
]

SalesOrderLine

Read sales order lines

query Parameters

accountId required	string <guid>
domainId required	string <guid>
salesOrder	string or null
salesOrderLineId	string or null <guid>
salesOrderLineNo	integer or null <int32>
includeDeletedLines	boolean or null
userId	string <guid>
traceId	string <guid>

Responses

Response samples

200
default

Content type

application/json

[{"orderLineId": "string",
"orderLineNo": 0,
"itemCode": "string",
"itemId": "string",
"gtin": "string",
"externalItemCode": "string",
"externalItemDescription": "string",
"bookedBoxes": 0,
"bookedWeight": 0,
"allocatedBoxes": 0,
"allocatedWeight": 0,
"allocateFromLot": "string",
"unitsPerPallet": 0,
"piecesPerUnit": 0,
"notes": "string",
"price": 0,
"priceUnit": 0,
"isDeleted": true
}
]

Create sales order line

query Parameters

accountId required	string <guid>
domainId required	string <guid>
salesOrder required	string or null
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

orderLineId	string or null <guid>
orderLineNo	integer or null <int32>
itemCode	string or null
itemId	string or null <guid>
gtin	string or null
externalItemCode	string or null
externalItemDescription	string or null
bookedBoxes	integer or null <int32>
bookedWeight	number or null <decimal>
allocatedBoxes	integer or null <int32>
allocatedWeight	number or null <decimal>
allocateFromLot	string or null
unitsPerPallet	integer or null <int32>
piecesPerUnit	integer or null <int32>
notes	string or null
price	number or null <decimal>
priceUnit	integer or null <int32> 0=weight, 1=consumer pack, 2=box ??
isDeleted required	boolean

Responses

Request samples

Payload

Content type

application/json

{"orderLineId": "string",
"orderLineNo": 0,
"itemCode": "string",
"itemId": "string",
"gtin": "string",
"externalItemCode": "string",
"externalItemDescription": "string",
"bookedBoxes": 0,
"bookedWeight": 0,
"allocatedBoxes": 0,
"allocatedWeight": 0,
"allocateFromLot": "string",
"unitsPerPallet": 0,
"piecesPerUnit": 0,
"notes": "string",
"price": 0,
"priceUnit": 0,
"isDeleted": true
}

Response samples

200
204
default

Content type

application/json

{"orderLineId": "string",
"orderLineNo": 0,
"itemCode": "string",
"itemId": "string",
"gtin": "string",
"externalItemCode": "string",
"externalItemDescription": "string",
"bookedBoxes": 0,
"bookedWeight": 0,
"allocatedBoxes": 0,
"allocatedWeight": 0,
"allocateFromLot": "string",
"unitsPerPallet": 0,
"piecesPerUnit": 0,
"notes": "string",
"price": 0,
"priceUnit": 0,
"isDeleted": true
}

Update sales order line

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

orderLineId	string or null <guid>
orderLineNo	integer or null <int32>
itemCode	string or null
itemId	string or null <guid>
gtin	string or null
externalItemCode	string or null
externalItemDescription	string or null
bookedBoxes	integer or null <int32>
bookedWeight	number or null <decimal>
allocatedBoxes	integer or null <int32>
allocatedWeight	number or null <decimal>
allocateFromLot	string or null
unitsPerPallet	integer or null <int32>
piecesPerUnit	integer or null <int32>
notes	string or null
price	number or null <decimal>
priceUnit	integer or null <int32> 0=weight, 1=consumer pack, 2=box ??
isDeleted required	boolean

Responses

Request samples

Payload

Content type

application/json

{"orderLineId": "string",
"orderLineNo": 0,
"itemCode": "string",
"itemId": "string",
"gtin": "string",
"externalItemCode": "string",
"externalItemDescription": "string",
"bookedBoxes": 0,
"bookedWeight": 0,
"allocatedBoxes": 0,
"allocatedWeight": 0,
"allocateFromLot": "string",
"unitsPerPallet": 0,
"piecesPerUnit": 0,
"notes": "string",
"price": 0,
"priceUnit": 0,
"isDeleted": true
}

Response samples

200
204
default

Content type

application/json

{"orderLineId": "string",
"orderLineNo": 0,
"itemCode": "string",
"itemId": "string",
"gtin": "string",
"externalItemCode": "string",
"externalItemDescription": "string",
"bookedBoxes": 0,
"bookedWeight": 0,
"allocatedBoxes": 0,
"allocatedWeight": 0,
"allocateFromLot": "string",
"unitsPerPallet": 0,
"piecesPerUnit": 0,
"notes": "string",
"price": 0,
"priceUnit": 0,
"isDeleted": true
}

Patch sales order line

Payload is sent as dictionary, entries in dictionary matches model from PUT.

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

property name*

additional property

any

Responses

Request samples

Payload

Content type

application/json

{"property1": null,
"property2": null
}

Response samples

200
204
default

Content type

application/json

{"orderLineId": "string",
"orderLineNo": 0,
"itemCode": "string",
"itemId": "string",
"gtin": "string",
"externalItemCode": "string",
"externalItemDescription": "string",
"bookedBoxes": 0,
"bookedWeight": 0,
"allocatedBoxes": 0,
"allocatedWeight": 0,
"allocateFromLot": "string",
"unitsPerPallet": 0,
"piecesPerUnit": 0,
"notes": "string",
"price": 0,
"priceUnit": 0,
"isDeleted": true
}

Read single sales order line

path Parameters

salesOrderLineId

required

string <guid>

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

200
204
default

Content type

application/json

{"orderLineId": "string",
"orderLineNo": 0,
"itemCode": "string",
"itemId": "string",
"gtin": "string",
"externalItemCode": "string",
"externalItemDescription": "string",
"bookedBoxes": 0,
"bookedWeight": 0,
"allocatedBoxes": 0,
"allocatedWeight": 0,
"allocateFromLot": "string",
"unitsPerPallet": 0,
"piecesPerUnit": 0,
"notes": "string",
"price": 0,
"priceUnit": 0,
"isDeleted": true
}

Delete sales order line

path Parameters

salesOrderLine

required

string

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

200
204
default

Content type

application/json

{"orderLineId": "string",
"orderLineNo": 0,
"itemCode": "string",
"itemId": "string",
"gtin": "string",
"externalItemCode": "string",
"externalItemDescription": "string",
"bookedBoxes": 0,
"bookedWeight": 0,
"allocatedBoxes": 0,
"allocatedWeight": 0,
"allocateFromLot": "string",
"unitsPerPallet": 0,
"piecesPerUnit": 0,
"notes": "string",
"price": 0,
"priceUnit": 0,
"isDeleted": true
}

Settlement

GetIntegrationResults

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

Content type

application/json

[{"settlementHeaderId": "string",
"settlementNo": "string",
"vesselCode": "string",
"startDate": "2019-08-24",
"endDate": "2019-08-24",
"trips": [{"fishingTripHeaderId": "string",
"fishingTripNo": "string",
"fishTicketNo": "string",
"startDate": "2019-08-24",
"endDate": "2019-08-24",
"landingDate": "2019-08-24",
"lines": [{"fishingTripItemLineId": "string",
"lineNo": 0,
"itemCode": "string",
"itemName": "string",
"grossWeight": 0,
"netWeight": 0,
"price": 0,
"amount": 0,
"speciesCode": "string",
"property1": null,
"property2": null
}
],
"warehouseCode": "string",
"property1": null,
"property2": null
}
],
"crewDetails": [{"settlementCrewDetailId": "string",
"quantity": 0,
"unitPrice": 0,
"crewNumber": "string",
"crewName": "string",
"payrollCode": "string",
"description": "string",
"customerCode": "string",
"documentNumber": "string",
"speciesCode": "string",
"fromERP": true,
"positionCode": "string",
"positionDescription": "string",
"landingFeeCode": "string",
"landingFeeDescription": "string",
"property1": null,
"property2": null
}
],
"property1": null,
"property2": null
}
]

UpdateIntegrationStatus

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

Array

settlementHeaderId required	string <guid>
status required	string (IntegrationStatus) Enum: "None" "ReadyToSend" "ReadByIntegration"
property name* additional property	any or null

Responses

Request samples

Payload

Content type

application/json

[{"settlementHeaderId": "string",
"status": "None",
"property1": null,
"property2": null
}
]

Response samples

Content type

application/json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"property1": null,
"property2": null
}

ShippingOrder

GetShippingOrder

path Parameters

order

required

string

query Parameters

accountId required	string <guid>
domainId required	string <guid>
boxLevel	boolean or null
includeItemDimensions	boolean or null
includeTransportationTasks	boolean or null
userId	string <guid>
traceId	string <guid>

Responses

Response samples

Content type

application/json

{"orderNo": "string",
"orderType": "Sales",
"orderId": "string",
"customerNo": "string",
"customerName": "string",
"responsiblePersonName": "string",
"vendorSalesOrderNo": "string",
"customerReference": "string",
"orderInfo": "string",
"awbNo": "string",
"tripNo": "string",
"flightRegNo": "string",
"transportRegNo": "string",
"transporterNo": "string",
"transporterName": "string",
"shipmentDate": "2019-08-24",
"weightUnitId": "string",
"customerOrderNo": "string",
"customerPurchaseOrderNo": "string",
"comment": "string",
"tags": ["string"
],
"deliveryPlace": {"addressId": "string",
"type": "Unspecified",
"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"address4": "string",
"zipCode": "string",
"city": "string",
"state": "string",
"countryCode": "string",
"gln": "string",
"routeNumber": "string"
},
"subStatus": {"subStatusId": "string",
"name": "string",
"description": "string"
},
"externalOrderInformation": "string",
"eta": "2019-08-24T14:15:22Z",
"etd": "2019-08-24T14:15:22Z",
"fromWarehouse": "string",
"systemStatus": "string",
"orderLines": [{"orderLineId": "string",
"orderLineNo": 0,
"itemCode": "string",
"itemName": "string",
"itemId": "string",
"itemDimensions": {"conservation": "string"
},
"gtin": "string",
"externalItemCode": "string",
"bookedWeight": 0,
"bookedBoxes": 0,
"allocatedWeight": 0,
"allocatedBoxes": 0,
"notes": "string"
}
],
"boxes": [{"itemId": "string",
"itemCode": "string",
"itemName": "string",
"palletNo": "string",
"palletSscc": "string",
"boxNo": "string",
"boxSscc": "string",
"useBy": "2019-08-24",
"netWeight": 0,
"duplicateUnits": 0,
"lotNo": "string",
"batchNo": "string",
"packingLabel": "string"
}
],
"dimensions": [{"dimensionId": "string",
"dimensionName": "string",
"sortOrder": 0,
"dimensionDetailId": "string",
"dimensionDetailName": "string"
}
],
"transportationTasks": [{"tripNumber": 0,
"taskNumber": 0,
"orderNumber": 0,
"orderType": "string",
"customerName": "string"
}
]
}

GetShippingOrders

query Parameters

accountId required	string <guid>
domainId required	string <guid>
changedSince	string or null <date-time>
subStatusId	string or null <guid>
skip	integer or null <int32>
take	integer <int32>
boxLevel	boolean or null
includeItemDimensions	boolean or null
includeTransportationTasks	boolean or null
userId	string <guid>
traceId	string <guid>

Responses

Response samples

Content type

application/json

{"items": [{"orderNo": "string",
"orderType": "Sales",
"orderId": "string",
"customerNo": "string",
"customerName": "string",
"responsiblePersonName": "string",
"vendorSalesOrderNo": "string",
"customerReference": "string",
"orderInfo": "string",
"awbNo": "string",
"tripNo": "string",
"flightRegNo": "string",
"transportRegNo": "string",
"transporterNo": "string",
"transporterName": "string",
"shipmentDate": "2019-08-24",
"weightUnitId": "string",
"customerOrderNo": "string",
"customerPurchaseOrderNo": "string",
"comment": "string",
"tags": ["string"
],
"deliveryPlace": {"addressId": "string",
"type": "Unspecified",
"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"address4": "string",
"zipCode": "string",
"city": "string",
"state": "string",
"countryCode": "string",
"gln": "string",
"routeNumber": "string"
},
"subStatus": {"subStatusId": "string",
"name": "string",
"description": "string"
},
"externalOrderInformation": "string",
"eta": "2019-08-24T14:15:22Z",
"etd": "2019-08-24T14:15:22Z",
"fromWarehouse": "string",
"systemStatus": "string",
"orderLines": [{"orderLineId": "string",
"orderLineNo": 0,
"itemCode": "string",
"itemName": "string",
"itemId": "string",
"itemDimensions": {"conservation": "string"
},
"gtin": "string",
"externalItemCode": "string",
"bookedWeight": 0,
"bookedBoxes": 0,
"allocatedWeight": 0,
"allocatedBoxes": 0,
"notes": "string"
}
],
"boxes": [{"itemId": "string",
"itemCode": "string",
"itemName": "string",
"palletNo": "string",
"palletSscc": "string",
"boxNo": "string",
"boxSscc": "string",
"useBy": "2019-08-24",
"netWeight": 0,
"duplicateUnits": 0,
"lotNo": "string",
"batchNo": "string",
"packingLabel": "string"
}
],
"dimensions": [{"dimensionId": "string",
"dimensionName": "string",
"sortOrder": 0,
"dimensionDetailId": "string",
"dimensionDetailName": "string"
}
],
"transportationTasks": [{"tripNumber": 0,
"taskNumber": 0,
"orderNumber": 0,
"orderType": "string",
"customerName": "string"
}
]
}
],
"skip": 0,
"totalResults": 0
}

GetShippingOrderDocuments

query Parameters

accountId required	string <guid>
domainId required	string <guid>
changedSince	string or null <date-time>
subStatusId	string or null <guid>
skip	integer or null <int32>
take	integer <int32>
boxLevel	boolean or null
userId	string <guid>
traceId	string <guid>

Responses

Response samples

Content type

application/json

{"items": [{"orderId": "string",
"orderType": "Sales",
"orderNo": "string",
"documentType": "string",
"documentTypeId": "string",
"documentId": "string",
"name": "string",
"uri": "string"
}
],
"skip": 0,
"totalResults": 0
}

Statistics

GetStatistics

query Parameters

accountId required	string <guid>
domainId required	string <guid>
applicationId	string or null <guid>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

Content type

application/json

[{"method": "string",
"path": "string",
"totalCount": 0,
"successCount": 0,
"rateLimitedCount": 0
}
]

GetTags

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

200
default

Content type

application/json

[{"tagId": "string",
"code": "string",
"description": "string",
"tagType": "string",
"certificateType": "string",
"active": true
}
]

TMSConfirm

ConfirmFindTaskByConsignmentId

path Parameters

consignmentId

required

string

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

400
default

Content type

application/json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"applicationId": ["string"
],
"errors": {"property1": ["string"
],
"property2": ["string"
]
},
"property1": null,
"property2": null
}

ConfirmRejectTask Deprecated

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

string

Responses

Request samples

Payload

Content type

application/json

"string"

Response samples

400
default

Content type

application/json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"applicationId": ["string"
],
"errors": {"property1": ["string"
],
"property2": ["string"
]
},
"property1": null,
"property2": null
}

ConfirmRejectTask2

path Parameters

taskId

required

string <guid>

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

400
default

Content type

application/json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"applicationId": ["string"
],
"errors": {"property1": ["string"
],
"property2": ["string"
]
},
"property1": null,
"property2": null
}

ConfirmAcceptTask

path Parameters

taskId

required

string <guid>

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

400
default

Content type

application/json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"applicationId": ["string"
],
"errors": {"property1": ["string"
],
"property2": ["string"
]
},
"property1": null,
"property2": null
}

ConfirmReportOrderTaskCollected

path Parameters

taskId

required

string <guid>

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

400
default

Content type

application/json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"applicationId": ["string"
],
"errors": {"property1": ["string"
],
"property2": ["string"
]
},
"property1": null,
"property2": null
}

ConfirmReportOrderCollected Deprecated

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

name	string or null
interchangeId	string or null
	Array of objects or null (XYPoint) [ items ]
latitude required	number <double>
longitude required	number <double>
date	string or null
transporterCode	string or null
freeText	string or null
publicPictures	Array of strings or null
waitingTime required	number <double>
customerIsPresent	boolean or null
	(ExecutedBy (object or null))
arrivalTime	string or null

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"interchangeId": "string",
"signatureLines": [[{"x": 0,
"y": 0
}
]
],
"latitude": 0.1,
"longitude": 0.1,
"date": "string",
"transporterCode": "string",
"freeText": "string",
"publicPictures": ["string"
],
"waitingTime": 0.1,
"customerIsPresent": true,
"executedBy": {"phoneNumber": "string"
},
"arrivalTime": "string"
}

Response samples

400
default

Content type

application/json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"applicationId": ["string"
],
"errors": {"property1": ["string"
],
"property2": ["string"
]
},
"property1": null,
"property2": null
}

ConfirmReportOrderDelivered Deprecated

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

name	string or null
interchangeId	string or null
	Array of objects or null (XYPoint) [ items ]
latitude required	number <double>
longitude required	number <double>
date	string or null
transporterCode	string or null
freeText	string or null
publicPictures	Array of strings or null
waitingTime required	number <double>
customerIsPresent	boolean or null
	(ExecutedBy (object or null))
arrivalTime	string or null

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"interchangeId": "string",
"signatureLines": [[{"x": 0,
"y": 0
}
]
],
"latitude": 0.1,
"longitude": 0.1,
"date": "string",
"transporterCode": "string",
"freeText": "string",
"publicPictures": ["string"
],
"waitingTime": 0.1,
"customerIsPresent": true,
"executedBy": {"phoneNumber": "string"
},
"arrivalTime": "string"
}

Response samples

400
default

Content type

application/json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"applicationId": ["string"
],
"errors": {"property1": ["string"
],
"property2": ["string"
]
},
"property1": null,
"property2": null
}

ConfirmReportOrderTaskDelivered

path Parameters

taskId

required

string <guid>

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

400
default

Content type

application/json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"applicationId": ["string"
],
"errors": {"property1": ["string"
],
"property2": ["string"
]
},
"property1": null,
"property2": null
}

ConfirmUploadImage Deprecated

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

string

Responses

Request samples

Payload

Content type

application/json

"string"

Response samples

400
default

Content type

application/json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"applicationId": ["string"
],
"errors": {"property1": ["string"
],
"property2": ["string"
]
},
"property1": null,
"property2": null
}

ConfirmUploadImage2

path Parameters

taskId

required

string <guid>

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

400
default

Content type

application/json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"applicationId": ["string"
],
"errors": {"property1": ["string"
],
"property2": ["string"
]
},
"property1": null,
"property2": null
}

ConfirmReportOrderOrTripReceived Deprecated

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

string

Responses

Request samples

Payload

Content type

application/json

"string"

Response samples

400
default

Content type

application/json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"applicationId": ["string"
],
"errors": {"property1": ["string"
],
"property2": ["string"
]
},
"property1": null,
"property2": null
}

ConfirmReportOrderOrTripReceived2

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

400
default

Content type

application/json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"applicationId": ["string"
],
"errors": {"property1": ["string"
],
"property2": ["string"
]
},
"property1": null,
"property2": null
}

ConfirmReportTripStarted Deprecated

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

string

Responses

Request samples

Payload

Content type

application/json

"string"

Response samples

400
default

Content type

application/json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"applicationId": ["string"
],
"errors": {"property1": ["string"
],
"property2": ["string"
]
},
"property1": null,
"property2": null
}

ConfirmReportTripStarted2

path Parameters

legId

required

string <guid>

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

400
default

Content type

application/json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"applicationId": ["string"
],
"errors": {"property1": ["string"
],
"property2": ["string"
]
},
"property1": null,
"property2": null
}

ConfirmReportTripEnded Deprecated

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

string

Responses

Request samples

Payload

Content type

application/json

"string"

Response samples

400
default

Content type

application/json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"applicationId": ["string"
],
"errors": {"property1": ["string"
],
"property2": ["string"
]
},
"property1": null,
"property2": null
}

ConfirmReportTripEnded2

path Parameters

legId

required

string <guid>

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

400
default

Content type

application/json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"applicationId": ["string"
],
"errors": {"property1": ["string"
],
"property2": ["string"
]
},
"property1": null,
"property2": null
}

ConfirmSearchAddressRegistry

query Parameters

accountId required	string <guid>
domainId required	string <guid>
query	string or null
userId	string <guid>
traceId	string <guid>

Responses

Response samples

400
default

Content type

application/json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"applicationId": ["string"
],
"errors": {"property1": ["string"
],
"property2": ["string"
]
},
"property1": null,
"property2": null
}

ConfirmAssignTasksToTrip Deprecated

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

string

Responses

Request samples

Payload

Content type

application/json

"string"

Response samples

400
default

Content type

application/json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"applicationId": ["string"
],
"errors": {"property1": ["string"
],
"property2": ["string"
]
},
"property1": null,
"property2": null
}

ConfirmAssignTasksToTrip2

path Parameters

tripId

required

string <guid>

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

400
default

Content type

application/json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"applicationId": ["string"
],
"errors": {"property1": ["string"
],
"property2": ["string"
]
},
"property1": null,
"property2": null
}

ConfirmFindOrder

query Parameters

accountId required	string <guid>
domainId required	string <guid>
query	string or null
tripId	string or null
userId	string <guid>
traceId	string <guid>

Responses

Response samples

400
default

Content type

application/json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"applicationId": ["string"
],
"errors": {"property1": ["string"
],
"property2": ["string"
]
},
"property1": null,
"property2": null
}

ConfirmGetClaimCategories

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

400
default

Content type

application/json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"applicationId": ["string"
],
"errors": {"property1": ["string"
],
"property2": ["string"
]
},
"property1": null,
"property2": null
}

ConfirmCreateClaim

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

400
default

Content type

application/json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"applicationId": ["string"
],
"errors": {"property1": ["string"
],
"property2": ["string"
]
},
"property1": null,
"property2": null
}

ConfirmFindCustomer

query Parameters

accountId required	string <guid>
domainId required	string <guid>
query	string or null
userId	string <guid>
traceId	string <guid>

Responses

Response samples

400
default

Content type

application/json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"applicationId": ["string"
],
"errors": {"property1": ["string"
],
"property2": ["string"
]
},
"property1": null,
"property2": null
}

ConfirmGetPackageTypes

query Parameters

accountId required	string <guid>
domainId required	string <guid>
onlyReturnPackageType required	boolean or null
userId	string <guid>
traceId	string <guid>

Responses

Response samples

400
default

Content type

application/json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"applicationId": ["string"
],
"errors": {"property1": ["string"
],
"property2": ["string"
]
},
"property1": null,
"property2": null
}

ConfirmCreateReturnOrder

query Parameters

accountId required	string <guid>
domainId required	string <guid>
isReturn required	boolean or null
userId	string <guid>
traceId	string <guid>

Responses

Response samples

400
default

Content type

application/json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"applicationId": ["string"
],
"errors": {"property1": ["string"
],
"property2": ["string"
]
},
"property1": null,
"property2": null
}

TMSConnect

CancelOrder

path Parameters

orderId

required

string <guid>

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

400
default

Content type

application/json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"applicationId": ["string"
],
"errors": {"property1": ["string"
],
"property2": ["string"
]
},
"property1": null,
"property2": null
}

PostTransportInstruction

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

ediMessage

string or null

Responses

Request samples

Payload

Content type

application/json

{"ediMessage": "string"
}

Response samples

400
default

Content type

application/json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"applicationId": ["string"
],
"errors": {"property1": ["string"
],
"property2": ["string"
]
},
"property1": null,
"property2": null
}

PostChargesAccepted

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

ediMessage

string or null

Responses

Request samples

Payload

Content type

application/json

{"ediMessage": "string"
}

Response samples

400
default

Content type

application/json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"applicationId": ["string"
],
"errors": {"property1": ["string"
],
"property2": ["string"
]
},
"property1": null,
"property2": null
}

PostDocument

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

orderId required	string <guid>
documentId required	string <guid>
documentType	string or null
description	string or null
fileName	string or null
contents	string or null base64
interchangeId	string or null

Responses

Request samples

Payload

Content type

application/json

{"orderId": "string",
"documentId": "string",
"documentType": "string",
"description": "string",
"fileName": "string",
"contents": "string",
"interchangeId": "string"
}

Response samples

400
default

Content type

application/json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"applicationId": ["string"
],
"errors": {"property1": ["string"
],
"property2": ["string"
]
},
"property1": null,
"property2": null
}

DeleteDocument

path Parameters

tmsDocumentId

required

string <guid>

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

400
default

Content type

application/json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"applicationId": ["string"
],
"errors": {"property1": ["string"
],
"property2": ["string"
]
},
"property1": null,
"property2": null
}

GetDocument2

path Parameters

tmsDocumentId

required

string <guid>

DocumentServiceDocumentId

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

Content type

application/json

"string"

TMSInvoice

GetTMSInvoicePdf

path Parameters

invoiceId required	string <guid>
customerId required	string <guid>

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

400
default

Content type

application/json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"applicationId": ["string"
],
"errors": {"property1": ["string"
],
"property2": ["string"
]
},
"property1": null,
"property2": null
}

TMSAddresses

GetAddresses

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>
search	string
type	string
name	string
countryCode	string
city	string
take	integer or null <int32>
skip	integer or null <int32>

Responses

Response samples

Content type

application/json

[{"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"poBox": "string",
"countryCode": "string",
"postCode": "string",
"city": "string",
"subDivision": "string",
"state": "string",
"addressType": "string",
"phoneNumber": "string",
"email": "string",
"contactName": "string",
"customerId": "string",
"vendorId": "string",
"organizationId": "string",
"position": {"latitude": -90,
"longitude": -180
},
"automaticallyPickUpViaLinkedTerminalAddress": true,
"automaticallyDeliverViaLinkedTerminalAddress": true,
"linkedAddressIds": ["string"
],
"accessInformation": "string",
"addressId": "string"
}
]

CreateAddress

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

name required	string [ 1 .. 200 ] characters
address1	string or null [ 0 .. 200 ] characters
address2	string or null [ 0 .. 200 ] characters
address3	string or null [ 0 .. 200 ] characters
poBox	string or null [ 0 .. 50 ] characters Post office box number or reference.
countryCode	string or null [ 0 .. 10 ] characters
postCode	string or null [ 0 .. 20 ] characters
city	string or null [ 0 .. 100 ] characters
subDivision	string or null [ 0 .. 128 ] characters Sub division (district/region below State/Province level).
state	string or null [ 0 .. 100 ] characters
addressType required	string string of enum: AddressType KnownValues: [Generic, Terminal, Port, Airport, TrainStation]
phoneNumber	string or null [ 0 .. 50 ] characters
email	string or null [ 0 .. 254 ] characters
contactName	string or null [ 0 .. 200 ] characters
customerId	string or null <guid> Associated Customer.
vendorId	string or null <guid> Associated Vendor.
organizationId	string or null <guid> Associated Organization.
	(PublicCoordinateDto (object or null))
automaticallyPickUpViaLinkedTerminalAddress	boolean or null Orders picking up here get a separate pickup task via the single linked Terminal address. Null: false on create, unchanged on update.
automaticallyDeliverViaLinkedTerminalAddress	boolean or null Orders delivering here get a separate delivery task via the single linked Terminal address. Null: false on create, unchanged on update.
linkedAddressIds	Array of strings or null <guid> [ items <guid > ] Addresses linked to this one; links are two-way. Null: no links on create, unchanged on update. A list replaces the links.
accessInformation	string or null [ 0 .. 300 ] characters Gate/door codes etc. Only returned to, and writable by, callers with the TMS.AddressAccessInformation role; ignored and returned as null otherwise. On update: null keeps the stored value, empty or whitespace clears it.

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"poBox": "string",
"countryCode": "string",
"postCode": "string",
"city": "string",
"subDivision": "string",
"state": "string",
"addressType": "string",
"phoneNumber": "string",
"email": "string",
"contactName": "string",
"customerId": "string",
"vendorId": "string",
"organizationId": "string",
"position": {"latitude": -90,
"longitude": -180
},
"automaticallyPickUpViaLinkedTerminalAddress": true,
"automaticallyDeliverViaLinkedTerminalAddress": true,
"linkedAddressIds": ["string"
],
"accessInformation": "string"
}

Response samples

Content type

application/json

{"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"poBox": "string",
"countryCode": "string",
"postCode": "string",
"city": "string",
"subDivision": "string",
"state": "string",
"addressType": "string",
"phoneNumber": "string",
"email": "string",
"contactName": "string",
"customerId": "string",
"vendorId": "string",
"organizationId": "string",
"position": {"latitude": -90,
"longitude": -180
},
"automaticallyPickUpViaLinkedTerminalAddress": true,
"automaticallyDeliverViaLinkedTerminalAddress": true,
"linkedAddressIds": ["string"
],
"accessInformation": "string",
"addressId": "string"
}

GetAddressById

path Parameters

addressId

required

string <guid>

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

Content type

application/json

{"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"poBox": "string",
"countryCode": "string",
"postCode": "string",
"city": "string",
"subDivision": "string",
"state": "string",
"addressType": "string",
"phoneNumber": "string",
"email": "string",
"contactName": "string",
"customerId": "string",
"vendorId": "string",
"organizationId": "string",
"position": {"latitude": -90,
"longitude": -180
},
"automaticallyPickUpViaLinkedTerminalAddress": true,
"automaticallyDeliverViaLinkedTerminalAddress": true,
"linkedAddressIds": ["string"
],
"accessInformation": "string",
"addressId": "string"
}

UpdateAddress

path Parameters

addressId

required

string <guid>

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

name required	string [ 1 .. 200 ] characters
address1	string or null [ 0 .. 200 ] characters
address2	string or null [ 0 .. 200 ] characters
address3	string or null [ 0 .. 200 ] characters
poBox	string or null [ 0 .. 50 ] characters Post office box number or reference.
countryCode	string or null [ 0 .. 10 ] characters
postCode	string or null [ 0 .. 20 ] characters
city	string or null [ 0 .. 100 ] characters
subDivision	string or null [ 0 .. 128 ] characters Sub division (district/region below State/Province level).
state	string or null [ 0 .. 100 ] characters
addressType required	string string of enum: AddressType KnownValues: [Generic, Terminal, Port, Airport, TrainStation]
phoneNumber	string or null [ 0 .. 50 ] characters
email	string or null [ 0 .. 254 ] characters
contactName	string or null [ 0 .. 200 ] characters
customerId	string or null <guid> Associated Customer.
vendorId	string or null <guid> Associated Vendor.
organizationId	string or null <guid> Associated Organization.
	(PublicCoordinateDto (object or null))
automaticallyPickUpViaLinkedTerminalAddress	boolean or null Orders picking up here get a separate pickup task via the single linked Terminal address. Null: false on create, unchanged on update.
automaticallyDeliverViaLinkedTerminalAddress	boolean or null Orders delivering here get a separate delivery task via the single linked Terminal address. Null: false on create, unchanged on update.
linkedAddressIds	Array of strings or null <guid> [ items <guid > ] Addresses linked to this one; links are two-way. Null: no links on create, unchanged on update. A list replaces the links.
accessInformation	string or null [ 0 .. 300 ] characters Gate/door codes etc. Only returned to, and writable by, callers with the TMS.AddressAccessInformation role; ignored and returned as null otherwise. On update: null keeps the stored value, empty or whitespace clears it.

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"poBox": "string",
"countryCode": "string",
"postCode": "string",
"city": "string",
"subDivision": "string",
"state": "string",
"addressType": "string",
"phoneNumber": "string",
"email": "string",
"contactName": "string",
"customerId": "string",
"vendorId": "string",
"organizationId": "string",
"position": {"latitude": -90,
"longitude": -180
},
"automaticallyPickUpViaLinkedTerminalAddress": true,
"automaticallyDeliverViaLinkedTerminalAddress": true,
"linkedAddressIds": ["string"
],
"accessInformation": "string"
}

Response samples

Content type

application/json

{"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"poBox": "string",
"countryCode": "string",
"postCode": "string",
"city": "string",
"subDivision": "string",
"state": "string",
"addressType": "string",
"phoneNumber": "string",
"email": "string",
"contactName": "string",
"customerId": "string",
"vendorId": "string",
"organizationId": "string",
"position": {"latitude": -90,
"longitude": -180
},
"automaticallyPickUpViaLinkedTerminalAddress": true,
"automaticallyDeliverViaLinkedTerminalAddress": true,
"linkedAddressIds": ["string"
],
"accessInformation": "string",
"addressId": "string"
}

TMSCustomerProjects

GetListOfCustomerProjects

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>
customerId	string or null <guid>
active	boolean or null
quickSearch	string
take	integer or null <int32>
skip	integer or null <int32>

Responses

Response samples

Content type

application/json

[{"customerId": "string",
"name": "string",
"description": "string",
"active": true,
"customerProjectId": "string"
}
]

CreateCustomerProject

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

customerId required	string <guid>
name	string or null
description	string or null
active required	boolean

Responses

Request samples

Payload

Content type

application/json

{"customerId": "string",
"name": "string",
"description": "string",
"active": true
}

Response samples

Content type

application/json

{"customerId": "string",
"name": "string",
"description": "string",
"active": true,
"customerProjectId": "string"
}

GetCustomerProjectById

path Parameters

customerProjectId

required

string <guid>

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

Content type

application/json

{"customerId": "string",
"name": "string",
"description": "string",
"active": true,
"customerProjectId": "string"
}

UpdateCustomerProject

path Parameters

customerProjectId

required

string <guid>

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

customerId required	string <guid>
name	string or null
description	string or null
active required	boolean
customerProjectId required	string <guid>

Responses

Request samples

Payload

Content type

application/json

{"customerId": "string",
"name": "string",
"description": "string",
"active": true,
"customerProjectId": "string"
}

Response samples

Content type

application/json

{"customerId": "string",
"name": "string",
"description": "string",
"active": true,
"customerProjectId": "string"
}

TMSDrivers

GetListOfDrivers

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>
isActive	boolean or null
name	string
skip	integer or null <int32>
take	integer or null <int32>

Responses

Response samples

Content type

application/json

[{"firstName": "string",
"lastName": "string",
"phoneNumber": "string",
"externalNumber": "string",
"allowConfirm": true,
"isActive": true,
"driverId": "string"
}
]

CreateDriver

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

firstName required	string [ 1 .. 150 ] characters
lastName required	string [ 1 .. 150 ] characters
phoneNumber	string or null [ 0 .. 50 ] characters
externalNumber	string or null [ 0 .. 50 ] characters
allowConfirm required	boolean
isActive required	boolean

Responses

Request samples

Payload

Content type

application/json

{"firstName": "string",
"lastName": "string",
"phoneNumber": "string",
"externalNumber": "string",
"allowConfirm": true,
"isActive": true
}

Response samples

Content type

application/json

{"firstName": "string",
"lastName": "string",
"phoneNumber": "string",
"externalNumber": "string",
"allowConfirm": true,
"isActive": true,
"driverId": "string"
}

GetDriverById

path Parameters

driverId

required

string <guid>

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

Content type

application/json

{"firstName": "string",
"lastName": "string",
"phoneNumber": "string",
"externalNumber": "string",
"allowConfirm": true,
"isActive": true,
"driverId": "string"
}

UpdateDriver

path Parameters

driverId

required

string <guid>

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

firstName required	string [ 1 .. 150 ] characters
lastName required	string [ 1 .. 150 ] characters
phoneNumber	string or null [ 0 .. 50 ] characters
externalNumber	string or null [ 0 .. 50 ] characters
allowConfirm required	boolean
isActive required	boolean
driverId required	string <guid>

Responses

Request samples

Payload

Content type

application/json

{"firstName": "string",
"lastName": "string",
"phoneNumber": "string",
"externalNumber": "string",
"allowConfirm": true,
"isActive": true,
"driverId": "string"
}

Response samples

Content type

application/json

{"firstName": "string",
"lastName": "string",
"phoneNumber": "string",
"externalNumber": "string",
"allowConfirm": true,
"isActive": true,
"driverId": "string"
}

TMSOrganizations

GetListOfOrganizations

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>
queryString	string
skip	integer or null <int32>
take	integer or null <int32>
includeInactive	boolean or null
countryCode	string
organizationNumber	string

Responses

Response samples

Content type

application/json

[{"name": "string",
"organizationNumber": "string",
"countryCode": "st",
"customerId": "string",
"vendorId": "string",
"customsCreditNumber": "string",
"customsExporterNumber": "string",
"customsAuthorizationNumber": "string",
"sendGoodsExternallyForWarehousing": true,
"externalWarehouseIntegration": "string",
"customsSystemId": "string",
"customsExporter": "string",
"customsExporterVendorId": "string",
"isActive": true,
"organizationId": "string"
}
]

CreateOrganization

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

name required	string [ 1 .. 200 ] characters
organizationNumber	string or null [ 0 .. 200 ] characters
countryCode	string or null [ 0 .. 2 ] characters
customerId	string or null <guid>
vendorId	string or null <guid>
customsCreditNumber	string or null [ 0 .. 200 ] characters
customsExporterNumber	string or null [ 0 .. 200 ] characters
customsAuthorizationNumber	string or null [ 0 .. 200 ] characters
sendGoodsExternallyForWarehousing required	boolean
externalWarehouseIntegration	string or null [ 0 .. 200 ] characters
customsSystemId	string or null [ 0 .. 200 ] characters
customsExporter required	string string of enum: CustomsExporter KnownValues: [Us, GivenVendor]
customsExporterVendorId	string or null <guid>
isActive required	boolean

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"organizationNumber": "string",
"countryCode": "st",
"customerId": "string",
"vendorId": "string",
"customsCreditNumber": "string",
"customsExporterNumber": "string",
"customsAuthorizationNumber": "string",
"sendGoodsExternallyForWarehousing": true,
"externalWarehouseIntegration": "string",
"customsSystemId": "string",
"customsExporter": "string",
"customsExporterVendorId": "string",
"isActive": true
}

Response samples

Content type

application/json

{"name": "string",
"organizationNumber": "string",
"countryCode": "st",
"customerId": "string",
"vendorId": "string",
"customsCreditNumber": "string",
"customsExporterNumber": "string",
"customsAuthorizationNumber": "string",
"sendGoodsExternallyForWarehousing": true,
"externalWarehouseIntegration": "string",
"customsSystemId": "string",
"customsExporter": "string",
"customsExporterVendorId": "string",
"isActive": true,
"organizationId": "string"
}

GetOrganizationById

path Parameters

organizationId

required

string <guid>

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

Content type

application/json

{"name": "string",
"organizationNumber": "string",
"countryCode": "st",
"customerId": "string",
"vendorId": "string",
"customsCreditNumber": "string",
"customsExporterNumber": "string",
"customsAuthorizationNumber": "string",
"sendGoodsExternallyForWarehousing": true,
"externalWarehouseIntegration": "string",
"customsSystemId": "string",
"customsExporter": "string",
"customsExporterVendorId": "string",
"isActive": true,
"organizationId": "string"
}

UpdateOrganization

path Parameters

organizationId

required

string <guid>

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

name required	string [ 1 .. 200 ] characters
organizationNumber	string or null [ 0 .. 200 ] characters
countryCode	string or null [ 0 .. 2 ] characters
customerId	string or null <guid>
vendorId	string or null <guid>
customsCreditNumber	string or null [ 0 .. 200 ] characters
customsExporterNumber	string or null [ 0 .. 200 ] characters
customsAuthorizationNumber	string or null [ 0 .. 200 ] characters
sendGoodsExternallyForWarehousing required	boolean
externalWarehouseIntegration	string or null [ 0 .. 200 ] characters
customsSystemId	string or null [ 0 .. 200 ] characters
customsExporter required	string string of enum: CustomsExporter KnownValues: [Us, GivenVendor]
customsExporterVendorId	string or null <guid>
isActive required	boolean
organizationId required	string <guid>

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"organizationNumber": "string",
"countryCode": "st",
"customerId": "string",
"vendorId": "string",
"customsCreditNumber": "string",
"customsExporterNumber": "string",
"customsAuthorizationNumber": "string",
"sendGoodsExternallyForWarehousing": true,
"externalWarehouseIntegration": "string",
"customsSystemId": "string",
"customsExporter": "string",
"customsExporterVendorId": "string",
"isActive": true,
"organizationId": "string"
}

Response samples

Content type

application/json

{"name": "string",
"organizationNumber": "string",
"countryCode": "st",
"customerId": "string",
"vendorId": "string",
"customsCreditNumber": "string",
"customsExporterNumber": "string",
"customsAuthorizationNumber": "string",
"sendGoodsExternallyForWarehousing": true,
"externalWarehouseIntegration": "string",
"customsSystemId": "string",
"customsExporter": "string",
"customsExporterVendorId": "string",
"isActive": true,
"organizationId": "string"
}

TMSVehicles

GetListOfVehicles

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>
isActive	boolean or null
isContainer	boolean or null
quickSearch	string
identifier	string
ownerIds	Array of strings <guid> [ items <guid > ]
departmentIds	Array of strings <guid> [ items <guid > ]
projectIds	Array of strings <guid> [ items <guid > ]
driverIds	Array of strings <guid> [ items <guid > ]
vehicleTypeIds	Array of strings <guid> [ items <guid > ]
take	integer or null <int32>
skip	integer or null <int32>
sortByAscending	boolean or null
	(VehicleSortBy (string or null))

Responses

Response samples

Content type

application/json

[{"description": "string",
"identifier": "string",
"vehicleTypeId": "string",
"make": "string",
"model": "string",
"modelYear": 1900,
"dateOfPurchase": "2019-08-24T14:15:22Z",
"dateOfSale": "2019-08-24T14:15:22Z",
"nationality": "st",
"phoneNumber": "string",
"allowConfirm": true,
"owner": "string",
"department": "string",
"project": "string",
"palletPlaces": 0,
"maxWeightInKg": 0,
"maxLengthInMeters": 0,
"maxWidthInMeters": 0,
"maxHeightInMeters": 0,
"maxVolumeInCubicMeters": 0,
"maxLoadingMeters": 0,
"driverId": "string",
"emissionGroup": "string",
"isActive": true,
"vehicleId": "string"
}
]

CreateVehicle

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

description required	string [ 1 .. 150 ] characters
identifier required	string [ 1 .. 100 ] characters
vehicleTypeId	string or null <guid>
make	string or null [ 0 .. 100 ] characters
model	string or null [ 0 .. 100 ] characters
modelYear required	integer <int32> [ 1900 .. 2100 ]
dateOfPurchase	string or null <date-time>
dateOfSale	string or null <date-time>
nationality	string or null = 2 characters
phoneNumber	string or null [ 0 .. 50 ] characters
allowConfirm required	boolean
owner	string or null <guid>
department	string or null <guid>
project	string or null <guid>
palletPlaces required	integer <int32>
maxWeightInKg required	integer <int32>
maxLengthInMeters required	number <decimal>
maxWidthInMeters required	number <decimal>
maxHeightInMeters required	number <decimal>
maxVolumeInCubicMeters required	number <decimal>
maxLoadingMeters required	number <decimal>
driverId	string or null <guid>
emissionGroup	string or null string of enum: EmissionGroup KnownValues: [Sea_BulkCarrier, Sea_GeneralCargoShip, Sea_ContainerShip, Sea_RoRoFerry, Sea_RefrigeratedCargo, Road_Euro5, Road_Euro6, Road_ElectricalVehicle, Road_Gas, Road_BioGas, Road_HVO100, Train_Elecric, Train_Diesel, Air]
isActive	boolean or null

Responses

Request samples

Payload

Content type

application/json

{"description": "string",
"identifier": "string",
"vehicleTypeId": "string",
"make": "string",
"model": "string",
"modelYear": 1900,
"dateOfPurchase": "2019-08-24T14:15:22Z",
"dateOfSale": "2019-08-24T14:15:22Z",
"nationality": "st",
"phoneNumber": "string",
"allowConfirm": true,
"owner": "string",
"department": "string",
"project": "string",
"palletPlaces": 0,
"maxWeightInKg": 0,
"maxLengthInMeters": 0,
"maxWidthInMeters": 0,
"maxHeightInMeters": 0,
"maxVolumeInCubicMeters": 0,
"maxLoadingMeters": 0,
"driverId": "string",
"emissionGroup": "string",
"isActive": true
}

Response samples

Content type

application/json

{"description": "string",
"identifier": "string",
"vehicleTypeId": "string",
"make": "string",
"model": "string",
"modelYear": 1900,
"dateOfPurchase": "2019-08-24T14:15:22Z",
"dateOfSale": "2019-08-24T14:15:22Z",
"nationality": "st",
"phoneNumber": "string",
"allowConfirm": true,
"owner": "string",
"department": "string",
"project": "string",
"palletPlaces": 0,
"maxWeightInKg": 0,
"maxLengthInMeters": 0,
"maxWidthInMeters": 0,
"maxHeightInMeters": 0,
"maxVolumeInCubicMeters": 0,
"maxLoadingMeters": 0,
"driverId": "string",
"emissionGroup": "string",
"isActive": true,
"vehicleId": "string"
}

GetVehicleById

path Parameters

vehicleId

required

string <guid>

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

Content type

application/json

{"description": "string",
"identifier": "string",
"vehicleTypeId": "string",
"make": "string",
"model": "string",
"modelYear": 1900,
"dateOfPurchase": "2019-08-24T14:15:22Z",
"dateOfSale": "2019-08-24T14:15:22Z",
"nationality": "st",
"phoneNumber": "string",
"allowConfirm": true,
"owner": "string",
"department": "string",
"project": "string",
"palletPlaces": 0,
"maxWeightInKg": 0,
"maxLengthInMeters": 0,
"maxWidthInMeters": 0,
"maxHeightInMeters": 0,
"maxVolumeInCubicMeters": 0,
"maxLoadingMeters": 0,
"driverId": "string",
"emissionGroup": "string",
"isActive": true,
"vehicleId": "string"
}

UpdateVehicle

path Parameters

vehicleId

required

string <guid>

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

description required	string [ 1 .. 150 ] characters
identifier required	string [ 1 .. 100 ] characters
vehicleTypeId	string or null <guid>
make	string or null [ 0 .. 100 ] characters
model	string or null [ 0 .. 100 ] characters
modelYear required	integer <int32> [ 1900 .. 2100 ]
dateOfPurchase	string or null <date-time>
dateOfSale	string or null <date-time>
nationality	string or null = 2 characters
phoneNumber	string or null [ 0 .. 50 ] characters
allowConfirm required	boolean
owner	string or null <guid>
department	string or null <guid>
project	string or null <guid>
palletPlaces required	integer <int32>
maxWeightInKg required	integer <int32>
maxLengthInMeters required	number <decimal>
maxWidthInMeters required	number <decimal>
maxHeightInMeters required	number <decimal>
maxVolumeInCubicMeters required	number <decimal>
maxLoadingMeters required	number <decimal>
driverId	string or null <guid>
emissionGroup	string or null string of enum: EmissionGroup KnownValues: [Sea_BulkCarrier, Sea_GeneralCargoShip, Sea_ContainerShip, Sea_RoRoFerry, Sea_RefrigeratedCargo, Road_Euro5, Road_Euro6, Road_ElectricalVehicle, Road_Gas, Road_BioGas, Road_HVO100, Train_Elecric, Train_Diesel, Air]
isActive	boolean or null
vehicleId required	string <guid>

Responses

Request samples

Payload

Content type

application/json

{"description": "string",
"identifier": "string",
"vehicleTypeId": "string",
"make": "string",
"model": "string",
"modelYear": 1900,
"dateOfPurchase": "2019-08-24T14:15:22Z",
"dateOfSale": "2019-08-24T14:15:22Z",
"nationality": "st",
"phoneNumber": "string",
"allowConfirm": true,
"owner": "string",
"department": "string",
"project": "string",
"palletPlaces": 0,
"maxWeightInKg": 0,
"maxLengthInMeters": 0,
"maxWidthInMeters": 0,
"maxHeightInMeters": 0,
"maxVolumeInCubicMeters": 0,
"maxLoadingMeters": 0,
"driverId": "string",
"emissionGroup": "string",
"isActive": true,
"vehicleId": "string"
}

Response samples

Content type

application/json

{"description": "string",
"identifier": "string",
"vehicleTypeId": "string",
"make": "string",
"model": "string",
"modelYear": 1900,
"dateOfPurchase": "2019-08-24T14:15:22Z",
"dateOfSale": "2019-08-24T14:15:22Z",
"nationality": "st",
"phoneNumber": "string",
"allowConfirm": true,
"owner": "string",
"department": "string",
"project": "string",
"palletPlaces": 0,
"maxWeightInKg": 0,
"maxLengthInMeters": 0,
"maxWidthInMeters": 0,
"maxHeightInMeters": 0,
"maxVolumeInCubicMeters": 0,
"maxLoadingMeters": 0,
"driverId": "string",
"emissionGroup": "string",
"isActive": true,
"vehicleId": "string"
}

TMSVehicleTypes

GetListOfVehicleTypes

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>
isContainer	boolean or null
icon	string
quickSearch	string
name	string
skip	integer or null <int32>
take	integer or null <int32>

Responses

Response samples

Content type

application/json

[{"isActive": true,
"description": "string",
"code": "string",
"loadCarrier": true,
"powered": true,
"icon": "string",
"modeOfTransportId": "string",
"modeOfTransports": ["string"
],
"meansOfTransportCode": "string",
"tareWeightInKg": 0,
"palletPlaces": 0,
"maxWeightInKg": 0,
"maxLengthInMeters": 0,
"maxWidthInMeters": 0,
"maxHeightInMeters": 0,
"maxVolumeInCubicMeters": 0,
"maxLoadingMeters": 0,
"teu": 0,
"vehicleTypeId": "string"
}
]

CreateVehicleType

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

isActive required	boolean
description required	string [ 1 .. 100 ] characters
code	string or null [ 0 .. 20 ] characters
loadCarrier required	boolean
powered required	boolean
icon required	string string of enum: VehicleTypeIcon KnownValues: [Van, Truck, Semi, Trailer, RoadTrain, Tractor, Boat, Plane, Container, Crane, Train, ModularRoadTrain]
modeOfTransportId	string or null <guid>
modeOfTransports	Array of strings or null
meansOfTransportCode	string or null
tareWeightInKg	integer or null <int32> [ 0 .. 2147483647 ]
palletPlaces required	integer <int32> [ 0 .. 2147483647 ]
maxWeightInKg required	integer <int32> [ 0 .. 2147483647 ]
maxLengthInMeters required	number <decimal> [ 0 .. 2147483647 ]
maxWidthInMeters required	number <decimal> [ 0 .. 2147483647 ]
maxHeightInMeters required	number <decimal> [ 0 .. 2147483647 ]
maxVolumeInCubicMeters required	number <decimal> [ 0 .. 2147483647 ]
maxLoadingMeters required	number <decimal> [ 0 .. 2147483647 ]
teu	number or null <decimal> [ 0 .. 999999999.999 ]

Responses

Request samples

Payload

Content type

application/json

{"isActive": true,
"description": "string",
"code": "string",
"loadCarrier": true,
"powered": true,
"icon": "string",
"modeOfTransportId": "string",
"modeOfTransports": ["string"
],
"meansOfTransportCode": "string",
"tareWeightInKg": 0,
"palletPlaces": 0,
"maxWeightInKg": 0,
"maxLengthInMeters": 0,
"maxWidthInMeters": 0,
"maxHeightInMeters": 0,
"maxVolumeInCubicMeters": 0,
"maxLoadingMeters": 0,
"teu": 0
}

Response samples

Content type

application/json

{"isActive": true,
"description": "string",
"code": "string",
"loadCarrier": true,
"powered": true,
"icon": "string",
"modeOfTransportId": "string",
"modeOfTransports": ["string"
],
"meansOfTransportCode": "string",
"tareWeightInKg": 0,
"palletPlaces": 0,
"maxWeightInKg": 0,
"maxLengthInMeters": 0,
"maxWidthInMeters": 0,
"maxHeightInMeters": 0,
"maxVolumeInCubicMeters": 0,
"maxLoadingMeters": 0,
"teu": 0,
"vehicleTypeId": "string"
}

GetVehicleTypeById

path Parameters

vehicleTypeId

required

string <guid>

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

Content type

application/json

{"isActive": true,
"description": "string",
"code": "string",
"loadCarrier": true,
"powered": true,
"icon": "string",
"modeOfTransportId": "string",
"modeOfTransports": ["string"
],
"meansOfTransportCode": "string",
"tareWeightInKg": 0,
"palletPlaces": 0,
"maxWeightInKg": 0,
"maxLengthInMeters": 0,
"maxWidthInMeters": 0,
"maxHeightInMeters": 0,
"maxVolumeInCubicMeters": 0,
"maxLoadingMeters": 0,
"teu": 0,
"vehicleTypeId": "string"
}

UpdateVehicleType

path Parameters

vehicleTypeId

required

string <guid>

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

isActive required	boolean
description required	string [ 1 .. 100 ] characters
code	string or null [ 0 .. 20 ] characters
loadCarrier required	boolean
powered required	boolean
icon required	string string of enum: VehicleTypeIcon KnownValues: [Van, Truck, Semi, Trailer, RoadTrain, Tractor, Boat, Plane, Container, Crane, Train, ModularRoadTrain]
modeOfTransportId	string or null <guid>
modeOfTransports	Array of strings or null
meansOfTransportCode	string or null
tareWeightInKg	integer or null <int32> [ 0 .. 2147483647 ]
palletPlaces required	integer <int32> [ 0 .. 2147483647 ]
maxWeightInKg required	integer <int32> [ 0 .. 2147483647 ]
maxLengthInMeters required	number <decimal> [ 0 .. 2147483647 ]
maxWidthInMeters required	number <decimal> [ 0 .. 2147483647 ]
maxHeightInMeters required	number <decimal> [ 0 .. 2147483647 ]
maxVolumeInCubicMeters required	number <decimal> [ 0 .. 2147483647 ]
maxLoadingMeters required	number <decimal> [ 0 .. 2147483647 ]
teu	number or null <decimal> [ 0 .. 999999999.999 ]
vehicleTypeId required	string <guid>

Responses

Request samples

Payload

Content type

application/json

{"isActive": true,
"description": "string",
"code": "string",
"loadCarrier": true,
"powered": true,
"icon": "string",
"modeOfTransportId": "string",
"modeOfTransports": ["string"
],
"meansOfTransportCode": "string",
"tareWeightInKg": 0,
"palletPlaces": 0,
"maxWeightInKg": 0,
"maxLengthInMeters": 0,
"maxWidthInMeters": 0,
"maxHeightInMeters": 0,
"maxVolumeInCubicMeters": 0,
"maxLoadingMeters": 0,
"teu": 0,
"vehicleTypeId": "string"
}

Response samples

Content type

application/json

{"isActive": true,
"description": "string",
"code": "string",
"loadCarrier": true,
"powered": true,
"icon": "string",
"modeOfTransportId": "string",
"modeOfTransports": ["string"
],
"meansOfTransportCode": "string",
"tareWeightInKg": 0,
"palletPlaces": 0,
"maxWeightInKg": 0,
"maxLengthInMeters": 0,
"maxWidthInMeters": 0,
"maxHeightInMeters": 0,
"maxVolumeInCubicMeters": 0,
"maxLoadingMeters": 0,
"teu": 0,
"vehicleTypeId": "string"
}

TMSTimpex

PostTransportDetails

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

string

Responses

Request samples

Payload

Content type

application/json

"string"

Response samples

400
default

Content type

application/json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"applicationId": ["string"
],
"errors": {"property1": ["string"
],
"property2": ["string"
]
},
"property1": null,
"property2": null
}

PostStatusReport

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

string

Responses

Request samples

Payload

Content type

application/json

"string"

Response samples

400
default

Content type

application/json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"applicationId": ["string"
],
"errors": {"property1": ["string"
],
"property2": ["string"
]
},
"property1": null,
"property2": null
}

PostMessageReceived

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

string

Responses

Request samples

Payload

Content type

application/json

"string"

Response samples

400
default

Content type

application/json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"applicationId": ["string"
],
"errors": {"property1": ["string"
],
"property2": ["string"
]
},
"property1": null,
"property2": null
}

TMSLegs

GetLegs

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>
vehicleId	string or null <guid>
driverId	string or null <guid>
dispatchStatus	string
startStopStatus	string
isCommunicatedReceived	boolean or null
isCancelled	boolean or null
quickSearch	string
take	integer or null <int32>
skip	integer or null <int32>
	(LegSortBy (string or null))
sortAscending	boolean or null

Responses

Response samples

Content type

application/json

[{"legId": "string",
"legNumber": 0,
"identifier": "string",
"tripId": "string",
"fromAddress": {"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"poBox": "string",
"postCode": "string",
"city": "string",
"subDivision": "string",
"state": "string",
"countryCode": "string",
"addressType": "string",
"phoneNumber": "string",
"email": "string",
"contactName": "string",
"position": {"latitude": -90,
"longitude": -180
}
},
"toAddress": {"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"poBox": "string",
"postCode": "string",
"city": "string",
"subDivision": "string",
"state": "string",
"countryCode": "string",
"addressType": "string",
"phoneNumber": "string",
"email": "string",
"contactName": "string",
"position": {"latitude": -90,
"longitude": -180
}
},
"etd": {"dateTimeOffset": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"eta": {"dateTimeOffset": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"vehicleUsages": [{"vehicleId": "string",
"vehicleName": "string",
"registrationNumber": "string"
}
],
"driverUsages": [{"driverId": "string",
"firstName": "string",
"lastName": "string",
"phoneNumber": "string"
}
],
"dispatchStatus": "string",
"startStopStatus": "string",
"isCommunicatedReceived": true
}
]

GetLegById

path Parameters

legId

required

string <guid>

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

Content type

application/json

{"legId": "string",
"legNumber": 0,
"identifier": "string",
"tripId": "string",
"fromAddress": {"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"poBox": "string",
"postCode": "string",
"city": "string",
"subDivision": "string",
"state": "string",
"countryCode": "string",
"addressType": "string",
"phoneNumber": "string",
"email": "string",
"contactName": "string",
"position": {"latitude": -90,
"longitude": -180
}
},
"toAddress": {"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"poBox": "string",
"postCode": "string",
"city": "string",
"subDivision": "string",
"state": "string",
"countryCode": "string",
"addressType": "string",
"phoneNumber": "string",
"email": "string",
"contactName": "string",
"position": {"latitude": -90,
"longitude": -180
}
},
"etd": {"dateTimeOffset": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"eta": {"dateTimeOffset": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"vehicleUsages": [{"vehicleId": "string",
"vehicleName": "string",
"registrationNumber": "string"
}
],
"driverUsages": [{"driverId": "string",
"firstName": "string",
"lastName": "string",
"phoneNumber": "string"
}
],
"dispatchStatus": "string",
"startStopStatus": "string",
"isCommunicatedReceived": true
}

SplitLeg

path Parameters

legId

required

string <guid>

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

required	object (PublicAddressDto)
	(ZonedDateTimeDto (object or null))
	(ZonedDateTimeDto (object or null))
legIdentifier	string or null [ 0 .. 200 ] characters
vehicleId	string or null <guid>

Responses

Request samples

Payload

Content type

application/json

{"splitLocation": {"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"poBox": "string",
"postCode": "string",
"city": "string",
"subDivision": "string",
"state": "string",
"countryCode": "string",
"addressType": "string",
"phoneNumber": "string",
"email": "string",
"contactName": "string",
"position": {"latitude": -90,
"longitude": -180
}
},
"etaToSplitLocation": {"dateTimeOffset": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"etdFromSplitLocation": {"dateTimeOffset": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"legIdentifier": "string",
"vehicleId": "string"
}

Response samples

Content type

application/json

[{"legId": "string",
"legNumber": 0,
"identifier": "string",
"tripId": "string",
"fromAddress": {"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"poBox": "string",
"postCode": "string",
"city": "string",
"subDivision": "string",
"state": "string",
"countryCode": "string",
"addressType": "string",
"phoneNumber": "string",
"email": "string",
"contactName": "string",
"position": {"latitude": -90,
"longitude": -180
}
},
"toAddress": {"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"poBox": "string",
"postCode": "string",
"city": "string",
"subDivision": "string",
"state": "string",
"countryCode": "string",
"addressType": "string",
"phoneNumber": "string",
"email": "string",
"contactName": "string",
"position": {"latitude": -90,
"longitude": -180
}
},
"etd": {"dateTimeOffset": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"eta": {"dateTimeOffset": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"vehicleUsages": [{"vehicleId": "string",
"vehicleName": "string",
"registrationNumber": "string"
}
],
"driverUsages": [{"driverId": "string",
"firstName": "string",
"lastName": "string",
"phoneNumber": "string"
}
],
"dispatchStatus": "string",
"startStopStatus": "string",
"isCommunicatedReceived": true
}
]

MergeLegs

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

leg1Id required	string <guid>
leg2Id required	string <guid>
keepDataFromLegId required	string <guid> Which of the two legs' data (identifier, resources) to keep on the merged leg.

Responses

Request samples

Payload

Content type

application/json

{"leg1Id": "string",
"leg2Id": "string",
"keepDataFromLegId": "string"
}

Response samples

Content type

application/json

[{"legId": "string",
"legNumber": 0,
"identifier": "string",
"tripId": "string",
"fromAddress": {"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"poBox": "string",
"postCode": "string",
"city": "string",
"subDivision": "string",
"state": "string",
"countryCode": "string",
"addressType": "string",
"phoneNumber": "string",
"email": "string",
"contactName": "string",
"position": {"latitude": -90,
"longitude": -180
}
},
"toAddress": {"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"poBox": "string",
"postCode": "string",
"city": "string",
"subDivision": "string",
"state": "string",
"countryCode": "string",
"addressType": "string",
"phoneNumber": "string",
"email": "string",
"contactName": "string",
"position": {"latitude": -90,
"longitude": -180
}
},
"etd": {"dateTimeOffset": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"eta": {"dateTimeOffset": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"vehicleUsages": [{"vehicleId": "string",
"vehicleName": "string",
"registrationNumber": "string"
}
],
"driverUsages": [{"driverId": "string",
"firstName": "string",
"lastName": "string",
"phoneNumber": "string"
}
],
"dispatchStatus": "string",
"startStopStatus": "string",
"isCommunicatedReceived": true
}
]

AddVehicleToLeg

path Parameters

legId required	string <guid>
vehicleId required	string <guid>

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

Content type

application/json

{"legId": "string",
"legNumber": 0,
"identifier": "string",
"tripId": "string",
"fromAddress": {"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"poBox": "string",
"postCode": "string",
"city": "string",
"subDivision": "string",
"state": "string",
"countryCode": "string",
"addressType": "string",
"phoneNumber": "string",
"email": "string",
"contactName": "string",
"position": {"latitude": -90,
"longitude": -180
}
},
"toAddress": {"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"poBox": "string",
"postCode": "string",
"city": "string",
"subDivision": "string",
"state": "string",
"countryCode": "string",
"addressType": "string",
"phoneNumber": "string",
"email": "string",
"contactName": "string",
"position": {"latitude": -90,
"longitude": -180
}
},
"etd": {"dateTimeOffset": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"eta": {"dateTimeOffset": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"vehicleUsages": [{"vehicleId": "string",
"vehicleName": "string",
"registrationNumber": "string"
}
],
"driverUsages": [{"driverId": "string",
"firstName": "string",
"lastName": "string",
"phoneNumber": "string"
}
],
"dispatchStatus": "string",
"startStopStatus": "string",
"isCommunicatedReceived": true
}

RemoveVehicleFromLeg

path Parameters

legId required	string <guid>
vehicleId required	string <guid>

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

Content type

application/json

{"legId": "string",
"legNumber": 0,
"identifier": "string",
"tripId": "string",
"fromAddress": {"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"poBox": "string",
"postCode": "string",
"city": "string",
"subDivision": "string",
"state": "string",
"countryCode": "string",
"addressType": "string",
"phoneNumber": "string",
"email": "string",
"contactName": "string",
"position": {"latitude": -90,
"longitude": -180
}
},
"toAddress": {"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"poBox": "string",
"postCode": "string",
"city": "string",
"subDivision": "string",
"state": "string",
"countryCode": "string",
"addressType": "string",
"phoneNumber": "string",
"email": "string",
"contactName": "string",
"position": {"latitude": -90,
"longitude": -180
}
},
"etd": {"dateTimeOffset": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"eta": {"dateTimeOffset": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"vehicleUsages": [{"vehicleId": "string",
"vehicleName": "string",
"registrationNumber": "string"
}
],
"driverUsages": [{"driverId": "string",
"firstName": "string",
"lastName": "string",
"phoneNumber": "string"
}
],
"dispatchStatus": "string",
"startStopStatus": "string",
"isCommunicatedReceived": true
}

UpdateVehicleOnLeg

path Parameters

legId required	string <guid>
oldVehicleId required	string <guid>
newVehicleId required	string <guid>

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

Content type

application/json

{"legId": "string",
"legNumber": 0,
"identifier": "string",
"tripId": "string",
"fromAddress": {"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"poBox": "string",
"postCode": "string",
"city": "string",
"subDivision": "string",
"state": "string",
"countryCode": "string",
"addressType": "string",
"phoneNumber": "string",
"email": "string",
"contactName": "string",
"position": {"latitude": -90,
"longitude": -180
}
},
"toAddress": {"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"poBox": "string",
"postCode": "string",
"city": "string",
"subDivision": "string",
"state": "string",
"countryCode": "string",
"addressType": "string",
"phoneNumber": "string",
"email": "string",
"contactName": "string",
"position": {"latitude": -90,
"longitude": -180
}
},
"etd": {"dateTimeOffset": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"eta": {"dateTimeOffset": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"vehicleUsages": [{"vehicleId": "string",
"vehicleName": "string",
"registrationNumber": "string"
}
],
"driverUsages": [{"driverId": "string",
"firstName": "string",
"lastName": "string",
"phoneNumber": "string"
}
],
"dispatchStatus": "string",
"startStopStatus": "string",
"isCommunicatedReceived": true
}

AddDriverToLeg

path Parameters

legId required	string <guid>
driverId required	string <guid>

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

Content type

application/json

{"legId": "string",
"legNumber": 0,
"identifier": "string",
"tripId": "string",
"fromAddress": {"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"poBox": "string",
"postCode": "string",
"city": "string",
"subDivision": "string",
"state": "string",
"countryCode": "string",
"addressType": "string",
"phoneNumber": "string",
"email": "string",
"contactName": "string",
"position": {"latitude": -90,
"longitude": -180
}
},
"toAddress": {"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"poBox": "string",
"postCode": "string",
"city": "string",
"subDivision": "string",
"state": "string",
"countryCode": "string",
"addressType": "string",
"phoneNumber": "string",
"email": "string",
"contactName": "string",
"position": {"latitude": -90,
"longitude": -180
}
},
"etd": {"dateTimeOffset": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"eta": {"dateTimeOffset": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"vehicleUsages": [{"vehicleId": "string",
"vehicleName": "string",
"registrationNumber": "string"
}
],
"driverUsages": [{"driverId": "string",
"firstName": "string",
"lastName": "string",
"phoneNumber": "string"
}
],
"dispatchStatus": "string",
"startStopStatus": "string",
"isCommunicatedReceived": true
}

RemoveDriverFromLeg

path Parameters

legId required	string <guid>
driverId required	string <guid>

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

Content type

application/json

{"legId": "string",
"legNumber": 0,
"identifier": "string",
"tripId": "string",
"fromAddress": {"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"poBox": "string",
"postCode": "string",
"city": "string",
"subDivision": "string",
"state": "string",
"countryCode": "string",
"addressType": "string",
"phoneNumber": "string",
"email": "string",
"contactName": "string",
"position": {"latitude": -90,
"longitude": -180
}
},
"toAddress": {"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"poBox": "string",
"postCode": "string",
"city": "string",
"subDivision": "string",
"state": "string",
"countryCode": "string",
"addressType": "string",
"phoneNumber": "string",
"email": "string",
"contactName": "string",
"position": {"latitude": -90,
"longitude": -180
}
},
"etd": {"dateTimeOffset": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"eta": {"dateTimeOffset": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"vehicleUsages": [{"vehicleId": "string",
"vehicleName": "string",
"registrationNumber": "string"
}
],
"driverUsages": [{"driverId": "string",
"firstName": "string",
"lastName": "string",
"phoneNumber": "string"
}
],
"dispatchStatus": "string",
"startStopStatus": "string",
"isCommunicatedReceived": true
}

UpdateDriverOnLeg

path Parameters

legId required	string <guid>
oldDriverId required	string <guid>
newDriverId required	string <guid>

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

Content type

application/json

{"legId": "string",
"legNumber": 0,
"identifier": "string",
"tripId": "string",
"fromAddress": {"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"poBox": "string",
"postCode": "string",
"city": "string",
"subDivision": "string",
"state": "string",
"countryCode": "string",
"addressType": "string",
"phoneNumber": "string",
"email": "string",
"contactName": "string",
"position": {"latitude": -90,
"longitude": -180
}
},
"toAddress": {"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"poBox": "string",
"postCode": "string",
"city": "string",
"subDivision": "string",
"state": "string",
"countryCode": "string",
"addressType": "string",
"phoneNumber": "string",
"email": "string",
"contactName": "string",
"position": {"latitude": -90,
"longitude": -180
}
},
"etd": {"dateTimeOffset": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"eta": {"dateTimeOffset": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"vehicleUsages": [{"vehicleId": "string",
"vehicleName": "string",
"registrationNumber": "string"
}
],
"driverUsages": [{"driverId": "string",
"firstName": "string",
"lastName": "string",
"phoneNumber": "string"
}
],
"dispatchStatus": "string",
"startStopStatus": "string",
"isCommunicatedReceived": true
}

UpdateIdentifierOnLeg

path Parameters

legId

required

string <guid>

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

identifier

required

string [ 1 .. 200 ] characters

Responses

Request samples

Payload

Content type

application/json

{"identifier": "string"
}

Response samples

Content type

application/json

{"legId": "string",
"legNumber": 0,
"identifier": "string",
"tripId": "string",
"fromAddress": {"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"poBox": "string",
"postCode": "string",
"city": "string",
"subDivision": "string",
"state": "string",
"countryCode": "string",
"addressType": "string",
"phoneNumber": "string",
"email": "string",
"contactName": "string",
"position": {"latitude": -90,
"longitude": -180
}
},
"toAddress": {"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"poBox": "string",
"postCode": "string",
"city": "string",
"subDivision": "string",
"state": "string",
"countryCode": "string",
"addressType": "string",
"phoneNumber": "string",
"email": "string",
"contactName": "string",
"position": {"latitude": -90,
"longitude": -180
}
},
"etd": {"dateTimeOffset": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"eta": {"dateTimeOffset": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"vehicleUsages": [{"vehicleId": "string",
"vehicleName": "string",
"registrationNumber": "string"
}
],
"driverUsages": [{"driverId": "string",
"firstName": "string",
"lastName": "string",
"phoneNumber": "string"
}
],
"dispatchStatus": "string",
"startStopStatus": "string",
"isCommunicatedReceived": true
}

RemoveIdentifierFromLeg

path Parameters

legId

required

string <guid>

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

Content type

application/json

{"legId": "string",
"legNumber": 0,
"identifier": "string",
"tripId": "string",
"fromAddress": {"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"poBox": "string",
"postCode": "string",
"city": "string",
"subDivision": "string",
"state": "string",
"countryCode": "string",
"addressType": "string",
"phoneNumber": "string",
"email": "string",
"contactName": "string",
"position": {"latitude": -90,
"longitude": -180
}
},
"toAddress": {"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"poBox": "string",
"postCode": "string",
"city": "string",
"subDivision": "string",
"state": "string",
"countryCode": "string",
"addressType": "string",
"phoneNumber": "string",
"email": "string",
"contactName": "string",
"position": {"latitude": -90,
"longitude": -180
}
},
"etd": {"dateTimeOffset": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"eta": {"dateTimeOffset": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"vehicleUsages": [{"vehicleId": "string",
"vehicleName": "string",
"registrationNumber": "string"
}
],
"driverUsages": [{"driverId": "string",
"firstName": "string",
"lastName": "string",
"phoneNumber": "string"
}
],
"dispatchStatus": "string",
"startStopStatus": "string",
"isCommunicatedReceived": true
}

TMSOrderRepetition

GetOrderRepetitions

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

Content type

application/json

[{"templateName": "string",
"endDate": "2019-08-24T14:15:22Z",
"creationHorizonInDays": 0,
"includeOrderLines": true,
"includeTaskStructure": true,
"autoPrice": true,
"setPricingReadyForProcessing": true,
"orderRepetitionId": "string",
"sourceOrderId": "string",
"baseDate": "2019-08-24T14:15:22Z",
"schedules": [{"recurrencePattern": "string",
"recursEvery": 0,
"weeklyRecurrence": {"daysOfWeek": "string"
},
"monthlyRecurrence": {"dayOfMonth": 0,
"monthlyOccurence": "string",
"dayOfWeek": "string"
},
"orderRepetitionScheduleId": "string",
"orderRepetitionId": "string"
}
]
}
]

CreateOrderRepetition

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

templateName	string or null [ 0 .. 100 ] characters
endDate	string or null <date-time>
creationHorizonInDays required	integer <int32> [ 0 .. 2147483647 ]
includeOrderLines required	boolean
includeTaskStructure required	boolean
autoPrice required	boolean
setPricingReadyForProcessing required	boolean
sourceOrderId required	string <guid> non-empty

Responses

Request samples

Payload

Content type

application/json

{"templateName": "string",
"endDate": "2019-08-24T14:15:22Z",
"creationHorizonInDays": 0,
"includeOrderLines": true,
"includeTaskStructure": true,
"autoPrice": true,
"setPricingReadyForProcessing": true,
"sourceOrderId": "string"
}

Response samples

Content type

application/json

{"templateName": "string",
"endDate": "2019-08-24T14:15:22Z",
"creationHorizonInDays": 0,
"includeOrderLines": true,
"includeTaskStructure": true,
"autoPrice": true,
"setPricingReadyForProcessing": true,
"orderRepetitionId": "string",
"sourceOrderId": "string",
"baseDate": "2019-08-24T14:15:22Z",
"schedules": [{"recurrencePattern": "string",
"recursEvery": 0,
"weeklyRecurrence": {"daysOfWeek": "string"
},
"monthlyRecurrence": {"dayOfMonth": 0,
"monthlyOccurence": "string",
"dayOfWeek": "string"
},
"orderRepetitionScheduleId": "string",
"orderRepetitionId": "string"
}
]
}

GetOrderRepetitionById

path Parameters

orderRepetitionId

required

string <guid>

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

Content type

application/json

{"templateName": "string",
"endDate": "2019-08-24T14:15:22Z",
"creationHorizonInDays": 0,
"includeOrderLines": true,
"includeTaskStructure": true,
"autoPrice": true,
"setPricingReadyForProcessing": true,
"orderRepetitionId": "string",
"sourceOrderId": "string",
"baseDate": "2019-08-24T14:15:22Z",
"schedules": [{"recurrencePattern": "string",
"recursEvery": 0,
"weeklyRecurrence": {"daysOfWeek": "string"
},
"monthlyRecurrence": {"dayOfMonth": 0,
"monthlyOccurence": "string",
"dayOfWeek": "string"
},
"orderRepetitionScheduleId": "string",
"orderRepetitionId": "string"
}
]
}

PatchOrderRepetition

path Parameters

orderRepetitionId

required

string <guid>

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

templateName	string or null [ 0 .. 100 ] characters
endDate	string or null <date-time>
creationHorizonInDays required	integer <int32> [ 0 .. 2147483647 ]
includeOrderLines required	boolean
includeTaskStructure required	boolean
autoPrice required	boolean
setPricingReadyForProcessing required	boolean

Responses

Request samples

Payload

Content type

application/json

{"templateName": "string",
"endDate": "2019-08-24T14:15:22Z",
"creationHorizonInDays": 0,
"includeOrderLines": true,
"includeTaskStructure": true,
"autoPrice": true,
"setPricingReadyForProcessing": true
}

Response samples

Content type

application/json

{"templateName": "string",
"endDate": "2019-08-24T14:15:22Z",
"creationHorizonInDays": 0,
"includeOrderLines": true,
"includeTaskStructure": true,
"autoPrice": true,
"setPricingReadyForProcessing": true,
"orderRepetitionId": "string",
"sourceOrderId": "string",
"baseDate": "2019-08-24T14:15:22Z",
"schedules": [{"recurrencePattern": "string",
"recursEvery": 0,
"weeklyRecurrence": {"daysOfWeek": "string"
},
"monthlyRecurrence": {"dayOfMonth": 0,
"monthlyOccurence": "string",
"dayOfWeek": "string"
},
"orderRepetitionScheduleId": "string",
"orderRepetitionId": "string"
}
]
}

GetOrderRepetitionForOrder

path Parameters

orderId

required

string <guid>

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

Content type

application/json

{"templateName": "string",
"endDate": "2019-08-24T14:15:22Z",
"creationHorizonInDays": 0,
"includeOrderLines": true,
"includeTaskStructure": true,
"autoPrice": true,
"setPricingReadyForProcessing": true,
"orderRepetitionId": "string",
"sourceOrderId": "string",
"baseDate": "2019-08-24T14:15:22Z",
"schedules": [{"recurrencePattern": "string",
"recursEvery": 0,
"weeklyRecurrence": {"daysOfWeek": "string"
},
"monthlyRecurrence": {"dayOfMonth": 0,
"monthlyOccurence": "string",
"dayOfWeek": "string"
},
"orderRepetitionScheduleId": "string",
"orderRepetitionId": "string"
}
]
}

GetOrderRepetitionScheduleById

path Parameters

orderRepetitionScheduleId

required

string <guid>

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

Content type

application/json

{"recurrencePattern": "string",
"recursEvery": 0,
"weeklyRecurrence": {"daysOfWeek": "string"
},
"monthlyRecurrence": {"dayOfMonth": 0,
"monthlyOccurence": "string",
"dayOfWeek": "string"
},
"orderRepetitionScheduleId": "string",
"orderRepetitionId": "string"
}

PatchOrderRepetitionSchedule

path Parameters

orderRepetitionScheduleId

required

string <guid>

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

recurrencePattern required	string string of enum: RecurrencePattern KnownValues: [Daily, Weekly, BiWeeklyEven, BiWeeklyOdd, Monthly]
recursEvery required	integer <int32>
	(PublicWeeklyRecurrenceDto (object or null))
	(PublicMonthlyRecurrenceDto (object or null))

Responses

Request samples

Payload

Content type

application/json

{"recurrencePattern": "string",
"recursEvery": 0,
"weeklyRecurrence": {"daysOfWeek": "string"
},
"monthlyRecurrence": {"dayOfMonth": 0,
"monthlyOccurence": "string",
"dayOfWeek": "string"
}
}

Response samples

Content type

application/json

{"recurrencePattern": "string",
"recursEvery": 0,
"weeklyRecurrence": {"daysOfWeek": "string"
},
"monthlyRecurrence": {"dayOfMonth": 0,
"monthlyOccurence": "string",
"dayOfWeek": "string"
},
"orderRepetitionScheduleId": "string",
"orderRepetitionId": "string"
}

CreateOrderRepetitionSchedule

path Parameters

orderRepetitionId

required

string <guid>

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

recurrencePattern required	string string of enum: RecurrencePattern KnownValues: [Daily, Weekly, BiWeeklyEven, BiWeeklyOdd, Monthly]
recursEvery required	integer <int32>
	(PublicWeeklyRecurrenceDto (object or null))
	(PublicMonthlyRecurrenceDto (object or null))

Responses

Request samples

Payload

Content type

application/json

{"recurrencePattern": "string",
"recursEvery": 0,
"weeklyRecurrence": {"daysOfWeek": "string"
},
"monthlyRecurrence": {"dayOfMonth": 0,
"monthlyOccurence": "string",
"dayOfWeek": "string"
}
}

Response samples

Content type

application/json

{"recurrencePattern": "string",
"recursEvery": 0,
"weeklyRecurrence": {"daysOfWeek": "string"
},
"monthlyRecurrence": {"dayOfMonth": 0,
"monthlyOccurence": "string",
"dayOfWeek": "string"
},
"orderRepetitionScheduleId": "string",
"orderRepetitionId": "string"
}

TMSOrders

GetOrders

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>
orderId	string
orderIds	Array of strings
excludeOrderIds	Array of strings
onlyReturnGuids	boolean or null
allPickedUp	boolean or null
hasDeviation	boolean or null
orderNumber	integer or null <int32>
orderNumbers	Array of integers <int32> [ items <int32 > ]
etdRange	string
etaRange	string
updatedAt	string or null <duration>
fromUpdatedAt	string or null <date-time>
toUpdatedAt	string or null <date-time>
quickSearch	string
limitToOrdersForPlanning	boolean or null
createdBasedOnOrderId	string or null <guid>
responsible	string or null <guid>
responsibles	Array of strings <guid> [ items <guid > ]
consignor	string
withinArea	string or null <guid>
consignee	string
container	string
label	string
customer	string or null <guid>
customers	Array of strings <guid> [ items <guid > ]
excludeCustomers	Array of strings <guid> [ items <guid > ]
vendors	Array of strings <guid> [ items <guid > ]
excludeVendors	Array of strings <guid> [ items <guid > ]
transporters	Array of strings <guid> [ items <guid > ]
excludeTransporters	Array of strings <guid> [ items <guid > ]
predefinedFilter	string
	(OrderStatusFilter (string or null))
fromArea	string or null <guid>
fromAreas	Array of strings <guid> [ items <guid > ]
excludeFromAreas	Array of strings <guid> [ items <guid > ]
fromCountryCode	string
toArea	string or null <guid>
toAreas	Array of strings <guid> [ items <guid > ]
excludeToAreas	Array of strings <guid> [ items <guid > ]
toCountryCode	string
goodsTypeIds	Array of strings <guid> [ items <guid > ]
excludeGoodsTypeIds	Array of strings <guid> [ items <guid > ]
orderTypeIds	Array of strings <guid> [ items <guid > ]
serviceCodeIds	Array of strings <guid> [ items <guid > ]
excludeServiceCodeIds	Array of strings <guid> [ items <guid > ]
minGrossWeightKg	number or null <decimal>
maxGrossWeightKg	number or null <decimal>
grossWeight	string
hasDangerousGoods	boolean or null
excludeOrderTypeIds	Array of strings <guid> [ items <guid > ]
tripIds	Array of strings
bookingReference	string
airwaybillNumber	string
cusomtsReceiptNumber	string
customsGoodsNumber	string
customsMrnNumber	string
sources	Array of strings
excludeSources	Array of strings
	(CalculatedSumOfIncomeFilter (string or null))
	(CalculatedSumOfCostsFilter (string or null))
departments	Array of strings <guid> [ items <guid > ]
excludeDepartments	Array of strings <guid> [ items <guid > ]
declarationStatuses	Array of strings
excludeDeclarationStatuses	Array of strings
goodsRegistrationStatuses	Array of strings
excludeGoodsRegistrationStatuses	Array of strings
orderCostsStatuses	Array of strings
orderEconomicalStatuses	Array of strings
excludeOrderEconomicalStatuses	Array of strings
excludeOrderCostsStatuses	Array of strings
checkPointsCompletionStatus	Array of strings
excludeCheckPointsCompletionStatus	Array of strings
checkedItems	Array of strings <guid> [ items <guid > ]
excludeCheckedItems	Array of strings <guid> [ items <guid > ]
	object
	object
	object
	object
	object
	object
deliveryRouteNumber	string
	(OrderSortBy (string or null))
sortByAscending	boolean or null
tags	Array of strings <guid> [ items <guid > ]
excludeTags	Array of strings <guid> [ items <guid > ]
executingTransporter	Array of strings or null <guid> [ items <guid > ]
isContributionMarginPositive	boolean or null
incoterms	Array of strings <guid> [ items <guid > ]
excludeIncoterms	Array of strings <guid> [ items <guid > ]
	(SelectionBasis (string or null))
selectionException	Array of strings <guid> [ items <guid > ]
deliveryAddressGenericSearch	string
dispatchAddressGenericSearch	string
customerProject	string
take	integer or null <int32>
skip	integer or null <int32>

Responses

Response samples

200
400
default

Content type

application/json

[{"customerId": "string",
"goodsTypeId": "string",
"serviceCodeId": "string",
"responsible": "string",
"company": "string",
"department": "string",
"project": "string",
"consignmentId": "string",
"customersReference": "string",
"consigneesReference": "string",
"sendersReference": "string",
"bookingReference": "string",
"airwaybillNumber": "string",
"customerProject": "string",
"deliveryRouteNumber": "string",
"externalEdiReference": "string",
"externalOrderTypeCode": "string",
"externalSystemStatusName": "string",
"waybillText": "string",
"etd": {"start": "2019-08-24T14:15:22Z",
"end": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"pickupArrivalTime": {"dateTimeOffset": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"atd": {"dateTimeOffset": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"eta": {"start": "2019-08-24T14:15:22Z",
"end": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"deliveryArrivalTime": {"dateTimeOffset": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"ata": {"dateTimeOffset": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"consignor": {"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"poBox": "string",
"postCode": "string",
"city": "string",
"subDivision": "string",
"state": "string",
"countryCode": "string",
"addressType": "string",
"phoneNumber": "string",
"email": "string",
"contactName": "string",
"position": {"latitude": -90,
"longitude": -180
}
},
"consignee": {"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"poBox": "string",
"postCode": "string",
"city": "string",
"subDivision": "string",
"state": "string",
"countryCode": "string",
"addressType": "string",
"phoneNumber": "string",
"email": "string",
"contactName": "string",
"position": {"latitude": -90,
"longitude": -180
}
},
"deliveryAddress": {"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"poBox": "string",
"postCode": "string",
"city": "string",
"subDivision": "string",
"state": "string",
"countryCode": "string",
"addressType": "string",
"phoneNumber": "string",
"email": "string",
"contactName": "string",
"position": {"latitude": -90,
"longitude": -180
}
},
"dispatchAddress": {"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"poBox": "string",
"postCode": "string",
"city": "string",
"subDivision": "string",
"state": "string",
"countryCode": "string",
"addressType": "string",
"phoneNumber": "string",
"email": "string",
"contactName": "string",
"position": {"latitude": -90,
"longitude": -180
}
},
"paymentTerms": "string",
"incoterms": "string",
"incotermsPlace": "string",
"freightPayer": "string",
"freightPayerCustomAddress": {"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"poBox": "string",
"postCode": "string",
"city": "string",
"subDivision": "string",
"state": "string",
"countryCode": "string",
"addressType": "string",
"phoneNumber": "string",
"email": "string",
"contactName": "string",
"position": {"latitude": -90,
"longitude": -180
}
},
"internalNote": "string",
"messageToDriver": "string",
"deliveryImminentNotificationActivated": true,
"deliveryImminentNotificationEmailAddresses": "string",
"hoursSpent": 0,
"environmentEmissionCo2": 0,
"orderId": "string",
"orderNumber": 0,
"orderTypeId": "string",
"orderTypeName": "string",
"goodsTypeName": "string",
"serviceCodeName": "string",
"customerName": "string",
"createdBasedOnOrderId": "string",
"hasDangerousGoods": true,
"tags": "string",
"orderApprovalStatus": "string",
"orderPlanningStatus": "string",
"orderAssigningStatus": "string",
"orderDispatchStatus": "string",
"orderCommunicatedReceivedStatus": "string",
"orderDepartureStatus": "string",
"orderDeliveryStatus": "string",
"orderEconomicalStatus": "string",
"orderInvoiceStatus": "string",
"orderAccountingStatus": "string",
"orderCostsStatus": "string",
"goodsRegistrationStatus": "string",
"declarationStatus": "string",
"totals": {"numberOfPackages": 0,
"numberOfPallets": 0,
"palletPlaces": 0,
"grossWeightInKg": 0,
"netWeightInKg": 0,
"volumeInCubicMeters": 0,
"loadingMeters": 0,
"chargeableWeightInKg": 0,
"sumOfIncomeInBaseCurrency": 0,
"sumOfAllCostsInBaseCurrency": 0
}
}
]

CreateOrder

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

customerId required	string <guid>
goodsTypeId	string or null <guid>
serviceCodeId	string or null <guid>
responsible	string or null <guid>
company	string or null <guid>
department	string or null <guid>
project	string or null <guid>
consignmentId	string or null
customersReference	string or null
consigneesReference	string or null
sendersReference	string or null
bookingReference	string or null
airwaybillNumber	string or null
customerProject	string or null
deliveryRouteNumber	string or null
externalEdiReference	string or null
externalOrderTypeCode	string or null
externalSystemStatusName	string or null
waybillText	string or null
	(ZonedDateTimeRangeDto (object or null))
	(ZonedDateTime (object or null))
	(ZonedDateTimeDto (object or null))
	(ZonedDateTimeRangeDto (object or null))
	(ZonedDateTime (object or null))
	(ZonedDateTimeDto (object or null))
	(PublicAddressDto (object or null))
	(PublicAddressDto (object or null))
	(PublicAddressDto (object or null))
	(PublicAddressDto (object or null))
paymentTerms	string or null <guid>
incoterms	string or null <guid>
incotermsPlace	string or null
freightPayer required	string string of enum: FreightPayer KnownValues: [Sender, Receiver, Custom]
	(PublicAddressDto (object or null))
internalNote	string or null
messageToDriver	string or null
deliveryImminentNotificationActivated required	boolean
deliveryImminentNotificationEmailAddresses	string or null
hoursSpent	number or null <decimal> >= 0
environmentEmissionCo2	number or null <decimal> >= 0
orderTypeId	string or null <guid>
createdBasedOnOrderId	string or null <guid>

Responses

Request samples

Payload

Content type

application/json

{"customerId": "string",
"goodsTypeId": "string",
"serviceCodeId": "string",
"responsible": "string",
"company": "string",
"department": "string",
"project": "string",
"consignmentId": "string",
"customersReference": "string",
"consigneesReference": "string",
"sendersReference": "string",
"bookingReference": "string",
"airwaybillNumber": "string",
"customerProject": "string",
"deliveryRouteNumber": "string",
"externalEdiReference": "string",
"externalOrderTypeCode": "string",
"externalSystemStatusName": "string",
"waybillText": "string",
"etd": {"start": "2019-08-24T14:15:22Z",
"end": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"pickupArrivalTime": {"dateTimeOffset": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"atd": {"dateTimeOffset": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"eta": {"start": "2019-08-24T14:15:22Z",
"end": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"deliveryArrivalTime": {"dateTimeOffset": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"ata": {"dateTimeOffset": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"consignor": {"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"poBox": "string",
"postCode": "string",
"city": "string",
"subDivision": "string",
"state": "string",
"countryCode": "string",
"addressType": "string",
"phoneNumber": "string",
"email": "string",
"contactName": "string",
"position": {"latitude": -90,
"longitude": -180
}
},
"consignee": {"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"poBox": "string",
"postCode": "string",
"city": "string",
"subDivision": "string",
"state": "string",
"countryCode": "string",
"addressType": "string",
"phoneNumber": "string",
"email": "string",
"contactName": "string",
"position": {"latitude": -90,
"longitude": -180
}
},
"deliveryAddress": {"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"poBox": "string",
"postCode": "string",
"city": "string",
"subDivision": "string",
"state": "string",
"countryCode": "string",
"addressType": "string",
"phoneNumber": "string",
"email": "string",
"contactName": "string",
"position": {"latitude": -90,
"longitude": -180
}
},
"dispatchAddress": {"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"poBox": "string",
"postCode": "string",
"city": "string",
"subDivision": "string",
"state": "string",
"countryCode": "string",
"addressType": "string",
"phoneNumber": "string",
"email": "string",
"contactName": "string",
"position": {"latitude": -90,
"longitude": -180
}
},
"paymentTerms": "string",
"incoterms": "string",
"incotermsPlace": "string",
"freightPayer": "string",
"freightPayerCustomAddress": {"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"poBox": "string",
"postCode": "string",
"city": "string",
"subDivision": "string",
"state": "string",
"countryCode": "string",
"addressType": "string",
"phoneNumber": "string",
"email": "string",
"contactName": "string",
"position": {"latitude": -90,
"longitude": -180
}
},
"internalNote": "string",
"messageToDriver": "string",
"deliveryImminentNotificationActivated": true,
"deliveryImminentNotificationEmailAddresses": "string",
"hoursSpent": 0,
"environmentEmissionCo2": 0,
"orderTypeId": "string",
"createdBasedOnOrderId": "string"
}

Response samples

201
400
default

Content type

application/json

{"customerId": "string",
"goodsTypeId": "string",
"serviceCodeId": "string",
"responsible": "string",
"company": "string",
"department": "string",
"project": "string",
"consignmentId": "string",
"customersReference": "string",
"consigneesReference": "string",
"sendersReference": "string",
"bookingReference": "string",
"airwaybillNumber": "string",
"customerProject": "string",
"deliveryRouteNumber": "string",
"externalEdiReference": "string",
"externalOrderTypeCode": "string",
"externalSystemStatusName": "string",
"waybillText": "string",
"etd": {"start": "2019-08-24T14:15:22Z",
"end": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"pickupArrivalTime": {"dateTimeOffset": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"atd": {"dateTimeOffset": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"eta": {"start": "2019-08-24T14:15:22Z",
"end": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"deliveryArrivalTime": {"dateTimeOffset": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"ata": {"dateTimeOffset": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"consignor": {"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"poBox": "string",
"postCode": "string",
"city": "string",
"subDivision": "string",
"state": "string",
"countryCode": "string",
"addressType": "string",
"phoneNumber": "string",
"email": "string",
"contactName": "string",
"position": {"latitude": -90,
"longitude": -180
}
},
"consignee": {"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"poBox": "string",
"postCode": "string",
"city": "string",
"subDivision": "string",
"state": "string",
"countryCode": "string",
"addressType": "string",
"phoneNumber": "string",
"email": "string",
"contactName": "string",
"position": {"latitude": -90,
"longitude": -180
}
},
"deliveryAddress": {"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"poBox": "string",
"postCode": "string",
"city": "string",
"subDivision": "string",
"state": "string",
"countryCode": "string",
"addressType": "string",
"phoneNumber": "string",
"email": "string",
"contactName": "string",
"position": {"latitude": -90,
"longitude": -180
}
},
"dispatchAddress": {"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"poBox": "string",
"postCode": "string",
"city": "string",
"subDivision": "string",
"state": "string",
"countryCode": "string",
"addressType": "string",
"phoneNumber": "string",
"email": "string",
"contactName": "string",
"position": {"latitude": -90,
"longitude": -180
}
},
"paymentTerms": "string",
"incoterms": "string",
"incotermsPlace": "string",
"freightPayer": "string",
"freightPayerCustomAddress": {"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"poBox": "string",
"postCode": "string",
"city": "string",
"subDivision": "string",
"state": "string",
"countryCode": "string",
"addressType": "string",
"phoneNumber": "string",
"email": "string",
"contactName": "string",
"position": {"latitude": -90,
"longitude": -180
}
},
"internalNote": "string",
"messageToDriver": "string",
"deliveryImminentNotificationActivated": true,
"deliveryImminentNotificationEmailAddresses": "string",
"hoursSpent": 0,
"environmentEmissionCo2": 0,
"orderId": "string",
"orderNumber": 0,
"orderTypeId": "string",
"orderTypeName": "string",
"goodsTypeName": "string",
"serviceCodeName": "string",
"customerName": "string",
"createdBasedOnOrderId": "string",
"hasDangerousGoods": true,
"tags": "string",
"orderApprovalStatus": "string",
"orderPlanningStatus": "string",
"orderAssigningStatus": "string",
"orderDispatchStatus": "string",
"orderCommunicatedReceivedStatus": "string",
"orderDepartureStatus": "string",
"orderDeliveryStatus": "string",
"orderEconomicalStatus": "string",
"orderInvoiceStatus": "string",
"orderAccountingStatus": "string",
"orderCostsStatus": "string",
"goodsRegistrationStatus": "string",
"declarationStatus": "string",
"totals": {"numberOfPackages": 0,
"numberOfPallets": 0,
"palletPlaces": 0,
"grossWeightInKg": 0,
"netWeightInKg": 0,
"volumeInCubicMeters": 0,
"loadingMeters": 0,
"chargeableWeightInKg": 0,
"sumOfIncomeInBaseCurrency": 0,
"sumOfAllCostsInBaseCurrency": 0
}
}

GetOrderById

path Parameters

orderId

required

string <guid>

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

200
204
400
404
default

Content type

application/json

{"customerId": "string",
"goodsTypeId": "string",
"serviceCodeId": "string",
"responsible": "string",
"company": "string",
"department": "string",
"project": "string",
"consignmentId": "string",
"customersReference": "string",
"consigneesReference": "string",
"sendersReference": "string",
"bookingReference": "string",
"airwaybillNumber": "string",
"customerProject": "string",
"deliveryRouteNumber": "string",
"externalEdiReference": "string",
"externalOrderTypeCode": "string",
"externalSystemStatusName": "string",
"waybillText": "string",
"etd": {"start": "2019-08-24T14:15:22Z",
"end": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"pickupArrivalTime": {"dateTimeOffset": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"atd": {"dateTimeOffset": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"eta": {"start": "2019-08-24T14:15:22Z",
"end": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"deliveryArrivalTime": {"dateTimeOffset": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"ata": {"dateTimeOffset": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"consignor": {"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"poBox": "string",
"postCode": "string",
"city": "string",
"subDivision": "string",
"state": "string",
"countryCode": "string",
"addressType": "string",
"phoneNumber": "string",
"email": "string",
"contactName": "string",
"position": {"latitude": -90,
"longitude": -180
}
},
"consignee": {"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"poBox": "string",
"postCode": "string",
"city": "string",
"subDivision": "string",
"state": "string",
"countryCode": "string",
"addressType": "string",
"phoneNumber": "string",
"email": "string",
"contactName": "string",
"position": {"latitude": -90,
"longitude": -180
}
},
"deliveryAddress": {"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"poBox": "string",
"postCode": "string",
"city": "string",
"subDivision": "string",
"state": "string",
"countryCode": "string",
"addressType": "string",
"phoneNumber": "string",
"email": "string",
"contactName": "string",
"position": {"latitude": -90,
"longitude": -180
}
},
"dispatchAddress": {"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"poBox": "string",
"postCode": "string",
"city": "string",
"subDivision": "string",
"state": "string",
"countryCode": "string",
"addressType": "string",
"phoneNumber": "string",
"email": "string",
"contactName": "string",
"position": {"latitude": -90,
"longitude": -180
}
},
"paymentTerms": "string",
"incoterms": "string",
"incotermsPlace": "string",
"freightPayer": "string",
"freightPayerCustomAddress": {"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"poBox": "string",
"postCode": "string",
"city": "string",
"subDivision": "string",
"state": "string",
"countryCode": "string",
"addressType": "string",
"phoneNumber": "string",
"email": "string",
"contactName": "string",
"position": {"latitude": -90,
"longitude": -180
}
},
"internalNote": "string",
"messageToDriver": "string",
"deliveryImminentNotificationActivated": true,
"deliveryImminentNotificationEmailAddresses": "string",
"hoursSpent": 0,
"environmentEmissionCo2": 0,
"orderId": "string",
"orderNumber": 0,
"orderTypeId": "string",
"orderTypeName": "string",
"goodsTypeName": "string",
"serviceCodeName": "string",
"customerName": "string",
"createdBasedOnOrderId": "string",
"hasDangerousGoods": true,
"tags": "string",
"orderApprovalStatus": "string",
"orderPlanningStatus": "string",
"orderAssigningStatus": "string",
"orderDispatchStatus": "string",
"orderCommunicatedReceivedStatus": "string",
"orderDepartureStatus": "string",
"orderDeliveryStatus": "string",
"orderEconomicalStatus": "string",
"orderInvoiceStatus": "string",
"orderAccountingStatus": "string",
"orderCostsStatus": "string",
"goodsRegistrationStatus": "string",
"declarationStatus": "string",
"totals": {"numberOfPackages": 0,
"numberOfPallets": 0,
"palletPlaces": 0,
"grossWeightInKg": 0,
"netWeightInKg": 0,
"volumeInCubicMeters": 0,
"loadingMeters": 0,
"chargeableWeightInKg": 0,
"sumOfIncomeInBaseCurrency": 0,
"sumOfAllCostsInBaseCurrency": 0
}
}

UpdateOrder

path Parameters

orderId

required

string <guid>

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

customerId required	string <guid>
goodsTypeId	string or null <guid>
serviceCodeId	string or null <guid>
responsible	string or null <guid>
company	string or null <guid>
department	string or null <guid>
project	string or null <guid>
consignmentId	string or null
customersReference	string or null
consigneesReference	string or null
sendersReference	string or null
bookingReference	string or null
airwaybillNumber	string or null
customerProject	string or null
deliveryRouteNumber	string or null
externalEdiReference	string or null
externalOrderTypeCode	string or null
externalSystemStatusName	string or null
waybillText	string or null
	(ZonedDateTimeRangeDto (object or null))
	(ZonedDateTime (object or null))
	(ZonedDateTimeDto (object or null))
	(ZonedDateTimeRangeDto (object or null))
	(ZonedDateTime (object or null))
	(ZonedDateTimeDto (object or null))
	(PublicAddressDto (object or null))
	(PublicAddressDto (object or null))
	(PublicAddressDto (object or null))
	(PublicAddressDto (object or null))
paymentTerms	string or null <guid>
incoterms	string or null <guid>
incotermsPlace	string or null
freightPayer required	string string of enum: FreightPayer KnownValues: [Sender, Receiver, Custom]
	(PublicAddressDto (object or null))
internalNote	string or null
messageToDriver	string or null
deliveryImminentNotificationActivated required	boolean
deliveryImminentNotificationEmailAddresses	string or null
hoursSpent	number or null <decimal> >= 0
environmentEmissionCo2	number or null <decimal> >= 0
orderTypeId required	string <guid>
tags	string or null

Responses

Request samples

Payload

Content type

application/json

{"customerId": "string",
"goodsTypeId": "string",
"serviceCodeId": "string",
"responsible": "string",
"company": "string",
"department": "string",
"project": "string",
"consignmentId": "string",
"customersReference": "string",
"consigneesReference": "string",
"sendersReference": "string",
"bookingReference": "string",
"airwaybillNumber": "string",
"customerProject": "string",
"deliveryRouteNumber": "string",
"externalEdiReference": "string",
"externalOrderTypeCode": "string",
"externalSystemStatusName": "string",
"waybillText": "string",
"etd": {"start": "2019-08-24T14:15:22Z",
"end": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"pickupArrivalTime": {"dateTimeOffset": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"atd": {"dateTimeOffset": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"eta": {"start": "2019-08-24T14:15:22Z",
"end": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"deliveryArrivalTime": {"dateTimeOffset": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"ata": {"dateTimeOffset": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"consignor": {"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"poBox": "string",
"postCode": "string",
"city": "string",
"subDivision": "string",
"state": "string",
"countryCode": "string",
"addressType": "string",
"phoneNumber": "string",
"email": "string",
"contactName": "string",
"position": {"latitude": -90,
"longitude": -180
}
},
"consignee": {"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"poBox": "string",
"postCode": "string",
"city": "string",
"subDivision": "string",
"state": "string",
"countryCode": "string",
"addressType": "string",
"phoneNumber": "string",
"email": "string",
"contactName": "string",
"position": {"latitude": -90,
"longitude": -180
}
},
"deliveryAddress": {"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"poBox": "string",
"postCode": "string",
"city": "string",
"subDivision": "string",
"state": "string",
"countryCode": "string",
"addressType": "string",
"phoneNumber": "string",
"email": "string",
"contactName": "string",
"position": {"latitude": -90,
"longitude": -180
}
},
"dispatchAddress": {"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"poBox": "string",
"postCode": "string",
"city": "string",
"subDivision": "string",
"state": "string",
"countryCode": "string",
"addressType": "string",
"phoneNumber": "string",
"email": "string",
"contactName": "string",
"position": {"latitude": -90,
"longitude": -180
}
},
"paymentTerms": "string",
"incoterms": "string",
"incotermsPlace": "string",
"freightPayer": "string",
"freightPayerCustomAddress": {"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"poBox": "string",
"postCode": "string",
"city": "string",
"subDivision": "string",
"state": "string",
"countryCode": "string",
"addressType": "string",
"phoneNumber": "string",
"email": "string",
"contactName": "string",
"position": {"latitude": -90,
"longitude": -180
}
},
"internalNote": "string",
"messageToDriver": "string",
"deliveryImminentNotificationActivated": true,
"deliveryImminentNotificationEmailAddresses": "string",
"hoursSpent": 0,
"environmentEmissionCo2": 0,
"orderTypeId": "string",
"tags": "string"
}

Response samples

200
204
400
404
default

Content type

application/json

{"customerId": "string",
"goodsTypeId": "string",
"serviceCodeId": "string",
"responsible": "string",
"company": "string",
"department": "string",
"project": "string",
"consignmentId": "string",
"customersReference": "string",
"consigneesReference": "string",
"sendersReference": "string",
"bookingReference": "string",
"airwaybillNumber": "string",
"customerProject": "string",
"deliveryRouteNumber": "string",
"externalEdiReference": "string",
"externalOrderTypeCode": "string",
"externalSystemStatusName": "string",
"waybillText": "string",
"etd": {"start": "2019-08-24T14:15:22Z",
"end": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"pickupArrivalTime": {"dateTimeOffset": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"atd": {"dateTimeOffset": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"eta": {"start": "2019-08-24T14:15:22Z",
"end": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"deliveryArrivalTime": {"dateTimeOffset": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"ata": {"dateTimeOffset": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"consignor": {"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"poBox": "string",
"postCode": "string",
"city": "string",
"subDivision": "string",
"state": "string",
"countryCode": "string",
"addressType": "string",
"phoneNumber": "string",
"email": "string",
"contactName": "string",
"position": {"latitude": -90,
"longitude": -180
}
},
"consignee": {"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"poBox": "string",
"postCode": "string",
"city": "string",
"subDivision": "string",
"state": "string",
"countryCode": "string",
"addressType": "string",
"phoneNumber": "string",
"email": "string",
"contactName": "string",
"position": {"latitude": -90,
"longitude": -180
}
},
"deliveryAddress": {"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"poBox": "string",
"postCode": "string",
"city": "string",
"subDivision": "string",
"state": "string",
"countryCode": "string",
"addressType": "string",
"phoneNumber": "string",
"email": "string",
"contactName": "string",
"position": {"latitude": -90,
"longitude": -180
}
},
"dispatchAddress": {"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"poBox": "string",
"postCode": "string",
"city": "string",
"subDivision": "string",
"state": "string",
"countryCode": "string",
"addressType": "string",
"phoneNumber": "string",
"email": "string",
"contactName": "string",
"position": {"latitude": -90,
"longitude": -180
}
},
"paymentTerms": "string",
"incoterms": "string",
"incotermsPlace": "string",
"freightPayer": "string",
"freightPayerCustomAddress": {"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"poBox": "string",
"postCode": "string",
"city": "string",
"subDivision": "string",
"state": "string",
"countryCode": "string",
"addressType": "string",
"phoneNumber": "string",
"email": "string",
"contactName": "string",
"position": {"latitude": -90,
"longitude": -180
}
},
"internalNote": "string",
"messageToDriver": "string",
"deliveryImminentNotificationActivated": true,
"deliveryImminentNotificationEmailAddresses": "string",
"hoursSpent": 0,
"environmentEmissionCo2": 0,
"orderId": "string",
"orderNumber": 0,
"orderTypeId": "string",
"orderTypeName": "string",
"goodsTypeName": "string",
"serviceCodeName": "string",
"customerName": "string",
"createdBasedOnOrderId": "string",
"hasDangerousGoods": true,
"tags": "string",
"orderApprovalStatus": "string",
"orderPlanningStatus": "string",
"orderAssigningStatus": "string",
"orderDispatchStatus": "string",
"orderCommunicatedReceivedStatus": "string",
"orderDepartureStatus": "string",
"orderDeliveryStatus": "string",
"orderEconomicalStatus": "string",
"orderInvoiceStatus": "string",
"orderAccountingStatus": "string",
"orderCostsStatus": "string",
"goodsRegistrationStatus": "string",
"declarationStatus": "string",
"totals": {"numberOfPackages": 0,
"numberOfPallets": 0,
"palletPlaces": 0,
"grossWeightInKg": 0,
"netWeightInKg": 0,
"volumeInCubicMeters": 0,
"loadingMeters": 0,
"chargeableWeightInKg": 0,
"sumOfIncomeInBaseCurrency": 0,
"sumOfAllCostsInBaseCurrency": 0
}
}

GetOrderLines

path Parameters

orderId

required

string <guid>

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

200
400
default

Content type

application/json

[{"numberOfPackages": 0,
"numberOfPallets": 0,
"packagingType": "string",
"label": "string",
"itemCode": "string",
"itemDescription": "string",
"sealNumber": "string",
"containerNumber": "string",
"containerTypeId": "string",
"containerId": "string",
"palletPlaces": 0,
"tareInKg": 0,
"netWeightInKg": 0,
"grossWeightInKg": 0,
"verifiedGrossMassInKg": 0,
"volumeInCubicMeters": 0,
"lengthInMeters": 0,
"widthInMeters": 0,
"heightInMeters": 0,
"lengthInMetersPerPackage": 0,
"widthInMetersPerPackage": 0,
"heightInMetersPerPackage": 0,
"loadingMeters": 0,
"chargeableWeightInKg": 0,
"dangerousGoodsClass": 0,
"unNumber": 0,
"externalReferenceNumber": "string",
"orderLineId": "string",
"lineNumber": 0,
"containerTypeName": "string",
"containerName": "string",
"packages": [{"packageId": "string",
"packageNumber": 0,
"packageSSCC": "string",
"orderLineId": "string"
}
]
}
]

CreateOrderLine

path Parameters

orderId

required

string <guid>

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

numberOfPackages required	integer <int32> [ 0 .. 2147483647 ]
numberOfPallets required	integer <int32> [ 0 .. 2147483647 ]
packagingType	string or null
label	string or null
itemCode	string or null
itemDescription	string or null
sealNumber	string or null
containerNumber	string or null
containerTypeId	string or null <guid>
containerId	string or null <guid>
palletPlaces required	number <decimal> >= 0
tareInKg	number or null <decimal> >= 0
netWeightInKg required	number <decimal> >= 0
grossWeightInKg required	number <decimal> >= 0
verifiedGrossMassInKg	number or null <decimal> >= 0
volumeInCubicMeters required	number <decimal> >= 0
lengthInMeters required	number <decimal> >= 0
widthInMeters required	number <decimal> >= 0
heightInMeters required	number <decimal> >= 0
lengthInMetersPerPackage required	number <decimal> >= 0
widthInMetersPerPackage required	number <decimal> >= 0
heightInMetersPerPackage required	number <decimal> >= 0
loadingMeters required	number <decimal> >= 0
chargeableWeightInKg required	number <decimal> >= 0
dangerousGoodsClass	integer or null <int32> [ 0 .. 2147483647 ]
unNumber	integer or null <int32> [ 0 .. 2147483647 ]
externalReferenceNumber	string or null

Responses

Request samples

Payload

Content type

application/json

{"numberOfPackages": 0,
"numberOfPallets": 0,
"packagingType": "string",
"label": "string",
"itemCode": "string",
"itemDescription": "string",
"sealNumber": "string",
"containerNumber": "string",
"containerTypeId": "string",
"containerId": "string",
"palletPlaces": 0,
"tareInKg": 0,
"netWeightInKg": 0,
"grossWeightInKg": 0,
"verifiedGrossMassInKg": 0,
"volumeInCubicMeters": 0,
"lengthInMeters": 0,
"widthInMeters": 0,
"heightInMeters": 0,
"lengthInMetersPerPackage": 0,
"widthInMetersPerPackage": 0,
"heightInMetersPerPackage": 0,
"loadingMeters": 0,
"chargeableWeightInKg": 0,
"dangerousGoodsClass": 0,
"unNumber": 0,
"externalReferenceNumber": "string"
}

Response samples

201
400
default

Content type

application/json

{"numberOfPackages": 0,
"numberOfPallets": 0,
"packagingType": "string",
"label": "string",
"itemCode": "string",
"itemDescription": "string",
"sealNumber": "string",
"containerNumber": "string",
"containerTypeId": "string",
"containerId": "string",
"palletPlaces": 0,
"tareInKg": 0,
"netWeightInKg": 0,
"grossWeightInKg": 0,
"verifiedGrossMassInKg": 0,
"volumeInCubicMeters": 0,
"lengthInMeters": 0,
"widthInMeters": 0,
"heightInMeters": 0,
"lengthInMetersPerPackage": 0,
"widthInMetersPerPackage": 0,
"heightInMetersPerPackage": 0,
"loadingMeters": 0,
"chargeableWeightInKg": 0,
"dangerousGoodsClass": 0,
"unNumber": 0,
"externalReferenceNumber": "string",
"orderLineId": "string",
"lineNumber": 0,
"containerTypeName": "string",
"containerName": "string",
"packages": [{"packageId": "string",
"packageNumber": 0,
"packageSSCC": "string",
"orderLineId": "string"
}
]
}

GetOrderLine

path Parameters

orderId required	string <guid>
lineId required	string <guid>

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

200
204
400
404
default

Content type

application/json

{"numberOfPackages": 0,
"numberOfPallets": 0,
"packagingType": "string",
"label": "string",
"itemCode": "string",
"itemDescription": "string",
"sealNumber": "string",
"containerNumber": "string",
"containerTypeId": "string",
"containerId": "string",
"palletPlaces": 0,
"tareInKg": 0,
"netWeightInKg": 0,
"grossWeightInKg": 0,
"verifiedGrossMassInKg": 0,
"volumeInCubicMeters": 0,
"lengthInMeters": 0,
"widthInMeters": 0,
"heightInMeters": 0,
"lengthInMetersPerPackage": 0,
"widthInMetersPerPackage": 0,
"heightInMetersPerPackage": 0,
"loadingMeters": 0,
"chargeableWeightInKg": 0,
"dangerousGoodsClass": 0,
"unNumber": 0,
"externalReferenceNumber": "string",
"orderLineId": "string",
"lineNumber": 0,
"containerTypeName": "string",
"containerName": "string",
"packages": [{"packageId": "string",
"packageNumber": 0,
"packageSSCC": "string",
"orderLineId": "string"
}
]
}

UpdateOrderLine

path Parameters

orderId required	string <guid>
lineId required	string <guid>

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

numberOfPackages required	integer <int32> [ 0 .. 2147483647 ]
numberOfPallets required	integer <int32> [ 0 .. 2147483647 ]
packagingType	string or null
label	string or null
itemCode	string or null
itemDescription	string or null
sealNumber	string or null
containerNumber	string or null
containerTypeId	string or null <guid>
containerId	string or null <guid>
palletPlaces required	number <decimal> >= 0
tareInKg	number or null <decimal> >= 0
netWeightInKg required	number <decimal> >= 0
grossWeightInKg required	number <decimal> >= 0
verifiedGrossMassInKg	number or null <decimal> >= 0
volumeInCubicMeters required	number <decimal> >= 0
lengthInMeters required	number <decimal> >= 0
widthInMeters required	number <decimal> >= 0
heightInMeters required	number <decimal> >= 0
lengthInMetersPerPackage required	number <decimal> >= 0
widthInMetersPerPackage required	number <decimal> >= 0
heightInMetersPerPackage required	number <decimal> >= 0
loadingMeters required	number <decimal> >= 0
chargeableWeightInKg required	number <decimal> >= 0
dangerousGoodsClass	integer or null <int32> [ 0 .. 2147483647 ]
unNumber	integer or null <int32> [ 0 .. 2147483647 ]
externalReferenceNumber	string or null

Responses

Request samples

Payload

Content type

application/json

{"numberOfPackages": 0,
"numberOfPallets": 0,
"packagingType": "string",
"label": "string",
"itemCode": "string",
"itemDescription": "string",
"sealNumber": "string",
"containerNumber": "string",
"containerTypeId": "string",
"containerId": "string",
"palletPlaces": 0,
"tareInKg": 0,
"netWeightInKg": 0,
"grossWeightInKg": 0,
"verifiedGrossMassInKg": 0,
"volumeInCubicMeters": 0,
"lengthInMeters": 0,
"widthInMeters": 0,
"heightInMeters": 0,
"lengthInMetersPerPackage": 0,
"widthInMetersPerPackage": 0,
"heightInMetersPerPackage": 0,
"loadingMeters": 0,
"chargeableWeightInKg": 0,
"dangerousGoodsClass": 0,
"unNumber": 0,
"externalReferenceNumber": "string"
}

Response samples

200
204
400
default

Content type

application/json

{"numberOfPackages": 0,
"numberOfPallets": 0,
"packagingType": "string",
"label": "string",
"itemCode": "string",
"itemDescription": "string",
"sealNumber": "string",
"containerNumber": "string",
"containerTypeId": "string",
"containerId": "string",
"palletPlaces": 0,
"tareInKg": 0,
"netWeightInKg": 0,
"grossWeightInKg": 0,
"verifiedGrossMassInKg": 0,
"volumeInCubicMeters": 0,
"lengthInMeters": 0,
"widthInMeters": 0,
"heightInMeters": 0,
"lengthInMetersPerPackage": 0,
"widthInMetersPerPackage": 0,
"heightInMetersPerPackage": 0,
"loadingMeters": 0,
"chargeableWeightInKg": 0,
"dangerousGoodsClass": 0,
"unNumber": 0,
"externalReferenceNumber": "string",
"orderLineId": "string",
"lineNumber": 0,
"containerTypeName": "string",
"containerName": "string",
"packages": [{"packageId": "string",
"packageNumber": 0,
"packageSSCC": "string",
"orderLineId": "string"
}
]
}

GetPricings

path Parameters

orderId

required

string <guid>

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>
take	integer or null <int32>
skip	integer or null <int32>

Responses

Response samples

200
400
default

Content type

application/json

[{"customerId": "string",
"pricingType": "string",
"description": "string",
"invoiceHeader": "string",
"invoiceFooter": "string",
"invoiceInformation": "string",
"referencePricingId": "string",
"billingMethod": "string",
"pricingId": "string",
"pricingNumber": 0,
"createdAt": "2019-08-24T14:15:22Z",
"exchangeRateFromInvoiceCurrencyToBaseCurrency": 0,
"pricingLines": [{"type": "string",
"description": "string",
"basis": 1,
"rate": 0,
"discount": 0,
"currency": "string",
"exchangeRateToInvoiceCurrency": 0,
"pricingLineId": "string",
"pricingId": "string",
"matchedToSettlementNumber": "string",
"matchedSettlementDate": "2019-08-24T14:15:22Z",
"matchedToSettlementAt": "2019-08-24T14:15:22Z",
"source": "string",
"status": "string",
"accountingStatus": "string"
}
],
"calculatedSumOfIncomeInBaseCurrency": 0,
"netAmountInBaseCurrency": 0,
"pricingInvoiceStatus": "string",
"pricingAccountingStatus": "string",
"orderId": "string",
"invoiceId": "string",
"invoiceNumber": 0,
"matchedSettlementOrInvoiceDate": "2019-08-24T14:15:22Z",
"customerName": "string",
"invoicedAt": "2019-08-24T14:15:22Z",
"postedAt": "2019-08-24T14:15:22Z",
"eventDate": "2019-08-24T14:15:22Z",
"invoiceCurrency": "string"
}
]

CreatePricing

path Parameters

orderId

required

string <guid>

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

customerId required	string <guid>
pricingType required	string string of enum: PricingType KnownValues: [Normal, Credit]
description	string or null
invoiceHeader	string or null
invoiceFooter	string or null
invoiceInformation	string or null
referencePricingId	string or null <guid>
billingMethod required	string string of enum: PricingBillingMethod KnownValues: [Invoice, Settlement]
orderId required	string <guid>
eventDate	string or null <date-time>
	Array of objects or null (CreatePublicPricingLineDto)

Responses

Request samples

Payload

Content type

application/json

{"customerId": "string",
"pricingType": "string",
"description": "string",
"invoiceHeader": "string",
"invoiceFooter": "string",
"invoiceInformation": "string",
"referencePricingId": "string",
"billingMethod": "string",
"orderId": "string",
"eventDate": "2019-08-24T14:15:22Z",
"pricingLines": [{"type": "string",
"description": "string",
"basis": 1,
"rate": 0,
"discount": 0,
"currency": "string",
"exchangeRateToInvoiceCurrency": 0
}
]
}

Response samples

201
400
default

Content type

application/json

{"customerId": "string",
"pricingType": "string",
"description": "string",
"invoiceHeader": "string",
"invoiceFooter": "string",
"invoiceInformation": "string",
"referencePricingId": "string",
"billingMethod": "string",
"pricingId": "string",
"pricingNumber": 0,
"createdAt": "2019-08-24T14:15:22Z",
"exchangeRateFromInvoiceCurrencyToBaseCurrency": 0,
"pricingLines": [{"type": "string",
"description": "string",
"basis": 1,
"rate": 0,
"discount": 0,
"currency": "string",
"exchangeRateToInvoiceCurrency": 0,
"pricingLineId": "string",
"pricingId": "string",
"matchedToSettlementNumber": "string",
"matchedSettlementDate": "2019-08-24T14:15:22Z",
"matchedToSettlementAt": "2019-08-24T14:15:22Z",
"source": "string",
"status": "string",
"accountingStatus": "string"
}
],
"calculatedSumOfIncomeInBaseCurrency": 0,
"netAmountInBaseCurrency": 0,
"pricingInvoiceStatus": "string",
"pricingAccountingStatus": "string",
"orderId": "string",
"invoiceId": "string",
"invoiceNumber": 0,
"matchedSettlementOrInvoiceDate": "2019-08-24T14:15:22Z",
"customerName": "string",
"invoicedAt": "2019-08-24T14:15:22Z",
"postedAt": "2019-08-24T14:15:22Z",
"eventDate": "2019-08-24T14:15:22Z",
"invoiceCurrency": "string"
}

UpdatePricing

path Parameters

orderId required	string <guid>
pricingId required	string <guid>

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

customerId required	string <guid>
pricingType required	string string of enum: PricingType KnownValues: [Normal, Credit]
description	string or null
invoiceHeader	string or null
invoiceFooter	string or null
invoiceInformation	string or null
referencePricingId	string or null <guid>
billingMethod required	string string of enum: PricingBillingMethod KnownValues: [Invoice, Settlement]
invoiceCurrency	string or null

Responses

Request samples

Payload

Content type

application/json

{"customerId": "string",
"pricingType": "string",
"description": "string",
"invoiceHeader": "string",
"invoiceFooter": "string",
"invoiceInformation": "string",
"referencePricingId": "string",
"billingMethod": "string",
"invoiceCurrency": "string"
}

Response samples

200
204
400
404
default

Content type

application/json

{"customerId": "string",
"pricingType": "string",
"description": "string",
"invoiceHeader": "string",
"invoiceFooter": "string",
"invoiceInformation": "string",
"referencePricingId": "string",
"billingMethod": "string",
"pricingId": "string",
"pricingNumber": 0,
"createdAt": "2019-08-24T14:15:22Z",
"exchangeRateFromInvoiceCurrencyToBaseCurrency": 0,
"pricingLines": [{"type": "string",
"description": "string",
"basis": 1,
"rate": 0,
"discount": 0,
"currency": "string",
"exchangeRateToInvoiceCurrency": 0,
"pricingLineId": "string",
"pricingId": "string",
"matchedToSettlementNumber": "string",
"matchedSettlementDate": "2019-08-24T14:15:22Z",
"matchedToSettlementAt": "2019-08-24T14:15:22Z",
"source": "string",
"status": "string",
"accountingStatus": "string"
}
],
"calculatedSumOfIncomeInBaseCurrency": 0,
"netAmountInBaseCurrency": 0,
"pricingInvoiceStatus": "string",
"pricingAccountingStatus": "string",
"orderId": "string",
"invoiceId": "string",
"invoiceNumber": 0,
"matchedSettlementOrInvoiceDate": "2019-08-24T14:15:22Z",
"customerName": "string",
"invoicedAt": "2019-08-24T14:15:22Z",
"postedAt": "2019-08-24T14:15:22Z",
"eventDate": "2019-08-24T14:15:22Z",
"invoiceCurrency": "string"
}

CreatePricingLine

path Parameters

orderId required	string <guid>
pricingId required	string <guid>

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

type required	string <guid>
description	string or null
basis required	number <decimal> >= 1
rate required	number <decimal> >= 0
discount required	number <decimal> [ 0 .. 100 ]
currency	string or null
exchangeRateToInvoiceCurrency required	number <decimal> >= 0

Responses

Request samples

Payload

Content type

application/json

{"type": "string",
"description": "string",
"basis": 1,
"rate": 0,
"discount": 0,
"currency": "string",
"exchangeRateToInvoiceCurrency": 0
}

Response samples

201
400
404
default

Content type

application/json

{"type": "string",
"description": "string",
"basis": 1,
"rate": 0,
"discount": 0,
"currency": "string",
"exchangeRateToInvoiceCurrency": 0,
"pricingLineId": "string",
"pricingId": "string",
"matchedToSettlementNumber": "string",
"matchedSettlementDate": "2019-08-24T14:15:22Z",
"matchedToSettlementAt": "2019-08-24T14:15:22Z",
"source": "string",
"status": "string",
"accountingStatus": "string"
}

UpdatePricingLine

path Parameters

orderId required	string <guid>
pricingId required	string <guid>
lineId required	string <guid>

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

type required	string <guid>
description	string or null
basis required	number <decimal> >= 1
rate required	number <decimal> >= 0
discount required	number <decimal> [ 0 .. 100 ]
currency	string or null
exchangeRateToInvoiceCurrency required	number <decimal> >= 0

Responses

Request samples

Payload

Content type

application/json

{"type": "string",
"description": "string",
"basis": 1,
"rate": 0,
"discount": 0,
"currency": "string",
"exchangeRateToInvoiceCurrency": 0
}

Response samples

200
204
400
404
default

Content type

application/json

{"type": "string",
"description": "string",
"basis": 1,
"rate": 0,
"discount": 0,
"currency": "string",
"exchangeRateToInvoiceCurrency": 0,
"pricingLineId": "string",
"pricingId": "string",
"matchedToSettlementNumber": "string",
"matchedSettlementDate": "2019-08-24T14:15:22Z",
"matchedToSettlementAt": "2019-08-24T14:15:22Z",
"source": "string",
"status": "string",
"accountingStatus": "string"
}

TMSTransportationTasks

GetAllTasks

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>
isAssigned	boolean or null
isDispatched	boolean or null
isPickupTask	boolean or null
isDeliveryTask	boolean or null
dateTimeRange	string
fitsTripId	string
taskIds	string
etdRange	string
etaRange	string
grossWeight	string
dispatchAddressGenericSearch	string
deliveryAddressGenericSearch	string
fromArea	string or null <guid>
fromCountryCode	string
toArea	string or null <guid>
toCountryCode	string
orderType	string or null <guid>
responsibleId	string or null <guid>
responsibleIds	Array of strings <guid> [ items <guid > ]
	(TaskType (string or null))
quickSearch	string
incomingGoodsReady	boolean or null
goodsTypeIds	Array of strings <guid> [ items <guid > ]
excludeGoodsTypeIds	Array of strings <guid> [ items <guid > ]
orderTypeIds	Array of strings <guid> [ items <guid > ]
excludeOrderTypeIds	Array of strings <guid> [ items <guid > ]
deliveryRouteNumber	string
serviceCodeIds	Array of strings <guid> [ items <guid > ]
tags	Array of strings <guid> [ items <guid > ]
excludeTags	Array of strings <guid> [ items <guid > ]
teamIds	Array of strings <guid> [ items <guid > ]
	(TaskSortBy (string or null))
sortByAscending	boolean or null
	(LoadingUnitAllocationStatus (string or null))
modeOfTransport	string
tripTypeId	string or null <guid>
vehicleId	string or null <guid>
loadCarrierId	string or null <guid>
tripKind	string
customerProject	string
take	integer or null <int32>
skip	integer or null <int32>

Responses

Response samples

200
400
default

Content type

application/json

[{"taskId": "string",
"orderId": "string",
"assigneeType": "string",
"tripId": "string",
"externalOrderId": "string",
"etd": {"start": "2019-08-24T14:15:22Z",
"end": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"atd": {"dateTimeOffset": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"eta": {"start": "2019-08-24T14:15:22Z",
"end": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"ata": {"dateTimeOffset": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"dispatchAddress": {"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"poBox": "string",
"postCode": "string",
"city": "string",
"subDivision": "string",
"state": "string",
"countryCode": "string",
"addressType": "string",
"phoneNumber": "string",
"email": "string",
"contactName": "string",
"position": {"latitude": -90,
"longitude": -180
}
},
"deliveryAddress": {"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"poBox": "string",
"postCode": "string",
"city": "string",
"subDivision": "string",
"state": "string",
"countryCode": "string",
"addressType": "string",
"phoneNumber": "string",
"email": "string",
"contactName": "string",
"position": {"latitude": -90,
"longitude": -180
}
},
"numberOfPackages": 0,
"numberOfPallets": 0,
"palletPlaces": 0,
"netWeightInKg": 0,
"grossWeightInKg": 0,
"volumeInCubicMeters": 0,
"chargeableWeightInKg": 0,
"loadingMeters": 0,
"isPrecedingTaskReceived": true,
"isParallellSplit": true,
"isAssigned": true,
"isDispatched": true,
"isCommunicatedReceived": true,
"isPickupTask": true,
"isDeliveryTask": true,
"proofOfPickup": {"name": "string",
"signature": [[{"x": 0,
"y": 0
}
]
],
"signatureImageAttachmentId": "string",
"position": {"latitude": 0.1,
"longitude": 0.1
},
"time": {"dateTimeOffset": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"arrivalTime": "2019-08-24T14:15:22Z",
"waitingTime": 0.1,
"freeText": "string",
"customerWasPresent": true,
"executedBy": "string",
"scannedPackages": [{"id": "string",
"licensePlate": "string",
"palletNumber": "string"
}
]
},
"proofOfDelivery": {"name": "string",
"signature": [[{"x": 0,
"y": 0
}
]
],
"signatureImageAttachmentId": "string",
"position": {"latitude": 0.1,
"longitude": 0.1
},
"time": {"dateTimeOffset": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"arrivalTime": "2019-08-24T14:15:22Z",
"waitingTime": 0.1,
"freeText": "string",
"customerWasPresent": true,
"executedBy": "string",
"scannedPackages": [{"id": "string",
"licensePlate": "string",
"palletNumber": "string"
}
]
},
"taskNumber": 0,
"orderNumber": 0,
"tags": "string"
}
]

GetTaskById

path Parameters

taskId

required

string <guid>

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

200
204
400
404
default

Content type

application/json

{"taskId": "string",
"orderId": "string",
"assigneeType": "string",
"tripId": "string",
"externalOrderId": "string",
"etd": {"start": "2019-08-24T14:15:22Z",
"end": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"atd": {"dateTimeOffset": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"eta": {"start": "2019-08-24T14:15:22Z",
"end": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"ata": {"dateTimeOffset": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"dispatchAddress": {"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"poBox": "string",
"postCode": "string",
"city": "string",
"subDivision": "string",
"state": "string",
"countryCode": "string",
"addressType": "string",
"phoneNumber": "string",
"email": "string",
"contactName": "string",
"position": {"latitude": -90,
"longitude": -180
}
},
"deliveryAddress": {"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"poBox": "string",
"postCode": "string",
"city": "string",
"subDivision": "string",
"state": "string",
"countryCode": "string",
"addressType": "string",
"phoneNumber": "string",
"email": "string",
"contactName": "string",
"position": {"latitude": -90,
"longitude": -180
}
},
"numberOfPackages": 0,
"numberOfPallets": 0,
"palletPlaces": 0,
"netWeightInKg": 0,
"grossWeightInKg": 0,
"volumeInCubicMeters": 0,
"chargeableWeightInKg": 0,
"loadingMeters": 0,
"isPrecedingTaskReceived": true,
"isParallellSplit": true,
"isAssigned": true,
"isDispatched": true,
"isCommunicatedReceived": true,
"isPickupTask": true,
"isDeliveryTask": true,
"proofOfPickup": {"name": "string",
"signature": [[{"x": 0,
"y": 0
}
]
],
"signatureImageAttachmentId": "string",
"position": {"latitude": 0.1,
"longitude": 0.1
},
"time": {"dateTimeOffset": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"arrivalTime": "2019-08-24T14:15:22Z",
"waitingTime": 0.1,
"freeText": "string",
"customerWasPresent": true,
"executedBy": "string",
"scannedPackages": [{"id": "string",
"licensePlate": "string",
"palletNumber": "string"
}
]
},
"proofOfDelivery": {"name": "string",
"signature": [[{"x": 0,
"y": 0
}
]
],
"signatureImageAttachmentId": "string",
"position": {"latitude": 0.1,
"longitude": 0.1
},
"time": {"dateTimeOffset": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"arrivalTime": "2019-08-24T14:15:22Z",
"waitingTime": 0.1,
"freeText": "string",
"customerWasPresent": true,
"executedBy": "string",
"scannedPackages": [{"id": "string",
"licensePlate": "string",
"palletNumber": "string"
}
]
},
"taskNumber": 0,
"orderNumber": 0,
"tags": "string"
}

UnassignTask

path Parameters

taskId

required

string <guid>

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>
removeCostsEvenReady	boolean or null

Responses

Response samples

200
204
400
404
default

Content type

application/json

{"taskId": "string",
"orderId": "string",
"assigneeType": "string",
"tripId": "string",
"externalOrderId": "string",
"etd": {"start": "2019-08-24T14:15:22Z",
"end": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"atd": {"dateTimeOffset": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"eta": {"start": "2019-08-24T14:15:22Z",
"end": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"ata": {"dateTimeOffset": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"dispatchAddress": {"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"poBox": "string",
"postCode": "string",
"city": "string",
"subDivision": "string",
"state": "string",
"countryCode": "string",
"addressType": "string",
"phoneNumber": "string",
"email": "string",
"contactName": "string",
"position": {"latitude": -90,
"longitude": -180
}
},
"deliveryAddress": {"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"poBox": "string",
"postCode": "string",
"city": "string",
"subDivision": "string",
"state": "string",
"countryCode": "string",
"addressType": "string",
"phoneNumber": "string",
"email": "string",
"contactName": "string",
"position": {"latitude": -90,
"longitude": -180
}
},
"numberOfPackages": 0,
"numberOfPallets": 0,
"palletPlaces": 0,
"netWeightInKg": 0,
"grossWeightInKg": 0,
"volumeInCubicMeters": 0,
"chargeableWeightInKg": 0,
"loadingMeters": 0,
"isPrecedingTaskReceived": true,
"isParallellSplit": true,
"isAssigned": true,
"isDispatched": true,
"isCommunicatedReceived": true,
"isPickupTask": true,
"isDeliveryTask": true,
"proofOfPickup": {"name": "string",
"signature": [[{"x": 0,
"y": 0
}
]
],
"signatureImageAttachmentId": "string",
"position": {"latitude": 0.1,
"longitude": 0.1
},
"time": {"dateTimeOffset": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"arrivalTime": "2019-08-24T14:15:22Z",
"waitingTime": 0.1,
"freeText": "string",
"customerWasPresent": true,
"executedBy": "string",
"scannedPackages": [{"id": "string",
"licensePlate": "string",
"palletNumber": "string"
}
]
},
"proofOfDelivery": {"name": "string",
"signature": [[{"x": 0,
"y": 0
}
]
],
"signatureImageAttachmentId": "string",
"position": {"latitude": 0.1,
"longitude": 0.1
},
"time": {"dateTimeOffset": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"arrivalTime": "2019-08-24T14:15:22Z",
"waitingTime": 0.1,
"freeText": "string",
"customerWasPresent": true,
"executedBy": "string",
"scannedPackages": [{"id": "string",
"licensePlate": "string",
"palletNumber": "string"
}
]
},
"taskNumber": 0,
"orderNumber": 0,
"tags": "string"
}

ChangeTaskEtd

path Parameters

taskId

required

string <guid>

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

start required	string <date-time>
end required	string <date-time>
zoneName	string or null

Responses

Request samples

Payload

Content type

application/json

{"start": "2019-08-24T14:15:22Z",
"end": "2019-08-24T14:15:22Z",
"zoneName": "string"
}

Response samples

200
204
400
404
default

Content type

application/json

{"taskId": "string",
"orderId": "string",
"assigneeType": "string",
"tripId": "string",
"externalOrderId": "string",
"etd": {"start": "2019-08-24T14:15:22Z",
"end": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"atd": {"dateTimeOffset": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"eta": {"start": "2019-08-24T14:15:22Z",
"end": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"ata": {"dateTimeOffset": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"dispatchAddress": {"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"poBox": "string",
"postCode": "string",
"city": "string",
"subDivision": "string",
"state": "string",
"countryCode": "string",
"addressType": "string",
"phoneNumber": "string",
"email": "string",
"contactName": "string",
"position": {"latitude": -90,
"longitude": -180
}
},
"deliveryAddress": {"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"poBox": "string",
"postCode": "string",
"city": "string",
"subDivision": "string",
"state": "string",
"countryCode": "string",
"addressType": "string",
"phoneNumber": "string",
"email": "string",
"contactName": "string",
"position": {"latitude": -90,
"longitude": -180
}
},
"numberOfPackages": 0,
"numberOfPallets": 0,
"palletPlaces": 0,
"netWeightInKg": 0,
"grossWeightInKg": 0,
"volumeInCubicMeters": 0,
"chargeableWeightInKg": 0,
"loadingMeters": 0,
"isPrecedingTaskReceived": true,
"isParallellSplit": true,
"isAssigned": true,
"isDispatched": true,
"isCommunicatedReceived": true,
"isPickupTask": true,
"isDeliveryTask": true,
"proofOfPickup": {"name": "string",
"signature": [[{"x": 0,
"y": 0
}
]
],
"signatureImageAttachmentId": "string",
"position": {"latitude": 0.1,
"longitude": 0.1
},
"time": {"dateTimeOffset": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"arrivalTime": "2019-08-24T14:15:22Z",
"waitingTime": 0.1,
"freeText": "string",
"customerWasPresent": true,
"executedBy": "string",
"scannedPackages": [{"id": "string",
"licensePlate": "string",
"palletNumber": "string"
}
]
},
"proofOfDelivery": {"name": "string",
"signature": [[{"x": 0,
"y": 0
}
]
],
"signatureImageAttachmentId": "string",
"position": {"latitude": 0.1,
"longitude": 0.1
},
"time": {"dateTimeOffset": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"arrivalTime": "2019-08-24T14:15:22Z",
"waitingTime": 0.1,
"freeText": "string",
"customerWasPresent": true,
"executedBy": "string",
"scannedPackages": [{"id": "string",
"licensePlate": "string",
"palletNumber": "string"
}
]
},
"taskNumber": 0,
"orderNumber": 0,
"tags": "string"
}

ChangeTaskEta

path Parameters

taskId

required

string <guid>

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

start required	string <date-time>
end required	string <date-time>
zoneName	string or null

Responses

Request samples

Payload

Content type

application/json

{"start": "2019-08-24T14:15:22Z",
"end": "2019-08-24T14:15:22Z",
"zoneName": "string"
}

Response samples

200
204
400
404
default

Content type

application/json

{"taskId": "string",
"orderId": "string",
"assigneeType": "string",
"tripId": "string",
"externalOrderId": "string",
"etd": {"start": "2019-08-24T14:15:22Z",
"end": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"atd": {"dateTimeOffset": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"eta": {"start": "2019-08-24T14:15:22Z",
"end": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"ata": {"dateTimeOffset": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"dispatchAddress": {"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"poBox": "string",
"postCode": "string",
"city": "string",
"subDivision": "string",
"state": "string",
"countryCode": "string",
"addressType": "string",
"phoneNumber": "string",
"email": "string",
"contactName": "string",
"position": {"latitude": -90,
"longitude": -180
}
},
"deliveryAddress": {"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"poBox": "string",
"postCode": "string",
"city": "string",
"subDivision": "string",
"state": "string",
"countryCode": "string",
"addressType": "string",
"phoneNumber": "string",
"email": "string",
"contactName": "string",
"position": {"latitude": -90,
"longitude": -180
}
},
"numberOfPackages": 0,
"numberOfPallets": 0,
"palletPlaces": 0,
"netWeightInKg": 0,
"grossWeightInKg": 0,
"volumeInCubicMeters": 0,
"chargeableWeightInKg": 0,
"loadingMeters": 0,
"isPrecedingTaskReceived": true,
"isParallellSplit": true,
"isAssigned": true,
"isDispatched": true,
"isCommunicatedReceived": true,
"isPickupTask": true,
"isDeliveryTask": true,
"proofOfPickup": {"name": "string",
"signature": [[{"x": 0,
"y": 0
}
]
],
"signatureImageAttachmentId": "string",
"position": {"latitude": 0.1,
"longitude": 0.1
},
"time": {"dateTimeOffset": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"arrivalTime": "2019-08-24T14:15:22Z",
"waitingTime": 0.1,
"freeText": "string",
"customerWasPresent": true,
"executedBy": "string",
"scannedPackages": [{"id": "string",
"licensePlate": "string",
"palletNumber": "string"
}
]
},
"proofOfDelivery": {"name": "string",
"signature": [[{"x": 0,
"y": 0
}
]
],
"signatureImageAttachmentId": "string",
"position": {"latitude": 0.1,
"longitude": 0.1
},
"time": {"dateTimeOffset": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"arrivalTime": "2019-08-24T14:15:22Z",
"waitingTime": 0.1,
"freeText": "string",
"customerWasPresent": true,
"executedBy": "string",
"scannedPackages": [{"id": "string",
"licensePlate": "string",
"palletNumber": "string"
}
]
},
"taskNumber": 0,
"orderNumber": 0,
"tags": "string"
}

ChangeTaskPickup

path Parameters

taskId

required

string <guid>

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

	(PublicAddressDto (object or null))
newEtdAtNewAddress required	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"newAddress": {"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"poBox": "string",
"postCode": "string",
"city": "string",
"subDivision": "string",
"state": "string",
"countryCode": "string",
"addressType": "string",
"phoneNumber": "string",
"email": "string",
"contactName": "string",
"position": {"latitude": -90,
"longitude": -180
}
},
"newEtdAtNewAddress": "2019-08-24T14:15:22Z"
}

Response samples

200
204
400
404
default

Content type

application/json

{"taskId": "string",
"orderId": "string",
"assigneeType": "string",
"tripId": "string",
"externalOrderId": "string",
"etd": {"start": "2019-08-24T14:15:22Z",
"end": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"atd": {"dateTimeOffset": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"eta": {"start": "2019-08-24T14:15:22Z",
"end": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"ata": {"dateTimeOffset": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"dispatchAddress": {"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"poBox": "string",
"postCode": "string",
"city": "string",
"subDivision": "string",
"state": "string",
"countryCode": "string",
"addressType": "string",
"phoneNumber": "string",
"email": "string",
"contactName": "string",
"position": {"latitude": -90,
"longitude": -180
}
},
"deliveryAddress": {"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"poBox": "string",
"postCode": "string",
"city": "string",
"subDivision": "string",
"state": "string",
"countryCode": "string",
"addressType": "string",
"phoneNumber": "string",
"email": "string",
"contactName": "string",
"position": {"latitude": -90,
"longitude": -180
}
},
"numberOfPackages": 0,
"numberOfPallets": 0,
"palletPlaces": 0,
"netWeightInKg": 0,
"grossWeightInKg": 0,
"volumeInCubicMeters": 0,
"chargeableWeightInKg": 0,
"loadingMeters": 0,
"isPrecedingTaskReceived": true,
"isParallellSplit": true,
"isAssigned": true,
"isDispatched": true,
"isCommunicatedReceived": true,
"isPickupTask": true,
"isDeliveryTask": true,
"proofOfPickup": {"name": "string",
"signature": [[{"x": 0,
"y": 0
}
]
],
"signatureImageAttachmentId": "string",
"position": {"latitude": 0.1,
"longitude": 0.1
},
"time": {"dateTimeOffset": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"arrivalTime": "2019-08-24T14:15:22Z",
"waitingTime": 0.1,
"freeText": "string",
"customerWasPresent": true,
"executedBy": "string",
"scannedPackages": [{"id": "string",
"licensePlate": "string",
"palletNumber": "string"
}
]
},
"proofOfDelivery": {"name": "string",
"signature": [[{"x": 0,
"y": 0
}
]
],
"signatureImageAttachmentId": "string",
"position": {"latitude": 0.1,
"longitude": 0.1
},
"time": {"dateTimeOffset": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"arrivalTime": "2019-08-24T14:15:22Z",
"waitingTime": 0.1,
"freeText": "string",
"customerWasPresent": true,
"executedBy": "string",
"scannedPackages": [{"id": "string",
"licensePlate": "string",
"palletNumber": "string"
}
]
},
"taskNumber": 0,
"orderNumber": 0,
"tags": "string"
}

ChangeTaskDelivery

path Parameters

taskId

required

string <guid>

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

	(PublicAddressDto (object or null))
newEtaAtNewAddress required	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"newAddress": {"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"poBox": "string",
"postCode": "string",
"city": "string",
"subDivision": "string",
"state": "string",
"countryCode": "string",
"addressType": "string",
"phoneNumber": "string",
"email": "string",
"contactName": "string",
"position": {"latitude": -90,
"longitude": -180
}
},
"newEtaAtNewAddress": "2019-08-24T14:15:22Z"
}

Response samples

200
204
400
404
default

Content type

application/json

{"taskId": "string",
"orderId": "string",
"assigneeType": "string",
"tripId": "string",
"externalOrderId": "string",
"etd": {"start": "2019-08-24T14:15:22Z",
"end": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"atd": {"dateTimeOffset": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"eta": {"start": "2019-08-24T14:15:22Z",
"end": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"ata": {"dateTimeOffset": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"dispatchAddress": {"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"poBox": "string",
"postCode": "string",
"city": "string",
"subDivision": "string",
"state": "string",
"countryCode": "string",
"addressType": "string",
"phoneNumber": "string",
"email": "string",
"contactName": "string",
"position": {"latitude": -90,
"longitude": -180
}
},
"deliveryAddress": {"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"poBox": "string",
"postCode": "string",
"city": "string",
"subDivision": "string",
"state": "string",
"countryCode": "string",
"addressType": "string",
"phoneNumber": "string",
"email": "string",
"contactName": "string",
"position": {"latitude": -90,
"longitude": -180
}
},
"numberOfPackages": 0,
"numberOfPallets": 0,
"palletPlaces": 0,
"netWeightInKg": 0,
"grossWeightInKg": 0,
"volumeInCubicMeters": 0,
"chargeableWeightInKg": 0,
"loadingMeters": 0,
"isPrecedingTaskReceived": true,
"isParallellSplit": true,
"isAssigned": true,
"isDispatched": true,
"isCommunicatedReceived": true,
"isPickupTask": true,
"isDeliveryTask": true,
"proofOfPickup": {"name": "string",
"signature": [[{"x": 0,
"y": 0
}
]
],
"signatureImageAttachmentId": "string",
"position": {"latitude": 0.1,
"longitude": 0.1
},
"time": {"dateTimeOffset": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"arrivalTime": "2019-08-24T14:15:22Z",
"waitingTime": 0.1,
"freeText": "string",
"customerWasPresent": true,
"executedBy": "string",
"scannedPackages": [{"id": "string",
"licensePlate": "string",
"palletNumber": "string"
}
]
},
"proofOfDelivery": {"name": "string",
"signature": [[{"x": 0,
"y": 0
}
]
],
"signatureImageAttachmentId": "string",
"position": {"latitude": 0.1,
"longitude": 0.1
},
"time": {"dateTimeOffset": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"arrivalTime": "2019-08-24T14:15:22Z",
"waitingTime": 0.1,
"freeText": "string",
"customerWasPresent": true,
"executedBy": "string",
"scannedPackages": [{"id": "string",
"licensePlate": "string",
"palletNumber": "string"
}
]
},
"taskNumber": 0,
"orderNumber": 0,
"tags": "string"
}

TMSTripRepetition

GetTripRepetitions

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

Content type

application/json

[{"templateName": "string",
"endDate": "2019-08-24T14:15:22Z",
"creationHorizonInDays": 0,
"tripRepetitionId": "string",
"sourceTripId": "string",
"baseDate": "2019-08-24T14:15:22Z",
"schedules": [{"recurrencePattern": "string",
"recursEvery": 0,
"weeklyRecurrence": {"daysOfWeek": "string"
},
"monthlyRecurrence": {"dayOfMonth": 0,
"monthlyOccurence": "string",
"dayOfWeek": "string"
},
"tripRepetitionScheduleId": "string",
"tripRepetitionId": "string"
}
]
}
]

CreateTripRepetition

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

templateName	string or null [ 0 .. 100 ] characters
endDate	string or null <date-time>
creationHorizonInDays required	integer <int32> [ 0 .. 2147483647 ]
sourceTripId required	string <guid> non-empty

Responses

Request samples

Payload

Content type

application/json

{"templateName": "string",
"endDate": "2019-08-24T14:15:22Z",
"creationHorizonInDays": 0,
"sourceTripId": "string"
}

Response samples

Content type

application/json

{"templateName": "string",
"endDate": "2019-08-24T14:15:22Z",
"creationHorizonInDays": 0,
"tripRepetitionId": "string",
"sourceTripId": "string",
"baseDate": "2019-08-24T14:15:22Z",
"schedules": [{"recurrencePattern": "string",
"recursEvery": 0,
"weeklyRecurrence": {"daysOfWeek": "string"
},
"monthlyRecurrence": {"dayOfMonth": 0,
"monthlyOccurence": "string",
"dayOfWeek": "string"
},
"tripRepetitionScheduleId": "string",
"tripRepetitionId": "string"
}
]
}

GetTripRepetitionById

path Parameters

tripRepetitionId

required

string <guid>

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

Content type

application/json

{"templateName": "string",
"endDate": "2019-08-24T14:15:22Z",
"creationHorizonInDays": 0,
"tripRepetitionId": "string",
"sourceTripId": "string",
"baseDate": "2019-08-24T14:15:22Z",
"schedules": [{"recurrencePattern": "string",
"recursEvery": 0,
"weeklyRecurrence": {"daysOfWeek": "string"
},
"monthlyRecurrence": {"dayOfMonth": 0,
"monthlyOccurence": "string",
"dayOfWeek": "string"
},
"tripRepetitionScheduleId": "string",
"tripRepetitionId": "string"
}
]
}

PatchTripRepetition

path Parameters

tripRepetitionId

required

string <guid>

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

templateName	string or null [ 0 .. 100 ] characters
endDate	string or null <date-time>
creationHorizonInDays required	integer <int32> [ 0 .. 2147483647 ]

Responses

Request samples

Payload

Content type

application/json

{"templateName": "string",
"endDate": "2019-08-24T14:15:22Z",
"creationHorizonInDays": 0
}

Response samples

Content type

application/json

{"templateName": "string",
"endDate": "2019-08-24T14:15:22Z",
"creationHorizonInDays": 0,
"tripRepetitionId": "string",
"sourceTripId": "string",
"baseDate": "2019-08-24T14:15:22Z",
"schedules": [{"recurrencePattern": "string",
"recursEvery": 0,
"weeklyRecurrence": {"daysOfWeek": "string"
},
"monthlyRecurrence": {"dayOfMonth": 0,
"monthlyOccurence": "string",
"dayOfWeek": "string"
},
"tripRepetitionScheduleId": "string",
"tripRepetitionId": "string"
}
]
}

GetTripRepetitionForTrip

path Parameters

tripId

required

string <guid>

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

Content type

application/json

{"templateName": "string",
"endDate": "2019-08-24T14:15:22Z",
"creationHorizonInDays": 0,
"tripRepetitionId": "string",
"sourceTripId": "string",
"baseDate": "2019-08-24T14:15:22Z",
"schedules": [{"recurrencePattern": "string",
"recursEvery": 0,
"weeklyRecurrence": {"daysOfWeek": "string"
},
"monthlyRecurrence": {"dayOfMonth": 0,
"monthlyOccurence": "string",
"dayOfWeek": "string"
},
"tripRepetitionScheduleId": "string",
"tripRepetitionId": "string"
}
]
}

GetTripRepetitionScheduleById

path Parameters

tripRepetitionScheduleId

required

string <guid>

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

Content type

application/json

{"recurrencePattern": "string",
"recursEvery": 0,
"weeklyRecurrence": {"daysOfWeek": "string"
},
"monthlyRecurrence": {"dayOfMonth": 0,
"monthlyOccurence": "string",
"dayOfWeek": "string"
},
"tripRepetitionScheduleId": "string",
"tripRepetitionId": "string"
}

PatchTripRepetitionSchedule

path Parameters

tripRepetitionScheduleId

required

string <guid>

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

recurrencePattern required	string string of enum: RecurrencePattern KnownValues: [Daily, Weekly, BiWeeklyEven, BiWeeklyOdd, Monthly]
recursEvery required	integer <int32>
	(PublicWeeklyRecurrenceDto (object or null))
	(PublicMonthlyRecurrenceDto (object or null))

Responses

Request samples

Payload

Content type

application/json

{"recurrencePattern": "string",
"recursEvery": 0,
"weeklyRecurrence": {"daysOfWeek": "string"
},
"monthlyRecurrence": {"dayOfMonth": 0,
"monthlyOccurence": "string",
"dayOfWeek": "string"
}
}

Response samples

Content type

application/json

{"recurrencePattern": "string",
"recursEvery": 0,
"weeklyRecurrence": {"daysOfWeek": "string"
},
"monthlyRecurrence": {"dayOfMonth": 0,
"monthlyOccurence": "string",
"dayOfWeek": "string"
},
"tripRepetitionScheduleId": "string",
"tripRepetitionId": "string"
}

CreateTripRepetitionSchedule

path Parameters

tripRepetitionId

required

string <guid>

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

recurrencePattern required	string string of enum: RecurrencePattern KnownValues: [Daily, Weekly, BiWeeklyEven, BiWeeklyOdd, Monthly]
recursEvery required	integer <int32>
	(PublicWeeklyRecurrenceDto (object or null))
	(PublicMonthlyRecurrenceDto (object or null))

Responses

Request samples

Payload

Content type

application/json

{"recurrencePattern": "string",
"recursEvery": 0,
"weeklyRecurrence": {"daysOfWeek": "string"
},
"monthlyRecurrence": {"dayOfMonth": 0,
"monthlyOccurence": "string",
"dayOfWeek": "string"
}
}

Response samples

Content type

application/json

{"recurrencePattern": "string",
"recursEvery": 0,
"weeklyRecurrence": {"daysOfWeek": "string"
},
"monthlyRecurrence": {"dayOfMonth": 0,
"monthlyOccurence": "string",
"dayOfWeek": "string"
},
"tripRepetitionScheduleId": "string",
"tripRepetitionId": "string"
}

TMSTrips

GetTrips

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>
tripNumber	integer or null <int32>
tripStatus	string
planningComplete	boolean or null
responsible	string or null <guid>
vehicleId	string or null <guid>
tripTypeId	string or null <guid>
quickSearch	string
take	integer or null <int32>
skip	integer or null <int32>
	(TripOrderBy (string or null))
sortAscending	boolean or null

Responses

Response samples

Content type

application/json

[{"vehicleId": "string",
"vehicleTypeId": "string",
"tripTypeId": "string",
"responsible": "string",
"company": "string",
"department": "string",
"project": "string",
"modeOfTransport": "string",
"meansOfTransportCode": "string",
"vehicleCountryCode": "string",
"registrationNumbers": "string",
"customsPlaceId": "string",
"bookingReference": "string",
"bookingDate": "2019-08-24T14:15:22Z",
"billOfLadingNumber": "string",
"planningComplete": true,
"internalNote": "string",
"messageToDriver": "string",
"tripId": "string",
"tripNumber": 0,
"tripKind": "string",
"etd": {"start": "2019-08-24T14:15:22Z",
"end": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"atd": {"dateTimeOffset": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"eta": {"start": "2019-08-24T14:15:22Z",
"end": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"ata": {"dateTimeOffset": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"fromAddress": {"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"poBox": "string",
"postCode": "string",
"city": "string",
"subDivision": "string",
"state": "string",
"countryCode": "string",
"addressType": "string",
"phoneNumber": "string",
"email": "string",
"contactName": "string",
"position": {"latitude": -90,
"longitude": -180
}
},
"toAddress": {"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"poBox": "string",
"postCode": "string",
"city": "string",
"subDivision": "string",
"state": "string",
"countryCode": "string",
"addressType": "string",
"phoneNumber": "string",
"email": "string",
"contactName": "string",
"position": {"latitude": -90,
"longitude": -180
}
},
"vehicleName": "string",
"vehicleTypeName": "string",
"tripTypeName": "string",
"tripTypeCode": "string",
"sealNo": "string",
"tags": "string",
"goodsNumber": "string",
"dispatchStatus": "string",
"communicatedReceivedStatus": "string",
"startedStatus": "string",
"endedStatus": "string",
"goodsRegistrationStatus": "string",
"declarationStatus": "string",
"tripCostsStatus": "string",
"tripStatus": "string",
"checkPointsCompletionStatus": "string",
"tasksDeliveryStatus": "string",
"totals": {"numberOfTasks": 0,
"numberOfPackages": 0,
"numberOfPallets": 0,
"palletPlaces": 0,
"netWeightInKg": 0,
"maxGrossWeightInKg": 0,
"averageGrossWeightInKg": 0,
"maxVolumeInCubicMeters": 0,
"averageVolumeInCubicMeters": 0,
"maxLoadingMeters": 0,
"averageLoadingMeters": 0,
"sumOfAllCostsInBaseCurrency": 0,
"sumOfAllIncomeInBaseCurrency": 0,
"sumOfOwnCostsInBaseCurrency": 0
}
}
]

CreateTrip

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

vehicleId	string or null <guid>
vehicleTypeId	string or null <guid>
tripTypeId	string or null <guid>
responsible	string or null <guid>
company	string or null <guid>
department	string or null <guid>
project	string or null <guid>
modeOfTransport required	string string of enum: ModeOfTransport KnownValues: [Multimodal, Road, Rail, Sea, Air]
meansOfTransportCode	string or null [ 0 .. 50 ] characters
vehicleCountryCode	string or null [ 0 .. 20 ] characters
registrationNumbers	string or null [ 0 .. 200 ] characters
customsPlaceId	string or null <guid>
bookingReference	string or null [ 0 .. 100 ] characters
bookingDate	string or null <date-time>
billOfLadingNumber	string or null [ 0 .. 100 ] characters
planningComplete required	boolean
internalNote	string or null [ 0 .. 2000 ] characters
messageToDriver	string or null [ 0 .. 2000 ] characters
tripKind required	string
	(ZonedDateTimeRangeDto (object or null))
	(ZonedDateTimeDto (object or null))
	(ZonedDateTimeRangeDto (object or null))
	(ZonedDateTimeDto (object or null))
required	object (PublicAddressDto)
required	object (PublicAddressDto)

Responses

Request samples

Payload

Content type

application/json

{"vehicleId": "string",
"vehicleTypeId": "string",
"tripTypeId": "string",
"responsible": "string",
"company": "string",
"department": "string",
"project": "string",
"modeOfTransport": "string",
"meansOfTransportCode": "string",
"vehicleCountryCode": "string",
"registrationNumbers": "string",
"customsPlaceId": "string",
"bookingReference": "string",
"bookingDate": "2019-08-24T14:15:22Z",
"billOfLadingNumber": "string",
"planningComplete": true,
"internalNote": "string",
"messageToDriver": "string",
"tripKind": "string",
"etd": {"start": "2019-08-24T14:15:22Z",
"end": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"atd": {"dateTimeOffset": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"eta": {"start": "2019-08-24T14:15:22Z",
"end": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"ata": {"dateTimeOffset": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"fromAddress": {"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"poBox": "string",
"postCode": "string",
"city": "string",
"subDivision": "string",
"state": "string",
"countryCode": "string",
"addressType": "string",
"phoneNumber": "string",
"email": "string",
"contactName": "string",
"position": {"latitude": -90,
"longitude": -180
}
},
"toAddress": {"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"poBox": "string",
"postCode": "string",
"city": "string",
"subDivision": "string",
"state": "string",
"countryCode": "string",
"addressType": "string",
"phoneNumber": "string",
"email": "string",
"contactName": "string",
"position": {"latitude": -90,
"longitude": -180
}
}
}

Response samples

Content type

application/json

{"vehicleId": "string",
"vehicleTypeId": "string",
"tripTypeId": "string",
"responsible": "string",
"company": "string",
"department": "string",
"project": "string",
"modeOfTransport": "string",
"meansOfTransportCode": "string",
"vehicleCountryCode": "string",
"registrationNumbers": "string",
"customsPlaceId": "string",
"bookingReference": "string",
"bookingDate": "2019-08-24T14:15:22Z",
"billOfLadingNumber": "string",
"planningComplete": true,
"internalNote": "string",
"messageToDriver": "string",
"tripId": "string",
"tripNumber": 0,
"tripKind": "string",
"etd": {"start": "2019-08-24T14:15:22Z",
"end": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"atd": {"dateTimeOffset": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"eta": {"start": "2019-08-24T14:15:22Z",
"end": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"ata": {"dateTimeOffset": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"fromAddress": {"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"poBox": "string",
"postCode": "string",
"city": "string",
"subDivision": "string",
"state": "string",
"countryCode": "string",
"addressType": "string",
"phoneNumber": "string",
"email": "string",
"contactName": "string",
"position": {"latitude": -90,
"longitude": -180
}
},
"toAddress": {"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"poBox": "string",
"postCode": "string",
"city": "string",
"subDivision": "string",
"state": "string",
"countryCode": "string",
"addressType": "string",
"phoneNumber": "string",
"email": "string",
"contactName": "string",
"position": {"latitude": -90,
"longitude": -180
}
},
"vehicleName": "string",
"vehicleTypeName": "string",
"tripTypeName": "string",
"tripTypeCode": "string",
"sealNo": "string",
"tags": "string",
"goodsNumber": "string",
"dispatchStatus": "string",
"communicatedReceivedStatus": "string",
"startedStatus": "string",
"endedStatus": "string",
"goodsRegistrationStatus": "string",
"declarationStatus": "string",
"tripCostsStatus": "string",
"tripStatus": "string",
"checkPointsCompletionStatus": "string",
"tasksDeliveryStatus": "string",
"totals": {"numberOfTasks": 0,
"numberOfPackages": 0,
"numberOfPallets": 0,
"palletPlaces": 0,
"netWeightInKg": 0,
"maxGrossWeightInKg": 0,
"averageGrossWeightInKg": 0,
"maxVolumeInCubicMeters": 0,
"averageVolumeInCubicMeters": 0,
"maxLoadingMeters": 0,
"averageLoadingMeters": 0,
"sumOfAllCostsInBaseCurrency": 0,
"sumOfAllIncomeInBaseCurrency": 0,
"sumOfOwnCostsInBaseCurrency": 0
}
}

GetTripById

path Parameters

tripId

required

string <guid>

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

Content type

application/json

{"vehicleId": "string",
"vehicleTypeId": "string",
"tripTypeId": "string",
"responsible": "string",
"company": "string",
"department": "string",
"project": "string",
"modeOfTransport": "string",
"meansOfTransportCode": "string",
"vehicleCountryCode": "string",
"registrationNumbers": "string",
"customsPlaceId": "string",
"bookingReference": "string",
"bookingDate": "2019-08-24T14:15:22Z",
"billOfLadingNumber": "string",
"planningComplete": true,
"internalNote": "string",
"messageToDriver": "string",
"tripId": "string",
"tripNumber": 0,
"tripKind": "string",
"etd": {"start": "2019-08-24T14:15:22Z",
"end": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"atd": {"dateTimeOffset": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"eta": {"start": "2019-08-24T14:15:22Z",
"end": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"ata": {"dateTimeOffset": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"fromAddress": {"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"poBox": "string",
"postCode": "string",
"city": "string",
"subDivision": "string",
"state": "string",
"countryCode": "string",
"addressType": "string",
"phoneNumber": "string",
"email": "string",
"contactName": "string",
"position": {"latitude": -90,
"longitude": -180
}
},
"toAddress": {"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"poBox": "string",
"postCode": "string",
"city": "string",
"subDivision": "string",
"state": "string",
"countryCode": "string",
"addressType": "string",
"phoneNumber": "string",
"email": "string",
"contactName": "string",
"position": {"latitude": -90,
"longitude": -180
}
},
"vehicleName": "string",
"vehicleTypeName": "string",
"tripTypeName": "string",
"tripTypeCode": "string",
"sealNo": "string",
"tags": "string",
"goodsNumber": "string",
"dispatchStatus": "string",
"communicatedReceivedStatus": "string",
"startedStatus": "string",
"endedStatus": "string",
"goodsRegistrationStatus": "string",
"declarationStatus": "string",
"tripCostsStatus": "string",
"tripStatus": "string",
"checkPointsCompletionStatus": "string",
"tasksDeliveryStatus": "string",
"totals": {"numberOfTasks": 0,
"numberOfPackages": 0,
"numberOfPallets": 0,
"palletPlaces": 0,
"netWeightInKg": 0,
"maxGrossWeightInKg": 0,
"averageGrossWeightInKg": 0,
"maxVolumeInCubicMeters": 0,
"averageVolumeInCubicMeters": 0,
"maxLoadingMeters": 0,
"averageLoadingMeters": 0,
"sumOfAllCostsInBaseCurrency": 0,
"sumOfAllIncomeInBaseCurrency": 0,
"sumOfOwnCostsInBaseCurrency": 0
}
}

UpdateTrip

path Parameters

tripId

required

string <guid>

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

vehicleId	string or null <guid>
vehicleTypeId	string or null <guid>
tripTypeId	string or null <guid>
responsible	string or null <guid>
company	string or null <guid>
department	string or null <guid>
project	string or null <guid>
modeOfTransport required	string string of enum: ModeOfTransport KnownValues: [Multimodal, Road, Rail, Sea, Air]
meansOfTransportCode	string or null [ 0 .. 50 ] characters
vehicleCountryCode	string or null [ 0 .. 20 ] characters
registrationNumbers	string or null [ 0 .. 200 ] characters
customsPlaceId	string or null <guid>
bookingReference	string or null [ 0 .. 100 ] characters
bookingDate	string or null <date-time>
billOfLadingNumber	string or null [ 0 .. 100 ] characters
planningComplete required	boolean
internalNote	string or null [ 0 .. 2000 ] characters
messageToDriver	string or null [ 0 .. 2000 ] characters
sealNo	string or null
tags	string or null

Responses

Request samples

Payload

Content type

application/json

{"vehicleId": "string",
"vehicleTypeId": "string",
"tripTypeId": "string",
"responsible": "string",
"company": "string",
"department": "string",
"project": "string",
"modeOfTransport": "string",
"meansOfTransportCode": "string",
"vehicleCountryCode": "string",
"registrationNumbers": "string",
"customsPlaceId": "string",
"bookingReference": "string",
"bookingDate": "2019-08-24T14:15:22Z",
"billOfLadingNumber": "string",
"planningComplete": true,
"internalNote": "string",
"messageToDriver": "string",
"sealNo": "string",
"tags": "string"
}

Response samples

Content type

application/json

{"vehicleId": "string",
"vehicleTypeId": "string",
"tripTypeId": "string",
"responsible": "string",
"company": "string",
"department": "string",
"project": "string",
"modeOfTransport": "string",
"meansOfTransportCode": "string",
"vehicleCountryCode": "string",
"registrationNumbers": "string",
"customsPlaceId": "string",
"bookingReference": "string",
"bookingDate": "2019-08-24T14:15:22Z",
"billOfLadingNumber": "string",
"planningComplete": true,
"internalNote": "string",
"messageToDriver": "string",
"tripId": "string",
"tripNumber": 0,
"tripKind": "string",
"etd": {"start": "2019-08-24T14:15:22Z",
"end": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"atd": {"dateTimeOffset": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"eta": {"start": "2019-08-24T14:15:22Z",
"end": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"ata": {"dateTimeOffset": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"fromAddress": {"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"poBox": "string",
"postCode": "string",
"city": "string",
"subDivision": "string",
"state": "string",
"countryCode": "string",
"addressType": "string",
"phoneNumber": "string",
"email": "string",
"contactName": "string",
"position": {"latitude": -90,
"longitude": -180
}
},
"toAddress": {"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"poBox": "string",
"postCode": "string",
"city": "string",
"subDivision": "string",
"state": "string",
"countryCode": "string",
"addressType": "string",
"phoneNumber": "string",
"email": "string",
"contactName": "string",
"position": {"latitude": -90,
"longitude": -180
}
},
"vehicleName": "string",
"vehicleTypeName": "string",
"tripTypeName": "string",
"tripTypeCode": "string",
"sealNo": "string",
"tags": "string",
"goodsNumber": "string",
"dispatchStatus": "string",
"communicatedReceivedStatus": "string",
"startedStatus": "string",
"endedStatus": "string",
"goodsRegistrationStatus": "string",
"declarationStatus": "string",
"tripCostsStatus": "string",
"tripStatus": "string",
"checkPointsCompletionStatus": "string",
"tasksDeliveryStatus": "string",
"totals": {"numberOfTasks": 0,
"numberOfPackages": 0,
"numberOfPallets": 0,
"palletPlaces": 0,
"netWeightInKg": 0,
"maxGrossWeightInKg": 0,
"averageGrossWeightInKg": 0,
"maxVolumeInCubicMeters": 0,
"averageVolumeInCubicMeters": 0,
"maxLoadingMeters": 0,
"averageLoadingMeters": 0,
"sumOfAllCostsInBaseCurrency": 0,
"sumOfAllIncomeInBaseCurrency": 0,
"sumOfOwnCostsInBaseCurrency": 0
}
}

SetTripCarrier

path Parameters

tripId

required

string <guid>

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

vehicleId	string or null <guid>
vehicleTypeId	string or null <guid>

Responses

Request samples

Payload

Content type

application/json

{"vehicleId": "string",
"vehicleTypeId": "string"
}

Response samples

Content type

application/json

{"vehicleId": "string",
"vehicleTypeId": "string",
"tripTypeId": "string",
"responsible": "string",
"company": "string",
"department": "string",
"project": "string",
"modeOfTransport": "string",
"meansOfTransportCode": "string",
"vehicleCountryCode": "string",
"registrationNumbers": "string",
"customsPlaceId": "string",
"bookingReference": "string",
"bookingDate": "2019-08-24T14:15:22Z",
"billOfLadingNumber": "string",
"planningComplete": true,
"internalNote": "string",
"messageToDriver": "string",
"tripId": "string",
"tripNumber": 0,
"tripKind": "string",
"etd": {"start": "2019-08-24T14:15:22Z",
"end": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"atd": {"dateTimeOffset": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"eta": {"start": "2019-08-24T14:15:22Z",
"end": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"ata": {"dateTimeOffset": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"fromAddress": {"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"poBox": "string",
"postCode": "string",
"city": "string",
"subDivision": "string",
"state": "string",
"countryCode": "string",
"addressType": "string",
"phoneNumber": "string",
"email": "string",
"contactName": "string",
"position": {"latitude": -90,
"longitude": -180
}
},
"toAddress": {"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"poBox": "string",
"postCode": "string",
"city": "string",
"subDivision": "string",
"state": "string",
"countryCode": "string",
"addressType": "string",
"phoneNumber": "string",
"email": "string",
"contactName": "string",
"position": {"latitude": -90,
"longitude": -180
}
},
"vehicleName": "string",
"vehicleTypeName": "string",
"tripTypeName": "string",
"tripTypeCode": "string",
"sealNo": "string",
"tags": "string",
"goodsNumber": "string",
"dispatchStatus": "string",
"communicatedReceivedStatus": "string",
"startedStatus": "string",
"endedStatus": "string",
"goodsRegistrationStatus": "string",
"declarationStatus": "string",
"tripCostsStatus": "string",
"tripStatus": "string",
"checkPointsCompletionStatus": "string",
"tasksDeliveryStatus": "string",
"totals": {"numberOfTasks": 0,
"numberOfPackages": 0,
"numberOfPallets": 0,
"palletPlaces": 0,
"netWeightInKg": 0,
"maxGrossWeightInKg": 0,
"averageGrossWeightInKg": 0,
"maxVolumeInCubicMeters": 0,
"averageVolumeInCubicMeters": 0,
"maxLoadingMeters": 0,
"averageLoadingMeters": 0,
"sumOfAllCostsInBaseCurrency": 0,
"sumOfAllIncomeInBaseCurrency": 0,
"sumOfOwnCostsInBaseCurrency": 0
}
}

AssignTasksToTrip

path Parameters

tripId

required

string <guid>

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>
ignoreTripLengthExceeded	boolean or null

Request Body schema: application/json
required

taskIds required	Array of strings <guid> non-empty [ items <guid > ]
pickupSource required	string (TasksTripAssignmentDetailsSource) Enum: "Task" "Trip" "Custom"
deliverySource required	string (TasksTripAssignmentDetailsSource) Enum: "Task" "Trip" "Custom"
	(ZonedDateTimeRangeDto (object or null))
	(ZonedDateTimeRangeDto (object or null))
	(PublicAddressDto (object or null))
	(PublicAddressDto (object or null))
sendTripToConfirm	boolean or null Force-sends the trip to confirm even if it is not yet dispatched.

Responses

Request samples

Payload

Content type

application/json

{"taskIds": ["string"
],
"pickupSource": "Task",
"deliverySource": "Task",
"overrideETD": {"start": "2019-08-24T14:15:22Z",
"end": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"overrideETA": {"start": "2019-08-24T14:15:22Z",
"end": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"customPickupAddress": {"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"poBox": "string",
"postCode": "string",
"city": "string",
"subDivision": "string",
"state": "string",
"countryCode": "string",
"addressType": "string",
"phoneNumber": "string",
"email": "string",
"contactName": "string",
"position": {"latitude": -90,
"longitude": -180
}
},
"customDeliveryAddress": {"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"poBox": "string",
"postCode": "string",
"city": "string",
"subDivision": "string",
"state": "string",
"countryCode": "string",
"addressType": "string",
"phoneNumber": "string",
"email": "string",
"contactName": "string",
"position": {"latitude": -90,
"longitude": -180
}
},
"sendTripToConfirm": true
}

Response samples

Content type

application/json

{"vehicleId": "string",
"vehicleTypeId": "string",
"tripTypeId": "string",
"responsible": "string",
"company": "string",
"department": "string",
"project": "string",
"modeOfTransport": "string",
"meansOfTransportCode": "string",
"vehicleCountryCode": "string",
"registrationNumbers": "string",
"customsPlaceId": "string",
"bookingReference": "string",
"bookingDate": "2019-08-24T14:15:22Z",
"billOfLadingNumber": "string",
"planningComplete": true,
"internalNote": "string",
"messageToDriver": "string",
"tripId": "string",
"tripNumber": 0,
"tripKind": "string",
"etd": {"start": "2019-08-24T14:15:22Z",
"end": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"atd": {"dateTimeOffset": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"eta": {"start": "2019-08-24T14:15:22Z",
"end": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"ata": {"dateTimeOffset": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"fromAddress": {"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"poBox": "string",
"postCode": "string",
"city": "string",
"subDivision": "string",
"state": "string",
"countryCode": "string",
"addressType": "string",
"phoneNumber": "string",
"email": "string",
"contactName": "string",
"position": {"latitude": -90,
"longitude": -180
}
},
"toAddress": {"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"poBox": "string",
"postCode": "string",
"city": "string",
"subDivision": "string",
"state": "string",
"countryCode": "string",
"addressType": "string",
"phoneNumber": "string",
"email": "string",
"contactName": "string",
"position": {"latitude": -90,
"longitude": -180
}
},
"vehicleName": "string",
"vehicleTypeName": "string",
"tripTypeName": "string",
"tripTypeCode": "string",
"sealNo": "string",
"tags": "string",
"goodsNumber": "string",
"dispatchStatus": "string",
"communicatedReceivedStatus": "string",
"startedStatus": "string",
"endedStatus": "string",
"goodsRegistrationStatus": "string",
"declarationStatus": "string",
"tripCostsStatus": "string",
"tripStatus": "string",
"checkPointsCompletionStatus": "string",
"tasksDeliveryStatus": "string",
"totals": {"numberOfTasks": 0,
"numberOfPackages": 0,
"numberOfPallets": 0,
"palletPlaces": 0,
"netWeightInKg": 0,
"maxGrossWeightInKg": 0,
"averageGrossWeightInKg": 0,
"maxVolumeInCubicMeters": 0,
"averageVolumeInCubicMeters": 0,
"maxLoadingMeters": 0,
"averageLoadingMeters": 0,
"sumOfAllCostsInBaseCurrency": 0,
"sumOfAllIncomeInBaseCurrency": 0,
"sumOfOwnCostsInBaseCurrency": 0
}
}

UnassignTaskFromTrip

path Parameters

tripId required	string <guid>
taskId required	string <guid>

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>
removeCostsEvenReady	boolean or null

Responses

Response samples

Content type

application/json

{"vehicleId": "string",
"vehicleTypeId": "string",
"tripTypeId": "string",
"responsible": "string",
"company": "string",
"department": "string",
"project": "string",
"modeOfTransport": "string",
"meansOfTransportCode": "string",
"vehicleCountryCode": "string",
"registrationNumbers": "string",
"customsPlaceId": "string",
"bookingReference": "string",
"bookingDate": "2019-08-24T14:15:22Z",
"billOfLadingNumber": "string",
"planningComplete": true,
"internalNote": "string",
"messageToDriver": "string",
"tripId": "string",
"tripNumber": 0,
"tripKind": "string",
"etd": {"start": "2019-08-24T14:15:22Z",
"end": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"atd": {"dateTimeOffset": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"eta": {"start": "2019-08-24T14:15:22Z",
"end": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"ata": {"dateTimeOffset": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"fromAddress": {"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"poBox": "string",
"postCode": "string",
"city": "string",
"subDivision": "string",
"state": "string",
"countryCode": "string",
"addressType": "string",
"phoneNumber": "string",
"email": "string",
"contactName": "string",
"position": {"latitude": -90,
"longitude": -180
}
},
"toAddress": {"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"poBox": "string",
"postCode": "string",
"city": "string",
"subDivision": "string",
"state": "string",
"countryCode": "string",
"addressType": "string",
"phoneNumber": "string",
"email": "string",
"contactName": "string",
"position": {"latitude": -90,
"longitude": -180
}
},
"vehicleName": "string",
"vehicleTypeName": "string",
"tripTypeName": "string",
"tripTypeCode": "string",
"sealNo": "string",
"tags": "string",
"goodsNumber": "string",
"dispatchStatus": "string",
"communicatedReceivedStatus": "string",
"startedStatus": "string",
"endedStatus": "string",
"goodsRegistrationStatus": "string",
"declarationStatus": "string",
"tripCostsStatus": "string",
"tripStatus": "string",
"checkPointsCompletionStatus": "string",
"tasksDeliveryStatus": "string",
"totals": {"numberOfTasks": 0,
"numberOfPackages": 0,
"numberOfPallets": 0,
"palletPlaces": 0,
"netWeightInKg": 0,
"maxGrossWeightInKg": 0,
"averageGrossWeightInKg": 0,
"maxVolumeInCubicMeters": 0,
"averageVolumeInCubicMeters": 0,
"maxLoadingMeters": 0,
"averageLoadingMeters": 0,
"sumOfAllCostsInBaseCurrency": 0,
"sumOfAllIncomeInBaseCurrency": 0,
"sumOfOwnCostsInBaseCurrency": 0
}
}

SetPlanningComplete

path Parameters

tripId

required

string <guid>

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>
planningComplete	boolean or null

Responses

Response samples

Content type

application/json

{"vehicleId": "string",
"vehicleTypeId": "string",
"tripTypeId": "string",
"responsible": "string",
"company": "string",
"department": "string",
"project": "string",
"modeOfTransport": "string",
"meansOfTransportCode": "string",
"vehicleCountryCode": "string",
"registrationNumbers": "string",
"customsPlaceId": "string",
"bookingReference": "string",
"bookingDate": "2019-08-24T14:15:22Z",
"billOfLadingNumber": "string",
"planningComplete": true,
"internalNote": "string",
"messageToDriver": "string",
"tripId": "string",
"tripNumber": 0,
"tripKind": "string",
"etd": {"start": "2019-08-24T14:15:22Z",
"end": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"atd": {"dateTimeOffset": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"eta": {"start": "2019-08-24T14:15:22Z",
"end": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"ata": {"dateTimeOffset": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"fromAddress": {"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"poBox": "string",
"postCode": "string",
"city": "string",
"subDivision": "string",
"state": "string",
"countryCode": "string",
"addressType": "string",
"phoneNumber": "string",
"email": "string",
"contactName": "string",
"position": {"latitude": -90,
"longitude": -180
}
},
"toAddress": {"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"poBox": "string",
"postCode": "string",
"city": "string",
"subDivision": "string",
"state": "string",
"countryCode": "string",
"addressType": "string",
"phoneNumber": "string",
"email": "string",
"contactName": "string",
"position": {"latitude": -90,
"longitude": -180
}
},
"vehicleName": "string",
"vehicleTypeName": "string",
"tripTypeName": "string",
"tripTypeCode": "string",
"sealNo": "string",
"tags": "string",
"goodsNumber": "string",
"dispatchStatus": "string",
"communicatedReceivedStatus": "string",
"startedStatus": "string",
"endedStatus": "string",
"goodsRegistrationStatus": "string",
"declarationStatus": "string",
"tripCostsStatus": "string",
"tripStatus": "string",
"checkPointsCompletionStatus": "string",
"tasksDeliveryStatus": "string",
"totals": {"numberOfTasks": 0,
"numberOfPackages": 0,
"numberOfPallets": 0,
"palletPlaces": 0,
"netWeightInKg": 0,
"maxGrossWeightInKg": 0,
"averageGrossWeightInKg": 0,
"maxVolumeInCubicMeters": 0,
"averageVolumeInCubicMeters": 0,
"maxLoadingMeters": 0,
"averageLoadingMeters": 0,
"sumOfAllCostsInBaseCurrency": 0,
"sumOfAllIncomeInBaseCurrency": 0,
"sumOfOwnCostsInBaseCurrency": 0
}
}

SendTripToConfirm

path Parameters

tripId

required

string <guid>

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

Content type

application/json

{"vehicleId": "string",
"vehicleTypeId": "string",
"tripTypeId": "string",
"responsible": "string",
"company": "string",
"department": "string",
"project": "string",
"modeOfTransport": "string",
"meansOfTransportCode": "string",
"vehicleCountryCode": "string",
"registrationNumbers": "string",
"customsPlaceId": "string",
"bookingReference": "string",
"bookingDate": "2019-08-24T14:15:22Z",
"billOfLadingNumber": "string",
"planningComplete": true,
"internalNote": "string",
"messageToDriver": "string",
"tripId": "string",
"tripNumber": 0,
"tripKind": "string",
"etd": {"start": "2019-08-24T14:15:22Z",
"end": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"atd": {"dateTimeOffset": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"eta": {"start": "2019-08-24T14:15:22Z",
"end": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"ata": {"dateTimeOffset": "2019-08-24T14:15:22Z",
"zoneName": "string"
},
"fromAddress": {"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"poBox": "string",
"postCode": "string",
"city": "string",
"subDivision": "string",
"state": "string",
"countryCode": "string",
"addressType": "string",
"phoneNumber": "string",
"email": "string",
"contactName": "string",
"position": {"latitude": -90,
"longitude": -180
}
},
"toAddress": {"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"poBox": "string",
"postCode": "string",
"city": "string",
"subDivision": "string",
"state": "string",
"countryCode": "string",
"addressType": "string",
"phoneNumber": "string",
"email": "string",
"contactName": "string",
"position": {"latitude": -90,
"longitude": -180
}
},
"vehicleName": "string",
"vehicleTypeName": "string",
"tripTypeName": "string",
"tripTypeCode": "string",
"sealNo": "string",
"tags": "string",
"goodsNumber": "string",
"dispatchStatus": "string",
"communicatedReceivedStatus": "string",
"startedStatus": "string",
"endedStatus": "string",
"goodsRegistrationStatus": "string",
"declarationStatus": "string",
"tripCostsStatus": "string",
"tripStatus": "string",
"checkPointsCompletionStatus": "string",
"tasksDeliveryStatus": "string",
"totals": {"numberOfTasks": 0,
"numberOfPackages": 0,
"numberOfPallets": 0,
"palletPlaces": 0,
"netWeightInKg": 0,
"maxGrossWeightInKg": 0,
"averageGrossWeightInKg": 0,
"maxVolumeInCubicMeters": 0,
"averageVolumeInCubicMeters": 0,
"maxLoadingMeters": 0,
"averageLoadingMeters": 0,
"sumOfAllCostsInBaseCurrency": 0,
"sumOfAllIncomeInBaseCurrency": 0,
"sumOfOwnCostsInBaseCurrency": 0
}
}

GetTripLog

path Parameters

tripId

required

string <guid>

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

Content type

application/json

[{"description": "string",
"details": "string",
"createdAt": "2019-08-24T14:15:22Z",
"createdBy": "string",
"isExternalChange": true,
"isExternalChangeAccepted": true
}
]

TMSTransportsiden

HandleTransportsidenRequest

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

string

Responses

Request samples

Payload

Content type

application/json

"string"

Response samples

400
default

Content type

application/json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"applicationId": ["string"
],
"errors": {"property1": ["string"
],
"property2": ["string"
]
},
"property1": null,
"property2": null
}

HandleTransportsidenGetRequest

query Parameters

accountId required	string <guid>
domainId required	string <guid>
service	string or null
id	string or null
userId	string <guid>
traceId	string <guid>

Responses

Response samples

400
default

Content type

application/json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"applicationId": ["string"
],
"errors": {"property1": ["string"
],
"property2": ["string"
]
},
"property1": null,
"property2": null
}

TransferOrder

Search for transfer orders. Max number of orders returned will be 100.

query Parameters

accountId required	string <guid>
domainId required	string <guid>
FromShippingDate	string or null <date-time>
ToShippingDate	string or null <date-time>
SystemStatus	string or null
DimensionName	string or null
DimensionValue	string or null
FromWarehouse	string or null
ToWarehouse	string or null
includeBoxes	boolean Default: false Will only return boxes if result is max 25 orders
userId	string <guid>
traceId	string <guid>

Responses

Response samples

Content type

application/json

[{"transferOrderNo": 0,
"transferOrderId": "string",
"toWarehouseId": "string",
"toWarehouseName": "string",
"responsiblePersonId": "string",
"awbNo": "string",
"flightRegNo": "string",
"transportRegNo": "string",
"transporterNo": "string",
"transporterId": "string",
"shipmentDate": "2019-08-24",
"arrivalDate": "2019-08-24",
"weightUnitId": "string",
"comment": "string",
"reference": "string",
"deliveryRemarks": "string",
"tags": ["string"
],
"deliveryPlaceId": "string",
"deliveryPlaceName": "string",
"deliveryPlaceAddress1": "string",
"deliveryPlaceAddress2": "string",
"deliveryPlaceAddress3": "string",
"deliveryPlaceAddress4": "string",
"deliveryPlacePostCode": "string",
"deliveryPlacePostalPlace": "string",
"deliveryPlaceState": "string",
"deliveryPlaceCountry": "string",
"dimensions": [{"dimensionId": "string",
"dimensionName": "string",
"sortOrder": 0,
"dimensionDetailId": "string",
"dimensionDetailName": "string"
}
],
"orderLines": [{"orderLineId": "string",
"orderLineNo": 0,
"itemCode": "string",
"itemId": "string",
"itemName": "string",
"numberOfBoxes": 0,
"weight": 0,
"piecesPerUnit": 0,
"notes": "string",
"boxes": [{"itemId": "string",
"itemCode": "string",
"itemName": "string",
"palletNo": "string",
"palletSscc": "string",
"boxNo": "string",
"boxSscc": "string",
"useBy": "2019-08-24",
"netWeight": 0,
"duplicateUnits": 0,
"lotNo": "string",
"batchNo": "string",
"packingLabel": "string"
}
]
}
]
}
]

CreateTransferOrder

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

shipmentDate required	string <date>
arrivalDate required	string <date>
responsiblePersonId required	string <guid>
toWarehouseId required	string <guid>
transporterId	string or null <guid>
awbNo	string or null
flightRegNo	string or null
transportRegNo	string or null
comment	string or null
reference	string or null
deliveryRemarks	string or null
tags	Array of strings or null
deliveryPlaceId	string or null <guid>
deliveryPlaceName	string or null
deliveryPlaceAddress1	string or null
deliveryPlaceAddress2	string or null
deliveryPlaceAddress3	string or null
deliveryPlaceAddress4	string or null
deliveryPlacePostCode	string or null
deliveryPlacePostalPlace	string or null
deliveryPlaceState	string or null
deliveryPlaceCountry	string or null
	Array of objects or null (OrderDimension)
	Array of objects or null (CreateTransferOrderLine)

Responses

Request samples

Payload

Content type

application/json

{"shipmentDate": "2019-08-24",
"arrivalDate": "2019-08-24",
"responsiblePersonId": "string",
"toWarehouseId": "string",
"transporterId": "string",
"awbNo": "string",
"flightRegNo": "string",
"transportRegNo": "string",
"comment": "string",
"reference": "string",
"deliveryRemarks": "string",
"tags": ["string"
],
"deliveryPlaceId": "string",
"deliveryPlaceName": "string",
"deliveryPlaceAddress1": "string",
"deliveryPlaceAddress2": "string",
"deliveryPlaceAddress3": "string",
"deliveryPlaceAddress4": "string",
"deliveryPlacePostCode": "string",
"deliveryPlacePostalPlace": "string",
"deliveryPlaceState": "string",
"deliveryPlaceCountry": "string",
"dimensions": [{"dimensionId": "string",
"dimensionName": "string",
"sortOrder": 0,
"dimensionDetailId": "string",
"dimensionDetailName": "string"
}
],
"orderLines": [{"orderLineNo": 0,
"itemCode": "string",
"itemId": "string",
"numberOfBoxes": 0,
"weight": 0,
"weightUnitId": "string"
}
]
}

Response samples

Content type

application/json

{"transferOrderNo": 0,
"transferOrderId": "string",
"toWarehouseId": "string",
"toWarehouseName": "string",
"responsiblePersonId": "string",
"awbNo": "string",
"flightRegNo": "string",
"transportRegNo": "string",
"transporterNo": "string",
"transporterId": "string",
"shipmentDate": "2019-08-24",
"arrivalDate": "2019-08-24",
"weightUnitId": "string",
"comment": "string",
"reference": "string",
"deliveryRemarks": "string",
"tags": ["string"
],
"deliveryPlaceId": "string",
"deliveryPlaceName": "string",
"deliveryPlaceAddress1": "string",
"deliveryPlaceAddress2": "string",
"deliveryPlaceAddress3": "string",
"deliveryPlaceAddress4": "string",
"deliveryPlacePostCode": "string",
"deliveryPlacePostalPlace": "string",
"deliveryPlaceState": "string",
"deliveryPlaceCountry": "string",
"dimensions": [{"dimensionId": "string",
"dimensionName": "string",
"sortOrder": 0,
"dimensionDetailId": "string",
"dimensionDetailName": "string"
}
],
"orderLines": [{"orderLineId": "string",
"orderLineNo": 0,
"itemCode": "string",
"itemId": "string",
"itemName": "string",
"numberOfBoxes": 0,
"weight": 0,
"piecesPerUnit": 0,
"notes": "string",
"boxes": [{"itemId": "string",
"itemCode": "string",
"itemName": "string",
"palletNo": "string",
"palletSscc": "string",
"boxNo": "string",
"boxSscc": "string",
"useBy": "2019-08-24",
"netWeight": 0,
"duplicateUnits": 0,
"lotNo": "string",
"batchNo": "string",
"packingLabel": "string"
}
]
}
]
}

Not implemented. Use Patch instead. Only created for documentation of the possible input fields for the Patch method.

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

transferOrderId required	string <guid>
toWarehouseId	string or null <guid>
responsiblePersonId	string or null <guid>
awbNo	string or null
flightRegNo	string or null
transportRegNo	string or null
transporterId	string or null <guid>
shipmentDate	string or null <date>
arrivalDate	string or null <date>
weightUnitId	string or null
comment	string or null
reference	string or null
deliveryRemarks	string or null
tags	Array of strings or null
deliveryPlaceId	string or null <guid>
deliveryPlaceName	string or null
deliveryPlaceAddress1	string or null
deliveryPlaceAddress2	string or null
deliveryPlaceAddress3	string or null
deliveryPlaceAddress4	string or null
deliveryPlacePostCode	string or null
deliveryPlacePostalPlace	string or null
deliveryPlaceState	string or null
deliveryPlaceCountry	string or null
	Array of objects or null (OrderDimension)

Responses

Request samples

Payload

Content type

application/json

{"transferOrderId": "string",
"toWarehouseId": "string",
"responsiblePersonId": "string",
"awbNo": "string",
"flightRegNo": "string",
"transportRegNo": "string",
"transporterId": "string",
"shipmentDate": "2019-08-24",
"arrivalDate": "2019-08-24",
"weightUnitId": "string",
"comment": "string",
"reference": "string",
"deliveryRemarks": "string",
"tags": ["string"
],
"deliveryPlaceId": "string",
"deliveryPlaceName": "string",
"deliveryPlaceAddress1": "string",
"deliveryPlaceAddress2": "string",
"deliveryPlaceAddress3": "string",
"deliveryPlaceAddress4": "string",
"deliveryPlacePostCode": "string",
"deliveryPlacePostalPlace": "string",
"deliveryPlaceState": "string",
"deliveryPlaceCountry": "string",
"dimensions": [{"dimensionId": "string",
"dimensionName": "string",
"sortOrder": 0,
"dimensionDetailId": "string",
"dimensionDetailName": "string"
}
]
}

Response samples

default

Content type

application/json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"property1": null,
"property2": null
}

Patch transfer order

Payload is sent as dictionary, entries in dictionary matches model from PUT.

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

property name*

additional property

any

Responses

Request samples

Payload

Content type

application/json

{"property1": null,
"property2": null
}

Response samples

200
204
default

Content type

application/json

{"transferOrderNo": 0,
"transferOrderId": "string",
"toWarehouseId": "string",
"toWarehouseName": "string",
"responsiblePersonId": "string",
"awbNo": "string",
"flightRegNo": "string",
"transportRegNo": "string",
"transporterNo": "string",
"transporterId": "string",
"shipmentDate": "2019-08-24",
"arrivalDate": "2019-08-24",
"weightUnitId": "string",
"comment": "string",
"reference": "string",
"deliveryRemarks": "string",
"tags": ["string"
],
"deliveryPlaceId": "string",
"deliveryPlaceName": "string",
"deliveryPlaceAddress1": "string",
"deliveryPlaceAddress2": "string",
"deliveryPlaceAddress3": "string",
"deliveryPlaceAddress4": "string",
"deliveryPlacePostCode": "string",
"deliveryPlacePostalPlace": "string",
"deliveryPlaceState": "string",
"deliveryPlaceCountry": "string",
"dimensions": [{"dimensionId": "string",
"dimensionName": "string",
"sortOrder": 0,
"dimensionDetailId": "string",
"dimensionDetailName": "string"
}
],
"orderLines": [{"orderLineId": "string",
"orderLineNo": 0,
"itemCode": "string",
"itemId": "string",
"itemName": "string",
"numberOfBoxes": 0,
"weight": 0,
"piecesPerUnit": 0,
"notes": "string",
"boxes": [{"itemId": "string",
"itemCode": "string",
"itemName": "string",
"palletNo": "string",
"palletSscc": "string",
"boxNo": "string",
"boxSscc": "string",
"useBy": "2019-08-24",
"netWeight": 0,
"duplicateUnits": 0,
"lotNo": "string",
"batchNo": "string",
"packingLabel": "string"
}
]
}
]
}

Get a single transfer order.

path Parameters

transferOrder

required

string

TransferOrderId or TransferOrderNo

query Parameters

accountId required	string <guid>
domainId required	string <guid>
includeBoxes	boolean Default: false True if boxes should be included on line level
userId	string <guid>
traceId	string <guid>

Responses

Response samples

Content type

application/json

{"transferOrderNo": 0,
"transferOrderId": "string",
"toWarehouseId": "string",
"toWarehouseName": "string",
"responsiblePersonId": "string",
"awbNo": "string",
"flightRegNo": "string",
"transportRegNo": "string",
"transporterNo": "string",
"transporterId": "string",
"shipmentDate": "2019-08-24",
"arrivalDate": "2019-08-24",
"weightUnitId": "string",
"comment": "string",
"reference": "string",
"deliveryRemarks": "string",
"tags": ["string"
],
"deliveryPlaceId": "string",
"deliveryPlaceName": "string",
"deliveryPlaceAddress1": "string",
"deliveryPlaceAddress2": "string",
"deliveryPlaceAddress3": "string",
"deliveryPlaceAddress4": "string",
"deliveryPlacePostCode": "string",
"deliveryPlacePostalPlace": "string",
"deliveryPlaceState": "string",
"deliveryPlaceCountry": "string",
"dimensions": [{"dimensionId": "string",
"dimensionName": "string",
"sortOrder": 0,
"dimensionDetailId": "string",
"dimensionDetailName": "string"
}
],
"orderLines": [{"orderLineId": "string",
"orderLineNo": 0,
"itemCode": "string",
"itemId": "string",
"itemName": "string",
"numberOfBoxes": 0,
"weight": 0,
"piecesPerUnit": 0,
"notes": "string",
"boxes": [{"itemId": "string",
"itemCode": "string",
"itemName": "string",
"palletNo": "string",
"palletSscc": "string",
"boxNo": "string",
"boxSscc": "string",
"useBy": "2019-08-24",
"netWeight": 0,
"duplicateUnits": 0,
"lotNo": "string",
"batchNo": "string",
"packingLabel": "string"
}
]
}
]
}

Confirm transfer order

query Parameters

accountId required	string <guid>
domainId required	string <guid>
transferOrder	string or null
processAsync	boolean or null
ignoreIfConfirmed	boolean or null
userId	string <guid>
traceId	string <guid>

Responses

Response samples

200
204
default

Content type

application/json

{"transferOrderNo": 0,
"transferOrderId": "string",
"toWarehouseId": "string",
"toWarehouseName": "string",
"responsiblePersonId": "string",
"awbNo": "string",
"flightRegNo": "string",
"transportRegNo": "string",
"transporterNo": "string",
"transporterId": "string",
"shipmentDate": "2019-08-24",
"arrivalDate": "2019-08-24",
"weightUnitId": "string",
"comment": "string",
"reference": "string",
"deliveryRemarks": "string",
"tags": ["string"
],
"deliveryPlaceId": "string",
"deliveryPlaceName": "string",
"deliveryPlaceAddress1": "string",
"deliveryPlaceAddress2": "string",
"deliveryPlaceAddress3": "string",
"deliveryPlaceAddress4": "string",
"deliveryPlacePostCode": "string",
"deliveryPlacePostalPlace": "string",
"deliveryPlaceState": "string",
"deliveryPlaceCountry": "string",
"dimensions": [{"dimensionId": "string",
"dimensionName": "string",
"sortOrder": 0,
"dimensionDetailId": "string",
"dimensionDetailName": "string"
}
],
"orderLines": [{"orderLineId": "string",
"orderLineNo": 0,
"itemCode": "string",
"itemId": "string",
"itemName": "string",
"numberOfBoxes": 0,
"weight": 0,
"piecesPerUnit": 0,
"notes": "string",
"boxes": [{"itemId": "string",
"itemCode": "string",
"itemName": "string",
"palletNo": "string",
"palletSscc": "string",
"boxNo": "string",
"boxSscc": "string",
"useBy": "2019-08-24",
"netWeight": 0,
"duplicateUnits": 0,
"lotNo": "string",
"batchNo": "string",
"packingLabel": "string"
}
]
}
]
}

Transporter

GetTransporterAll

query Parameters

accountId required	string <guid>
domainId required	string <guid>
transporterNo	integer or null <int32>
changedSince	string or null <date-time>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

200
default

Content type

application/json

[{"id": "string",
"transporterNo": 0,
"externalTransporterNo": "string",
"name": "string",
"active": true,
"organizationNo": "string",
"vatIdentificationNo": "string",
"currencyCode": "string",
"languageCode": "string",
"primaryEmail": "string",
"secondaryEmail": "string",
"phone": "string",
"mobilePhone": "string",
"ledgerNo": "string",
"eori": "string",
"vatRequired": true,
"addresses": [{"addressId": "string",
"type": "Unspecified",
"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"address4": "string",
"zipCode": "string",
"city": "string",
"state": "string",
"countryCode": "string",
"gln": "string",
"routeNumber": "string"
}
],
"contactInformation": [{"contactId": "string",
"firstName": "string",
"lastName": "string",
"primaryEmail": "string",
"secondaryEmail": "string",
"phone": "string",
"mobilePhone": "string"
}
],
"lastModifiedAt": "2019-08-24T14:15:22Z"
}
]

PostTransporter

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

Array

id	string or null <guid>
transporterNo	integer or null <int32>
externalTransporterNo	string or null
name	string or null
active required	boolean
organizationNo	string or null
vatIdentificationNo	string or null
currencyCode	string or null
languageCode	string or null
primaryEmail	string or null
secondaryEmail	string or null
phone	string or null
mobilePhone	string or null
ledgerNo	string or null
eori	string or null
vatRequired required	boolean
	Array of objects or null (Address)
	Array of objects or null (ContactInformation)
lastModifiedAt	string or null <date-time>

Responses

Request samples

Payload

Content type

application/json

[{"id": "string",
"transporterNo": 0,
"externalTransporterNo": "string",
"name": "string",
"active": true,
"organizationNo": "string",
"vatIdentificationNo": "string",
"currencyCode": "string",
"languageCode": "string",
"primaryEmail": "string",
"secondaryEmail": "string",
"phone": "string",
"mobilePhone": "string",
"ledgerNo": "string",
"eori": "string",
"vatRequired": true,
"addresses": [{"addressId": "string",
"type": "Unspecified",
"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"address4": "string",
"zipCode": "string",
"city": "string",
"state": "string",
"countryCode": "string",
"gln": "string",
"routeNumber": "string"
}
],
"contactInformation": [{"contactId": "string",
"firstName": "string",
"lastName": "string",
"primaryEmail": "string",
"secondaryEmail": "string",
"phone": "string",
"mobilePhone": "string"
}
],
"lastModifiedAt": "2019-08-24T14:15:22Z"
}
]

Response samples

default

Content type

application/json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"property1": null,
"property2": null
}

GetTransporter

path Parameters

required

string

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

200
204
default

Content type

application/json

{"id": "string",
"transporterNo": 0,
"externalTransporterNo": "string",
"name": "string",
"active": true,
"organizationNo": "string",
"vatIdentificationNo": "string",
"currencyCode": "string",
"languageCode": "string",
"primaryEmail": "string",
"secondaryEmail": "string",
"phone": "string",
"mobilePhone": "string",
"ledgerNo": "string",
"eori": "string",
"vatRequired": true,
"addresses": [{"addressId": "string",
"type": "Unspecified",
"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"address4": "string",
"zipCode": "string",
"city": "string",
"state": "string",
"countryCode": "string",
"gln": "string",
"routeNumber": "string"
}
],
"contactInformation": [{"contactId": "string",
"firstName": "string",
"lastName": "string",
"primaryEmail": "string",
"secondaryEmail": "string",
"phone": "string",
"mobilePhone": "string"
}
],
"lastModifiedAt": "2019-08-24T14:15:22Z"
}

PutTransporter

path Parameters

required

string

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

id	string or null <guid>
transporterNo	integer or null <int32>
externalTransporterNo	string or null
name	string or null
active required	boolean
organizationNo	string or null
vatIdentificationNo	string or null
currencyCode	string or null
languageCode	string or null
primaryEmail	string or null
secondaryEmail	string or null
phone	string or null
mobilePhone	string or null
ledgerNo	string or null
eori	string or null
vatRequired required	boolean
	Array of objects or null (Address)
	Array of objects or null (ContactInformation)
lastModifiedAt	string or null <date-time>

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"transporterNo": 0,
"externalTransporterNo": "string",
"name": "string",
"active": true,
"organizationNo": "string",
"vatIdentificationNo": "string",
"currencyCode": "string",
"languageCode": "string",
"primaryEmail": "string",
"secondaryEmail": "string",
"phone": "string",
"mobilePhone": "string",
"ledgerNo": "string",
"eori": "string",
"vatRequired": true,
"addresses": [{"addressId": "string",
"type": "Unspecified",
"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"address4": "string",
"zipCode": "string",
"city": "string",
"state": "string",
"countryCode": "string",
"gln": "string",
"routeNumber": "string"
}
],
"contactInformation": [{"contactId": "string",
"firstName": "string",
"lastName": "string",
"primaryEmail": "string",
"secondaryEmail": "string",
"phone": "string",
"mobilePhone": "string"
}
],
"lastModifiedAt": "2019-08-24T14:15:22Z"
}

Response samples

default

Content type

application/json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"property1": null,
"property2": null
}

GetTransporterAddresses

path Parameters

required

string

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

200
default

Content type

application/json

[{"addressId": "string",
"type": "Unspecified",
"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"address4": "string",
"zipCode": "string",
"city": "string",
"state": "string",
"countryCode": "string",
"gln": "string",
"routeNumber": "string"
}
]

PostTransporterAddresses

path Parameters

required

string

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

Array

addressId	string or null <guid>
type required	string (AddressType) Enum: "Unspecified" "InvoiceAddress" "DeliveryAddress"
name	string or null
address1	string or null
address2	string or null
address3	string or null
address4	string or null
zipCode	string or null
city	string or null
state	string or null
countryCode	string or null
gln	string or null
routeNumber	string or null

Responses

Request samples

Payload

Content type

application/json

[{"addressId": "string",
"type": "Unspecified",
"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"address4": "string",
"zipCode": "string",
"city": "string",
"state": "string",
"countryCode": "string",
"gln": "string",
"routeNumber": "string"
}
]

Response samples

default

Content type

application/json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"property1": null,
"property2": null
}

PutTransporterAddresses

path Parameters

required

string

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

Array

addressId	string or null <guid>
type required	string (AddressType) Enum: "Unspecified" "InvoiceAddress" "DeliveryAddress"
name	string or null
address1	string or null
address2	string or null
address3	string or null
address4	string or null
zipCode	string or null
city	string or null
state	string or null
countryCode	string or null
gln	string or null
routeNumber	string or null

Responses

Request samples

Payload

Content type

application/json

[{"addressId": "string",
"type": "Unspecified",
"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"address4": "string",
"zipCode": "string",
"city": "string",
"state": "string",
"countryCode": "string",
"gln": "string",
"routeNumber": "string"
}
]

Response samples

default

Content type

application/json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"property1": null,
"property2": null
}

Vehicle

PostLocation

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

string

Responses

Request samples

Payload

Content type

application/json

"string"

Vendor

GetVendors

query Parameters

accountId required	string <guid>
domainId required	string <guid>
VendorNo	integer or null <int32>
ChangedSince	string or null <date-time>
IncludeDeleted	boolean or null
userId	string <guid>
traceId	string <guid>

Responses

Response samples

200
default

Content type

application/json

[{"id": "string",
"vendorNo": 0,
"externalVendorNo": "string",
"name": "string",
"active": true,
"organizationNo": "string",
"vatIdentificationNo": "string",
"currencyCode": "string",
"languageCode": "string",
"primaryEmail": "string",
"secondaryEmail": "string",
"phone": "string",
"mobilePhone": "string",
"ledgerNo": "string",
"eori": "string",
"vatRequired": true,
"paymentTerms": "string",
"addresses": [{"addressId": "string",
"type": "Unspecified",
"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"address4": "string",
"zipCode": "string",
"city": "string",
"state": "string",
"countryCode": "string",
"gln": "string",
"routeNumber": "string"
}
],
"contactInformation": [{"contactId": "string",
"firstName": "string",
"lastName": "string",
"primaryEmail": "string",
"secondaryEmail": "string",
"phone": "string",
"mobilePhone": "string"
}
],
"lastModifiedAt": "2019-08-24T14:15:22Z"
}
]

PostVendor

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

Array

id	string or null <guid>
vendorNo	integer or null <int32>
externalVendorNo	string or null
name	string or null
active required	boolean
organizationNo	string or null
vatIdentificationNo	string or null
currencyCode	string or null
languageCode	string or null
primaryEmail	string or null
secondaryEmail	string or null
phone	string or null
mobilePhone	string or null
ledgerNo	string or null
eori	string or null
vatRequired required	boolean
paymentTerms	string or null
	Array of objects or null (Address)
	Array of objects or null (ContactInformation)
lastModifiedAt	string or null <date-time>

Responses

Request samples

Payload

Content type

application/json

[{"id": "string",
"vendorNo": 0,
"externalVendorNo": "string",
"name": "string",
"active": true,
"organizationNo": "string",
"vatIdentificationNo": "string",
"currencyCode": "string",
"languageCode": "string",
"primaryEmail": "string",
"secondaryEmail": "string",
"phone": "string",
"mobilePhone": "string",
"ledgerNo": "string",
"eori": "string",
"vatRequired": true,
"paymentTerms": "string",
"addresses": [{"addressId": "string",
"type": "Unspecified",
"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"address4": "string",
"zipCode": "string",
"city": "string",
"state": "string",
"countryCode": "string",
"gln": "string",
"routeNumber": "string"
}
],
"contactInformation": [{"contactId": "string",
"firstName": "string",
"lastName": "string",
"primaryEmail": "string",
"secondaryEmail": "string",
"phone": "string",
"mobilePhone": "string"
}
],
"lastModifiedAt": "2019-08-24T14:15:22Z"
}
]

Response samples

200
default

Content type

application/json

[{"id": "string",
"vendorNo": 0,
"externalVendorNo": "string",
"name": "string",
"active": true,
"organizationNo": "string",
"vatIdentificationNo": "string",
"currencyCode": "string",
"languageCode": "string",
"primaryEmail": "string",
"secondaryEmail": "string",
"phone": "string",
"mobilePhone": "string",
"ledgerNo": "string",
"eori": "string",
"vatRequired": true,
"paymentTerms": "string",
"addresses": [{"addressId": "string",
"type": "Unspecified",
"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"address4": "string",
"zipCode": "string",
"city": "string",
"state": "string",
"countryCode": "string",
"gln": "string",
"routeNumber": "string"
}
],
"contactInformation": [{"contactId": "string",
"firstName": "string",
"lastName": "string",
"primaryEmail": "string",
"secondaryEmail": "string",
"phone": "string",
"mobilePhone": "string"
}
],
"lastModifiedAt": "2019-08-24T14:15:22Z"
}
]

GetVendor

path Parameters

required

string

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

200
204
default

Content type

application/json

{"id": "string",
"vendorNo": 0,
"externalVendorNo": "string",
"name": "string",
"active": true,
"organizationNo": "string",
"vatIdentificationNo": "string",
"currencyCode": "string",
"languageCode": "string",
"primaryEmail": "string",
"secondaryEmail": "string",
"phone": "string",
"mobilePhone": "string",
"ledgerNo": "string",
"eori": "string",
"vatRequired": true,
"paymentTerms": "string",
"addresses": [{"addressId": "string",
"type": "Unspecified",
"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"address4": "string",
"zipCode": "string",
"city": "string",
"state": "string",
"countryCode": "string",
"gln": "string",
"routeNumber": "string"
}
],
"contactInformation": [{"contactId": "string",
"firstName": "string",
"lastName": "string",
"primaryEmail": "string",
"secondaryEmail": "string",
"phone": "string",
"mobilePhone": "string"
}
],
"lastModifiedAt": "2019-08-24T14:15:22Z"
}

PutVendor

path Parameters

required

string

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

id	string or null <guid>
vendorNo	integer or null <int32>
externalVendorNo	string or null
name	string or null
active required	boolean
organizationNo	string or null
vatIdentificationNo	string or null
currencyCode	string or null
languageCode	string or null
primaryEmail	string or null
secondaryEmail	string or null
phone	string or null
mobilePhone	string or null
ledgerNo	string or null
eori	string or null
vatRequired required	boolean
paymentTerms	string or null
	Array of objects or null (Address)
	Array of objects or null (ContactInformation)
lastModifiedAt	string or null <date-time>

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"vendorNo": 0,
"externalVendorNo": "string",
"name": "string",
"active": true,
"organizationNo": "string",
"vatIdentificationNo": "string",
"currencyCode": "string",
"languageCode": "string",
"primaryEmail": "string",
"secondaryEmail": "string",
"phone": "string",
"mobilePhone": "string",
"ledgerNo": "string",
"eori": "string",
"vatRequired": true,
"paymentTerms": "string",
"addresses": [{"addressId": "string",
"type": "Unspecified",
"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"address4": "string",
"zipCode": "string",
"city": "string",
"state": "string",
"countryCode": "string",
"gln": "string",
"routeNumber": "string"
}
],
"contactInformation": [{"contactId": "string",
"firstName": "string",
"lastName": "string",
"primaryEmail": "string",
"secondaryEmail": "string",
"phone": "string",
"mobilePhone": "string"
}
],
"lastModifiedAt": "2019-08-24T14:15:22Z"
}

Response samples

200
204
default

Content type

application/json

{"id": "string",
"vendorNo": 0,
"externalVendorNo": "string",
"name": "string",
"active": true,
"organizationNo": "string",
"vatIdentificationNo": "string",
"currencyCode": "string",
"languageCode": "string",
"primaryEmail": "string",
"secondaryEmail": "string",
"phone": "string",
"mobilePhone": "string",
"ledgerNo": "string",
"eori": "string",
"vatRequired": true,
"paymentTerms": "string",
"addresses": [{"addressId": "string",
"type": "Unspecified",
"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"address4": "string",
"zipCode": "string",
"city": "string",
"state": "string",
"countryCode": "string",
"gln": "string",
"routeNumber": "string"
}
],
"contactInformation": [{"contactId": "string",
"firstName": "string",
"lastName": "string",
"primaryEmail": "string",
"secondaryEmail": "string",
"phone": "string",
"mobilePhone": "string"
}
],
"lastModifiedAt": "2019-08-24T14:15:22Z"
}

GetVendorAddresses

path Parameters

required

string

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

200
default

Content type

application/json

[{"addressId": "string",
"type": "Unspecified",
"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"address4": "string",
"zipCode": "string",
"city": "string",
"state": "string",
"countryCode": "string",
"gln": "string",
"routeNumber": "string"
}
]

PostVendorAddresses

path Parameters

required

string

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

Array

addressId	string or null <guid>
type required	string (AddressType) Enum: "Unspecified" "InvoiceAddress" "DeliveryAddress"
name	string or null
address1	string or null
address2	string or null
address3	string or null
address4	string or null
zipCode	string or null
city	string or null
state	string or null
countryCode	string or null
gln	string or null
routeNumber	string or null

Responses

Request samples

Payload

Content type

application/json

[{"addressId": "string",
"type": "Unspecified",
"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"address4": "string",
"zipCode": "string",
"city": "string",
"state": "string",
"countryCode": "string",
"gln": "string",
"routeNumber": "string"
}
]

Response samples

default

Content type

application/json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"property1": null,
"property2": null
}

PutVendorAddresses

path Parameters

required

string

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

Array

addressId	string or null <guid>
type required	string (AddressType) Enum: "Unspecified" "InvoiceAddress" "DeliveryAddress"
name	string or null
address1	string or null
address2	string or null
address3	string or null
address4	string or null
zipCode	string or null
city	string or null
state	string or null
countryCode	string or null
gln	string or null
routeNumber	string or null

Responses

Request samples

Payload

Content type

application/json

[{"addressId": "string",
"type": "Unspecified",
"name": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"address4": "string",
"zipCode": "string",
"city": "string",
"state": "string",
"countryCode": "string",
"gln": "string",
"routeNumber": "string"
}
]

Response samples

default

Content type

application/json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"property1": null,
"property2": null
}

Get all contacts for Vendor

path Parameters

vendorId

required

string

The Vendor id

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

200
default

Content type

application/json

[{"contactId": "string",
"firstName": "string",
"lastName": "string",
"primaryEmail": "string",
"secondaryEmail": "string",
"phone": "string",
"mobilePhone": "string"
}
]

Add single contact to vendor

path Parameters

vendorId

required

string

The Vendor id

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

contactId	string or null <guid>
firstName	string or null
lastName	string or null
primaryEmail	string or null
secondaryEmail	string or null
phone	string or null
mobilePhone	string or null

Responses

Request samples

Payload

Content type

application/json

{"contactId": "string",
"firstName": "string",
"lastName": "string",
"primaryEmail": "string",
"secondaryEmail": "string",
"phone": "string",
"mobilePhone": "string"
}

Response samples

default

Content type

application/json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"property1": null,
"property2": null
}

Update single contact at vendor

path Parameters

vendorId

required

string

The Vendor id

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

contactId	string or null <guid>
firstName	string or null
lastName	string or null
primaryEmail	string or null
secondaryEmail	string or null
phone	string or null
mobilePhone	string or null

Responses

Request samples

Payload

Content type

application/json

{"contactId": "string",
"firstName": "string",
"lastName": "string",
"primaryEmail": "string",
"secondaryEmail": "string",
"phone": "string",
"mobilePhone": "string"
}

Response samples

default

Content type

application/json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"property1": null,
"property2": null
}

Vessel

GetById3

path Parameters

vesselId

required

string <guid>

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

Content type

application/json

{"vesselId": "string",
"code": "string",
"name": "string",
"defaultPortOfLandingId": "string",
"defaultWarehouseId": "string",
"defaultQuotaPermitId": "string",
"defaultFishingAreaId": "string",
"defaultEquipmentId": "string",
"vendorId": "string",
"ownVessel": true,
"externalVesselCode": "string",
"vesselGroupId": "string",
"isActive": true,
"isAutoQuotaEnabled": true,
"readOnly": {"portOfLandingCode": "string",
"portOfLandingDescription": "string",
"warehouseCode": "string",
"warehouseName": "string",
"quotaPermitCode": "string",
"quotaPermitDescription": "string",
"fishingAreaCode": "string",
"fishingAreaDescription": "string",
"numberOfCrew": 0,
"numberOfDeductions": 0,
"vendorNumber": "string",
"vendorName": "string",
"property1": null,
"property2": null
},
"property1": null,
"property2": null
}

Delete3

path Parameters

vesselId

required

string <guid>

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

Content type

application/json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"property1": null,
"property2": null
}

FindPaged3

query Parameters

accountId required	string <guid>
domainId required	string <guid>
vesselId	string or null <guid>
vesselCode	string or null
skip	integer or null <int32>
take	integer or null <int32>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

Content type

application/json

{"items": [{"vesselId": "string",
"code": "string",
"name": "string",
"defaultPortOfLandingId": "string",
"defaultWarehouseId": "string",
"defaultQuotaPermitId": "string",
"defaultFishingAreaId": "string",
"defaultEquipmentId": "string",
"vendorId": "string",
"ownVessel": true,
"externalVesselCode": "string",
"vesselGroupId": "string",
"isActive": true,
"isAutoQuotaEnabled": true,
"readOnly": {"portOfLandingCode": "string",
"portOfLandingDescription": "string",
"warehouseCode": "string",
"warehouseName": "string",
"quotaPermitCode": "string",
"quotaPermitDescription": "string",
"fishingAreaCode": "string",
"fishingAreaDescription": "string",
"numberOfCrew": 0,
"numberOfDeductions": 0,
"vendorNumber": "string",
"vendorName": "string",
"property1": null,
"property2": null
},
"property1": null,
"property2": null
}
],
"skip": 0,
"totalResults": 0,
"property1": null,
"property2": null
}

Create3

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

Array

vesselId required	string <guid>
code	string or null
name	string or null
defaultPortOfLandingId	string or null <guid>
defaultWarehouseId	string or null <guid>
defaultQuotaPermitId	string or null <guid>
defaultFishingAreaId	string or null <guid>
defaultEquipmentId	string or null <guid>
vendorId	string or null <guid>
ownVessel	boolean or null
externalVesselCode	string or null
vesselGroupId	string or null <guid>
isActive	boolean or null
isAutoQuotaEnabled	boolean or null
	(ReadOnlyAttributes6 (object or null))
property name* additional property	any or null

Responses

Request samples

Payload

Content type

application/json

[{"vesselId": "string",
"code": "string",
"name": "string",
"defaultPortOfLandingId": "string",
"defaultWarehouseId": "string",
"defaultQuotaPermitId": "string",
"defaultFishingAreaId": "string",
"defaultEquipmentId": "string",
"vendorId": "string",
"ownVessel": true,
"externalVesselCode": "string",
"vesselGroupId": "string",
"isActive": true,
"isAutoQuotaEnabled": true,
"readOnly": {"portOfLandingCode": "string",
"portOfLandingDescription": "string",
"warehouseCode": "string",
"warehouseName": "string",
"quotaPermitCode": "string",
"quotaPermitDescription": "string",
"fishingAreaCode": "string",
"fishingAreaDescription": "string",
"numberOfCrew": 0,
"numberOfDeductions": 0,
"vendorNumber": "string",
"vendorName": "string",
"property1": null,
"property2": null
},
"property1": null,
"property2": null
}
]

Response samples

Content type

application/json

[{"vesselId": "string",
"code": "string",
"name": "string",
"defaultPortOfLandingId": "string",
"defaultWarehouseId": "string",
"defaultQuotaPermitId": "string",
"defaultFishingAreaId": "string",
"defaultEquipmentId": "string",
"vendorId": "string",
"ownVessel": true,
"externalVesselCode": "string",
"vesselGroupId": "string",
"isActive": true,
"isAutoQuotaEnabled": true,
"readOnly": {"portOfLandingCode": "string",
"portOfLandingDescription": "string",
"warehouseCode": "string",
"warehouseName": "string",
"quotaPermitCode": "string",
"quotaPermitDescription": "string",
"fishingAreaCode": "string",
"fishingAreaDescription": "string",
"numberOfCrew": 0,
"numberOfDeductions": 0,
"vendorNumber": "string",
"vendorName": "string",
"property1": null,
"property2": null
},
"property1": null,
"property2": null
}
]

Update3

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

Array

vesselId required	string <guid>
code	string or null
name	string or null
defaultPortOfLandingId	string or null <guid>
defaultWarehouseId	string or null <guid>
defaultQuotaPermitId	string or null <guid>
defaultFishingAreaId	string or null <guid>
defaultEquipmentId	string or null <guid>
vendorId	string or null <guid>
ownVessel	boolean or null
externalVesselCode	string or null
vesselGroupId	string or null <guid>
isActive	boolean or null
isAutoQuotaEnabled	boolean or null
	(ReadOnlyAttributes6 (object or null))
property name* additional property	any or null

Responses

Request samples

Payload

Content type

application/json

[{"vesselId": "string",
"code": "string",
"name": "string",
"defaultPortOfLandingId": "string",
"defaultWarehouseId": "string",
"defaultQuotaPermitId": "string",
"defaultFishingAreaId": "string",
"defaultEquipmentId": "string",
"vendorId": "string",
"ownVessel": true,
"externalVesselCode": "string",
"vesselGroupId": "string",
"isActive": true,
"isAutoQuotaEnabled": true,
"readOnly": {"portOfLandingCode": "string",
"portOfLandingDescription": "string",
"warehouseCode": "string",
"warehouseName": "string",
"quotaPermitCode": "string",
"quotaPermitDescription": "string",
"fishingAreaCode": "string",
"fishingAreaDescription": "string",
"numberOfCrew": 0,
"numberOfDeductions": 0,
"vendorNumber": "string",
"vendorName": "string",
"property1": null,
"property2": null
},
"property1": null,
"property2": null
}
]

Response samples

Content type

application/json

[{"vesselId": "string",
"code": "string",
"name": "string",
"defaultPortOfLandingId": "string",
"defaultWarehouseId": "string",
"defaultQuotaPermitId": "string",
"defaultFishingAreaId": "string",
"defaultEquipmentId": "string",
"vendorId": "string",
"ownVessel": true,
"externalVesselCode": "string",
"vesselGroupId": "string",
"isActive": true,
"isAutoQuotaEnabled": true,
"readOnly": {"portOfLandingCode": "string",
"portOfLandingDescription": "string",
"warehouseCode": "string",
"warehouseName": "string",
"quotaPermitCode": "string",
"quotaPermitDescription": "string",
"fishingAreaCode": "string",
"fishingAreaDescription": "string",
"numberOfCrew": 0,
"numberOfDeductions": 0,
"vendorNumber": "string",
"vendorName": "string",
"property1": null,
"property2": null
},
"property1": null,
"property2": null
}
]

Warehouse

GetWarehouses

query Parameters

accountId required	string <guid>
domainId required	string <guid>
includeDeleted	boolean or null
userId	string <guid>
traceId	string <guid>

Responses

Response samples

200
default

Content type

application/json

[{"warehouseName": "string",
"isVirtual": true,
"notAvailableForAllocation": true,
"extCode": "string",
"active": true,
"address": {"addressId": "string",
"domainId": "string",
"actorId": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"address4": "string",
"city": "string",
"state": "string",
"postCode": "string",
"countryCode": "string",
"countryId": "string",
"countryName": "string",
"gln": "string",
"description": "string",
"primaryAddress": true,
"invoiceAddress": true,
"deliveryAddress": true,
"addressPhone": "string",
"addressEmail": "string",
"routeNumber": "string",
"accountId": "string",
"createdBy": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"updatedAt": "2019-08-24T14:15:22Z",
"isDeleted": true,
"property1": null,
"property2": null
},
"warehouseId": "string"
}
]

PostWareHouse

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

warehouseName	string or null
isVirtual required	boolean
notAvailableForAllocation required	boolean
extCode	string or null
active	boolean or null
	(AddressModel (object or null))

Responses

Request samples

Payload

Content type

application/json

{"warehouseName": "string",
"isVirtual": true,
"notAvailableForAllocation": true,
"extCode": "string",
"active": true,
"address": {"addressId": "string",
"domainId": "string",
"actorId": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"address4": "string",
"city": "string",
"state": "string",
"postCode": "string",
"countryCode": "string",
"countryId": "string",
"countryName": "string",
"gln": "string",
"description": "string",
"primaryAddress": true,
"invoiceAddress": true,
"deliveryAddress": true,
"addressPhone": "string",
"addressEmail": "string",
"routeNumber": "string",
"accountId": "string",
"createdBy": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"updatedAt": "2019-08-24T14:15:22Z",
"isDeleted": true,
"property1": null,
"property2": null
}
}

Response samples

200
204
default

Content type

application/json

{"warehouseName": "string",
"isVirtual": true,
"notAvailableForAllocation": true,
"extCode": "string",
"active": true,
"address": {"addressId": "string",
"domainId": "string",
"actorId": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"address4": "string",
"city": "string",
"state": "string",
"postCode": "string",
"countryCode": "string",
"countryId": "string",
"countryName": "string",
"gln": "string",
"description": "string",
"primaryAddress": true,
"invoiceAddress": true,
"deliveryAddress": true,
"addressPhone": "string",
"addressEmail": "string",
"routeNumber": "string",
"accountId": "string",
"createdBy": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"updatedAt": "2019-08-24T14:15:22Z",
"isDeleted": true,
"property1": null,
"property2": null
},
"warehouseId": "string"
}

PutWarehouse

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

warehouseName	string or null
isVirtual required	boolean
notAvailableForAllocation required	boolean
extCode	string or null
active	boolean or null
	(AddressModel (object or null))
warehouseId	string or null <guid>

Responses

Request samples

Payload

Content type

application/json

{"warehouseName": "string",
"isVirtual": true,
"notAvailableForAllocation": true,
"extCode": "string",
"active": true,
"address": {"addressId": "string",
"domainId": "string",
"actorId": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"address4": "string",
"city": "string",
"state": "string",
"postCode": "string",
"countryCode": "string",
"countryId": "string",
"countryName": "string",
"gln": "string",
"description": "string",
"primaryAddress": true,
"invoiceAddress": true,
"deliveryAddress": true,
"addressPhone": "string",
"addressEmail": "string",
"routeNumber": "string",
"accountId": "string",
"createdBy": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"updatedAt": "2019-08-24T14:15:22Z",
"isDeleted": true,
"property1": null,
"property2": null
},
"warehouseId": "string"
}

Response samples

200
204
default

Content type

application/json

{"warehouseName": "string",
"isVirtual": true,
"notAvailableForAllocation": true,
"extCode": "string",
"active": true,
"address": {"addressId": "string",
"domainId": "string",
"actorId": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"address4": "string",
"city": "string",
"state": "string",
"postCode": "string",
"countryCode": "string",
"countryId": "string",
"countryName": "string",
"gln": "string",
"description": "string",
"primaryAddress": true,
"invoiceAddress": true,
"deliveryAddress": true,
"addressPhone": "string",
"addressEmail": "string",
"routeNumber": "string",
"accountId": "string",
"createdBy": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"updatedAt": "2019-08-24T14:15:22Z",
"isDeleted": true,
"property1": null,
"property2": null
},
"warehouseId": "string"
}

GetWarehouse

path Parameters

required

string <guid>

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

200
204
default

Content type

application/json

{"warehouseName": "string",
"isVirtual": true,
"notAvailableForAllocation": true,
"extCode": "string",
"active": true,
"address": {"addressId": "string",
"domainId": "string",
"actorId": "string",
"address1": "string",
"address2": "string",
"address3": "string",
"address4": "string",
"city": "string",
"state": "string",
"postCode": "string",
"countryCode": "string",
"countryId": "string",
"countryName": "string",
"gln": "string",
"description": "string",
"primaryAddress": true,
"invoiceAddress": true,
"deliveryAddress": true,
"addressPhone": "string",
"addressEmail": "string",
"routeNumber": "string",
"accountId": "string",
"createdBy": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"updatedAt": "2019-08-24T14:15:22Z",
"isDeleted": true,
"property1": null,
"property2": null
},
"warehouseId": "string"
}

DeleteWarehouse

path Parameters

required

string <guid>

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

default

Content type

application/json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"property1": null,
"property2": null
}

ILMS

GetChangedOrdersSince

query Parameters

accountId required	string <guid>
domainId required	string <guid>
since	string <date-time>
userId	string <guid>
traceId	string <guid>

Responses

GetChangedOrdersWithinDateInterval

query Parameters

accountId required	string <guid>
domainId required	string <guid>
fromDate	string <date-time>
toDate	string <date-time>
userId	string <guid>
traceId	string <guid>

Responses

Customs

ReceiveExternalGoodsRegistrationNumber

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Request Body schema: application/json
required

string

Responses

Request samples

Payload

Content type

application/json

"string"

Response samples

400
default

Content type

application/json

{"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"applicationId": ["string"
],
"errors": {"property1": ["string"
],
"property2": ["string"
]
},
"property1": null,
"property2": null
}

DKPlusCallback

DKplusWebhookCallback

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Responses

ApiLogging

GetApiLogs

query Parameters

accountId required	string <guid>
domainId required	string <guid>
fromTime	string <date-time>
toTime	string <date-time>
Method	string or null
Path	string or null
Query	string or null
StatusCode	integer or null <int32>
IsSuccess	boolean or null
ActionName	string or null
RouteTemplate	string or null
RequestContent	string or null
ResponseContent	string or null
CreatedBy	string or null <guid>
Skip	integer or null <int32>
Take	integer or null <int32>
RowCount	boolean or null
userId	string <guid>
traceId	string <guid>

Responses

Response samples

default

Content type

application/json

[{"method": "string",
"path": "string",
"id": 0,
"requestSize": 0,
"responseSize": 0,
"requestBody": "http://example.com",
"responseBody": "http://example.com",
"query": "string",
"protocol": "string",
"scheme": "string",
"statusCode": 0,
"rateLimited": true,
"isSuccess": true,
"endpoint": "string",
"actionName": "string",
"routeTemplate": "string",
"createdAt": "2019-08-24T14:15:22Z",
"createdBy": "string",
"applicationId": "string"
}
]

GetRequestPayload

path Parameters

required

integer <int64>

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Responses

GetResponsePayload

path Parameters

required

integer <int64>

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Responses

GetActiveApiUsers

query Parameters

accountId required	string <guid>
domainId required	string <guid>
userId	string <guid>
traceId	string <guid>

Responses

Response samples

Content type

application/json

[{"userId": "string",
"requestCount": 0
}
]

Maritech API (1.0.0)

Accounting

GetAccountingBatches

query Parameters

Responses

Response samples

GetAccountingBatch

path Parameters

query Parameters

Responses

Response samples

GetAccountingBatchForDebug

query Parameters

Responses

Response samples

UpdateAccountingBatchStatus

path Parameters

query Parameters

Responses

Response samples

Allocation

Allocate to sales order

query Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

CatchField

GetCatchFields

query Parameters

Responses

Response samples

Configuration

GetClientConfig

query Parameters

Responses

Response samples

PutClientConfig

query Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

GetIntegrationConfig

query Parameters

Responses

Response samples

GetRateLimitConfig

query Parameters

Responses

Response samples

PutRateLimitConfig

query Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Contacts

GetContacts

query Parameters

Responses

Response samples

CostSetup

Get cost setups

query Parameters

Responses

Response samples

Create cost setup

query Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get a cost setup

path Parameters

query Parameters

Responses

Response samples

Patch cost setup

path Parameters

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required