Get Invoices
get
/invoices
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 : invoices
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)
-
attributeCurrency1:
attributeCurrency1
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeCurrency2:
attributeCurrency2
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeCurrency3:
attributeCurrency3
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
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 Date
-
attributeDate12:
attributeDate12
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate13:
attributeDate13
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate14:
attributeDate14
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate15:
attributeDate15
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate16:
attributeDate16
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate17:
attributeDate17
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate18:
attributeDate18
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate19:
attributeDate19
Attribute fields (flexfields) allow you to add additional information about an object. Data Type 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 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 NUMBER
-
attributeNumber12: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber13: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber14: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber15: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber16: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber17: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber18: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber19: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type 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 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
-
baseCharge:
baseCharge
The Base Charge is the sum of the shipping charges for the invoice.
-
consolidationType: string
The value is set based on the invoice type involved - there are three consolidation types- STANDARD for a stand-alone invoice, PARENT for a parent invoice (for example, a consolidation invoice), or CHILD for a child invoice.
-
correctionCodeId: string
Correction code identifier.
-
currencyGid: string
The GID for currency.
-
customerVatRegNoGid: string
The Customer VAT Registration ID is the VAT tax ID for the customer.
-
dateReceived:
dateReceived
The date the invoice was received.
-
destCountryCode3Gid: string
The destination country code GID.
-
destStationCity: string
The city in which the related shipment ends.
-
destStationFsac: string
The FSAC code for the station in which the related shipment ended.
-
destStationPostalCode: string
The postal code in which the related shipment ended.
-
destStationProvinceCode: string
The province code in which the related shipment ended.
-
destStationSplc: string
The SPLC code for the destination of the shipment which relates to this invoice.
-
discountAmount:
discountAmount
The total dollar amount of any discounts applied to the invoice.
-
discountDaysDue: number
(int32)
The number of days in the terms discount period by which payment is due if the terms of the discount are to be earned.
-
discountDueDate:
discountDueDate
The date that the payment must be made by in order for the discount to be earned.
-
discountPercentage: number
(double)
Either a specific amount for the discount or a percentage to be used for the discount.
-
documents:
documents
-
domainName: string
Database domain where this data is stored.
-
endDate:
endDate
The end range for which this invoice was generated.
-
enteredByGlUserGid: string
Identifies which GL user entered the invoice into the system.
-
equipmentDetails:
equipmentDetails
-
exchangeRateDate:
exchangeRateDate
Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.
-
exchangeRateGid: string
Indicates the set of exchange rates to use for currency conversions; if null, the default set should be used
-
glDate:
glDate
GL Date for the invoice as set by agent or manual action.
-
incoTermGid: string
The terms of sale for this particular invoice.
-
insertDate:
insertDate
Read Only:
true
insert date -
invConsConstraintSetGid: string
Constraint Set ID is used for creating a consolidated invoice/bill. This will be used for identifying the parent invoice/bill when you add more invoices/bills with the same constraint set.
-
invoiceDate:
invoiceDate
The date of the invoice.
-
invoiceGid: string
The GID for the invoice.
-
invoiceNumber: string
Indicates the number that was assigned to the invoice.
-
invoiceRuleGid: string
The rule ID used for generating this invoice/bill.
-
invoiceServiceCodeGid: string
The type of service that was performed. Foreign key to INVOICE_SERVICE_CODE.
-
invoiceSource: string
Read Only:
true
Valid values are G, I, M. -
invoiceType: string
Read Only:
true
Indicates whether this is a bill or an invoice (valid values are 'I' or 'B'). INVOICE_TYPE indicates whether this is a bill or an invoice (valid values are 'I' or 'B'). -
invoiceXid: string
The XID for the invoice.
-
invoicingProcess: string
N/A
-
involvedParties:
involvedParties
-
isCreditNote: boolean
Indicates if this invoice is a credit note
-
isFixedCost: boolean
The Fixed Cost check box allows you to override the amount due calculation. When checked the amount due that you enter will be used regardless of the base and other charges.
-
isHazardous: boolean
Indicator for identifying whether the invoiced shipment was or was not identified as carrying hazardous or dangerous goods.
-
isPassThrough: boolean
The Pass Through check box allows to the invoice to be approved for payment without being matched to a shipment.
-
isTemperatureControl: boolean
Indicator for identifying whether the invoiced shipment was or was not identified as requiring temperature control.
-
isVatAnalysisFixed: boolean
Indicates if the VAT Analysis is fixed (user entered) and the system should not try to calculate it.
-
letterOfCreditExpDate:
letterOfCreditExpDate
The date until which the letter of credit is in effect. After this date, the letter of credit expires.
-
letterOfCreditIssueDate:
letterOfCreditIssueDate
The date that the letter of credit was issued.
-
letterOfCreditNumber: string
The identification number of the letter of credit.
-
lineItems:
lineItems
-
links: array
links
Read Only:
true
-
netAmountDue:
netAmountDue
The net amount that is due for the invoice.
-
netAmtDueWithTax:
netAmtDueWithTax
The Amount Due with VAT is the total amount due plus any applicable value added taxes (VAT).
-
netDueDate:
netDueDate
The date on which the net amount for the invoice is due.
-
notes:
notes
-
originalInvoiceGid: string
For supplemental bills. This references the original bill.
-
originCountryCode3Gid: string
The origin country code GID.
-
originStationCity: string
The city in which the related shipment began.
-
originStationFsac: string
The FSAC code for the station in which the related shipment began.
-
originStationPostalCode: string
The postal code in which the related shipment began.
-
originStationProvinceCode: string
The province code in which the related shipment began.
-
originStationSplc: string
The SPLC code for the station in which the related shipment began.
-
otherCharge:
otherCharge
The Other Charge is the sum of the accessorial and other non-shipping charges for the invoice.
-
parentInvoiceGid: string
The parent invoice GID.
-
paymentMethodCodeGid: string
The method of payment that is expected for the invoice. Examples include: check, cash on deliver, credit card and electronic funds transfer.
-
ports:
ports
-
protectiveServices:
protectiveServices
-
railDate:
railDate
The rail date is the date when a container gets put on rail car.
-
refnums:
refnums
-
remarks:
remarks
-
routes:
routes
-
sailCutoffDate:
sailCutoffDate
The sail cutoff date is the latest date in which you can get your cargo onto the vessel.
-
sailDate:
sailDate
The sail date is the date the vessel sails.
-
servprovAliasQualGid: string
Identifies the service provider qualifier (such as SCAC), which is then associated with the value in servprov_alias_value. This attribute is marked as Create-Only.
-
servprovAliasValue: string
Identifies service provider that handled the shipment related to the invoice. The qualifier servprov_alias_qual_gid qualifies the value, which can be a scec code, or another descriptor for the service provider. This attribute is marked as Create-Only.
-
servprovGid: string
The GID for the service provider. This attribute is marked as Create-Only.
-
servprovVatRegNoGid: string
The service provider VAT Registration ID is the VAT tax ID for the service provider.
-
shipments:
shipments
-
startDate:
startDate
The start range for which this invoice was generated.
-
statuses:
statuses
-
stops:
stops
-
summaries:
summaries
-
summaryDetails:
summaryDetails
-
supplyCountryCode3Gid: string
The Supply Country Code ID represents the country that the goods are coming from.
-
supplyProvinceVatRegs:
supplyProvinceVatRegs
-
texts:
texts
-
updateDate:
updateDate
Read Only:
true
update date -
userDefined1IconGid: string
Can store a user-defined icon that will appear within the user interface to help visually identify attributes of the invoice.
-
userDefined2IconGid: string
Can store a user-defined icon that will appear within the user interface to help visually identify attributes of the invoice.
-
userDefined3IconGid: string
Can store a user-defined icon that will appear within the user interface to help visually identify attributes of the invoice.
-
userDefined4IconGid: string
Can store a user-defined icon that will appear within the user interface to help visually identify attributes of the invoice.
-
userDefined5IconGid: string
Can store a user-defined icon that will appear within the user interface to help visually identify attributes of the invoice.
-
vatAnalyses:
vatAnalyses
-
vatExemptValue: string
The VAT Exempt field is used when the bill is exempt from the tax. When it is checked, you need to specify whether the bill is Exempt with Credit or Exempt without Credit.
-
vesOpServprovAliasQualGid: string
The vessel operator service provider alias qualifier GID.
-
vesOpServprovAliasValue: string
Service provider alias of the vessel operator.
-
vesselCode: string
The vessel that was used for the shipment that relates to the invoice.
-
vesselCodeQualifier: string
The qualifier for the vessel.
-
vesselCountryCode3Gid: string
The vessel country code GID.
-
vesselGid: string
Vessel ID for the invoice.
-
voyageNumber: string
The number of the voyage that relates to the shipment for which this invoice is being created.
Nested Schema : attributeCurrency1
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
Match All
Show Source
Nested Schema : attributeCurrency2
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
Match All
Show Source
Nested Schema : attributeCurrency3
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
Match All
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 Date
Match All
Show Source
Nested Schema : attributeDate12
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate13
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate14
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate15
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate16
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate17
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate18
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate19
Attribute fields (flexfields) allow you to add additional information about an object. Data Type 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 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 : baseCharge
The Base Charge is the sum of the shipping charges for the invoice.
Match All
Show Source
Nested Schema : discountAmount
The total dollar amount of any discounts applied to the invoice.
Match All
Show Source
Nested Schema : discountDueDate
The date that the payment must be made by in order for the discount to be earned.
Match All
Show Source
Nested Schema : documents
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : equipmentDetails
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : exchangeRateDate
Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.
Match All
Show Source
Nested Schema : glDate
GL Date for the invoice as set by agent or manual action.
Match All
Show Source
Nested Schema : involvedParties
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : letterOfCreditExpDate
The date until which the letter of credit is in effect. After this date, the letter of credit expires.
Match All
Show Source
Nested Schema : letterOfCreditIssueDate
The date that the letter of credit was issued.
Match All
Show Source
Nested Schema : lineItems
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : netAmtDueWithTax
The Amount Due with VAT is the total amount due plus any applicable value added taxes (VAT).
Match All
Show Source
Nested Schema : netDueDate
The date on which the net amount for the invoice is due.
Match All
Show Source
Nested Schema : notes
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : otherCharge
The Other Charge is the sum of the accessorial and other non-shipping charges for the invoice.
Match All
Show Source
Nested Schema : ports
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : protectiveServices
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : railDate
The rail date is the date when a container gets put on rail car.
Match All
Show Source
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 : routes
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : sailCutoffDate
The sail cutoff date is the latest date in which you can get your cargo onto the vessel.
Match All
Show Source
Nested Schema : shipments
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : startDate
The start range for which this invoice was generated.
Match All
Show Source
Nested Schema : statuses
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : stops
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : summaries
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : summaryDetails
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : supplyProvinceVatRegs
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 : vatAnalyses
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : currencyType
Type:
Show Source
object
-
currency: string
ISO 4217 currency code
-
value: number
Numeric value that specifies a currency
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 : invoices.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 : invoices.equipmentDetails
Type:
Show Source
object
-
descriptionCode: string
Description code.
-
domainName: string
Database domain where this data is stored.
-
dunnage:
dunnage
Dunnage.
-
equipmentInitialNumber: string
The Equipment Initial/Number field is a concatenation of equipment initial and equipment number. The initial is a mark that is registered with national or international authorities that is associated with a specific owner.
-
equipmentNumber: string
The number for the equipment. This attribute is marked as Create-Only.
-
equipmentOwnerIdentifier: string
The identifier of the equipment owner.
-
equipmentPrefix: string
The prefix of the equipment that was used for the shipment that relates to this invoice. This attribute is marked as Create-Only.
-
height:
height
The height of the equipment.
-
isoEquipmentTypeIdentifier: string
The ISO equipment type identifier.
-
length:
length
The length of the equipment.
-
links: array
links
Read Only:
true
-
maximumTemperature:
maximumTemperature
The maximum temperature for the equipment.
-
minimumTemperature:
minimumTemperature
The minimum temperature for the equipment.
-
ownershipCode: string
Ownership code.
-
percentHumidityAllowed: number
(int32)
The maximum percentage of humidity allowed for the equipment.
-
seals:
seals
-
seqNumber: number
(int64)
Read Only:
true
Internal database sequence number related to each invoice equipment entry. -
sEquipmentGid: string
The GID for the shipment equipment.
-
tareWeight:
tareWeight
Weight of equipment when empty.
-
unitCount: number
(int64)
Unit count.
-
ventSettingCode: string
The vent setting code.
-
volume:
volume
The volume of the equipment.
-
weight:
weight
The weight of the equipment.
-
weightAllowance:
weightAllowance
The regulatory maximum weight for the equipment.
-
weightQualifier: string
Weight qualifier.
-
width:
width
The width of the equipment.
Nested Schema : seals
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : weightAllowance
The regulatory maximum weight for the equipment.
Match All
Show Source
Nested Schema : amountType
Type:
Show Source
object
-
unit: string
Unit of measure
-
value: number
Numeric value that specifies an amount
Nested Schema : invoices.equipmentDetails.seals
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
sealNumber: string
The identification number for equipment that has been sealed.
-
sealSequence: number
(int32)
Seal sequence number.
Nested Schema : invoices.involvedParties
Type:
Show Source
object
-
comMethodGid: string
The communication method GID.
-
domainName: string
Database domain where this data is stored.
-
involvedPartyContactGid: string
The involved party contact GID.
-
involvedPartyQualGid: string
The GID for an involved party.
-
links: array
links
Read Only:
true
Nested Schema : invoices.lineItems
Type:
Show Source
object
-
accessorialCodeGid: string
The GID for an accessorial code.
-
accessorialDescription: string
Text to describe the accessorial.
-
adjustmentReasonCodeGid: string
The GID for the adjustment reason code used to specify why an adjustment was made to the line.
-
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)
-
attributeCurrency1:
attributeCurrency1
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeCurrency2:
attributeCurrency2
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeCurrency3:
attributeCurrency3
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
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 Date
-
attributeDate12:
attributeDate12
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate13:
attributeDate13
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate14:
attributeDate14
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate15:
attributeDate15
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate16:
attributeDate16
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate17:
attributeDate17
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate18:
attributeDate18
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate19:
attributeDate19
Attribute fields (flexfields) allow you to add additional information about an object. Data Type 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 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 NUMBER
-
attributeNumber12: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber13: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber14: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber15: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber16: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber17: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber18: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber19: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type 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 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
-
billableIndicatorGid: string
The indicator used to tell if this line item is billable (sell side bill only).
-
billedAsQualifier: string
Qualifier for Billed as quantity.
-
billedAsQuantity: number
(double)
Billed as quantity.
-
commercialDatas:
commercialDatas
-
compartmentIdCode: string
The identification number for the equipment's compartment for this line item.
-
costRefs:
costRefs
-
costTypeGid: string
The cost type for the invoice line.
-
declaredValue:
declaredValue
The stated value of this line item.
-
declaredValueQualGid: string
The declared value qualifier GID.
-
description: string
Text describing the line item on the invoice.
-
deviationAmount:
deviationAmount
The actual deviation in the tolerance amount based upon rule.
-
domainName: string
Database domain where this data is stored.
-
exchangeRateDate:
exchangeRateDate
Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.
-
exchangeRateGid: string
Indicates the set of exchange rates to use for currency conversions; if null, the default set should be used
-
exportLicControlCode: string
Export license control code.
-
exportLicCountryCode3Gid: string
The export license country code GID.
-
exportLicExpDate:
exportLicExpDate
The date on which the export license expires.
-
exportLicNumber: string
The identification number for the export license.
-
flexCommodityCode: string
Flex commodity code.
-
flexCommodityQualGid: string
The flexible commodity qualifier GID.
-
freightCharge:
freightCharge
The freight charge for this line item.
-
freightRateQualifier: string
The qualifier for the freight rate.
-
freightRateValue:
freightRateValue
Freight rate value.
-
generalLedgerGid: string
GL code for the invoice line item.
-
importLicExpDate:
importLicExpDate
The expiration date for the import license.
-
importLicIssueDate:
importLicIssueDate
The issue date for the import license.
-
importLicNumber: string
The import license number.
-
indicator: string
The invoice line item indicator.
-
lineitemSeqNo: number
(int32)
Line item sequence number. This attribute is marked as Create-Only.
-
links: array
links
Read Only:
true
-
marks: string
Marks.
-
marksQualifier: string
Qualifier for Marks.
-
matchStatus: string
Invoice line item status. UNMATCHED: It means the invoice line item has not been matched to any shipment cost. MATCHED: It means the invoice line item has been matched to shipment cost. MATCHED_IN_TOLERANCE: It means the invoice line item has been matched to shipment cost and passed the line level tolerance check. MATCHED_OUT_OF_TOLERANCE: It means the invoice line item has been matched to shipment cost and failed the line level tolerance check. UNMATCHED_IN_TOLERANCE: It means the invoice line item has not been matched to any shipment cost and it is within the tolerance limit. UNMATCHED_OUT_OF_TOLERANCE: It means the invoice line item has not been matched to any shipment cost and failed the line level tolerance check.
-
outOfTolAmt:
outOfTolAmt
The Out Of Tolerance Amount containing amount above or below the Payment Invoice Line approval tolerance allowable amount or percentage.
-
outOfTolReasonCodeGid: string
The GID for the out of tolerance amount reason code.
-
paymentMethodCodeGid: string
The GID for the method of payment for the invoice. Examples of payment include cash on delivery, check and electronic funds transfer.
-
prepaidAmount:
prepaidAmount
The amount that was already collected towards this invoice line item.
-
processAsFlowThru: boolean
Flag to identify this cost was processed as a flow thru and needs to be considered during adjustments.
-
refnums:
refnums
-
remarks:
remarks
-
tariffAgencyCode: string
The code for the tariff agency.
-
tariffEffectiveDate:
tariffEffectiveDate
The effective date of the tariff.
-
tariffFreightClassCode: string
The code for the tariff freight class.
-
tariffIssuingCarrierId: string
The identification number for the carrier that issued the tariff.
-
tariffItemNumber: string
Tariff item number.
-
tariffItemNumberSuffix: string
Tariff item number suffix.
-
tariffItemPart: string
Tariff item part.
-
tariffPubAuthority: string
Tariff Pub Authority.
-
tariffRefnum: string
Tariff reference number.
-
tariffRefnumQualifier: string
Tariff reference number qualifier.
-
tariffRefnumSuffix: string
Suffix for the tariff reference number.
-
tariffRegAgencyCode: string
Tariff Reg Agency.
-
tariffSection: string
Tariff section.
-
tariffSupplementId: string
Tariff supplement ID.
-
transportHandlingUnitGid: string
The GID for the transport handling unit associated with the invoice line item.
-
unitCount: number
(int64)
Unit count for that line.
-
vatCodeGid: string
Used by the invoice action to manually calculate VAT. This field is intended to be user entered (via UI or integration) so that a VAT code may be applied to an entire invoice line item easily without the user having to specify invoice line item VAT records. The system does not populate this field.
-
vats:
vats
-
volume:
volume
Total volume for line item.
-
vouchers:
vouchers
-
weight:
weight
Total weight for line item.
-
weightQualifier: string
Weight qualifier.
Nested Schema : attributeCurrency1
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
Match All
Show Source
Nested Schema : attributeCurrency2
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
Match All
Show Source
Nested Schema : attributeCurrency3
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
Match All
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 Date
Match All
Show Source
Nested Schema : attributeDate12
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate13
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate14
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate15
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate16
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate17
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate18
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate19
Attribute fields (flexfields) allow you to add additional information about an object. Data Type 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 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 : commercialDatas
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : costRefs
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : deviationAmount
The actual deviation in the tolerance amount based upon rule.
Match All
Show Source
Nested Schema : exchangeRateDate
Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.
Match All
Show Source
Nested Schema : exportLicExpDate
The date on which the export license expires.
Match All
Show Source
Nested Schema : outOfTolAmt
The Out Of Tolerance Amount containing amount above or below the Payment Invoice Line approval tolerance allowable amount or percentage.
Match All
Show Source
Nested Schema : prepaidAmount
The amount that was already collected towards this invoice line item.
Match All
Show Source
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 : vouchers
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : invoices.lineItems.commercialDatas
Type:
Show Source
object
-
commercialDataSeqNo: number
(int32)
Sequence number for the commercial data line.
-
domainName: string
Database domain where this data is stored.
-
exchangeRateDate:
exchangeRateDate
Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.
-
exchangeRateGid: string
Indicates the set of exchange rates to use for currency conversions; if null, the default set should be used
-
links: array
links
Read Only:
true
-
liTotalCommercialValue:
liTotalCommercialValue
Line item total commercial value.
-
packagingUnitGid: string
The GID for the packaging unit.
-
unitCount: number
(int64)
Unit count.
-
unitPrice:
unitPrice
The price for the units being shipped.
-
unitPriceQualifier: string
Qualifier for the unit price.
Nested Schema : exchangeRateDate
Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.
Match All
Show Source
Nested Schema : invoices.lineItems.costRefs
Type:
Show Source
object
-
costReferenceGid: string
The GID for the cost reference.
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
shipmentCostQualGid: string
The GID for the shipment cost qualifier.
Nested Schema : invoices.lineItems.refnums
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
invoiceLiRefnumQualGid: string
The invoice line item reference number qualifier GID.
-
links: array
links
Read Only:
true
-
referenceNumber: string
Line item reference number.
Nested Schema : invoices.lineItems.remarks
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
remarkQualIdentifier: string
Remark qualifier.
-
remarkSeqNo: number
(int64)
The sequence number for the line item remark on the invoice.
-
remarkText: string
Remarks about the line item on the invoice.
Nested Schema : invoices.lineItems.vats
Type:
Show Source
object
-
costRefs:
costRefs
-
domainName: string
Database domain where this data is stored.
-
exchangeRateDate:
exchangeRateDate
Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.
-
exchangeRateGid: string
Indicates the set of exchange rates to use for currency conversions; if null, the default set should be used.
-
isCumulative: boolean
If 'Y', the amount of this tax is based on the base cost plus the previously-calculated taxes.
-
links: array
links
Read Only:
true
-
vatAmount:
vatAmount
This is the actual VAT amount.
-
vatCalcAmt:
vatCalcAmt
This is the VAT amount calculated from the rate and base value.
-
vatCodeGid: string
The GID for the VAT tax that is being applied to the line item.
-
vatCountryCode3Gid: string
Country for which this VAT item applies
-
vatOverrideAmt:
vatOverrideAmt
This is a manually entered amount to set the VAT regardless of rate.
-
vatProvinceCode: string
Province for which this VAT item applies (used for Canada).
-
vatRate: number
(double)
The VAT charge rate.
-
vatSeqno: number
(int32)
The VAT Sequence number is used when more than one VAT is applicable to the line item. This field tells the system what order to charge the taxes in. This attribute is marked as Create-Only.
Nested Schema : costRefs
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : exchangeRateDate
Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.
Match All
Show Source
Nested Schema : vatCalcAmt
This is the VAT amount calculated from the rate and base value.
Match All
Show Source
Nested Schema : vatOverrideAmt
This is a manually entered amount to set the VAT regardless of rate.
Match All
Show Source
Nested Schema : invoices.lineItems.vats.costRefs
Type:
Show Source
object
-
costReferenceGid: string
The GID for the cost reference.
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
shipmentCostQualGid: string
The GID for the shipment cost reference.
-
vatAmount:
vatAmount
Monetary value of VAT for this cost reference item.
-
vatBasisAmount:
vatBasisAmount
Allocated basis on which VAT is calculated for this cost reference item.
Nested Schema : vatBasisAmount
Allocated basis on which VAT is calculated for this cost reference item.
Match All
Show Source
Nested Schema : invoices.lineItems.vouchers
Type:
Show Source
object
-
adjustmentReasonGid: string
The GID for the adjustment reason.
-
amountPaid:
amountPaid
Amount paid.
-
domainName: string
Database domain where this data is stored.
-
exchangeRateDate:
exchangeRateDate
Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.
-
exchangeRateGid: string
Indicates the set of exchange rates to use for currency conversions; if null, the default set should be used.
-
links: array
links
Read Only:
true
-
voucherGid: string
The GID for the voucher.
Nested Schema : exchangeRateDate
Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.
Match All
Show Source
Nested Schema : invoices.notes
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
enteredBy: string
The name and domain of the person who entered notes about the invoice.
-
invoiceNoteSeqNo: number
(int64)
The Invoice Note Sequence number specifies the order of notes on the invoice or bill.
-
isSystemGenerated: boolean
Indicates whether this is system generated or not.
-
links: array
links
Read Only:
true
-
note: string
The note(s) about the invoice.
-
summary: string
Summary.
-
timestamp:
timestamp
The day, month, and year of the note on the invoice.
Nested Schema : timestamp
The day, month, and year of the note on the invoice.
Match All
Show Source
Nested Schema : invoices.ports
Type:
Show Source
object
-
countryCode3Gid: string
The country code GID.
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
locationIdentifier: string
The location identifier.
-
locationIdentifierQualifier: string
The qualifier associated with the location identifier.
-
portFunctionCode: string
The port function code.
-
portName: string
The name of the port on the invoice.
-
portSeqNo: number
(int32)
The sequence number for the port on the invoice.
-
provinceCode: string
The province code on the invoice.
Nested Schema : invoices.protectiveServices
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
protSrvCode: string
Protective service code.
-
protSrvRuleCode: string
Protective service rule code.
-
protSrvSeqNo: number
(int32)
Protective service sequence number.
-
protSrvTemp:
protSrvTemp
Temperature requirement.
Nested Schema : invoices.refnums
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
invoiceRefnumQualGid: string
The GID for the reference number (PONUMBER, VATNUMBER, CUSTPONUMBER).
-
invoiceRefnumValue: string
Value of entered for the Reference Number Qualifier.
-
issueDate:
issueDate
The date the invoice was issued.
-
links: array
links
Read Only:
true
Nested Schema : invoices.remarks
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
remarkQualIdentifier: string
Remark qualifier.
-
remarkSeqNo: number
(int64)
A sequence number for a remark on an invoice.
-
remarkText: string
The text for the remark on an invoice.
Nested Schema : invoices.routes
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
intermodalServiceCode: string
Intermodal service code.
-
jctCityCode: string
Junction city code.
-
links: array
links
Read Only:
true
-
routeSeqNo: number
(int32)
The sequence number for the route on an invoice.
-
servprovAliasQualGid: string
The service provider alias qualifier GID.
-
servprovAliasValue: string
Service provider associated with the route.
-
transportModeIdentifier: string
The transport mode identifier.
Nested Schema : invoices.shipments
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
lineitemSeqNo: number
(int64)
Line item sequence number.
-
links: array
links
Read Only:
true
-
sequenceNo: number
(int64)
Sequence number.
-
shipGroupGid: string
This column is to generate invoice based on shipment group. Here the shipment group can have only one invoice associated to it.
-
shipmentGid: string
The GID for the shipment.
-
sShipUnitGid: string
The GID for the shipment ship unit.
-
sShipUnitLineNo: number
(int64)
The shipment ship unit line number.
-
trackingNumber: string
Tracking number
Nested Schema : invoices.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 status type on the invoice.
-
statusValueGid: string
The GID for the status value on the invoice.
Nested Schema : invoices.stops
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
endDate:
endDate
End date.
-
equipmentNumber: string
The equipment number on the invoice.
-
equipmentPrefix: string
Equipment prefix.
-
invoiceStopReasonGid: string
The invoice stop reason GID.
-
links: array
links
Read Only:
true
-
locationGid: string
The GID for the location on the invoice.
-
locationRefnum: string
A reference number for the location on the invoice.
-
locationRefnumQualGid: string
The location reference number qualifier GID.
-
refnums:
refnums
-
seals:
seals
-
startDate:
startDate
Start date.
-
stopSeqNo: string
Stop sequence number. This attribute is marked as Create-Only.
Nested Schema : refnums
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : seals
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : invoices.stops.refnums
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
invoiceStopRefnumQualGid: string
The invoice stop reference number qualifier GID.
-
links: array
links
Read Only:
true
-
referenceNumber: string
Reference number.
Nested Schema : invoices.stops.seals
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
sealNumber: string
The number of the seal that was placed on the piece of equipment.
-
sealSequence: number
(int32)
A one-up number to allow several seals being placed on a piece of equipment at the same stop.
Nested Schema : invoices.summaries
Type:
Show Source
object
-
commercialUnitPrice:
commercialUnitPrice
Commercial unit price.
-
domainName: string
Database domain where this data is stored.
-
exchangeRateDate:
exchangeRateDate
Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.
-
exchangeRateGid: string
Indicates the set of exchange rates to use for currency conversions; if null, the default set should be used.
-
freightCharge:
freightCharge
The total freight charge for the invoice.
-
invoiceServiceCodeGid: string
The type of service that was performed. Foreign key to INVOICE_SERVICE_CODE. Summary level charges on invoice for service level. This is generally for air and ground.
-
invoiceSummarySeqNo: number
(int32)
Sequence number for the invoice summary.
-
invoiceTotal: number
(int32)
The count of the invoice's line items.
-
links: array
links
Read Only:
true
-
prepaidAmount:
prepaidAmount
The dollar amount already paid on the invoice.
-
remarks:
remarks
-
transportHandlingUnitGid: string
The GID for the transport handling unit.
-
unitCount: number
(int64)
The number of units on the invoice.
-
volume:
volume
The total volume of items shipped for this invoice.
-
weight:
weight
The total weight of all items shipped on this invoice.
-
weightQualifier: string
Weight qualifier.
Nested Schema : exchangeRateDate
Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.
Match All
Show Source
Nested Schema : remarks
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : invoices.summaries.remarks
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
remarkQualIdentifier: string
The qualifier for the remark.
-
remarkSeqNo: number
(int64)
Read Only:
true
A sequence number for a remark on an invoice. -
remarkText: string
The text of the remarks on the invoice.
Nested Schema : invoices.summaryDetails
Type:
Show Source
object
-
accessorialCodeGid: string
The GID for the accessorial code on the invoice.
-
accessorialDescription: string
The text describing the accessorial on the invoice.
-
billedAsQualifier: string
Billed as qualifier.
-
billedAsQuantity:
billedAsQuantity
Billed as quantity.
-
declaredValue:
declaredValue
The declared value of all items on the invoice.
-
declaredValueQualGid: string
The declared value qualifier GID.
-
domainName: string
Database domain where this data is stored.
-
exchangeRateDate:
exchangeRateDate
Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.
-
exchangeRateGid: string
Indicates the set of exchange rates to use for currency conversions; if null, the default set should be used
-
freightCharge:
freightCharge
The total freight charge for shipping all items on the invoice.
-
freightRateQualifier: string
The freight rate qualifier.
-
freightRateQuantity:
freightRateQuantity
Freight rate quantity.
-
lineitemSeqNo: number
(int32)
The sequence number for the line item on the invoice. This attribute is marked as Create-Only.
-
links: array
links
Read Only:
true
-
packagingUnitGid: string
N/A
-
paymentMethodCodeGid: string
The GID for the payment method code.
-
prepaidAmount:
prepaidAmount
The dollar amount already paid on the invoice.
-
unitCount: number
(int64)
Unit count.
-
volume:
volume
The total volume of the items shipped on the invoice.
-
weight:
weight
The total weight of all items shipped on the invoice.
-
weightQualifier: string
Weight qualifier.
Nested Schema : exchangeRateDate
Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.
Match All
Show Source
Nested Schema : freightCharge
The total freight charge for shipping all items on the invoice.
Match All
Show Source
Nested Schema : invoices.supplyProvinceVatRegs
Type:
Show Source
object
-
countryCode3Gid: string
Country for the provincial registration.
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
provinceCode: string
Province of registration.
-
vatProvincialRegGid: string
The registration ID.
Nested Schema : invoices.texts
Type:
Show Source
object
-
documentDefGid: string
Document that should hold text.
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
textOverride: string
Transactional override for the template on the specific document.
-
textTemplateGid: string
The GID for the text template. A Text Template is a predefined, formatted selection of text that is identified by a business object. Use text templates to attach a short paragraph of text to a document, XML transmission, or notification (via XSL stylesheet).
Nested Schema : invoices.vatAnalyses
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
exchangeRateDate:
exchangeRateDate
Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.
-
exchangeRateGid: string
Indicates the set of exchange rates to use for currency conversions; if null, the default set should be used.
-
links: array
links
Read Only:
true
-
taxAmount:
taxAmount
Amount of tax.
-
vatBasisAmount:
vatBasisAmount
The portion of the invoice amount that will be taxed at the rate for the given VAT code
-
vatCodeGid: string
The GID for the vat code.
-
vatRate: number
(double)
The tax rate that the basis amount will be taxed.
Nested Schema : exchangeRateDate
Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.
Match All
Show Source
Nested Schema : vatBasisAmount
The portion of the invoice amount that will be taxed at the rate for the given VAT code
Match All
Show Source