API docs by Redocly

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

Content type
application/json
[
  • {
    }
]

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

Content type
application/json
{
  • "id": "string",
  • "batchNo": 0,
  • "isPosted": true,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "vouchers": [
    ]
}

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

Content type
application/json
{
  • "id": "string",
  • "batchNo": 0,
  • "isPosted": true,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "vouchers": [
    ]
}

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

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

Content type
application/json
[
  • {
    }
]

Response samples

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

Content type
application/json
[
  • {
    }
]

Configuration

GetClientConfig

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

Responses

Response samples

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

Content type
application/json
{
  • "vendorIdType": "Guid",
  • "customerIdType": "Guid",
  • "transporterIdType": "Guid",
  • "exporterIdType": "Guid",
  • "employeeIdType": "Guid"
}

Response samples

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

Content type
application/json
{
  • "salesOrderStatuses": [
    ],
  • "purchaseOrderStatuses": [
    ],
  • "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

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

Content type
application/json
{
  • "limit": 0,
  • "window": "string"
}

Response samples

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

Content type
application/json
[
  • {
    }
]

Country

GetCountries

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

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Crew

ListCrewActors

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

Responses

Response samples

Content type
application/json
[
  • {
    }
]

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

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

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

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": {
    }
}

UpdateCrewActor

path Parameters
id
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

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": {
    }
}

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

Content type
application/json
[
  • {
    }
]

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

Content type
application/json
[
  • {
    }
]

Response samples

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

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

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>
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>
userId
string <guid>
traceId
string <guid>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

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)
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

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

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

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

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
"string"

Get single customer

path Parameters
id
required
string
query Parameters
accountId
required
string <guid>
domainId
required
string <guid>
userId
string <guid>
traceId
string <guid>

Responses

Response samples

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": [
    ],
  • "contactInformation": [
    ],
  • "privateOrCompany": "string",
  • "creditLimit": 0,
  • "insuranceLimit": 0,
  • "lastModifiedAt": "2019-08-24T14:15:22Z"
}

PutCustomer

path Parameters
id
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>
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)
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

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": [
    ],
  • "contactInformation": [
    ],
  • "privateOrCompany": "string",
  • "creditLimit": 0,
  • "insuranceLimit": 0,
  • "lastModifiedAt": "2019-08-24T14:15:22Z"
}

Response samples

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": [
    ],
  • "contactInformation": [
    ],
  • "privateOrCompany": "string",
  • "creditLimit": 0,
  • "insuranceLimit": 0,
  • "lastModifiedAt": "2019-08-24T14:15:22Z"
}

GetCustomerAddresses

path Parameters
id
required
string
query Parameters
accountId
required
string <guid>
domainId
required
string <guid>
userId
string <guid>
traceId
string <guid>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

PostCustomerAddresses

path Parameters
id
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

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

PutCustomerAddresses

path Parameters
id
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

Content type
application/json
[
  • {
    }
]

Response samples

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

Content type
application/json
[
  • {
    }
]

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

Content type
application/json
{
  • "contactId": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "primaryEmail": "string",
  • "secondaryEmail": "string",
  • "phone": "string",
  • "mobilePhone": "string"
}

Response samples

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

Content type
application/json
{
  • "contactId": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "primaryEmail": "string",
  • "secondaryEmail": "string",
  • "phone": "string",
  • "mobilePhone": "string"
}

Response samples

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

Content type
application/json
[
  • {
    }
]

Response samples

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

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

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

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

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))
(DimensionType (object or null))
dimensionName
string or null
userId
string <guid>
traceId
string <guid>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Use to add or update

query Parameters
accountId
required
string <guid>
domainId
required
string <guid>
required
(DimensionType (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

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "name": "string",
  • "dimensionType": "string",
  • "lastModifiedAt": "2019-08-24T14:15:22Z",
  • "values": [
    ]
}

DeleteDimensionValues

query Parameters
accountId
required
string <guid>
domainId
required
string <guid>
required
(DimensionType (object or null))
userId
string <guid>
traceId
string <guid>
Request Body schema: application/json
required
Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "applicationId": [
    ],
  • "errors": {
    },
  • "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

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

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

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>
userId
string <guid>
traceId
string <guid>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

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

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

GetEmployee

path Parameters
id
required
string
query Parameters
accountId
required
string <guid>
domainId
required
string <guid>
userId
string <guid>
traceId
string <guid>

Responses

Response samples

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": {
    }
}

PutEmployee

path Parameters
id
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

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": {
    }
}

Response samples

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": {
    },
  • "readOnly": {
    }
}

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": [
    ],
  • "skip": 0,
  • "totalResults": 0
}

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))

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

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))

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

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

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>
userId
string <guid>
traceId
string <guid>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

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

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

GetExporter

path Parameters
id
required
string
query Parameters
accountId
required
string <guid>
domainId
required
string <guid>
userId
string <guid>
traceId
string <guid>

Responses

Response samples

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": [
    ],
  • "contactInformation": [
    ],
  • "lastModifiedAt": "2019-08-24T14:15:22Z"
}

PutExporter

path Parameters
id
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

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": [
    ],
  • "contactInformation": [
    ],
  • "lastModifiedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

GetExporterAddresses

path Parameters
id
required
string
query Parameters
accountId
required
string <guid>
domainId
required
string <guid>
userId
string <guid>
traceId
string <guid>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

PostExporterAddresses

path Parameters
id
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

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

PutExporterAddresses

path Parameters
id
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

Content type
application/json
[
  • {
    }
]

Response samples

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

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

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

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

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

Content type
application/json
{
  • "data": [
    ]
}

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

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "data": [
    ]
}

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": [
    ],
  • "fishingTripFees": [
    ]
}

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
userId
string <guid>
traceId
string <guid>

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "skip": 0,
  • "totalResults": 0
}

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"

Responses

Request samples

Content type
application/json
{
  • "items": [
    ],
  • "flags": "NotSet"
}

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)

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

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)

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

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

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

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

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

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

Content type
application/json
{
  • "trades": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

GeneralLedger

GetGeneralLedgers

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

Responses

Response samples

Content type
application/json
[
  • {
    }
]

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

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

GetGeneralLedgers2

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

Responses

Response samples

Content type
application/json
[
  • {
    }
]

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

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

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

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

Content type
application/json
{
  • "name": "string",
  • "active": true,
  • "vatCode": "string",
  • "ledgerType": "Sale"
}

Response samples

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

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

Content type
application/json
{
  • "name": "string",
  • "active": true,
  • "vatCode": "string",
  • "ledgerType": "Sale"
}

Response samples

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

Content type
application/json
[
  • {
    }
]

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

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

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

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

DeleteHarvestPlanOrder

query Parameters
accountId
required
string <guid>
domainId
required
string <guid>
harvestPlantOrderId
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
}

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
string

Packing plant id (aka packing label). Mandatory field.

warehouse
string or null

Warehosue code or name.

itemCode
string

Item code. Mandatory field.

batchNo
string or null
lotNo
string or null
purchaseOrderNo
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
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

Content type
application/json
[
  • {
    }
]

Response samples

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
string

Packing plant id (aka packing label). Mandatory field.

warehouse
string or null

Warehosue code or name.

itemCode
string

Item code. Mandatory field.

batchNo
string or null
lotNo
string or null
purchaseOrderNo
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
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

Content type
application/json
[
  • {
    }
]

Response samples

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

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

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

Content type
application/json
[
  • {
    }
]

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
userId
string <guid>
traceId
string <guid>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Patch inventory box

Sets properties on individual boxes identified by SSCC. Payload is a list of dictionaries with keys: sscc (required), subStatusId, extPalletNo.

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 or null
extPalletNo
string or null
subStatusId
string or null <guid>

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

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, extPalletNo.

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 or null
extPalletNo
string or null
subStatusId
string or null <guid>

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

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

Content type
application/json
{
  • "boxes": [
    ],
  • "pallets": [
    ],
  • "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

Content type
application/json
{
  • "data": [
    ]
}

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

Content type
application/json
{
  • "data": [
    ]
}

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

Content type
application/json
[
  • {
    }
]

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

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": {
    },
  • "customerReference": "string",
  • "headerText": "string",
  • "footerText": "string",
  • "personResponsibleId": "string",
  • "personResponsibleSentBy": "string",
  • "sentBy": "string",
  • "sentAt": "2019-08-24T14:15:22Z",
  • "personResponsiblePostedBy": "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": [
    ],
  • "lines": [
    ],
  • "customerId": "string",
  • "customerName": "string",
  • "customerNo": "string",
  • "sumsByVatRate": [
    ],
  • "sumsByTaxCode": [
    ],
  • "isExport": true,
  • "isExportDeclaration": true,
  • "isExportPosting": true,
  • "isProforma": true,
  • "isFactoring": true,
  • "factoringDate": "2019-08-24",
  • "factoringBatchNo": 0,
  • "factoringBatchId": "string",
  • "factoringBatch": {
    },
  • "factoringStatus": "NotReady",
  • "kid": "string",
  • "refInvoiceId": "string",
  • "refInvoiceNo": 0,
  • "imported": true,
  • "customsOfficeCode": "string",
  • "ledgerNo": "string",
  • "invoiceDeclaration": true,
  • "cases": [
    ],
  • "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": [
    ],
  • "forexHedgeBundleId": "string",
  • "accountingEntryDate": "2019-08-24",
  • "containerNo": "string",
  • "sealNo": "string",
  • "decimals": 0,
  • "frozen": true,
  • "bankInformation": {
    },
  • "factoringCustomer": {
    },
  • "basedOnCount": 0,
  • "originToCount": 0,
  • "isSample": true,
  • "electronicInvoiceType": "string",
  • "healthCertificateId": "string",
  • "sentToHC": true,
  • "foreignVatId": "string",
  • "vatTexts": [
    ],
  • "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

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": {
    },
  • "customerReference": "string",
  • "headerText": "string",
  • "footerText": "string",
  • "personResponsibleId": "string",
  • "personResponsibleSentBy": "string",
  • "sentBy": "string",
  • "sentAt": "2019-08-24T14:15:22Z",
  • "personResponsiblePostedBy": "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": [
    ],
  • "lines": [
    ],
  • "customerId": "string",
  • "customerName": "string",
  • "customerNo": "string",
  • "sumsByVatRate": [
    ],
  • "sumsByTaxCode": [
    ],
  • "isExport": true,
  • "isExportDeclaration": true,
  • "isExportPosting": true,
  • "isProforma": true,
  • "isFactoring": true,
  • "factoringDate": "2019-08-24",
  • "factoringBatchNo": 0,
  • "factoringBatchId": "string",
  • "factoringBatch": {
    },
  • "factoringStatus": "NotReady",
  • "kid": "string",
  • "refInvoiceId": "string",
  • "refInvoiceNo": 0,
  • "imported": true,
  • "customsOfficeCode": "string",
  • "ledgerNo": "string",
  • "invoiceDeclaration": true,
  • "cases": [
    ],
  • "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": [
    ],
  • "forexHedgeBundleId": "string",
  • "accountingEntryDate": "2019-08-24",
  • "containerNo": "string",
  • "sealNo": "string",
  • "decimals": 0,
  • "frozen": true,
  • "bankInformation": {
    },
  • "factoringCustomer": {
    },
  • "basedOnCount": 0,
  • "originToCount": 0,
  • "isSample": true,
  • "electronicInvoiceType": "string",
  • "healthCertificateId": "string",
  • "sentToHC": true,
  • "foreignVatId": "string",
  • "vatTexts": [
    ],
  • "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

Content type
application/json
{
  • "customsReceiptNo": "string"
}

Response samples

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": {
    },
  • "kid": "string",
  • "paymentTerms": {
    },
  • "totalNetAmount": 0,
  • "totalGrossAmount": 0,
  • "totalVatAmounts": [
    ],
  • "lines": [
    ],
  • "orders": [
    ],
  • "type": "string",
  • "customer": {
    },
  • "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
userId
string <guid>
traceId
string <guid>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

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

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": [
    ]
}

Response samples

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": [
    ],
  • "translations": {
    },
  • "lastModifiedAt": "2019-08-24T14:15:22Z"
}

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

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": [
    ]
}

Response samples

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": [
    ],
  • "translations": {
    },
  • "lastModifiedAt": "2019-08-24T14:15:22Z"
}

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

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

Content type
application/json
[
  • {
    }
]

Label

GetLabels

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

Responses

Response samples

Content type
application/json
[
  • {
    }
]

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

Content type
application/json
[
  • {
    }
]

Response samples

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>
userId
string <guid>
traceId
string <guid>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

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

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

Content type
application/json
[
  • {
    }
]

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

Content type
application/json
{
  • "messageId": "string",
  • "messageType": "string",
  • "status": "string",
  • "messageText": "string",
  • "time": "2019-08-24T14:15:22Z",
  • "size": 0,
  • "metadata": {
    }
}

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

Content type
application/json
[
  • {
    }
]

GetMessage

path Parameters
id
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

Content type
application/json
{
  • "messageId": "string",
  • "messageType": "string",
  • "status": "string",
  • "messageText": "string",
  • "time": "2019-08-24T14:15:22Z",
  • "size": 0,
  • "metadata": {
    },
  • "content": "string"
}

SetMessageRead

path Parameters
id
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
{
  • "messageId": "string",
  • "messageType": "string",
  • "status": "string",
  • "messageText": "string",
  • "time": "2019-08-24T14:15:22Z",
  • "size": 0,
  • "metadata": {
    },
  • "content": "string"
}

GetMessageContent

path Parameters
id
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
}

PaymentTerms

GetAllPaymentTerms

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

Responses

Response samples

Content type
application/json
[
  • {
    }
]

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

Content type
application/json
[
  • {
    }
]

Response samples

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

Content type
application/json
{
  • "id": "string",
  • "code": "string",
  • "name": "string",
  • "numberOfDays": 0,
  • "calculateFrom": "string"
}

Response samples

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

GetPaymentTerm

path Parameters
id
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
{
  • "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

Content type
application/json
{
  • "payrollCodeId": "string",
  • "code": "string",
  • "description": "string",
  • "payrollCodeType": "Earnings"
}

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

Content type
application/json
{
  • "items": [
    ],
  • "skip": 0,
  • "totalResults": 0
}

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"

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

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"

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

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

Content type
application/json
[
  • {
    }
]

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

Content type
application/json
{
  • "purchaseOrder": "string",
  • "palletSscc": "string"
}

Response samples

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

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

Content type
application/json
{
  • "items": [
    ],
  • "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

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

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": {
    }
}

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

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": {
    }
}

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

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

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": {
    }
}

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

Content type
application/json
{
  • "property1": null,
  • "property2": null
}

Response samples

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": {
    }
}

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

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

Content type
application/json
{
  • "items": [
    ],
  • "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

Content type
application/json
{
  • "items": [
    ],
  • "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

Content type
application/json
{
  • "items": [
    ],
  • "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

Content type
application/json
[
  • {
    }
]

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

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": [
    ],
  • "landingNotes": [
    ],
  • "forecasts": [
    ],
  • "dimensions": [
    ],
  • "boxes": [
    ]
}

Response samples

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": [
    ],
  • "landingNotes": [
    ],
  • "forecasts": [
    ],
  • "dimensions": [
    ],
  • "boxes": [
    ]
}

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

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": [
    ],
  • "landingNotes": [
    ],
  • "forecasts": [
    ],
  • "dimensions": [
    ],
  • "boxes": [
    ]
}

Response samples

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": [
    ],
  • "landingNotes": [
    ],
  • "forecasts": [
    ],
  • "dimensions": [
    ],
  • "boxes": [
    ]
}

Patch purchase 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

Content type
application/json
{
  • "property1": null,
  • "property2": null
}

Response samples

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": [
    ],
  • "landingNotes": [
    ],
  • "forecasts": [
    ],
  • "dimensions": [
    ],
  • "boxes": [
    ]
}

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

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": [
    ],
  • "landingNotes": [
    ],
  • "forecasts": [
    ],
  • "dimensions": [
    ],
  • "boxes": [
    ]
}

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

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",
  • "systemStatus": "string",
  • "isDeleted": true,
  • "currencyId": "string",
  • "weightUnitId": "string",
  • "customerOrderNo": "string",
  • "customerPurchaseOrderNo": "string",
  • "comment": "string",
  • "tags": [
    ],
  • "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": [
    ],
  • "dimensions": [
    ],
  • "boxes": [
    ],
  • "property1": null,
  • "property2": null
}

Get pallets and boxes from raw material storage

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

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get pallets and boxes from raw material storage

path Parameters
purchaseOrder
required
string
query Parameters
accountId
required
string <guid>
domainId
required
string <guid>
userId
string <guid>
traceId
string <guid>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

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

Content type
application/json
[
  • {
    }
]

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

Content type
application/json
[
  • {
    }
]

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
required
string <guid>
contentType
string or null
documentType
string or null
fileName
string or null
payLoad
string or null <byte>

Responses

Request samples

Content type
application/json
{
  • "purchaseOrderId": "string",
  • "contentType": "string",
  • "documentType": "string",
  • "fileName": "string",
  • "payLoad": "string"
}

Response samples

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

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

Content type
application/json
{
  • "limit": 0,
  • "window": "string"
}

Response samples

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

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": {
    },
  • "responsiblePersonName": "string",
  • "packingPlant": {
    },
  • "warehouse": {
    },
  • "packingDate": "2019-08-24",
  • "eta": "2019-08-24T14:15:22Z",
  • "etd": "2019-08-24T14:15:22Z",
  • "weightUnitId": "string",
  • "tags": [
    ],
  • "tripNo": "string",
  • "transportRegNo": "string",
  • "transporterNo": "string",
  • "transporterName": "string",
  • "externalOrderInformation": "string",
  • "awbNo": "string",
  • "subStatus": {
    },
  • "systemStatus": "string",
  • "orderLines": [
    ],
  • "boxes": [
    ]
}

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": [
    ],
  • "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": [
    ],
  • "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

Content type
application/json
[
  • {
    }
]

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>
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
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)
gln
string or null
organizationNo
string or null
deliveryGLN
string or null
property name*
additional property
any or null

Responses

Request samples

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",
  • "systemStatus": "string",
  • "isDeleted": true,
  • "currencyId": "string",
  • "weightUnitId": "string",
  • "customerOrderNo": "string",
  • "customerPurchaseOrderNo": "string",
  • "comment": "string",
  • "tags": [
    ],
  • "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": [
    ],
  • "dimensions": [
    ],
  • "boxes": [
    ],
  • "property1": null,
  • "property2": null,
  • "gln": "string",
  • "organizationNo": "string",
  • "deliveryGLN": "string"
}

Response samples

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",
  • "systemStatus": "string",
  • "isDeleted": true,
  • "currencyId": "string",
  • "weightUnitId": "string",
  • "customerOrderNo": "string",
  • "customerPurchaseOrderNo": "string",
  • "comment": "string",
  • "tags": [
    ],
  • "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": [
    ],
  • "dimensions": [
    ],
  • "boxes": [
    ],
  • "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>
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
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)
property name*
additional property
any or null

Responses

Request samples

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",
  • "systemStatus": "string",
  • "isDeleted": true,
  • "currencyId": "string",
  • "weightUnitId": "string",
  • "customerOrderNo": "string",
  • "customerPurchaseOrderNo": "string",
  • "comment": "string",
  • "tags": [
    ],
  • "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": [
    ],
  • "dimensions": [
    ],
  • "boxes": [
    ],
  • "property1": null,
  • "property2": null
}

Response samples

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",
  • "systemStatus": "string",
  • "isDeleted": true,
  • "currencyId": "string",
  • "weightUnitId": "string",
  • "customerOrderNo": "string",
  • "customerPurchaseOrderNo": "string",
  • "comment": "string",
  • "tags": [
    ],
  • "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": [
    ],
  • "dimensions": [
    ],
  • "boxes": [
    ],
  • "property1": null,
  • "property2": null
}

Patch sales 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

Content type
application/json
{
  • "property1": null,
  • "property2": null
}

Response samples

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",
  • "systemStatus": "string",
  • "isDeleted": true,
  • "currencyId": "string",
  • "weightUnitId": "string",
  • "customerOrderNo": "string",
  • "customerPurchaseOrderNo": "string",
  • "comment": "string",
  • "tags": [
    ],
  • "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": [
    ],
  • "dimensions": [
    ],
  • "boxes": [
    ],
  • "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

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",
  • "systemStatus": "string",
  • "isDeleted": true,
  • "currencyId": "string",
  • "weightUnitId": "string",
  • "customerOrderNo": "string",
  • "customerPurchaseOrderNo": "string",
  • "comment": "string",
  • "tags": [
    ],
  • "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": [
    ],
  • "dimensions": [
    ],
  • "boxes": [
    ],
  • "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

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",
  • "systemStatus": "string",
  • "isDeleted": true,
  • "currencyId": "string",
  • "weightUnitId": "string",
  • "customerOrderNo": "string",
  • "customerPurchaseOrderNo": "string",
  • "comment": "string",
  • "tags": [
    ],
  • "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": [
    ],
  • "dimensions": [
    ],
  • "boxes": [
    ],
  • "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

Content type
application/json
[
  • {
    }
]

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

Content type
application/json
[
  • {
    }
]

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>
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

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,
  • "unitsPerPallet": 0,
  • "piecesPerUnit": 0,
  • "notes": "string",
  • "price": 0,
  • "priceUnit": 0,
  • "isDeleted": true
}

Response samples

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,
  • "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>
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

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,
  • "unitsPerPallet": 0,
  • "piecesPerUnit": 0,
  • "notes": "string",
  • "price": 0,
  • "priceUnit": 0,
  • "isDeleted": true
}

Response samples

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,
  • "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

Content type
application/json
{
  • "property1": null,
  • "property2": null
}

Response samples

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,
  • "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

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,
  • "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

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,
  • "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
[
  • {
    }
]

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"

Responses

Request samples

Content type
application/json
[
  • {
    }
]

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": [
    ],
  • "deliveryPlace": {
    },
  • "subStatus": {
    },
  • "externalOrderInformation": "string",
  • "eta": "2019-08-24T14:15:22Z",
  • "etd": "2019-08-24T14:15:22Z",
  • "fromWarehouse": "string",
  • "systemStatus": "string",
  • "orderLines": [
    ],
  • "boxes": [
    ],
  • "dimensions": [
    ],
  • "transportationTasks": [
    ]
}

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": [
    ],
  • "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": [
    ],
  • "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
[
  • {
    }
]

Tag

GetTags

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

Responses

Response samples

Content type
application/json
[
  • {
    }
]

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

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "applicationId": [
    ],
  • "errors": {
    },
  • "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

Content type
application/json
"string"

Response samples

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "applicationId": [
    ],
  • "errors": {
    },
  • "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

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "applicationId": [
    ],
  • "errors": {
    },
  • "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

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "applicationId": [
    ],
  • "errors": {
    },
  • "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

Content type
application/json
{
  • "name": "string",
  • "interchangeId": "string",
  • "signatureLines": [
    ],
  • "latitude": 0.1,
  • "longitude": 0.1,
  • "date": "string",
  • "transporterCode": "string",
  • "freeText": "string",
  • "publicPictures": [
    ],
  • "waitingTime": 0.1,
  • "customerIsPresent": true,
  • "executedBy": {
    },
  • "arrivalTime": "string"
}

Response samples

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "applicationId": [
    ],
  • "errors": {
    },
  • "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

Content type
application/json
{
  • "name": "string",
  • "interchangeId": "string",
  • "signatureLines": [
    ],
  • "latitude": 0.1,
  • "longitude": 0.1,
  • "date": "string",
  • "transporterCode": "string",
  • "freeText": "string",
  • "publicPictures": [
    ],
  • "waitingTime": 0.1,
  • "customerIsPresent": true,
  • "executedBy": {
    },
  • "arrivalTime": "string"
}

Response samples

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "applicationId": [
    ],
  • "errors": {
    },
  • "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

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "applicationId": [
    ],
  • "errors": {
    },
  • "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

Content type
application/json
"string"

Response samples

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "applicationId": [
    ],
  • "errors": {
    },
  • "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

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "applicationId": [
    ],
  • "errors": {
    },
  • "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

Content type
application/json
"string"

Response samples

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "applicationId": [
    ],
  • "errors": {
    },
  • "property1": null,
  • "property2": null
}

ConfirmReportOrderOrTripReceived2

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",
  • "applicationId": [
    ],
  • "errors": {
    },
  • "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

Content type
application/json
"string"

Response samples

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "applicationId": [
    ],
  • "errors": {
    },
  • "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

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "applicationId": [
    ],
  • "errors": {
    },
  • "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

Content type
application/json
"string"

Response samples

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "applicationId": [
    ],
  • "errors": {
    },
  • "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

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "applicationId": [
    ],
  • "errors": {
    },
  • "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

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "applicationId": [
    ],
  • "errors": {
    },
  • "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

Content type
application/json
"string"

Response samples

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "applicationId": [
    ],
  • "errors": {
    },
  • "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

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "applicationId": [
    ],
  • "errors": {
    },
  • "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

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "applicationId": [
    ],
  • "errors": {
    },
  • "property1": null,
  • "property2": null
}

ConfirmGetClaimCategories

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",
  • "applicationId": [
    ],
  • "errors": {
    },
  • "property1": null,
  • "property2": null
}

ConfirmCreateClaim

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",
  • "applicationId": [
    ],
  • "errors": {
    },
  • "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

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "applicationId": [
    ],
  • "errors": {
    },
  • "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

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "applicationId": [
    ],
  • "errors": {
    },
  • "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

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "applicationId": [
    ],
  • "errors": {
    },
  • "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

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "applicationId": [
    ],
  • "errors": {
    },
  • "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

Content type
application/json
{
  • "ediMessage": "string"
}

Response samples

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "applicationId": [
    ],
  • "errors": {
    },
  • "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

Content type
application/json
{
  • "ediMessage": "string"
}

Response samples

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "applicationId": [
    ],
  • "errors": {
    },
  • "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

Content type
application/json
{
  • "orderId": "string",
  • "documentId": "string",
  • "documentType": "string",
  • "description": "string",
  • "fileName": "string",
  • "contents": "string",
  • "interchangeId": "string"
}

Response samples

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "applicationId": [
    ],
  • "errors": {
    },
  • "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

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "applicationId": [
    ],
  • "errors": {
    },
  • "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

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "applicationId": [
    ],
  • "errors": {
    },
  • "property1": null,
  • "property2": null
}

TMSDrivers

GetListOfDrivers

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

Responses

CreateDriver

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

Responses

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
"string"

UpdateDriver

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
"string"

TMSVehicles

GetListOfVehicles

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

Responses

CreateVehicle

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

Responses

Response samples

Content type
application/json
"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
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

UpdateVehicle

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
"string"

TMSVehicleTypes

GetListOfVehicleTypes

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

Responses

CreateVehicleType

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

Responses

Response samples

Content type
application/json
"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
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

UpdateVehicleType

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
"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

Content type
application/json
"string"

Response samples

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "applicationId": [
    ],
  • "errors": {
    },
  • "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

Content type
application/json
"string"

Response samples

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "applicationId": [
    ],
  • "errors": {
    },
  • "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

Content type
application/json
"string"

Response samples

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "applicationId": [
    ],
  • "errors": {
    },
  • "property1": null,
  • "property2": null
}

TMSOrders

GetOrders

query Parameters
accountId
required
string <guid>
domainId
required
string <guid>
OnlyReturnGuids
boolean
AllPickedUp
boolean or null
HasDeviation
boolean or null
OrderNumber
integer or null <int32>
EtdRange
string or null
EtaRange
string or null
UpdatedAt
string or null <duration>
FromUpdatedAt
string or null <date-time>
ToUpdatedAt
string or null <date-time>
QuickSearch
string or null
OrderId
string or null <guid>
Responsibles
Array of strings or null <guid> [ items <guid > ]
Consignor
string or null
Consignee
string or null
Container
string or null
Label
string or null
Customer
string or null <guid>
Customers
Array of strings or null <guid> [ items <guid > ]
ExcludeCustomers
Array of strings or null <guid> [ items <guid > ]
Vendors
Array of strings or null <guid> [ items <guid > ]
ExcludeVendors
Array of strings or null <guid> [ items <guid > ]
Transporters
Array of strings or null <guid> [ items <guid > ]
ExcludeTransporters
Array of strings or null <guid> [ items <guid > ]
(OrderSearchPredefinedFilter (string or null))
(OrderStatusFilter (string or null))
FromAreas
Array of strings or null <guid> [ items <guid > ]
ExcludeFromAreas
Array of strings or null <guid> [ items <guid > ]
FromCountryCode
string or null
ToAreas
Array of strings or null <guid> [ items <guid > ]
ExcludeToAreas
Array of strings or null <guid> [ items <guid > ]
ToCountryCode
string or null
OrderIds
Array of strings or null <guid> [ items <guid > ]
ExcludeOrderIds
Array of strings or null <guid> [ items <guid > ]
GoodsTypeIds
Array of strings or null <guid> [ items <guid > ]
ExcludeGoodsTypeIds
Array of strings or null <guid> [ items <guid > ]
OrderTypeIds
Array of strings or null <guid> [ items <guid > ]
ServiceCodeIds
Array of strings or null <guid> [ items <guid > ]
ExcludeOrderTypeIds
Array of strings or null <guid> [ items <guid > ]
TripIds
Array of strings or null <guid> [ items <guid > ]
BookingReference
string or null
AirwaybillNumber
string or null
CustomsReceiptNumber
string or null
CustomsGoodsNumber
string or null
CustomsMrnNumber
string or null
(CalculatedSumOfIncomeFilter (string or null))
(CalculatedSumOfCostsFilter (string or null))
Departments
Array of strings or null <guid> [ items <guid > ]
ExcludeDepartments
Array of strings or null <guid> [ items <guid > ]
DeliveryRouteNumber
string or null
(OrderSortBy (string or null))
SortByAscending
boolean
Tags
Array of strings or null <guid> [ items <guid > ]
ExcludeTags
Array of strings or null <guid> [ items <guid > ]
IsContributionMarginPositive
boolean or null
Incoterms
Array of strings or null <guid> [ items <guid > ]
take
integer or null <int32>
skip
integer or null <int32>
userId
string <guid>
traceId
string <guid>

Responses

Response samples

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "applicationId": [
    ],
  • "errors": {
    },
  • "property1": null,
  • "property2": null
}

CreateOrder

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",
  • "applicationId": [
    ],
  • "errors": {
    },
  • "property1": null,
  • "property2": null
}

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

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "applicationId": [
    ],
  • "errors": {
    },
  • "property1": null,
  • "property2": null
}

UpdateOrder

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
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "applicationId": [
    ],
  • "errors": {
    },
  • "property1": null,
  • "property2": null
}

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

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "applicationId": [
    ],
  • "errors": {
    },
  • "property1": null,
  • "property2": null
}

CreateOrderLine

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
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "applicationId": [
    ],
  • "errors": {
    },
  • "property1": null,
  • "property2": null
}

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

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "applicationId": [
    ],
  • "errors": {
    },
  • "property1": null,
  • "property2": null
}

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>

Responses

Response samples

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "applicationId": [
    ],
  • "errors": {
    },
  • "property1": null,
  • "property2": null
}

GetPricings

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
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "applicationId": [
    ],
  • "errors": {
    },
  • "property1": null,
  • "property2": null
}

CreatePricing

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
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "applicationId": [
    ],
  • "errors": {
    },
  • "property1": null,
  • "property2": null
}

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>

Responses

Response samples

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "applicationId": [
    ],
  • "errors": {
    },
  • "property1": null,
  • "property2": null
}

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>

Responses

Response samples

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "applicationId": [
    ],
  • "errors": {
    },
  • "property1": null,
  • "property2": null
}

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>

Responses

Response samples

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "applicationId": [
    ],
  • "errors": {
    },
  • "property1": null,
  • "property2": null
}

TMSTransportationTasks

GetAllTasks

query Parameters
accountId
required
string <guid>
domainId
required
string <guid>
IsAssigned
boolean or null
IsDispatched
boolean or null
IsPickupTask
boolean or null
IsDeliveryTask
boolean or null
DateTimeRange
string or null
FitsTripId
string or null <guid>
TaskIds
string or null
EtdRange
string or null
EtaRange
string or null
GrossWeight
string or null
DispatchAddressGenericSearch
string or null
DeliveryAddressGenericSearch
string or null
FromArea
string or null <guid>
FromCountryCode
string or null
ToArea
string or null <guid>
ToCountryCode
string or null
OrderType
string or null <guid>
ResponsibleId
string or null <guid>
ResponsibleIds
Array of strings or null <guid> [ items <guid > ]
(TaskType (string or null))
QuickSearch
string or null
IncomingGoodsReady
boolean or null
GoodsTypeIds
Array of strings or null <guid> [ items <guid > ]
ExcludeGoodsTypeIds
Array of strings or null <guid> [ items <guid > ]
OrderTypeIds
Array of strings or null <guid> [ items <guid > ]
ExcludeOrderTypeIds
Array of strings or null <guid> [ items <guid > ]
DeliveryRouteNumber
string or null
ServiceCodeIds
Array of strings or null <guid> [ items <guid > ]
Tags
Array of strings or null <guid> [ items <guid > ]
ExcludeTags
Array of strings or null <guid> [ items <guid > ]
(TaskSortBy (string or null))
SortByAscending
boolean
(LoadingUnitAllocationStatus (string or null))
(ModeOfTransport (string or null))
TripTypeId
string or null <guid>
VehicleId
string or null <guid>
(TripKind (string or null))
take
integer or null <int32>
skip
integer or null <int32>
userId
string <guid>
traceId
string <guid>

Responses

Response samples

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "applicationId": [
    ],
  • "errors": {
    },
  • "property1": null,
  • "property2": null
}

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

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "applicationId": [
    ],
  • "errors": {
    },
  • "property1": null,
  • "property2": null
}

UnassignTask

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

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "applicationId": [
    ],
  • "errors": {
    },
  • "property1": null,
  • "property2": null
}

ChangeTaskEtd

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

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "applicationId": [
    ],
  • "errors": {
    },
  • "property1": null,
  • "property2": null
}

ChangeTaskEta

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

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "applicationId": [
    ],
  • "errors": {
    },
  • "property1": null,
  • "property2": null
}

ChangeTaskPickup

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

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "applicationId": [
    ],
  • "errors": {
    },
  • "property1": null,
  • "property2": null
}

ChangeTaskDelivery

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

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "applicationId": [
    ],
  • "errors": {
    },
  • "property1": null,
  • "property2": null
}

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

Content type
application/json
"string"

Response samples

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "applicationId": [
    ],
  • "errors": {
    },
  • "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

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "applicationId": [
    ],
  • "errors": {
    },
  • "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
[
  • {
    }
]

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

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": [
    ],
  • "deliveryPlaceId": "string",
  • "deliveryPlaceName": "string",
  • "deliveryPlaceAddress1": "string",
  • "deliveryPlaceAddress2": "string",
  • "deliveryPlaceAddress3": "string",
  • "deliveryPlaceAddress4": "string",
  • "deliveryPlacePostCode": "string",
  • "deliveryPlacePostalPlace": "string",
  • "deliveryPlaceState": "string",
  • "deliveryPlaceCountry": "string",
  • "dimensions": [
    ],
  • "orderLines": [
    ]
}

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": [
    ],
  • "deliveryPlaceId": "string",
  • "deliveryPlaceName": "string",
  • "deliveryPlaceAddress1": "string",
  • "deliveryPlaceAddress2": "string",
  • "deliveryPlaceAddress3": "string",
  • "deliveryPlaceAddress4": "string",
  • "deliveryPlacePostCode": "string",
  • "deliveryPlacePostalPlace": "string",
  • "deliveryPlaceState": "string",
  • "deliveryPlaceCountry": "string",
  • "dimensions": [
    ],
  • "orderLines": [
    ]
}

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

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": [
    ],
  • "deliveryPlaceId": "string",
  • "deliveryPlaceName": "string",
  • "deliveryPlaceAddress1": "string",
  • "deliveryPlaceAddress2": "string",
  • "deliveryPlaceAddress3": "string",
  • "deliveryPlaceAddress4": "string",
  • "deliveryPlacePostCode": "string",
  • "deliveryPlacePostalPlace": "string",
  • "deliveryPlaceState": "string",
  • "deliveryPlaceCountry": "string",
  • "dimensions": [
    ]
}

Response samples

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

Content type
application/json
{
  • "property1": null,
  • "property2": null
}

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": [
    ],
  • "deliveryPlaceId": "string",
  • "deliveryPlaceName": "string",
  • "deliveryPlaceAddress1": "string",
  • "deliveryPlaceAddress2": "string",
  • "deliveryPlaceAddress3": "string",
  • "deliveryPlaceAddress4": "string",
  • "deliveryPlacePostCode": "string",
  • "deliveryPlacePostalPlace": "string",
  • "deliveryPlaceState": "string",
  • "deliveryPlaceCountry": "string",
  • "dimensions": [
    ],
  • "orderLines": [
    ]
}

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": [
    ],
  • "deliveryPlaceId": "string",
  • "deliveryPlaceName": "string",
  • "deliveryPlaceAddress1": "string",
  • "deliveryPlaceAddress2": "string",
  • "deliveryPlaceAddress3": "string",
  • "deliveryPlaceAddress4": "string",
  • "deliveryPlacePostCode": "string",
  • "deliveryPlacePostalPlace": "string",
  • "deliveryPlaceState": "string",
  • "deliveryPlaceCountry": "string",
  • "dimensions": [
    ],
  • "orderLines": [
    ]
}

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

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": [
    ],
  • "deliveryPlaceId": "string",
  • "deliveryPlaceName": "string",
  • "deliveryPlaceAddress1": "string",
  • "deliveryPlaceAddress2": "string",
  • "deliveryPlaceAddress3": "string",
  • "deliveryPlaceAddress4": "string",
  • "deliveryPlacePostCode": "string",
  • "deliveryPlacePostalPlace": "string",
  • "deliveryPlaceState": "string",
  • "deliveryPlaceCountry": "string",
  • "dimensions": [
    ],
  • "orderLines": [
    ]
}

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

Content type
application/json
[
  • {
    }
]

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

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

GetTransporter

path Parameters
id
required
string
query Parameters
accountId
required
string <guid>
domainId
required
string <guid>
userId
string <guid>
traceId
string <guid>

Responses

Response samples

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": [
    ],
  • "contactInformation": [
    ],
  • "lastModifiedAt": "2019-08-24T14:15:22Z"
}

PutTransporter

path Parameters
id
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

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": [
    ],
  • "contactInformation": [
    ],
  • "lastModifiedAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

GetTransporterAddresses

path Parameters
id
required
string
query Parameters
accountId
required
string <guid>
domainId
required
string <guid>
userId
string <guid>
traceId
string <guid>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

PostTransporterAddresses

path Parameters
id
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

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

PutTransporterAddresses

path Parameters
id
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

Content type
application/json
[
  • {
    }
]

Response samples

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

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>
userId
string <guid>
traceId
string <guid>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

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

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

GetVendor

path Parameters
id
required
string
query Parameters
accountId
required
string <guid>
domainId
required
string <guid>
userId
string <guid>
traceId
string <guid>

Responses

Response samples

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": [
    ],
  • "contactInformation": [
    ],
  • "lastModifiedAt": "2019-08-24T14:15:22Z"
}

PutVendor

path Parameters
id
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

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": [
    ],
  • "contactInformation": [
    ],
  • "lastModifiedAt": "2019-08-24T14:15:22Z"
}

Response samples

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": [
    ],
  • "contactInformation": [
    ],
  • "lastModifiedAt": "2019-08-24T14:15:22Z"
}

GetVendorAddresses

path Parameters
id
required
string
query Parameters
accountId
required
string <guid>
domainId
required
string <guid>
userId
string <guid>
traceId
string <guid>

Responses

Response samples

Content type
application/json
[
  • {
    }
]

PostVendorAddresses

path Parameters
id
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

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

PutVendorAddresses

path Parameters
id
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

Content type
application/json
[
  • {
    }
]

Response samples

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

Content type
application/json
[
  • {
    }
]

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

Content type
application/json
{
  • "contactId": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "primaryEmail": "string",
  • "secondaryEmail": "string",
  • "phone": "string",
  • "mobilePhone": "string"
}

Response samples

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

Content type
application/json
{
  • "contactId": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "primaryEmail": "string",
  • "secondaryEmail": "string",
  • "phone": "string",
  • "mobilePhone": "string"
}

Response samples

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": {
    }
}

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": [
    ],
  • "skip": 0,
  • "totalResults": 0
}

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))

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

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))

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

Warehouse

GetWarehouses

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

Responses

Response samples

Content type
application/json
[
  • {
    }
]

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

Content type
application/json
{
  • "warehouseName": "string",
  • "isVirtual": true,
  • "notAvailableForAllocation": true,
  • "extCode": "string",
  • "active": true,
  • "address": {
    }
}

Response samples

Content type
application/json
{
  • "warehouseName": "string",
  • "isVirtual": true,
  • "notAvailableForAllocation": true,
  • "extCode": "string",
  • "active": true,
  • "address": {
    },
  • "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

Content type
application/json
{
  • "warehouseName": "string",
  • "isVirtual": true,
  • "notAvailableForAllocation": true,
  • "extCode": "string",
  • "active": true,
  • "address": {
    },
  • "warehouseId": "string"
}

Response samples

Content type
application/json
{
  • "warehouseName": "string",
  • "isVirtual": true,
  • "notAvailableForAllocation": true,
  • "extCode": "string",
  • "active": true,
  • "address": {
    },
  • "warehouseId": "string"
}

GetWarehouse

path Parameters
id
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
{
  • "warehouseName": "string",
  • "isVirtual": true,
  • "notAvailableForAllocation": true,
  • "extCode": "string",
  • "active": true,
  • "address": {
    },
  • "warehouseId": "string"
}

DeleteWarehouse

path Parameters
id
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
}

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

Content type
application/json
"string"

Response samples

Content type
application/json
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "applicationId": [
    ],
  • "errors": {
    },
  • "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

Content type
application/json
[
  • {
    }
]

GetRequestPayload

path Parameters
id
required
integer <int64>
query Parameters
accountId
required
string <guid>
domainId
required
string <guid>
userId
string <guid>
traceId
string <guid>

Responses

GetResponsePayload

path Parameters
id
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
[
  • {
    }
]