Jump to

• Request
• Response

Get a VAT Analysis

get

/bills/{invoiceGid}/vatAnalyses/{vatCodeGid}

Request

Path Parameters

• invoiceGid(required): string
  Resource ID
• vatCodeGid(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.vatAnalyses

Type: object

Show Source

• 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
• taxAmount: taxAmount
  Amount of tax.
• vatBasisAmount: vatBasisAmount
  The portion of the invoice amount that will be taxed at the rate for the given VAT code
• vatCodeGid: string
  The GID for the vat code.
• vatRate: number (double)
  The tax rate that the basis amount will be taxed.

{
    "properties":{
        "vatCodeGid":{
            "description":"The GID for the vat code.",
            "type":"string"
        },
        "taxAmount":{
            "description":"Amount of tax.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "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"
        },
        "vatBasisAmount":{
            "description":"The portion of the invoice amount that will be taxed at the rate for the given VAT code",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "vatRate":{
            "description":"The tax rate that the basis amount will be taxed.",
            "type":"number",
            "format":"double"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "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 : taxAmount

Amount of tax.

Match All

Show Source

• object currencyType

{
    "description":"Amount of tax.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : vatBasisAmount

The portion of the invoice amount that will be taxed at the rate for the given VAT code

Match All

Show Source

• object currencyType

{
    "description":"The portion of the invoice amount that will be taxed at the rate for the given VAT code",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

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

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

Back to Top