Jump to

• Request
• Response

Get Accruals

get

/orderReleases/{orderReleaseGid}/accruals

Request

Path Parameters

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

Nested Schema : items

Type: array

Show Source

• Array of: object orderReleases.accruals

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/orderReleases.accruals"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object links

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

Nested Schema : orderReleases.accruals

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