Get VATs
get
/invoices/{invoiceGid}/lineItems/{lineitemSeqNo}/vats
Request
Path Parameters
-
invoiceGid(required): string
Resource ID
-
lineitemSeqNo(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.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. This attribute is marked as Create-Only.
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 : invoices.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 : currencyType
Type:
Show Source
object
-
currency: string
ISO 4217 currency code
-
value: number
Numeric value that specifies a currency