Get Summary Details
get
/invoices/{invoiceGid}/summaryDetails
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 : invoices.summaryDetails
Type:
Show Source
object
-
accessorialCodeGid: string
The GID for the accessorial code on the invoice.
-
accessorialDescription: string
The text describing the accessorial on the invoice.
-
billedAsQualifier: string
Billed as qualifier.
-
billedAsQuantity:
billedAsQuantity
Billed as quantity.
-
declaredValue:
declaredValue
The declared value of all items on the invoice.
-
declaredValueQualGid: string
The declared value qualifier GID.
-
domainName: string
Database domain where this data is stored.
-
exchangeRateDate:
exchangeRateDate
Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.
-
exchangeRateGid: string
Indicates the set of exchange rates to use for currency conversions; if null, the default set should be used
-
freightCharge:
freightCharge
The total freight charge for shipping all items on the invoice.
-
freightRateQualifier: string
The freight rate qualifier.
-
freightRateQuantity:
freightRateQuantity
Freight rate quantity.
-
lineitemSeqNo: number
(int32)
The sequence number for the line item on the invoice. This attribute is marked as Create-Only.
-
links: array
links
Read Only:
true
-
packagingUnitGid: string
N/A
-
paymentMethodCodeGid: string
The GID for the payment method code.
-
prepaidAmount:
prepaidAmount
The dollar amount already paid on the invoice.
-
unitCount: number
(int64)
Unit count.
-
volume:
volume
The total volume of the items shipped on the invoice.
-
weight:
weight
The total weight of all items shipped on the invoice.
-
weightQualifier: string
Weight qualifier.
Nested Schema : exchangeRateDate
Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.
Match All
Show Source
Nested Schema : freightCharge
The total freight charge for shipping all items on the invoice.
Match All
Show Source
Nested Schema : currencyType
Type:
Show Source
object
-
currency: string
ISO 4217 currency code
-
value: number
Numeric value that specifies a currency
Nested Schema : amountType
Type:
Show Source
object
-
unit: string
Unit of measure
-
value: number
Numeric value that specifies an amount