DELTA H7 API 0.3.0

H7/Operators API

Servers

https://{URL_OPERATEUR_EDI}/dh7 http
URL_OPERATEUR_EDI: This value is the url of the operator.

Operations

Pub declarations/customsDeclarationReference/reponses

H7/operators interface for a Response_H7 message

Parameters
customsDeclarationReference
required
string

Accepts the following message:

Response_H7

Payload
object
header
required
object
messageDateTime
required
string
date-time must match [0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}[+,-][0-9]{2}:[0-9]{2}.+

AAAA-MM-DDThh:mm:ss[offset][ZoneID]

messageId
required
string
length <= 291
lrn
required
string
length <= 22
customsDeclarationReference
required
string
length <= 22
mrn
string
must match [0-9a-zA-Z]{18}

Filled only in case of acceptation of declaration (not filled for pre-lodged declaration)

Additional properties are NOT allowed.

declarationState
required
object
state
required
string
length <= 35
stateDateTime
required
string
date-time must match [0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}[+,-][0-9]{2}:[0-9]{2}.+

AAAA-MM-DDThh:mm:ss[offset][ZoneID]

event
required
string
length <= 260

Additional properties are NOT allowed.

dutiesAndTaxes
required
object
generalTaxation
required
object

Not filled if relief from taxation

guaranteedAmount
required
number
float must match ([0-9]{1,14}[.][0-9]{1,2})|([0-9]{1,15}[.][0-9])|([0-9]{1,16})

The amount of tax is rounded to the nearest euro

unguaranteedAmount
required
number
float must match ([0-9]{1,14}[.][0-9]{1,2})|([0-9]{1,15}[.][0-9])|([0-9]{1,16})

The amount of tax is rounded to the nearest euro

totalPayableTaxAmount
required
number
float must match ([0-9]{1,14}[.][0-9]{1,2})|([0-9]{1,15}[.][0-9])|([0-9]{1,16})

The amount of tax is rounded to the nearest euro

Additional properties are NOT allowed.

itemsTaxation
required
array<object>
<= 99 items

Items:

0
object
itemNumber
required
integer
int32 length <= 5
nationalTaxCode
string
must match .{4}

Not filled in case of tax exemption or IOSS

taxType
string
must match .{3}

Not filled in case of dock dues collection or tax exemption

taxBaseAmount
number
float must match ([0-9]{1,14}[.][0-9]{1,2})|([0-9]{1,15}[.][0-9])|([0-9]{1,16})

Not filled in case of tax exemption; The tax base amount is rounded to the nearest euro

taxRate
number
float must match ([0-9]{1,14}[.][0-9]{1,3})|([0-9]{1,15}[.][0-9]{1,2})|([0-9]{1,16}[.][0-9])|([0-9]{1,17})

Not filled in case of tax exemption or IOSS

payableTaxAmount
required
number
float must match ([0-9]{1,14}[.][0-9]{1,2})|([0-9]{1,15}[.][0-9])|([0-9]{1,16})

The amount of tax is rounded to the nearest euro

additionalProcedure
required
array<object>
<= 2 items

Items:

0
object
additionalProcedureCode
required
string
length <= 3

Additional procedure code C07 is added automatically for IOSS (F48) or Special arrangement (F49)

Additional properties are NOT allowed.

Additional items are allowed.

Additional properties are NOT allowed.

Additional items are allowed.

Additional properties are NOT allowed.

Additional properties are NOT allowed.

Examples

Response_H7
Payload
{
  "header": {
    "messageDateTime": "2020-06-12T05:36:30-05:00[US/Central]",
    "messageId": "b6c9f124-4a83-4003-bcc9-1bce1798c2ab1591712615",
    "lrn": "123456",
    "customsDeclarationReference": "2282319",
    "mrn": "15FR9876AB889012B5"
  },
  "declarationState": {
    "state": "VLD",
    "stateDateTime": "2020-06-12T05:36:30-05:00[US/Central]",
    "event": "Creation"
  },
  "dutiesAndTaxes": {
    "generalTaxation": {
      "guaranteedAmount": 0,
      "unguaranteedAmount": 32,
      "totalPayableTaxAmount": 32
    },
    "itemsTaxation": [
      {
        "itemNumber": 1,
        "nationalTaxCode": "A445",
        "taxType": "B00",
        "taxBaseAmount": 110,
        "taxRate": 20,
        "payableTaxAmount": 22,
        "additionalProcedure": [
          {
            "additionalProcedureCode": "C07"
          }
        ]
      }
    ]
  }
}
This example has been generated automatically.

Messages

#1 Response_H7

Payload
object
header
required
object
messageDateTime
required
string
date-time must match [0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}[+,-][0-9]{2}:[0-9]{2}.+

AAAA-MM-DDThh:mm:ss[offset][ZoneID]

messageId
required
string
length <= 291
lrn
required
string
length <= 22
customsDeclarationReference
required
string
length <= 22
mrn
string
must match [0-9a-zA-Z]{18}

Filled only in case of acceptation of declaration (not filled for pre-lodged declaration)

Additional properties are NOT allowed.

declarationState
required
object
state
required
string
length <= 35
stateDateTime
required
string
date-time must match [0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}[+,-][0-9]{2}:[0-9]{2}.+

AAAA-MM-DDThh:mm:ss[offset][ZoneID]

event
required
string
length <= 260

Additional properties are NOT allowed.

dutiesAndTaxes
required
object
generalTaxation
required
object

Not filled if relief from taxation

guaranteedAmount
required
number
float must match ([0-9]{1,14}[.][0-9]{1,2})|([0-9]{1,15}[.][0-9])|([0-9]{1,16})

The amount of tax is rounded to the nearest euro

unguaranteedAmount
required
number
float must match ([0-9]{1,14}[.][0-9]{1,2})|([0-9]{1,15}[.][0-9])|([0-9]{1,16})

The amount of tax is rounded to the nearest euro

totalPayableTaxAmount
required
number
float must match ([0-9]{1,14}[.][0-9]{1,2})|([0-9]{1,15}[.][0-9])|([0-9]{1,16})

The amount of tax is rounded to the nearest euro

Additional properties are NOT allowed.

itemsTaxation
required
array<object>
<= 99 items

Items:

0
object
itemNumber
required
integer
int32 length <= 5
nationalTaxCode
string
must match .{4}

Not filled in case of tax exemption or IOSS

taxType
string
must match .{3}

Not filled in case of dock dues collection or tax exemption

taxBaseAmount
number
float must match ([0-9]{1,14}[.][0-9]{1,2})|([0-9]{1,15}[.][0-9])|([0-9]{1,16})

Not filled in case of tax exemption; The tax base amount is rounded to the nearest euro

taxRate
number
float must match ([0-9]{1,14}[.][0-9]{1,3})|([0-9]{1,15}[.][0-9]{1,2})|([0-9]{1,16}[.][0-9])|([0-9]{1,17})

Not filled in case of tax exemption or IOSS

payableTaxAmount
required
number
float must match ([0-9]{1,14}[.][0-9]{1,2})|([0-9]{1,15}[.][0-9])|([0-9]{1,16})

The amount of tax is rounded to the nearest euro

additionalProcedure
required
array<object>
<= 2 items

Items:

0
object
additionalProcedureCode
required
string
length <= 3

Additional procedure code C07 is added automatically for IOSS (F48) or Special arrangement (F49)

Additional properties are NOT allowed.

Additional items are allowed.

Additional properties are NOT allowed.

Additional items are allowed.

Additional properties are NOT allowed.

Additional properties are NOT allowed.