FormatTheCheckAmount

Format the Check Amount

Minor Business Rule

Object Name: B0400400

Parent DLL: CFIN

Location: Client/Server

Language: C

1.Functional Description

1.1Purpose

The purpose of this business function is to take a payment amount and a maximum length and return a formatted string.  The formatted string will be 

the payment amount with the commas and decimal points in the correct locations based on the payment amount's currency and the user's profile as to 

whether the decimal separator is a comma or point.  Also, the formatted string will be left padded with asterisks (*) to make the string the maximum 

length.  If the payment amount cannot fit into the formatted string, because it will exceed the maximum length, then all asterisks will be returned.  


For example, if I pass in 10000 USD with a maximum length of 13, then the following will be returned ****10,000.00.  If I pass in 10000 USD with a 

maximum length of 8, then ******** will be returned, as the formatted payment amount cannot fit in the length of 8 spaces.


1.2Setup Notes and Prerequisites

Make sure the payment amount that you pass in has the correct currency decimals in the math numeric data structure.


1.3Special Logic


Data Structure

D0400400 - Format the Check Amount

Parameter NameData ItemData TypeReq/OptI/O/Both
mnPaymntAmountPAAPMATH_NUMERICREQINPUT

In the Accounts Payable system, the amount of the payment. In the Accounts Receivable system, the amount of the receipt. This amount 
must balance to the total amount applied to the invoice pay items.

szFormatedAmountDL01charOPTNONE

A user defined name or remark.

mnReturnLengthMATH01MATH_NUMERICOPTNONE

- - - Good Performance Low Value. 

Related Functions

None

Related Tables

None