Jump to

• Request
• Response

Get an Allocation Base

get

/orderReleases/{orderReleaseGid}/allocations/{allocSeqNo}/allocationBase/{allocSeqNo}

Request

Path Parameters

• allocSeqNo(required): string
  Resource ID
• orderReleaseGid(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 : schema

Type: object

Show Source

• allocatedCost: allocatedCost
  No description.
• allocSeqNo: number (int64)
  No description.
• allocTypeQualGid: string
  GC3 Global identifier for the entity. Is created by concatenating Domain Name,"." and XID.
• domainName: string
  No description.
• exchangeRateDate: exchangeRateDate
  No description.
• exchangeRateGid: string
  No description.
• invoiceGid: string
  GC3 Global identifier for the entity. Is created by concatenating Domain Name,"." and XID.
• links: array links
  Read Only: true
• parentInvoiceGid: string
  If populated, the INVOICE_GID indicates that this alllocation is for a child invoice. This column indicates the parent invoice of the entire consolidation that was allocated.
• shipGroupGid: string
  Represents Shipment Group ID. This is populated when allocating a shipment group or a voucher corresponding to an invoice created for a shipment
  group.
• shipmentGid: string
  GC3 Global identifier for the entity. Is created by concatenating Domain Name,"." and XID.
• timestamp: timestamp
  No description.
• voucherGid: string
  GC3 Global identifier for the entity. Is created by concatenating Domain Name,"." and XID.

{
    "properties":{
        "allocSeqNo":{
            "description":"No description.",
            "type":"number",
            "format":"int64"
        },
        "shipmentGid":{
            "description":"GC3 Global identifier for the entity. Is created by concatenating Domain Name,\".\" and XID.",
            "type":"string"
        },
        "allocTypeQualGid":{
            "description":"GC3 Global identifier for the entity. Is created by concatenating Domain Name,\".\" and XID.",
            "type":"string"
        },
        "invoiceGid":{
            "description":"GC3 Global identifier for the entity. Is created by concatenating Domain Name,\".\" and XID.",
            "type":"string"
        },
        "timestamp":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "allocatedCost":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "parentInvoiceGid":{
            "description":"If populated, the INVOICE_GID indicates that this alllocation is for a child invoice.  This column indicates the parent invoice of the entire consolidation that was allocated.",
            "type":"string"
        },
        "voucherGid":{
            "description":"GC3 Global identifier for the entity. Is created by concatenating Domain Name,\".\" and XID.",
            "type":"string"
        },
        "exchangeRateDate":{
            "description":"No description.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "exchangeRateGid":{
            "description":"No description.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "shipGroupGid":{
            "description":"Represents Shipment Group ID. This is populated when allocating a shipment group or a voucher corresponding to an invoice created for a shipment<br>group.",
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : allocatedCost

No description.

Match All

Show Source

• object currencyType

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

Nested Schema : exchangeRateDate

No description.

Match All

Show Source

• object dateType

{
    "description":"No description.",
    "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 : timestamp

No description.

Match All

Show Source

• object dateTimeType

{
    "description":"No description.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

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

Type: object

Show Source

• timezone: string
  Timezone in Olson database format
• value: string (date-time)
  Date in ISO 8601 format

{
    "properties":{
        "value":{
            "description":"Date in ISO 8601 format",
            "type":"string",
            "format":"date-time"
        },
        "timezone":{
            "description":"Timezone in Olson database format",
            "type":"string"
        }
    }
}

Back to Top