Jump to

• Request
• Response

Get Summary Details

get

/bills/{invoiceGid}/summaryDetails

Request

Path Parameters

• invoiceGid(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 Top

Response

Supported Media Types

• application/vnd.oracle.resource+json;type=collection

Default Response

Default Response.

Body ()

Root Schema : schema

Type: object

Show Source

• items(required): array items
• links: array links

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/bills.summaryDetails"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            }
        }
    },
    "required":[
        "items"
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object bills.summaryDetails

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/bills.summaryDetails"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object links

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/links"
    }
}

Nested Schema : bills.summaryDetails

Type: object

Show Source

• accessorialCodeGid: string
  The GID for the accessorial code on the invoice.
• accessorialDescription: string
  The text describing the accessorial on the invoice.
• billedAsQualifier: string
  Billed as qualifier.
• billedAsQuantity: billedAsQuantity
  Billed as quantity.
• declaredValue: declaredValue
  The declared value of all items on the invoice.
• declaredValueQualGid: string
  The declared value qualifier GID.
• 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
• freightCharge: freightCharge
  The total freight charge for shipping all items on the invoice.
• freightRateQualifier: string
  The freight rate qualifier.
• freightRateQuantity: freightRateQuantity
  Freight rate quantity.
• lineitemSeqNo: number (int32)
  The sequence number for the line item on the invoice.
• links: array links
  Read Only: true
• packagingUnitGid: string
  N/A
• paymentMethodCodeGid: string
  The GID for the payment method code.
• prepaidAmount: prepaidAmount
  The dollar amount already paid on the invoice.
• unitCount: number (int64)
  Unit count.
• volume: volume
  The total volume of the items shipped on the invoice.
• weight: weight
  The total weight of all items shipped on the invoice.
• weightQualifier: string
  Weight qualifier.

{
    "properties":{
        "lineitemSeqNo":{
            "description":"The sequence number for the line item on the invoice.",
            "type":"number",
            "format":"int32"
        },
        "billedAsQualifier":{
            "description":"Billed as qualifier.",
            "type":"string"
        },
        "billedAsQuantity":{
            "description":"Billed as quantity.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "freightRateQualifier":{
            "description":"The freight rate qualifier.",
            "type":"string"
        },
        "freightRateQuantity":{
            "description":"Freight rate quantity.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "unitCount":{
            "description":"Unit count.",
            "type":"number",
            "format":"int64"
        },
        "packagingUnitGid":{
            "description":"N/A",
            "type":"string"
        },
        "weight":{
            "description":"The total weight of all items shipped on the invoice.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "volume":{
            "description":"The total volume of the items shipped on the invoice.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "weightQualifier":{
            "description":"Weight qualifier.",
            "type":"string"
        },
        "freightCharge":{
            "description":"The total freight charge for shipping all items on the invoice.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "prepaidAmount":{
            "description":"The dollar amount already paid on the invoice.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "paymentMethodCodeGid":{
            "description":"The GID for the payment method code.",
            "type":"string"
        },
        "accessorialCodeGid":{
            "description":"The GID for the accessorial code on the invoice.",
            "type":"string"
        },
        "accessorialDescription":{
            "description":"The text describing the accessorial on the invoice.",
            "type":"string"
        },
        "declaredValueQualGid":{
            "description":"The declared value qualifier GID.",
            "type":"string"
        },
        "declaredValue":{
            "description":"The declared value of all items on the invoice.",
            "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"
        },
        "domainName":{
            "description":"Database domain where this data is stored.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : billedAsQuantity

Billed as quantity.

Match All

Show Source

• object currencyType

{
    "description":"Billed as quantity.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : declaredValue

The declared value of all items on the invoice.

Match All

Show Source

• object currencyType

{
    "description":"The declared value of all items on the invoice.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

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 : freightCharge

The total freight charge for shipping all items on the invoice.

Match All

Show Source

• object currencyType

{
    "description":"The total freight charge for shipping all items on the invoice.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : freightRateQuantity

Freight rate quantity.

Match All

Show Source

• object currencyType

{
    "description":"Freight rate quantity.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

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 : prepaidAmount

The dollar amount already paid on the invoice.

Match All

Show Source

• object currencyType

{
    "description":"The dollar amount already paid on the invoice.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : volume

The total volume of the items shipped on the invoice.

Match All

Show Source

• object amountType

{
    "description":"The total volume of the items shipped on the invoice.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

Nested Schema : weight

The total weight of all items shipped on the invoice.

Match All

Show Source

• object amountType

{
    "description":"The total weight of all items shipped on the invoice.",
    "allOf":[
        {
            "$ref":"#/components/schemas/amountType"
        }
    ]
}

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

Nested Schema : links

Type: object

Show Source

• href: string
• rel: string

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

Nested Schema : amountType

Type: object

Show Source

• unit: string
  Unit of measure
• value: number
  Numeric value that specifies an amount

{
    "properties":{
        "value":{
            "description":"Numeric value that specifies an amount",
            "type":"number"
        },
        "unit":{
            "description":"Unit of measure",
            "type":"string"
        }
    }
}

Back to Top