Get Line Items

get

/bills/{invoiceGid}/lineItems

Request

Path Parameters
Query Parameters
  • 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.
  • Comma-delimited string of field names that you wanted returned in a GET request.
  • Positive integer value that specifies the maximum number of items returned by the server.
  • 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.
  • Comma-separated string of field names, each optionally followed by asc or desc, that specifies the order of items returned in the response payload.
  • Filter (a 'where'clause) to restrict the items returned in the collection. By default, no filtering is applied.
  • 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 Top

Response

Supported Media Types

Default Response

Default Response.
Body ()
Root Schema : schema
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : bills.lineItems
Type: object
Show Source
Nested Schema : attributeCurrency1
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
Match All
Show Source
Nested Schema : attributeCurrency2
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
Match All
Show Source
Nested Schema : attributeCurrency3
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
Match All
Show Source
Nested Schema : attributeDate1
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate10
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate11
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate12
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate13
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate14
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate15
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate16
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate17
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate18
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate19
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate2
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate20
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate3
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate4
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate5
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate6
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate7
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate8
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate9
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : commercialData
Type: object
Show Source
Nested Schema : costRefs
Type: object
Show Source
Nested Schema : declaredValue
The stated value of this line item.
Match All
Show Source
Nested Schema : deviationAmount
The actual deviation in the tolerance amount based upon rule.
Match All
Show Source
Nested Schema : exchangeRateDate
Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.
Match All
Show Source
Nested Schema : exportLicExpDate
The date on which the export license expires.
Match All
Show Source
Nested Schema : freightCharge
The freight charge for this line item.
Match All
Show Source
Nested Schema : freightRateValue
Freight rate value.
Match All
Show Source
Nested Schema : importLicExpDate
The expiration date for the import license.
Match All
Show Source
Nested Schema : importLicIssueDate
The issue date for the import license.
Match All
Show Source
Nested Schema : outOfTolAmt
The Out Of Tolerance Amount containing amount above or below the Payment Invoice Line approval tolerance allowable amount or percentage.
Match All
Show Source
Nested Schema : prepaidAmount
The amount that was already collected towards this invoice line item.
Match All
Show Source
Nested Schema : refnums
Type: object
Show Source
Nested Schema : remarks
Type: object
Show Source
Nested Schema : tariffEffectiveDate
The effective date of the tariff.
Match All
Show Source
Nested Schema : vats
Type: object
Show Source
Nested Schema : volume
Total volume for line item.
Match All
Show Source
Nested Schema : vouchers
Type: object
Show Source
Nested Schema : weight
Total weight for line item.
Match All
Show Source
Nested Schema : currencyType
Type: object
Show Source
Nested Schema : dateTimeType
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : bills.lineItems.commercialData
Type: object
Show Source
Nested Schema : exchangeRateDate
Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.
Match All
Show Source
Nested Schema : liTotalCommercialValue
Line item total commercial value.
Match All
Show Source
Nested Schema : unitPrice
The price for the units being shipped.
Match All
Show Source
Nested Schema : dateType
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : bills.lineItems.costRefs
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : bills.lineItems.refnums
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : bills.lineItems.remarks
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : bills.lineItems.vats
Type: object
Show Source
Nested Schema : costRefs
Type: object
Show Source
Nested Schema : exchangeRateDate
Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.
Match All
Show Source
Nested Schema : vatAmount
This is the actual VAT amount.
Match All
Show Source
Nested Schema : vatCalcAmt
This is the VAT amount calculated from the rate and base value.
Match All
Show Source
Nested Schema : vatOverrideAmt
This is a manually entered amount to set the VAT regardless of rate.
Match All
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : bills.lineItems.vats.costRefs
Type: object
Show Source
Nested Schema : vatAmount
Monetary value of VAT for this cost reference item.
Match All
Show Source
Nested Schema : vatBasisAmount
Allocated basis on which VAT is calculated for this cost reference item.
Match All
Show Source
Nested Schema : amountType
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : bills.lineItems.vouchers
Type: object
Show Source
Nested Schema : amountPaid
Amount paid.
Match All
Show Source
Nested Schema : exchangeRateDate
Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.
Match All
Show Source
Back to Top