Jump to

• Request
• Response

Get an Invoice

get

/invoices/{invoiceGid}

Request

Path Parameters

• invoiceGid(required): string
  Resource ID

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.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/vnd.oracle.resource+json;type=singular

Default Response

Default Response.

Body ()

Root Schema : schema

Type: object

Show Source

• 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.

{
    "properties":{
        "invoiceGid":{
            "description":"The GID for the invoice.",
            "type":"string"
        },
        "invoiceXid":{
            "description":"The XID for the invoice.",
            "type":"string"
        },
        "invoiceType":{
            "description":"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').",
            "type":"string",
            "readOnly":true
        },
        "invoiceSource":{
            "description":"Valid values are G, I, M.",
            "type":"string",
            "readOnly":true
        },
        "enteredByGlUserGid":{
            "description":"Identifies which GL user entered the invoice into the system.",
            "type":"string"
        },
        "invoiceNumber":{
            "description":"Indicates the number that was assigned to the invoice.",
            "type":"string"
        },
        "servprovAliasQualGid":{
            "description":"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.",
            "type":"string"
        },
        "servprovAliasValue":{
            "description":"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.",
            "type":"string"
        },
        "correctionCodeId":{
            "description":"Correction code identifier.",
            "type":"string"
        },
        "invoiceDate":{
            "description":"The date of the invoice.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "currencyGid":{
            "description":"The GID for currency.",
            "type":"string"
        },
        "netAmountDue":{
            "description":"The net amount that is due for the invoice.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "netDueDate":{
            "description":"The date on which the net amount for the invoice is due.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "paymentMethodCodeGid":{
            "description":"The method of payment that is expected for the invoice. Examples include: check, cash on deliver, credit card and electronic funds transfer.",
            "type":"string"
        },
        "startDate":{
            "description":"The start range for which this invoice was generated.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "endDate":{
            "description":"The end range for which this invoice was generated.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "invoiceServiceCodeGid":{
            "description":"The type of service that was performed. Foreign key to INVOICE_SERVICE_CODE.",
            "type":"string"
        },
        "incoTermGid":{
            "description":"The terms of sale for this particular invoice.",
            "type":"string"
        },
        "discountAmount":{
            "description":"The total dollar amount of any discounts applied to the invoice.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "discountPercentage":{
            "description":"Either a specific amount for the discount or a percentage to be used for the discount.",
            "type":"number",
            "format":"double"
        },
        "discountDaysDue":{
            "description":"The number of days in the terms discount period by which payment is due if the terms of the discount are to be earned.",
            "type":"number",
            "format":"int32"
        },
        "discountDueDate":{
            "description":"The date that the payment must be made by in order for the discount to be earned.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "originStationCity":{
            "description":"The city in which the related shipment began.",
            "type":"string"
        },
        "originStationFsac":{
            "description":"The FSAC code for the station in which the related shipment began.",
            "type":"string"
        },
        "originStationSplc":{
            "description":"The SPLC code for the station in which the related shipment began.",
            "type":"string"
        },
        "originStationProvinceCode":{
            "description":"The province code in which the related shipment began.",
            "type":"string"
        },
        "originStationPostalCode":{
            "description":"The postal code in which the related shipment began.",
            "type":"string"
        },
        "originCountryCode3Gid":{
            "description":"The origin country code GID.",
            "type":"string"
        },
        "destStationCity":{
            "description":"The city in which the related shipment ends.",
            "type":"string"
        },
        "destStationFsac":{
            "description":"The FSAC code for the station in which the related shipment ended.",
            "type":"string"
        },
        "destStationSplc":{
            "description":"The SPLC code for the destination of the shipment which relates to this invoice.",
            "type":"string"
        },
        "destStationProvinceCode":{
            "description":"The province code in which the related shipment ended.",
            "type":"string"
        },
        "destStationPostalCode":{
            "description":"The postal code in which the related shipment ended.",
            "type":"string"
        },
        "destCountryCode3Gid":{
            "description":"The destination country code GID.",
            "type":"string"
        },
        "letterOfCreditExpDate":{
            "description":"The date until which the letter of credit is in effect. After this date, the letter of credit expires.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "letterOfCreditIssueDate":{
            "description":"The date that the letter of credit was issued.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "letterOfCreditNumber":{
            "description":"The identification number of the letter of credit.",
            "type":"string"
        },
        "vesselCodeQualifier":{
            "description":"The qualifier for the vessel.",
            "type":"string"
        },
        "vesselCode":{
            "description":"The vessel that was used for the shipment that relates to the invoice.",
            "type":"string"
        },
        "vesselCountryCode3Gid":{
            "description":"The vessel country code GID.",
            "type":"string"
        },
        "vesselGid":{
            "description":"Vessel ID for the invoice.",
            "type":"string"
        },
        "vesOpServprovAliasQualGid":{
            "description":"The vessel operator service provider alias qualifier GID.",
            "type":"string"
        },
        "vesOpServprovAliasValue":{
            "description":"Service provider alias of the vessel operator.",
            "type":"string"
        },
        "voyageNumber":{
            "description":"The number of the voyage that relates to the shipment for which this invoice is being created.",
            "type":"string"
        },
        "parentInvoiceGid":{
            "description":"The parent invoice GID.",
            "type":"string"
        },
        "dateReceived":{
            "description":"The date the invoice was received.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "supplyCountryCode3Gid":{
            "description":"The Supply Country Code ID represents the country that the goods are coming from.",
            "type":"string"
        },
        "servprovVatRegNoGid":{
            "description":"The service provider VAT Registration ID is the VAT tax ID for the service provider.",
            "type":"string"
        },
        "customerVatRegNoGid":{
            "description":"The Customer VAT Registration ID is the VAT tax ID for the customer. ",
            "type":"string"
        },
        "vatExemptValue":{
            "description":"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.",
            "type":"string"
        },
        "netAmtDueWithTax":{
            "description":"The Amount Due with VAT is the total amount due plus any applicable value added taxes (VAT).",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "isPassThrough":{
            "description":"The Pass Through check box allows to the invoice to be approved for payment without being matched to a shipment.",
            "type":"boolean"
        },
        "consolidationType":{
            "description":"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.",
            "type":"string"
        },
        "isFixedCost":{
            "description":"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.",
            "type":"boolean"
        },
        "baseCharge":{
            "description":"The Base Charge is the sum of the shipping charges for the invoice. ",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "otherCharge":{
            "description":"The Other Charge is the sum of the accessorial and other non-shipping charges for the invoice.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "isCreditNote":{
            "description":"Indicates if this invoice is a credit note",
            "type":"boolean"
        },
        "userDefined1IconGid":{
            "description":"Can store a user-defined icon that will appear within the user interface to help visually identify attributes of the invoice.",
            "type":"string"
        },
        "userDefined2IconGid":{
            "description":"Can store a user-defined icon that will appear within the user interface to help visually identify attributes of the invoice.",
            "type":"string"
        },
        "userDefined3IconGid":{
            "description":"Can store a user-defined icon that will appear within the user interface to help visually identify attributes of the invoice.",
            "type":"string"
        },
        "userDefined4IconGid":{
            "description":"Can store a user-defined icon that will appear within the user interface to help visually identify attributes of the invoice.",
            "type":"string"
        },
        "userDefined5IconGid":{
            "description":"Can store a user-defined icon that will appear within the user interface to help visually identify attributes of the invoice.",
            "type":"string"
        },
        "exchangeRateDate":{
            "description":"Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "exchangeRateGid":{
            "description":"Indicates the set of exchange rates to use for currency conversions; if null, the default set should be used",
            "type":"string"
        },
        "servprovGid":{
            "description":"The GID for the service provider. This attribute is marked as Create-Only.",
            "type":"string"
        },
        "sailDate":{
            "description":"The sail date is the date the vessel sails.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "sailCutoffDate":{
            "description":"The sail cutoff date is the latest date in which you can get your cargo onto the vessel.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "railDate":{
            "description":"The rail date is the date when a container gets put on rail car.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "isHazardous":{
            "description":"Indicator for identifying whether the invoiced shipment was or was not identified as carrying hazardous or dangerous goods. ",
            "type":"boolean"
        },
        "isTemperatureControl":{
            "description":"Indicator for identifying whether the invoiced shipment was or was not identified as requiring temperature control. ",
            "type":"boolean"
        },
        "invoicingProcess":{
            "description":"N/A",
            "type":"string"
        },
        "isVatAnalysisFixed":{
            "description":"Indicates if the VAT Analysis is fixed (user entered) and the system should not try to calculate it.",
            "type":"boolean"
        },
        "originalInvoiceGid":{
            "description":"For supplemental bills. This references the original bill.",
            "type":"string"
        },
        "glDate":{
            "description":"GL Date for the invoice as set by agent or manual action.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "attribute1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute11":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute12":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute13":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute14":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute15":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute16":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute17":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute18":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute19":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute20":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attributeNumber1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeDate1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeCurrency1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "attributeCurrency2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "attributeCurrency3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "attributeNumber11":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber12":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber13":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber14":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber15":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber16":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber17":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber18":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber19":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber20":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeDate11":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate12":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate13":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate14":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate15":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate16":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate17":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate18":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate19":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate20":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "invoiceRuleGid":{
            "description":"The rule ID used for generating this invoice/bill.",
            "type":"string"
        },
        "invConsConstraintSetGid":{
            "description":"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.",
            "type":"string"
        },
        "updateDate":{
            "description":"update date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "insertDate":{
            "description":"insert date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "protectiveServices":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/invoices.protectiveServices"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "stops":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/invoices.stops"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "ports":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/invoices.ports"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "lineItems":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/invoices.lineItems"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "involvedParties":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/invoices.involvedParties"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "vatAnalyses":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/invoices.vatAnalyses"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "remarks":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/invoices.remarks"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "texts":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/invoices.texts"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "equipmentDetails":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/invoices.equipmentDetails"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "routes":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/invoices.routes"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "shipments":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/invoices.shipments"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "supplyProvinceVatRegs":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/invoices.supplyProvinceVatRegs"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "notes":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/invoices.notes"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "summaries":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/invoices.summaries"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "refnums":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/invoices.refnums"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "summaryDetails":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/invoices.summaryDetails"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "statuses":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/invoices.statuses"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "documents":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/invoices.documents"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : attributeCurrency1

Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER

Match All

Show Source

• object currencyType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : attributeCurrency2

Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER

Match All

Show Source

• object currencyType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : attributeCurrency3

Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER

Match All

Show Source

• object currencyType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : attributeDate1

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate10

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate11

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate12

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate13

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate14

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate15

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate16

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate17

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate18

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate19

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate2

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate20

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate3

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate4

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate5

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate6

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate7

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate8

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate9

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : baseCharge

The Base Charge is the sum of the shipping charges for the invoice.

Match All

Show Source

• object currencyType

{
    "description":"The Base Charge is the sum of the shipping charges for the invoice. ",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : dateReceived

The date the invoice was received.

Match All

Show Source

• object dateTimeType

{
    "description":"The date the invoice was received.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : discountAmount

The total dollar amount of any discounts applied to the invoice.

Match All

Show Source

• object currencyType

{
    "description":"The total dollar amount of any discounts applied to the invoice.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : discountDueDate

The date that the payment must be made by in order for the discount to be earned.

Match All

Show Source

• object dateType

{
    "description":"The date that the payment must be made by in order for the discount to be earned.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : documents

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/invoices.documents"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : endDate

The end range for which this invoice was generated.

Match All

Show Source

• object dateTimeType

{
    "description":"The end range for which this invoice was generated.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : equipmentDetails

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/invoices.equipmentDetails"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":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

• object dateType

{
    "description":"Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : glDate

GL Date for the invoice as set by agent or manual action.

Match All

Show Source

• object dateType

{
    "description":"GL Date for the invoice as set by agent or manual action.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : insertDate

Read Only: true

insert date

Match All

Show Source

• object dateType

{
    "description":"insert date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ],
    "readOnly":true
}

Nested Schema : invoiceDate

The date of the invoice.

Match All

Show Source

• object dateTimeType

{
    "description":"The date of the invoice.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : involvedParties

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/invoices.involvedParties"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":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

• object dateType

{
    "description":"The date until which the letter of credit is in effect. After this date, the letter of credit expires.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : letterOfCreditIssueDate

The date that the letter of credit was issued.

Match All

Show Source

• object dateType

{
    "description":"The date that the letter of credit was issued.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : lineItems

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/invoices.lineItems"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : netAmountDue

The net amount that is due for the invoice.

Match All

Show Source

• object currencyType

{
    "description":"The net amount that is due for the invoice.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : netAmtDueWithTax

The Amount Due with VAT is the total amount due plus any applicable value added taxes (VAT).

Match All

Show Source

• object currencyType

{
    "description":"The Amount Due with VAT is the total amount due plus any applicable value added taxes (VAT).",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : netDueDate

The date on which the net amount for the invoice is due.

Match All

Show Source

• object dateTimeType

{
    "description":"The date on which the net amount for the invoice is due.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : notes

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/invoices.notes"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":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

• object currencyType

{
    "description":"The Other Charge is the sum of the accessorial and other non-shipping charges for the invoice.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : ports

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/invoices.ports"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : protectiveServices

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/invoices.protectiveServices"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : railDate

The rail date is the date when a container gets put on rail car.

Match All

Show Source

• object dateTimeType

{
    "description":"The rail date is the date when a container gets put on rail car.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : refnums

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/invoices.refnums"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : remarks

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/invoices.remarks"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : routes

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/invoices.routes"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":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

• object dateTimeType

{
    "description":"The sail cutoff date is the latest date in which you can get your cargo onto the vessel.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : sailDate

The sail date is the date the vessel sails.

Match All

Show Source

• object dateTimeType

{
    "description":"The sail date is the date the vessel sails.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : shipments

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/invoices.shipments"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : startDate

The start range for which this invoice was generated.

Match All

Show Source

• object dateTimeType

{
    "description":"The start range for which this invoice was generated.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : statuses

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/invoices.statuses"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : stops

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/invoices.stops"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : summaries

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/invoices.summaries"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : summaryDetails

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/invoices.summaryDetails"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : supplyProvinceVatRegs

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/invoices.supplyProvinceVatRegs"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : texts

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/invoices.texts"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : updateDate

Read Only: true

update date

Match All

Show Source

• object dateType

{
    "description":"update date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ],
    "readOnly":true
}

Nested Schema : vatAnalyses

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/invoices.vatAnalyses"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : currencyType

Type: object

Show Source

• currency: string
  ISO 4217 currency code
• value: number
  Numeric value that specifies a currency

{
    "properties":{
        "value":{
            "description":"Numeric value that specifies a currency",
            "type":"number"
        },
        "currency":{
            "description":"ISO 4217 currency code",
            "type":"string"
        }
    }
}

Nested Schema : dateTimeType

Type: object

Show Source

• timezone: string
  Timezone in Olson database format
• value: string (date-time)
  Date in ISO 8601 format

{
    "properties":{
        "value":{
            "description":"Date in ISO 8601 format",
            "type":"string",
            "format":"date-time"
        },
        "timezone":{
            "description":"Timezone in Olson database format",
            "type":"string"
        }
    }
}

Nested Schema : dateType

Type: object

Show Source

• value: string (date-time)
  Date in ISO 8601 format

{
    "properties":{
        "value":{
            "description":"Date in ISO 8601 format",
            "type":"string",
            "format":"date-time"
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object invoices.documents

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/invoices.documents"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : invoices.documents

Type: object

Show Source

• 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
  Represents the related document for consolidated/linked documents.
• 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.

{
    "properties":{
        "documentGid":{
            "description":"No description.",
            "type":"string"
        },
        "documentXid":{
            "description":"No description.",
            "type":"string"
        },
        "documentDefGid":{
            "description":"No description.",
            "type":"string"
        },
        "documentUrl":{
            "description":"No description.",
            "type":"string"
        },
        "documentType":{
            "description":"No description.",
            "type":"string"
        },
        "documentMimeType":{
            "description":"No description.",
            "type":"string"
        },
        "documentFilename":{
            "description":"No description.",
            "type":"string"
        },
        "ownerDataQueryTypeGid":{
            "description":"No description.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "reportGid":{
            "description":"The report associated with the document attachment, if content was generated by the report subsystem.",
            "type":"string"
        },
        "generatedAt":{
            "description":"If preparation, date/time content was last generated",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "uploadedAt":{
            "description":"If attachment, date/time content was last updated",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "documentTrackingNum":{
            "description":"No description.",
            "type":"string"
        },
        "documentCmsId":{
            "description":"A GUID to associate the document with content stored on its remote CMS. Valid when document_type=CMS.",
            "type":"string"
        },
        "contentManagementSystemGid":{
            "description":"No description.",
            "type":"string"
        },
        "usedAs":{
            "description":"Represents the classification of a document.(C/I/L/T)",
            "type":"string"
        },
        "relatedDocumentGid":{
            "description":"Represents the related document for consolidated/linked documents.",
            "type":"string"
        },
        "effectiveDate":{
            "description":"represents effective date for a document",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "expirationDate":{
            "description":"Represents expiration date for a document.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "userDefined1IconGid":{
            "description":"No description.",
            "type":"string"
        },
        "userDefined2IconGid":{
            "description":"No description.",
            "type":"string"
        },
        "userDefined3IconGid":{
            "description":"No description.",
            "type":"string"
        },
        "userDefined4IconGid":{
            "description":"No description.",
            "type":"string"
        },
        "userDefined5IconGid":{
            "description":"No description.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : effectiveDate

represents effective date for a document

Match All

Show Source

• object dateType

{
    "description":"represents effective date for a document",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : expirationDate

Represents expiration date for a document.

Match All

Show Source

• object dateType

{
    "description":"Represents expiration date for a document.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : generatedAt

If preparation, date/time content was last generated

Match All

Show Source

• object dateTimeType

{
    "description":"If preparation, date/time content was last generated",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : uploadedAt

If attachment, date/time content was last updated

Match All

Show Source

• object dateTimeType

{
    "description":"If attachment, date/time content was last updated",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : links

Type: object

Show Source

• href: string
• rel: string

{
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object invoices.equipmentDetails

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/invoices.equipmentDetails"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : invoices.equipmentDetails

Type: object

Show Source

• 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.

{
    "properties":{
        "seqNumber":{
            "description":"Internal database sequence number related to each invoice equipment entry.",
            "type":"number",
            "format":"int64",
            "readOnly":true
        },
        "equipmentInitialNumber":{
            "description":"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.",
            "type":"string"
        },
        "sEquipmentGid":{
            "description":"The GID for the shipment equipment.",
            "type":"string"
        },
        "equipmentPrefix":{
            "description":"The prefix of the equipment that was used for the shipment that relates to this invoice. This attribute is marked as Create-Only.",
            "type":"string"
        },
        "equipmentNumber":{
            "description":"The number for the equipment. This attribute is marked as Create-Only.",
            "type":"string"
        },
        "isoEquipmentTypeIdentifier":{
            "description":"The ISO equipment type identifier.",
            "type":"string"
        },
        "descriptionCode":{
            "description":"Description code.",
            "type":"string"
        },
        "equipmentOwnerIdentifier":{
            "description":"The identifier of the equipment owner.",
            "type":"string"
        },
        "ownershipCode":{
            "description":"Ownership code.",
            "type":"string"
        },
        "length":{
            "description":"The length of the equipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "width":{
            "description":"The width of the equipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "height":{
            "description":"The height of the equipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "weight":{
            "description":"The weight of the equipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "volume":{
            "description":"The volume of the equipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "tareWeight":{
            "description":"Weight of equipment when empty.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "dunnage":{
            "description":"Dunnage.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "unitCount":{
            "description":"Unit count.",
            "type":"number",
            "format":"int64"
        },
        "weightQualifier":{
            "description":"Weight qualifier.",
            "type":"string"
        },
        "minimumTemperature":{
            "description":"The minimum temperature for the equipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "maximumTemperature":{
            "description":"The maximum temperature for the equipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "percentHumidityAllowed":{
            "description":"The maximum percentage of humidity allowed for the equipment.",
            "type":"number",
            "format":"int32"
        },
        "ventSettingCode":{
            "description":"The vent setting code.",
            "type":"string"
        },
        "weightAllowance":{
            "description":"The regulatory maximum weight for the equipment.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "seals":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/invoices.equipmentDetails.seals"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : dunnage

Dunnage.

Match All

Show Source

• object amountType

{
    "description":"Dunnage.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : height

The height of the equipment.

Match All

Show Source

• object amountType

{
    "description":"The height of the equipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : length

The length of the equipment.

Match All

Show Source

• object amountType

{
    "description":"The length of the equipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : maximumTemperature

The maximum temperature for the equipment.

Match All

Show Source

• object amountType

{
    "description":"The maximum temperature for the equipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : minimumTemperature

The minimum temperature for the equipment.

Match All

Show Source

• object amountType

{
    "description":"The minimum temperature for the equipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : seals

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/invoices.equipmentDetails.seals"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : tareWeight

Weight of equipment when empty.

Match All

Show Source

• object amountType

{
    "description":"Weight of equipment when empty.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : volume

The volume of the equipment.

Match All

Show Source

• object amountType

{
    "description":"The volume of the equipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : weight

The weight of the equipment.

Match All

Show Source

• object amountType

{
    "description":"The weight of the equipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : weightAllowance

The regulatory maximum weight for the equipment.

Match All

Show Source

• object amountType

{
    "description":"The regulatory maximum weight for the equipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : width

The width of the equipment.

Match All

Show Source

• object amountType

{
    "description":"The width of the equipment.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : amountType

Type: object

Show Source

• unit: string
  Unit of measure
• value: number
  Numeric value that specifies an amount

{
    "properties":{
        "value":{
            "description":"Numeric value that specifies an amount",
            "type":"number"
        },
        "unit":{
            "description":"Unit of measure",
            "type":"string"
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object invoices.equipmentDetails.seals

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/invoices.equipmentDetails.seals"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : invoices.equipmentDetails.seals

Type: object

Show Source

• 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.

{
    "properties":{
        "sealSequence":{
            "description":"Seal sequence number.",
            "type":"number",
            "format":"int32"
        },
        "sealNumber":{
            "description":"The identification number for equipment that has been sealed.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object invoices.involvedParties

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/invoices.involvedParties"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : invoices.involvedParties

Type: object

Show Source

• 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

{
    "properties":{
        "involvedPartyQualGid":{
            "description":"The GID for an involved party.",
            "type":"string"
        },
        "involvedPartyContactGid":{
            "description":"The involved party contact GID.",
            "type":"string"
        },
        "comMethodGid":{
            "description":"The communication method GID.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object invoices.lineItems

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/invoices.lineItems"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : invoices.lineItems

Type: object

Show Source

• 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.

{
    "properties":{
        "lineitemSeqNo":{
            "description":"Line item sequence number. This attribute is marked as Create-Only.",
            "type":"number",
            "format":"int32"
        },
        "description":{
            "description":"Text describing the line item on the invoice.",
            "type":"string"
        },
        "unitCount":{
            "description":"Unit count for that line.",
            "type":"number",
            "format":"int64"
        },
        "transportHandlingUnitGid":{
            "description":"The GID for the transport handling unit associated with the invoice line item.",
            "type":"string"
        },
        "billableIndicatorGid":{
            "description":"The indicator used to tell if this line item is billable (sell side bill only).",
            "type":"string"
        },
        "flexCommodityQualGid":{
            "description":"The flexible commodity qualifier GID.",
            "type":"string"
        },
        "flexCommodityCode":{
            "description":"Flex commodity code.",
            "type":"string"
        },
        "weight":{
            "description":"Total weight for line item.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "volume":{
            "description":"Total volume for line item.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "weightQualifier":{
            "description":"Weight qualifier.",
            "type":"string"
        },
        "marks":{
            "description":"Marks.",
            "type":"string"
        },
        "marksQualifier":{
            "description":"Qualifier for Marks.",
            "type":"string"
        },
        "billedAsQualifier":{
            "description":"Qualifier for Billed as quantity.",
            "type":"string"
        },
        "billedAsQuantity":{
            "description":"Billed as quantity.",
            "type":"number",
            "format":"double"
        },
        "freightRateQualifier":{
            "description":"The qualifier for the freight rate.",
            "type":"string"
        },
        "freightRateValue":{
            "description":"Freight rate value.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "freightCharge":{
            "description":"The freight charge for this line item.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "prepaidAmount":{
            "description":"The amount that was already collected towards this invoice line item.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "paymentMethodCodeGid":{
            "description":"The GID for the method of payment for the invoice. Examples of payment include cash on delivery, check and electronic funds transfer.",
            "type":"string"
        },
        "accessorialCodeGid":{
            "description":"The GID for an accessorial code.",
            "type":"string"
        },
        "accessorialDescription":{
            "description":"Text to describe the accessorial.",
            "type":"string"
        },
        "compartmentIdCode":{
            "description":"The identification number for the equipment's compartment for this line item.",
            "type":"string"
        },
        "exportLicControlCode":{
            "description":"Export license control code.",
            "type":"string"
        },
        "exportLicCountryCode3Gid":{
            "description":"The export license country code GID.",
            "type":"string"
        },
        "exportLicExpDate":{
            "description":"The date on which the export license expires.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "exportLicNumber":{
            "description":"The identification number for the export license.",
            "type":"string"
        },
        "importLicExpDate":{
            "description":"The expiration date for the import license.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "importLicIssueDate":{
            "description":"The issue date for the import license.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "importLicNumber":{
            "description":"The import license number.",
            "type":"string"
        },
        "tariffAgencyCode":{
            "description":"The code for the tariff agency.",
            "type":"string"
        },
        "tariffRefnum":{
            "description":"Tariff reference number.",
            "type":"string"
        },
        "tariffRefnumQualifier":{
            "description":"Tariff reference number qualifier.",
            "type":"string"
        },
        "tariffRefnumSuffix":{
            "description":"Suffix for the tariff reference number.",
            "type":"string"
        },
        "tariffSection":{
            "description":"Tariff section.",
            "type":"string"
        },
        "tariffItemNumber":{
            "description":"Tariff item number.",
            "type":"string"
        },
        "tariffItemNumberSuffix":{
            "description":"Tariff item number suffix.",
            "type":"string"
        },
        "tariffItemPart":{
            "description":"Tariff item part.",
            "type":"string"
        },
        "tariffSupplementId":{
            "description":"Tariff supplement ID.",
            "type":"string"
        },
        "tariffRegAgencyCode":{
            "description":"Tariff Reg Agency.",
            "type":"string"
        },
        "tariffPubAuthority":{
            "description":"Tariff Pub Authority.",
            "type":"string"
        },
        "tariffIssuingCarrierId":{
            "description":"The identification number for the carrier that issued the tariff.",
            "type":"string"
        },
        "tariffFreightClassCode":{
            "description":"The code for the tariff freight class.",
            "type":"string"
        },
        "tariffEffectiveDate":{
            "description":"The effective date of the tariff.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "declaredValueQualGid":{
            "description":"The declared value qualifier GID.",
            "type":"string"
        },
        "declaredValue":{
            "description":"The stated value of this line item.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "adjustmentReasonCodeGid":{
            "description":"The GID for the adjustment reason code used to specify why an adjustment was made to the line.",
            "type":"string"
        },
        "processAsFlowThru":{
            "description":"Flag to identify this cost was processed as a flow thru and needs to be considered during adjustments.",
            "type":"boolean"
        },
        "generalLedgerGid":{
            "description":"GL code for the invoice line item.",
            "type":"string"
        },
        "exchangeRateDate":{
            "description":"Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "exchangeRateGid":{
            "description":"Indicates the set of exchange rates to use for currency conversions; if null, the default set should be used",
            "type":"string"
        },
        "vatCodeGid":{
            "description":"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.",
            "type":"string"
        },
        "costTypeGid":{
            "description":"The cost type for the invoice line.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "indicator":{
            "description":"The invoice line item indicator.",
            "type":"string"
        },
        "outOfTolAmt":{
            "description":"The Out Of Tolerance Amount containing amount above or below the Payment Invoice Line approval tolerance allowable amount or percentage.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "outOfTolReasonCodeGid":{
            "description":"The GID for the out of tolerance amount reason code.",
            "type":"string"
        },
        "deviationAmount":{
            "description":"The actual deviation in the tolerance amount based upon rule.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "attribute1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute11":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute12":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute13":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute14":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute15":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute16":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute17":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute18":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute19":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attribute20":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)",
            "type":"string"
        },
        "attributeNumber1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeDate1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate4":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate5":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate6":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate7":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate8":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate9":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate10":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeCurrency1":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "attributeCurrency2":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "attributeCurrency3":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "attributeNumber11":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber12":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber13":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber14":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber15":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber16":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber17":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber18":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber19":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeNumber20":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
            "type":"number",
            "format":"double"
        },
        "attributeDate11":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate12":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate13":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate14":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate15":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate16":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate17":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate18":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate19":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "attributeDate20":{
            "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "matchStatus":{
            "description":"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. ",
            "type":"string"
        },
        "vats":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/invoices.lineItems.vats"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "costRefs":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/invoices.lineItems.costRefs"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "remarks":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/invoices.lineItems.remarks"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "commercialDatas":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/invoices.lineItems.commercialDatas"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "refnums":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/invoices.lineItems.refnums"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "vouchers":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/invoices.lineItems.vouchers"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : attributeCurrency1

Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER

Match All

Show Source

• object currencyType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : attributeCurrency2

Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER

Match All

Show Source

• object currencyType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : attributeCurrency3

Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER

Match All

Show Source

• object currencyType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : attributeDate1

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate10

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate11

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate12

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate13

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate14

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate15

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate16

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate17

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate18

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate19

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate2

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate20

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate3

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate4

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate5

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate6

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate7

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate8

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : attributeDate9

Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date

Match All

Show Source

• object dateTimeType

{
    "description":"Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : commercialDatas

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/invoices.lineItems.commercialDatas"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : costRefs

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/invoices.lineItems.costRefs"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : declaredValue

The stated value of this line item.

Match All

Show Source

• object currencyType

{
    "description":"The stated value of this line item.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : deviationAmount

The actual deviation in the tolerance amount based upon rule.

Match All

Show Source

• object currencyType

{
    "description":"The actual deviation in the tolerance amount based upon rule.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

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

• object dateType

{
    "description":"Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : exportLicExpDate

The date on which the export license expires.

Match All

Show Source

• object dateType

{
    "description":"The date on which the export license expires.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : freightCharge

The freight charge for this line item.

Match All

Show Source

• object currencyType

{
    "description":"The freight charge for this line item.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : freightRateValue

Freight rate value.

Match All

Show Source

• object currencyType

{
    "description":"Freight rate value.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : importLicExpDate

The expiration date for the import license.

Match All

Show Source

• object dateType

{
    "description":"The expiration date for the import license.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : importLicIssueDate

The issue date for the import license.

Match All

Show Source

• object dateType

{
    "description":"The issue date for the import license.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

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

• object currencyType

{
    "description":"The Out Of Tolerance Amount containing amount above or below the Payment Invoice Line approval tolerance allowable amount or percentage.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : prepaidAmount

The amount that was already collected towards this invoice line item.

Match All

Show Source

• object currencyType

{
    "description":"The amount that was already collected towards this invoice line item.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : refnums

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/invoices.lineItems.refnums"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : remarks

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/invoices.lineItems.remarks"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : tariffEffectiveDate

The effective date of the tariff.

Match All

Show Source

• object dateType

{
    "description":"The effective date of the tariff.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : vats

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/invoices.lineItems.vats"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : volume

Total volume for line item.

Match All

Show Source

• object amountType

{
    "description":"Total volume for line item.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : vouchers

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/invoices.lineItems.vouchers"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : weight

Total weight for line item.

Match All

Show Source

• object amountType

{
    "description":"Total weight for line item.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object invoices.lineItems.commercialDatas

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/invoices.lineItems.commercialDatas"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : invoices.lineItems.commercialDatas

Type: object

Show Source

• 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.

{
    "properties":{
        "commercialDataSeqNo":{
            "description":"Sequence number for the commercial data line.",
            "type":"number",
            "format":"int32"
        },
        "unitPrice":{
            "description":"The price for the units being shipped.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "unitPriceQualifier":{
            "description":"Qualifier for the unit price.",
            "type":"string"
        },
        "liTotalCommercialValue":{
            "description":"Line item total commercial value.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "unitCount":{
            "description":"Unit count.",
            "type":"number",
            "format":"int64"
        },
        "packagingUnitGid":{
            "description":"The GID for the packaging unit.",
            "type":"string"
        },
        "exchangeRateDate":{
            "description":"Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "exchangeRateGid":{
            "description":"Indicates the set of exchange rates to use for currency conversions; if null, the default set should be used",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":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

• object dateType

{
    "description":"Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : liTotalCommercialValue

Line item total commercial value.

Match All

Show Source

• object currencyType

{
    "description":"Line item total commercial value.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : unitPrice

The price for the units being shipped.

Match All

Show Source

• object currencyType

{
    "description":"The price for the units being shipped.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object invoices.lineItems.costRefs

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/invoices.lineItems.costRefs"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : invoices.lineItems.costRefs

Type: object

Show Source

• 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.

{
    "properties":{
        "costReferenceGid":{
            "description":"The GID for the cost reference.",
            "type":"string"
        },
        "shipmentCostQualGid":{
            "description":"The GID for the shipment cost qualifier.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object invoices.lineItems.refnums

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/invoices.lineItems.refnums"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : invoices.lineItems.refnums

Type: object

Show Source

• 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.

{
    "properties":{
        "invoiceLiRefnumQualGid":{
            "description":"The invoice line item reference number qualifier GID.",
            "type":"string"
        },
        "referenceNumber":{
            "description":"Line item reference number.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object invoices.lineItems.remarks

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/invoices.lineItems.remarks"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : invoices.lineItems.remarks

Type: object

Show Source

• 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.

{
    "properties":{
        "remarkSeqNo":{
            "description":"The sequence number for the line item remark on the invoice.",
            "type":"number",
            "format":"int64"
        },
        "remarkQualIdentifier":{
            "description":"Remark qualifier.",
            "type":"string"
        },
        "remarkText":{
            "description":"Remarks about the line item on the invoice.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object invoices.lineItems.vats

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/invoices.lineItems.vats"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : invoices.lineItems.vats

Type: object

Show Source

• 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.

{
    "properties":{
        "vatSeqno":{
            "description":"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.",
            "type":"number",
            "format":"int32"
        },
        "vatCodeGid":{
            "description":"The GID for the VAT tax that is being applied to the line item.",
            "type":"string"
        },
        "vatCountryCode3Gid":{
            "description":"Country for which this VAT item applies",
            "type":"string"
        },
        "vatProvinceCode":{
            "description":"Province for which this VAT item applies (used for Canada).",
            "type":"string"
        },
        "vatRate":{
            "description":"The VAT charge rate.",
            "type":"number",
            "format":"double"
        },
        "vatAmount":{
            "description":"This is the actual VAT amount.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "vatCalcAmt":{
            "description":"This is the VAT amount calculated from the rate and base value.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "vatOverrideAmt":{
            "description":"This is a manually entered amount to set the VAT regardless of rate.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "isCumulative":{
            "description":"If 'Y', the amount of this tax is based on the base cost plus the previously-calculated taxes.",
            "type":"boolean"
        },
        "exchangeRateDate":{
            "description":"Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "exchangeRateGid":{
            "description":"Indicates the set of exchange rates to use for currency conversions; if null, the default set should be used.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "costRefs":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/invoices.lineItems.vats.costRefs"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : costRefs

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/invoices.lineItems.vats.costRefs"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":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

• object dateType

{
    "description":"Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : vatAmount

This is the actual VAT amount.

Match All

Show Source

• object currencyType

{
    "description":"This is the actual VAT amount.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : vatCalcAmt

This is the VAT amount calculated from the rate and base value.

Match All

Show Source

• object currencyType

{
    "description":"This is the VAT amount calculated from the rate and base value.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : vatOverrideAmt

This is a manually entered amount to set the VAT regardless of rate.

Match All

Show Source

• object currencyType

{
    "description":"This is a manually entered amount to set the VAT regardless of rate.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object invoices.lineItems.vats.costRefs

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/invoices.lineItems.vats.costRefs"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : invoices.lineItems.vats.costRefs

Type: object

Show Source

• 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.

{
    "properties":{
        "costReferenceGid":{
            "description":"The GID for the cost reference.",
            "type":"string"
        },
        "shipmentCostQualGid":{
            "description":"The GID for the shipment cost reference.",
            "type":"string"
        },
        "vatBasisAmount":{
            "description":"Allocated basis on which VAT is calculated for this cost reference item.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "vatAmount":{
            "description":"Monetary value of VAT for this cost reference item.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : vatAmount

Monetary value of VAT for this cost reference item.

Match All

Show Source

• object currencyType

{
    "description":"Monetary value of VAT for this cost reference item.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : vatBasisAmount

Allocated basis on which VAT is calculated for this cost reference item.

Match All

Show Source

• object currencyType

{
    "description":"Allocated basis on which VAT is calculated for this cost reference item.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object invoices.lineItems.vouchers

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/invoices.lineItems.vouchers"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : invoices.lineItems.vouchers

Type: object

Show Source

• 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.

{
    "properties":{
        "voucherGid":{
            "description":"The GID for the voucher.",
            "type":"string"
        },
        "amountPaid":{
            "description":"Amount paid.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "adjustmentReasonGid":{
            "description":"The GID for the adjustment reason.",
            "type":"string"
        },
        "exchangeRateDate":{
            "description":"Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "exchangeRateGid":{
            "description":"Indicates the set of exchange rates to use for currency conversions; if null, the default set should be used.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : amountPaid

Amount paid.

Match All

Show Source

• object currencyType

{
    "description":"Amount paid.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

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

• object dateType

{
    "description":"Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object invoices.notes

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/invoices.notes"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : invoices.notes

Type: object

Show Source

• 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.

{
    "properties":{
        "invoiceNoteSeqNo":{
            "description":"The Invoice Note Sequence number specifies the order of notes on the invoice or bill.",
            "type":"number",
            "format":"int64"
        },
        "timestamp":{
            "description":"The day, month, and year of the note on the invoice.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "summary":{
            "description":"Summary.",
            "type":"string"
        },
        "note":{
            "description":"The note(s) about the invoice.",
            "type":"string"
        },
        "isSystemGenerated":{
            "description":"Indicates whether this is system generated or not.",
            "type":"boolean"
        },
        "enteredBy":{
            "description":"The name and domain of the person who entered notes about the invoice.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : timestamp

The day, month, and year of the note on the invoice.

Match All

Show Source

• object dateTimeType

{
    "description":"The day, month, and year of the note on the invoice.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object invoices.ports

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/invoices.ports"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : invoices.ports

Type: object

Show Source

• 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.

{
    "properties":{
        "portSeqNo":{
            "description":"The sequence number for the port on the invoice.",
            "type":"number",
            "format":"int32"
        },
        "portFunctionCode":{
            "description":"The port function code.",
            "type":"string"
        },
        "locationIdentifier":{
            "description":"The location identifier.",
            "type":"string"
        },
        "locationIdentifierQualifier":{
            "description":"The qualifier associated with the location identifier.",
            "type":"string"
        },
        "portName":{
            "description":"The name of the port on the invoice.",
            "type":"string"
        },
        "provinceCode":{
            "description":"The province code on the invoice.",
            "type":"string"
        },
        "countryCode3Gid":{
            "description":"The country code GID.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object invoices.protectiveServices

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/invoices.protectiveServices"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : invoices.protectiveServices

Type: object

Show Source

• 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.

{
    "properties":{
        "protSrvSeqNo":{
            "description":"Protective service sequence number.",
            "type":"number",
            "format":"int32"
        },
        "protSrvCode":{
            "description":"Protective service code.",
            "type":"string"
        },
        "protSrvRuleCode":{
            "description":"Protective service rule code.",
            "type":"string"
        },
        "protSrvTemp":{
            "description":"Temperature requirement.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : protSrvTemp

Temperature requirement.

Match All

Show Source

• object amountType

{
    "description":"Temperature requirement.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object invoices.refnums

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/invoices.refnums"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : invoices.refnums

Type: object

Show Source

• 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

{
    "properties":{
        "invoiceRefnumQualGid":{
            "description":"The GID for the reference number (PONUMBER, VATNUMBER, CUSTPONUMBER).",
            "type":"string"
        },
        "invoiceRefnumValue":{
            "description":"Value of entered for the Reference Number Qualifier.",
            "type":"string"
        },
        "issueDate":{
            "description":"The date the invoice was issued.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : issueDate

The date the invoice was issued.

Match All

Show Source

• object dateType

{
    "description":"The date the invoice was issued.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object invoices.remarks

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/invoices.remarks"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : invoices.remarks

Type: object

Show Source

• 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.

{
    "properties":{
        "remarkSeqNo":{
            "description":"A sequence number for a remark on an invoice.",
            "type":"number",
            "format":"int64"
        },
        "remarkQualIdentifier":{
            "description":"Remark qualifier.",
            "type":"string"
        },
        "remarkText":{
            "description":"The text for the remark on an invoice.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object invoices.routes

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/invoices.routes"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : invoices.routes

Type: object

Show Source

• 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.

{
    "properties":{
        "routeSeqNo":{
            "description":"The sequence number for the route on an invoice.",
            "type":"number",
            "format":"int32"
        },
        "transportModeIdentifier":{
            "description":"The transport mode identifier.",
            "type":"string"
        },
        "servprovAliasQualGid":{
            "description":"The service provider alias qualifier GID.",
            "type":"string"
        },
        "servprovAliasValue":{
            "description":"Service provider associated with the route.",
            "type":"string"
        },
        "intermodalServiceCode":{
            "description":"Intermodal service code.",
            "type":"string"
        },
        "jctCityCode":{
            "description":"Junction city code.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object invoices.shipments

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/invoices.shipments"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : invoices.shipments

Type: object

Show Source

• 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

{
    "properties":{
        "sequenceNo":{
            "description":"Sequence number.",
            "type":"number",
            "format":"int64"
        },
        "shipmentGid":{
            "description":"The GID for the shipment.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "sShipUnitGid":{
            "description":"The GID for the shipment ship unit.",
            "type":"string"
        },
        "sShipUnitLineNo":{
            "description":"The shipment ship unit line number.",
            "type":"number",
            "format":"int64"
        },
        "trackingNumber":{
            "description":"Tracking number",
            "type":"string"
        },
        "lineitemSeqNo":{
            "description":"Line item sequence number.",
            "type":"number",
            "format":"int64"
        },
        "shipGroupGid":{
            "description":"This column is to generate invoice based on shipment group. Here the shipment group can have only one  invoice associated to it.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object invoices.statuses

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/invoices.statuses"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : invoices.statuses

Type: object

Show Source

• 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.

{
    "properties":{
        "statusTypeGid":{
            "description":"The GID for the status type on the invoice.",
            "type":"string"
        },
        "statusValueGid":{
            "description":"The GID for the status value on the invoice.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object invoices.stops

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/invoices.stops"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : invoices.stops

Type: object

Show Source

• 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.

{
    "properties":{
        "stopSeqNo":{
            "description":"Stop sequence number. This attribute is marked as Create-Only.",
            "type":"string"
        },
        "locationGid":{
            "description":"The GID for the location on the invoice.",
            "type":"string"
        },
        "locationRefnumQualGid":{
            "description":"The location reference number qualifier GID.",
            "type":"string"
        },
        "locationRefnum":{
            "description":"A reference number for the location on the invoice.",
            "type":"string"
        },
        "invoiceStopReasonGid":{
            "description":"The invoice stop reason GID.",
            "type":"string"
        },
        "equipmentPrefix":{
            "description":"Equipment prefix.",
            "type":"string"
        },
        "equipmentNumber":{
            "description":"The equipment number on the invoice.",
            "type":"string"
        },
        "startDate":{
            "description":"Start date.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "endDate":{
            "description":"End date.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "seals":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/invoices.stops.seals"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "refnums":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/invoices.stops.refnums"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : endDate

End date.

Match All

Show Source

• object dateTimeType

{
    "description":"End date.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : refnums

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/invoices.stops.refnums"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : seals

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/invoices.stops.seals"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : startDate

Start date.

Match All

Show Source

• object dateTimeType

{
    "description":"Start date.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object invoices.stops.refnums

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/invoices.stops.refnums"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : invoices.stops.refnums

Type: object

Show Source

• 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.

{
    "properties":{
        "invoiceStopRefnumQualGid":{
            "description":"The invoice stop reference number qualifier GID.",
            "type":"string"
        },
        "referenceNumber":{
            "description":"Reference number.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object invoices.stops.seals

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/invoices.stops.seals"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : invoices.stops.seals

Type: object

Show Source

• 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.

{
    "properties":{
        "sealSequence":{
            "description":"A one-up number to allow several seals being placed on a piece of equipment at the same stop.",
            "type":"number",
            "format":"int32"
        },
        "sealNumber":{
            "description":"The number of the seal that was placed on the piece of equipment.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object invoices.summaries

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/invoices.summaries"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : invoices.summaries

Type: object

Show Source

• 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.

{
    "properties":{
        "invoiceSummarySeqNo":{
            "description":"Sequence number for the invoice summary.",
            "type":"number",
            "format":"int32"
        },
        "freightCharge":{
            "description":"The total freight charge for the invoice.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "prepaidAmount":{
            "description":"The dollar amount already paid on the invoice.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "commercialUnitPrice":{
            "description":"Commercial unit price.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "unitCount":{
            "description":"The number of units on the invoice.",
            "type":"number",
            "format":"int64"
        },
        "transportHandlingUnitGid":{
            "description":"The GID for the transport handling unit.",
            "type":"string"
        },
        "weight":{
            "description":"The total weight of all items shipped on this invoice.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "volume":{
            "description":"The total volume of items shipped for this invoice.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "weightQualifier":{
            "description":"Weight qualifier.",
            "type":"string"
        },
        "invoiceTotal":{
            "description":"The count of the invoice's line items.",
            "type":"number",
            "format":"int32"
        },
        "exchangeRateDate":{
            "description":"Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "exchangeRateGid":{
            "description":"Indicates the set of exchange rates to use for currency conversions; if null, the default set should be used.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "invoiceServiceCodeGid":{
            "description":"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.",
            "type":"string"
        },
        "remarks":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/invoices.summaries.remarks"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : commercialUnitPrice

Commercial unit price.

Match All

Show Source

• object currencyType

{
    "description":"Commercial unit price.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

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

• object dateType

{
    "description":"Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : freightCharge

The total freight charge for the invoice.

Match All

Show Source

• object currencyType

{
    "description":"The total freight charge for the invoice.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : prepaidAmount

The dollar amount already paid on the invoice.

Match All

Show Source

• object currencyType

{
    "description":"The dollar amount already paid on the invoice.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : remarks

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/invoices.summaries.remarks"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : volume

The total volume of items shipped for this invoice.

Match All

Show Source

• object amountType

{
    "description":"The total volume of items shipped for this invoice.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : weight

The total weight of all items shipped on this invoice.

Match All

Show Source

• object amountType

{
    "description":"The total weight of all items shipped on this invoice.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object invoices.summaries.remarks

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/invoices.summaries.remarks"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : invoices.summaries.remarks

Type: object

Show Source

• 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.

{
    "properties":{
        "remarkSeqNo":{
            "description":"A sequence number for a remark on an invoice.",
            "type":"number",
            "format":"int64",
            "readOnly":true
        },
        "remarkQualIdentifier":{
            "description":"The qualifier for the remark.",
            "type":"string"
        },
        "remarkText":{
            "description":"The text of the remarks on the invoice.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object invoices.summaryDetails

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/invoices.summaryDetails"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : invoices.summaryDetails

Type: object

Show Source

• 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.

{
    "properties":{
        "lineitemSeqNo":{
            "description":"The sequence number for the line item on the invoice. This attribute is marked as Create-Only.",
            "type":"number",
            "format":"int32"
        },
        "billedAsQualifier":{
            "description":"Billed as qualifier.",
            "type":"string"
        },
        "billedAsQuantity":{
            "description":"Billed as quantity.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "freightRateQualifier":{
            "description":"The freight rate qualifier.",
            "type":"string"
        },
        "freightRateQuantity":{
            "description":"Freight rate quantity.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "unitCount":{
            "description":"Unit count.",
            "type":"number",
            "format":"int64"
        },
        "packagingUnitGid":{
            "description":"N/A",
            "type":"string"
        },
        "weight":{
            "description":"The total weight of all items shipped on the invoice.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "volume":{
            "description":"The total volume of the items shipped on the invoice.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "weightQualifier":{
            "description":"Weight qualifier.",
            "type":"string"
        },
        "freightCharge":{
            "description":"The total freight charge for shipping all items on the invoice.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "prepaidAmount":{
            "description":"The dollar amount already paid on the invoice.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "paymentMethodCodeGid":{
            "description":"The GID for the payment method code.",
            "type":"string"
        },
        "accessorialCodeGid":{
            "description":"The GID for the accessorial code on the invoice.",
            "type":"string"
        },
        "accessorialDescription":{
            "description":"The text describing the accessorial on the invoice.",
            "type":"string"
        },
        "declaredValueQualGid":{
            "description":"The declared value qualifier GID.",
            "type":"string"
        },
        "declaredValue":{
            "description":"The declared value of all items on the invoice.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "exchangeRateDate":{
            "description":"Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "exchangeRateGid":{
            "description":"Indicates the set of exchange rates to use for currency conversions; if null, the default set should be used",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : billedAsQuantity

Billed as quantity.

Match All

Show Source

• object currencyType

{
    "description":"Billed as quantity.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : declaredValue

The declared value of all items on the invoice.

Match All

Show Source

• object currencyType

{
    "description":"The declared value of all items on the invoice.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

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

• object dateType

{
    "description":"Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : freightCharge

The total freight charge for shipping all items on the invoice.

Match All

Show Source

• object currencyType

{
    "description":"The total freight charge for shipping all items on the invoice.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : freightRateQuantity

Freight rate quantity.

Match All

Show Source

• object currencyType

{
    "description":"Freight rate quantity.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : prepaidAmount

The dollar amount already paid on the invoice.

Match All

Show Source

• object currencyType

{
    "description":"The dollar amount already paid on the invoice.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : volume

The total volume of the items shipped on the invoice.

Match All

Show Source

• object amountType

{
    "description":"The total volume of the items shipped on the invoice.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : weight

The total weight of all items shipped on the invoice.

Match All

Show Source

• object amountType

{
    "description":"The total weight of all items shipped on the invoice.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object invoices.supplyProvinceVatRegs

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/invoices.supplyProvinceVatRegs"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : invoices.supplyProvinceVatRegs

Type: object

Show Source

• 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.

{
    "properties":{
        "countryCode3Gid":{
            "description":"Country for the provincial registration.",
            "type":"string"
        },
        "provinceCode":{
            "description":"Province of registration.",
            "type":"string"
        },
        "vatProvincialRegGid":{
            "description":"The registration ID.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object invoices.texts

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/invoices.texts"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : invoices.texts

Type: object

Show Source

• 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).

{
    "properties":{
        "textTemplateGid":{
            "description":"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).",
            "type":"string"
        },
        "documentDefGid":{
            "description":"Document that should hold text.",
            "type":"string"
        },
        "textOverride":{
            "description":"Transactional override for the template on the specific document.",
            "type":"string"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object invoices.vatAnalyses

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/invoices.vatAnalyses"
    }
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : invoices.vatAnalyses

Type: object

Show Source

• 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.

{
    "properties":{
        "vatCodeGid":{
            "description":"The GID for the vat code.",
            "type":"string"
        },
        "taxAmount":{
            "description":"Amount of tax.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "exchangeRateDate":{
            "description":"Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "exchangeRateGid":{
            "description":"Indicates the set of exchange rates to use for currency conversions; if null, the default set should be used.",
            "type":"string"
        },
        "vatBasisAmount":{
            "description":"The portion of the invoice amount that will be taxed at the rate for the given VAT code",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "vatRate":{
            "description":"The tax rate that the basis amount will be taxed.",
            "type":"number",
            "format":"double"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":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

• object dateType

{
    "description":"Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : links

Type: array

Read Only: true

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    },
    "readOnly":true
}

Nested Schema : taxAmount

Amount of tax.

Match All

Show Source

• object currencyType

{
    "description":"Amount of tax.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

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

• object currencyType

{
    "description":"The portion of the invoice amount that will be taxed at the rate for the given VAT code",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Back to Top