Get Line Items
get
/bills/{invoiceGid}/lineItems
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.
-
limit: integer(int32)
Positive integer value that specifies the maximum number of items returned by the server.
-
offset: integer(int32)
Non-negative integer values that specifies the index of the first item to be returned. The offset index begins at 0. By default, the offset is 0, which returns all items starting from the first item in the collection.
-
orderBy: string
Comma-separated string of field names, each optionally followed by asc or desc, that specifies the order of items returned in the response payload.
-
q: string
Filter (a 'where'clause) to restrict the items returned in the collection. By default, no filtering is applied.
-
totalResults: boolean
Boolean value that specifies whether to calculate the totalResults property. By default, this value is set to false indicating that totalResults is not calculated.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/vnd.oracle.resource+json;type=collection
Default Response
Default Response.
Nested Schema : bills.lineItems
Type:
Show Source
object
-
accessorialCodeGid: string
The GID for an accessorial code.
-
accessorialDescription: string
Text to describe the accessorial.
-
adjustmentReasonCodeGid: string
The GID for the adjustment reason code used to specify why an adjustment was made to the line.
-
attribute1: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute10: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute11: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute12: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute13: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute14: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute15: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute16: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute17: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute18: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute19: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute2: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute20: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute3: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute4: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute5: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute6: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute7: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute8: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute9: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attributeCurrency1:
attributeCurrency1
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeCurrency2:
attributeCurrency2
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeCurrency3:
attributeCurrency3
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeDate1:
attributeDate1
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate10:
attributeDate10
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate11:
attributeDate11
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate12:
attributeDate12
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate13:
attributeDate13
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate14:
attributeDate14
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate15:
attributeDate15
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate16:
attributeDate16
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate17:
attributeDate17
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate18:
attributeDate18
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate19:
attributeDate19
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate2:
attributeDate2
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate20:
attributeDate20
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate3:
attributeDate3
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate4:
attributeDate4
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate5:
attributeDate5
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate6:
attributeDate6
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate7:
attributeDate7
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate8:
attributeDate8
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate9:
attributeDate9
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeNumber1: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber10: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber11: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber12: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber13: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber14: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber15: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber16: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber17: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber18: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber19: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber2: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber20: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber3: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber4: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber5: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber6: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber7: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber8: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber9: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
billableIndicatorGid: string
The indicator used to tell if this line item is billable (sell side bill only).
-
billedAsQualifier: string
Qualifier for Billed as quantity.
-
billedAsQuantity: number
(double)
Billed as quantity.
-
commercialData:
commercialData
-
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.
-
links: array
links
Read Only:
true
-
marks: string
Marks.
-
marksQualifier: string
Qualifier for Marks.
-
matchStatus: string
Invoice line item status. UNMATCHED: It means the invoice line item has not been matched to any shipment cost. MATCHED: It means the invoice line item has been matched to shipment cost. MATCHED_IN_TOLERANCE: It means the invoice line item has been matched to shipment cost and passed the line level tolerance check. MATCHED_OUT_OF_TOLERANCE: It means the invoice line item has been matched to shipment cost and failed the line level tolerance check. UNMATCHED_IN_TOLERANCE: It means the invoice line item has not been matched to any shipment cost and it is within the tolerance limit. UNMATCHED_OUT_OF_TOLERANCE: It means the invoice line item has not been matched to any shipment cost and failed the line level tolerance check.
-
outOfTolAmt:
outOfTolAmt
The Out Of Tolerance Amount containing amount above or below the Payment Invoice Line approval tolerance allowable amount or percentage.
-
outOfTolReasonCodeGid: string
The GID for the out of tolerance amount reason code.
-
paymentMethodCodeGid: string
The GID for the method of payment for the invoice. Examples of payment include cash on delivery, check and electronic funds transfer.
-
prepaidAmount:
prepaidAmount
The amount that was already collected towards this invoice line item.
-
processAsFlowThru: boolean
Flag to identify this cost was processed as a flow thru and needs to be considered during adjustments.
-
refnums:
refnums
-
remarks:
remarks
-
tariffAgencyCode: string
The code for the tariff agency.
-
tariffEffectiveDate:
tariffEffectiveDate
The effective date of the tariff.
-
tariffFreightClassCode: string
The code for the tariff freight class.
-
tariffIssuingCarrierId: string
The identification number for the carrier that issued the tariff.
-
tariffItemNumber: string
Tariff item number.
-
tariffItemNumberSuffix: string
Tariff item number suffix.
-
tariffItemPart: string
Tariff item part.
-
tariffPubAuthority: string
Tariff Pub Authority.
-
tariffRefnum: string
Tariff reference number.
-
tariffRefnumQualifier: string
Tariff reference number qualifier.
-
tariffRefnumSuffix: string
Suffix for the tariff reference number.
-
tariffRegAgencyCode: string
Tariff Reg Agency.
-
tariffSection: string
Tariff section.
-
tariffSupplementId: string
Tariff supplement ID.
-
transportHandlingUnitGid: string
The GID for the transport handling unit associated with the invoice line item.
-
unitCount: number
(int64)
Unit count for that line.
-
vatCodeGid: string
Used by the invoice action to manually calculate VAT. This field is intended to be user entered (via UI or integration) so that a VAT code may be applied to an entire invoice line item easily without the user having to specify invoice line item VAT records. The system does not populate this field.
-
vats:
vats
-
volume:
volume
Total volume for line item.
-
vouchers:
vouchers
-
weight:
weight
Total weight for line item.
-
weightQualifier: string
Weight qualifier.
Nested Schema : attributeCurrency1
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
Match All
Show Source
Nested Schema : attributeCurrency2
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
Match All
Show Source
Nested Schema : attributeCurrency3
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
Match All
Show Source
Nested Schema : attributeDate1
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate10
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate11
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate12
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate13
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate14
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate15
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate16
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate17
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate18
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate19
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate2
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate20
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate3
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate4
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate5
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate6
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate7
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate8
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate9
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : commercialData
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : costRefs
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : deviationAmount
The actual deviation in the tolerance amount based upon rule.
Match All
Show Source
Nested Schema : exchangeRateDate
Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.
Match All
Show Source
Nested Schema : exportLicExpDate
The date on which the export license expires.
Match All
Show Source
Nested Schema : outOfTolAmt
The Out Of Tolerance Amount containing amount above or below the Payment Invoice Line approval tolerance allowable amount or percentage.
Match All
Show Source
Nested Schema : prepaidAmount
The amount that was already collected towards this invoice line item.
Match All
Show Source
Nested Schema : refnums
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : remarks
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : vouchers
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : currencyType
Type:
Show Source
object
-
currency: string
ISO 4217 currency code
-
value: number
Numeric value that specifies a currency
Nested Schema : dateTimeType
Type:
Show Source
object
-
timezone: string
Timezone in Olson database format
-
value: string
(date-time)
Date in ISO 8601 format
Nested Schema : bills.lineItems.commercialData
Type:
Show Source
object
-
commercialDataSeqNo: number
(int32)
Sequence number for the commercial data line.
-
domainName: string
Database domain where this data is stored.
-
exchangeRateDate:
exchangeRateDate
Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.
-
exchangeRateGid: string
Indicates the set of exchange rates to use for currency conversions; if null, the default set should be used
-
links: array
links
Read Only:
true
-
liTotalCommercialValue:
liTotalCommercialValue
Line item total commercial value.
-
packagingUnitGid: string
The GID for the packaging unit.
-
unitCount: number
(int64)
Unit count.
-
unitPrice:
unitPrice
The price for the units being shipped.
-
unitPriceQualifier: string
Qualifier for the unit price.
Nested Schema : exchangeRateDate
Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.
Match All
Show Source
Nested Schema : bills.lineItems.costRefs
Type:
Show Source
object
-
costReferenceGid: string
The GID for the cost reference.
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
shipmentCostQualGid: string
The GID for the shipment cost qualifier.
Nested Schema : bills.lineItems.refnums
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
invoiceLiRefnumQualGid: string
The invoice line item reference number qualifier GID.
-
links: array
links
Read Only:
true
-
referenceNumber: string
Line item reference number.
Nested Schema : bills.lineItems.remarks
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
remarkQualIdentifier: string
Remark qualifier.
-
remarkSeqNo: number
(int64)
The sequence number for the line item remark on the invoice.
-
remarkText: string
Remarks about the line item on the invoice.
Nested Schema : bills.lineItems.vats
Type:
Show Source
object
-
costRefs:
costRefs
-
domainName: string
Database domain where this data is stored.
-
exchangeRateDate:
exchangeRateDate
Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.
-
exchangeRateGid: string
Indicates the set of exchange rates to use for currency conversions; if null, the default set should be used.
-
isCumulative: boolean
If 'Y', the amount of this tax is based on the base cost plus the previously-calculated taxes.
-
links: array
links
Read Only:
true
-
vatAmount:
vatAmount
This is the actual VAT amount.
-
vatCalcAmt:
vatCalcAmt
This is the VAT amount calculated from the rate and base value.
-
vatCodeGid: string
The GID for the VAT tax that is being applied to the line item.
-
vatCountryCode3Gid: string
Country for which this VAT item applies
-
vatOverrideAmt:
vatOverrideAmt
This is a manually entered amount to set the VAT regardless of rate.
-
vatProvinceCode: string
Province for which this VAT item applies (used for Canada).
-
vatRate: number
(double)
The VAT charge rate.
-
vatSeqno: number
(int32)
The VAT Sequence number is used when more than one VAT is applicable to the line item. This field tells the system what order to charge the taxes in.
Nested Schema : costRefs
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : exchangeRateDate
Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.
Match All
Show Source
Nested Schema : vatCalcAmt
This is the VAT amount calculated from the rate and base value.
Match All
Show Source
Nested Schema : vatOverrideAmt
This is a manually entered amount to set the VAT regardless of rate.
Match All
Show Source
Nested Schema : bills.lineItems.vats.costRefs
Type:
Show Source
object
-
costReferenceGid: string
The GID for the cost reference.
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
shipmentCostQualGid: string
The GID for the shipment cost reference.
-
vatAmount:
vatAmount
Monetary value of VAT for this cost reference item.
-
vatBasisAmount:
vatBasisAmount
Allocated basis on which VAT is calculated for this cost reference item.
Nested Schema : vatBasisAmount
Allocated basis on which VAT is calculated for this cost reference item.
Match All
Show Source
Nested Schema : amountType
Type:
Show Source
object
-
unit: string
Unit of measure
-
value: number
Numeric value that specifies an amount
Nested Schema : bills.lineItems.vouchers
Type:
Show Source
object
-
adjustmentReasonGid: string
The GID for the adjustment reason.
-
amountPaid:
amountPaid
Amount paid.
-
domainName: string
Database domain where this data is stored.
-
exchangeRateDate:
exchangeRateDate
Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.
-
exchangeRateGid: string
Indicates the set of exchange rates to use for currency conversions; if null, the default set should be used.
-
links: array
links
Read Only:
true
-
voucherGid: string
The GID for the voucher.
Nested Schema : exchangeRateDate
Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.
Match All
Show Source