DELTA H7 API 0.0.1

DGDDI

Operators/H7 API

Servers

https://edi.douane.gouv.fr/dh7 http

Operations

Pub /declarations/creer

Operators/H7 interface for a Creation_H7 message

Accepts the following message:

Payload

object

header

required

object

messageDateTime

required

date

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

UUID + timestamp

lrn

required

string

length <= 22

Additional properties are NOT allowed.

declaration

required

object

genericInformation

required

object

declarationType

required

string

must match [a-zA-Z]{2}

IM or CO

additionalDeclarationType

required

string

must match [a-zA-Z]

A or D

provisionalValidationDate

string

must match [0-9]{8}

Required for anticipated declaration, otherwise do not fill

provisionalValidationTime

string

must match [0-9]{2}:[0-9]{2}

Required for anticipated declaration, otherwise do not fill

Additional properties are NOT allowed.

clearanceAgreement

required

object

clearanceAgreementNumber

required

string

length <= 8

Additional properties are NOT allowed.

declarationOffice

required

object

declarationOfficeReference

required

string

length <= 8

Additional properties are NOT allowed.

presentationOffice

required

object

presentationOfficeReference

required

string

length <= 8

Additional properties are NOT allowed.

importer

required

object

importerName

string

length <= 70

importerId

string

length <= 17

If empty, then name and address are required

importerAddress

object

importerStreet

required

string

length <= 70

importerCountry

required

string

must match [a-zA-Z]{2}

importerPostcode

required

string

length <= 17

importerCity

required

string

length <= 35

Additional properties are NOT allowed.

declarant

required

object

declarantName

string

length <= 70

declarantId

required

string

length <= 17

declarantAddress

object

declarantStreet

required

string

length <= 70

declarantCountry

required

string

must match [a-zA-Z]{2}

declarantPostcode

required

string

length <= 17

declarantCity

required

string

length <= 35

Additional properties are NOT allowed.

declarantContactPerson

object

declarantContactName

string

length <= 70

declarantContactPhone

string

length <= 35

declarantContactEmail

string

length <= 256

Additional properties are NOT allowed.

representative

required

object

representativeId

required

string

length <= 17

representativeStatus

required

string

must match [1-3]

1, 2 or 3

representativeContactPerson

object

representativeContactName

string

length <= 70

representativeContactPhone

string

length <= 35

representativeContactEmail

string

length <= 256

Additional properties are NOT allowed.

authorisations

array<object>

Items:

object

authorisationType

required

string

length <= 4

May be filled with the AEO certification

authorisationReference

required

string

length <= 35

May be filled with the AEO certification reference

authorisationHolder

required

string

length <= 17

Fill with EORI number of the holder of the authorisation

Additional properties are NOT allowed.

Additional items are allowed.

credit

object

If IOSS, do not fill

creditNumber

required

string

length <= 4

Additional properties are NOT allowed.

goodsShipment

required

object

locationOfGoods

required

object

goodsLocality

required

string

length <= 20

madtAgreement

required

string

length <= 8

Additional properties are NOT allowed.

goodsMeasurement

required

object

grossMass

required

number

length <= 17

Additional properties are NOT allowed.

exporter

object

To be used on the general segment if the exporter is identical for all items

exporterName

required

string

length <= 70

exporterAddress

required

object

exporterStreet

required

string

length <= 70

exporterCountry

required

string

must match [a-zA-Z]{2}

exporterPostcode

required

string

length <= 17

exporterCity

required

string

length <= 35

Additional properties are NOT allowed.

previousDocuments

array<object>

Items:

object

previousDocumentReference

required

string

length <= 70

Fill this tag with ENS or transit MRN for example

previousDocumentType

required

string

must match [0-9a-zA-Z]{2,3,4}

Fill with previous document type

Additional properties are NOT allowed.

Additional items are allowed.

supportingDocuments

array<object>

Items:

object

supportingDocumentReference

required

string

length <= 70

Fill with supporting documents

supportingDocumentType

required

string

must match .{4}

Fill with supporting documents type

Additional properties are NOT allowed.

Additional items are allowed.

additionalReferences

array<object>

Items:

object

additionalReferenceNumber

required

string

length <= 70

May be filled with any additional declarations made which is not covered by supporting document, transport document or additional information

additionalReferenceType

required

string

must match .{4}

May be filled with any additional declarations made which is not covered by supporting document, transport document or additional information

Additional properties are NOT allowed.

Additional items are allowed.

transportDocuments

array<object>

To be filled on the general segment if the transport document is identical for all items

Items:

object

transportDocumentReference

required

string

length <= 70

Fill with air waybill or other transport documents

transportDocumentType

required

string

must match .{4}

Fill with air waybill or other transport documents

Additional properties are NOT allowed.

Additional items are allowed.

ucr

object

To be used on general segment if the UCRs are identical for all items

ucrReference

string

length <= 35

Fill this tag with transaction references in case of IOSS

Additional properties are NOT allowed.

additionalFiscalReference

object

To be used on general segment if IOSS

roleCode

required

string

must match .{3}

Fill with FR5 on general segment

vatId

required

string

length <= 17

Fill with IOSS number on general segment

Additional properties are NOT allowed.

governmentAgencyGoodsItems

required

array<object>

Items:

object

itemNumber

required

integer

length <= 5

exporter

object

To be used on item level if there are different exporters for different items

exporterName

required

string

length <= 70

exporterAddress

object

exporterStreet

required

string

length <= 70

exporterCountry

required

string

must match [a-zA-Z]{2}

exporterPostcode

required

string

length <= 17

exporterCity

required

string

length <= 35

Additional properties are NOT allowed.

additionalInformation

array<object>

Items:

object

code

required

string

must match .{5}

text

string

length <= 512

Additional properties are NOT allowed.

Additional items are allowed.

supportingDocuments

array<object>

Items:

object

supportingDocumentReference

required

string

length <= 70

Fill with supporting documents

supportingDocumentType

required

string

must match .{4}

Fill with supporting documents type

Additional properties are NOT allowed.

Additional items are allowed.

additionalReferences

array<object>

Items:

object

additionalReferenceNumber

required

string

length <= 70

May be filled with any additional declarations made which is not covered by supporting document, transport document or additional information

additionalReferenceType

required

string

must match .{4}

May be filled with any additional declarations made which is not covered by supporting document, transport document or additional information

Additional properties are NOT allowed.

Additional items are allowed.

transportDocuments

array<object>

To be used on item level if there are different transport documents for different items

Items:

object

transportDocumentReference

required

string

length <= 70

Fill with air waybill or other transport documents

transportDocumentType

required

string

must match .{4}

Fill with air waybill or other transport documents

Additional properties are NOT allowed.

Additional items are allowed.

ucr

object

To be used on item level if there are different UCRs for different items

ucrReference

string

length <= 35

Fill this tag with transaction references in case of IOSS

Additional properties are NOT allowed.

additionalFiscalReferences

array<object>

To be used on general segment if IOSS

Items:

object

roleCode

required

string

must match .{3}

FR1, FR2, FR3, FR4, FR7. If IOSS, then serve FR5 and IOSS number on general segment

vatId

required

string

length <= 17

FR3 + n°TVA operepfisc or FRX + VAT number

Additional properties are NOT allowed.

Additional items are allowed.

procedure

required

object

additionalProcedure

required

object

additionalProcedureCode

required

string

length <= 3

C07, C08, F48 or F49

Additional properties are NOT allowed.

packaging

required

object

numberOfPackages

required

integer

must match [0-9]{1,8}

Additional properties are NOT allowed.

commodity

required

object

descriptionOfGoods

required

string

length <= 512

commodityCode

required

object

nomenclatureCode

required

string

must match [0-9]{1,10}

For H7 : at least SH6 required, NC8 or Taric10 should be filled for reduced VAT

reducedVat

integer

must match [0-1]

Filled for reduced VAT (with C07 only), 1 : Apply for reduced VAT, 0 : Otherwise

nationalAdditionalCodes

array<object>

Items:

object

cana

required

string

length <= 4

Additional properties are NOT allowed.

Additional items are allowed.

taxBase

required

object

value

required

object

currency

required

string

must match [a-zA-Z]{3}

amount

required

number

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

Additional properties are NOT allowed.

transportCost

object

currency

string

must match [a-zA-Z]{3}

amount

number

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

Additional properties are NOT allowed.

goodsMeasurement

object

grossMass

required

number

length <= 17

supplementaryUnitsNumber

number

length <= 17

supplementaryUnitsCode

string

length <= 3

supplementaryUnitsType

string

must match [a-zA-Z0-9]

Additional properties are NOT allowed.

Additional items are allowed.

Additional properties are NOT allowed.

Headers

object

Additional properties are NOT allowed.

Examples

Payload Headers

{
  "header": {
    "messageDateTime": "2020-06-12T05:36:30-05:00[US/Central]",
    "messageId": "b6c9f124-4a83-4003-bcc9-1bce1798c2ab1591712615",
    "lrn": "123456"
  },
  "declaration": {
    "genericInformation": {
      "declarationType": "IM",
      "additionalDeclarationType": "A",
      "provisionalValidationDate": "20200512",
      "provisionalValidationTime": "12:12"
    },
    "clearanceAgreement": {
      "clearanceAgreementNumber": "MADT"
    },
    "declarationOffice": {
      "declarationOfficeReference": "FR000600"
    },
    "presentationOffice": {
      "presentationOfficeReference": "FR000600"
    },
    "importer": {
      "importerName": "Jean Martin",
      "importerId": "FR97350535701687",
      "importerAddress": {
        "importerStreet": "36 Rue Louis Blanc",
        "importerCountry": "FR",
        "importerPostcode": "44200",
        "importerCity": "Nantes"
      }
    },
    "declarant": {
      "declarantName": "Jean Martin",
      "declarantId": "FR97350535701687",
      "declarantAddress": {
        "declarantStreet": "36 Rue Louis Blanc",
        "declarantCountry": "FR",
        "declarantPostcode": "44200",
        "declarantCity": "Nantes"
      },
      "declarantContactPerson": {
        "declarantContactName": "Jean Martin",
        "declarantContactPhone": "+33212273262",
        "declarantContactEmail": "representative@email.com"
      }
    },
    "representative": {
      "representativeId": "FR97350535701687",
      "representativeStatus": "1",
      "representativeContactPerson": {
        "representativeContactName": "Jean Martin",
        "representativeContactPhone": "+33212273262",
        "representativeContactEmail": "representative@email.com"
      }
    },
    "authorisations": [
      {
        "authorisationType": "",
        "authorisationReference": "",
        "authorisationHolder": "FR97350535701687"
      }
    ],
    "credit": {
      "creditNumber": "ARSC"
    }
  },
  "goodsShipment": {
    "locationOfGoods": {
      "goodsLocality": "Bordeaux",
      "madtAgreement": "00002674"
    },
    "goodsMeasurement": {
      "grossMass": 1234567890.123456
    },
    "exporter": {
      "exporterName": "John Smith",
      "exporterAddress": {
        "exporterStreet": "3603 Eight Mile Road",
        "exporterCountry": "US",
        "exporterPostcode": "48201",
        "exporterCity": "Detroit"
      }
    },
    "previousDocuments": [
      {
        "previousDocumentReference": "123456789012345678",
        "previousDocumentType": "MRN"
      }
    ],
    "supportingDocuments": [
      {
        "supportingDocumentReference": "1400073870",
        "supportingDocumentType": "N380"
      }
    ],
    "additionalReferences": [
      {
        "additionalReferenceNumber": null,
        "additionalReferenceType": null
      }
    ],
    "transportDocuments": [
      {
        "transportDocumentReference": "ABC1234",
        "transportDocumentType": "N740"
      }
    ],
    "ucr": {
      "ucrReference": null
    },
    "additionalFiscalReference": {
      "roleCode": "FR5",
      "vatId": null
    },
    "governmentAgencyGoodsItems": [
      {
        "itemNumber": 1,
        "exporter": {
          "exporterName": "Mathers",
          "exporterAddress": {
            "exporterStreet": "3603 Eight Mile Road",
            "exporterCountry": "US",
            "exporterPostcode": "48201",
            "exporterCity": "Detroit"
          }
        },
        "additionalInformation": [
          {
            "code": "00100",
            "text": "This is the additional information description related to the code"
          }
        ],
        "supportingDocuments": [
          {
            "supportingDocumentReference": "1400073870",
            "supportingDocumentType": "N380"
          }
        ],
        "additionalReferences": [
          {
            "additionalReferenceNumber": null,
            "additionalReferenceType": null
          }
        ],
        "transportDocuments": [
          {
            "transportDocumentReference": null,
            "transportDocumentType": null
          }
        ],
        "ucr": {
          "ucrReference": ""
        },
        "additionalFiscalReferences": [
          {
            "roleCode": "FR5",
            "vatId": null
          }
        ],
        "procedure": {
          "additionalProcedure": {
            "additionalProcedureCode": "C07"
          }
        },
        "packaging": {
          "numberOfPackages": 1
        },
        "commodity": {
          "descriptionOfGoods": "This is a commodity text description",
          "commodityCode": {
            "nomenclatureCode": "01022910",
            "reducedVat": "1",
            "nationalAdditionalCodes": [
              {
                "cana": "R499"
              }
            ],
            "taxBase": {
              "value": {
                "currency": "EUR",
                "amount": "12345678901234,12"
              },
              "transportCost": {
                "currency": "EUR",
                "amount": "123456789012345,1"
              }
            }
          },
          "goodsMeasurement": {
            "grossMass": 1234567890.123456,
            "supplementaryUnitsNumber": 1234567890.123456,
            "supplementaryUnitsCode": "KGM",
            "supplementaryUnitsType": "P"
          }
        }
      }
    ]
  }
}

This example has been generated automatically.

{}