Jump to

• Request
• Response

Get Summaries

get

/invoices/{invoiceGid}/summaries

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/invoices.summaries"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            }
        }
    },
    "required":[
        "items"
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object invoices.summaries

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/invoices.summaries"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object links

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

Nested Schema : invoices.summaries

Type: object

Show Source

• commercialUnitPrice: commercialUnitPrice
  Commercial unit price.
• 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 the invoice.
• invoiceServiceCodeGid: string
  The type of service that was performed. Foreign key to INVOICE_SERVICE_CODE. Summary level charges on invoice for service level. This is generally for air and ground.
• invoiceSummarySeqNo: number (int32)
  Sequence number for the invoice summary.
• invoiceTotal: number (int32)
  The count of the invoice's line items.
• links: array links
  Read Only: true
• prepaidAmount: prepaidAmount
  The dollar amount already paid on the invoice.
• remarks: remarks
• transportHandlingUnitGid: string
  The GID for the transport handling unit.
• unitCount: number (int64)
  The number of units on the invoice.
• volume: volume
  The total volume of items shipped for this invoice.
• weight: weight
  The total weight of all items shipped on this invoice.
• weightQualifier: string
  Weight qualifier.

{
    "properties":{
        "invoiceSummarySeqNo":{
            "description":"Sequence number for the invoice summary.",
            "type":"number",
            "format":"int32"
        },
        "freightCharge":{
            "description":"The total freight charge for the invoice.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "prepaidAmount":{
            "description":"The dollar amount already paid on the invoice.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "commercialUnitPrice":{
            "description":"Commercial unit price.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "unitCount":{
            "description":"The number of units on the invoice.",
            "type":"number",
            "format":"int64"
        },
        "transportHandlingUnitGid":{
            "description":"The GID for the transport handling unit.",
            "type":"string"
        },
        "weight":{
            "description":"The total weight of all items shipped on this invoice.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "volume":{
            "description":"The total volume of items shipped for this invoice.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/amountType"
                }
            ]
        },
        "weightQualifier":{
            "description":"Weight qualifier.",
            "type":"string"
        },
        "invoiceTotal":{
            "description":"The count of the invoice's line items.",
            "type":"number",
            "format":"int32"
        },
        "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"
        },
        "invoiceServiceCodeGid":{
            "description":"The type of service that was performed. Foreign key to INVOICE_SERVICE_CODE. Summary level charges on invoice for service level. This is generally for air and ground.",
            "type":"string"
        },
        "remarks":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/invoices.summaries.remarks"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : commercialUnitPrice

Commercial unit price.

Match All

Commercial unit price.

Show Source

• object currencyType

{
    "description":"Commercial unit price.",
    "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

Indicates the date to be used for any currency conversions; if null, the latest conversion should be used.

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 the invoice.

Match All

The total freight charge for the invoice.

Show Source

• object currencyType

{
    "description":"The total freight charge for the invoice.",
    "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

The dollar amount already paid on the invoice.

Show Source

• object currencyType

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

Nested Schema : remarks

Type: object

Show Source

• items: array items
• links: array links
  Read Only: true

{
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/invoices.summaries.remarks"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : volume

The total volume of items shipped for this invoice.

Match All

The total volume of items shipped for this invoice.

Show Source

• object amountType

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

Nested Schema : weight

The total weight of all items shipped on this invoice.

Match All

The total weight of all items shipped on this invoice.

Show Source

• object amountType

{
    "description":"The total weight of all items shipped on this 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 : items

Type: array

Show Source

• Array of: object invoices.summaries.remarks

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/invoices.summaries.remarks"
    }
}

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 : invoices.summaries.remarks

Type: object

Show Source

• domainName: string
  Database domain where this data is stored.
• links: array links
  Read Only: true
• remarkQualIdentifier: string
  The qualifier for the remark.
• remarkSeqNo: number (int64)
  Read Only: true

  A sequence number for a remark on an invoice.
• remarkText: string
  The text of the remarks on the invoice.

{
    "properties":{
        "remarkSeqNo":{
            "description":"A sequence number for a remark on an invoice.",
            "type":"number",
            "format":"int64",
            "readOnly":true
        },
        "remarkQualIdentifier":{
            "description":"The qualifier for the remark.",
            "type":"string"
        },
        "remarkText":{
            "description":"The text of the remarks on the invoice.",
            "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 : links

Type: array

Read Only: true

Show Source

• Array of: object links

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

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