Jump to

• Request
• Response

Get an Accrual

get

/orderReleases/{orderReleaseGid}/accruals/{orderReleaseAccrualGid}

Request

Path Parameters

• orderReleaseAccrualGid(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

• accessorialCodeGid: string
  If line accruals are enabled, this will be populated with the accessorial ID for the accrual line.
• accruedDate: accruedDate
  The date the amount was accrued.
• costTypeGid: string
  If line accruals are enabled, this will be populated with the cost type for the accrual line.
• delta: delta
  Delta or difference for the accrual calculated as: new amount - amount previously sent.
• domainName: string
  Database domain where this data is stored.
• exchangeRateDate: exchangeRateDate
  The exchange rate date used for currency conversion calculation.
• exchangeRateGid: string
  The exchange rate GID used for currency conversion calculation.
• freightCost: freightCost
  The total current allocated freight costs.
• freightSentCost: freightSentCost
  Total allocated freight cost already sent via the accrual interface.
• isReversal: boolean
  A flag to determine whether the order release accrual is a reversal.
• links: array links
  Read Only: true
• orderReleaseAccrualGid: string
  The GID for this accrual entry.
• orderReleaseAccrualXid: string
  The XID for this accrual entry.
• sentDate: sentDate
  Timestamp of when this accrual was sent from the system. Null means it has not been sent yet.
• shipmentGid: string
  The shipment GID associated to this accrual entry.
• shipmentStartDate: shipmentStartDate
  The shipment start date used for exchange rate calculations.

{
    "properties":{
        "orderReleaseAccrualGid":{
            "description":"The GID for this accrual entry.",
            "type":"string"
        },
        "orderReleaseAccrualXid":{
            "description":"The XID for this accrual entry.",
            "type":"string"
        },
        "sentDate":{
            "description":"Timestamp of when this accrual was sent from the system. Null means it has not been sent yet.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "shipmentGid":{
            "description":"The shipment GID associated to this accrual entry.",
            "type":"string"
        },
        "accruedDate":{
            "description":"The date the amount was accrued.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "freightCost":{
            "description":"The total current allocated freight costs.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "freightSentCost":{
            "description":"Total allocated freight cost already sent via the accrual interface.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "exchangeRateGid":{
            "description":"The exchange rate GID used for currency conversion calculation.",
            "type":"string"
        },
        "exchangeRateDate":{
            "description":"The exchange rate date used for currency conversion calculation.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ]
        },
        "isReversal":{
            "description":"A flag to determine whether the order release accrual is a reversal.",
            "type":"boolean"
        },
        "shipmentStartDate":{
            "description":"The shipment start date used for exchange rate calculations.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateTimeType"
                }
            ]
        },
        "delta":{
            "description":"Delta or difference for the accrual calculated as: new amount - amount previously sent.",
            "allOf":[
                {
                    "$ref":"#/components/schemas/currencyType"
                }
            ]
        },
        "costTypeGid":{
            "description":"If line accruals are enabled, this will be populated with the cost type for the accrual line.",
            "type":"string"
        },
        "accessorialCodeGid":{
            "description":"If line accruals are enabled, this will be populated with the accessorial ID for the accrual line.",
            "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 : accruedDate

The date the amount was accrued.

Match All

Show Source

• object dateTimeType

{
    "description":"The date the amount was accrued.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : delta

Delta or difference for the accrual calculated as: new amount - amount previously sent.

Match All

Show Source

• object currencyType

{
    "description":"Delta or difference for the accrual calculated as: new amount - amount previously sent.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : exchangeRateDate

The exchange rate date used for currency conversion calculation.

Match All

Show Source

• object dateType

{
    "description":"The exchange rate date used for currency conversion calculation.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ]
}

Nested Schema : freightCost

The total current allocated freight costs.

Match All

Show Source

• object currencyType

{
    "description":"The total current allocated freight costs.",
    "allOf":[
        {
            "$ref":"#/components/schemas/currencyType"
        }
    ]
}

Nested Schema : freightSentCost

Total allocated freight cost already sent via the accrual interface.

Match All

Show Source

• object currencyType

{
    "description":"Total allocated freight cost already sent via the accrual interface.",
    "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 : sentDate

Timestamp of when this accrual was sent from the system. Null means it has not been sent yet.

Match All

Show Source

• object dateTimeType

{
    "description":"Timestamp of when this accrual was sent from the system. Null means it has not been sent yet.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

Nested Schema : shipmentStartDate

The shipment start date used for exchange rate calculations.

Match All

Show Source

• object dateTimeType

{
    "description":"The shipment start date used for exchange rate calculations.",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateTimeType"
        }
    ]
}

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

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

Back to Top