CalcAndAllocateRetainage

Calculate Contract Billing Retainage

Minor Business Rule

Object Name: N5200220

Parent DLL: CCRIN

Location: Client/Server

Language: NER

Data Structure

D5200220C - Calculate And Allocation Retainage Data Structure

Parameter NameData ItemData TypeReq/OptI/O/Both
mnDomCurrentNetAmt_ATXAATXAMATH_NUMERICOPTINPUT

The amount on which taxes are assessed.

mnForCurrentNetAmt_CTXACTXAMATH_NUMERICOPTINPUT

That portion of the sale that is subject to tax in foreign currency.

mnDomScheduleOfValues_SCOFSCOFMATH_NUMERICOPTINPUT

The expected or budgeted amount assigned to a specific line item of the contract. The system uses this amount in conjunction with the 
percent of completion to calculate billing and retainage.

mnForScheduleofValues_FSOFFSOFMATH_NUMERICOPTINPUT

The foreign expected or foreign budgeted amount assigned to a specific line item of the contract. The system uses this amount in 
conjunction with the percent of completion to calculate billing and retainage.

mnDomTotalPriorAmt_PATXPATXMATH_NUMERICOPTINPUT

mnForTotalPriorAmt_FATXFATXMATH_NUMERICOPTINPUT

cCurrencyMode_CRRMCRRMcharOPTINPUT

An option that specifies whether the system displays amounts in the domestic or foreign currency. On  The system displays amounts in the 
foreign currency of the transaction. Off  The system displays amounts in the domestic currency of the transaction.

mnDiscountPercentage_DCPDCPMATH_NUMERICOPTINPUT

The percent of the total invoice or voucher that you will discount if it is paid within the discount period. You enter the discount percent as a 
decimal, for example, a 2 percent discount is .02.

mnNoOfRowsForAlloc_MATH01MATH01MATH_NUMERICOPTINPUT

- - - Good Performance Low Value. 

szRetainageRule_RTNRRTNRcharOPTINPUT

A rule the system uses to calculate retainage on a contract. For example: Retn % - 10.00; Percent Complete - 50.00 Retn % - 5.00; Percent 
Complete - 95.00 This rule indicates that there is a 10% retainage until 50% of the job is complete. Then a 5% retainage is calculated for the next 
45% of the job until 95% of the job is complete. Once 95% of the job is complete, retainage is no longer withheld.

szProgramId_PIDPIDcharOPTINPUT

The number that identifies the batch or interactive program (batch or interactive object). For example, the number of the Sales Order Entry 
interactive program is P4210, and the number of the Print Invoices batch process report is R42565. The program ID is a variable length value. 
It is assigned according to a structured syntax in the form TSSXXX, where: T The first character of the number is alphabetic and identifies the 
type, such as P for Program, R for Report, and so on. For example, the value P in the number P4210 indicates that the object is a 
program. SS The second and third characters of the number are numeric and identify the system code. For example, the value 42 in the number P4210 
indicates that this program belongs to system 42, which is the Sales Order Processing system. XXX The remaining characters of the numer are 
numeric and identify a unique program or report. For example, the value 10 in the number P4210 indicates that this is the Sales Order Entry 
program.

idObjectIdentifier_OBIDOBIDIDOPTBOTH

The Object Identifier uniquely identifies a control on a form.

mnDomPriorRetainage_RTNPRTNPMATH_NUMERICOPTINPUT

Retainage Amount through the last application or adjustment for a specific contract.

mnForPriorRetainage_FTNPFTNPMATH_NUMERICOPTINPUT

Retainage Amount through the last application or adjustment for a specific contract.

szCacheComputerID_CTIDCTIDcharOPTINPUT

mnCacheJobnumber_JOBSJOBSMATH_NUMERICOPTINPUT

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

szUserId_USERUSERcharOPTINPUT

The code that identifies a user profile.

jdDateUpdated_UPMJUPMJJDEDATEOPTINPUT

The date that specifies the last update to the file record.

mnTimeLastUpdated_UPMTUPMTMATH_NUMERICOPTINPUT

The time that specifies when the program executed the last update to this record.

szWorkStationId_JOBNJOBNcharOPTINPUT

The code that identifies the work station ID that executed a particular job.

mnBatchNumber_ICUICUMATH_NUMERICOPTINPUT

A number that identifies a group of transactions that the system processes and balances as a unit. When you enter a batch, you can either 
assign a batch number or let the system assign it using the Next Numbers program.

mnDocumentOrderAlt_DOCZDOCZMATH_NUMERICOPTINPUT

The original document number.  This can be a voucher, an invoice, unapplied cash, a journal entry number, etc.  Matching document 
numbers are also used to identify related documents in the Accounts Receivable and Accounts Payable systems.  See matching document 
(DOCM).  This document number (DOCO) is always the original document number, and the matching document number (DOCM) is the check, 
adjustment, or credit to be applied against the original document. For example: A/P Automated/Manual Payment: Original (DOCO) - Voucher; 
Matching Document (DOCM) - Payment  A/R Original Invoice: Original (DOCO) - Invoice  Receipt Application: Original (DOCO) - Invoice; Matching 
Document (DOCM) - Receipt Credit Memo/Adjustment: Original (DOCO) - Invoice; Matching Document (DOCM) -Credit Memo  Unapplied 
Case: Original (DOCO) - Receipt

szDocTypeInvoiceOnly_DCTIDCTIcharOPTINPUT

A user defined (00/DI) document type for invoice entry. Any document type set up for invoice-only entry should begin with the letter R 
(receivables). The default is RI, RR, or RM. Reserved document types have been defined for vouchers, invoices, receipts, and time sheets. The 
reserved document types are: P_ Accounts Payable Documents R_Accounts Receivable Documents T_ Payroll Documents I_Inventory 
Documents O_ Order Processing Documents  Note: Verify that the default document type for invoices is set up in both UDC 00/DT and UDC 00/DI.

szDocumentCompanyInvoice_KCOIKCOIcharOPTINPUT

Invoice Document Company.

mnAmountDocumentsEntered_DOCNDOCNMATH_NUMERICOPTINPUT

If you are using the batch control feature, the number of transactions entered into the batch. If you are not using batch control, the system 
displays the number as negative. Note: The batch review screen is used by many J.D. Edwards systems. As a result, this field might not apply to 
batches created by your particular system.

mnAmountEntered_AMEAMEMATH_NUMERICOPTINPUT

The total amount of transactions entered.

mnAplicationNumberAPPLMATH_NUMERICOPTINPUT

The last or current application number for the specified contract. (The system assigns a new application number each time an invoice is 
issued for the contract.)

mnAdjustmentNumberADJNMATH_NUMERICOPTINPUT

A number used to control changes to closed applications. Closed applications represent invoices that have been sent. This number is 
always zero unless you reopen a previous application.

Related Functions

None

Related Tables

None
CalcCntrctBillingRetainage

CalcCntrctBillingRetainage

Calculate Contract Billing Retainage

Minor Business Rule

Object Name: N5200220

Parent DLL: CCRIN

Location: Client/Server

Language: NER

Data Structure

D5200220 - Calculate Contract Billing Retainage Data Structure

Parameter NameData ItemData TypeReq/OptI/O/Both
mnBatchNumberICUMATH_NUMERICREQINPUT

A number that identifies a group of transactions that the system processes and balances as a unit. When you enter a batch, you can either 
assign a batch number or let the system assign it using the Next Numbers program.

mnDocumentOrderAltDOCZMATH_NUMERICREQINPUT

The original document number.  This can be a voucher, an invoice, unapplied cash, a journal entry number, etc.  Matching document 
numbers are also used to identify related documents in the Accounts Receivable and Accounts Payable systems.  See matching document 
(DOCM).  This document number (DOCO) is always the original document number, and the matching document number (DOCM) is the check, 
adjustment, or credit to be applied against the original document. For example: A/P Automated/Manual Payment: Original (DOCO) - Voucher; 
Matching Document (DOCM) - Payment  A/R Original Invoice: Original (DOCO) - Invoice  Receipt Application: Original (DOCO) - Invoice; Matching 
Document (DOCM) - Receipt Credit Memo/Adjustment: Original (DOCO) - Invoice; Matching Document (DOCM) -Credit Memo  Unapplied 
Case: Original (DOCO) - Receipt

szDocTypeInvoiceOnlyDCTIcharREQINPUT

A user defined (00/DI) document type for invoice entry. Any document type set up for invoice-only entry should begin with the letter R 
(receivables). The default is RI, RR, or RM. Reserved document types have been defined for vouchers, invoices, receipts, and time sheets. The 
reserved document types are: P_ Accounts Payable Documents R_Accounts Receivable Documents T_ Payroll Documents I_Inventory 
Documents O_ Order Processing Documents  Note: Verify that the default document type for invoices is set up in both UDC 00/DT and UDC 00/DI.

szDocumentCompanyInvoiceKCOIcharREQINPUT

Invoice Document Company.

szProgramIdPIDcharREQINPUT

The number that identifies the batch or interactive program (batch or interactive object). For example, the number of the Sales Order Entry 
interactive program is P4210, and the number of the Print Invoices batch process report is R42565. The program ID is a variable length value. 
It is assigned according to a structured syntax in the form TSSXXX, where: T The first character of the number is alphabetic and identifies the 
type, such as P for Program, R for Report, and so on. For example, the value P in the number P4210 indicates that the object is a 
program. SS The second and third characters of the number are numeric and identify the system code. For example, the value 42 in the number P4210 
indicates that this program belongs to system 42, which is the Sales Order Processing system. XXX The remaining characters of the numer are 
numeric and identify a unique program or report. For example, the value 10 in the number P4210 indicates that this is the Sales Order Entry 
program.

cErrorCodeERRCcharOPTOUTPUT

This error code indicates if any errors occurred during the creation of the Trip Document Detail (F4914) records by the Delivery Document 
Set Server program (XT4914).

idObjectIdentifierOBIDIDOPTINPUT

The Object Identifier uniquely identifies a control on a form.

cActivateVertexTaxCompliaVVTXcharOPTINPUT

This flag determines whether to use the Vertex Tax Compliance system for tax calculations.  Values are: Y  Use Vertex system to calculate 
taxes.  N Do not use Vertex system to calculate taxes.  Instead, use JDE tax calculations. 

mnVertexJobNumberJOBSMATH_NUMERICOPTINPUT

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

mnDocumentOrderInvoiceEDOCOMATH_NUMERICOPTINPUT

A number that identifies an original document. This document can be a voucher, a sales order, an invoice, unapplied cash, a journal entry, 
and so on.

szOrderTypeDCTOcharOPTINPUT

A user defined code (00/DT) that identifies the type of document. This code also indicates the origin of the transaction. J.D. Edwards has 
reserved document type codes for vouchers, invoices, receipts, and time sheets, which create automatic offset entries during the post 
program. (These entries are not self-balancing when you originally enter them.) The following document types are defined by J.D. Edwards and 
should not be changed: P Accounts Payable documents   R Accounts Receivable documents   T Payroll documents   I Inventory documents  
O Purchase Order Processing documents   J General Accounting/Joint Interest Billing documents   S Sales Order Processing documents

szCompanyKeyOrderNoKCOOcharOPTINPUT

A number that, along with order number and order type, uniquely identifies an order document (such as a purchase order, a contract, a 
sales order, and so on). If you use the Next Numbers by Company/Fiscal Year facility, the Automatic Next Numbers program (X0010) uses the 
order company to retrieve the correct next number for that company. If two or more order documents have the same order number and order 
type, the order company lets you locate the desired document. If you use the regular Next Numbers facility, the order company is not used to 
assign a next number. In this case, you probably would not use the order company to locate the document.

mnAplicationNumberAPPLMATH_NUMERICOPTINPUT

The last or current application number for the specified contract. (The system assigns a new application number each time an invoice is 
issued for the contract.)

mnAdjustmentNumberADJNMATH_NUMERICOPTINPUT

A number used to control changes to closed applications. Closed applications represent invoices that have been sent. This number is 
always zero unless you reopen a previous application.

Related Functions

None

Related Tables

None
CalculateRetainage

CalculateRetainage

Calculate Contract Billing Retainage

Minor Business Rule

Object Name: N5200220

Parent DLL: CCRIN

Location: Client/Server

Language: NER

Data Structure

D5200220B - Calculate Retainage Data Structure

Parameter NameData ItemData TypeReq/OptI/O/Both
mnDomTaxableBilledToDate_ATXAATXAMATH_NUMERICOPTINPUT

The amount on which taxes are assessed.

mnForTaxableBilledToDate_CTXACTXAMATH_NUMERICOPTINPUT

That portion of the sale that is subject to tax in foreign currency.

mnDomScheduleOfValues_SCOFSCOFMATH_NUMERICOPTINPUT

The expected or budgeted amount assigned to a specific line item of the contract. The system uses this amount in conjunction with the 
percent of completion to calculate billing and retainage.

mnForScheduleofValues_FSOFFSOFMATH_NUMERICOPTINPUT

The foreign expected or foreign budgeted amount assigned to a specific line item of the contract. The system uses this amount in 
conjunction with the percent of completion to calculate billing and retainage.

mnDomPriorTaxableAmt_PATXPATXMATH_NUMERICOPTINPUT

mnForPriorTaxableAmt_FATXFATXMATH_NUMERICOPTINPUT

mnDomPriorRetainage_RTNPRTNPMATH_NUMERICOPTINPUT

Retainage Amount through the last application or adjustment for a specific contract.

mnForPriorRetainage_FTNPFTNPMATH_NUMERICOPTINPUT

Retainage Amount through the last application or adjustment for a specific contract.

cCurrencyMode_CRRMCRRMcharOPTINPUT

An option that specifies whether the system displays amounts in the domestic or foreign currency. On  The system displays amounts in the 
foreign currency of the transaction. Off  The system displays amounts in the domestic currency of the transaction.

szRetainageRule_RTNRRTNRcharOPTINPUT

A rule the system uses to calculate retainage on a contract. For example: Retn % - 10.00; Percent Complete - 50.00 Retn % - 5.00; Percent 
Complete - 95.00 This rule indicates that there is a 10% retainage until 50% of the job is complete. Then a 5% retainage is calculated for the next 
45% of the job until 95% of the job is complete. Once 95% of the job is complete, retainage is no longer withheld.

mnDomCurrentRetainage_RTNGRTNGMATH_NUMERICOPTOUTPUT

This field is the retained dollars for a contract line.

mnForCurrentRetainage_FTNGFTNGMATH_NUMERICOPTOUTPUT

xThis field is the retained dollars for a contract line.

Related Functions

None

Related Tables

None
RecalcDiscountAndDeferred

RecalcDiscountAndDeferred

Calculate Contract Billing Retainage

Minor Business Rule

Object Name: N5200220

Parent DLL: CCRIN

Location: Client/Server

Language: NER

Data Structure

D5200220A - Recalculate Discount and Deferred Data Structure

Parameter NameData ItemData TypeReq/OptI/O/Both
mnDomCurrentNetAmt_ATXAATXAMATH_NUMERICREQINPUT

The amount on which taxes are assessed.

mnForCurrentNetAmt_CTXACTXAMATH_NUMERICREQINPUT

That portion of the sale that is subject to tax in foreign currency.

mnDomRetainage_RTNGRTNGMATH_NUMERICREQINPUT

This field is the retained dollars for a contract line.

mnForRetainage_FTNGFTNGMATH_NUMERICREQINPUT

xThis field is the retained dollars for a contract line.

mnDiscountPercent_DCPDCPMATH_NUMERICREQINPUT

The percent of the total invoice or voucher that you will discount if it is paid within the discount period. You enter the discount percent as a 
decimal, for example, a 2 percent discount is .02.

cRetainageControlFlag_RCTLRCTLcharREQINPUT

An option that determines whether the retainage amount is stored in the Accounts Receivable or General Accounting system and whether 
tax is calculated on the whole amount, including the retainage, or on each amount as it is billed. Valid values are: Blank The retainage is 
stored in the Accounts Receivable system and the tax is computed from the total taxable amount. 1 The retainage is stored in the Accounts 
Receivable system and the tax on the retainage amount is calculated and then subtracted from the total tax amount. This tax on retainage is 
deferred until the retainage is released. 2 The retainage is stored in the General Accounting system and the tax is computed from the total taxable 
amount. 3 The retainage is stored in the General Accounting system and the tax on the retainage amount is calculated and then subtracted from 
the total tax amount. This tax on retainage is deferred until the retainage is released.

szTaxRateArea_TXA1TXA1charREQINPUT

A code that identifies a tax or geographic area that has common tax rates and tax authorities. The system validates the code you enter 
against the Tax Areas table (F4008). The system uses the tax rate area in conjunction with the tax explanation code and tax rules to calculate tax 
and G/L distribution amounts when you create an invoice or voucher.

szTaxExplanationCode_EXR1EXR1charREQINPUT

A hard-coded user defined code (00/EX) that controls the algorithm that the system uses to calculate tax and G/L distribution amounts. The 
system uses the tax explanation code in conjunction with the tax rate area and tax rules to determine how the tax is calculated. Each 
transaction pay item can be defined with a different tax explanation code.

cCurrencyMode_CRRMCRRMcharREQINPUT

An option that specifies whether the system displays amounts in the domestic or foreign currency. On  The system displays amounts in the 
foreign currency of the transaction. Off  The system displays amounts in the domestic currency of the transaction.

mnDomCurrentDiscount_ADSCADSCMATH_NUMERICOPTOUTPUT

The amount of the invoice or voucher pay item that is eligible to be subtracted from the gross amount when the transaction is paid. The 
system calculates discount amounts based on the payment term entered on the transaction.  Note: If the system calculates the discount, verify 
that it applies to the pay item specified. Usually, freight, sales tax, and labor charges that are included in the gross amount do not qualify for 
discounts.

mnForCurrentDiscount_CDSCDSMATH_NUMERICOPTOUTPUT

The foreign amount of the discount available as opposed to the amount of the discount actually taken.

mnDomCurrentDeferredTax_DDTRDDTRMATH_NUMERICOPTOUTPUT

The deferred tax associated with the retainage amount.

mnForCurrentDeferredTax_FDTRFDTRMATH_NUMERICOPTOUTPUT

The deferred tax associated with the retainage stored in the foreign currency of the transaction.

Related Functions

None

Related Tables

None