ExternalRatingFunctionTemplate

External Rating Function Template

Minor Business Rule

Object Name: B4900920

Parent DLL: CTRAN

Location: Client/Server

Language: C

Data Structure

D4900920 - External Rating Function Template

Parameter NameData ItemData TypeReq/OptI/O/Both
mnFreightChargeRateAFRCGMATH_NUMERICOPTNONE

The unit or flat amount of a freight charge.

szFreightChargeCurrencyCodeCRCDcharOPTNONE

A code that identifies the currency of a transaction. 

mnRatedQuantityRTDQMATH_NUMERICOPTNONE

The quantity in weight, volume, or some other unit which was used to calculate a charge.  The type of quantity is specified by the rate basis.

szUnitOfMeasureRatedQuantityUOMcharOPTNONE

A user defined code (00/UM) that indicates the quantity in which to express an inventory item, for example, CS (case) or BX (box).

szErrorMessageIDDTAIcharOPTNONE

A code that identifies and defines a unit of information. It is an alphanumeric code up to 8 characters long that does not allow blanks or 
special characters such as %, &, or +. You create new data items using system codes 55-59. You cannot change the alias.

cUseRatingFunctionCacheEV01charOPTNONE

An option that specifies the type of processing for an event.

mnTransportationJobnumberJOBSMATH_NUMERICOPTNONE

The job number (work station ID) which executed the particular job.

mnDetailJobNumberJOBSMATH_NUMERICOPTNONE

The job number (work station ID) which executed the particular job.

cBillablePayableBLPBcharOPTNONE

Designates whether a freight charge will be billed to a client (billable) or paid to a contractor (payable). Valid values are:    B Billable    P 
Payable    *  Either billable or payable (the same table is used for both)    N Freight calculation is to be skipped for this customer/item 
combination. Customer freight is also called billable freight. Supplier freight is also called payable freight.

szFreightRateScheduleFRSCcharOPTNONE

The schedule of freight and miscellaneous charges which are applied to a shipment.

mnCarrierCARSMATH_NUMERICOPTNONE

The address number for the preferred carrier of the item. The customer or your organization might prefer a certain carrier due to route or 
special handling requirements.

szPlanningDepotVMCUcharOPTNONE

Indicates the depot from which a trip originates. The Trip Depot and the Trip Number fields identify the unique combination of vehicle, 
registration number, load date, and shift.

mnLoadNumberLDNMMATH_NUMERICOPTNONE

1

mnDeliveryNumberADLNOMATH_NUMERICOPTNONE

This is a system assigned number which is used when a shipment is placed on a load or when two or more shipments for the same 
destination appear on a single manifest or bill of lading.  In this case the shipments are rated as though there is a single shipment.

mnShipmentNumberSHPNMATH_NUMERICOPTNONE

A "next number" that uniquely identifies a shipment.

mnRoutingStepNumberRSSNMATH_NUMERICOPTNONE

This is the number assigned to a shipment routing step. The movement of a shipment from the origin to the final destination (ship to 
address) can be made up of one or more routing steps, each with an intermediate destination.

mnAddressNumberShipToSHANMATH_NUMERICOPTNONE

The address number of the location to which you want to ship this order. The address book provides default values for customer address, 
including street, city, state, zip code, and country.

szOriginDepotNMCUcharOPTNONE

This identifies the origin depot for a shipment or a load.

mnOriginAddressNumberORGNMATH_NUMERICOPTNONE

This is the address book number of the origin of a shipment. This could be the address number for the branch/plant, the address number of 
a supplier, or the address number of a hub or de-consolidation center.

szPostalCodeOriginADDOcharOPTNONE

The origin postal code of a shipment.

mnDestinationAddressNumberANCCMATH_NUMERICOPTNONE

The address book number of a hub or deconsolidation center.  A hub number is entered for a load to indicate a pooled shipment.

szZipCodePostalDestinationADDZcharOPTNONE

The United States ZIP code or the postal code that specifies where a letter is to be routed.  Attach this code to the address for delivery in 
other countries. This code is used as the low end value when doing Postal Code Transaction range processing.

mnShipmentWeightWGTSMATH_NUMERICOPTNONE

The shipment weight is qualified by a Weight Qualifier (WGQ) that identifies the type of weight.

szWeightUnitOfMeasureWTUMcharOPTNONE

The unit of measure that indicates the weight of an individual item. Typical weight units of measure are:    GM Gram    OZ Ounce    LB Pound    
KG Kilogram    CW Hundredweight    TN Ton 

mnShipmentVolumeSCVLMATH_NUMERICOPTNONE

The volume scheduled on a load or in a compartment.

szVolumeUnitOfMeasureVLUMcharOPTNONE

The unit of measure for the cubic space occupied by an inventory item. Typical volume unit of measures are:    ML Milliliter    OZ Fluid Ounce   
 PT Pint    LT Liter    CF Cubic Foot    CM Cubic Meter    CY Cubic Yard 

mnCubicContainerSpaceCCUBMATH_NUMERICOPTNONE

The volume of shipment containers which hold product.  This volume is used for cube rating instead of the volume of the products on the 
shipment.

mnTotalLoadWeightWGTSMATH_NUMERICOPTNONE

The shipment weight is qualified by a Weight Qualifier (WGQ) that identifies the type of weight.

mnTotalLoadVolumeSCVLMATH_NUMERICOPTNONE

The volume scheduled on a load or in a compartment.

mnDistanceDSTNMATH_NUMERICOPTNONE

Either the total amount of distanced traveled, or the total amount of time spent idle.

cDistanceSourceDSRCcharOPTNONE

The source of the distance for a delivery. The source could be a preference,carrier agreement, entered by the user, or retrieved from a 
mileage system.

szUnitofMeasureDistanceUMD1charOPTNONE

mnNumberofStopsNSTPMATH_NUMERICOPTNONE

The number of stops (usually deliveries) on a load.

mnNumberofPircesNPCSMATH_NUMERICOPTNONE

The number of pieces, pallets, containers, etc. which make up a shipment. For shipments that do not have piece information defined in the 
Pieces table (F4943), the system calculates the estimated piece count by converting the quantity in the transaction unit of measure to the 
shipping unit of measure. To obtain the whole piece number, the system rounds the unit of measure down. The weight and volume of the leftover 
quantities from all detail lines are added and the sum total is divided by the maximum piece weight and/or volume. The system rounds the 
resulting piece weight or volume up to the next whole number. This number is added to the whole piece number to obtain the piece count.

mnShipmentLengthLGTSMATH_NUMERICOPTNONE

The length of a shipment or shipment piece.

mnShipmentWidthWTHSMATH_NUMERICOPTNONE

The width of a shipment or shipment piece.

mnShipmentHeightHGTSMATH_NUMERICOPTNONE

The height of a shipment or shipment piece.

mnShipmentGirthGTHSMATH_NUMERICOPTNONE

The girth of a shipment or shipment piece.

szUnitofMeasureLinearLUOMcharOPTNONE

The width, height, or length unit of measure for a vehicle.

mnNumberOfContainersNCTRMATH_NUMERICOPTNONE

The number of shipping containers, pallets, etc.

mnAmountExtendedPriceAEXPMATH_NUMERICOPTNONE

The number of units multiplied by the unit price.

mnAmountForeignExtPriceFEAMATH_NUMERICOPTNONE

The product of the foreign price times the number of units.

szCurrencyCodeForeignCRCDcharOPTNONE

A code that identifies the currency of a transaction. 

mnAmountExtendedCostECSTMATH_NUMERICOPTNONE

For accounts receivable and accounts payable, the invoice (gross) amount. For sales orders and purchase orders, the unit cost times the 
number of units.

mnOutofRouteDistanceODSTMATH_NUMERICOPTNONE

The total distance which is considered outside of the normal route and may be subject to an out of route premium charge.

mnTimeElapsedELTMMATH_NUMERICOPTNONE

This is the amount of time in minutes which will be used to determine idle time freight charges.

szUnitOfMeasureTimeUMcharOPTNONE

A user defined code (00/UM) that identifies the unit of measurement for an amount or quantity. For example, it can represent a barrel, box, 
cubic meter, liter, hour, and so on.

szRouteCodeROUTcharOPTNONE

The route field is a user defined code (system 42, type RT) that represents the delivery route on which the customer resides. This field is 
one of several factors used by the freight summary facility to calculate potential freight charges for an order. For picking, use the route code with 
the stop and zone codes to group all of the items that are to be loaded onto a delivery vehicle for a specific route. You set up a default for 
each of these fields on the Customer Billing Instruction form.

szZoneNumberZONcharOPTNONE

The zone field is a user defined code (system 40, type ZN) that represents the delivery area in which the customer resides. This field is one 
of several factors used by freight summary facility to calculate potential freight charges for an order. For picking you can use the zone code 
with the route and stop codes to group all item that are to be loaded onto a delivery vehicle for a specific route. You set up the default for each 
of these fields on the Customer Billing Instructions form.

szCarrierZoneCZONcharOPTNONE

The identifier used by a carrier to identify a specific zone. For example, ZONE-21 might refer to a zone used by a parcel carrier to 
determine the freight charge for deliveries to specific zip codes.

mnRouteNumberRTNMATH_NUMERICOPTNONE

A number assigned by the system to each routing record.

szShipmentCategoryCode1SCT1charOPTNONE

A generic field used to store information about a shipment.  This field can loaded from an address book category.

szShipmentCategoryCode2SCT2charOPTNONE

A generic field used to store information about a shipment.  This field can loaded from an address book category.

szShipmentCategoryCode3SCT3charOPTNONE

A generic field used to store information about a shipment.  This field can loaded from an address book category.

jdDatePromisedPickJuPPDJJDEDATEOPTNONE

The promised shipment date for a sales order. This date represents the day that the item can be shipped from the warehouse.

szOwningBranchPlantMCUcharOPTNONE

An alphanumeric code that identifies a separate entity within a business for which you want to track costs. For example, a business unit 
might be a warehouse location, job, project, work center, branch, or plant. You can assign a business unit to a document, entity, or person for 
purposes of responsibility reporting. For example, the system provides reports of open accounts payable and accounts receivable by 
business unit to track equipment by responsible department. Business unit security might prevent you from viewing information about business units 
for which you have no authority.

szChargeCode1CGC1charOPTNONE

A user defined code which classifies the freight charge.

szShipmentLevelPayableSLPFcharOPTNONE

A flag used to specify that payable freight should be calculated at the shipment or delivery level instead of at the load level.

szDefaultFreightClassificationNMFCcharOPTNONE

The National Motor Freight Classification which is assigned according to the freight commodity code.

szStandardCarrierAlphaCodeSCACcharOPTNONE

A unique four-character code assigned to the carrier.

szRateNameRTNMcharOPTNONE

The name of the rate which is used to define and calculate a freight charge.

cRateBasisFreightRTGBcharOPTNONE

The basis used to calculate the charge.

cRateLevelSHPCcharOPTNONE

A flag that indicates whether a rate is applied to an entire shipment or to individual pieces on a shipment. Depending on how the rate is 
applied to a shipment, the rates are added together for a total freight cost, piece level, or at a detail level where the shipment is rated as a 
combination of both the shipment and piece level. This field also indicates how a load is rated versus how a shipment is rated.

cRateDetailLevelRDLVcharOPTNONE

This flag identifies the shipment detail field that determines a rate when the charge is applied at the shipment detail level. You can specify 
one of the following fields:     o Freight Classification Code     o Dispatch Group     o Freight Category 1     o Freight Category 2 

szFreightDetailKeyGS1AcharOPTNONE

szCurrencyCodeDomesticCRDCcharOPTNONE

A code that identifies the domestic (base) currency of the company on a transaction. 

szCurrencyCodeCarrierCRCDcharOPTNONE

A code that identifies the currency of a transaction. 

szCurrencyCodeShipToCRCDcharOPTNONE

A code that identifies the currency of a transaction. 

cRateTypFRTPcharOPTNONE

The type of rate specified in a table.  This could be a fixed amount or percentage, for example.

cInboundRouteSelectedIBRScharOPTNONE

This option indicates an inbound route.

Related Functions

None

Related Tables

None