Jump to

• Request
• Response

Get a Cost Reference

get

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

Request

Path Parameters

• costReferenceGid(required): string
  Resource ID
• 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.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"
        }
    }
}

Back to Top