Transportial OTMS API (0.9.2)

Download OpenAPI description
Languages
Servers
Mock server
https://docs.transportial.com/_mock/apis/
Test environment
https://test.api.otms.transportial.com/api/
Production
https://api.otms.transportial.com/api/

Transportial

Our full API documentation can be found here for OTMS. It describes our endpoints and the way we accept data.

Authentication

You can authenticate users by a login call and sending their token in the Authorization header.

OTM5

Our API is fully supportive of the OTM5 data structure. You can send and receive those objects in the exact definition. In our documentation you will find our other objects and you don't need to use Associations, we do return that structure however.

ServiceCard

Object describing a geographic ServiceCard. A ServiceCard can either be a point or an area.

Operations

Tire

Object describing a geographic Tire. A Tire can either be a point or an area.

Operations

Action

Actions are dynamic entities that are able to couple together various static entities at a certain moment in time. For instance a Load action couples together a Consignment and a Vehicle at the moment the Loading happens.

Operations

Actor

Actors can be stacked and constrain different activities in their context

Operations

Charge

Charges

Operations

Invoice

Invoices

Operations

LedgerEntry

LedgerEntry ...

Operations

Payout

Payouts

Operations

Plan

Plans

Operations

Quote

Quotes

Operations

Administration

Administrations can be stacked and constrain different activities in their context

Operations

Transaction

Transactions

Operations

Alert

Object describing a geographic alert. A alert can either be a point or an area.

Operations

Publisher

Object describing a geographic publisher. A publisher can either be a point or an area.

Operations

App

Object describing a geographic app. A app can either be a point or an area.

Operations

Attribute

A generic entity that can help in defining other entities properties

Operations

Ban

Object describing a geographic Ban. A Ban can either be a point or an area.

Operations

Board

Boards contain Lanes and might represent a module of a project or a project itself

Operations

Booking

Object describing a geographic booking. A booking can either be a point or an area.

Operations

Business

Business is a base entity that describes a companies information. Thiis entity is used for contracts, clients, invoices, quotes, etc. It can be any type of relation you do business with.

Operations

Camera

A Camera

Operations

CapacityContract

The CapacityContract is the entity to model a contract of a purchase of certain amount of scheduled capacity.

Operations

Capacity

A capacity models the amount of cargo, a schedule can deliver.

Operations

Certificate

Object describing a geographic Certificate. A Certificate can either be a point or an area.

Operations

Chat

Sending messages to users grouped by rooms

Operations

MessageTemplate

MessageTemplates can be stacked and constrain different activities in their context

Operations

Chauffeur

Chauffeurs are the people who are responsible for controlling a Vehicle. They have schedules, planning and legal responsibilities.

Operations

Complaint

Object describing a geographic Complaint. A Complaint can either be a point or an area.

Operations

Consignment

Consignments can be stacked and constrain different activities in their context

Operations

Constraint

Constraints can be stacked and constrain different activities in their context

Operations

Contract

Contracts

Operations

Damage

Object describing a geographic damage. A damage can either be a point or an area.

Operations

Document

Documents are the base entities to handle all types of external data files and the references to them

Operations

Event

Events - like actions - model dynamic entities that couple various static entities at a certain moment in time. Events are used for either real-time updates, or updates on earlier provided data. Notice that in both event types these are updates on earlier provided data, whereas actions are usually used together with the entities they dynamically couple.

Operations

Feedback

Feedbacks

Operations

File

File management. Upload, retrieve and download files. Categorized by it's purpose.

Operations

Fleet

Fleets can be stacked and constrain different activities in their context

Operations

General

General reference data sets like Languages, Currencies etc. and functions

Operations

Goods

Goods are the items to be transported as part of a consignment. Goods can be divided into two sub-types of goods, depending on the use case and the level of detail. Goods either consists of items, describing the actual goods to be transported. Or a transport equipment, which is equipment used to carry the actual goods to be transported. Transport equipment is (usually) a means to an end, not something that needs to be transported on itself, such as pallets.

Operations

TransportEquipment

TransportEquipment are the items to be transported as part of a consignment. TransportEquipment can be divided into two sub-types of transportEquipment, depending on the use case and the level of detail. TransportEquipment either consists of items, describing the actual transportEquipment to be transported. Or a transport equipment, which is equipment used to carry the actual transportEquipment to be transported. Transport equipment is (usually) a means to an end, not something that needs to be transported on itself, such as pallets.

Operations

Insights

All the insights you need can be gathered from these endpoints

Operations

Integration

An Integration is the connection for 2 systems. An integration can be configured and enabled through this object. It can also configure the entire connection or it can be pre-configured.

Operations

Lane

A lane contains a location and status of a todo task.

Operations

ToDo

A lane contains a location and status of a todo task.

Operations

Location

Object describing a geographic location. A location can either be a point or an area.

Operations

Mail

Mails can be stacked and constrain different activities in their context

Operations

Management

The management overviews

Operations

MessageAutomation

Message-Automations are communication automation connectors that can use events

Operations

Notification

Notification endpoint to notify people, groups or the entire user base of things they might want to know or need to know

Operations

Platform

Platforms can be stacked and constrain different activities in their context

Operations

SAML

SAML Configuration for Single-SignOn(SSO) establishment between Service-Provider(SP) and Identity-Provider(IDP)

Operations

Pricing

A pricing models the path going from one location to at least one other location.

Operations

Route

A route models the path going from one location to at least one other location.

Operations

Calculate and create a new route

Request

Calculate and create a new route based on Vehicle and the Georeferences

Headers
Authorizationstringrequired
Bodyapplication/jsonrequired
namestring
vehicleobject(Vehicle)
actionsArray of objects(Action)
constraintsArray of objects(Constraint)
routeobject(Route)
curl -i -X POST \
  https://docs.transportial.com/_mock/apis/route/calculate \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "vehicle": {
      "nonce": "string",
      "versionNumber": 0,
      "hasAgreedToPrice": true,
      "transportMode": "maritime",
      "loadCapacities": [
        {
          "value": "string",
          "unit": "string"
        }
      ],
      "loadMeters": {
        "value": "string",
        "unit": "string"
      },
      "actors": [
        {
          "associationType": "inline"
        }
      ],
      "legalStatistics": {
        "lastInstantOfAVehicleOwnerLocation": "2019-08-24T14:15:22Z",
        "countryCabotageStatistics": {
          "property1": {
            "completedCabotageTrips": 0,
            "lastInstantOfCompletedCabotageTrip": "2019-08-24T14:15:22Z",
            "lastInstantOfInternationalTripWithCountryAsDestination": "2019-08-24T14:15:22Z"
          },
          "property2": {
            "completedCabotageTrips": 0,
            "lastInstantOfCompletedCabotageTrip": "2019-08-24T14:15:22Z",
            "lastInstantOfInternationalTripWithCountryAsDestination": "2019-08-24T14:15:22Z"
          }
        },
        "lastInstantOfInternationalTrip": "2019-08-24T14:15:22Z",
        "lastInternationalTripDestinationCountry": "string"
      },
      "capacityContract": {
        "nonce": "string",
        "name": "string",
        "type": "permanentContract",
        "communicationMethod": "messageAutomation",
        "contract": {
          "nonce": "string",
          "title": "string",
          "description": "string",
          "deliveryTerms": "EXW",
          "contractor": {
            "id": "string",
            "nonce": "string",
            "uuid": "string",
            "primaryPlatformId": "string",
            "createdAt": "2019-08-24T14:15:22Z",
            "updatedAt": "2019-08-24T14:15:22Z",
            "name": "string",
            "relationType": "string",
            "alias": "string",
            "description": "string",
            "transportLicenseNumber": "string",
            "eori": "string",
            "scacCode": "string",
            "industry": {
              "id": "string",
              "nonce": "string",
              "uuid": "string",
              "primaryPlatformId": "string",
              "createdAt": "2019-08-24T14:15:22Z",
              "updatedAt": "2019-08-24T14:15:22Z",
              "name": "string",
              "abbreviated": "string",
              "enabled": true
            },
            "website": "string",
            "coc": "string",
            "vat": "string",
            "verified": true,
            "documents": [
              {
                "associationType": "inline",
                "entity": {
                  "externalAttributes": {}
                }
              }
            ],
            "logo": {
              "nonce": "string",
              "url": "string",
              "path": "string",
              "name": "string",
              "originalName": "string",
              "size": 0,
              "purpose": "string",
              "type": "IMAGE",
              "mimeType": "string",
              "extension": "string",
              "uploadedAt": "2019-08-24T14:15:22Z"
            },
            "banners": [
              {
                "id": "string",
                "nonce": "string",
                "uuid": "string",
                "primaryPlatformId": "string",
                "createdAt": "2019-08-24T14:15:22Z",
                "updatedAt": "2019-08-24T14:15:22Z",
                "url": "string",
                "path": "string",
                "name": "string",
                "originalName": "string",
                "size": 0,
                "purpose": "string",
                "type": "IMAGE",
                "mimeType": "string",
                "extension": "string",
                "uploadedAt": "2019-08-24T14:15:22Z"
              }
            ],
            "locations": [
              {
                "id": "string",
                "nonce": "string",
                "uuid": "string",
                "primaryPlatformId": "string",
                "createdAt": "2019-08-24T14:15:22Z",
                "updatedAt": "2019-08-24T14:15:22Z",
                "type": "warehouse",
                "name": "string",
                "unCode": "string",
                "geoReference": {},
                "administrativeReference": {},
                "contactDetails": [
                  null
                ],
                "constraints": [
                  null
                ],
                "pricingElements": [
                  null
                ],
                "remark": "string",
                "hash": "string",
                "externalAttributes": {
                  "property1": {},
                  "property2": {}
                }
              }
            ],
            "identification": [
              {
                "id": "string",
                "nonce": "string",
                "uuid": "string",
                "primaryPlatformId": "string",
                "createdAt": "2019-08-24T14:15:22Z",
                "updatedAt": "2019-08-24T14:15:22Z",
                "url": "string",
                "path": "string",
                "name": "string",
                "originalName": "string",
                "size": 0,
                "purpose": "string",
                "type": "IMAGE",
                "mimeType": "string",
                "extension": "string",
                "uploadedAt": "2019-08-24T14:15:22Z"
              }
            ],
            "contactDetails": [
              {
                "id": "string",
                "nonce": "string",
                "uuid": "string",
                "primaryPlatformId": "string",
                "createdAt": "2019-08-24T14:15:22Z",
                "updatedAt": "2019-08-24T14:15:22Z",
                "type": "iban",
                "value": "string",
                "remarks": "string"
              }
            ],
            "contactPersons": [
              {
                "id": "string",
                "nonce": "string",
                "uuid": "string",
                "primaryPlatformId": "string",
                "createdAt": "2019-08-24T14:15:22Z",
                "updatedAt": "2019-08-24T14:15:22Z",
                "firstName": "string",
                "lastName": "string",
                "position": "string",
                "email": "string",
                "phone": "string"
              }
            ],
            "administration": {
              "id": "string",
              "nonce": "string",
              "uuid": "string",
              "primaryPlatformId": "string",
              "createdAt": "2019-08-24T14:15:22Z",
              "updatedAt": "2019-08-24T14:15:22Z",
              "name": "string",
              "primary": true,
              "business": {},
              "currency": {
                "id": "string",
                "nonce": "string",
                "uuid": "string",
                "primaryPlatformId": "string",
                "createdAt": "2019-08-24T14:15:22Z",
                "updatedAt": "2019-08-24T14:15:22Z",
                "name": "string",
                "short": "string",
                "sign": "string",
                "decimalDelimiter": "string",
                "thousandDelimiter": "string",
                "enabled": true
              },
              "balance": {
                "id": "string",
                "nonce": "string",
                "uuid": "string",
                "primaryPlatformId": "string",
                "createdAt": "2019-08-24T14:15:22Z",
                "updatedAt": "2019-08-24T14:15:22Z",
                "amount": 0.1,
                "currency": {},
                "taxRate": {
                  "identifiers": []
                },
                "inclusiveOfTax": true
              },
              "numberFormat": "string",
              "numberLength": 0,
              "dueDays": 0,
              "invoiceNumberIndex": {
                "property1": 0,
                "property2": 0
              },
              "quoteNumberIndex": {
                "property1": 0,
                "property2": 0
              },
              "automaticallySendReminders": true,
              "invoiceTermsAndConditions": "string",
              "quoteTermsAndConditions": "string",
              "invoiceNumbering": 0,
              "quoteNumbering": 0
            },
            "pricingConfigurationCount": 0,
            "hasAgreedToPrice": true
          },
          "contractorSignee": {
            "nonce": "string",
            "firstName": "string",
            "lastName": "string",
            "position": "string",
            "email": "string",
            "phone": "string"
          },
          "client": {
            "id": "string",
            "nonce": "string",
            "uuid": "string",
            "primaryPlatformId": "string",
            "createdAt": "2019-08-24T14:15:22Z",
            "updatedAt": "2019-08-24T14:15:22Z",
            "name": "string",
            "relationType": "string",
            "alias": "string",
            "description": "string",
            "transportLicenseNumber": "string",
            "eori": "string",
            "scacCode": "string",
            "industry": {
              "id": "string",
              "nonce": "string",
              "uuid": "string",
              "primaryPlatformId": "string",
              "createdAt": "2019-08-24T14:15:22Z",
              "updatedAt": "2019-08-24T14:15:22Z",
              "name": "string",
              "abbreviated": "string",
              "enabled": true
            },
            "website": "string",
            "coc": "string",
            "vat": "string",
            "verified": true,
            "documents": [
              {
                "associationType": "inline",
                "entity": {
                  "externalAttributes": {}
                }
              }
            ],
            "logo": {
              "nonce": "string",
              "url": "string",
              "path": "string",
              "name": "string",
              "originalName": "string",
              "size": 0,
              "purpose": "string",
              "type": "IMAGE",
              "mimeType": "string",
              "extension": "string",
              "uploadedAt": "2019-08-24T14:15:22Z"
            },
            "banners": [
              {
                "id": "string",
                "nonce": "string",
                "uuid": "string",
                "primaryPlatformId": "string",
                "createdAt": "2019-08-24T14:15:22Z",
                "updatedAt": "2019-08-24T14:15:22Z",
                "url": "string",
                "path": "string",
                "name": "string",
                "originalName": "string",
                "size": 0,
                "purpose": "string",
                "type": "IMAGE",
                "mimeType": "string",
                "extension": "string",
                "uploadedAt": "2019-08-24T14:15:22Z"
              }
            ],
            "locations": [
              {
                "id": "string",
                "nonce": "string",
                "uuid": "string",
                "primaryPlatformId": "string",
                "createdAt": "2019-08-24T14:15:22Z",
                "updatedAt": "2019-08-24T14:15:22Z",
                "type": "warehouse",
                "name": "string",
                "unCode": "string",
                "geoReference": {},
                "administrativeReference": {},
                "contactDetails": [
                  null
                ],
                "constraints": [
                  null
                ],
                "pricingElements": [
                  null
                ],
                "remark": "string",
                "hash": "string",
                "externalAttributes": {
                  "property1": {},
                  "property2": {}
                }
              }
            ],
            "identification": [
              {
                "id": "string",
                "nonce": "string",
                "uuid": "string",
                "primaryPlatformId": "string",
                "createdAt": "2019-08-24T14:15:22Z",
                "updatedAt": "2019-08-24T14:15:22Z",
                "url": "string",
                "path": "string",
                "name": "string",
                "originalName": "string",
                "size": 0,
                "purpose": "string",
                "type": "IMAGE",
                "mimeType": "string",
                "extension": "string",
                "uploadedAt": "2019-08-24T14:15:22Z"
              }
            ],
            "contactDetails": [
              {
                "id": "string",
                "nonce": "string",
                "uuid": "string",
                "primaryPlatformId": "string",
                "createdAt": "2019-08-24T14:15:22Z",
                "updatedAt": "2019-08-24T14:15:22Z",
                "type": "iban",
                "value": "string",
                "remarks": "string"
              }
            ],
            "contactPersons": [
              {
                "id": "string",
                "nonce": "string",
                "uuid": "string",
                "primaryPlatformId": "string",
                "createdAt": "2019-08-24T14:15:22Z",
                "updatedAt": "2019-08-24T14:15:22Z",
                "firstName": "string",
                "lastName": "string",
                "position": "string",
                "email": "string",
                "phone": "string"
              }
            ],
            "administration": {
              "id": "string",
              "nonce": "string",
              "uuid": "string",
              "primaryPlatformId": "string",
              "createdAt": "2019-08-24T14:15:22Z",
              "updatedAt": "2019-08-24T14:15:22Z",
              "name": "string",
              "primary": true,
              "business": {},
              "currency": {
                "id": "string",
                "nonce": "string",
                "uuid": "string",
                "primaryPlatformId": "string",
                "createdAt": "2019-08-24T14:15:22Z",
                "updatedAt": "2019-08-24T14:15:22Z",
                "name": "string",
                "short": "string",
                "sign": "string",
                "decimalDelimiter": "string",
                "thousandDelimiter": "string",
                "enabled": true
              },
              "balance": {
                "id": "string",
                "nonce": "string",
                "uuid": "string",
                "primaryPlatformId": "string",
                "createdAt": "2019-08-24T14:15:22Z",
                "updatedAt": "2019-08-24T14:15:22Z",
                "amount": 0.1,
                "currency": {},
                "taxRate": {
                  "identifiers": []
                },
                "inclusiveOfTax": true
              },
              "numberFormat": "string",
              "numberLength": 0,
              "dueDays": 0,
              "invoiceNumberIndex": {
                "property1": 0,
                "property2": 0
              },
              "quoteNumberIndex": {
                "property1": 0,
                "property2": 0
              },
              "automaticallySendReminders": true,
              "invoiceTermsAndConditions": "string",
              "quoteTermsAndConditions": "string",
              "invoiceNumbering": 0,
              "quoteNumbering": 0
            },
            "pricingConfigurationCount": 0,
            "hasAgreedToPrice": true
          },
          "clientSignee": {
            "nonce": "string",
            "firstName": "string",
            "lastName": "string",
            "position": "string",
            "email": "string",
            "phone": "string"
          }
        },
        "business": {
          "id": "string",
          "nonce": "string",
          "uuid": "string",
          "primaryPlatformId": "string",
          "createdAt": "2019-08-24T14:15:22Z",
          "updatedAt": "2019-08-24T14:15:22Z",
          "name": "string",
          "relationType": "string",
          "alias": "string",
          "description": "string",
          "transportLicenseNumber": "string",
          "eori": "string",
          "scacCode": "string",
          "industry": {
            "id": "string",
            "nonce": "string",
            "uuid": "string",
            "primaryPlatformId": "string",
            "createdAt": "2019-08-24T14:15:22Z",
            "updatedAt": "2019-08-24T14:15:22Z",
            "name": "string",
            "abbreviated": "string",
            "enabled": true
          },
          "website": "string",
          "coc": "string",
          "vat": "string",
          "verified": true,
          "documents": [
            {
              "associationType": "inline",
              "entity": {
                "nonce": "string",
                "description": "string",
                "expiresAt": "2019-08-24T14:15:22Z",
                "fileName": "string",
                "mimeType": "string",
                "encoding": "string",
                "verified": true,
                "content": {},
                "file": {},
                "externalAttributes": {
                  "property1": {},
                  "property2": {}
                },
                "name": "string"
              }
            }
          ],
          "logo": {
            "nonce": "string",
            "url": "string",
            "path": "string",
            "name": "string",
            "originalName": "string",
            "size": 0,
            "purpose": "string",
            "type": "IMAGE",
            "mimeType": "string",
            "extension": "string",
            "uploadedAt": "2019-08-24T14:15:22Z"
          },
          "banners": [
            {
              "id": "string",
              "nonce": "string",
              "uuid": "string",
              "primaryPlatformId": "string",
              "createdAt": "2019-08-24T14:15:22Z",
              "updatedAt": "2019-08-24T14:15:22Z",
              "url": "string",
              "path": "string",
              "name": "string",
              "originalName": "string",
              "size": 0,
              "purpose": "string",
              "type": "IMAGE",
              "mimeType": "string",
              "extension": "string",
              "uploadedAt": "2019-08-24T14:15:22Z"
            }
          ],
          "locations": [
            {
              "id": "string",
              "nonce": "string",
              "uuid": "string",
              "primaryPlatformId": "string",
              "createdAt": "2019-08-24T14:15:22Z",
              "updatedAt": "2019-08-24T14:15:22Z",
              "type": "warehouse",
              "name": "string",
              "unCode": "string",
              "geoReference": {
                "id": "string",
                "nonce": "string",
                "uuid": "string",
                "primaryPlatformId": "string",
                "createdAt": "2019-08-24T14:15:22Z",
                "updatedAt": "2019-08-24T14:15:22Z",
                "type": "addressGeoReference",
                "name": "string",
                "street": "string",
                "houseNumber": "string",
                "houseNumberAddition": "string",
                "postalCode": "string",
                "city": "string",
                "country": "string",
                "hash": "string"
              },
              "administrativeReference": {
                "name": "string",
                "street": "string",
                "houseNumber": "string",
                "houseNumberAddition": "string",
                "postalCode": "string",
                "city": "string",
                "country": "string"
              },
              "contactDetails": [
                {}
              ],
              "constraints": [
                {}
              ],
              "pricingElements": [
                {}
              ],
              "remark": "string",
              "hash": "string",
              "externalAttributes": {
                "property1": {},
                "property2": {}
              }
            }
          ],
          "identification": [
            {
              "id": "string",
              "nonce": "string",
              "uuid": "string",
              "primaryPlatformId": "string",
              "createdAt": "2019-08-24T14:15:22Z",
              "updatedAt": "2019-08-24T14:15:22Z",
              "url": "string",
              "path": "string",
              "name": "string",
              "originalName": "string",
              "size": 0,
              "purpose": "string",
              "type": "IMAGE",
              "mimeType": "string",
              "extension": "string",
              "uploadedAt": "2019-08-24T14:15:22Z"
            }
          ],
          "contactDetails": [
            {
              "id": "string",
              "nonce": "string",
              "uuid": "string",
              "primaryPlatformId": "string",
              "createdAt": "2019-08-24T14:15:22Z",
              "updatedAt": "2019-08-24T14:15:22Z",
              "type": "iban",
              "value": "string",
              "remarks": "string"
            }
          ],
          "contactPersons": [
            {
              "id": "string",
              "nonce": "string",
              "uuid": "string",
              "primaryPlatformId": "string",
              "createdAt": "2019-08-24T14:15:22Z",
              "updatedAt": "2019-08-24T14:15:22Z",
              "firstName": "string",
              "lastName": "string",
              "position": "string",
              "email": "string",
              "phone": "string"
            }
          ],
          "administration": {
            "id": "string",
            "nonce": "string",
            "uuid": "string",
            "primaryPlatformId": "string",
            "createdAt": "2019-08-24T14:15:22Z",
            "updatedAt": "2019-08-24T14:15:22Z",
            "name": "string",
            "primary": true,
            "business": {},
            "currency": {
              "id": "string",
              "nonce": "string",
              "uuid": "string",
              "primaryPlatformId": "string",
              "createdAt": "2019-08-24T14:15:22Z",
              "updatedAt": "2019-08-24T14:15:22Z",
              "name": "string",
              "short": "string",
              "sign": "string",
              "decimalDelimiter": "string",
              "thousandDelimiter": "string",
              "enabled": true
            },
            "balance": {
              "id": "string",
              "nonce": "string",
              "uuid": "string",
              "primaryPlatformId": "string",
              "createdAt": "2019-08-24T14:15:22Z",
              "updatedAt": "2019-08-24T14:15:22Z",
              "amount": 0.1,
              "currency": {
                "id": "string",
                "nonce": "string",
                "uuid": "string",
                "primaryPlatformId": "string",
                "createdAt": "2019-08-24T14:15:22Z",
                "updatedAt": "2019-08-24T14:15:22Z",
                "name": "string",
                "short": "string",
                "sign": "string",
                "decimalDelimiter": "string",
                "thousandDelimiter": "string",
                "enabled": true
              },
              "taxRate": {
                "nonce": "string",
                "creditCode": "string",
                "debitCode": "string",
                "identifiers": [
                  null
                ],
                "name": "string",
                "description": "string",
                "jurisdiction": "string",
                "percentage": 0.1,
                "inclusive": true,
                "active": true
              },
              "inclusiveOfTax": true
            },
            "numberFormat": "string",
            "numberLength": 0,
            "dueDays": 0,
            "invoiceNumberIndex": {
              "property1": 0,
              "property2": 0
            },
            "quoteNumberIndex": {
              "property1": 0,
              "property2": 0
            },
            "automaticallySendReminders": true,
            "invoiceTermsAndConditions": "string",
            "quoteTermsAndConditions": "string",
            "invoiceNumbering": 0,
            "quoteNumbering": 0
          },
          "pricingConfigurationCount": 0,
          "hasAgreedToPrice": true
        },
        "administration": {
          "nonce": "string",
          "name": "string",
          "primary": true,
          "business": {
            "id": "string",
            "nonce": "string",
            "uuid": "string",
            "primaryPlatformId": "string",
            "createdAt": "2019-08-24T14:15:22Z",
            "updatedAt": "2019-08-24T14:15:22Z",
            "name": "string",
            "relationType": "string",
            "alias": "string",
            "description": "string",
            "transportLicenseNumber": "string",
            "eori": "string",
            "scacCode": "string",
            "industry": {
              "id": "string",
              "nonce": "string",
              "uuid": "string",
              "primaryPlatformId": "string",
              "createdAt": "2019-08-24T14:15:22Z",
              "updatedAt": "2019-08-24T14:15:22Z",
              "name": "string",
              "abbreviated": "string",
              "enabled": true
            },
            "website": "string",
            "coc": "string",
            "vat": "string",
            "verified": true,
            "documents": [
              {
                "associationType": "inline",
                "entity": {
                  "externalAttributes": {}
                }
              }
            ],
            "logo": {
              "nonce": "string",
              "url": "string",
              "path": "string",
              "name": "string",
              "originalName": "string",
              "size": 0,
              "purpose": "string",
              "type": "IMAGE",
              "mimeType": "string",
              "extension": "string",
              "uploadedAt": "2019-08-24T14:15:22Z"
            },
            "banners": [
              {
                "id": "string",
                "nonce": "string",
                "uuid": "string",
                "primaryPlatformId": "string",
                "createdAt": "2019-08-24T14:15:22Z",
                "updatedAt": "2019-08-24T14:15:22Z",
                "url": "string",
                "path": "string",
                "name": "string",
                "originalName": "string",
                "size": 0,
                "purpose": "string",
                "type": "IMAGE",
                "mimeType": "string",
                "extension": "string",
                "uploadedAt": "2019-08-24T14:15:22Z"
              }
            ],
            "locations": [
              {
                "id": "string",
                "nonce": "string",
                "uuid": "string",
                "primaryPlatformId": "string",
                "createdAt": "2019-08-24T14:15:22Z",
                "updatedAt": "2019-08-24T14:15:22Z",
                "type": "warehouse",
                "name": "string",
                "unCode": "string",
                "geoReference": {},
                "administrativeReference": {},
                "contactDetails": [
                  null
                ],
                "constraints": [
                  null
                ],
                "pricingElements": [
                  null
                ],
                "remark": "string",
                "hash": "string",
                "externalAttributes": {
                  "property1": {},
                  "property2": {}
                }
              }
            ],
            "identification": [
              {
                "id": "string",
                "nonce": "string",
                "uuid": "string",
                "primaryPlatformId": "string",
                "createdAt": "2019-08-24T14:15:22Z",
                "updatedAt": "2019-08-24T14:15:22Z",
                "url": "string",
                "path": "string",
                "name": "string",
                "originalName": "string",
                "size": 0,
                "purpose": "string",
                "type": "IMAGE",
                "mimeType": "string",
                "extension": "string",
                "uploadedAt": "2019-08-24T14:15:22Z"
              }
            ],
            "contactDetails": [
              {
                "id": "string",
                "nonce": "string",
                "uuid": "string",
                "primaryPlatformId": "string",
                "createdAt": "2019-08-24T14:15:22Z",
                "updatedAt": "2019-08-24T14:15:22Z",
                "type": "iban",
                "value": "string",
                "remarks": "string"
              }
            ],
            "contactPersons": [
              {
                "id": "string",
                "nonce": "string",
                "uuid": "string",
                "primaryPlatformId": "string",
                "createdAt": "2019-08-24T14:15:22Z",
                "updatedAt": "2019-08-24T14:15:22Z",
                "firstName": "string",
                "lastName": "string",
                "position": "string",
                "email": "string",
                "phone": "string"
              }
            ],
            "administration": {
              "id": "string",
              "nonce": "string",
              "uuid": "string",
              "primaryPlatformId": "string",
              "createdAt": "2019-08-24T14:15:22Z",
              "updatedAt": "2019-08-24T14:15:22Z",
              "name": "string",
              "primary": true,
              "business": {},
              "currency": {
                "id": "string",
                "nonce": "string",
                "uuid": "string",
                "primaryPlatformId": "string",
                "createdAt": "2019-08-24T14:15:22Z",
                "updatedAt": "2019-08-24T14:15:22Z",
                "name": "string",
                "short": "string",
                "sign": "string",
                "decimalDelimiter": "string",
                "thousandDelimiter": "string",
                "enabled": true
              },
              "balance": {
                "id": "string",
                "nonce": "string",
                "uuid": "string",
                "primaryPlatformId": "string",
                "createdAt": "2019-08-24T14:15:22Z",
                "updatedAt": "2019-08-24T14:15:22Z",
                "amount": 0.1,
                "currency": {},
                "taxRate": {
                  "identifiers": []
                },
                "inclusiveOfTax": true
              },
              "numberFormat": "string",
              "numberLength": 0,
              "dueDays": 0,
              "invoiceNumberIndex": {
                "property1": 0,
                "property2": 0
              },
              "quoteNumberIndex": {
                "property1": 0,
                "property2": 0
              },
              "automaticallySendReminders": true,
              "invoiceTermsAndConditions": "string",
              "quoteTermsAndConditions": "string",
              "invoiceNumbering": 0,
              "quoteNumbering": 0
            },
            "pricingConfigurationCount": 0,
            "hasAgreedToPrice": true
          },
          "currency": {
            "nonce": "string",
            "name": "string",
            "short": "string",
            "sign": "string",
            "decimalDelimiter": "string",
            "thousandDelimiter": "string",
            "enabled": true
          },
          "balance": {
            "nonce": "string",
            "amount": 0.1,
            "currency": {
              "nonce": "string",
              "name": "string",
              "short": "string",
              "sign": "string",
              "decimalDelimiter": "string",
              "thousandDelimiter": "string",
              "enabled": true
            },
            "taxRate": {
              "nonce": "string",
              "creditCode": "string",
              "debitCode": "string",
              "identifiers": [
                {}
              ],
              "name": "string",
              "description": "string",
              "jurisdiction": "string",
              "percentage": 0.1,
              "inclusive": true,
              "active": true
            },
            "inclusiveOfTax": true
          },
          "numberFormat": "string",
          "numberLength": 0,
          "dueDays": 0,
          "invoiceNumberIndex": {
            "property1": 0,
            "property2": 0
          },
          "quoteNumberIndex": {
            "property1": 0,
            "property2": 0
          },
          "automaticallySendReminders": true,
          "invoiceTermsAndConditions": "string",
          "quoteTermsAndConditions": "string",
          "invoiceStandardDocuments": [
            {
              "nonce": "string",
              "description": "string",
              "expiresAt": "2019-08-24T14:15:22Z",
              "fileName": "string",
              "mimeType": "string",
              "encoding": "string",
              "verified": true,
              "content": {
                "contentType": "data",
                "data": "string"
              },
              "file": {
                "nonce": "string",
                "url": "string",
                "path": "string",
                "name": "string",
                "originalName": "string",
                "size": 0,
                "purpose": "string",
                "type": "IMAGE",
                "mimeType": "string",
                "extension": "string",
                "uploadedAt": "2019-08-24T14:15:22Z"
              },
              "externalAttributes": {
                "property1": {},
                "property2": {}
              },
              "name": "string"
            }
          ],
          "quoteStandardDocuments": [
            {
              "nonce": "string",
              "description": "string",
              "expiresAt": "2019-08-24T14:15:22Z",
              "fileName": "string",
              "mimeType": "string",
              "encoding": "string",
              "verified": true,
              "content": {
                "contentType": "data",
                "data": "string"
              },
              "file": {
                "nonce": "string",
                "url": "string",
                "path": "string",
                "name": "string",
                "originalName": "string",
                "size": 0,
                "purpose": "string",
                "type": "IMAGE",
                "mimeType": "string",
                "extension": "string",
                "uploadedAt": "2019-08-24T14:15:22Z"
              },
              "externalAttributes": {
                "property1": {},
                "property2": {}
              },
              "name": "string"
            }
          ],
          "invoiceNumbering": 0,
          "quoteNumbering": 0
        },
        "startTime": "2019-08-24T14:15:22Z",
        "endTime": "2019-08-24T14:15:22Z",
        "selfBilling": true,
        "currency": {
          "nonce": "string",
          "name": "string",
          "short": "string",
          "sign": "string",
          "decimalDelimiter": "string",
          "thousandDelimiter": "string",
          "enabled": true
        },
        "triggerType": "endOfWeek",
        "pricingModules": [
          {
            "nonce": "string",
            "type": "fixed",
            "name": "string",
            "sequenceNr": 0,
            "description": "string",
            "category": {
              "nonce": "string",
              "name": "string",
              "creditCode": "string",
              "debitCode": "string",
              "defaultValue": 0.1,
              "enabled": true
            },
            "taxRates": [
              {
                "nonce": "string",
                "sequenceNr": 0,
                "name": "string",
                "description": "string",
                "taxRate": {
                  "identifiers": []
                },
                "filters": [
                  null
                ]
              }
            ],
            "filters": [
              {
                "selector": "string",
                "comparisonType": "equal",
                "value": "string",
                "linkType": "and",
                "filters": [
                  null
                ],
                "sequenceNr": 0
              }
            ],
            "oncePerInvoice": true
          }
        ],
        "lastHandledSelfBilling": "2019-08-24T14:15:22Z",
        "signature": {
          "nonce": "string",
          "ip": "string",
          "userAgent": "string",
          "date": "2019-08-24T14:15:22Z",
          "file": {
            "nonce": "string",
            "url": "string",
            "path": "string",
            "name": "string",
            "originalName": "string",
            "size": 0,
            "purpose": "string",
            "type": "IMAGE",
            "mimeType": "string",
            "extension": "string",
            "uploadedAt": "2019-08-24T14:15:22Z"
          }
        },
        "integration": {
          "nonce": "string",
          "type": "manual",
          "name": "string",
          "description": "string",
          "schedule": {
            "integrationSchedulerScheduleValue": 0,
            "integrationSchedulerScheduleType": "seconds",
            "milliseconds": 0
          },
          "dataSources": [
            {
              "nonce": "string",
              "directionType": "in",
              "connectionType": "api",
              "requestMethod": "get",
              "dataType": "xml",
              "entityType": "action",
              "url": "string",
              "port": 0,
              "path": "string",
              "token": "string",
              "query": "string",
              "parameters": [
                {
                  "fields": [],
                  "filters": [],
                  "options": []
                }
              ],
              "allowedIps": [
                "string"
              ],
              "hasAuthentication": true,
              "credentials": {
                "nonce": "string",
                "authenticationMethod": "apiKey",
                "username": "string",
                "password": "string",
                "accessKey": "string",
                "secretKey": "string",
                "clientId": "string",
                "clientSecret": "string",
                "grantType": "string",
                "scope": "string",
                "apiKey": "string",
                "bearer": "string",
                "sshKey": {},
                "sshTunnel": true,
                "sshHost": "string",
                "sshUsername": "string",
                "sshPassword": "string",
                "externalAttributes": {
                  "property1": {},
                  "property2": {}
                },
                "headers": {
                  "property1": {},
                  "property2": {}
                },
                "oauthUrl": "string",
                "oAuthCache": "string",
                "oAuthCacheCreationDate": "2019-08-24T14:15:22Z",
                "openIdToken": "string",
                "openIdRefreshToken": "string",
                "openIdAccessToken": "string",
                "openIdExpiration": "2019-08-24T14:15:22Z"
              },
              "otm": true,
              "fields": [
                {
                  "fields": [],
                  "filters": [],
                  "options": []
                }
              ],
              "filters": [
                {
                  "filters": []
                }
              ],
              "template": true
            }
          ],
          "enabled": true,
          "lastHandled": "2019-08-24T14:15:22Z",
          "integration": [
            {
              "nonce": "string",
              "author": {
                "nonce": "string",
                "hasAgreedToPrice": true,
                "type": "user",
                "username": "string",
                "firstName": "string",
                "lastName": "string",
                "email": "string",
                "phone": "string",
                "passwordModified": "2019-08-24T14:15:22Z",
                "twoFactorAuthentication": true,
                "status": "DELETED",
                "loginMethod": "DEFAULT",
                "accountType": "default",
                "standardLoadingSize": 10,
                "timezone": "string",
                "vehicleGroups": [
                  null
                ]
              },
              "name": "string",
              "text": "string"
            }
          ],
          "triggerType": "trigger",
          "triggerEvent": "afterCreatingTrip",
          "filters": [
            {
              "selector": "string",
              "comparisonType": "equal",
              "value": "string",
              "linkType": "and",
              "filters": [
                {}
              ],
              "sequenceNr": 0
            }
          ]
        },
        "messageAutomation": {
          "nonce": "string",
          "name": "string",
          "description": "string",
          "automationConfig": {
            "triggerType": "trigger",
            "triggerEvent": "afterCreatingTrip",
            "schedule": {
              "integrationSchedulerScheduleValue": 0,
              "integrationSchedulerScheduleType": "seconds",
              "milliseconds": 0
            },
            "filters": [
              {
                "selector": "string",
                "comparisonType": "equal",
                "value": "string",
                "linkType": "and",
                "filters": [
                  null
                ],
                "sequenceNr": 0
              }
            ],
            "query": {
              "nonce": "string",
              "fields": [
                {}
              ],
              "entityType": "action",
              "joins": [
                {}
              ],
              "filters": [
                {}
              ],
              "groupBy": [
                {}
              ],
              "having": {
                "name": "string",
                "groupByAggregate": "count"
              },
              "sortFields": [
                {}
              ],
              "sortDirection": "asc",
              "limit": 0,
              "offset": 0
            },
            "recipients": [
              "string"
            ],
            "recipientSelector": "string",
            "toggleForAll": true,
            "channel": "email",
            "manualIntegration": {
              "nonce": "string",
              "type": "manual",
              "name": "string",
              "description": "string",
              "schedule": {
                "integrationSchedulerScheduleValue": 0,
                "integrationSchedulerScheduleType": "seconds",
                "milliseconds": 0
              },
              "dataSources": [
                {
                  "parameters": [],
                  "allowedIps": [],
                  "fields": [],
                  "filters": []
                }
              ],
              "enabled": true,
              "lastHandled": "2019-08-24T14:15:22Z",
              "sectorType": "boardComputer",
              "manualType": "transics",
              "enabledFunctions": [
                "string"
              ],
              "url": "string",
              "port": 0,
              "credentials": {
                "nonce": "string",
                "authenticationMethod": "apiKey",
                "username": "string",
                "password": "string",
                "accessKey": "string",
                "secretKey": "string",
                "clientId": "string",
                "clientSecret": "string",
                "grantType": "string",
                "scope": "string",
                "apiKey": "string",
                "bearer": "string",
                "sshKey": {},
                "sshTunnel": true,
                "sshHost": "string",
                "sshUsername": "string",
                "sshPassword": "string",
                "externalAttributes": {
                  "property1": {},
                  "property2": {}
                },
                "headers": {
                  "property1": {},
                  "property2": {}
                },
                "oauthUrl": "string",
                "oAuthCache": "string",
                "oAuthCacheCreationDate": "2019-08-24T14:15:22Z",
                "openIdToken": "string",
                "openIdRefreshToken": "string",
                "openIdAccessToken": "string",
                "openIdExpiration": "2019-08-24T14:15:22Z"
              },
              "filters": [
                {
                  "filters": []
                }
              ],
              "integration": [
                {}
              ]
            },
            "includeAttachments": true,
            "subject": "string",
            "currentTriggerPosition": 0,
            "localizedTexts": [
              {
                "language": {},
                "content": "string",
                "messageTemplate": "string",
                "subject": "string"
              }
            ],
            "defaultLanguageId": "string",
            "languageSelector": "string"
          },
          "enabled": true,
          "lastHandled": "2019-08-24T14:15:22Z",
          "template": true,
          "templateCategory": "string",
          "type": "messageAutomation",
          "notes": [
            {
              "nonce": "string",
              "author": {
                "nonce": "string",
                "hasAgreedToPrice": true,
                "type": "user",
                "username": "string",
                "firstName": "string",
                "lastName": "string",
                "email": "string",
                "phone": "string",
                "passwordModified": "2019-08-24T14:15:22Z",
                "twoFactorAuthentication": true,
                "status": "DELETED",
                "loginMethod": "DEFAULT",
                "accountType": "default",
                "standardLoadingSize": 10,
                "timezone": "string",
                "vehicleGroups": [
                  null
                ]
              },
              "name": "string",
              "text": "string"
            }
          ]
        },
        "consignments": [
          {
            "nonce": "string",
            "versionNumber": 0,
            "hasAgreedToPrice": true,
            "name": "string",
            "consignmentNr": "string",
            "description": "string",
            "status": "draft",
            "highValueGoods": true,
            "goods": [
              {
                "associationType": "inline"
              }
            ],
            "consignment": {},
            "originalPhysicalSender": {
              "nonce": "string",
              "type": "warehouse",
              "name": "string",
              "unCode": "string",
              "geoReference": {
                "nonce": "string",
                "type": "addressGeoReference",
                "hash": "string",
                "name": "string",
                "street": "string",
                "houseNumber": "string",
                "houseNumberAddition": "string",
                "postCode": "string",
                "city": "string",
                "country": "string"
              },
              "administrativeReference": {
                "name": "string",
                "street": "string",
                "houseNumber": "string",
                "houseNumberAddition": "string",
                "postalCode": "string",
                "city": "string",
                "country": "string"
              },
              "contactPersons": [
                {}
              ],
              "hash": "string",
              "externalAttributes": {
                "property1": {},
                "property2": {}
              },
              "attributes": [
                {}
              ],
              "remark": "string"
            },
            "originalLegalSender": {
              "nonce": "string",
              "type": "warehouse",
              "name": "string",
              "unCode": "string",
              "geoReference": {
                "nonce": "string",
                "type": "addressGeoReference",
                "hash": "string",
                "name": "string",
                "street": "string",
                "houseNumber": "string",
                "houseNumberAddition": "string",
                "postCode": "string",
                "city": "string",
                "country": "string"
              },
              "administrativeReference": {
                "name": "string",
                "street": "string",
                "houseNumber": "string",
                "houseNumberAddition": "string",
                "postalCode": "string",
                "city": "string",
                "country": "string"
              },
              "contactPersons": [
                {}
              ],
              "hash": "string",
              "externalAttributes": {
                "property1": {},
                "property2": {}
              },
              "attributes": [
                {}
              ],
              "remark": "string"
            },
            "originalPhysicalAddressee": {
              "nonce": "string",
              "type": "warehouse",
              "name": "string",
              "unCode": "string",
              "geoReference": {
                "nonce": "string",
                "type": "addressGeoReference",
                "hash": "string",
                "name": "string",
                "street": "string",
                "houseNumber": "string",
                "houseNumberAddition": "string",
                "postCode": "string",
                "city": "string",
                "country": "string"
              },
              "administrativeReference": {
                "name": "string",
                "street": "string",
                "houseNumber": "string",
                "houseNumberAddition": "string",
                "postalCode": "string",
                "city": "string",
                "country": "string"
              },
              "contactPersons": [
                {}
              ],
              "hash": "string",
              "externalAttributes": {
                "property1": {},
                "property2": {}
              },
              "attributes": [
                {}
              ],
              "remark": "string"
            },
            "originalLegalAddressee": {
              "nonce": "string",
              "type": "warehouse",
              "name": "string",
              "unCode": "string",
              "geoReference": {
                "nonce": "string",
                "type": "addressGeoReference",
                "hash": "string",
                "name": "string",
                "street": "string",
                "houseNumber": "string",
                "houseNumberAddition": "string",
                "postCode": "string",
                "city": "string",
                "country": "string"
              },
              "administrativeReference": {
                "name": "string",
                "street": "string",
                "houseNumber": "string",
                "houseNumberAddition": "string",
                "postalCode": "string",
                "city": "string",
                "country": "string"
              },
              "contactPersons": [
                {}
              ],
              "hash": "string",
              "externalAttributes": {
                "property1": {},
                "property2": {}
              },
              "attributes": [
                {}
              ],
              "remark": "string"
            },
            "isPlannedToLastLocation": true,
            "documents": [
              {
                "associationType": "inline"
              }
            ],
            "actors": [
              {
                "associationType": "inline"
              }
            ],
            "pricingElements": [
              {
                "nonce": "string",
                "name": "string",
                "description": "string",
                "category": {},
                "amount": {}
              }
            ],
            "externalAttributes": {
              "property1": {},
              "property2": {}
            },
            "expectedRevenue": {
              "nonce": "string",
              "amount": 0.1,
              "currency": {
                "nonce": "string",
                "name": "string",
                "short": "string",
                "sign": "string",
                "decimalDelimiter": "string",
                "thousandDelimiter": "string",
                "enabled": true
              },
              "taxRate": {
                "nonce": "string",
                "creditCode": "string",
                "debitCode": "string",
                "identifiers": [
                  null
                ],
                "name": "string",
                "description": "string",
                "jurisdiction": "string",
                "percentage": 0.1,
                "inclusive": true,
                "active": true
              },
              "inclusiveOfTax": true
            },
            "expectedCost": {
              "nonce": "string",
              "amount": 0.1,
              "currency": {
                "nonce": "string",
                "name": "string",
                "short": "string",
                "sign": "string",
                "decimalDelimiter": "string",
                "thousandDelimiter": "string",
                "enabled": true
              },
              "taxRate": {
                "nonce": "string",
                "creditCode": "string",
                "debitCode": "string",
                "identifiers": [
                  null
                ],
                "name": "string",
                "description": "string",
                "jurisdiction": "string",
                "percentage": 0.1,
                "inclusive": true,
                "active": true
              },
              "inclusiveOfTax": true
            },
            "combined": true,
            "type": "string",
            "remark": "string",
            "constraints": [
              {
                "nonce": "string",
                "name": "string",
                "enforceability": "enforced",
                "type": "accessConstraint",
                "description": "string"
              }
            ],
            "attributes": [
              {
                "nonce": "string",
                "name": "string",
                "color": "string"
              }
            ]
          }
        ],
        "purchasedUnits": 0,
        "capacity": {
          "nonce": "string",
          "name": "string",
          "description": "string",
          "business": {
            "id": "string",
            "nonce": "string",
            "uuid": "string",
            "primaryPlatformId": "string",
            "createdAt": "2019-08-24T14:15:22Z",
            "updatedAt": "2019-08-24T14:15:22Z",
            "name": "string",
            "relationType": "string",
            "alias": "string",
            "description": "string",
            "transportLicenseNumber": "string",
            "eori": "string",
            "scacCode": "string",
            "industry": {
              "id": "string",
              "nonce": "string",
              "uuid": "string",
              "primaryPlatformId": "string",
              "createdAt": "2019-08-24T14:15:22Z",
              "updatedAt": "2019-08-24T14:15:22Z",
              "name": "string",
              "abbreviated": "string",
              "enabled": true
            },
            "website": "string",
            "coc": "string",
            "vat": "string",
            "verified": true,
            "documents": [
              {
                "associationType": "inline",
                "entity": {
                  "externalAttributes": {}
                }
              }
            ],
            "logo": {
              "nonce": "string",
              "url": "string",
              "path": "string",
              "name": "string",
              "originalName": "string",
              "size": 0,
              "purpose": "string",
              "type": "IMAGE",
              "mimeType": "string",
              "extension": "string",
              "uploadedAt": "2019-08-24T14:15:22Z"
            },
            "banners": [
              {
                "id": "string",
                "nonce": "string",
                "uuid": "string",
                "primaryPlatformId": "string",
                "createdAt": "2019-08-24T14:15:22Z",
                "updatedAt": "2019-08-24T14:15:22Z",
                "url": "string",
                "path": "string",
                "name": "string",
                "originalName": "string",
                "size": 0,
                "purpose": "string",
                "type": "IMAGE",
                "mimeType": "string",
                "extension": "string",
                "uploadedAt": "2019-08-24T14:15:22Z"
              }
            ],
            "locations": [
              {
                "id": "string",
                "nonce": "string",
                "uuid": "string",
                "primaryPlatformId": "string",
                "createdAt": "2019-08-24T14:15:22Z",
                "updatedAt": "2019-08-24T14:15:22Z",
                "type": "warehouse",
                "name": "string",
                "unCode": "string",
                "geoReference": {},
                "administrativeReference": {},
                "contactDetails": [
                  null
                ],
                "constraints": [
                  null
                ],
                "pricingElements": [
                  null
                ],
                "remark": "string",
                "hash": "string",
                "externalAttributes": {
                  "property1": {},
                  "property2": {}
                }
              }
            ],
            "identification": [
              {
                "id": "string",
                "nonce": "string",
                "uuid": "string",
                "primaryPlatformId": "string",
                "createdAt": "2019-08-24T14:15:22Z",
                "updatedAt": "2019-08-24T14:15:22Z",
                "url": "string",
                "path": "string",
                "name": "string",
                "originalName": "string",
                "size": 0,
                "purpose": "string",
                "type": "IMAGE",
                "mimeType": "string",
                "extension": "string",
                "uploadedAt": "2019-08-24T14:15:22Z"
              }
            ],
            "contactDetails": [
              {
                "id": "string",
                "nonce": "string",
                "uuid": "string",
                "primaryPlatformId": "string",
                "createdAt": "2019-08-24T14:15:22Z",
                "updatedAt": "2019-08-24T14:15:22Z",
                "type": "iban",
                "value": "string",
                "remarks": "string"
              }
            ],
            "contactPersons": [
              {
                "id": "string",
                "nonce": "string",
                "uuid": "string",
                "primaryPlatformId": "string",
                "createdAt": "2019-08-24T14:15:22Z",
                "updatedAt": "2019-08-24T14:15:22Z",
                "firstName": "string",
                "lastName": "string",
                "position": "string",
                "email": "string",
                "phone": "string"
              }
            ],
            "administration": {
              "id": "string",
              "nonce": "string",
              "uuid": "string",
              "primaryPlatformId": "string",
              "createdAt": "2019-08-24T14:15:22Z",
              "updatedAt": "2019-08-24T14:15:22Z",
              "name": "string",
              "primary": true,
              "business": {},
              "currency": {
                "id": "string",
                "nonce": "string",
                "uuid": "string",
                "primaryPlatformId": "string",
                "createdAt": "2019-08-24T14:15:22Z",
                "updatedAt": "2019-08-24T14:15:22Z",
                "name": "string",
                "short": "string",
                "sign": "string",
                "decimalDelimiter": "string",
                "thousandDelimiter": "string",
                "enabled": true
              },
              "balance": {
                "id": "string",
                "nonce": "string",
                "uuid": "string",
                "primaryPlatformId": "string",
                "createdAt": "2019-08-24T14:15:22Z",
                "updatedAt": "2019-08-24T14:15:22Z",
                "amount": 0.1,
                "currency": {},
                "taxRate": {
                  "identifiers": []
                },
                "inclusiveOfTax": true
              },
              "numberFormat": "string",
              "numberLength": 0,
              "dueDays": 0,
              "invoiceNumberIndex": {
                "property1": 0,
                "property2": 0
              },
              "quoteNumberIndex": {
                "property1": 0,
                "property2": 0
              },
              "automaticallySendReminders": true,
              "invoiceTermsAndConditions": "string",
              "quoteTermsAndConditions": "string",
              "invoiceNumbering": 0,
              "quoteNumbering": 0
            },
            "pricingConfigurationCount": 0,
            "hasAgreedToPrice": true
          },
          "schedule": {
            "nonce": "string",
            "name": "string",
            "description": "string",
            "weekDays": [
              "sunday"
            ],
            "startDate": "2019-08-24T14:15:22Z",
            "endDate": "2019-08-24T14:15:22Z",
            "timeSlotTemplates": [
              {
                "nonce": "string",
                "capacityUnits": 0,
                "weekDay": "sunday",
                "startTime": "2019-08-24T14:15:22Z",
                "endTime": "2019-08-24T14:15:22Z",
                "pricingModules": [
                  null
                ]
              }
            ],
            "timeSlots": [
              {
                "nonce": "string",
                "date": "2019-08-24T14:15:22Z",
                "startTime": "2019-08-24T14:15:22Z",
                "endTime": "2019-08-24T14:15:22Z",
                "consignments": [
                  null
                ],
                "route": {
                  "expenses": [],
                  "additionalInfo": {},
                  "actors": [],
                  "actions": [],
                  "constraints": []
                }
              }
            ]
          },
          "modality": "maritime",
          "subType": "load",
          "capacityPerUnit": {
            "value": "string",
            "unit": "string"
          },
          "totalUnits": 0,
          "availableCapacity": {
            "value": "string",
            "unit": "string"
          },
          "totalCapacity": {
            "value": "string",
            "unit": "string"
          },
          "pricingModules": [
            {
              "nonce": "string",
              "type": "fixed",
              "name": "string",
              "sequenceNr": 0,
              "description": "string",
              "category": {
                "nonce": "string",
                "name": "string",
                "creditCode": "string",
                "debitCode": "string",
                "defaultValue": 0.1,
                "enabled": true
              },
              "taxRates": [
                {
                  "filters": []
                }
              ],
              "filters": [
                {
                  "filters": []
                }
              ],
              "oncePerInvoice": true
            }
          ]
        }
      },
      "name": "string",
      "description": "string",
      "vin": "string",
      "licensePlate": "string",
      "vehicleType": "string",
      "emissionStandard": "euro0",
      "fuelCapacity": {
        "value": "string",
        "unit": "string"
      },
      "fuelType": "string",
      "maxLinks": 0,
      "length": {
        "value": "string",
        "unit": "string"
      },
      "height": {
        "value": "string",
        "unit": "string"
      },
      "width": {
        "value": "string",
        "unit": "string"
      },
      "loadLength": {
        "value": "string",
        "unit": "string"
      },
      "loadHeight": {
        "value": "string",
        "unit": "string"
      },
      "loadWidth": {
        "value": "string",
        "unit": "string"
      },
      "maxWeight": {
        "value": "string",
        "unit": "string"
      },
      "emptyWeight": {
        "value": "string",
        "unit": "string"
      },
      "operational": true,
      "attributes": [
        {
          "nonce": "string",
          "name": "string",
          "color": "string"
        }
      ]
    },
    "actions": [
      {
        "nonce": "string",
        "versionNumber": 0,
        "type": "load",
        "groupId": "string",
        "name": "string",
        "externalAttributes": {
          "property1": {},
          "property2": {}
        },
        "lifeCycle": "requested",
        "result": {
          "status": "succeeded",
          "remark": "string",
          "reason": "string"
        },
        "remark": "string",
        "sequenceNr": 0,
        "location": {
          "associationType": "inline",
          "entity": {
            "id": "string",
            "nonce": "string",
            "uuid": "string",
            "primaryPlatformId": "string",
            "createdAt": "2019-08-24T14:15:22Z",
            "updatedAt": "2019-08-24T14:15:22Z",
            "type": "warehouse",
            "name": "string",
            "unCode": "string",
            "geoReference": {
              "id": "string",
              "nonce": "string",
              "uuid": "string",
              "primaryPlatformId": "string",
              "createdAt": "2019-08-24T14:15:22Z",
              "updatedAt": "2019-08-24T14:15:22Z",
              "type": "addressGeoReference",
              "name": "string",
              "street": "string",
              "houseNumber": "string",
              "houseNumberAddition": "string",
              "postalCode": "string",
              "city": "string",
              "country": "string",
              "hash": "string"
            },
            "administrativeReference": {
              "name": "string",
              "street": "string",
              "houseNumber": "string",
              "houseNumberAddition": "string",
              "postalCode": "string",
              "city": "string",
              "country": "string"
            },
            "contactDetails": [
              {
                "id": "string",
                "nonce": "string",
                "uuid": "string",
                "primaryPlatformId": "string",
                "createdAt": "2019-08-24T14:15:22Z",
                "updatedAt": "2019-08-24T14:15:22Z",
                "type": "iban",
                "value": "string",
                "remarks": "string"
              }
            ],
            "constraints": [
              {
                "id": "string",
                "nonce": "string",
                "uuid": "string",
                "primaryPlatformId": "string",
                "createdAt": "2019-08-24T14:15:22Z",
                "updatedAt": "2019-08-24T14:15:22Z",
                "type": "accessConstraint",
                "name": "string",
                "enforceability": "enforced",
                "description": "string"
              }
            ],
            "pricingElements": [
              {
                "id": "string",
                "nonce": "string",
                "uuid": "string",
                "primaryPlatformId": "string",
                "createdAt": "2019-08-24T14:15:22Z",
                "updatedAt": "2019-08-24T14:15:22Z",
                "name": "string",
                "description": "string",
                "category": {},
                "amount": {}
              }
            ],
            "remark": "string",
            "hash": "string",
            "externalAttributes": {
              "property1": {},
              "property2": {}
            }
          },
          "description": "string"
        },
        "startTime": "2019-08-24T14:15:22Z",
        "endTime": "2019-08-24T14:15:22Z",
        "eta": "2019-08-24T14:15:22Z",
        "etd": "2019-08-24T14:15:22Z",
        "timeFormat": "string",
        "recurrence": "string",
        "duration": 0,
        "estimatedDuration": 0,
        "actions": [
          {
            "type": "inline",
            "associationType": "string",
            "entity": {},
            "description": "string"
          }
        ],
        "documents": [
          {
            "associationType": "inline"
          }
        ],
        "identifiers": [
          {
            "nonce": "string",
            "name": "string",
            "system": "string",
            "value": "string",
            "expiredAt": "2019-08-24T14:15:22Z"
          }
        ],
        "constraints": [
          {
            "associationType": "inline",
            "entity": {
              "nonce": "string",
              "name": "string",
              "enforceability": "enforced",
              "type": "accessConstraint",
              "description": "string"
            },
            "description": "string"
          }
        ],
        "communicationRequests": [
          {
            "nonce": "string",
            "name": "string",
            "description": "string",
            "status": "pending",
            "responseMessage": "string",
            "responseValue": "string",
            "communicationRequests": [
              {}
            ]
          }
        ],
        "isContainmentAction": true,
        "vehicle": {
          "associationType": "inline"
        },
        "pin": "string",
        "tar": "string",
        "shipmentLine": {
          "scacCode": "string",
          "smdgCode": "string"
        },
        "containmentUUID": "string"
      }
    ],
    "constraints": [
      {
        "nonce": "string",
        "name": "string",
        "enforceability": "enforced",
        "type": "accessConstraint",
        "description": "string"
      }
    ],
    "route": {
      "nonce": "string",
      "time": 0,
      "cost": 0,
      "distance": 0,
      "expenses": [
        {
          "nonce": "string",
          "name": "string",
          "description": "string",
          "money": {
            "nonce": "string",
            "amount": 0.1,
            "currency": {
              "nonce": "string",
              "name": "string",
              "short": "string",
              "sign": "string",
              "decimalDelimiter": "string",
              "thousandDelimiter": "string",
              "enabled": true
            },
            "taxRate": {
              "nonce": "string",
              "creditCode": "string",
              "debitCode": "string",
              "identifiers": [
                {}
              ],
              "name": "string",
              "description": "string",
              "jurisdiction": "string",
              "percentage": 0.1,
              "inclusive": true,
              "active": true
            },
            "inclusiveOfTax": true
          }
        }
      ],
      "additionalInfo": {
        "property1": {},
        "property2": {}
      },
      "lineString": "string",
      "actors": [
        {
          "nonce": "string",
          "name": "string",
          "user": {
            "nonce": "string",
            "hasAgreedToPrice": true,
            "type": "user",
            "username": "string",
            "firstName": "string",
            "lastName": "string",
            "email": "string",
            "phone": "string",
            "passwordModified": "2019-08-24T14:15:22Z",
            "twoFactorAuthentication": true,
            "status": "DELETED",
            "loginMethod": "DEFAULT",
            "accountType": "default",
            "standardLoadingSize": 10,
            "timezone": "string",
            "vehicleGroups": [
              {
                "nonce": "string",
                "name": "string",
                "vehicles": [
                  null
                ]
              }
            ]
          },
          "identifiers": [
            {
              "nonce": "string",
              "name": "string",
              "system": "string",
              "value": "string",
              "expiredAt": "2019-08-24T14:15:22Z"
            }
          ],
          "contactDetails": [
            {
              "nonce": "string",
              "type": "iban",
              "value": "string",
              "remarks": "string"
            }
          ]
        }
      ],
      "actions": [
        {
          "nonce": "string",
          "versionNumber": 0,
          "type": "load",
          "groupId": "string",
          "name": "string",
          "externalAttributes": {
            "property1": {},
            "property2": {}
          },
          "lifeCycle": "requested",
          "result": {
            "status": "succeeded",
            "remark": "string",
            "reason": "string"
          },
          "remark": "string",
          "sequenceNr": 0,
          "location": {
            "associationType": "inline",
            "entity": {
              "id": "string",
              "nonce": "string",
              "uuid": "string",
              "primaryPlatformId": "string",
              "createdAt": "2019-08-24T14:15:22Z",
              "updatedAt": "2019-08-24T14:15:22Z",
              "type": "warehouse",
              "name": "string",
              "unCode": "string",
              "geoReference": {
                "id": "string",
                "nonce": "string",
                "uuid": "string",
                "primaryPlatformId": "string",
                "createdAt": "2019-08-24T14:15:22Z",
                "updatedAt": "2019-08-24T14:15:22Z",
                "type": "addressGeoReference",
                "name": "string",
                "street": "string",
                "houseNumber": "string",
                "houseNumberAddition": "string",
                "postalCode": "string",
                "city": "string",
                "country": "string",
                "hash": "string"
              },
              "administrativeReference": {
                "name": "string",
                "street": "string",
                "houseNumber": "string",
                "houseNumberAddition": "string",
                "postalCode": "string",
                "city": "string",
                "country": "string"
              },
              "contactDetails": [
                {}
              ],
              "constraints": [
                {}
              ],
              "pricingElements": [
                {}
              ],
              "remark": "string",
              "hash": "string",
              "externalAttributes": {
                "property1": {},
                "property2": {}
              }
            },
            "description": "string"
          },
          "startTime": "2019-08-24T14:15:22Z",
          "endTime": "2019-08-24T14:15:22Z",
          "eta": "2019-08-24T14:15:22Z",
          "etd": "2019-08-24T14:15:22Z",
          "timeFormat": "string",
          "recurrence": "string",
          "duration": 0,
          "estimatedDuration": 0,
          "actions": [
            {
              "type": "inline",
              "associationType": "string",
              "entity": {},
              "description": "string"
            }
          ],
          "documents": [
            {
              "associationType": "inline"
            }
          ],
          "identifiers": [
            {
              "nonce": "string",
              "name": "string",
              "system": "string",
              "value": "string",
              "expiredAt": "2019-08-24T14:15:22Z"
            }
          ],
          "constraints": [
            {
              "associationType": "inline",
              "entity": {
                "nonce": "string",
                "name": "string",
                "enforceability": "enforced",
                "type": "accessConstraint",
                "description": "string"
              },
              "description": "string"
            }
          ],
          "communicationRequests": [
            {
              "nonce": "string",
              "name": "string",
              "description": "string",
              "status": "pending",
              "responseMessage": "string",
              "responseValue": "string",
              "communicationRequests": [
                {}
              ]
            }
          ],
          "isContainmentAction": true,
          "vehicle": {
            "associationType": "inline"
          },
          "pin": "string",
          "tar": "string",
          "shipmentLine": {
            "scacCode": "string",
            "smdgCode": "string"
          },
          "containmentUUID": "string"
        }
      ],
      "name": "string",
      "constraints": [
        {
          "nonce": "string",
          "name": "string",
          "enforceability": "enforced",
          "type": "accessConstraint",
          "description": "string"
        }
      ]
    }
  }'

Responses

Success

Bodyapplication/json
successboolean
messagestring
codeinteger(int32)
routeobject(RouteModel)
Response
application/json
{ "success": true, "message": "string", "code": 0, "route": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "time": 0, "cost": 0, "distance": 0, "expenses": [], "additionalInfo": {}, "lineString": "string", "actors": [], "actions": [], "constraints": [] } }

Calculate and create a new route

Request

Calculate and create a new route based on Vehicle and the Georeferences

Headers
Authorizationstringrequired
Bodyapplication/jsonrequired
namestring
vehicleobject(Vehicle)
geoReferencesArray of objects(GeoReference)
constraintsArray of objects(Constraint)
curl -i -X POST \
  https://docs.transportial.com/_mock/apis/route/calculate:georeferences \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "vehicle": {
      "nonce": "string",
      "versionNumber": 0,
      "hasAgreedToPrice": true,
      "transportMode": "maritime",
      "loadCapacities": [
        {
          "value": "string",
          "unit": "string"
        }
      ],
      "loadMeters": {
        "value": "string",
        "unit": "string"
      },
      "actors": [
        {
          "associationType": "inline"
        }
      ],
      "legalStatistics": {
        "lastInstantOfAVehicleOwnerLocation": "2019-08-24T14:15:22Z",
        "countryCabotageStatistics": {
          "property1": {
            "completedCabotageTrips": 0,
            "lastInstantOfCompletedCabotageTrip": "2019-08-24T14:15:22Z",
            "lastInstantOfInternationalTripWithCountryAsDestination": "2019-08-24T14:15:22Z"
          },
          "property2": {
            "completedCabotageTrips": 0,
            "lastInstantOfCompletedCabotageTrip": "2019-08-24T14:15:22Z",
            "lastInstantOfInternationalTripWithCountryAsDestination": "2019-08-24T14:15:22Z"
          }
        },
        "lastInstantOfInternationalTrip": "2019-08-24T14:15:22Z",
        "lastInternationalTripDestinationCountry": "string"
      },
      "capacityContract": {
        "nonce": "string",
        "name": "string",
        "type": "permanentContract",
        "communicationMethod": "messageAutomation",
        "contract": {
          "nonce": "string",
          "title": "string",
          "description": "string",
          "deliveryTerms": "EXW",
          "contractor": {
            "id": "string",
            "nonce": "string",
            "uuid": "string",
            "primaryPlatformId": "string",
            "createdAt": "2019-08-24T14:15:22Z",
            "updatedAt": "2019-08-24T14:15:22Z",
            "name": "string",
            "relationType": "string",
            "alias": "string",
            "description": "string",
            "transportLicenseNumber": "string",
            "eori": "string",
            "scacCode": "string",
            "industry": {
              "id": "string",
              "nonce": "string",
              "uuid": "string",
              "primaryPlatformId": "string",
              "createdAt": "2019-08-24T14:15:22Z",
              "updatedAt": "2019-08-24T14:15:22Z",
              "name": "string",
              "abbreviated": "string",
              "enabled": true
            },
            "website": "string",
            "coc": "string",
            "vat": "string",
            "verified": true,
            "documents": [
              {
                "associationType": "inline",
                "entity": {
                  "externalAttributes": {}
                }
              }
            ],
            "logo": {
              "nonce": "string",
              "url": "string",
              "path": "string",
              "name": "string",
              "originalName": "string",
              "size": 0,
              "purpose": "string",
              "type": "IMAGE",
              "mimeType": "string",
              "extension": "string",
              "uploadedAt": "2019-08-24T14:15:22Z"
            },
            "banners": [
              {
                "id": "string",
                "nonce": "string",
                "uuid": "string",
                "primaryPlatformId": "string",
                "createdAt": "2019-08-24T14:15:22Z",
                "updatedAt": "2019-08-24T14:15:22Z",
                "url": "string",
                "path": "string",
                "name": "string",
                "originalName": "string",
                "size": 0,
                "purpose": "string",
                "type": "IMAGE",
                "mimeType": "string",
                "extension": "string",
                "uploadedAt": "2019-08-24T14:15:22Z"
              }
            ],
            "locations": [
              {
                "id": "string",
                "nonce": "string",
                "uuid": "string",
                "primaryPlatformId": "string",
                "createdAt": "2019-08-24T14:15:22Z",
                "updatedAt": "2019-08-24T14:15:22Z",
                "type": "warehouse",
                "name": "string",
                "unCode": "string",
                "geoReference": {},
                "administrativeReference": {},
                "contactDetails": [
                  null
                ],
                "constraints": [
                  null
                ],
                "pricingElements": [
                  null
                ],
                "remark": "string",
                "hash": "string",
                "externalAttributes": {
                  "property1": {},
                  "property2": {}
                }
              }
            ],
            "identification": [
              {
                "id": "string",
                "nonce": "string",
                "uuid": "string",
                "primaryPlatformId": "string",
                "createdAt": "2019-08-24T14:15:22Z",
                "updatedAt": "2019-08-24T14:15:22Z",
                "url": "string",
                "path": "string",
                "name": "string",
                "originalName": "string",
                "size": 0,
                "purpose": "string",
                "type": "IMAGE",
                "mimeType": "string",
                "extension": "string",
                "uploadedAt": "2019-08-24T14:15:22Z"
              }
            ],
            "contactDetails": [
              {
                "id": "string",
                "nonce": "string",
                "uuid": "string",
                "primaryPlatformId": "string",
                "createdAt": "2019-08-24T14:15:22Z",
                "updatedAt": "2019-08-24T14:15:22Z",
                "type": "iban",
                "value": "string",
                "remarks": "string"
              }
            ],
            "contactPersons": [
              {
                "id": "string",
                "nonce": "string",
                "uuid": "string",
                "primaryPlatformId": "string",
                "createdAt": "2019-08-24T14:15:22Z",
                "updatedAt": "2019-08-24T14:15:22Z",
                "firstName": "string",
                "lastName": "string",
                "position": "string",
                "email": "string",
                "phone": "string"
              }
            ],
            "administration": {
              "id": "string",
              "nonce": "string",
              "uuid": "string",
              "primaryPlatformId": "string",
              "createdAt": "2019-08-24T14:15:22Z",
              "updatedAt": "2019-08-24T14:15:22Z",
              "name": "string",
              "primary": true,
              "business": {},
              "currency": {
                "id": "string",
                "nonce": "string",
                "uuid": "string",
                "primaryPlatformId": "string",
                "createdAt": "2019-08-24T14:15:22Z",
                "updatedAt": "2019-08-24T14:15:22Z",
                "name": "string",
                "short": "string",
                "sign": "string",
                "decimalDelimiter": "string",
                "thousandDelimiter": "string",
                "enabled": true
              },
              "balance": {
                "id": "string",
                "nonce": "string",
                "uuid": "string",
                "primaryPlatformId": "string",
                "createdAt": "2019-08-24T14:15:22Z",
                "updatedAt": "2019-08-24T14:15:22Z",
                "amount": 0.1,
                "currency": {},
                "taxRate": {
                  "identifiers": []
                },
                "inclusiveOfTax": true
              },
              "numberFormat": "string",
              "numberLength": 0,
              "dueDays": 0,
              "invoiceNumberIndex": {
                "property1": 0,
                "property2": 0
              },
              "quoteNumberIndex": {
                "property1": 0,
                "property2": 0
              },
              "automaticallySendReminders": true,
              "invoiceTermsAndConditions": "string",
              "quoteTermsAndConditions": "string",
              "invoiceNumbering": 0,
              "quoteNumbering": 0
            },
            "pricingConfigurationCount": 0,
            "hasAgreedToPrice": true
          },
          "contractorSignee": {
            "nonce": "string",
            "firstName": "string",
            "lastName": "string",
            "position": "string",
            "email": "string",
            "phone": "string"
          },
          "client": {
            "id": "string",
            "nonce": "string",
            "uuid": "string",
            "primaryPlatformId": "string",
            "createdAt": "2019-08-24T14:15:22Z",
            "updatedAt": "2019-08-24T14:15:22Z",
            "name": "string",
            "relationType": "string",
            "alias": "string",
            "description": "string",
            "transportLicenseNumber": "string",
            "eori": "string",
            "scacCode": "string",
            "industry": {
              "id": "string",
              "nonce": "string",
              "uuid": "string",
              "primaryPlatformId": "string",
              "createdAt": "2019-08-24T14:15:22Z",
              "updatedAt": "2019-08-24T14:15:22Z",
              "name": "string",
              "abbreviated": "string",
              "enabled": true
            },
            "website": "string",
            "coc": "string",
            "vat": "string",
            "verified": true,
            "documents": [
              {
                "associationType": "inline",
                "entity": {
                  "externalAttributes": {}
                }
              }
            ],
            "logo": {
              "nonce": "string",
              "url": "string",
              "path": "string",
              "name": "string",
              "originalName": "string",
              "size": 0,
              "purpose": "string",
              "type": "IMAGE",
              "mimeType": "string",
              "extension": "string",
              "uploadedAt": "2019-08-24T14:15:22Z"
            },
            "banners": [
              {
                "id": "string",
                "nonce": "string",
                "uuid": "string",
                "primaryPlatformId": "string",
                "createdAt": "2019-08-24T14:15:22Z",
                "updatedAt": "2019-08-24T14:15:22Z",
                "url": "string",
                "path": "string",
                "name": "string",
                "originalName": "string",
                "size": 0,
                "purpose": "string",
                "type": "IMAGE",
                "mimeType": "string",
                "extension": "string",
                "uploadedAt": "2019-08-24T14:15:22Z"
              }
            ],
            "locations": [
              {
                "id": "string",
                "nonce": "string",
                "uuid": "string",
                "primaryPlatformId": "string",
                "createdAt": "2019-08-24T14:15:22Z",
                "updatedAt": "2019-08-24T14:15:22Z",
                "type": "warehouse",
                "name": "string",
                "unCode": "string",
                "geoReference": {},
                "administrativeReference": {},
                "contactDetails": [
                  null
                ],
                "constraints": [
                  null
                ],
                "pricingElements": [
                  null
                ],
                "remark": "string",
                "hash": "string",
                "externalAttributes": {
                  "property1": {},
                  "property2": {}
                }
              }
            ],
            "identification": [
              {
                "id": "string",
                "nonce": "string",
                "uuid": "string",
                "primaryPlatformId": "string",
                "createdAt": "2019-08-24T14:15:22Z",
                "updatedAt": "2019-08-24T14:15:22Z",
                "url": "string",
                "path": "string",
                "name": "string",
                "originalName": "string",
                "size": 0,
                "purpose": "string",
                "type": "IMAGE",
                "mimeType": "string",
                "extension": "string",
                "uploadedAt": "2019-08-24T14:15:22Z"
              }
            ],
            "contactDetails": [
              {
                "id": "string",
                "nonce": "string",
                "uuid": "string",
                "primaryPlatformId": "string",
                "createdAt": "2019-08-24T14:15:22Z",
                "updatedAt": "2019-08-24T14:15:22Z",
                "type": "iban",
                "value": "string",
                "remarks": "string"
              }
            ],
            "contactPersons": [
              {
                "id": "string",
                "nonce": "string",
                "uuid": "string",
                "primaryPlatformId": "string",
                "createdAt": "2019-08-24T14:15:22Z",
                "updatedAt": "2019-08-24T14:15:22Z",
                "firstName": "string",
                "lastName": "string",
                "position": "string",
                "email": "string",
                "phone": "string"
              }
            ],
            "administration": {
              "id": "string",
              "nonce": "string",
              "uuid": "string",
              "primaryPlatformId": "string",
              "createdAt": "2019-08-24T14:15:22Z",
              "updatedAt": "2019-08-24T14:15:22Z",
              "name": "string",
              "primary": true,
              "business": {},
              "currency": {
                "id": "string",
                "nonce": "string",
                "uuid": "string",
                "primaryPlatformId": "string",
                "createdAt": "2019-08-24T14:15:22Z",
                "updatedAt": "2019-08-24T14:15:22Z",
                "name": "string",
                "short": "string",
                "sign": "string",
                "decimalDelimiter": "string",
                "thousandDelimiter": "string",
                "enabled": true
              },
              "balance": {
                "id": "string",
                "nonce": "string",
                "uuid": "string",
                "primaryPlatformId": "string",
                "createdAt": "2019-08-24T14:15:22Z",
                "updatedAt": "2019-08-24T14:15:22Z",
                "amount": 0.1,
                "currency": {},
                "taxRate": {
                  "identifiers": []
                },
                "inclusiveOfTax": true
              },
              "numberFormat": "string",
              "numberLength": 0,
              "dueDays": 0,
              "invoiceNumberIndex": {
                "property1": 0,
                "property2": 0
              },
              "quoteNumberIndex": {
                "property1": 0,
                "property2": 0
              },
              "automaticallySendReminders": true,
              "invoiceTermsAndConditions": "string",
              "quoteTermsAndConditions": "string",
              "invoiceNumbering": 0,
              "quoteNumbering": 0
            },
            "pricingConfigurationCount": 0,
            "hasAgreedToPrice": true
          },
          "clientSignee": {
            "nonce": "string",
            "firstName": "string",
            "lastName": "string",
            "position": "string",
            "email": "string",
            "phone": "string"
          }
        },
        "business": {
          "id": "string",
          "nonce": "string",
          "uuid": "string",
          "primaryPlatformId": "string",
          "createdAt": "2019-08-24T14:15:22Z",
          "updatedAt": "2019-08-24T14:15:22Z",
          "name": "string",
          "relationType": "string",
          "alias": "string",
          "description": "string",
          "transportLicenseNumber": "string",
          "eori": "string",
          "scacCode": "string",
          "industry": {
            "id": "string",
            "nonce": "string",
            "uuid": "string",
            "primaryPlatformId": "string",
            "createdAt": "2019-08-24T14:15:22Z",
            "updatedAt": "2019-08-24T14:15:22Z",
            "name": "string",
            "abbreviated": "string",
            "enabled": true
          },
          "website": "string",
          "coc": "string",
          "vat": "string",
          "verified": true,
          "documents": [
            {
              "associationType": "inline",
              "entity": {
                "nonce": "string",
                "description": "string",
                "expiresAt": "2019-08-24T14:15:22Z",
                "fileName": "string",
                "mimeType": "string",
                "encoding": "string",
                "verified": true,
                "content": {},
                "file": {},
                "externalAttributes": {
                  "property1": {},
                  "property2": {}
                },
                "name": "string"
              }
            }
          ],
          "logo": {
            "nonce": "string",
            "url": "string",
            "path": "string",
            "name": "string",
            "originalName": "string",
            "size": 0,
            "purpose": "string",
            "type": "IMAGE",
            "mimeType": "string",
            "extension": "string",
            "uploadedAt": "2019-08-24T14:15:22Z"
          },
          "banners": [
            {
              "id": "string",
              "nonce": "string",
              "uuid": "string",
              "primaryPlatformId": "string",
              "createdAt": "2019-08-24T14:15:22Z",
              "updatedAt": "2019-08-24T14:15:22Z",
              "url": "string",
              "path": "string",
              "name": "string",
              "originalName": "string",
              "size": 0,
              "purpose": "string",
              "type": "IMAGE",
              "mimeType": "string",
              "extension": "string",
              "uploadedAt": "2019-08-24T14:15:22Z"
            }
          ],
          "locations": [
            {
              "id": "string",
              "nonce": "string",
              "uuid": "string",
              "primaryPlatformId": "string",
              "createdAt": "2019-08-24T14:15:22Z",
              "updatedAt": "2019-08-24T14:15:22Z",
              "type": "warehouse",
              "name": "string",
              "unCode": "string",
              "geoReference": {
                "id": "string",
                "nonce": "string",
                "uuid": "string",
                "primaryPlatformId": "string",
                "createdAt": "2019-08-24T14:15:22Z",
                "updatedAt": "2019-08-24T14:15:22Z",
                "type": "addressGeoReference",
                "name": "string",
                "street": "string",
                "houseNumber": "string",
                "houseNumberAddition": "string",
                "postalCode": "string",
                "city": "string",
                "country": "string",
                "hash": "string"
              },
              "administrativeReference": {
                "name": "string",
                "street": "string",
                "houseNumber": "string",
                "houseNumberAddition": "string",
                "postalCode": "string",
                "city": "string",
                "country": "string"
              },
              "contactDetails": [
                {}
              ],
              "constraints": [
                {}
              ],
              "pricingElements": [
                {}
              ],
              "remark": "string",
              "hash": "string",
              "externalAttributes": {
                "property1": {},
                "property2": {}
              }
            }
          ],
          "identification": [
            {
              "id": "string",
              "nonce": "string",
              "uuid": "string",
              "primaryPlatformId": "string",
              "createdAt": "2019-08-24T14:15:22Z",
              "updatedAt": "2019-08-24T14:15:22Z",
              "url": "string",
              "path": "string",
              "name": "string",
              "originalName": "string",
              "size": 0,
              "purpose": "string",
              "type": "IMAGE",
              "mimeType": "string",
              "extension": "string",
              "uploadedAt": "2019-08-24T14:15:22Z"
            }
          ],
          "contactDetails": [
            {
              "id": "string",
              "nonce": "string",
              "uuid": "string",
              "primaryPlatformId": "string",
              "createdAt": "2019-08-24T14:15:22Z",
              "updatedAt": "2019-08-24T14:15:22Z",
              "type": "iban",
              "value": "string",
              "remarks": "string"
            }
          ],
          "contactPersons": [
            {
              "id": "string",
              "nonce": "string",
              "uuid": "string",
              "primaryPlatformId": "string",
              "createdAt": "2019-08-24T14:15:22Z",
              "updatedAt": "2019-08-24T14:15:22Z",
              "firstName": "string",
              "lastName": "string",
              "position": "string",
              "email": "string",
              "phone": "string"
            }
          ],
          "administration": {
            "id": "string",
            "nonce": "string",
            "uuid": "string",
            "primaryPlatformId": "string",
            "createdAt": "2019-08-24T14:15:22Z",
            "updatedAt": "2019-08-24T14:15:22Z",
            "name": "string",
            "primary": true,
            "business": {},
            "currency": {
              "id": "string",
              "nonce": "string",
              "uuid": "string",
              "primaryPlatformId": "string",
              "createdAt": "2019-08-24T14:15:22Z",
              "updatedAt": "2019-08-24T14:15:22Z",
              "name": "string",
              "short": "string",
              "sign": "string",
              "decimalDelimiter": "string",
              "thousandDelimiter": "string",
              "enabled": true
            },
            "balance": {
              "id": "string",
              "nonce": "string",
              "uuid": "string",
              "primaryPlatformId": "string",
              "createdAt": "2019-08-24T14:15:22Z",
              "updatedAt": "2019-08-24T14:15:22Z",
              "amount": 0.1,
              "currency": {
                "id": "string",
                "nonce": "string",
                "uuid": "string",
                "primaryPlatformId": "string",
                "createdAt": "2019-08-24T14:15:22Z",
                "updatedAt": "2019-08-24T14:15:22Z",
                "name": "string",
                "short": "string",
                "sign": "string",
                "decimalDelimiter": "string",
                "thousandDelimiter": "string",
                "enabled": true
              },
              "taxRate": {
                "nonce": "string",
                "creditCode": "string",
                "debitCode": "string",
                "identifiers": [
                  null
                ],
                "name": "string",
                "description": "string",
                "jurisdiction": "string",
                "percentage": 0.1,
                "inclusive": true,
                "active": true
              },
              "inclusiveOfTax": true
            },
            "numberFormat": "string",
            "numberLength": 0,
            "dueDays": 0,
            "invoiceNumberIndex": {
              "property1": 0,
              "property2": 0
            },
            "quoteNumberIndex": {
              "property1": 0,
              "property2": 0
            },
            "automaticallySendReminders": true,
            "invoiceTermsAndConditions": "string",
            "quoteTermsAndConditions": "string",
            "invoiceNumbering": 0,
            "quoteNumbering": 0
          },
          "pricingConfigurationCount": 0,
          "hasAgreedToPrice": true
        },
        "administration": {
          "nonce": "string",
          "name": "string",
          "primary": true,
          "business": {
            "id": "string",
            "nonce": "string",
            "uuid": "string",
            "primaryPlatformId": "string",
            "createdAt": "2019-08-24T14:15:22Z",
            "updatedAt": "2019-08-24T14:15:22Z",
            "name": "string",
            "relationType": "string",
            "alias": "string",
            "description": "string",
            "transportLicenseNumber": "string",
            "eori": "string",
            "scacCode": "string",
            "industry": {
              "id": "string",
              "nonce": "string",
              "uuid": "string",
              "primaryPlatformId": "string",
              "createdAt": "2019-08-24T14:15:22Z",
              "updatedAt": "2019-08-24T14:15:22Z",
              "name": "string",
              "abbreviated": "string",
              "enabled": true
            },
            "website": "string",
            "coc": "string",
            "vat": "string",
            "verified": true,
            "documents": [
              {
                "associationType": "inline",
                "entity": {
                  "externalAttributes": {}
                }
              }
            ],
            "logo": {
              "nonce": "string",
              "url": "string",
              "path": "string",
              "name": "string",
              "originalName": "string",
              "size": 0,
              "purpose": "string",
              "type": "IMAGE",
              "mimeType": "string",
              "extension": "string",
              "uploadedAt": "2019-08-24T14:15:22Z"
            },
            "banners": [
              {
                "id": "string",
                "nonce": "string",
                "uuid": "string",
                "primaryPlatformId": "string",
                "createdAt": "2019-08-24T14:15:22Z",
                "updatedAt": "2019-08-24T14:15:22Z",
                "url": "string",
                "path": "string",
                "name": "string",
                "originalName": "string",
                "size": 0,
                "purpose": "string",
                "type": "IMAGE",
                "mimeType": "string",
                "extension": "string",
                "uploadedAt": "2019-08-24T14:15:22Z"
              }
            ],
            "locations": [
              {
                "id": "string",
                "nonce": "string",
                "uuid": "string",
                "primaryPlatformId": "string",
                "createdAt": "2019-08-24T14:15:22Z",
                "updatedAt": "2019-08-24T14:15:22Z",
                "type": "warehouse",
                "name": "string",
                "unCode": "string",
                "geoReference": {},
                "administrativeReference": {},
                "contactDetails": [
                  null
                ],
                "constraints": [
                  null
                ],
                "pricingElements": [
                  null
                ],
                "remark": "string",
                "hash": "string",
                "externalAttributes": {
                  "property1": {},
                  "property2": {}
                }
              }
            ],
            "identification": [
              {
                "id": "string",
                "nonce": "string",
                "uuid": "string",
                "primaryPlatformId": "string",
                "createdAt": "2019-08-24T14:15:22Z",
                "updatedAt": "2019-08-24T14:15:22Z",
                "url": "string",
                "path": "string",
                "name": "string",
                "originalName": "string",
                "size": 0,
                "purpose": "string",
                "type": "IMAGE",
                "mimeType": "string",
                "extension": "string",
                "uploadedAt": "2019-08-24T14:15:22Z"
              }
            ],
            "contactDetails": [
              {
                "id": "string",
                "nonce": "string",
                "uuid": "string",
                "primaryPlatformId": "string",
                "createdAt": "2019-08-24T14:15:22Z",
                "updatedAt": "2019-08-24T14:15:22Z",
                "type": "iban",
                "value": "string",
                "remarks": "string"
              }
            ],
            "contactPersons": [
              {
                "id": "string",
                "nonce": "string",
                "uuid": "string",
                "primaryPlatformId": "string",
                "createdAt": "2019-08-24T14:15:22Z",
                "updatedAt": "2019-08-24T14:15:22Z",
                "firstName": "string",
                "lastName": "string",
                "position": "string",
                "email": "string",
                "phone": "string"
              }
            ],
            "administration": {
              "id": "string",
              "nonce": "string",
              "uuid": "string",
              "primaryPlatformId": "string",
              "createdAt": "2019-08-24T14:15:22Z",
              "updatedAt": "2019-08-24T14:15:22Z",
              "name": "string",
              "primary": true,
              "business": {},
              "currency": {
                "id": "string",
                "nonce": "string",
                "uuid": "string",
                "primaryPlatformId": "string",
                "createdAt": "2019-08-24T14:15:22Z",
                "updatedAt": "2019-08-24T14:15:22Z",
                "name": "string",
                "short": "string",
                "sign": "string",
                "decimalDelimiter": "string",
                "thousandDelimiter": "string",
                "enabled": true
              },
              "balance": {
                "id": "string",
                "nonce": "string",
                "uuid": "string",
                "primaryPlatformId": "string",
                "createdAt": "2019-08-24T14:15:22Z",
                "updatedAt": "2019-08-24T14:15:22Z",
                "amount": 0.1,
                "currency": {},
                "taxRate": {
                  "identifiers": []
                },
                "inclusiveOfTax": true
              },
              "numberFormat": "string",
              "numberLength": 0,
              "dueDays": 0,
              "invoiceNumberIndex": {
                "property1": 0,
                "property2": 0
              },
              "quoteNumberIndex": {
                "property1": 0,
                "property2": 0
              },
              "automaticallySendReminders": true,
              "invoiceTermsAndConditions": "string",
              "quoteTermsAndConditions": "string",
              "invoiceNumbering": 0,
              "quoteNumbering": 0
            },
            "pricingConfigurationCount": 0,
            "hasAgreedToPrice": true
          },
          "currency": {
            "nonce": "string",
            "name": "string",
            "short": "string",
            "sign": "string",
            "decimalDelimiter": "string",
            "thousandDelimiter": "string",
            "enabled": true
          },
          "balance": {
            "nonce": "string",
            "amount": 0.1,
            "currency": {
              "nonce": "string",
              "name": "string",
              "short": "string",
              "sign": "string",
              "decimalDelimiter": "string",
              "thousandDelimiter": "string",
              "enabled": true
            },
            "taxRate": {
              "nonce": "string",
              "creditCode": "string",
              "debitCode": "string",
              "identifiers": [
                {}
              ],
              "name": "string",
              "description": "string",
              "jurisdiction": "string",
              "percentage": 0.1,
              "inclusive": true,
              "active": true
            },
            "inclusiveOfTax": true
          },
          "numberFormat": "string",
          "numberLength": 0,
          "dueDays": 0,
          "invoiceNumberIndex": {
            "property1": 0,
            "property2": 0
          },
          "quoteNumberIndex": {
            "property1": 0,
            "property2": 0
          },
          "automaticallySendReminders": true,
          "invoiceTermsAndConditions": "string",
          "quoteTermsAndConditions": "string",
          "invoiceStandardDocuments": [
            {
              "nonce": "string",
              "description": "string",
              "expiresAt": "2019-08-24T14:15:22Z",
              "fileName": "string",
              "mimeType": "string",
              "encoding": "string",
              "verified": true,
              "content": {
                "contentType": "data",
                "data": "string"
              },
              "file": {
                "nonce": "string",
                "url": "string",
                "path": "string",
                "name": "string",
                "originalName": "string",
                "size": 0,
                "purpose": "string",
                "type": "IMAGE",
                "mimeType": "string",
                "extension": "string",
                "uploadedAt": "2019-08-24T14:15:22Z"
              },
              "externalAttributes": {
                "property1": {},
                "property2": {}
              },
              "name": "string"
            }
          ],
          "quoteStandardDocuments": [
            {
              "nonce": "string",
              "description": "string",
              "expiresAt": "2019-08-24T14:15:22Z",
              "fileName": "string",
              "mimeType": "string",
              "encoding": "string",
              "verified": true,
              "content": {
                "contentType": "data",
                "data": "string"
              },
              "file": {
                "nonce": "string",
                "url": "string",
                "path": "string",
                "name": "string",
                "originalName": "string",
                "size": 0,
                "purpose": "string",
                "type": "IMAGE",
                "mimeType": "string",
                "extension": "string",
                "uploadedAt": "2019-08-24T14:15:22Z"
              },
              "externalAttributes": {
                "property1": {},
                "property2": {}
              },
              "name": "string"
            }
          ],
          "invoiceNumbering": 0,
          "quoteNumbering": 0
        },
        "startTime": "2019-08-24T14:15:22Z",
        "endTime": "2019-08-24T14:15:22Z",
        "selfBilling": true,
        "currency": {
          "nonce": "string",
          "name": "string",
          "short": "string",
          "sign": "string",
          "decimalDelimiter": "string",
          "thousandDelimiter": "string",
          "enabled": true
        },
        "triggerType": "endOfWeek",
        "pricingModules": [
          {
            "nonce": "string",
            "type": "fixed",
            "name": "string",
            "sequenceNr": 0,
            "description": "string",
            "category": {
              "nonce": "string",
              "name": "string",
              "creditCode": "string",
              "debitCode": "string",
              "defaultValue": 0.1,
              "enabled": true
            },
            "taxRates": [
              {
                "nonce": "string",
                "sequenceNr": 0,
                "name": "string",
                "description": "string",
                "taxRate": {
                  "identifiers": []
                },
                "filters": [
                  null
                ]
              }
            ],
            "filters": [
              {
                "selector": "string",
                "comparisonType": "equal",
                "value": "string",
                "linkType": "and",
                "filters": [
                  null
                ],
                "sequenceNr": 0
              }
            ],
            "oncePerInvoice": true
          }
        ],
        "lastHandledSelfBilling": "2019-08-24T14:15:22Z",
        "signature": {
          "nonce": "string",
          "ip": "string",
          "userAgent": "string",
          "date": "2019-08-24T14:15:22Z",
          "file": {
            "nonce": "string",
            "url": "string",
            "path": "string",
            "name": "string",
            "originalName": "string",
            "size": 0,
            "purpose": "string",
            "type": "IMAGE",
            "mimeType": "string",
            "extension": "string",
            "uploadedAt": "2019-08-24T14:15:22Z"
          }
        },
        "integration": {
          "nonce": "string",
          "type": "manual",
          "name": "string",
          "description": "string",
          "schedule": {
            "integrationSchedulerScheduleValue": 0,
            "integrationSchedulerScheduleType": "seconds",
            "milliseconds": 0
          },
          "dataSources": [
            {
              "nonce": "string",
              "directionType": "in",
              "connectionType": "api",
              "requestMethod": "get",
              "dataType": "xml",
              "entityType": "action",
              "url": "string",
              "port": 0,
              "path": "string",
              "token": "string",
              "query": "string",
              "parameters": [
                {
                  "fields": [],
                  "filters": [],
                  "options": []
                }
              ],
              "allowedIps": [
                "string"
              ],
              "hasAuthentication": true,
              "credentials": {
                "nonce": "string",
                "authenticationMethod": "apiKey",
                "username": "string",
                "password": "string",
                "accessKey": "string",
                "secretKey": "string",
                "clientId": "string",
                "clientSecret": "string",
                "grantType": "string",
                "scope": "string",
                "apiKey": "string",
                "bearer": "string",
                "sshKey": {},
                "sshTunnel": true,
                "sshHost": "string",
                "sshUsername": "string",
                "sshPassword": "string",
                "externalAttributes": {
                  "property1": {},
                  "property2": {}
                },
                "headers": {
                  "property1": {},
                  "property2": {}
                },
                "oauthUrl": "string",
                "oAuthCache": "string",
                "oAuthCacheCreationDate": "2019-08-24T14:15:22Z",
                "openIdToken": "string",
                "openIdRefreshToken": "string",
                "openIdAccessToken": "string",
                "openIdExpiration": "2019-08-24T14:15:22Z"
              },
              "otm": true,
              "fields": [
                {
                  "fields": [],
                  "filters": [],
                  "options": []
                }
              ],
              "filters": [
                {
                  "filters": []
                }
              ],
              "template": true
            }
          ],
          "enabled": true,
          "lastHandled": "2019-08-24T14:15:22Z",
          "integration": [
            {
              "nonce": "string",
              "author": {
                "nonce": "string",
                "hasAgreedToPrice": true,
                "type": "user",
                "username": "string",
                "firstName": "string",
                "lastName": "string",
                "email": "string",
                "phone": "string",
                "passwordModified": "2019-08-24T14:15:22Z",
                "twoFactorAuthentication": true,
                "status": "DELETED",
                "loginMethod": "DEFAULT",
                "accountType": "default",
                "standardLoadingSize": 10,
                "timezone": "string",
                "vehicleGroups": [
                  null
                ]
              },
              "name": "string",
              "text": "string"
            }
          ],
          "triggerType": "trigger",
          "triggerEvent": "afterCreatingTrip",
          "filters": [
            {
              "selector": "string",
              "comparisonType": "equal",
              "value": "string",
              "linkType": "and",
              "filters": [
                {}
              ],
              "sequenceNr": 0
            }
          ]
        },
        "messageAutomation": {
          "nonce": "string",
          "name": "string",
          "description": "string",
          "automationConfig": {
            "triggerType": "trigger",
            "triggerEvent": "afterCreatingTrip",
            "schedule": {
              "integrationSchedulerScheduleValue": 0,
              "integrationSchedulerScheduleType": "seconds",
              "milliseconds": 0
            },
            "filters": [
              {
                "selector": "string",
                "comparisonType": "equal",
                "value": "string",
                "linkType": "and",
                "filters": [
                  null
                ],
                "sequenceNr": 0
              }
            ],
            "query": {
              "nonce": "string",
              "fields": [
                {}
              ],
              "entityType": "action",
              "joins": [
                {}
              ],
              "filters": [
                {}
              ],
              "groupBy": [
                {}
              ],
              "having": {
                "name": "string",
                "groupByAggregate": "count"
              },
              "sortFields": [
                {}
              ],
              "sortDirection": "asc",
              "limit": 0,
              "offset": 0
            },
            "recipients": [
              "string"
            ],
            "recipientSelector": "string",
            "toggleForAll": true,
            "channel": "email",
            "manualIntegration": {
              "nonce": "string",
              "type": "manual",
              "name": "string",
              "description": "string",
              "schedule": {
                "integrationSchedulerScheduleValue": 0,
                "integrationSchedulerScheduleType": "seconds",
                "milliseconds": 0
              },
              "dataSources": [
                {
                  "parameters": [],
                  "allowedIps": [],
                  "fields": [],
                  "filters": []
                }
              ],
              "enabled": true,
              "lastHandled": "2019-08-24T14:15:22Z",
              "sectorType": "boardComputer",
              "manualType": "transics",
              "enabledFunctions": [
                "string"
              ],
              "url": "string",
              "port": 0,
              "credentials": {
                "nonce": "string",
                "authenticationMethod": "apiKey",
                "username": "string",
                "password": "string",
                "accessKey": "string",
                "secretKey": "string",
                "clientId": "string",
                "clientSecret": "string",
                "grantType": "string",
                "scope": "string",
                "apiKey": "string",
                "bearer": "string",
                "sshKey": {},
                "sshTunnel": true,
                "sshHost": "string",
                "sshUsername": "string",
                "sshPassword": "string",
                "externalAttributes": {
                  "property1": {},
                  "property2": {}
                },
                "headers": {
                  "property1": {},
                  "property2": {}
                },
                "oauthUrl": "string",
                "oAuthCache": "string",
                "oAuthCacheCreationDate": "2019-08-24T14:15:22Z",
                "openIdToken": "string",
                "openIdRefreshToken": "string",
                "openIdAccessToken": "string",
                "openIdExpiration": "2019-08-24T14:15:22Z"
              },
              "filters": [
                {
                  "filters": []
                }
              ],
              "integration": [
                {}
              ]
            },
            "includeAttachments": true,
            "subject": "string",
            "currentTriggerPosition": 0,
            "localizedTexts": [
              {
                "language": {},
                "content": "string",
                "messageTemplate": "string",
                "subject": "string"
              }
            ],
            "defaultLanguageId": "string",
            "languageSelector": "string"
          },
          "enabled": true,
          "lastHandled": "2019-08-24T14:15:22Z",
          "template": true,
          "templateCategory": "string",
          "type": "messageAutomation",
          "notes": [
            {
              "nonce": "string",
              "author": {
                "nonce": "string",
                "hasAgreedToPrice": true,
                "type": "user",
                "username": "string",
                "firstName": "string",
                "lastName": "string",
                "email": "string",
                "phone": "string",
                "passwordModified": "2019-08-24T14:15:22Z",
                "twoFactorAuthentication": true,
                "status": "DELETED",
                "loginMethod": "DEFAULT",
                "accountType": "default",
                "standardLoadingSize": 10,
                "timezone": "string",
                "vehicleGroups": [
                  null
                ]
              },
              "name": "string",
              "text": "string"
            }
          ]
        },
        "consignments": [
          {
            "nonce": "string",
            "versionNumber": 0,
            "hasAgreedToPrice": true,
            "name": "string",
            "consignmentNr": "string",
            "description": "string",
            "status": "draft",
            "highValueGoods": true,
            "goods": [
              {
                "associationType": "inline"
              }
            ],
            "consignment": {},
            "originalPhysicalSender": {
              "nonce": "string",
              "type": "warehouse",
              "name": "string",
              "unCode": "string",
              "geoReference": {
                "nonce": "string",
                "type": "addressGeoReference",
                "hash": "string",
                "name": "string",
                "street": "string",
                "houseNumber": "string",
                "houseNumberAddition": "string",
                "postCode": "string",
                "city": "string",
                "country": "string"
              },
              "administrativeReference": {
                "name": "string",
                "street": "string",
                "houseNumber": "string",
                "houseNumberAddition": "string",
                "postalCode": "string",
                "city": "string",
                "country": "string"
              },
              "contactPersons": [
                {}
              ],
              "hash": "string",
              "externalAttributes": {
                "property1": {},
                "property2": {}
              },
              "attributes": [
                {}
              ],
              "remark": "string"
            },
            "originalLegalSender": {
              "nonce": "string",
              "type": "warehouse",
              "name": "string",
              "unCode": "string",
              "geoReference": {
                "nonce": "string",
                "type": "addressGeoReference",
                "hash": "string",
                "name": "string",
                "street": "string",
                "houseNumber": "string",
                "houseNumberAddition": "string",
                "postCode": "string",
                "city": "string",
                "country": "string"
              },
              "administrativeReference": {
                "name": "string",
                "street": "string",
                "houseNumber": "string",
                "houseNumberAddition": "string",
                "postalCode": "string",
                "city": "string",
                "country": "string"
              },
              "contactPersons": [
                {}
              ],
              "hash": "string",
              "externalAttributes": {
                "property1": {},
                "property2": {}
              },
              "attributes": [
                {}
              ],
              "remark": "string"
            },
            "originalPhysicalAddressee": {
              "nonce": "string",
              "type": "warehouse",
              "name": "string",
              "unCode": "string",
              "geoReference": {
                "nonce": "string",
                "type": "addressGeoReference",
                "hash": "string",
                "name": "string",
                "street": "string",
                "houseNumber": "string",
                "houseNumberAddition": "string",
                "postCode": "string",
                "city": "string",
                "country": "string"
              },
              "administrativeReference": {
                "name": "string",
                "street": "string",
                "houseNumber": "string",
                "houseNumberAddition": "string",
                "postalCode": "string",
                "city": "string",
                "country": "string"
              },
              "contactPersons": [
                {}
              ],
              "hash": "string",
              "externalAttributes": {
                "property1": {},
                "property2": {}
              },
              "attributes": [
                {}
              ],
              "remark": "string"
            },
            "originalLegalAddressee": {
              "nonce": "string",
              "type": "warehouse",
              "name": "string",
              "unCode": "string",
              "geoReference": {
                "nonce": "string",
                "type": "addressGeoReference",
                "hash": "string",
                "name": "string",
                "street": "string",
                "houseNumber": "string",
                "houseNumberAddition": "string",
                "postCode": "string",
                "city": "string",
                "country": "string"
              },
              "administrativeReference": {
                "name": "string",
                "street": "string",
                "houseNumber": "string",
                "houseNumberAddition": "string",
                "postalCode": "string",
                "city": "string",
                "country": "string"
              },
              "contactPersons": [
                {}
              ],
              "hash": "string",
              "externalAttributes": {
                "property1": {},
                "property2": {}
              },
              "attributes": [
                {}
              ],
              "remark": "string"
            },
            "isPlannedToLastLocation": true,
            "documents": [
              {
                "associationType": "inline"
              }
            ],
            "actors": [
              {
                "associationType": "inline"
              }
            ],
            "pricingElements": [
              {
                "nonce": "string",
                "name": "string",
                "description": "string",
                "category": {},
                "amount": {}
              }
            ],
            "externalAttributes": {
              "property1": {},
              "property2": {}
            },
            "expectedRevenue": {
              "nonce": "string",
              "amount": 0.1,
              "currency": {
                "nonce": "string",
                "name": "string",
                "short": "string",
                "sign": "string",
                "decimalDelimiter": "string",
                "thousandDelimiter": "string",
                "enabled": true
              },
              "taxRate": {
                "nonce": "string",
                "creditCode": "string",
                "debitCode": "string",
                "identifiers": [
                  null
                ],
                "name": "string",
                "description": "string",
                "jurisdiction": "string",
                "percentage": 0.1,
                "inclusive": true,
                "active": true
              },
              "inclusiveOfTax": true
            },
            "expectedCost": {
              "nonce": "string",
              "amount": 0.1,
              "currency": {
                "nonce": "string",
                "name": "string",
                "short": "string",
                "sign": "string",
                "decimalDelimiter": "string",
                "thousandDelimiter": "string",
                "enabled": true
              },
              "taxRate": {
                "nonce": "string",
                "creditCode": "string",
                "debitCode": "string",
                "identifiers": [
                  null
                ],
                "name": "string",
                "description": "string",
                "jurisdiction": "string",
                "percentage": 0.1,
                "inclusive": true,
                "active": true
              },
              "inclusiveOfTax": true
            },
            "combined": true,
            "type": "string",
            "remark": "string",
            "constraints": [
              {
                "nonce": "string",
                "name": "string",
                "enforceability": "enforced",
                "type": "accessConstraint",
                "description": "string"
              }
            ],
            "attributes": [
              {
                "nonce": "string",
                "name": "string",
                "color": "string"
              }
            ]
          }
        ],
        "purchasedUnits": 0,
        "capacity": {
          "nonce": "string",
          "name": "string",
          "description": "string",
          "business": {
            "id": "string",
            "nonce": "string",
            "uuid": "string",
            "primaryPlatformId": "string",
            "createdAt": "2019-08-24T14:15:22Z",
            "updatedAt": "2019-08-24T14:15:22Z",
            "name": "string",
            "relationType": "string",
            "alias": "string",
            "description": "string",
            "transportLicenseNumber": "string",
            "eori": "string",
            "scacCode": "string",
            "industry": {
              "id": "string",
              "nonce": "string",
              "uuid": "string",
              "primaryPlatformId": "string",
              "createdAt": "2019-08-24T14:15:22Z",
              "updatedAt": "2019-08-24T14:15:22Z",
              "name": "string",
              "abbreviated": "string",
              "enabled": true
            },
            "website": "string",
            "coc": "string",
            "vat": "string",
            "verified": true,
            "documents": [
              {
                "associationType": "inline",
                "entity": {
                  "externalAttributes": {}
                }
              }
            ],
            "logo": {
              "nonce": "string",
              "url": "string",
              "path": "string",
              "name": "string",
              "originalName": "string",
              "size": 0,
              "purpose": "string",
              "type": "IMAGE",
              "mimeType": "string",
              "extension": "string",
              "uploadedAt": "2019-08-24T14:15:22Z"
            },
            "banners": [
              {
                "id": "string",
                "nonce": "string",
                "uuid": "string",
                "primaryPlatformId": "string",
                "createdAt": "2019-08-24T14:15:22Z",
                "updatedAt": "2019-08-24T14:15:22Z",
                "url": "string",
                "path": "string",
                "name": "string",
                "originalName": "string",
                "size": 0,
                "purpose": "string",
                "type": "IMAGE",
                "mimeType": "string",
                "extension": "string",
                "uploadedAt": "2019-08-24T14:15:22Z"
              }
            ],
            "locations": [
              {
                "id": "string",
                "nonce": "string",
                "uuid": "string",
                "primaryPlatformId": "string",
                "createdAt": "2019-08-24T14:15:22Z",
                "updatedAt": "2019-08-24T14:15:22Z",
                "type": "warehouse",
                "name": "string",
                "unCode": "string",
                "geoReference": {},
                "administrativeReference": {},
                "contactDetails": [
                  null
                ],
                "constraints": [
                  null
                ],
                "pricingElements": [
                  null
                ],
                "remark": "string",
                "hash": "string",
                "externalAttributes": {
                  "property1": {},
                  "property2": {}
                }
              }
            ],
            "identification": [
              {
                "id": "string",
                "nonce": "string",
                "uuid": "string",
                "primaryPlatformId": "string",
                "createdAt": "2019-08-24T14:15:22Z",
                "updatedAt": "2019-08-24T14:15:22Z",
                "url": "string",
                "path": "string",
                "name": "string",
                "originalName": "string",
                "size": 0,
                "purpose": "string",
                "type": "IMAGE",
                "mimeType": "string",
                "extension": "string",
                "uploadedAt": "2019-08-24T14:15:22Z"
              }
            ],
            "contactDetails": [
              {
                "id": "string",
                "nonce": "string",
                "uuid": "string",
                "primaryPlatformId": "string",
                "createdAt": "2019-08-24T14:15:22Z",
                "updatedAt": "2019-08-24T14:15:22Z",
                "type": "iban",
                "value": "string",
                "remarks": "string"
              }
            ],
            "contactPersons": [
              {
                "id": "string",
                "nonce": "string",
                "uuid": "string",
                "primaryPlatformId": "string",
                "createdAt": "2019-08-24T14:15:22Z",
                "updatedAt": "2019-08-24T14:15:22Z",
                "firstName": "string",
                "lastName": "string",
                "position": "string",
                "email": "string",
                "phone": "string"
              }
            ],
            "administration": {
              "id": "string",
              "nonce": "string",
              "uuid": "string",
              "primaryPlatformId": "string",
              "createdAt": "2019-08-24T14:15:22Z",
              "updatedAt": "2019-08-24T14:15:22Z",
              "name": "string",
              "primary": true,
              "business": {},
              "currency": {
                "id": "string",
                "nonce": "string",
                "uuid": "string",
                "primaryPlatformId": "string",
                "createdAt": "2019-08-24T14:15:22Z",
                "updatedAt": "2019-08-24T14:15:22Z",
                "name": "string",
                "short": "string",
                "sign": "string",
                "decimalDelimiter": "string",
                "thousandDelimiter": "string",
                "enabled": true
              },
              "balance": {
                "id": "string",
                "nonce": "string",
                "uuid": "string",
                "primaryPlatformId": "string",
                "createdAt": "2019-08-24T14:15:22Z",
                "updatedAt": "2019-08-24T14:15:22Z",
                "amount": 0.1,
                "currency": {},
                "taxRate": {
                  "identifiers": []
                },
                "inclusiveOfTax": true
              },
              "numberFormat": "string",
              "numberLength": 0,
              "dueDays": 0,
              "invoiceNumberIndex": {
                "property1": 0,
                "property2": 0
              },
              "quoteNumberIndex": {
                "property1": 0,
                "property2": 0
              },
              "automaticallySendReminders": true,
              "invoiceTermsAndConditions": "string",
              "quoteTermsAndConditions": "string",
              "invoiceNumbering": 0,
              "quoteNumbering": 0
            },
            "pricingConfigurationCount": 0,
            "hasAgreedToPrice": true
          },
          "schedule": {
            "nonce": "string",
            "name": "string",
            "description": "string",
            "weekDays": [
              "sunday"
            ],
            "startDate": "2019-08-24T14:15:22Z",
            "endDate": "2019-08-24T14:15:22Z",
            "timeSlotTemplates": [
              {
                "nonce": "string",
                "capacityUnits": 0,
                "weekDay": "sunday",
                "startTime": "2019-08-24T14:15:22Z",
                "endTime": "2019-08-24T14:15:22Z",
                "pricingModules": [
                  null
                ]
              }
            ],
            "timeSlots": [
              {
                "nonce": "string",
                "date": "2019-08-24T14:15:22Z",
                "startTime": "2019-08-24T14:15:22Z",
                "endTime": "2019-08-24T14:15:22Z",
                "consignments": [
                  null
                ],
                "route": {
                  "expenses": [],
                  "additionalInfo": {},
                  "actors": [],
                  "actions": [],
                  "constraints": []
                }
              }
            ]
          },
          "modality": "maritime",
          "subType": "load",
          "capacityPerUnit": {
            "value": "string",
            "unit": "string"
          },
          "totalUnits": 0,
          "availableCapacity": {
            "value": "string",
            "unit": "string"
          },
          "totalCapacity": {
            "value": "string",
            "unit": "string"
          },
          "pricingModules": [
            {
              "nonce": "string",
              "type": "fixed",
              "name": "string",
              "sequenceNr": 0,
              "description": "string",
              "category": {
                "nonce": "string",
                "name": "string",
                "creditCode": "string",
                "debitCode": "string",
                "defaultValue": 0.1,
                "enabled": true
              },
              "taxRates": [
                {
                  "filters": []
                }
              ],
              "filters": [
                {
                  "filters": []
                }
              ],
              "oncePerInvoice": true
            }
          ]
        }
      },
      "name": "string",
      "description": "string",
      "vin": "string",
      "licensePlate": "string",
      "vehicleType": "string",
      "emissionStandard": "euro0",
      "fuelCapacity": {
        "value": "string",
        "unit": "string"
      },
      "fuelType": "string",
      "maxLinks": 0,
      "length": {
        "value": "string",
        "unit": "string"
      },
      "height": {
        "value": "string",
        "unit": "string"
      },
      "width": {
        "value": "string",
        "unit": "string"
      },
      "loadLength": {
        "value": "string",
        "unit": "string"
      },
      "loadHeight": {
        "value": "string",
        "unit": "string"
      },
      "loadWidth": {
        "value": "string",
        "unit": "string"
      },
      "maxWeight": {
        "value": "string",
        "unit": "string"
      },
      "emptyWeight": {
        "value": "string",
        "unit": "string"
      },
      "operational": true,
      "attributes": [
        {
          "nonce": "string",
          "name": "string",
          "color": "string"
        }
      ]
    },
    "geoReferences": [
      {
        "nonce": "string",
        "type": "addressGeoReference",
        "hash": "string",
        "name": "string",
        "street": "string",
        "houseNumber": "string",
        "houseNumberAddition": "string",
        "postCode": "string",
        "city": "string",
        "country": "string"
      }
    ],
    "constraints": [
      {
        "nonce": "string",
        "name": "string",
        "enforceability": "enforced",
        "type": "accessConstraint",
        "description": "string"
      }
    ]
  }'

Responses

Success

Bodyapplication/json
successboolean
messagestring
codeinteger(int32)
routeobject(RouteModel)
Response
application/json
{ "success": true, "message": "string", "code": 0, "route": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "time": 0, "cost": 0, "distance": 0, "expenses": [], "additionalInfo": {}, "lineString": "string", "actors": [], "actions": [], "constraints": [] } }

Update route

Request

Update a route

Headers
Authorizationstringrequired
Bodyapplication/jsonrequired
idstring
noncestring
uuidstring
primaryPlatformIdstring
createdAtstring(date-time)
updatedAtstring(date-time)
namestring
timeinteger(int32)
costinteger(int32)
distanceinteger(int32)
expensesArray of objects(RouteCostElementModel)
additionalInfoobject
lineStringstring
actorsArray of objects(ActorModel)
actionsArray of objects(ActionModel)
constraintsArray of objects(ConstraintAssociation)
curl -i -X PUT \
  https://docs.transportial.com/_mock/apis/route \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": "string",
    "nonce": "string",
    "uuid": "string",
    "primaryPlatformId": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "name": "string",
    "time": 0,
    "cost": 0,
    "distance": 0,
    "expenses": [
      {
        "id": "string",
        "nonce": "string",
        "uuid": "string",
        "primaryPlatformId": "string",
        "createdAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z",
        "name": "string",
        "description": "string",
        "money": {
          "id": "string",
          "nonce": "string",
          "uuid": "string",
          "primaryPlatformId": "string",
          "createdAt": "2019-08-24T14:15:22Z",
          "updatedAt": "2019-08-24T14:15:22Z",
          "amount": 0.1,
          "currency": {
            "id": "string",
            "nonce": "string",
            "uuid": "string",
            "primaryPlatformId": "string",
            "createdAt": "2019-08-24T14:15:22Z",
            "updatedAt": "2019-08-24T14:15:22Z",
            "name": "string",
            "short": "string",
            "sign": "string",
            "decimalDelimiter": "string",
            "thousandDelimiter": "string",
            "enabled": true
          },
          "taxRate": {
            "nonce": "string",
            "creditCode": "string",
            "debitCode": "string",
            "identifiers": [
              {
                "nonce": "string",
                "name": "string",
                "system": "string",
                "value": "string",
                "expiredAt": "2019-08-24T14:15:22Z"
              }
            ],
            "name": "string",
            "description": "string",
            "jurisdiction": "string",
            "percentage": 0.1,
            "inclusive": true,
            "active": true
          },
          "inclusiveOfTax": true
        }
      }
    ],
    "additionalInfo": {
      "property1": {},
      "property2": {}
    },
    "lineString": "string",
    "actors": [
      {
        "id": "string",
        "nonce": "string",
        "uuid": "string",
        "primaryPlatformId": "string",
        "createdAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z",
        "name": "string",
        "user": {
          "nonce": "string",
          "hasAgreedToPrice": true,
          "type": "user",
          "username": "string",
          "firstName": "string",
          "lastName": "string",
          "email": "string",
          "phone": "string",
          "passwordModified": "2019-08-24T14:15:22Z",
          "twoFactorAuthentication": true,
          "status": "DELETED",
          "loginMethod": "DEFAULT",
          "accountType": "default",
          "standardLoadingSize": 10,
          "timezone": "string",
          "vehicleGroups": [
            {
              "nonce": "string",
              "name": "string",
              "vehicles": [
                {
                  "loadCapacities": [],
                  "actors": [],
                  "attributes": []
                }
              ]
            }
          ]
        },
        "identifiers": [
          {
            "id": "string",
            "nonce": "string",
            "uuid": "string",
            "primaryPlatformId": "string",
            "createdAt": "2019-08-24T14:15:22Z",
            "updatedAt": "2019-08-24T14:15:22Z",
            "name": "string",
            "system": "string",
            "value": "string",
            "expiredAt": "2019-08-24T14:15:22Z"
          }
        ],
        "contactDetails": [
          {
            "id": "string",
            "nonce": "string",
            "uuid": "string",
            "primaryPlatformId": "string",
            "createdAt": "2019-08-24T14:15:22Z",
            "updatedAt": "2019-08-24T14:15:22Z",
            "type": "iban",
            "value": "string",
            "remarks": "string"
          }
        ]
      }
    ],
    "actions": [
      {
        "id": "string",
        "nonce": "string",
        "uuid": "string",
        "primaryPlatformId": "string",
        "createdAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z",
        "type": "load",
        "groupId": "string",
        "name": "string",
        "externalAttributes": {
          "property1": {},
          "property2": {}
        },
        "identifiers": [
          {
            "id": "string",
            "nonce": "string",
            "uuid": "string",
            "primaryPlatformId": "string",
            "createdAt": "2019-08-24T14:15:22Z",
            "updatedAt": "2019-08-24T14:15:22Z",
            "name": "string",
            "system": "string",
            "value": "string",
            "expiredAt": "2019-08-24T14:15:22Z"
          }
        ],
        "lifeCycle": "requested",
        "result": {
          "status": "succeeded",
          "remark": "string",
          "reason": "string"
        },
        "remark": "string",
        "sequenceNr": 0,
        "location": {
          "associationType": "inline",
          "entity": {
            "id": "string",
            "nonce": "string",
            "uuid": "string",
            "primaryPlatformId": "string",
            "createdAt": "2019-08-24T14:15:22Z",
            "updatedAt": "2019-08-24T14:15:22Z",
            "type": "warehouse",
            "name": "string",
            "unCode": "string",
            "geoReference": {
              "id": "string",
              "nonce": "string",
              "uuid": "string",
              "primaryPlatformId": "string",
              "createdAt": "2019-08-24T14:15:22Z",
              "updatedAt": "2019-08-24T14:15:22Z",
              "type": "addressGeoReference",
              "name": "string",
              "street": "string",
              "houseNumber": "string",
              "houseNumberAddition": "string",
              "postalCode": "string",
              "city": "string",
              "country": "string",
              "hash": "string"
            },
            "administrativeReference": {
              "name": "string",
              "street": "string",
              "houseNumber": "string",
              "houseNumberAddition": "string",
              "postalCode": "string",
              "city": "string",
              "country": "string"
            },
            "contactDetails": [
              {
                "id": "string",
                "nonce": "string",
                "uuid": "string",
                "primaryPlatformId": "string",
                "createdAt": "2019-08-24T14:15:22Z",
                "updatedAt": "2019-08-24T14:15:22Z",
                "type": "iban",
                "value": "string",
                "remarks": "string"
              }
            ],
            "constraints": [
              {
                "id": "string",
                "nonce": "string",
                "uuid": "string",
                "primaryPlatformId": "string",
                "createdAt": "2019-08-24T14:15:22Z",
                "updatedAt": "2019-08-24T14:15:22Z",
                "type": "accessConstraint",
                "name": "string",
                "enforceability": "enforced",
                "description": "string"
              }
            ],
            "pricingElements": [
              {
                "id": "string",
                "nonce": "string",
                "uuid": "string",
                "primaryPlatformId": "string",
                "createdAt": "2019-08-24T14:15:22Z",
                "updatedAt": "2019-08-24T14:15:22Z",
                "name": "string",
                "description": "string",
                "category": {},
                "amount": {}
              }
            ],
            "remark": "string",
            "hash": "string",
            "externalAttributes": {
              "property1": {},
              "property2": {}
            }
          },
          "description": "string"
        },
        "startTime": "2019-08-24T14:15:22Z",
        "endTime": "2019-08-24T14:15:22Z",
        "eta": "2019-08-24T14:15:22Z",
        "etd": "2019-08-24T14:15:22Z",
        "timeFormat": "string",
        "recurrence": "string",
        "duration": 0,
        "estimatedDuration": 0,
        "actions": [
          {
            "type": "inline",
            "associationType": "string",
            "entity": {
              "nonce": "string",
              "versionNumber": 0,
              "type": "load",
              "groupId": "string",
              "name": "string",
              "externalAttributes": {
                "property1": {},
                "property2": {}
              },
              "lifeCycle": "requested",
              "result": {
                "status": "succeeded",
                "remark": "string",
                "reason": "string"
              },
              "remark": "string",
              "sequenceNr": 0,
              "location": {
                "associationType": "inline",
                "entity": {
                  "contactDetails": [],
                  "constraints": [],
                  "pricingElements": [],
                  "externalAttributes": {}
                },
                "description": "string"
              },
              "startTime": "2019-08-24T14:15:22Z",
              "endTime": "2019-08-24T14:15:22Z",
              "eta": "2019-08-24T14:15:22Z",
              "etd": "2019-08-24T14:15:22Z",
              "timeFormat": "string",
              "recurrence": "string",
              "duration": 0,
              "estimatedDuration": 0,
              "actions": [
                {}
              ],
              "documents": [
                {}
              ],
              "identifiers": [
                {}
              ],
              "constraints": [
                {}
              ],
              "communicationRequests": [
                {
                  "communicationRequests": []
                }
              ],
              "isContainmentAction": true,
              "vehicle": {
                "associationType": "inline"
              },
              "pin": "string",
              "tar": "string",
              "shipmentLine": {
                "scacCode": "string",
                "smdgCode": "string"
              },
              "containmentUUID": "string"
            },
            "description": "string"
          }
        ],
        "communicationRequests": [
          {
            "id": "string",
            "nonce": "string",
            "uuid": "string",
            "primaryPlatformId": "string",
            "createdAt": "2019-08-24T14:15:22Z",
            "updatedAt": "2019-08-24T14:15:22Z",
            "name": "string",
            "description": "string",
            "status": "pending",
            "responseMessage": "string",
            "responseValue": "string"
          }
        ],
        "documents": [
          {
            "associationType": "inline"
          }
        ],
        "versionNumber": 0,
        "constraints": [
          {
            "associationType": "inline",
            "entity": {
              "nonce": "string",
              "name": "string",
              "enforceability": "enforced",
              "type": "accessConstraint",
              "description": "string"
            },
            "description": "string"
          }
        ],
        "isContainmentAction": true,
        "vehicle": {
          "associationType": "inline"
        },
        "stop": {
          "type": "inline",
          "associationType": "string",
          "entity": {
            "nonce": "string",
            "versionNumber": 0,
            "type": "load",
            "groupId": "string",
            "name": "string",
            "externalAttributes": {
              "property1": {},
              "property2": {}
            },
            "lifeCycle": "requested",
            "result": {
              "status": "succeeded",
              "remark": "string",
              "reason": "string"
            },
            "remark": "string",
            "sequenceNr": 0,
            "location": {
              "associationType": "inline",
              "entity": {
                "id": "string",
                "nonce": "string",
                "uuid": "string",
                "primaryPlatformId": "string",
                "createdAt": "2019-08-24T14:15:22Z",
                "updatedAt": "2019-08-24T14:15:22Z",
                "type": "warehouse",
                "name": "string",
                "unCode": "string",
                "geoReference": {},
                "administrativeReference": {},
                "contactDetails": [
                  null
                ],
                "constraints": [
                  null
                ],
                "pricingElements": [
                  null
                ],
                "remark": "string",
                "hash": "string",
                "externalAttributes": {
                  "property1": {},
                  "property2": {}
                }
              },
              "description": "string"
            },
            "startTime": "2019-08-24T14:15:22Z",
            "endTime": "2019-08-24T14:15:22Z",
            "eta": "2019-08-24T14:15:22Z",
            "etd": "2019-08-24T14:15:22Z",
            "timeFormat": "string",
            "recurrence": "string",
            "duration": 0,
            "estimatedDuration": 0,
            "actions": [
              {}
            ],
            "documents": [
              {
                "associationType": "inline"
              }
            ],
            "identifiers": [
              {
                "nonce": "string",
                "name": "string",
                "system": "string",
                "value": "string",
                "expiredAt": "2019-08-24T14:15:22Z"
              }
            ],
            "constraints": [
              {
                "associationType": "inline",
                "entity": {},
                "description": "string"
              }
            ],
            "communicationRequests": [
              {
                "nonce": "string",
                "name": "string",
                "description": "string",
                "status": "pending",
                "responseMessage": "string",
                "responseValue": "string",
                "communicationRequests": [
                  null
                ]
              }
            ],
            "isContainmentAction": true,
            "vehicle": {
              "associationType": "inline"
            },
            "pin": "string",
            "tar": "string",
            "shipmentLine": {
              "scacCode": "string",
              "smdgCode": "string"
            },
            "containmentUUID": "string"
          },
          "description": "string"
        },
        "pin": "string",
        "tar": "string",
        "shipmentLine": {
          "scacCode": "string",
          "smdgCode": "string"
        },
        "containmentUUID": "string"
      }
    ],
    "constraints": [
      {
        "associationType": "inline",
        "entity": {
          "nonce": "string",
          "name": "string",
          "enforceability": "enforced",
          "type": "accessConstraint",
          "description": "string"
        },
        "description": "string"
      }
    ]
  }'

Responses

Success

Bodyapplication/json
successboolean
messagestring
codeinteger(int32)
routeobject(RouteModel)
Response
application/json
{ "success": true, "message": "string", "code": 0, "route": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "time": 0, "cost": 0, "distance": 0, "expenses": [], "additionalInfo": {}, "lineString": "string", "actors": [], "actions": [], "constraints": [] } }

Create route

Request

Create a new route

Headers
Authorizationstringrequired
Bodyapplication/jsonrequired
noncestring
namestring
timeinteger(int32)
costinteger(int32)
distanceinteger(int32)
expensesArray of objects(RouteCostElementModel)
additionalInfoobject
lineStringstring
actorsArray of objects(ActorModel)
actionsArray of objects(ActionModel)
constraintsArray of objects(ConstraintAssociation)
curl -i -X POST \
  https://docs.transportial.com/_mock/apis/route \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "nonce": "string",
    "name": "string",
    "time": 0,
    "cost": 0,
    "distance": 0,
    "expenses": [
      {
        "id": "string",
        "nonce": "string",
        "uuid": "string",
        "primaryPlatformId": "string",
        "createdAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z",
        "name": "string",
        "description": "string",
        "money": {
          "id": "string",
          "nonce": "string",
          "uuid": "string",
          "primaryPlatformId": "string",
          "createdAt": "2019-08-24T14:15:22Z",
          "updatedAt": "2019-08-24T14:15:22Z",
          "amount": 0.1,
          "currency": {
            "id": "string",
            "nonce": "string",
            "uuid": "string",
            "primaryPlatformId": "string",
            "createdAt": "2019-08-24T14:15:22Z",
            "updatedAt": "2019-08-24T14:15:22Z",
            "name": "string",
            "short": "string",
            "sign": "string",
            "decimalDelimiter": "string",
            "thousandDelimiter": "string",
            "enabled": true
          },
          "taxRate": {
            "nonce": "string",
            "creditCode": "string",
            "debitCode": "string",
            "identifiers": [
              {
                "nonce": "string",
                "name": "string",
                "system": "string",
                "value": "string",
                "expiredAt": "2019-08-24T14:15:22Z"
              }
            ],
            "name": "string",
            "description": "string",
            "jurisdiction": "string",
            "percentage": 0.1,
            "inclusive": true,
            "active": true
          },
          "inclusiveOfTax": true
        }
      }
    ],
    "additionalInfo": {
      "property1": {},
      "property2": {}
    },
    "lineString": "string",
    "actors": [
      {
        "id": "string",
        "nonce": "string",
        "uuid": "string",
        "primaryPlatformId": "string",
        "createdAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z",
        "name": "string",
        "user": {
          "nonce": "string",
          "hasAgreedToPrice": true,
          "type": "user",
          "username": "string",
          "firstName": "string",
          "lastName": "string",
          "email": "string",
          "phone": "string",
          "passwordModified": "2019-08-24T14:15:22Z",
          "twoFactorAuthentication": true,
          "status": "DELETED",
          "loginMethod": "DEFAULT",
          "accountType": "default",
          "standardLoadingSize": 10,
          "timezone": "string",
          "vehicleGroups": [
            {
              "nonce": "string",
              "name": "string",
              "vehicles": [
                {
                  "loadCapacities": [],
                  "actors": [],
                  "attributes": []
                }
              ]
            }
          ]
        },
        "identifiers": [
          {
            "id": "string",
            "nonce": "string",
            "uuid": "string",
            "primaryPlatformId": "string",
            "createdAt": "2019-08-24T14:15:22Z",
            "updatedAt": "2019-08-24T14:15:22Z",
            "name": "string",
            "system": "string",
            "value": "string",
            "expiredAt": "2019-08-24T14:15:22Z"
          }
        ],
        "contactDetails": [
          {
            "id": "string",
            "nonce": "string",
            "uuid": "string",
            "primaryPlatformId": "string",
            "createdAt": "2019-08-24T14:15:22Z",
            "updatedAt": "2019-08-24T14:15:22Z",
            "type": "iban",
            "value": "string",
            "remarks": "string"
          }
        ]
      }
    ],
    "actions": [
      {
        "id": "string",
        "nonce": "string",
        "uuid": "string",
        "primaryPlatformId": "string",
        "createdAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z",
        "type": "load",
        "groupId": "string",
        "name": "string",
        "externalAttributes": {
          "property1": {},
          "property2": {}
        },
        "identifiers": [
          {
            "id": "string",
            "nonce": "string",
            "uuid": "string",
            "primaryPlatformId": "string",
            "createdAt": "2019-08-24T14:15:22Z",
            "updatedAt": "2019-08-24T14:15:22Z",
            "name": "string",
            "system": "string",
            "value": "string",
            "expiredAt": "2019-08-24T14:15:22Z"
          }
        ],
        "lifeCycle": "requested",
        "result": {
          "status": "succeeded",
          "remark": "string",
          "reason": "string"
        },
        "remark": "string",
        "sequenceNr": 0,
        "location": {
          "associationType": "inline",
          "entity": {
            "id": "string",
            "nonce": "string",
            "uuid": "string",
            "primaryPlatformId": "string",
            "createdAt": "2019-08-24T14:15:22Z",
            "updatedAt": "2019-08-24T14:15:22Z",
            "type": "warehouse",
            "name": "string",
            "unCode": "string",
            "geoReference": {
              "id": "string",
              "nonce": "string",
              "uuid": "string",
              "primaryPlatformId": "string",
              "createdAt": "2019-08-24T14:15:22Z",
              "updatedAt": "2019-08-24T14:15:22Z",
              "type": "addressGeoReference",
              "name": "string",
              "street": "string",
              "houseNumber": "string",
              "houseNumberAddition": "string",
              "postalCode": "string",
              "city": "string",
              "country": "string",
              "hash": "string"
            },
            "administrativeReference": {
              "name": "string",
              "street": "string",
              "houseNumber": "string",
              "houseNumberAddition": "string",
              "postalCode": "string",
              "city": "string",
              "country": "string"
            },
            "contactDetails": [
              {
                "id": "string",
                "nonce": "string",
                "uuid": "string",
                "primaryPlatformId": "string",
                "createdAt": "2019-08-24T14:15:22Z",
                "updatedAt": "2019-08-24T14:15:22Z",
                "type": "iban",
                "value": "string",
                "remarks": "string"
              }
            ],
            "constraints": [
              {
                "id": "string",
                "nonce": "string",
                "uuid": "string",
                "primaryPlatformId": "string",
                "createdAt": "2019-08-24T14:15:22Z",
                "updatedAt": "2019-08-24T14:15:22Z",
                "type": "accessConstraint",
                "name": "string",
                "enforceability": "enforced",
                "description": "string"
              }
            ],
            "pricingElements": [
              {
                "id": "string",
                "nonce": "string",
                "uuid": "string",
                "primaryPlatformId": "string",
                "createdAt": "2019-08-24T14:15:22Z",
                "updatedAt": "2019-08-24T14:15:22Z",
                "name": "string",
                "description": "string",
                "category": {},
                "amount": {}
              }
            ],
            "remark": "string",
            "hash": "string",
            "externalAttributes": {
              "property1": {},
              "property2": {}
            }
          },
          "description": "string"
        },
        "startTime": "2019-08-24T14:15:22Z",
        "endTime": "2019-08-24T14:15:22Z",
        "eta": "2019-08-24T14:15:22Z",
        "etd": "2019-08-24T14:15:22Z",
        "timeFormat": "string",
        "recurrence": "string",
        "duration": 0,
        "estimatedDuration": 0,
        "actions": [
          {
            "type": "inline",
            "associationType": "string",
            "entity": {
              "nonce": "string",
              "versionNumber": 0,
              "type": "load",
              "groupId": "string",
              "name": "string",
              "externalAttributes": {
                "property1": {},
                "property2": {}
              },
              "lifeCycle": "requested",
              "result": {
                "status": "succeeded",
                "remark": "string",
                "reason": "string"
              },
              "remark": "string",
              "sequenceNr": 0,
              "location": {
                "associationType": "inline",
                "entity": {
                  "contactDetails": [],
                  "constraints": [],
                  "pricingElements": [],
                  "externalAttributes": {}
                },
                "description": "string"
              },
              "startTime": "2019-08-24T14:15:22Z",
              "endTime": "2019-08-24T14:15:22Z",
              "eta": "2019-08-24T14:15:22Z",
              "etd": "2019-08-24T14:15:22Z",
              "timeFormat": "string",
              "recurrence": "string",
              "duration": 0,
              "estimatedDuration": 0,
              "actions": [
                {}
              ],
              "documents": [
                {}
              ],
              "identifiers": [
                {}
              ],
              "constraints": [
                {}
              ],
              "communicationRequests": [
                {
                  "communicationRequests": []
                }
              ],
              "isContainmentAction": true,
              "vehicle": {
                "associationType": "inline"
              },
              "pin": "string",
              "tar": "string",
              "shipmentLine": {
                "scacCode": "string",
                "smdgCode": "string"
              },
              "containmentUUID": "string"
            },
            "description": "string"
          }
        ],
        "communicationRequests": [
          {
            "id": "string",
            "nonce": "string",
            "uuid": "string",
            "primaryPlatformId": "string",
            "createdAt": "2019-08-24T14:15:22Z",
            "updatedAt": "2019-08-24T14:15:22Z",
            "name": "string",
            "description": "string",
            "status": "pending",
            "responseMessage": "string",
            "responseValue": "string"
          }
        ],
        "documents": [
          {
            "associationType": "inline"
          }
        ],
        "versionNumber": 0,
        "constraints": [
          {
            "associationType": "inline",
            "entity": {
              "nonce": "string",
              "name": "string",
              "enforceability": "enforced",
              "type": "accessConstraint",
              "description": "string"
            },
            "description": "string"
          }
        ],
        "isContainmentAction": true,
        "vehicle": {
          "associationType": "inline"
        },
        "stop": {
          "type": "inline",
          "associationType": "string",
          "entity": {
            "nonce": "string",
            "versionNumber": 0,
            "type": "load",
            "groupId": "string",
            "name": "string",
            "externalAttributes": {
              "property1": {},
              "property2": {}
            },
            "lifeCycle": "requested",
            "result": {
              "status": "succeeded",
              "remark": "string",
              "reason": "string"
            },
            "remark": "string",
            "sequenceNr": 0,
            "location": {
              "associationType": "inline",
              "entity": {
                "id": "string",
                "nonce": "string",
                "uuid": "string",
                "primaryPlatformId": "string",
                "createdAt": "2019-08-24T14:15:22Z",
                "updatedAt": "2019-08-24T14:15:22Z",
                "type": "warehouse",
                "name": "string",
                "unCode": "string",
                "geoReference": {},
                "administrativeReference": {},
                "contactDetails": [
                  null
                ],
                "constraints": [
                  null
                ],
                "pricingElements": [
                  null
                ],
                "remark": "string",
                "hash": "string",
                "externalAttributes": {
                  "property1": {},
                  "property2": {}
                }
              },
              "description": "string"
            },
            "startTime": "2019-08-24T14:15:22Z",
            "endTime": "2019-08-24T14:15:22Z",
            "eta": "2019-08-24T14:15:22Z",
            "etd": "2019-08-24T14:15:22Z",
            "timeFormat": "string",
            "recurrence": "string",
            "duration": 0,
            "estimatedDuration": 0,
            "actions": [
              {}
            ],
            "documents": [
              {
                "associationType": "inline"
              }
            ],
            "identifiers": [
              {
                "nonce": "string",
                "name": "string",
                "system": "string",
                "value": "string",
                "expiredAt": "2019-08-24T14:15:22Z"
              }
            ],
            "constraints": [
              {
                "associationType": "inline",
                "entity": {},
                "description": "string"
              }
            ],
            "communicationRequests": [
              {
                "nonce": "string",
                "name": "string",
                "description": "string",
                "status": "pending",
                "responseMessage": "string",
                "responseValue": "string",
                "communicationRequests": [
                  null
                ]
              }
            ],
            "isContainmentAction": true,
            "vehicle": {
              "associationType": "inline"
            },
            "pin": "string",
            "tar": "string",
            "shipmentLine": {
              "scacCode": "string",
              "smdgCode": "string"
            },
            "containmentUUID": "string"
          },
          "description": "string"
        },
        "pin": "string",
        "tar": "string",
        "shipmentLine": {
          "scacCode": "string",
          "smdgCode": "string"
        },
        "containmentUUID": "string"
      }
    ],
    "constraints": [
      {
        "associationType": "inline",
        "entity": {
          "nonce": "string",
          "name": "string",
          "enforceability": "enforced",
          "type": "accessConstraint",
          "description": "string"
        },
        "description": "string"
      }
    ]
  }'

Responses

Success

Bodyapplication/json
successboolean
messagestring
codeinteger(int32)
routeobject(RouteModel)
Response
application/json
{ "success": true, "message": "string", "code": 0, "route": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "time": 0, "cost": 0, "distance": 0, "expenses": [], "additionalInfo": {}, "lineString": "string", "actors": [], "actions": [], "constraints": [] } }

Get route

Request

Get a route on id

Path
idstringrequired
Headers
Authorizationstringrequired
curl -i -X GET \
  'https://docs.transportial.com/_mock/apis/route/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json
successboolean
messagestring
codeinteger(int32)
routeobject(RouteModel)
Response
application/json
{ "success": true, "message": "string", "code": 0, "route": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "time": 0, "cost": 0, "distance": 0, "expenses": [], "additionalInfo": {}, "lineString": "string", "actors": [], "actions": [], "constraints": [] } }

Delete route

Request

Delete a route

Path
idstringrequired
Headers
Authorizationstringrequired
curl -i -X DELETE \
  'https://docs.transportial.com/_mock/apis/route/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json
successboolean
messagestring
codeinteger(int32)
routeobject(RouteModel)
Response
application/json
{ "success": true, "message": "string", "code": 0, "route": { "id": "string", "nonce": "string", "uuid": "string", "primaryPlatformId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "name": "string", "time": 0, "cost": 0, "distance": 0, "expenses": [], "additionalInfo": {}, "lineString": "string", "actors": [], "actions": [], "constraints": [] } }

Get routes

Request

Get list of routes

Path
offsetinteger(int64)required
amountinteger(int64)required
Headers
Authorizationstringrequired
curl -i -X GET \
  'https://docs.transportial.com/_mock/apis/routes/{offset}/{amount}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json
successboolean
messagestring
codeinteger(int32)
totalResultsinteger(int32)
routesArray of objects(RouteModel)
Response
application/json
{ "success": true, "message": "string", "code": 0, "totalResults": 0, "routes": [ {} ] }

Search routes

Request

Search list of routes based on query

Path
offsetinteger(int64)required
amountinteger(int64)required
Headers
Authorizationstringrequired
curl -i -X GET \
  'https://docs.transportial.com/_mock/apis/routes/search/{offset}/{amount}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json
successboolean
messagestring
codeinteger(int32)
totalResultsinteger(int32)
routesArray of objects(RouteModel)
Response
application/json
{ "success": true, "message": "string", "code": 0, "totalResults": 0, "routes": [ {} ] }

Routing

Everything routing: meaning the routes from A-B supporting multiple modalities

Operations

ScheduleRoute

A scheduleRoute is a device that is able to measure a quantity in a certain unit, such as measuring the speed in km/h.

Operations

Sensor

A sensor is a device that is able to measure a quantity in a certain unit, such as measuring the speed in km/h.

Operations

Support

Support tickets are there to diagnose issues in the software or help users if they have a question

Operations

Tachograph

Tachograph methods

Operations

Team

A Team is a group of Vehicle's. Groups can be used to reference a list of vehicles without having to select each individual one.

Operations

Tender

Tenders can be stacked and constrain different activities in their context

Operations

Terminal

Terminals

Operations

ToDoComment

Object describing a geographic toDoComment. A toDoComment can either be a point or an area.

Operations

TQL

TQL stands for "Transportial Query Language". It's used to be able to run any query from a given JSON request

Operations

TransportOrder

The TransportOrder is the top-level entity to model a group of related consignments that might be transported separately, but need to be administered together.

Operations

Trip

A Trip is an aggregate entity that combines various entities to model visiting various locations, potentially doing one or multiple actions on each location, such as loading or unloading consignments. It is optionally coupled to a Vehicle that is/was driving this trip.

Operations

Type

Types

Operations

User

Users related to the platform and all actions required

Operations

User roles

The permissions grouped by a "Role", that can be assigned to a user

Operations

Settings

The user settings for the system

Operations

BoardComputer

A Boardcomputer is a device that tracks properties of a Vehicle. Values received from a BoardComputer can be the current location, speed, temperatues etc.

Operations

Vehicle

A Vehicle is a means to transport consignments from one location to potentially multiple other locations. There are various types of vehicles, each with their own unique properties like size, dimensions, fuel type and means of transport (by air, on land, over sea).

Operations

VehicleGroup

A VehicleGroup is a group of Vehicle's. Groups can be used to reference a list of vehicles without having to select each individual one.

Operations

Widget

Widgets can be stacked and constrain different activities in their context

Operations