1. Reference information
  2. Notification events
  3. DeclarationPdfCreated event data

DeclarationPdfCreated event data

The declaration pdf created model is an object with following fields:

Property Cardinality Type Description
id 1x string A unique key that identifies the event
tenantId 1x string Tenant Id of the tenant for which this event applies.
plantId 1x string Plant Id of the tenant for which this event applies.
eventTime 1x timestamp The exact time in UTC that the event occurred in CAS.
eventType 1x string Type of the event. DeclarationPdfCreated for this event.
eventSubType 1x string Subtype of the event. A list of possible event subtypes for this event can be found here.
data.id 1x string Identification of the declaration.
data.customsShipmentReference 1x string The customs shipment external reference
data.jurisdiction 1x string Two letter Country ISO code indicating the jurisdiction of the declaration.
data.traderReference 1x string The UCR/TraderReference of a declaration
data.customsFlow 1x string The name of the customs flow as defined in the configuration
data.customsFlowStep 1x string The name of the customs flow step as defined in the configuration
data.customsFlowStepInstanceCount 1x int The number of instances in the same customs flow for the given customsFlowStep
data.customsFlowStepInstanceSeq 1x int The sequence number of the instance in the same customs flow for the given customsFlowStep
data.mrn 1x string The MRN of a declaration, as provided by the customs system.
data.lrn 1x string The LRN of a declaration. This LRN is created by the CAS declaration module.
data.declarationUrl 1x string If available, this field contains a link to the declaration details in the CAS generic format (see Declaration).
data.url 1x string Tokenized URL to download the PDF related to the shipment.
data.type 1x string Type of the PDF related to the shipment
data.storageLocation 1x string The storage location reference
data.plant 1x string The plant reference
data.company 1x string The company reference

Remarks

The URL to the PDF included in the notification will trigger a redirect (HTTP 307) when followed to the actual location of the PDF using a secured temporary URL (as described here). To be able to download this PDF in an automated fashion, your HTTP client has to be configured to automatically follow redirects (or do this manually).

If the redirect behaviour is not desired or supported by your HTTP client, the secured temporary URL can also be requested without a redirect by using the following endpoint, which URL can be constructed by suffixing the URL in the notification with /url.

Example

{
    "id": "434513a3-0305-4639-baf6-c85235b965b3",
    "tenantId": "yourTenantId",
    "plantId": "yourPlantId",
    "eventTime": "2017-06-26T18:41:00.9584103Z",
    "eventType": "DeclarationPdfCreated",
    "eventSubType": "EAD",
    "data": {
        "id": "123456789",
        "customsShipmentReference": "FQB1XH5TPU",
        "jurisdiction": "BE",
        "traderReference": "HYRRMAWYRH",
        "customsFlow": "9NZ4Z6XWG9ERW6KSYK4O",
        "customsFlowStep": "G0L2U0VZ1K86S5XRC09G",
        "customsFlowStepInstanceCount": 2,
        "customsFlowStepInstanceSeq": 1,
        "mrn": "59BEE0000008465153",
        "lrn": "LRN0001222",
        "declarationUrl": "https://cas-declaration-api.customs4trade.com/v1/{tenantId}/declarations/{declarationId}",
        "url": "https://cas-declaration-api.customs4trade.com/v1/{tenantId}/declarations/{declarationId}/attachments/{documentType}/{attachmentId}",
        "type": "EAD",
        "storageLocation": "SL_01",
        "plant": "P_01",
        "company": "C_01"
    }
}
← Previous Page Next Page →