API - Usage Methods
Declaration (CHIEF) Methods
AmendAcceptedExportGbDeclaration
Specifies a partial or complete declaration to replace an existing accepted export declaration.
| Payload | Schema / Return value |
|---|---|
| Request: | DeclarationGbExport.xsd |
| Response (success): | DeclarationGbIdentifier.xsd |
| Response (failure): | See Error Reporting above |
Notes
This is the same request schema as is used for creating a declaration. In this instance the 'Reason for Amendment' element in the XML data is treated as mandatory and an error will be returned if this element is missing or empty.
Transactions
Transactions are supported by specifying a TransactionId on the request.
AmendAcceptedImportGbDeclaration
Specifies a partial or complete declaration to be stored in Sequoia, replacing an existing accepted import declaration.
| Payload | Schema / Return value |
|---|---|
| Request: | DeclarationGbImport.xsd |
| Response (success): | DeclarationGbIdentifier.xsd |
| Response (failure): | See Error Reporting above |
Notes
This is the same request schema as is used for creating a declaration. In this instance the 'Reason for Amendment' element in the XML data is treated as mandatory and an error will be returned if this element is missing or empty.
Transactions
Transactions are supported by specifying a TransactionId on the request.
CreateExportGbDeclaration
Specifies a partial or complete declaration to be stored in Sequoia.
| Payload | Schema / Return value |
|---|---|
| Request: | DeclarationGbExport.xsd |
| Response (success): | DeclarationGbIdentifier.xsd |
| Response (failure): | See Error Reporting above |
Notes
This method will populate the declaration currency automatically with “GB”. Any other declaration currency value in the schema will be ignored.
Transactions
Transactions are supported by specifying a TransactionId on the request.
CreateFsdImportGbDeclaration
Specifies a partial or complete final supplementary declaration (FSD) to be stored in Sequoia.
| Payload | Schema / Return value |
|---|---|
| Request: | FsdDeclarationGbImport.xsd |
| Response (success): | DeclarationGbIdentifier.xsd |
| Response (failure): | See Error Reporting above |
Notes
This method will populate the declaration currency automatically with "GB". Any other declaration currency value in the schema will be ignored.
Transactions
Transactions are supported by specifying a TransactionId on the request.
CreateImportGbDeclaration
Specifies a partial or complete declaration to be stored in Sequoia.
| Payload | Schema / Return value |
|---|---|
| Request: | DeclarationGbImport.xsd |
| Response (success): | DeclarationGbIdentifier.xsd |
| Response (failure): | See Error Reporting above |
Notes
This method will populate the declaration currency automatically with “GB”. Any other declaration currency value in the schema will be ignored.
Transactions
Transactions are supported by specifying a TransactionId on the request.
DeleteGbDeclaration
Delete an existing import or export declaration identified by DUCR and optional DUCR part number.
| Payload | Schema / Return value |
|---|---|
| Request: | DeclarationGbIdentifier.xsd |
| Response (success): | 'True' |
| Response (failure): | See Error Reporting above |
Transactions Transactions are supported by specifying a TransactionId on the request.
GetCustomsReportDeclarationResponse
Gets the full data for a specified declaration and report type.
| Payload | Schema / Return value |
|---|---|
| Request: | DeclarationGbReportRequest.xsd |
| Response (success): | DeclarationGbResponse.xsd |
| Response (failure): | See Error Reporting above |
GetFrontierDeclarationResponse
Gets declaration response data for the declaration identified from the DUCR (Declaration UCR), DUCR and DUCR part number or Job Reference.
| Payload | Schema / Return value |
|---|---|
| Request: | DeclarationResponseRequest.Xsd |
| Response (success): | DeclarationResponse.Xsd |
| Response (failure): | If no matching response is located, data in the format DeclarationResponse.Xsd will still be returned but the Entry Number will be empty. |
GetFullAcceptedDeclarationResponse
Gets the full response data for the accepted declaration.
| Payload | Schema / Return value |
|---|---|
| Request: | DeclarationGbIdentifier.xsd |
| Response (success): | DeclarationGbResponse.xsd |
| Response (failure): | See Error Reporting above |
GetGbDeclaration
Gets declaration data for the declaration identified from the specified DUCR (Declaration UCR), DUCR and part number or Job Reference.
| Payload | Schema / Return value |
|---|---|
| Request: | DeclarationResponseRequest.xsd |
| Response (success): | DeclarationGbImport.xsd (for an import declaration) DeclarationGbExport.xsd (for an export declaration) |
| Response (failure): | If no matching declaration is located an empty string will be returned. |
GetGbDeclarationErrorResponseList
Get the error response for an existing import or export declaration identified by DUCR/DUCR part number.
| Payload | Schema / Return value |
|---|---|
| Request: | DeclarationGbIdentifier.xsd |
| Response (success): | DeclarationGbErrorResponse.xsd |
| Response (failure): | See Error Reporting above |
GetGbDeclarationReportList
Get the list of available reports for an existing import or export declaration identified by DUCR / DUCR part number.
| Payload | Schema / Return value |
|---|---|
| Request: | DeclarationGbIdentifier.xsd |
| Response (success): | DeclarationGbAcceptanceReport.xsd |
| Response (failure): | See Error Reporting above |
GetGbDeclarationFromTemplate
Gets a declaration or fragment of a declaration based on a template.
| Payload | Schema / Return value |
|---|---|
| Request: | DeclarationGbTemplateRequest.xsd |
| Response (success): | DeclarationGbImport.xsd (for a full import declaration template) DeclarationGbImportItem.xsd (for an import declaration item template) DeclarationGbExport.xsd (for a full export declaration template) DeclarationGbExportItem.xsd (for an export declaration item template) |
| Response (failure): | See Error Reporting above |
GetGbDeclarationsModifiedSince
Get a list of declarations modified or created since a specified date.
| Payload | Schema / Return value |
|---|---|
| Request: | DeclarationRecordsModifiedSinceRequest.xsd |
| Response (success): | DeclarationGbIdentifierList.xsd |
| Response (failure): | See Error Reporting above |
Notes
The response for this request is paged - See the section on Token-based page queries for further information.
SendGbDeclaration
Transmit an existing import or export declaration identified by DUCR/DUCR part number.
| Payload | Schema / Return value |
|---|---|
| Request: | DeclarationGbIdentifier.xsd |
| Response (success): | 'True' |
| Response (failure): | See Error Reporting above |
SendGbDeclarationCancellation
Sends a cancellation request for an existing accepted import or export declaration identified by DUCR and optional DUCR part number.
| Payload | Schema / Return value |
|---|---|
| Request: | DeclarationGbIdentifier.xsd |
| Response (success): | 'True' |
| Response (failure): | See Error Reporting above |
UpdateExportGbDeclaration
Specifies a partial or complete declaration to be stored in Sequoia, replacing an existing export declaration.
| Payload | Schema / Return value |
|---|---|
| Request: | DeclarationGbExport.xsd |
| Response (success): | DeclarationGbIdentifier.xsd |
| Response (failure): | See Error Reporting above |
Transactions
Transactions are supported by specifying a TransactionId on the request.
UpdateImportGbDeclaration
Specifies a partial or complete declaration to be stored within Sequoia data tables replacing an existing import declaration.
| Payload | Schema / Return value |
|---|---|
| Request: | DeclarationGbImport.xsd |
| Response (success): | DeclarationGbIdentifier.xsd |
| Response (failure): | See Error Reporting above |
Notes
This method will populate the declaration currency automatically. Any declaration currency value supplied in the schema will be ignored.
Transactions
Transactions are supported by specifying a TransactionId on the request.
ValidateGbDeclaration
Specifies a declaration by DUCR and optionally by DUCR part number to validate the declaration using Sequoia business rules. A collection of errors, warnings and informational messages are returned as detailed below.
| Payload | Schema / Return value |
|---|---|
| Request: | DeclarationGbIdentifier.xsd |
| Response (success): | 'No validation errors returned' |
| Response (failure): | See Error Reporting above |
Notes
This method will return a collection of validation error messages for the given declaration if:
- a matching declaration is found and it doesn't meet the Sequoia business rules, or;
- a matching declaration is not found or there are multiple matches (for example if a part number is not specified).