Contract

Request contract info by contract number

Takes a list of contract numbers and outputs the contract information for each, provided the user is authorized to access the information.

Security
Request
header Parameters
x-api-key
required
string

The API Key.

Request Body schema: application/json
object (ExternalBusinessRequestDto)
page
integer <int32>
Responses
200

List of contracts with found

post/v1/contracts/list
Request samples
application/json
{
  • "businessRequest": {
    },
  • "page": 0
}
Response samples
application/json
{
  • "contracts": [
    ],
  • "page": 0
}

Save a contract document

Saves the contract to the contract document archive.

Security
Request
path Parameters
contractId
required
string <uuid>

The ID of the contract.

header Parameters
x-api-key
required
string

The API Key.

Request Body schema: application/json
contractNumbers
Array of strings
requestId
string
Responses
200

contract document saved

post/v1/contracts/{contractId}/document
Request samples
application/json
{
  • "contractNumbers": [
    ],
  • "requestId": "string"
}
Response samples
application/json
{
  • "url": "string",
  • "extension": "string"
}

Retrieve contract performance report url

This request sends the contract ID as a parameter, and downloads the most recent report for the contract's performance.

Security
Request
path Parameters
contractId
required
string <uuid>

The ID of the contract.

header Parameters
x-api-key
required
string

The API Key.

Request Body schema: application/json
contractNumbers
Array of strings
requestId
string
Responses
200

Contract performance report url returned

post/v1/contracts/{contractId}/performance-reports/latest/download
Request samples
application/json
{
  • "contractNumbers": [
    ],
  • "requestId": "string"
}
Response samples
application/json
{
  • "url": "string"
}

Create a comment on a dispute

This request sends the contract ID and dispute ID parameters, and writes a comment on the listed dispute.

Security
Request
path Parameters
contractId
required
string <uuid>

The ID of the contract.

disputeId
required
string <uuid>
header Parameters
x-api-key
required
string

The API Key.

Request Body schema: application/json
comment
string
object (ExternalBusinessRequestDto)
Responses
200

Comment saved

post/v1/contracts/{contractId}/disputes/{disputeId}/comments
Request samples
application/json
{
  • "comment": "string",
  • "businessRequest": {
    }
}
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "disputeId": "57331f1d-cb7c-4df0-89e4-ba6ba8d5fd8f",
  • "submittedByBusinessId": "5ddcff70-8ced-40ab-bf39-c9469330fef9",
  • "submittedByBusinessName": "string",
  • "comment": "string",
  • "created": { }
}

Details of a dispute

Takes the contract ID and dispute ID as parameters and recalls the full information of the dispute that was raised on the contract.

Security
Request
path Parameters
contractId
required
string <uuid>

The ID of the contract.

disputeId
required
string <uuid>
header Parameters
x-api-key
required
string

The API Key.

Request Body schema: application/json
contractNumbers
Array of strings
requestId
string
Responses
200

dispute details returned

post/v1/contracts/{contractId}/disputes/{disputeId}
Request samples
application/json
{
  • "contractNumbers": [
    ],
  • "requestId": "string"
}
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "exceptionReference": "string",
  • "contractId": "dbf32426-cf38-4818-9c6e-3230d889fa51",
  • "contractNumber": "string",
  • "status": "string",
  • "disputeReason": "string",
  • "subReason": "string",
  • "eventDate": "2019-08-24",
  • "submittedByBusinessId": "5ddcff70-8ced-40ab-bf39-c9469330fef9",
  • "submitted": { },
  • "teuCount": { },
  • "vessel": "string",
  • "service": "string",
  • "bookingNumber": "string",
  • "placeOfReceipt": "string",
  • "placeOfDelivery": "string",
  • "voyage": "string",
  • "hidden": true,
  • "excused": true,
  • "excusedReason": "string",
  • "excusedSubReason": "string",
  • "penalties": [
    ],
  • "carrierBusiness": {
    },
  • "shipperBusiness": {
    },
  • "documents": [
    ],
  • "comments": [
    ]
}

Add dispute document

Saves a document to the dispute with the given contract ID and dispute ID.

Security
Request
path Parameters
contractId
required
string <uuid>

The ID of the contract.

disputeId
required
string <uuid>
header Parameters
x-api-key
required
string

The API Key.

Request Body schema: application/json
Array of objects (ExternalCreateDisputeDocumentRequestDto)
object (ExternalBusinessRequestDto)
Responses
200

Document Saved

post/v1/contracts/{contractId}/disputes/{disputeId}/documents
Request samples
application/json
{
  • "documents": [
    ],
  • "businessInfo": {
    }
}
Response samples
application/json
{
  • "documents": [
    ]
}

Archive dispute document

Once a document is no longer required for a dispute, this request is used to archive the document.

Security
Request
path Parameters
contractId
required
string <uuid>

The ID of the contract.

documentId
required
string <uuid>
header Parameters
x-api-key
required
string

The API Key.

Request Body schema: application/json
contractNumbers
Array of strings
requestId
string
Responses
200

OK

post/v1/contracts/{contractId}/documents/{documentId}/archive
Request samples
application/json
{
  • "contractNumbers": [
    ],
  • "requestId": "string"
}

Unarchive dispute document

Takes the contract ID and document ID parameters as arguements and moves an archived document out of the archive and into active status.

Security
Request
path Parameters
contractId
required
string <uuid>

The ID of the contract.

documentId
required
string <uuid>
header Parameters
x-api-key
required
string

The API Key.

Request Body schema: application/json
contractNumbers
Array of strings
requestId
string
Responses
200

Document unarchived

post/v1/contracts/{contractId}/documents/{documentId}/unarchive
Request samples
application/json
{
  • "contractNumbers": [
    ],
  • "requestId": "string"
}

Create contract dispute

Adds an dispute to the contract ID by passing through the relevant contract ID.

Security
Request
path Parameters
contractId
required
string <uuid>

The ID of the contract.

header Parameters
x-api-key
required
string

The API Key.

Request Body schema: application/json
contractId
string <uuid>
reason
string
subReason
string
eventDate
string <date>
description
string
teuCount
object (BigDecimal)
bookingNumber
string
placeOfReceipt
string
placeOfDelivery
string
vessel
string
service
string
Array of objects (ExternalCreateDisputeDocumentRequestDto)
voyage
string
Array of objects (ExternalExceptionPenaltyDto)
object (ExternalBusinessRequestDto)
Responses
200

dispute created

post/v1/contracts/{contractId}/disputes/create
Request samples
application/json
{
  • "contractId": "dbf32426-cf38-4818-9c6e-3230d889fa51",
  • "reason": "string",
  • "subReason": "string",
  • "eventDate": "2019-08-24",
  • "description": "string",
  • "teuCount": { },
  • "bookingNumber": "string",
  • "placeOfReceipt": "string",
  • "placeOfDelivery": "string",
  • "vessel": "string",
  • "service": "string",
  • "documents": [
    ],
  • "voyage": "string",
  • "penalties": [
    ],
  • "businessInfo": {
    }
}
Response samples
application/json
{
  • "disputeId": "57331f1d-cb7c-4df0-89e4-ba6ba8d5fd8f"
}

Statement details

Returns a list of all details (status, carrier, start date, end date, etc.) of the requested statement.

Security
Request
path Parameters
contractId
required
string <uuid>

The ID of the contract.

statementId
required
string <uuid>

The ID of the requested statement.

header Parameters
x-api-key
required
string

The API Key.

Request Body schema: application/json
contractNumbers
Array of strings
requestId
string
Responses
200

Statement details returned

post/v1/contracts/{contractId}/statements/{statementId}
Request samples
application/json
{
  • "contractNumbers": [
    ],
  • "requestId": "string"
}
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "reference": "string",
  • "status": "string",
  • "contractId": "dbf32426-cf38-4818-9c6e-3230d889fa51",
  • "contractNumber": "string",
  • "carrierBusinessId": "e6fefb5d-5ca8-48fc-96a1-c2e457128ae4",
  • "shipperBusinessId": "3a3008ed-02df-47a9-b693-ac9a87a9a643",
  • "startDate": "2019-08-24",
  • "endDate": "2019-08-24",
  • "additionalInformation": "string",
  • "exceptionsIds": [
    ],
  • "penaltyDefault": {
    },
  • "exceptions": [
    ],
  • "dateIssued": { }
}

Create comment on a statement

Creates a comment that is attached to the provided statement ID.

Security
Request
path Parameters
contractId
required
string <uuid>

The ID of the contract.

statementId
required
string <uuid>

The ID of the requested statement.

header Parameters
x-api-key
required
string

The API Key.

Request Body schema: application/json
comment
string
object (ExternalBusinessRequestDto)
Responses
200

Comment created on statement

post/v1/contracts/{contractId}/statements/{statementId}/comment
Request samples
application/json
{
  • "comment": "string",
  • "businessRequest": {
    }
}
Response samples
application/json
{
  • "comment": "string",
  • "businessId": "50092e54-cd12-4059-9828-e8c4ee9a3cf5",
  • "submittedByBusinessName": "string",
  • "created": { }
}

Statement comments list

This request returns a list of all comments on the provided statement ID.

Security
Request
path Parameters
contractId
required
string <uuid>

The ID of the contract.

statementId
required
string <uuid>

The ID of the requested statement.

header Parameters
x-api-key
required
string

The API Key.

Request Body schema: application/json
contractNumbers
Array of strings
requestId
string
Responses
200

Statement comments returned

post/v1/contracts/{contractId}/statements/{statementId}/comments
Request samples
application/json
{
  • "contractNumbers": [
    ],
  • "requestId": "string"
}
Response samples
application/json
{
  • "comments": [
    ]
}

Create statement attachment

Adds one or more attachments to the requested statement.

Security
Request
path Parameters
contractId
required
string <uuid>

The ID of the contract.

statementId
required
string <uuid>

The ID of the requested statement.

header Parameters
x-api-key
required
string

The API Key.

Request Body schema: application/json
Array of objects (ExternalCreateAttachmentDto)
object (ExternalBusinessRequestDto)
Responses
200

Attachment saved to statement

post/v1/contracts/{contractId}/statements/{statementId}/attachment
Request samples
application/json
{
  • "attachments": [
    ],
  • "businessRequest": {
    }
}
Response samples
application/json
{
  • "attachments": [
    ]
}

Statement attachments list

Returns a list of attachments that have been saved to the requested statement.

Security
Request
path Parameters
contractId
required
string <uuid>

The ID of the contract.

statementId
required
string <uuid>

The ID of the requested statement.

header Parameters
x-api-key
required
string

The API Key.

Request Body schema: application/json
contractNumbers
Array of strings
requestId
string
Responses
200

Statement attachments returned

post/v1/contracts/{contractId}/statements/{statementId}/attachments
Request samples
application/json
{
  • "contractNumbers": [
    ],
  • "requestId": "string"
}
Response samples
application/json
{
  • "attachments": [
    ]
}