Jump to

• Request
• Response

Get Allocation Rules

get

/allocationRules

Request

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

Nested Schema : items

Type: array

Show Source

• Array of: object allocationRules

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

Nested Schema : links

Type: array

Show Source

• Array of: object links

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

Nested Schema : allocationRules

Type: object

Show Source

• allocationRuleDetails: allocationRuleDetails
• allocationRuleGid: string
  GC3 Global identifier for the entity. Is created by concatenating Domain Name,"." and XID.
• allocationRuleXid: string
  GC3 Unique identifier for the entity. Is used for creating the GID
• consInvAllocType: string
  Consolidated Invoice Allocation Type. Depend on the type of 'By Line Item' or 'By Total', the amount of the child invoices or the total payment will be allocated to the orders on the related shipment.
• contactProfileGid: string
  Allocation rule criteria for matching the involved party contact for shipment/invoice/bill
• domainName: string
  No description.
• insertDate: insertDate
  Read Only: true

  insert date
• involvedPartyQualifierGid: string
  Allocation rule criteria for matching the involved party qualifier for shipment/invoice/bill
• isAllocBill: boolean
  Identifies if the allocation rule is applicable for Customer Bill Allocation
• isAllocShipment: boolean
  Identifies if the allocation rule is applicable for Shipment Allocation
• isAllocVoucher: boolean
  Identifies if the allocation rule is applicable for Voucher Allocation
• isAllocVoucherVat: boolean
  Identifies if the allocation rule is applicable for Voucher Vat Allocation
• links: array links
  Read Only: true
• locationProfileGid: string
  GC3 Global identifier for the entity. Is created by concatenating Domain Name,"." and XID.
• modeProfileGid: string
  This is one of the Allocation Rule criteria for determining the allocation rule for a given invoice.
• updateDate: updateDate
  Read Only: true

  update date

{
    "properties":{
        "allocationRuleGid":{
            "description":"GC3 Global identifier for the entity. Is created by concatenating Domain Name,\".\" and XID.",
            "type":"string"
        },
        "allocationRuleXid":{
            "description":"GC3 Unique identifier for the entity. Is used for creating the GID",
            "type":"string"
        },
        "locationProfileGid":{
            "description":"GC3 Global identifier for the entity. Is created by concatenating Domain Name,\".\" and XID.",
            "type":"string"
        },
        "consInvAllocType":{
            "description":"Consolidated Invoice Allocation Type. Depend on the type of 'By Line Item' or 'By Total', the amount of the child invoices or the total payment will be allocated to the orders on the related shipment.",
            "type":"string"
        },
        "modeProfileGid":{
            "description":"This is one of the Allocation Rule criteria for determining the allocation rule for a given invoice.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "isAllocShipment":{
            "description":"Identifies if the allocation rule is applicable for Shipment Allocation",
            "type":"boolean"
        },
        "isAllocVoucher":{
            "description":"Identifies if the allocation rule is applicable for Voucher Allocation",
            "type":"boolean"
        },
        "isAllocBill":{
            "description":"Identifies if the allocation rule is applicable for Customer Bill Allocation",
            "type":"boolean"
        },
        "isAllocVoucherVat":{
            "description":"Identifies if the allocation rule is applicable for Voucher Vat Allocation",
            "type":"boolean"
        },
        "involvedPartyQualifierGid":{
            "description":"Allocation rule criteria for matching the involved party qualifier for shipment/invoice/bill",
            "type":"string"
        },
        "contactProfileGid":{
            "description":"Allocation rule criteria for matching the involved party contact for shipment/invoice/bill",
            "type":"string"
        },
        "updateDate":{
            "description":"update date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "insertDate":{
            "description":"insert date",
            "allOf":[
                {
                    "$ref":"#/components/schemas/dateType"
                }
            ],
            "readOnly":true
        },
        "allocationRuleDetails":{
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/allocationRules.allocationRuleDetails"
                    }
                },
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/links"
                    },
                    "readOnly":true
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/links"
            },
            "readOnly":true
        }
    }
}

Nested Schema : allocationRuleDetails

Type: object

Show Source

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

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

Nested Schema : insertDate

Read Only: true

insert date

Match All

insert date

Show Source

• object dateType

{
    "description":"insert date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ],
    "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 : updateDate

Read Only: true

update date

Match All

update date

Show Source

• object dateType

{
    "description":"update date",
    "allOf":[
        {
            "$ref":"#/components/schemas/dateType"
        }
    ],
    "readOnly":true
}

Nested Schema : items

Type: array

Show Source

• Array of: object allocationRules.allocationRuleDetails

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/allocationRules.allocationRuleDetails"
    }
}

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 : allocationRules.allocationRuleDetails

Type: object

Show Source

• accessorialCodeGid: string
  Populated only inc ase cost_type_gid is 'A'. Identifies which accessorial code.
• allocMethodGid: string
  The allocation method that the rule line is going to use.
• allocMetricGid: string
  GC3 Global identifier for the entity. Is created by concatenating Domain Name,"." and XID.
• allocRuleDetailSeq: number (double)
  The seq for maintaining the primary key.
• allocType: string
  No description.
• basis: string
  No description.
• costTypeGid: string
  The cost type identifier. i.e if the cost is a BaseCost(B), Accessorial (A), Stopoff (S) etc...
• domainName: string
  No description.
• links: array links
  Read Only: true

{
    "properties":{
        "allocRuleDetailSeq":{
            "description":"The seq for maintaining the primary key.",
            "type":"number",
            "format":"double"
        },
        "basis":{
            "description":"No description.",
            "type":"string"
        },
        "allocType":{
            "description":"No description.",
            "type":"string"
        },
        "allocMetricGid":{
            "description":"GC3 Global identifier for the entity. Is created by concatenating Domain Name,\".\" and XID.",
            "type":"string"
        },
        "domainName":{
            "description":"No description.",
            "type":"string"
        },
        "costTypeGid":{
            "description":"The cost type identifier. i.e if the cost is a BaseCost(B), Accessorial (A), Stopoff (S) etc...",
            "type":"string"
        },
        "accessorialCodeGid":{
            "description":"Populated only inc ase cost_type_gid is 'A'. Identifies which accessorial code.",
            "type":"string"
        },
        "allocMethodGid":{
            "description":"The allocation method that the rule line is going to use.",
            "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 : links

Type: object

Show Source

• href: string
• rel: string

{
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "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"
        }
    }
}

Back to Top