1. REST API for Fusion Cloud Transportation and Global Trade Management Business Object Resources
  2. Tasks
  3. Business Objects
  4. Rate Records
  5. Cost Groups

Get Cost Groups

get

/rateRecords/{rateGeoGid}/costGroups

Request

Path Parameters
Query Parameters
  • 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.
  • Comma-delimited string of field names that you wanted returned in a GET request.
  • Positive integer value that specifies the maximum number of items returned by the server.
  • 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.
  • Comma-separated string of field names, each optionally followed by asc or desc, that specifies the order of items returned in the response payload.
  • Filter (a 'where'clause) to restrict the items returned in the collection. By default, no filtering is applied.
  • 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

Default Response

Default Response.
Body ()
Root Schema : schema
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : links
Type: array
Show Source
Nested Schema : rateRecords.costGroups
Type: object
Show Source
  • costs
  • Defines the way the rating logic handles unit breaks. When there is a unit break defined for a rate, deficit calculations will make sure that the least expensive rate is selected. For example, if a rate break occurs at 1000 pounds, and an order weighs 999 pounds (with a rate of $15 per pound), then the system will look at the price of shipping at the next highest weight break (1001 pounds at $13 per pound) and apply the cheapest rate. In this example, the least expensive option is to use the 1001 pound rate even though only 999 pounds are being shipped. For details on the types, see rounding and deficit calculations.
  • Database domain where this data is stored.
  • The name used to identify the rate group.
  • links
  • Determine how costs within this group will be calculated.
  • The GID for the rate cost group. Rate cost groups provide the ability to group separate costs together to produce a final rate.
  • The sequence number used in the UI to display rate groups in order.
  • The XID for the rate cost group.
  • Set to Base to create a base cost or miscellaneous for all other cost types.
  • Defines when rounding should take place. For example, you may only want rounding to be done on cost calculations.
  • Specifies which fields in the rating process should be rounded. For example, you may only want currency fields rounded.
  • Specifies what interval to round up or down to. For example, if you want to round up or down to the nearest 1, then you would enter 1 here. If you want to round up or down to the nearest tenth decimal place, then you would enter .1 here.
  • Dictates how numbers are rounded. Select Ceiling to always round up, Floor to always round down, Nearest Interval to round up if it is 5 or greater and down if it is less than 5, or No Rounding to not round at all.
Nested Schema : costs
Type: object
Show Source
Nested Schema : items
Type: array
Show Source
Nested Schema : rateRecords.costGroups.costs
Type: object
Show Source
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
  • Used to combine conditional rules with values of SELECTED, AND, or OR. If you choose SELECTED, the system first finds matches for the first conditional rule, and then passes only those matches on to the next conditional rule, etc..
  • Used to combine conditional rules with values of SELECTED, AND, or OR. If you choose SELECTED, the system first finds matches for the first conditional rule, and then passes only those matches on to the next conditional rule, etc..
  • Used to combine conditional rules with values of SELECTED, AND, or OR. If you choose SELECTED, the system first finds matches for the first conditional rule, and then passes only those matches on to the next conditional rule, etc..
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
  • attributeDate1
    Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
  • attributeDate10
    Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
  • attributeDate2
    Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
  • attributeDate3
    Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
  • attributeDate4
    Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
  • attributeDate5
    Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
  • attributeDate6
    Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
  • attributeDate7
    Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
  • attributeDate8
    Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
  • attributeDate9
    Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
  • Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
  • Calculate Chargeable Weight/Volume Using provides you with options for calculating the chargeable weight. If you select this field value as "Shipment Total Dimensional Weight/Volume", chargeable weight/volume will be calculated based on the Shipment Total Dimensional Weight/Volume. If you select this field value as "Sum of Individual Ship Unit Dimensional Weight/Volume", chargeable weight/volume will be calculated based on the Sum of Individual Ship Unit Dimensional Weight/Volume.
  • Allows the user to select a calendar activity for the calendar validation test.
  • If the costs being defined is to be based on a calendar provide the Calendar ID.
  • Charge action to be applied. Values (A/M/X/D/W).
  • chargeAmount
    Amount to be charged per unit code and unit count. For example, the amount to be charge is 1 USD for every 3 pounds.
  • Comparator between charges.
  • The RBI used to lookup values in the secondary rate unit break profile.
  • Determines the attribute/qualifier of the object based on which the charge using unit breaks is to be calculated. For example, if the rate break is based on flex field attribute1, this column will hold value as attribute1, the flex field column name. If the rate break is based on the reference number qualifier GLOG = ORDER_01 then this column will hold the value GLOG, the qualifier name.
  • Determines the attribute/qualifier of the object based on which the charge using unit breaks is to be calculated. For example, if rate break is based on flex field attribute1, this column will hold value as attribute1, the flex field column name. If rate break is based on the reference number qualifier GLOG = ORDER_01 then this column will hold the value GLOG, the qualifier name.
  • This is the basis option for which the cost accrues from the Basis field. Values (A/L/S/G/E/I).
  • The basis option for which the cost accrues from the Basis field.
  • Controls how charge multipliers are applied against the specified cost. Values (A/L/S/G/E/I). There are a set of options:
    Add individual multiplier values
    Greatest individual cost
    Choose lowest individual cost
    Collect costs separately
  • Enter the number of basis options that go with each amount in the Unit field.
  • Determines the attribute/qualifier of the object based on which the charge is to be calculated. For example, if the charge is based on some flex field attribute1, this column will hold value as attribute1, the flex field column name. If the charge is based on the reference number qualifier GLOG = ORDER_01 then this column will hold the value GLOG, the qualifier name.
  • Determines the attribute/qualifier of the object based on which the charge is to be calculated. For example, if the charge is based on some flex field attribute1, this column will hold value as attribute1, the flex field column name. If the charge is based on the reference number qualifier GLOG = ORDER_01 then this column will hold the value GLOG, the qualifier name.
  • Charge sequence controls, in the order that the costs are calculated. Charge Sequence 1 is calculated before Charge Sequence 2.
  • There are the following cost types:
    Charge
    Discount
    External
    Profile
  • The charge unit count indicates the per amount for the charge. For example, the amount to be charged is 1 USD for every 3 pounds. In this example 3 is the charge unit count - 1 USD is charged for every 3 pounds.
  • The number of basis options that go with each amount in the Unit field.
  • The charge per unit of measure. For example, the amount to be charged is 1 USD for every 3 pounds. In this example pounds is the charge unit of measure code.
  • The charge per unit of measure. For example, the amount to be charged is 1 USD for every 3 pounds. In this example pounds is the charge unit of measure code.
  • The cost category can be assigned to one or more rate costs in a rate record. The cost category can then be grouped into cost category sets which can then be used during the driver assignment process. During the rating process, only rate costs whose categories are contained in the specified set will be evaluated. The results will be sorted based on total weighted cost and the best option assigned.
  • Tags a cost with an accessorial code. This does not indicate that the cost is an accessorial. It is a way of identifying groups of costs.
  • Designates the type of the cost. C = Charge, D = Discount, P = Profile, E = External.
  • When to apply deficit calculations. Values are Y/N/P where Y = Yes, N = No, and P = Payant Pour
  • Records additional information about the rate cost. This description will appear as the shipment cost type on the Financial tab of the Shipment Manager when this rate cost is applied to a shipment. If this field is left blank, a default shipment cost type appears such as Base or Discount.
  • The Dimensional (Dim) Rate Factor ID links to the definition of the dim rate factor. The dim rate factor calculates the dimensional weight of a shipment, typically for goods shipped via air or sea. The weight is calculated as: Volume of the shipment/Dimensional rate factor. The system uses the greater of dimensional weight and actual weight which is called the chargeable weight. This chargeable weight is used while rating the shipment.
  • Identifies the distance unit for the tariff. Informational. Values ( A/B/D/F/K/L/M/T/X).
  • Database domain where this data is stored.
  • effectiveDate
    Date the rate is effective from.
  • Stores information related to the authority/government agency that relates to this rate.
  • expirationDate
    Date the rate expires, and should no longer be considered for planning.
  • For a cost type of E, specifies the external rating engine GID.
  • For external rating engine GIDs of type GENERIC, this specifies the fieldset used to call out to the external engine.
  • Operand value high value if the operand requires low/high values. For example where the operator is between: value1 < Basis <= value2.< div>
  • Operand value high value if the operand requires low/high values. For example where the operator is between: value1 < Basis <= value2.< div>
  • Operand value high value if the operand requires low/high values. For example where the operator is between: value1 < Basis <= value2.< div>
  • Operand value high value if the operand requires low/high values. For example where the operator is between: value1 < Basis <= value2.< div>
  • Indicates if this rate cost has been filed as tariff. This is set to 'N' for new spot rates. Users may wish to set up a saved query to notify users if this rate is used.
  • The operator for the conditional. For example, <=: less than or equal to,>: Greater than, <: less than,>=: Greater than or equal to, =: Equal to etc.
  • The operator for the conditional. For example, <=: less than or equal to,>: Greater than, <: less than,>=: Greater than or equal to, =: Equal to etc.
  • The operator for the conditional. For example, <=: less than or equal to,>: Greater than, <: less than,>=: Greater than or equal to, =: Equal to etc.
  • The operator for the conditional. For example, <=: less than or equal to,>: Greater than, <: less than,>=: Greater than or equal to, =: Equal to etc.
  • links
  • For a cost type of L, specifies the logic parameter qualifier (of type Currency) which contains the cost value used as the charge multiplier.
  • Operand value or low value if the operand requires low/high values. For example where the operator is between: value1 < Basis <= value2.< div>
  • Operand value or low value if the operand requires low/high values. For example where the operator is between: value1 < Basis <= value2.< div>
  • Operand value or low value if the operand requires low/high values. For example where the operator is between: value1 < Basis <= value2.< div>
  • Operand value or low value if the operand requires low/high values. For example where the operator is between: value1 < Basis <= value2.< div>
  • maxCost
    The maximum cost is the absolute maximum rate that can be charged. The calculated rate cost is comparted to the maximum cost and the lower of the two values is what is charged.
  • minCost
    The minimum charge for a shipment. The minimum charge is absolute minimum charge that applies; so the calculated cost of a shipment will be compared to the minimum charge and the cost will always be greater than or equal to the minimum charge.
  • The GID for the operator.
  • The GID for the operator.
  • The GID for the operator.
  • The GID for the operator.
  • Determines the attribute/qualifier of the object on which the condition is based. For example, if the condition checks the value for flex field attribute1 = TEST, this column will hold value as attribute1, the flex field column name. If condition is on the reference number qualifier GLOG = ORDER_01 then this column will hold the value GLOG, the qualifier name.
  • Determines the attribute/qualifier of the object on which the second condition is based. For example, if the condition checks the value for flex field attribute1 = TEST, this column will hold value as attribute1, the flex field column name. If condition is on the reference number qualifier GLOG = ORDER_01 then this column will hold the value GLOG, the qualifier name.
  • Determines the attribute/qualifier of the object on which the third condition is based. For example, if the condition checks the value for flex field attribute1 = TEST, this column will hold value as attribute1, the flex field column name. If the condition is on the reference number qualifier GLOG = ORDER_01 then this column will hold the value GLOG, the qualifier name.
  • Determines the attribute/qualifier of the object on which the condition is based. For example, if the condition checks the value for flex field attribute1 = TEST, this column will hold value as attribute1, the flex field column name. If the condition is on the reference number qualifier GLOG = ORDER_01 then this column will hold the value GLOG, the qualifier name.
  • The minimum charge in the base currency.
  • The mileage factor published for rating purposes. This number is qualified by the rate basis qualifier. An informational field.
  • Provides context for the rate basis number. Informational. For example, if the rate basis number is "83" as defined by the household goods miles definition which would explain the geography for the rate basis number. Values (A/B/C/D/E/F/H/M/T/X/Y).
  • Internal sequencing number for costs operand.
  • An internal sequencing number for costs defined on a rate.
  • The secondary rate unit break profile. It cannot have a value if the main profile GID is NULL.
  • The main rate unit break profile.
  • Determines when to apply the rounding rules. Values are A/N/C/O where A=always, N=never, C=conditionals only, and O=cost calculations only.
  • Determines which kinds of fields will be affected by the rounding settings during costing. Values are 0-7, where 0=all fields, 1=none, 2=numeric fields only, 3=unit fields (weight, etc.), 4=currency, 5=numeric and unit fields, 6=numeric and currency fields, and 7=unit and currency fields.
  • Numbers will be rounded (or truncated) to the nearest increment of this value.
  • The type of rounding that will occur during rating. Value are: N=no rounding, I=round to nearest interval, F=floor, and C=ceiling.
  • A commodity classification that is used, as a means of control, for grouping of commodities in tariff applications.
  • tariffDistance
    The distance on which the rate is based.
  • The tariff freight class code specifies the freight classification associated with this tariff. Tariff freight class code references a system where the motor carrier industry has classified "goods" by their shipping density instead of their composition or use. An informational field.
  • The Tariff fields are a set of informational field that let the service provider know the rate being used. The tariff item number can be used for all types of prices. If the service provider assigns an item number or a numeric extension for the authority number in the reference number to the price, then this field can be used to capture that information. The tariff item number is the next step below the tariff section.
  • The tariff item number suffix, if you have a suffix with your tariff item number. The tariff item number suffix works with the tariff item number. An informational field.
  • The item part is a subdivision of an item. The item part is like the house number on a street (tariff item number) in a city (tariff section) in a state (tariff reference number).
  • The tariff section is the first division of granularity of a tariff and describes where the rate can be found. An informational field.
  • If using tiered rating, assigning a number to this field allows RIQ to query tiered rates by simply specifying a tier number.
Nested Schema : attributeDate1
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate10
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate2
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate3
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate4
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate5
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate6
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate7
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate8
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : attributeDate9
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
Match All
Show Source
Nested Schema : chargeAmount
Amount to be charged per unit code and unit count. For example, the amount to be charge is 1 USD for every 3 pounds.
Match All
Show Source
Nested Schema : effectiveDate
Date the rate is effective from.
Match All
Show Source
Nested Schema : expirationDate
Date the rate expires, and should no longer be considered for planning.
Match All
Show Source
Nested Schema : maxCost
The maximum cost is the absolute maximum rate that can be charged. The calculated rate cost is comparted to the maximum cost and the lower of the two values is what is charged.
Match All
Show Source
Nested Schema : minCost
The minimum charge for a shipment. The minimum charge is absolute minimum charge that applies; so the calculated cost of a shipment will be compared to the minimum charge and the cost will always be greater than or equal to the minimum charge.
Match All
Show Source
Nested Schema : tariffDistance
The distance on which the rate is based.
Match All
Show Source
Nested Schema : dateType
Type: object
Show Source
Nested Schema : currencyType
Type: object
Show Source
Nested Schema : amountType
Type: object
Show Source
Back to Top