Create an Invoice

post

/invoices

Request

Header Parameters
  • An optional header parameter that allows you to process the request asynchronously. Set the request header "Prefer" to "respond-async" for asynchronous processing. For synchronous processing, leave the parameter blank or do not define it.
Supported Media Types
Request Body - application/vnd.oracle.resource+json;type=singular ()
Root Schema : schema
Type: object
Show Source
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 : dateReceived
The date the invoice was received.
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: object
Show Source
Nested Schema : endDate
The end range for which this invoice was generated.
Match All
Show Source
Nested Schema : equipmentDetails
Type: object
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 : glDate
GL Date for the invoice as set by agent or manual action.
Match All
Show Source
Nested Schema : insertDate
Read Only: true
insert date
Match All
Show Source
Nested Schema : invoiceDate
The date of the invoice.
Match All
Show Source
Nested Schema : involvedParties
Type: object
Show Source
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: object
Show Source
Nested Schema : links
Type: array
Read Only: true
Show Source
Nested Schema : netAmountDue
The net amount that is due for the invoice.
Match All
Show Source
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: object
Show Source
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: object
Show Source
Nested Schema : protectiveServices
Type: object
Show Source
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: object
Show Source
Nested Schema : remarks
Type: object
Show Source
Nested Schema : routes
Type: object
Show Source
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 : sailDate
The sail date is the date the vessel sails.
Match All
Show Source
Nested Schema : shipments
Type: object
Show Source
Nested Schema : startDate
The start range for which this invoice was generated.
Match All
Show Source
Nested Schema : statuses
Type: object
Show Source
Nested Schema : stops
Type: object
Show Source
Nested Schema : summaries
Type: object
Show Source
Nested Schema : summaryDetails
Type: object
Show Source
Nested Schema : supplyProvinceVatRegs
Type: object
Show Source
Nested Schema : texts
Type: object
Show Source
Nested Schema : updateDate
Read Only: true
update date
Match All
Show Source
Nested Schema : vatAnalyses
Type: object
Show Source
Nested Schema : currencyType
Type: object
Show Source
Nested Schema : dateTimeType
Type: object
Show Source
Nested Schema : dateType
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : links
Type: array
Read Only: true
Show Source
Nested Schema : invoices.documents
Type: object
Show Source
Nested Schema : effectiveDate
represents effective date for a document
Match All
Show Source
Nested Schema : expirationDate
Represents expiration date for a document.
Match All
Show Source
Nested Schema : generatedAt
If preparation, date/time content was last generated
Match All
Show Source
Nested Schema : uploadedAt
If attachment, date/time content was last updated
Match All
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : links
Type: array
Read Only: true
Show Source
Nested Schema : invoices.equipmentDetails
Type: object
Show Source
Nested Schema : dunnage
Dunnage.
Match All
Show Source
Nested Schema : height
The height of the equipment.
Match All
Show Source
Nested Schema : length
The length of the equipment.
Match All
Show Source
Nested Schema : maximumTemperature
The maximum temperature for the equipment.
Match All
Show Source
Nested Schema : minimumTemperature
The minimum temperature for the equipment.
Match All
Show Source
Nested Schema : seals
Type: object
Show Source
Nested Schema : tareWeight
Weight of equipment when empty.
Match All
Show Source
Nested Schema : volume
The volume of the equipment.
Match All
Show Source
Nested Schema : weight
The weight of the equipment.
Match All
Show Source
Nested Schema : weightAllowance
The regulatory maximum weight for the equipment.
Match All
Show Source
Nested Schema : width
The width of the equipment.
Match All
Show Source
Nested Schema : amountType
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : invoices.equipmentDetails.seals
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : links
Type: array
Read Only: true
Show Source
Nested Schema : invoices.involvedParties
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : links
Type: array
Read Only: true
Show Source
Nested Schema : invoices.lineItems
Type: object
Show Source
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: object
Show Source
Nested Schema : costRefs
Type: object
Show Source
Nested Schema : declaredValue
The stated value of this line item.
Match All
Show Source
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 : freightCharge
The freight charge for this line item.
Match All
Show Source
Nested Schema : freightRateValue
Freight rate value.
Match All
Show Source
Nested Schema : importLicExpDate
The expiration date for the import license.
Match All
Show Source
Nested Schema : importLicIssueDate
The issue date for the import license.
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: object
Show Source
Nested Schema : remarks
Type: object
Show Source
Nested Schema : tariffEffectiveDate
The effective date of the tariff.
Match All
Show Source
Nested Schema : vats
Type: object
Show Source
Nested Schema : volume
Total volume for line item.
Match All
Show Source
Nested Schema : vouchers
Type: object
Show Source
Nested Schema : weight
Total weight for line item.
Match All
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : invoices.lineItems.commercialDatas
Type: object
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 : liTotalCommercialValue
Line item total commercial value.
Match All
Show Source
Nested Schema : unitPrice
The price for the units being shipped.
Match All
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : invoices.lineItems.costRefs
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : invoices.lineItems.refnums
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : invoices.lineItems.remarks
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : invoices.lineItems.vats
Type: object
Show Source
Nested Schema : costRefs
Type: object
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 : vatAmount
This is the actual VAT amount.
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 : items
Type: array
Show Source
Nested Schema : invoices.lineItems.vats.costRefs
Type: object
Show Source
Nested Schema : vatAmount
Monetary value of VAT for this cost reference item.
Match All
Show Source
Nested Schema : vatBasisAmount
Allocated basis on which VAT is calculated for this cost reference item.
Match All
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : invoices.lineItems.vouchers
Type: object
Show Source
Nested Schema : amountPaid
Amount paid.
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 : items
Type: array
Show Source
Nested Schema : links
Type: array
Read Only: true
Show Source
Nested Schema : invoices.notes
Type: object
Show Source
Nested Schema : timestamp
The day, month, and year of the note on the invoice.
Match All
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : links
Type: array
Read Only: true
Show Source
Nested Schema : invoices.ports
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : links
Type: array
Read Only: true
Show Source
Nested Schema : invoices.protectiveServices
Type: object
Show Source
Nested Schema : protSrvTemp
Temperature requirement.
Match All
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : links
Type: array
Read Only: true
Show Source
Nested Schema : invoices.refnums
Type: object
Show Source
Nested Schema : issueDate
The date the invoice was issued.
Match All
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : links
Type: array
Read Only: true
Show Source
Nested Schema : invoices.remarks
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : links
Type: array
Read Only: true
Show Source
Nested Schema : invoices.routes
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : links
Type: array
Read Only: true
Show Source
Nested Schema : invoices.shipments
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : links
Type: array
Read Only: true
Show Source
Nested Schema : invoices.statuses
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : links
Type: array
Read Only: true
Show Source
Nested Schema : invoices.stops
Type: object
Show Source
Nested Schema : endDate
End date.
Match All
Show Source
Nested Schema : refnums
Type: object
Show Source
Nested Schema : seals
Type: object
Show Source
Nested Schema : startDate
Start date.
Match All
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : invoices.stops.refnums
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : invoices.stops.seals
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : links
Type: array
Read Only: true
Show Source
Nested Schema : invoices.summaries
Type: object
Show Source
Nested Schema : commercialUnitPrice
Commercial unit price.
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 : freightCharge
The total freight charge for the invoice.
Match All
Show Source
Nested Schema : prepaidAmount
The dollar amount already paid on the invoice.
Match All
Show Source
Nested Schema : remarks
Type: object
Show Source
Nested Schema : volume
The total volume of items shipped for this invoice.
Match All
Show Source
Nested Schema : weight
The total weight of all items shipped on this invoice.
Match All
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : invoices.summaries.remarks
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : links
Type: array
Read Only: true
Show Source
Nested Schema : invoices.summaryDetails
Type: object
Show Source
Nested Schema : billedAsQuantity
Billed as quantity.
Match All
Show Source
Nested Schema : declaredValue
The declared value of all items on the invoice.
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 : freightCharge
The total freight charge for shipping all items on the invoice.
Match All
Show Source
Nested Schema : freightRateQuantity
Freight rate quantity.
Match All
Show Source
Nested Schema : prepaidAmount
The dollar amount already paid on the invoice.
Match All
Show Source
Nested Schema : volume
The total volume of the items shipped on the invoice.
Match All
Show Source
Nested Schema : weight
The total weight of all items shipped on the invoice.
Match All
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : links
Type: array
Read Only: true
Show Source
Nested Schema : invoices.supplyProvinceVatRegs
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : links
Type: array
Read Only: true
Show Source
Nested Schema : invoices.texts
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : links
Type: array
Read Only: true
Show Source
Nested Schema : invoices.vatAnalyses
Type: object
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 : taxAmount
Amount of tax.
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
Back to Top

Response

Supported Media Types

Default Response

Default Response.
Body ()
Root Schema : schema
Type: object
Show Source
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 : dateReceived
The date the invoice was received.
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: object
Show Source
Nested Schema : endDate
The end range for which this invoice was generated.
Match All
Show Source
Nested Schema : equipmentDetails
Type: object
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 : glDate
GL Date for the invoice as set by agent or manual action.
Match All
Show Source
Nested Schema : insertDate
Read Only: true
insert date
Match All
Show Source
Nested Schema : invoiceDate
The date of the invoice.
Match All
Show Source
Nested Schema : involvedParties
Type: object
Show Source
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: object
Show Source
Nested Schema : links
Type: array
Read Only: true
Show Source
Nested Schema : netAmountDue
The net amount that is due for the invoice.
Match All
Show Source
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: object
Show Source
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: object
Show Source
Nested Schema : protectiveServices
Type: object
Show Source
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: object
Show Source
Nested Schema : remarks
Type: object
Show Source
Nested Schema : routes
Type: object
Show Source
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 : sailDate
The sail date is the date the vessel sails.
Match All
Show Source
Nested Schema : shipments
Type: object
Show Source
Nested Schema : startDate
The start range for which this invoice was generated.
Match All
Show Source
Nested Schema : statuses
Type: object
Show Source
Nested Schema : stops
Type: object
Show Source
Nested Schema : summaries
Type: object
Show Source
Nested Schema : summaryDetails
Type: object
Show Source
Nested Schema : supplyProvinceVatRegs
Type: object
Show Source
Nested Schema : texts
Type: object
Show Source
Nested Schema : updateDate
Read Only: true
update date
Match All
Show Source
Nested Schema : vatAnalyses
Type: object
Show Source
Nested Schema : currencyType
Type: object
Show Source
Nested Schema : dateTimeType
Type: object
Show Source
Nested Schema : dateType
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : links
Type: array
Read Only: true
Show Source
Nested Schema : invoices.documents
Type: object
Show Source
Nested Schema : effectiveDate
represents effective date for a document
Match All
Show Source
Nested Schema : expirationDate
Represents expiration date for a document.
Match All
Show Source
Nested Schema : generatedAt
If preparation, date/time content was last generated
Match All
Show Source
Nested Schema : uploadedAt
If attachment, date/time content was last updated
Match All
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : links
Type: array
Read Only: true
Show Source
Nested Schema : invoices.equipmentDetails
Type: object
Show Source
Nested Schema : dunnage
Dunnage.
Match All
Show Source
Nested Schema : height
The height of the equipment.
Match All
Show Source
Nested Schema : length
The length of the equipment.
Match All
Show Source
Nested Schema : maximumTemperature
The maximum temperature for the equipment.
Match All
Show Source
Nested Schema : minimumTemperature
The minimum temperature for the equipment.
Match All
Show Source
Nested Schema : seals
Type: object
Show Source
Nested Schema : tareWeight
Weight of equipment when empty.
Match All
Show Source
Nested Schema : volume
The volume of the equipment.
Match All
Show Source
Nested Schema : weight
The weight of the equipment.
Match All
Show Source
Nested Schema : weightAllowance
The regulatory maximum weight for the equipment.
Match All
Show Source
Nested Schema : width
The width of the equipment.
Match All
Show Source
Nested Schema : amountType
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : invoices.equipmentDetails.seals
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : links
Type: array
Read Only: true
Show Source
Nested Schema : invoices.involvedParties
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : links
Type: array
Read Only: true
Show Source
Nested Schema : invoices.lineItems
Type: object
Show Source
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: object
Show Source
Nested Schema : costRefs
Type: object
Show Source
Nested Schema : declaredValue
The stated value of this line item.
Match All
Show Source
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 : freightCharge
The freight charge for this line item.
Match All
Show Source
Nested Schema : freightRateValue
Freight rate value.
Match All
Show Source
Nested Schema : importLicExpDate
The expiration date for the import license.
Match All
Show Source
Nested Schema : importLicIssueDate
The issue date for the import license.
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: object
Show Source
Nested Schema : remarks
Type: object
Show Source
Nested Schema : tariffEffectiveDate
The effective date of the tariff.
Match All
Show Source
Nested Schema : vats
Type: object
Show Source
Nested Schema : volume
Total volume for line item.
Match All
Show Source
Nested Schema : vouchers
Type: object
Show Source
Nested Schema : weight
Total weight for line item.
Match All
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : invoices.lineItems.commercialDatas
Type: object
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 : liTotalCommercialValue
Line item total commercial value.
Match All
Show Source
Nested Schema : unitPrice
The price for the units being shipped.
Match All
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : invoices.lineItems.costRefs
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : invoices.lineItems.refnums
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : invoices.lineItems.remarks
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : invoices.lineItems.vats
Type: object
Show Source
Nested Schema : costRefs
Type: object
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 : vatAmount
This is the actual VAT amount.
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 : items
Type: array
Show Source
Nested Schema : invoices.lineItems.vats.costRefs
Type: object
Show Source
Nested Schema : vatAmount
Monetary value of VAT for this cost reference item.
Match All
Show Source
Nested Schema : vatBasisAmount
Allocated basis on which VAT is calculated for this cost reference item.
Match All
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : invoices.lineItems.vouchers
Type: object
Show Source
Nested Schema : amountPaid
Amount paid.
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 : items
Type: array
Show Source
Nested Schema : links
Type: array
Read Only: true
Show Source
Nested Schema : invoices.notes
Type: object
Show Source
Nested Schema : timestamp
The day, month, and year of the note on the invoice.
Match All
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : links
Type: array
Read Only: true
Show Source
Nested Schema : invoices.ports
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : links
Type: array
Read Only: true
Show Source
Nested Schema : invoices.protectiveServices
Type: object
Show Source
Nested Schema : protSrvTemp
Temperature requirement.
Match All
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : links
Type: array
Read Only: true
Show Source
Nested Schema : invoices.refnums
Type: object
Show Source
Nested Schema : issueDate
The date the invoice was issued.
Match All
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : links
Type: array
Read Only: true
Show Source
Nested Schema : invoices.remarks
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : links
Type: array
Read Only: true
Show Source
Nested Schema : invoices.routes
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : links
Type: array
Read Only: true
Show Source
Nested Schema : invoices.shipments
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : links
Type: array
Read Only: true
Show Source
Nested Schema : invoices.statuses
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : links
Type: array
Read Only: true
Show Source
Nested Schema : invoices.stops
Type: object
Show Source
Nested Schema : endDate
End date.
Match All
Show Source
Nested Schema : refnums
Type: object
Show Source
Nested Schema : seals
Type: object
Show Source
Nested Schema : startDate
Start date.
Match All
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : invoices.stops.refnums
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : invoices.stops.seals
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : links
Type: array
Read Only: true
Show Source
Nested Schema : invoices.summaries
Type: object
Show Source
Nested Schema : commercialUnitPrice
Commercial unit price.
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 : freightCharge
The total freight charge for the invoice.
Match All
Show Source
Nested Schema : prepaidAmount
The dollar amount already paid on the invoice.
Match All
Show Source
Nested Schema : remarks
Type: object
Show Source
Nested Schema : volume
The total volume of items shipped for this invoice.
Match All
Show Source
Nested Schema : weight
The total weight of all items shipped on this invoice.
Match All
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : invoices.summaries.remarks
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : links
Type: array
Read Only: true
Show Source
Nested Schema : invoices.summaryDetails
Type: object
Show Source
Nested Schema : billedAsQuantity
Billed as quantity.
Match All
Show Source
Nested Schema : declaredValue
The declared value of all items on the invoice.
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 : freightCharge
The total freight charge for shipping all items on the invoice.
Match All
Show Source
Nested Schema : freightRateQuantity
Freight rate quantity.
Match All
Show Source
Nested Schema : prepaidAmount
The dollar amount already paid on the invoice.
Match All
Show Source
Nested Schema : volume
The total volume of the items shipped on the invoice.
Match All
Show Source
Nested Schema : weight
The total weight of all items shipped on the invoice.
Match All
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : links
Type: array
Read Only: true
Show Source
Nested Schema : invoices.supplyProvinceVatRegs
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : links
Type: array
Read Only: true
Show Source
Nested Schema : invoices.texts
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : links
Type: array
Read Only: true
Show Source
Nested Schema : invoices.vatAnalyses
Type: object
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 : taxAmount
Amount of tax.
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
Back to Top