Jump to

• Request
• Response

Get a Commercial Data

get

/bills/{invoiceGid}/lineItems/{lineitemSeqNo}/commercialData/{commercialDataSeqNo}

Request

Path Parameters

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

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.commercialData

Type: object

Show Source

• commercialDataSeqNo: number (int32)
  Sequence number for the commercial data line.
• 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
• liTotalCommercialValue: liTotalCommercialValue
  Line item total commercial value.
• packagingUnitGid: string
  The GID for the packaging unit.
• unitCount: number (int64)
  Unit count.
• unitPrice: unitPrice
  The price for the units being shipped.
• unitPriceQualifier: string
  Qualifier for the unit price.

{
    "properties":{
        "commercialDataSeqNo":{
            "description":"Sequence number for the commercial data line.",
            "type":"number",
            "format":"int32"
        },
        "unitPrice":{
            "description":"The price for the units being shipped.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "unitPriceQualifier":{
            "description":"Qualifier for the unit price.",
            "type":"string"
        },
        "liTotalCommercialValue":{
            "description":"Line item total commercial value.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "unitCount":{
            "description":"Unit count.",
            "type":"number",
            "format":"int64"
        },
        "packagingUnitGid":{
            "description":"The GID for the packaging unit.",
            "type":"string"
        },
        "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"
        },
        "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 : liTotalCommercialValue

Line item total commercial value.

Match All

Show Source

• object currencyType

{
    "description":"Line item total commercial value.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : unitPrice

The price for the units being shipped.

Match All

Show Source

• object currencyType

{
    "description":"The price for the units being shipped.",
    "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