Get Rate Records
get
/rateRecords
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 TopResponse
Supported Media Types
- application/vnd.oracle.resource+json;type=collection
Default Response
Default Response.
Nested Schema : rateRecords
Type:
Show Source
object
-
accessorials:
accessorials
-
allowUncostedLineItems: boolean
Allow Uncosted Line Items (Y/N) is used when there are one or more ratable objects on the shipment which are not charged or considered for rating when rating a shipment using rate record.
Selected: Some basis options within a shipment pass through the rating engine without a charge if other basis options qualify. For example, if a shipment contains four line items, and a rate is found that contains charges for 3 of those items, that rate qualifies for the shipment and the fourth line item ships for free. If there is a conditional charge and a minimum charge, and the conditional charge does not apply, the minimum charge will always be applied. Cleared: This rate only qualifies if all basis options can be charged. -
attribute1: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute10: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute11: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute12: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute13: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute14: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute15: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute16: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute17: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute18: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute19: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute2: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute20: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute3: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute4: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute5: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute6: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute7: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute8: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute9: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attributeDate1:
attributeDate1
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate10:
attributeDate10
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate2:
attributeDate2
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate3:
attributeDate3
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate4:
attributeDate4
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate5:
attributeDate5
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate6:
attributeDate6
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate7:
attributeDate7
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate8:
attributeDate8
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate9:
attributeDate9
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeNumber1: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber10: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber2: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber3: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber4: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber5: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber6: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber7: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber8: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber9: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
buyRateGeoProfileGid: string
The ID of the rate geo profile to be used when building buy shipments.
-
buyServprovProfileGid: string
The ID of the service provider profile to be used when building buy shipments.
-
calcChargeableWtVolWith: string
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.
-
circuityAllowancePercent: number
(double)
The allowed amount of out of route distance (as a percent of the direct source to final destination distance) that is free before circuitous distance cost are charged.
Circuity Allowance Percent = (t/d-1)*100 where:
t is the allowed total distance traveled between the first and last stop of the shipment.
d is the shortest distance between the first and last stop of the shipment.
If the allowed total distance is 1500 miles and the distance between the first and last stop is 1300 miles, Circuity Allowance Percent = (1500/1300-1)*100 = (1.15-1)*100 = 15%. The lower the percentage, the more in line the route must be. -
circuityDistanceCost:
circuityDistanceCost
The per distance unit charge for each unit over the included/free amount.
-
cofcTofc: string
The Container-On-Flat-Car/Trailer-On-Flat-Car code used along with the Rail Inter Modal Plan GID to determine the rate.
-
corporationProfileGid: string
Allows you to constrain the usage of the rate during the planning based the compatibility definition provided by the assigned corporation profile.
-
costGroups:
costGroups
-
customerRateCode: string
This code signifies what rate is used on a Leg; either "C" for the Customer's rate, or "S" for the Shipper's rate.
-
deficitCalculationsType: string
When to apply deficit calculations. Values are Y/N/P where Y = Yes, N = No and P = Payant Pour.
-
deliveryStopsConstraint: number
(int32)
Constraint value for the number of delivery stops that this rate can be used for.
-
dimRateFactorGid: string
The GID for the dim rate factor.
-
documents:
documents
-
domainName: string
Database domain where this data is stored.
-
domainProfileGid: string
Allows you to assign a domain profile ID which defines the compatible or incompatible domains for rate.
-
effectiveDate:
effectiveDate
Date the rate is effective from.
-
equipmentGroupProfileGid: string
Links the rate geo record to an equipment group profile that, if provided, will constrain the rate to only use equipment groups identified as compatible based on the defined equipment group profile.
-
expirationDate:
expirationDate
Date the rate expires, and should no longer be considered for planning.
-
expireMarkId: string
Used to indicate that the rate has been marked for expiration.
-
flexCommodityProfileGid: string
The GID for the flex commodity profile.
-
hazardousRateType: string
Qualifies how the rate should be used for shipments with hazardous materials. The Hazardous Rate Type has three options which can be used to indicate whether the rate can be used for shipments with or without hazardous materials. The options are:
Allows Hazardous Materials
Hazardous Materials Only
Non-Hazardous Materials Only -
insertDate:
insertDate
Read Only:
true
insert date -
isActive: boolean
TRUE FALSE flag indicating if the rate is active or not.
-
isForBeyond: boolean
The From Beyond and For Beyond check boxes allow the existence of two rates with the same geography, such as SPLC to SPLC, to exist with one being allowable for use with Rule 11 and the other one not. Since you cannot have the same GID, this allows you to have the flexibility. The For Beyond check box is for a leg going into a junction as defined on Rule 11 Route Code. The From Beyond check box is for a leg going from a junction. Select both check boxes for a leg going from a junction to a junction.
-
isFromBeyond: boolean
The From Beyond and For Beyond check boxes allow the existence of two rates with the same geography, such as SPLC to SPLC, to exist with one being allowable for use with Rule 11 and the other one not. Since you cannot have the same GID, this allows you to have the flexibility. The For Beyond check box is for a leg going into a junction as defined on Rule 11 Route Code. The From Beyond check box is for a leg going from a junction. Select both check boxes for a leg going from a junction to a junction.
-
isMasterOverridesBase: boolean
If Y, the BASE rate will not be evaluated and applied for this rate geo.
-
isQuote: boolean
Most commonly applicable to spot rates; indicates if this rate is to be found by rate finding logic. During RIQ, if the attached rate offering is a spot rate, the rate geo can only be used if quote is checked.
-
isSourcingRate: boolean
This column is named as IS_SOURCING_RATE to maintain consistency with RATE_OFFERING table but used to serve the purpose of IS_READ_ONLY in the UI.
-
links: array
links
Read Only:
true
-
locationGid: string
The GID for the location.
-
logicConfigGid: string
Specifies the logic configuration group ID used to look up any logic parameters specified as charge multipliers on costs. If not null, overrides value specified on the owning rate offering.
-
maxCircuityDistance:
maxCircuityDistance
The rate constraint that defines the maximum circuity distance for the rate. If this value is exceeded, the rate cannot be applied to the shipment. To use this field, you must have a value in the Circuity Distance Cost field. If there is no additional cost applicable, then enter a cost of 0.00.
-
maxCircuityPercent: number
(double)
The rate constraint that defines the maximum circuity percent for the rate. If this value is exceeded, the rate cannot be applied to the shipment. To use this field, you must have a value in the Circuity Distance Cost field. If there is no additional cost applicable, then enter a cost of 0.00.
-
minCost:
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.
-
minStops: number
(int32)
Value for the minimum number of stops required for this rate to apply.
-
multiBaseGroupsRule: string
The multi base group rule determines how the results from multiple rate cost groups are evaluated. Values A/M/X. Options are:
Add the Cost,
Select the Least Cost,
Select the Greatest Cost.
Rate Cost Groups allow you to group rate costs together.
Note: To use Rate Cost Groups, you must have rate groups active within your user preferences. -
nmfcCodeSubstitutes:
nmfcCodeSubstitutes
-
parentRateGeoGid: string
Used for rate maintenance and is provided so you can track the different versions of your rates during the approval process.
-
paymentMethodCodeGid: string
Optional payment method for the rate record
-
pickupStopsConstraint: number
(int32)
Constraint value for the number of pickup stops that this rate can be used for.
-
railInterModalPlanGid: string
The rail inter-modal plan GID. i.e. Plan 20 - door-to-door, Plan 25 - ramp-to-ramp, etc.
-
rateGeoDesc: string
The rate geo description.
-
rateGeoGid: string
The GID for the rate geo.
-
rateGeoSeq: number
(int64)
System generated unique identifier for a rate geo. For internal use only.
-
rateGeoXid: string
The XID for the rate geo.
-
rateOfferingGid: string
Indicates the rate offering to which this rate reo record is linked.
-
rateQualityGid: string
The GID for rate quality.
-
rateServiceGid: string
Links to the rate service record which, based on the related rate service type, determines how to calculate the timing for a shipment.
-
rateZoneProfileGid: string
The GID for the rate zone profile.
-
refnums:
refnums
-
remarks:
remarks
-
roTimePeriodDefGid: string
The global ID for the rate offering time period definition which is used to define the time periods for tiered rates.
-
roundingApplication: string
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.
-
roundingFieldsLevel: number
(int32)
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.
-
roundingInterval: number
(double)
Numbers will be rounded (or truncated) to the nearest increment of this value.
-
roundingType: string
The type of rounding that will occur during rating. Value are: N=no rounding, I=round to nearest interval, F=floor, and C=ceiling.
-
routeCodeGid: string
The GID for the route code.
-
smcDiscounts:
smcDiscounts
-
specialServices:
specialServices
-
stopRates:
stopRates
-
stopsIncludedRate: number
(int32)
The Stops Included Rate field indicates the number of free stops included in the rate before stop-off charges apply. The source and destination locations count as stops so, typically, the minimum number of stops included in the rate is 2. Additional charges apply for all stops not included in the rate.
-
totalStopsConstraint: number
(int32)
Constraint value for the total number of stops (pickup and delivery) that this rate can be used for.
-
updateDate:
updateDate
Read Only:
true
update date -
viaDestLocGid: string
A VIA Locations is used when rating and routing international shipments. Rates are valid when the data specified here matches the VIA Location set up on an itinerary. This field provides the location GID for a single destination via location.
-
viaDestLocProfGid: string
VIA Locations are used when rating and routing international shipments. Rates are valid when the data specified here matches the VIA Locations set up on an itinerary. This field provides the profile GID for the profile/list of destination via locations.
-
viaSrcLocGid: string
A VIA Locations is used when rating and routing international shipments. Rates are valid when the data specified here matches the VIA Location set up on an itinerary. This field provides the location GID for a single source via location.
-
viaSrcLocProfGid: string
VIA Locations are used when rating and routing international shipments. Rates are valid when the data specified here matches the VIA Locations set up on an itinerary. This field provides the profile GID for the profile/list of source via locations.
-
xLaneGid: string
Indicates the lane definition (the from and to geo hierarchies) that this rate geo record will cover.
Nested Schema : accessorials
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
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 : circuityDistanceCost
The per distance unit charge for each unit over the included/free amount.
Match All
Show Source
Nested Schema : costGroups
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : documents
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : expirationDate
Date the rate expires, and should no longer be considered for planning.
Match All
Show Source
Nested Schema : maxCircuityDistance
The rate constraint that defines the maximum circuity distance for the rate. If this value is exceeded, the rate cannot be applied to the shipment. To use this field, you must have a value in the Circuity Distance Cost field. If there is no additional cost applicable, then enter a cost of 0.00.
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 : nmfcCodeSubstitutes
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : refnums
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : remarks
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : smcDiscounts
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : specialServices
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : stopRates
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : rateRecords.accessorials
Type:
Show Source
object
-
accessorialCodeGid: string
The GID for the accessorial code.
-
accessorialCostGid: string
Links to the rating setup used to determine the cost of providing the accessorial.
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
Nested Schema : dateTimeType
Type:
Show Source
object
-
timezone: string
Timezone in Olson database format
-
value: string
(date-time)
Date in ISO 8601 format
Nested Schema : currencyType
Type:
Show Source
object
-
currency: string
ISO 4217 currency code
-
value: number
Numeric value that specifies a currency
Nested Schema : rateRecords.costGroups
Type:
Show Source
object
-
costs:
costs
-
deficitCalculationsType: string
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.
-
domainName: string
Database domain where this data is stored.
-
groupName: string
The name used to identify the rate group.
-
links: array
links
Read Only:
true
-
multiRatesRule: string
Determine how costs within this group will be calculated.
-
rateGeoCostGroupGid: string
The GID for the rate cost group. Rate cost groups provide the ability to group separate costs together to produce a final rate.
-
rateGeoCostGroupSeq: number
(int64)
The sequence number used in the UI to display rate groups in order.
-
rateGeoCostGroupXid: string
The XID for the rate cost group.
-
rateGroupType: string
Set to Base to create a base cost or miscellaneous for all other cost types.
-
roundingApplication: string
Defines when rounding should take place. For example, you may only want rounding to be done on cost calculations.
-
roundingFieldsLevel: number
(int32)
Specifies which fields in the rating process should be rounded. For example, you may only want currency fields rounded.
-
roundingInterval: number
(double)
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.
-
roundingType: string
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:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : rateRecords.costGroups.costs
Type:
Show Source
object
-
allowZeroRbiValue: boolean
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
andOr1: string
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..
-
andOr2: string
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..
-
andOr3: string
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..
-
attribute1: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute10: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute11: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute12: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute13: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute14: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute15: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute16: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute17: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute18: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute19: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute2: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute20: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute3: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute4: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute5: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute6: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute7: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute8: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attribute9: string
Attribute fields (flexfields) allow you to add additional information about an object. Data Type VARCHAR2 (150)
-
attributeDate1:
attributeDate1
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate10:
attributeDate10
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate2:
attributeDate2
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate3:
attributeDate3
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate4:
attributeDate4
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate5:
attributeDate5
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate6:
attributeDate6
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate7:
attributeDate7
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate8:
attributeDate8
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeDate9:
attributeDate9
Attribute fields (flexfields) allow you to add additional information about an object. Data Type Date
-
attributeNumber1: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber10: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber2: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber3: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber4: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber5: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber6: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber7: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber8: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
attributeNumber9: number
(double)
Attribute fields (flexfields) allow you to add additional information about an object. Data Type NUMBER
-
calcChargeableWtVolWith: string
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.
-
calendarActivityGid: string
Allows the user to select a calendar activity for the calendar validation test.
-
calendarGid: string
If the costs being defined is to be based on a calendar provide the Calendar ID.
-
chargeAction: string
Charge action to be applied. Values (A/M/X/D/W).
-
chargeAmount:
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.
-
chargeBreakComparator: string
Comparator between charges.
-
chargeBreakComparator2Gid: string
The RBI used to lookup values in the secondary rate unit break profile.
-
chargeBreakCompQualifier1: string
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.
-
chargeBreakCompQualifier2: string
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.
-
chargeMultiplier: string
This is the basis option for which the cost accrues from the Basis field. Values (A/L/S/G/E/I).
-
chargeMultiplier2: string
The basis option for which the cost accrues from the Basis field.
-
chargeMultiplierOption: string
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 -
chargeMultiplierScalar: number
(double)
Enter the number of basis options that go with each amount in the Unit field.
-
chargeQualifier1: string
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.
-
chargeQualifier2: string
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.
-
chargeSequence: number
(int64)
Charge sequence controls, in the order that the costs are calculated. Charge Sequence 1 is calculated before Charge Sequence 2.
-
chargeType: string
There are the following cost types:
Charge
Discount
External
Profile -
chargeUnitCount: number
(int64)
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.
-
chargeUnitCount2: number
(int64)
The number of basis options that go with each amount in the Unit field.
-
chargeUnitUomCode: string
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.
-
chargeUnitUomCode2: string
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.
-
costCategoryGid: string
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.
-
costCodeGid: string
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.
-
costType: string
Designates the type of the cost. C = Charge, D = Discount, P = Profile, E = External.
-
deficitCalculationsType: string
When to apply deficit calculations. Values are Y/N/P where Y = Yes, N = No, and P = Payant Pour
-
description: string
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.
-
dimRateFactorGid: string
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.
-
distanceQualifier: string
Identifies the distance unit for the tariff. Informational. Values ( A/B/D/F/K/L/M/T/X).
-
domainName: string
Database domain where this data is stored.
-
effectiveDate:
effectiveDate
Date the rate is effective from.
-
exParte: string
Stores information related to the authority/government agency that relates to this rate.
-
expirationDate:
expirationDate
Date the rate expires, and should no longer be considered for planning.
-
externalRatingEngineGid: string
For a cost type of E, specifies the external rating engine GID.
-
extReFieldsetGid: string
For external rating engine GIDs of type GENERIC, this specifies the fieldset used to call out to the external engine.
-
highValue1: string
Operand value high value if the operand requires low/high values. For example where the operator is between: value1 < Basis <= value2.< div> =>
-
highValue2: string
Operand value high value if the operand requires low/high values. For example where the operator is between: value1 < Basis <= value2.< div> =>
-
highValue3: string
Operand value high value if the operand requires low/high values. For example where the operator is between: value1 < Basis <= value2.< div> =>
-
highValue4: string
Operand value high value if the operand requires low/high values. For example where the operator is between: value1 < Basis <= value2.< div> =>
-
isFiledAsTariff: boolean
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.
-
leftOperand1: string
The operator for the conditional. For example, <=: less than or equal to,>: Greater than, <: less than,>=: Greater than or equal to, =: Equal to etc.=:>
-
leftOperand2: string
The operator for the conditional. For example, <=: less than or equal to,>: Greater than, <: less than,>=: Greater than or equal to, =: Equal to etc.=:>
-
leftOperand3: string
The operator for the conditional. For example, <=: less than or equal to,>: Greater than, <: less than,>=: Greater than or equal to, =: Equal to etc.=:>
-
leftOperand4: string
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: array
links
Read Only:
true
-
logicParamQualGid: string
For a cost type of L, specifies the logic parameter qualifier (of type Currency) which contains the cost value used as the charge multiplier.
-
lowValue1: string
Operand value or low value if the operand requires low/high values. For example where the operator is between: value1 < Basis <= value2.< div> =>
-
lowValue2: string
Operand value or low value if the operand requires low/high values. For example where the operator is between: value1 < Basis <= value2.< div> =>
-
lowValue3: string
Operand value or low value if the operand requires low/high values. For example where the operator is between: value1 < Basis <= value2.< div> =>
-
lowValue4: string
Operand value or low value if the operand requires low/high values. For example where the operator is between: value1 < Basis <= value2.< div> =>
-
maxCost:
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:
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.
-
oper1Gid: string
The GID for the operator.
-
oper2Gid: string
The GID for the operator.
-
oper3Gid: string
The GID for the operator.
-
oper4Gid: string
The GID for the operator.
-
operandQualifier1: string
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.
-
operandQualifier2: string
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.
-
operandQualifier3: string
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.
-
operandQualifier4: string
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.
-
paymentMethodCodeGid: string
The minimum charge in the base currency.
-
rateBasisNumber: string
The mileage factor published for rating purposes. This number is qualified by the rate basis qualifier. An informational field.
-
rateBasisQualifier: string
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).
-
rateGeoCostOperandSeq: number
(double)
Internal sequencing number for costs operand.
-
rateGeoCostSeq: number
(int64)
An internal sequencing number for costs defined on a rate.
-
rateUnitBreakProfile2Gid: string
The secondary rate unit break profile. It cannot have a value if the main profile GID is NULL.
-
rateUnitBreakProfileGid: string
The main rate unit break profile.
-
roundingApplication: string
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.
-
roundingFieldsLevel: number
(int32)
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.
-
roundingInterval: number
(double)
Numbers will be rounded (or truncated) to the nearest increment of this value.
-
roundingType: string
The type of rounding that will occur during rating. Value are: N=no rounding, I=round to nearest interval, F=floor, and C=ceiling.
-
tariffColumn: string
A commodity classification that is used, as a means of control, for grouping of commodities in tariff applications.
-
tariffDistance:
tariffDistance
The distance on which the rate is based.
-
tariffFreightClassCode: string
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.
-
tariffItemNumber: string
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.
-
tariffItemNumberSuffix: string
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.
-
tariffItemPart: string
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).
-
tariffSection: string
The tariff section is the first division of granularity of a tariff and describes where the rate can be found. An informational field.
-
tier: number
(int32)
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 : 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 : amountType
Type:
Show Source
object
-
unit: string
Unit of measure
-
value: number
Numeric value that specifies an amount
Nested Schema : rateRecords.documents
Type:
Show Source
object
-
contentManagementSystemGid: string
No description.
-
documentCmsId: string
A GUID to associate the document with content stored on its remote CMS. Valid when document_type=CMS.
-
documentDefGid: string
No description.
-
documentFilename: string
No description.
-
documentGid: string
No description.
-
documentMimeType: string
No description.
-
documentTrackingNum: string
No description.
-
documentType: string
No description.
-
documentUrl: string
No description.
-
documentXid: string
No description.
-
domainName: string
No description.
-
effectiveDate:
effectiveDate
represents effective date for a document
-
expirationDate:
expirationDate
Represents expiration date for a document.
-
generatedAt:
generatedAt
If preparation, date/time content was last generated
-
links: array
links
Read Only:
true
-
ownerDataQueryTypeGid: string
No description.
- relatedDocumentGid: string
-
reportGid: string
The report associated with the document attachment, if content was generated by the report subsystem.
-
uploadedAt:
uploadedAt
If attachment, date/time content was last updated
-
usedAs: string
Represents the classification of a document.(C/I/L/T)
-
userDefined1IconGid: string
No description.
-
userDefined2IconGid: string
No description.
-
userDefined3IconGid: string
No description.
-
userDefined4IconGid: string
No description.
-
userDefined5IconGid: string
No description.
Nested Schema : generatedAt
If preparation, date/time content was last generated
Match All
Show Source
Nested Schema : rateRecords.nmfcCodeSubstitutes
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
nmfcHigh: number
(double)
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.
-
nmfcLow: number
(double)
Low National Motor Freight Classification value used for defining a rate as classification record.
-
rateAsNmfcClass: number
(double)
The National Motor Freight Classification (NMFC) fields allow you to apply a specific NMFC based rate using a range of NMFC classes. For example, if you want anything between the NMFC class of 45 and 65 to use the 55 NMFC class rate, then you would enter 45 in the NMFC Low field, 65 in the NMFC High field, and 55 in the Rate As NMFC Class field. Note: The NMFC Low and High fields are inclusive, meaning they follow a "greater than or equal to" and a "less than or equal to" pattern respectively. Using the above example, 45 and 65 are included in the ranges.
-
rateOfferingGid: string
The GID for the related rate offering for the rate as table of values.
-
roNmfccsSeqNum: number
(int64)
Internal sequence number for different row entries.
Nested Schema : rateRecords.refnums
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
rateGeoRefnumQualGid: string
The GID for the rate geo reference number qualifier.
-
rateGeoRefnumValue: string
The actual reference value for the rate geo reference number.
Nested Schema : rateRecords.remarks
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
remarkQualifierGid: string
The optional qualifier for rate geo remarks.
-
remarkSequence: number
(int64)
Sequence to allow multiple remarks for a rate geo.
-
remarkText: string
The actual remark text for rate geo remarks.
Nested Schema : rateRecords.smcDiscounts
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
l5cDiscount: number
(double)
Percent discount for weights <= 500 lb.< div> =>
-
links: array
links
Read Only:
true
-
m10mDiscount: number
(double)
Percent discount for weight > 10,000 lb.
-
m1mDiscount: number
(double)
Percent discount for weight > 1000 lb.
-
m20mDiscount: number
(double)
Percent discount for weight > 20,000 lb.
-
m2mDiscount: number
(double)
Percent discount for weight > 2000 lb.
-
m30mDiscount: number
(double)
Percent discount for weight > 30,000 lb.
-
m40mDiscount: number
(double)
Percent discount for weight > 40,000 lb.
-
m5cDiscount: number
(double)
Percent discount for weight > 500 lb.
-
m5mDiscount: number
(double)
Percent discount for weight > 5000 lb.
-
minDiscount: number
(double)
Percent for minimum cost.
-
movementType: string
Qualifies the usage of the discounts defined by SMC/Carrier Connect Movement Type.
If null, then the discounts provided (by weight break) apply to all Movement Types. Otherwise - the discounts defined apply to the specified Movement Type - either Direct, Indirect, Partner or Custom. -
rateOfferingGid: string
The GID for the rate offering related to the SMC discount as table of values.
-
smcDiscSeqNum: number
(int64)
An internal sequence number for the different SMC discount entries provided by movement type.
-
stopAlternationBreak: string
Specifies the weight break where the deficit rating should stop.
Nested Schema : rateRecords.specialServices
Type:
Show Source
object
-
accessorials:
accessorials
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
-
specialServiceGid: string
The GID for the special service.
Nested Schema : accessorials
Type:
Show Source
object
-
items: array
items
-
links: array
links
Read Only:
true
Nested Schema : rateRecords.specialServices.accessorials
Type:
Show Source
object
-
accessorialCodeGid: string
The GID for the accessorial code.
-
accessorialCostGid: string
The GID for the special service related accessorial cost. The accessorial code and cost are provided in situations where the special service is provided for a charge -which is defined by the related accessorial code and cost.
-
domainName: string
Database domain where this data is stored.
-
links: array
links
Read Only:
true
Nested Schema : rateRecords.stopRates
Type:
Show Source
object
-
domainName: string
Database domain where this data is stored.
-
highStop: number
(int32)
Stop off charges are typically defined for truckload rates. In most cases, the base rate includes the pickup stop and the first delivery stop. The rate may also support the option of performing addition stops, but at an additional per stop charge. The additional per stop charges are often specified in a ranges i.e., for stops 3 to 5 the per stop charge is X for stops 6 to 7 the per stop charge is Y per stop.
The high stop field defines the high end of the range for stop off charges. -
links: array
links
Read Only:
true
-
lowStop: number
(int32)
Stop off charges are typically defined for truckload rates. In most cases, the base rate includes the pickup stop and the first delivery stop. The rate may also support the option of performing addition stops, but at an additional per stop charge. The additional per stop charges are often specified in a ranges i.e., for stops 3 to 5 the per stop charge is X for stops 6 to 7 the per stop charge is Y per stop.
The low stop fields defines the low end of the range for stop off charges. -
perStopCost:
perStopCost
The per stop charge for the low high range being defined.
Nested Schema : perStopCost
The per stop charge for the low high range being defined.
Match All
Show Source