Jump to

• Request
• Response

Get a VAT

get

/bills/{invoiceGid}/lineItems/{lineitemSeqNo}/vats/{vatSeqno}

Request

Path Parameters

• invoiceGid(required): string
  Resource ID
• lineitemSeqNo(required): string
  Resource ID
• vatSeqno(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 : bills.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.

{
    "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.",
            "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/bills.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/bills.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 bills.lineItems.vats.costRefs

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/bills.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 : bills.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 : links

Type: object

Show Source

• href: string
• rel: string

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

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 : 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"
        }
    }
}

Back to Top