Get Customs Declarations
get
/customsDeclarations
Request
Query Parameters
-
expand: string
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.
-
fields: string
Comma-delimited string of field names that you wanted returned in a GET request.
-
limit: integer(int32)
Positive integer value that specifies the maximum number of items returned by the server.
-
offset: integer(int32)
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.
-
orderBy: string
Comma-separated string of field names, each optionally followed by asc or desc, that specifies the order of items returned in the response payload.
-
q: string
Filter (a 'where'clause) to restrict the items returned in the collection. By default, no filtering is applied.
-
totalResults: boolean
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 TopResponse
Supported Media Types
- application/vnd.oracle.resource+json;type=collection
Default Response
Default Response.
Nested Schema : customsDeclarations
Type:
Show Source
object
-
attribute1: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute10: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute11: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute12: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute13: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute14: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute15: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute16: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute17: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute18: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute19: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute2: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute20: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute3: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute4: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute5: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute6: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute7: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute8: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute9: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attributeDate1:
attributeDate1
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate10:
attributeDate10
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate11:
attributeDate11
Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
-
attributeDate12:
attributeDate12
Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
-
attributeDate13:
attributeDate13
Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
-
attributeDate14:
attributeDate14
Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
-
attributeDate15:
attributeDate15
Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
-
attributeDate16:
attributeDate16
Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
-
attributeDate17:
attributeDate17
Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
-
attributeDate18:
attributeDate18
Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
-
attributeDate19:
attributeDate19
Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
-
attributeDate2:
attributeDate2
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate20:
attributeDate20
Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
-
attributeDate3:
attributeDate3
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate4:
attributeDate4
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate5:
attributeDate5
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate6:
attributeDate6
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate7:
attributeDate7
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate8:
attributeDate8
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate9:
attributeDate9
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeNumber1: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber10: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber11: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
-
attributeNumber12: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
-
attributeNumber13: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
-
attributeNumber14: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
-
attributeNumber15: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
-
attributeNumber16: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
-
attributeNumber17: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
-
attributeNumber18: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
-
attributeNumber19: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
-
attributeNumber2: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber20: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
-
attributeNumber3: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber4: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber5: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber6: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber7: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber8: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber9: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
carrierCode: string
The carrier code.
-
conveyanceFlag: string
Flag of the vessel used for the border movement GTM trade transaction.
-
conveyanceName: string
Name of the vessel used for the border movement GTM trade transaction.
-
countryOfExport: string
This describes the country of export for the transaction.
-
countryOfImport: string
This describes the country of import for the transaction.
-
currencyGid: string
The currency in which values should be sent for filing. It is foreign key reference to CURRENCY table.
-
dataQueryTypeGid: string
A data query type represents different business objects.
-
departTransportModeGid: string
The departure transport mode. Which is a foreign key to TRANSPORT_MODE table.
-
departureConveyanceFlag: string
The departure conveyance flag.
-
departureConveyanceName: string
The departure conveyance name.
-
documents:
documents
-
domainName: string
Database domain where this data is stored.
-
exchangeRateDate:
exchangeRateDate
The Exchange Rate date to be used for value conversion while preparing the declaration.
-
exchangeRateGid: string
The Exchange Rate ID to be used for value conversion while preparing the declaration. It is foreign key reference to EXCHANGE_RATE table.
-
gtmBondGid: string
The bond or guarantee used for the import duties and taxes of the GTM trade transaction.
-
gtmDeclarationTypeGid: string
The declaration type ID across all domains. Which is a foreign key to GTM_DECLARATION_TYPE table.
-
gtmDeclSTypeGid: string
The Declaration Sub Type ID. It is foreign key reference to GTM_DECL_S_TYPE table.
-
gtmPriorProcedureGid: string
Specifies the previous customs procedure that occurred before the current one. For example, before your goods are released for free circulation, they may have entered a bonded warehouse first. This field is used to indicate the entry into the bonded warehouse. It is a foreign key reference to GTM_PROCEDURE.
-
gtmProcedureDetailGid: string
The procedure detail GID.
-
gtmProcedureGid: string
This is the customs procedure being requested for this declaration. Examples include Inward Processing Procedure in the EU or Consumption - Foreign Trade Zone in the US. It is a foreign key to GTM_PROCEDURE.
-
gtmTradePreferenceGid: string
The Trade Preference ID which is the tariff treatment of the goods. It is a foreign key reference to GTM_TRADE_PREFERENCE table.
-
gtmTransactionGid: string
The GID for the GTM trade transaction.
-
gtmTransactionXid: string
The external identifier (XID) for the GTM trade transaction.
-
gtmValuationMethodGid: string
The valuation method ID.
-
incoTermGid: string
Incoterm used for the GTM trade transaction. It is a foreign key reference to the INCO_TERM table.
-
incoTermLocation: string
Incoterm location used for the GTM trade transaction.
-
inlandConveyanceFlag: string
The inland conveyance flag.
-
inlandConveyanceName: string
The inland conveyance name.
-
inlandTransportModeGid: string
The inland transport mode. Which is a foreign key to TRANSPORT_MODE table.
-
insertDate:
insertDate
Read Only:
true
insert date -
involvedLocations:
involvedLocations
-
involvedParties:
involvedParties
-
isHazardousCargo: boolean
Indicates if the goods on the GTM trade transaction are hazardous.
-
lines:
lines
-
links: array
links
Read Only:
true
-
logicConfigGid: string
The declaration configuration details that were used to build declaration from transactions or transaction lines.
-
objectId: string
The object ID.
-
policies:
policies
-
ports:
ports
-
refnums:
refnums
-
remarks:
remarks
-
reqBsStatusCodeGid: string
This column refers to the Status Code of the request for customs filing of a declaration. It is a foreign key reference to the BS_STATUS_CODE table.
-
reqBsStatusGroupGid: string
This column refers to the Status Group of the request status of custom filing of a declaration. It is a foreign key reference to the BS_STATUS_GROUP table.
-
reqdocs:
reqdocs
-
respBsStatusCodeGid: string
This column refers to the Status Code of the response received after customs filing of a declaration. It is a foreign key reference to the BS_STATUS_CODE table.
-
respBsStatusGroupGid: string
This column refers to the Status Group of the response status received after custom filing of a declaration. It is a foreign key reference to the BS_STATUS_GROUP table.
-
statuses:
statuses
-
transactionCodes:
transactionCodes
-
transactionDates:
transactionDates
-
transactionQuantities:
transactionQuantities
-
transactionValues:
transactionValues
-
transportModeGid: string
Transport mode used for the border movement GTM trade transaction. It is a foreign key reference to the TRANSPORT_MODE table.
-
updateDate:
updateDate
Read Only:
true
update date -
userDefined1IconGid: string
Marks the condition or state of the GTM trade transaction using images. It is a foreign key reference to ICON table.
-
userDefined2IconGid: string
Marks the condition or state of the GTM trade transaction using images. It is a foreign key reference to ICON table.
-
userDefined3IconGid: string
Marks the condition or state of the GTM trade transaction using images. It is a foreign key reference to ICON table.
-
userDefined4IconGid: string
Marks the condition or state of the GTM trade transaction using images. It is a foreign key reference to ICON table.
-
userDefined5IconGid: string
Marks the condition or state of the GTM trade transaction using images. It is a foreign key reference to ICON table.
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:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : exchangeRateDate
The Exchange Rate date to be used for value conversion while preparing the declaration.
Match All
Show Source
Nested Schema : involvedLocations
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : involvedParties
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : lines
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : policies
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : ports
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : refnums
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : remarks
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : reqdocs
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : statuses
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : transactionCodes
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : transactionDates
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : transactionQuantities
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : transactionValues
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : dateTimeType
Type:
Show Source
object
-
timezone: string
Timezone in Olson database format
-
value: string
(date-time)
Date in ISO 8601 format
Nested Schema : customsDeclarations.documents
Type:
Show Source
object
-
contentManagementSystemGid: string
No description.
-
documentCmsId: string
A GUID to associate the document with content stored on its remote CMS. Valid when document_type=CMS.
-
documentDefGid: string
No description.
-
documentFilename: string
No description.
-
documentGid: string
No description.
-
documentMimeType: string
No description.
-
documentTrackingNum: string
No description.
-
documentType: string
No description.
-
documentUrl: string
No description.
-
documentXid: string
No description.
-
domainName: string
No description.
-
effectiveDate:
effectiveDate
represents effective date for a document
-
expirationDate:
expirationDate
Represents expiration date for a document.
-
generatedAt:
generatedAt
If preparation, date/time content was last generated
-
links: array
links
Read Only:
true
-
ownerDataQueryTypeGid: string
No description.
- relatedDocumentGid: string
-
reportGid: string
The report associated with the document attachment, if content was generated by the report subsystem.
-
uploadedAt:
uploadedAt
If attachment, date/time content was last updated
-
usedAs: string
Represents the classification of a document.(C/I/L/T)
-
userDefined1IconGid: string
No description.
-
userDefined2IconGid: string
No description.
-
userDefined3IconGid: string
No description.
-
userDefined4IconGid: string
No description.
-
userDefined5IconGid: string
No description.
Nested Schema : generatedAt
If preparation, date/time content was last generated
Match All
Show Source
Nested Schema : customsDeclarations.involvedLocations
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
involvedLocationGid: string
The GID for the involved location.
-
involvedLocationQualGid: string
The GID for the involved location qualifier.
-
links: array
links
Read Only:
true
Nested Schema : customsDeclarations.involvedParties
Type:
Show Source
object
-
comMethodGid: string
The GID for the communication method of the involved party.
-
domainName: string
Database domain where this data is stored.
-
involvedPartyContactGid: string
The GID for the involved party contact or party.
-
involvedPartyQualGid: string
The GID for the involved party qualifier.
-
links: array
links
Read Only:
true
Nested Schema : customsDeclarations.lines
Type:
Show Source
object
-
additionalInfos:
additionalInfos
-
attribute1: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute10: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute11: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute12: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute13: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute14: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute15: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute16: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute17: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute18: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute19: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute2: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute20: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute3: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute4: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute5: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute6: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute7: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute8: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute9: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attributeDate1:
attributeDate1
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate10:
attributeDate10
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate11:
attributeDate11
Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
-
attributeDate12:
attributeDate12
Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
-
attributeDate13:
attributeDate13
Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
-
attributeDate14:
attributeDate14
Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
-
attributeDate15:
attributeDate15
Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
-
attributeDate16:
attributeDate16
Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
-
attributeDate17:
attributeDate17
Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
-
attributeDate18:
attributeDate18
Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
-
attributeDate19:
attributeDate19
Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
-
attributeDate2:
attributeDate2
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate20:
attributeDate20
Attribute fields (flexfields) allow you to add additional information about an object. Data type as Date
-
attributeDate3:
attributeDate3
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate4:
attributeDate4
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate5:
attributeDate5
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate6:
attributeDate6
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate7:
attributeDate7
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate8:
attributeDate8
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate9:
attributeDate9
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeNumber1: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber10: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber11: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
-
attributeNumber12: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
-
attributeNumber13: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
-
attributeNumber14: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
-
attributeNumber15: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
-
attributeNumber16: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
-
attributeNumber17: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
-
attributeNumber18: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
-
attributeNumber19: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
-
attributeNumber2: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber20: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data type as Number
-
attributeNumber3: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber4: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber5: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber6: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber7: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber8: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber9: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
baseAmounts:
baseAmounts
-
controlScreens:
controlScreens
-
countryOfExport: string
This describes the country of export for the transaction line.
-
countryOfImport: string
This describes the country of import for the transaction line.
-
countryOfManufacture: string
The country of manufacture for item associated with the GTM trade transaction line.
-
countryOfOrigin: string
The country of origin for item associated with the GTM trade transaction line.
-
domainName: string
Database domain where this data is stored.
-
gtmBondGid: string
The GID for the bond associated with the GTM trade transaction line.
-
gtmPriorProcedureGid: string
The GID for the prior procedure associated with the GTM trade transaction line.
-
gtmProcedureDetailGid: string
The GID for the procedure detail associated with the GTM trade transaction line.
-
gtmProcedureGid: string
The GID for the procedure associated with the GTM trade transaction line.
-
gtmStructureComponentSeq: number
(int32)
The sequence number of the component within an item structure.
-
gtmStructureGid: string
The GID for the trade item structure.
-
gtmTariffCode: string
This column represents the trade program applicable for transaction line.
-
gtmTradePreferenceGid: string
The GID for the trade preference associated with the GTM trade transaction line.
-
gtmTransactionLineGid: string
The GID for the GTM trade transaction line.
-
gtmTransactionLineXid: string
The XID for the GTM trade transaction line.
-
gtmTransLineProdDocs:
gtmTransLineProdDocs
-
gtmTrItemStructureGid: string
Component of transaction item structure indicates the parent item structure that the line is part of.
-
gtmValuationMethodGid: string
The GID for the valuation method associated with the GTM trade transaction line.
-
importProdClassTypeGid: string
No description.
-
incoTermGid: string
The GID for the incoterm associated with the GTM trade transaction line.
-
incoTermLocation: string
The incoterm location associated with the GTM trade transaction line.
-
indicator: string
Marks the condition or state of the GTM trade transaction line using colors.
-
involvedParties:
involvedParties
-
isCanceled: boolean
Indicates if the transaction line is a canceled line.
-
itemGid: string
The GID for the item associated with the GTM trade transaction line.
-
itemStructureGid: string
Item Structure field indicates the structure that was used for qualification or business process.
-
licenses:
licenses
-
lineCodes:
lineCodes
-
lineDates:
lineDates
-
lineItemDescription: string
Describes the item on the transaction line.
-
lineObjectId: string
N/A
-
lineObjectNo: number
(int64)
N/A
-
links: array
links
Read Only:
true
-
notes:
notes
-
otherControls:
otherControls
-
parentTransLineGid: string
Indicates the parent transaction line for a transaction line which is a child line.
-
partyScreens:
partyScreens
-
percentageValues:
percentageValues
-
precedingTransactionLineGid: string
If a transaction line is created from another transaction line, this indicates the preceding transaction line from which this line is created.
-
productClassifications:
productClassifications
-
quantities:
quantities
-
references:
references
-
refnums:
refnums
-
remarks:
remarks
-
reportings:
reportings
-
reportQuantities:
reportQuantities
-
reqdClassifications:
reqdClassifications
-
reqdocLinks:
reqdocLinks
-
sanctions:
sanctions
-
statuses:
statuses
-
textLinks:
textLinks
-
transLineType: string
Indicates if a line is a transaction line or a declaration line.
-
userDefined1IconGid: string
Marks the condition or state of the GTM trade transaction line using images. It is a foreign key reference to ICON table.
-
userDefined2IconGid: string
Marks the condition or state of the GTM trade transaction line using images. It is a foreign key reference to ICON table.
-
userDefined3IconGid: string
Marks the condition or state of the GTM trade transaction line using images. It is a foreign key reference to ICON table.
-
userDefined4IconGid: string
Marks the condition or state of the GTM trade transaction line using images. It is a foreign key reference to ICON table.
-
userDefined5IconGid: string
Marks the condition or state of the GTM trade transaction line using images. It is a foreign key reference to ICON table.
Nested Schema : additionalInfos
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
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:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : controlScreens
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : gtmTransLineProdDocs
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : involvedParties
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : licenses
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : lineCodes
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : lineDates
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : notes
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : otherControls
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : partyScreens
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : percentageValues
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : productClassifications
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : quantities
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : references
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : refnums
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : remarks
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : reportings
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : reportQuantities
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : reqdClassifications
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : reqdocLinks
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : sanctions
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : statuses
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : textLinks
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : customsDeclarations.lines.additionalInfos
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
exportFrom: string
Country or region from which the goods are being exported.
-
gtmAdditionalInfoGid: string
The GID for the GTM additional information.
-
links: array
links
Read Only:
true
-
textOverride: string
Text specified in this field will override the default text defined in the GTM additional information.
Nested Schema : customsDeclarations.lines.baseAmounts
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
gtmBaseAmountTypeGid: string
The GID for the base amount type.
-
gtmComplianceRuleGid: string
The GID for the compliance rule.
-
gtmComplianceRuleGroupGid: string
The GID for the compliance rule set group.
-
gtmRegimeGid: string
The GID for the regime.
-
links: array
links
Read Only:
true
Nested Schema : customsDeclarations.lines.controlScreens
Type:
Show Source
object
-
controlCode: string
The control code assigned to the GTM trade transaction line.
-
domainName: string
Database domain where this data is stored.
-
exceptionComplianceRuleGid: string
The GID for the compliance rule used to assign the exception control type/control code to the GTM trade transaction line.
-
gtmAuthorizationTypeGid: string
The authorization type of the license number associated with the license used to release a control on the GTM trade transaction line.
-
gtmComplianceRuleGid: string
The GID for the compliance rule used to assign the control type/control code to the GTM trade transaction line.
-
gtmComplianceRuleGroupGid: string
The GID for the compliance rule set group used to assign the control type/control code to the GTM trade transaction line.
-
gtmControlCategory: string
The control category associated with the control type/control code assigned to the GTM trade transaction line.
-
gtmControlTypeGid: string
The GID for the control type assigned to the GTM trade transaction line.
-
gtmExceptionControlCode: string
The exception control code assigned to the GTM trade transaction line.
-
gtmExceptionControlTypeGid: string
The GID for the exception control type assigned to the GTM trade transaction line.
-
gtmRegistrationGid: string
The GID for the registration associated with the GTM trade transaction line.
-
gtmRegulationReferenceGid: string
The GID for the regulation reference associated with the control assigned to the GTM trade transaction line.
-
gtmTrControlScreenGid: string
The GID for the GTM trade transaction line control code.
-
gtmTrControlScreenXid: string
The XID for the GTM trade transaction line control code.
-
involvedPartyQualGid: string
The GID for the involved party associated with the control code assigned to the GTM trade transaction line.
-
licenseAddedBy: string
Specifies who added the license to the GTM trade transaction line.
-
licenseAddedOn:
licenseAddedOn
Specifies the date on which the license is added to the GTM trade transaction line.
-
licenseNumber: string
The license number associated with the license used to release a control on the GTM trade transaction line.
-
licenseQuantity: number
(double)
The quantity from the associated license used to release a control on the GTM trade transaction line.
-
licenseUom: string
The unit of measured for the quantity from the associated license used to release a control on the GTM trade transaction line.
-
links: array
links
Read Only:
true
Nested Schema : licenseAddedOn
Specifies the date on which the license is added to the GTM trade transaction line.
Match All
Show Source
Nested Schema : customsDeclarations.lines.gtmTransLineProdDocs
Type:
Show Source
object
-
archiveDetail: string
The archive details of the produced document.
-
archiveFormat: string
The archive format of the produced document.
-
archiveLocationGid: string
The archive location of the produced document. It is a foreign key to LOCATION table.
-
domainName: string
Database domain where this data is stored.
-
gtmProdDocTypeGid: string
The GID for the GTM trade transaction line produced document type.
-
links: array
links
Read Only:
true
-
prodDocDate:
prodDocDate
The document date for the produced document.
-
prodDocRefNumber: string
The document reference number for the produced document.
-
prodDocSequence: number
(int64)
The sequence number generated for the primary key.
-
prodDocValidationLoc: string
The location where the produced document is validated.
Nested Schema : customsDeclarations.lines.involvedParties
Type:
Show Source
object
-
comMethodGid: string
The GID for the communication method of the involved party.
-
domainName: string
Database domain where this data is stored.
-
involvedPartyContactGid: string
The GID for the involved party contact or party.
-
involvedPartyQualGid: string
The GID for the involved party qualifier.
-
links: array
links
Read Only:
true
Nested Schema : customsDeclarations.lines.licenses
Type:
Show Source
object
-
assignedDate:
assignedDate
The date that the license is assigned to the trade transaction line.
-
comments: string
Comments.
-
controlCode: string
The control code being released by the license line assigned to the trade transaction.
-
currencyValue:
currencyValue
The currency value of the license line assigned to the trade transaction.
-
domainName: string
Database domain where this data is stored.
-
exchangeRateGid: string
The Exchange Rate ID used for value conversion between the license and the trade transaction. It is foreign key reference to EXCHANGE_RATE table.
-
gtmControlTypeGid: string
The control type being released by the license line assigned to the trade transaction.
-
gtmLlUsageSequenceNo: number
(int64)
The sequence number of the license line usage.
-
gtmQuantityTypeGid: string
The GID for the GTM quantity qualifier.
-
gtmTransLineLicenseSeq: number
(int64)
The sequence number for the license line assigned to the trade transaction.
-
gtmValueQualifierGid: string
The GID for the GTM value qualifier.
-
licenseExpirationDate:
licenseExpirationDate
The expiration date of the license assigned to the trade transaction line.
-
licenseLineGid: string
The GID for the GTM license line.
-
links: array
links
Read Only:
true
-
quantityUom: string
The unit of measure of the license line quantity allocated to the trade transaction line.
-
quantityValue: number
(double)
The value of the license line quantity allocated to the trade transaction line.
-
rateExchangeDate:
rateExchangeDate
The Exchange Rate date used for value conversion between the license and the trade transaction.
-
transactionDate:
transactionDate
Transaction date is set on performing license assignment based on the date qualifier configured on license code option.
-
userGid: string
The GID for GTM user which assigned the license to the trade transaction line.
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:
Show Source
object
-
currency: string
ISO 4217 currency code
-
value: number
Numeric value that specifies a currency
Nested Schema : customsDeclarations.lines.lineCodes
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
gtmCode: string
The corresponding code for the GTM type.
-
gtmTypeGid: string
The GID for the GTM type or user-defined type.
-
links: array
links
Read Only:
true
Nested Schema : customsDeclarations.lines.lineDates
Type:
Show Source
object
-
dateQualifierGid: string
The GID for the date qualifier.
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
transLineDate:
transLineDate
The transaction line date.
Nested Schema : customsDeclarations.lines.notes
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
enteredBy: string
The action name or the manual intervention that resulted in this note
-
isSystemGenerated: string
Says if the note is generated by the system or manually added by the user.
-
links: array
links
Read Only:
true
-
note: string
Detailed description about the event.
-
noteSequenceNo: number
(int64)
Sequence number of notes.
-
summary: string
High level description about the event.
-
timestamp:
timestamp
Timestamp of the event that is noted.
Nested Schema : customsDeclarations.lines.otherControls
Type:
Show Source
object
-
authorizationAddedBy: string
The user who submitted the authorization.
-
authorizationAddedOn:
authorizationAddedOn
The date the authorization was submitted.
-
authorizationText: string
The authorization information entered by a user to release the control assigned to the GTM trade transaction line during other control screening.
-
controlCode: string
The control code assigned to the GTM trade transaction line.
-
domainName: string
Database domain where this data is stored.
-
exceptionComplianceRuleGid: string
The GID for the compliance rule used to assign the exception control type/control code to the GTM trade transaction line for other control screening.
-
gtmComplianceRuleGid: string
The GID for the compliance rule used to assign the control type/control code for other control screening to the GTM trade transaction line.
-
gtmComplianceRuleGroupGid: string
The GID for the compliance rule set group used to assign the control type/control code for other control screening to the GTM trade transaction line.
-
gtmControlTypeGid: string
The GID for the control type assigned to the GTM trade transaction line for other control screening.
-
gtmExceptionControlCode: string
The exception control code assigned to the GTM trade transaction line during other control screening.
-
gtmExceptionControlTypeGid: string
The GID for the exception control type assigned to the GTM trade transaction line during other control screening.
-
gtmTrOtherControlGid: string
The GID for the GTM trade transaction line control code for other control screening.
-
gtmTrOtherControlXid: string
The XID for the GTM trade transaction line control code for other control screening.
-
links: array
links
Read Only:
true
Nested Schema : customsDeclarations.lines.partyScreens
Type:
Show Source
object
-
contactGid: string
The contact GID.
-
domainName: string
Database domain where this data is stored.
-
gtmPartyGid: string
The GID for party associated with the GTM trade transaction line.
-
gtmTrPartyScreenGid: string
The GID for the party screening record associated with the GTM trade transaction.
-
gtmTrPartyScreenXid: string
The XID for the party screening record associated with the GTM trade transaction.
-
isPassed: boolean
The restricted party screening status for a party associated with the GTM trade transaction line.
-
links: array
links
Read Only:
true
Nested Schema : customsDeclarations.lines.percentageValues
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
gtmPercentageValueQualGid: string
The GID for the percentage value qualifier associated with the GTM trade transaction line.
-
links: array
links
Read Only:
true
-
percentageValue: number
(double)
The percentage value associated with the GTM trade transaction line.
Nested Schema : customsDeclarations.lines.productClassifications
Type:
Show Source
object
-
bindingRulingEffectiveDate:
bindingRulingEffectiveDate
No description.
-
bindingRulingExpirationDate:
bindingRulingExpirationDate
Indicates expiration date of binding ruling.
-
bindingRulingNumber: string
No description.
-
classificationCode: string
Classification code for an item.
-
domainName: string
Database domain where this data is stored.
-
gtmProdClassCodeGid: string
The GID for the product classification code assigned to the GTM trade transaction line.
-
gtmProdClassPurposeGid: string
The GID of product classification purpose added to GTM Trade Transaction Line.
-
gtmProductClassTypeGid: string
The GID for the product classification type assigned to the GTM trade transaction line.
-
gtmTrProdClassificationGid: string
The GID for the product classification assigned to the GTM trade transaction line.
-
gtmTrProdClassificationXid: string
The XID for the product classification assigned to the GTM trade transaction line.
-
isFixed: boolean
Used to indicate if the assigned product classification code is fixed and should not be changed.
-
links: array
links
Read Only:
true
-
tradeDirection: string
Trade Direction of the product classification. This field is deprecated and should not be used.
Nested Schema : bindingRulingExpirationDate
Indicates expiration date of binding ruling.
Match All
Show Source
Nested Schema : customsDeclarations.lines.quantities
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
gtmQuantityTypeGid: string
The GID for the GTM quantity qualifier.
-
gtmTransLineQtySeqNo: number
(int64)
The sequence number of the quantity on the trade transaction line.
-
links: array
links
Read Only:
true
-
quantityValue: number
(double)
The value of the quantity on the trade transaction line.
-
uomCode: string
The unit of measure of the quantity on the trade transaction line.
Nested Schema : customsDeclarations.lines.references
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
gtmQuantityTypeGid: string
The GID used for the trade transaction line quantity qualifier. It is the quantity qualifier of the transaction line aggregated to the declaration line.
-
isPrimary: string
Identifies the primary transaction among multiple transactions listed. The values are Y/N.
-
links: array
links
Read Only:
true
-
quantityUomCode: string
Defines the unit of measure for the value that is aggregated to the declaration line.
-
quantityValue: number
(double)
Defines the quantity value of transaction line that is aggregated to the declaration line.
-
transactionRefGid: string
The GID for the GTM trade transaction related to the GTM trade transaction line that is aggregated to the declaration line.
-
transLineRefGid: string
The GID for the GTM trade transaction line that is aggregated to the declaration line.
Nested Schema : customsDeclarations.lines.refnums
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
gtmTranslineRefnumQualGid: string
The GID for the GTM trade transaction line reference number qualifier.
-
links: array
links
Read Only:
true
-
refnumValue: string
The value of the reference number.
Nested Schema : customsDeclarations.lines.remarks
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
remarkQualGid: string
The GID for the GTM trade transaction line remark.
-
remarkSequence: number
(int64)
The sequence number for the GTM trade transaction line remark.
-
remarkText: string
The remark text for the GTM trade transaction line.
Nested Schema : customsDeclarations.lines.reportings
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
exceptionComplianceRuleGid: string
The GID for the exception compliance rule used to assign the reporting results to the GTM trade transaction line.
-
gtmComplianceRuleGid: string
The GID for the compliance rule used to assign the reporting results to the GTM trade transaction line.
-
gtmComplianceRuleGroupGid: string
The GID for the compliance rule set group used to assign the reporting results to the GTM trade transaction line.
-
gtmControlCode: string
The control code assigned in the reporting results of the GTM trade transaction line.
-
gtmControlTypeGid: string
The GID for the control type assigned in the reporting results of the GTM trade transaction line.
-
gtmExceptionControlCode: string
The exception control code assigned in the reporting results of the GTM trade transaction line.
-
gtmExceptionControlTypeGid: string
The GID for the exception control type assigned in the reporting results of the GTM trade transaction line.
-
gtmRegimeGid: string
The GID for the regime associated with the reporting results control assigned to the GTM trade transaction line.
-
gtmTrReportingGid: string
The GID for the reporting results assigned to the GTM trade transaction line.
-
gtmTrReportingXid: string
The XID for the reporting results assigned to the GTM trade transaction line.
-
links: array
links
Read Only:
true
Nested Schema : customsDeclarations.lines.reportQuantities
Type:
Show Source
object
-
attributeName: string
Refers to the unit of measure selected in uom_code. For example, REPORTING UOM1.
-
classificationCode: string
Classification code for an item.
-
domainName: string
Database domain where this data is stored.
-
gtlrqSeqNum: number
(int64)
The sequence number of the quantity on the trade transaction line.
-
gtmProdClassCodeGid: string
The GID for the product classification code for the reporting quantity.
-
gtmProdClassTypeGid: string
The GID for the product classification type for the reporting quantity.
-
gtmQuantityTypeGid: string
The GID for the GTM quantity qualifier for the reporting quantity.
-
links: array
links
Read Only:
true
-
quantityValue: number
(double)
The value of the quantity on the trade transaction line for the reporting quantity.
-
uomCode: string
The unit of measure of the quantity on the trade transaction line for the reporting quantity.
Nested Schema : customsDeclarations.lines.reqdClassifications
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
gtmProdClassTypeGid: string
The GID for the required product classification type associated with the GTM trade transaction line.
-
links: array
links
Read Only:
true
Nested Schema : customsDeclarations.lines.reqdocLinks
Type:
Show Source
object
-
documentDefGid: string
Required document type for the GTM trade transaction.
-
domainName: string
Database domain where this data is stored.
-
gtmComplianceRuleGid: string
The GID for the compliance rule.
-
gtmComplianceRuleGroupGid: string
The GID for the compliance rule set group.
-
gtmTransactionGid: string
The GID for the GTM trade transaction.
-
gtmTransLineReqdocLinkGid: string
The GID for the required document associated with the GTM trade transaction line.
-
gtmTransLineReqdocLinkXid: string
The XID for the required document associated with the GTM trade transaction line.
-
links: array
links
Read Only:
true
Nested Schema : customsDeclarations.lines.sanctions
Type:
Show Source
object
-
authorizationAddedBy: string
The user who added the authorization used to override a sanction.
-
authorizationAddedOn:
authorizationAddedOn
The date on which an authorization is added to the sanction.
-
authorizationText: string
The authorization used to override a sanction assigned to the GTM trade transaction line.
-
controlCode: string
The sanction control code assigned to the GTM trade transaction.
-
domainName: string
Database domain where this data is stored.
-
gtmComplianceRuleGid: string
The GID for compliance rule used to assign the sanction to the GTM trade transaction.
-
gtmComplianceRuleGroupGid: string
The GID for compliance rule set group used to assign the sanction to the GTM trade transaction.
-
gtmControlTypeGid: string
The GID for the sanction control type assigned to the GTM trade transaction.
-
gtmTrSanctionGid: string
The GID for sanction assigned to the GTM trade transaction line.
-
gtmTrSanctionXid: string
The XID for the sanction assigned to the GTM trade transaction.
-
links: array
links
Read Only:
true
Nested Schema : customsDeclarations.lines.statuses
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
statusTypeGid: string
The GID for the transaction line status type.
-
statusValueGid: string
The GID for the transaction line status value.
Nested Schema : customsDeclarations.lines.textLinks
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
gtmComplianceRuleGid: string
The GID for the GTM compliance rule used to assign a text template to a trade transaction line.
-
gtmComplianceRuleGroupGid: string
The GID for the GTM compliance rule set group used to assign a text template to a trade transaction line.
-
gtmTransactionLineGid: string
The GID for the GTM trade transaction line.
-
gtmTransLineTextLinkGid: string
The GID for the link between the GTM trade transaction line and the associated text template.
-
gtmTransLineTextLinkXid: string
The XID for the link between the GTM trade transaction line and the associated text template.
-
links: array
links
Read Only:
true
-
textOverride: string
Transactional override for the template on the specific document
Nested Schema : customsDeclarations.policies
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
gtmComplianceRuleGid: string
The GID for the GTM compliance rule.
-
gtmComplianceRuleGroupGid: string
The GID for the GTM compliance rule set group.
-
gtmComplianceTemplateGid: string
The GID for the GTM compliance template.
-
gtmPolicyQualifierGid: string
The GID for the GTM policy qualifier.
-
links: array
links
Read Only:
true
Nested Schema : customsDeclarations.ports
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
gtmPortQualifierGid: string
The GID for the GTM port qualifier.
-
links: array
links
Read Only:
true
-
locationGid: string
The GID for the location.
Nested Schema : customsDeclarations.refnums
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
gtmTransRefnumQualGid: string
The GID for the GTM trade transaction reference number.
-
links: array
links
Read Only:
true
-
refnumValue: string
The value of the reference number.
Nested Schema : customsDeclarations.remarks
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
remarkQualGid: string
The GID for the GTM trade transaction remark.
-
remarkSequence: number
(int64)
The sequence number for the GTM trade transaction remark.
-
remarkText: string
The remark text for the GTM trade transaction.
Nested Schema : customsDeclarations.reqdocs
Type:
Show Source
object
-
docs:
docs
-
documentDefGid: string
Required document type for the GTM trade transaction.
-
domainName: string
Database domain where this data is stored.
-
gtmComplianceRuleGid: string
The GID for the compliance rule.
-
gtmComplianceRuleGroupGid: string
The GID for the compliance rule set group.
-
instructions: string
Free-form field to hold document attributes. E.g. a document could be denoted as required or optional.
-
links: array
links
Read Only:
true
-
numRevisions: number
(int32)
The number of document revisions generated.
-
reviewers:
reviewers
-
reviewStatus: string
The review status of the required document.
-
statuses:
statuses
-
subscribers:
subscribers
-
texts:
texts
Nested Schema : reviewers
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : statuses
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : subscribers
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : texts
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : customsDeclarations.reqdocs.docs
Type:
Show Source
object
-
annotations: string
Annotations for a document revision.
-
documentCmsName: string
The document name used to identify a set of revisions (versions) for a CMS.
-
documentGid: string
The GID for the document instance.
-
documentRevision: number
(int32)
The revision count for the document.
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
review: string
The review status of the required document.
-
reviews:
reviews
Nested Schema : reviews
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : customsDeclarations.reqdocs.docs.reviews
Type:
Show Source
object
-
comments: string
Comments from the reviewer for the specific document.
-
contactGid: string
The GID for the document reviewer.
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
state: string
The review status of the document.
Nested Schema : customsDeclarations.reqdocs.reviewers
Type:
Show Source
object
-
asInvolvedPartyQualGid: string
The involved party of the reviewer if they are acting as a party on the trade transaction.
-
contactGid: string
The GID for the document reviewer.
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
Nested Schema : customsDeclarations.reqdocs.statuses
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
statusTypeGid: string
The status type associated with a required document.
-
statusValueGid: string
The status value associated with a required document.
Nested Schema : customsDeclarations.reqdocs.subscribers
Type:
Show Source
object
-
asInvolvedPartyQualGid: string
The involved party of the subscriber if they are acting as a party on the trade transaction.
-
contactGid: string
The GID for the document reviewer.
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
Nested Schema : customsDeclarations.reqdocs.texts
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
gtmComplianceRuleGid: string
The compliance rule used to assign the text template to the GTM trade transaction.
-
gtmComplianceRuleGroupGid: string
The compliance rule set group used to assign the text template to the GTM trade transaction.
-
gtmTransactionLineGid: string
The GID for the GTM trade transaction line.
-
links: array
links
Read Only:
true
-
textLinks:
textLinks
-
textOverride: string
Transactional override for the template on the specific document.
-
textTemplateGid: string
The GID for the text template associated with the GTM trade transaction line.
Nested Schema : textLinks
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : customsDeclarations.reqdocs.texts.textLinks
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
gtmComplianceRuleGid: string
The GID for the GTM compliance rule used to assign a text template to a trade transaction line.
-
gtmComplianceRuleGroupGid: string
The GID for the GTM compliance rule set group used to assign a text template to a trade transaction line.
-
gtmTransactionLineGid: string
The GID for the GTM trade transaction line.
-
gtmTransLineTextLinkGid: string
The GID for the link between the GTM trade transaction line and the associated text template.
-
gtmTransLineTextLinkXid: string
The XID for the link between the GTM trade transaction line and the associated text template.
-
links: array
links
Read Only:
true
-
textOverride: string
Transactional override for the template on the specific document
Nested Schema : customsDeclarations.statuses
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
statusTypeGid: string
The GID for the transaction status type.
-
statusValueGid: string
The GID for the transaction status value.
Nested Schema : customsDeclarations.transactionCodes
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
gtmCode: string
The corresponding code for the GTM type.
-
gtmTypeGid: string
The GID for the GTM type or user-defined type.
-
links: array
links
Read Only:
true
Nested Schema : customsDeclarations.transactionDates
Type:
Show Source
object
-
dateQualifierGid: string
The GID for the date qualifier.
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
transactionDate:
transactionDate
The transaction date.
Nested Schema : customsDeclarations.transactionQuantities
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
gtmQuantityTypeGid: string
The GID for the GTM quantity qualifier.
-
links: array
links
Read Only:
true
-
quantityValue: number
(double)
The value of the quantity.
-
uomCode: string
The unit of measure of the quantity.
Nested Schema : customsDeclarations.transactionValues
Type:
Show Source
object
-
currencyValue:
currencyValue
The currency value of the trade transaction.
-
domainName: string
Database domain where this data is stored.
-
gtmFormulaExpressionGid: string
Formula(If any) associated with the value qualifier.
-
gtmValueQualifierGid: string
The GID for the value qualifier.
-
isFixed: boolean
If this is set to false, the currency values can be overridden with the values calculated from formula or any other process.
-
links: array
links
Read Only:
true
-
methodOfCalculation: string
Shows how the currency value should be calculated either manually or by using a formula.
-
paymentMethodCodeGid: string
The payment method. It is a foreign key to PAYMENT_METHOD_CODE table.
-
rcValue: number
(double)
The reporting currency value.
-
rcValueCurrencyGid: string
The reporting value currency. It is a foreign key to CURRENCY table.
-
valueFormulaCompRuleGrpId: string
Compliance rule group ID used to assign formula to the value qualifiers on the transaction.
-
valueNote: string
A note that shows how the value qualifier is calculated.
-
valueSetCompRuleGrpId: string
Compliance rule group ID used to assign value set to the transaction.