Get Customs Declarations

get

/customsDeclarations

Request

Query Parameters
  • Comma-delimited string of child resource names that you want to expand so that the contents return with the parent in the same GET request.
  • Comma-delimited string of field names that you wanted returned in a GET request.
  • Positive integer value that specifies the maximum number of items returned by the server.
  • Non-negative integer values that specifies the index of the first item to be returned. The offset index begins at 0. By default, the offset is 0, which returns all items starting from the first item in the collection.
  • Comma-separated string of field names, each optionally followed by asc or desc, that specifies the order of items returned in the response payload.
  • Filter (a 'where'clause) to restrict the items returned in the collection. By default, no filtering is applied.
  • Boolean value that specifies whether to calculate the totalResults property. By default, this value is set to false indicating that totalResults is not calculated.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

Default Response

Default Response.
Body ()
Root Schema : schema
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : customsDeclarations
Type: object
Show Source
Nested Schema : attributeDate1
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate10
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate11
Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
Match All
Show Source
Nested Schema : attributeDate12
Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
Match All
Show Source
Nested Schema : attributeDate13
Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
Match All
Show Source
Nested Schema : attributeDate14
Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
Match All
Show Source
Nested Schema : attributeDate15
Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
Match All
Show Source
Nested Schema : attributeDate16
Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
Match All
Show Source
Nested Schema : attributeDate17
Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
Match All
Show Source
Nested Schema : attributeDate18
Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
Match All
Show Source
Nested Schema : attributeDate19
Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
Match All
Show Source
Nested Schema : attributeDate2
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate20
Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
Match All
Show Source
Nested Schema : attributeDate3
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate4
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate5
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate6
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate7
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate8
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate9
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : documents
Type: object
Show Source
Nested Schema : exchangeRateDate
The Exchange Rate date to be used for value conversion while preparing the declaration.
Match All
Show Source
Nested Schema : insertDate
Read Only: true
insert date
Match All
Show Source
Nested Schema : involvedLocations
Type: object
Show Source
Nested Schema : involvedParties
Type: object
Show Source
Nested Schema : lines
Type: object
Show Source
Nested Schema : policies
Type: object
Show Source
Nested Schema : ports
Type: object
Show Source
Nested Schema : refnums
Type: object
Show Source
Nested Schema : remarks
Type: object
Show Source
Nested Schema : reqdocs
Type: object
Show Source
Nested Schema : statuses
Type: object
Show Source
Nested Schema : transactionCodes
Type: object
Show Source
Nested Schema : transactionDates
Type: object
Show Source
Nested Schema : transactionQuantities
Type: object
Show Source
Nested Schema : transactionValues
Type: object
Show Source
Nested Schema : updateDate
Read Only: true
update date
Match All
Show Source
Nested Schema : dateTimeType
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : customsDeclarations.documents
Type: object
Show Source
Nested Schema : effectiveDate
represents effective date for a document
Match All
Show Source
Nested Schema : expirationDate
Represents expiration date for a document.
Match All
Show Source
Nested Schema : generatedAt
If preparation, date/time content was last generated
Match All
Show Source
Nested Schema : uploadedAt
If attachment, date/time content was last updated
Match All
Show Source
Nested Schema : dateType
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : customsDeclarations.involvedLocations
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : customsDeclarations.involvedParties
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : customsDeclarations.lines
Type: object
Show Source
Nested Schema : additionalInfos
Type: object
Show Source
Nested Schema : attributeDate1
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate10
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate11
Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
Match All
Show Source
Nested Schema : attributeDate12
Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
Match All
Show Source
Nested Schema : attributeDate13
Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
Match All
Show Source
Nested Schema : attributeDate14
Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
Match All
Show Source
Nested Schema : attributeDate15
Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
Match All
Show Source
Nested Schema : attributeDate16
Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
Match All
Show Source
Nested Schema : attributeDate17
Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
Match All
Show Source
Nested Schema : attributeDate18
Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
Match All
Show Source
Nested Schema : attributeDate19
Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
Match All
Show Source
Nested Schema : attributeDate2
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate20
Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
Match All
Show Source
Nested Schema : attributeDate3
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate4
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate5
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate6
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate7
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate8
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate9
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : baseAmounts
Type: object
Show Source
Nested Schema : controlScreens
Type: object
Show Source
Nested Schema : gtmTransLineProdDocs
Type: object
Show Source
Nested Schema : involvedParties
Type: object
Show Source
Nested Schema : licenses
Type: object
Show Source
Nested Schema : lineCodes
Type: object
Show Source
Nested Schema : lineDates
Type: object
Show Source
Nested Schema : notes
Type: object
Show Source
Nested Schema : otherControls
Type: object
Show Source
Nested Schema : partyScreens
Type: object
Show Source
Nested Schema : percentageValues
Type: object
Show Source
Nested Schema : productClassifications
Type: object
Show Source
Nested Schema : quantities
Type: object
Show Source
Nested Schema : references
Type: object
Show Source
Nested Schema : refnums
Type: object
Show Source
Nested Schema : remarks
Type: object
Show Source
Nested Schema : reportings
Type: object
Show Source
Nested Schema : reportQuantities
Type: object
Show Source
Nested Schema : reqdClassifications
Type: object
Show Source
Nested Schema : sanctions
Type: object
Show Source
Nested Schema : statuses
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : customsDeclarations.lines.additionalInfos
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : customsDeclarations.lines.baseAmounts
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : customsDeclarations.lines.controlScreens
Type: object
Show Source
Nested Schema : licenseAddedOn
Specifies the date on which the license is added to the GTM trade transaction line.
Match All
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : customsDeclarations.lines.gtmTransLineProdDocs
Type: object
Show Source
Nested Schema : prodDocDate
The document date for the produced document.
Match All
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : customsDeclarations.lines.involvedParties
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : customsDeclarations.lines.licenses
Type: object
Show Source
Nested Schema : assignedDate
The date that the license is assigned to the trade transaction line.
Match All
Show Source
Nested Schema : currencyValue
The currency value of the license line assigned to the trade transaction.
Match All
Show Source
Nested Schema : licenseExpirationDate
The expiration date of the license assigned to the trade transaction line.
Match All
Show Source
Nested Schema : rateExchangeDate
The Exchange Rate date used for value conversion between the license and the trade transaction.
Match All
Show Source
Nested Schema : transactionDate
Transaction date is set on performing license assignment based on the date qualifier configured on license code option.
Match All
Show Source
Nested Schema : currencyType
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : customsDeclarations.lines.lineCodes
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : customsDeclarations.lines.lineDates
Type: object
Show Source
Nested Schema : transLineDate
The transaction line date.
Match All
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : customsDeclarations.lines.notes
Type: object
Show Source
Nested Schema : timestamp
Timestamp of the event that is noted.
Match All
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : customsDeclarations.lines.otherControls
Type: object
Show Source
Nested Schema : authorizationAddedOn
The date the authorization was submitted.
Match All
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : customsDeclarations.lines.partyScreens
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : customsDeclarations.lines.percentageValues
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : customsDeclarations.lines.productClassifications
Type: object
Show Source
Nested Schema : bindingRulingEffectiveDate
No description.
Match All
Show Source
Nested Schema : bindingRulingExpirationDate
Indicates expiration date of binding ruling.
Match All
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : customsDeclarations.lines.quantities
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : customsDeclarations.lines.references
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : customsDeclarations.lines.refnums
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : customsDeclarations.lines.remarks
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : customsDeclarations.lines.reportings
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : customsDeclarations.lines.reportQuantities
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : customsDeclarations.lines.reqdClassifications
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : customsDeclarations.lines.sanctions
Type: object
Show Source
Nested Schema : authorizationAddedOn
The date on which an authorization is added to the sanction.
Match All
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : customsDeclarations.lines.statuses
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : customsDeclarations.policies
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : customsDeclarations.ports
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : customsDeclarations.refnums
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : customsDeclarations.remarks
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : customsDeclarations.reqdocs
Type: object
Show Source
Nested Schema : docs
Type: object
Show Source
Nested Schema : reviewers
Type: object
Show Source
Nested Schema : statuses
Type: object
Show Source
Nested Schema : subscribers
Type: object
Show Source
Nested Schema : texts
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : customsDeclarations.reqdocs.docs
Type: object
Show Source
Nested Schema : reviews
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : customsDeclarations.reqdocs.docs.reviews
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : customsDeclarations.reqdocs.reviewers
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : customsDeclarations.reqdocs.statuses
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : customsDeclarations.reqdocs.subscribers
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : customsDeclarations.reqdocs.texts
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : customsDeclarations.statuses
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : customsDeclarations.transactionCodes
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : customsDeclarations.transactionDates
Type: object
Show Source
Nested Schema : transactionDate
The transaction date.
Match All
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : customsDeclarations.transactionQuantities
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : customsDeclarations.transactionValues
Type: object
Show Source
Nested Schema : currencyValue
The currency value of the trade transaction.
Match All
Show Source
Back to Top