GetHoldCodeInformation

Get Hold Code Information

Minor Business Rule

Object Name: B4001110

Parent DLL: CDIST

Location: Client/Server

Language: C

This Business Function retrieves all columns from the Hold Codes table (F42008).  If the Hold Code 
has not been found then this Business Functions sends back an error flag of '1'

Data Structure

D4001110 -  Get Hold Code Information

Parameter NameData ItemData TypeReq/OptI/O/Both
szBranchPlantMCUcharNONENONE

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.

szHoldCodeHCODcharNONENONE

A user defined code (42/HC) that identifies why an order was placed on hold (for example, credit, budget, or margin standards were 
exceeded).

szCodeTypeCTYPcharNONENONE

A code that determines whether the hold code applies to an individual line within an order (L) or the order as a whole (O). For credit holds, 
the hold code applies to the whole order. For margin holds, you can apply the hold code to a line or the whole order.

mnPersonResponsibleRPERMATH_NUMERICNONENONE

The address book number of the person who is responsible for reviewing and releasing orders placed on hold.

szTypeCriteriaTYPCcharNONENONE

A code that categorizes hold codes into groups. Some examples of codes include:    A Amount Hold    C Credit Hold    M Margin Hold    Q 
Quantity Hold 

szLimitTypeLTYPcharNONENONE

A code that indicates whether there is an amount limit (A) or a percentage limit (%) for the order. Limit type typically applies only on order or 
line gross margin limits.

mnLimitLowerComparisonLLCMATH_NUMERICNONENONE

A number that indicates the lower limit that the system uses as the low end of the range of acceptable margin percentages or amounts. You 
can establish a minimum gross margin percentage or amount for an order or for an individual order line.

mnLimitUpperComparisonULCMATH_NUMERICNONENONE

A number that indicates the upper limit that the system uses as the high end of a range of acceptable margin percentages or amounts. Use 
this code when you want to establish a maximum gross margin percentage or amount for an order or an individual order line.

szPasswordPWRDcharNONENONE

A series of characters that you must enter before the system updates a table. In the Distribution systems, the password secures 
commissions setup and the release of held orders. Only users with access to the password can release an order. The system does not display the 
password on the form. You should not enter blanks anywhere in the password

szDescriptionDSC1charNONENONE

Brief information about an item; a remark or an explanation.

mnPercentPastDuePPLMATH_NUMERICNONENONE

Number that tells the system what percentage of total receivables to accept in the column specified in the Age From field.  When aging 
credit checking is used, the allowable % field is required entry. For example, Your customer has a total A/R balance of 10,000 and 2,500 of that is 
in the 31-60 day column.  The Age From value is 3 (31-60 days) and the Acceptable % value is 10 (10%).  Therefore, this customer could 
have as much as 1,000 (10,000 x 10%) in columns 3 through 6 and still pass this credit check.  Since the customer has more, the system will place 
its orders on hold.

cAgingPeriodAPBcharNONENONE

Number that designates the aging period the system should use when you specify a credit check based on the aging of the customer's 
accounts receivable.

cErrorCodeERRcharNONENONE

The Data Field Error Code field is simply a generic data field to pass an error condition flag.  This field is one of the fields that make up the 
external parameter data structure of the Data Dictionary Server.

Related Functions

None

Related Tables

F42008 Order Hold Constants