API - Usage Methods
Worksheet Methods
Sequoia v5
CreateCdsWorksheet
Saves a Worksheet in Sequoia compatible with CDS declarations.
| Payload | Schema / Return value |
|---|---|
| Request: | CdsWorksheet.xsd |
| Response (success): | A string representing the worksheet reference. |
| Response (failure): | See Error Reporting above |
Transactions
Transactions are supported by specifying a TransactionId on the request.
Sequoia v1.74
CreateWorksheet
Saves a Worksheet in Sequoia.
| Payload | Schema / Return value |
|---|---|
| Request: | Worksheet.xsd |
| Response (success): | A string representing the worksheet reference. |
| Response (failure): | See Error Reporting above |
Transactions
Transactions are supported by specifying a TransactionId on the request.
Sequoia v1.83
GetWorksheetReport
Retrieves details of a declaration worksheet, including data from customs declarations in which it was consumed.
| Payload | Schema / Return value |
|---|---|
| Request: | WorksheetIdentifier.xsd |
| Response (success): | WorksheetReport.xsd |
| Response (failure): | See Error Reporting above |
Sequoia v1.83
GetWorksheetsModifiedWithinDateRange
Retrieves a list of declaration worksheets modified within a range of dates. The 'modified' timestamp on a worksheet is set when details of the worksheet are created/changed, and on receipt of a response from CHIEF to a declaration in which details of the worksheet(s) were consumed.
| Payload | Schema / Return value |
|---|---|
| Request: | GetWorksheetsModifiedWithinDateRangeRequest.xsd |
| Response (success): | GetWorksheetsModifiedWithinDateRangeResponse.xsd |
| Response (failure): | See Error Reporting above |