CreateAndUpdateRetainRecord

Create and Update Retainage F4812 Record

Minor Business Rule

Object Name: N48S0740

Parent DLL: CCRIN

Location: Client/Server

Language: NER

Data Structure

D48S0740 - Create and Update Retainage F4812 Record Data Structure

Parameter NameData ItemData TypeReq/OptI/O/Both
mnInvNo_DOCZDOCZMATH_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

szInvDocType_DCTIDCTIcharREQINPUT

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.

szInvDocKeyCo_KCOIKCOIcharREQINPUT

Invoice Document Company.

szPayItem_SFXSFXcharREQINPUT

A number that identifies the pay item for a voucher or an invoice. The system assigns the pay item number. If the voucher or invoice has 
multiple pay items, the numbers are sequential.

mnContractNo_DOCODOCOMATH_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.

szContractDocType_DCTODCTOcharOPTINPUT

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

szContractKeyCo_KCOOKCOOcharOPTINPUT

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.

szContractChangeOrder_COCHCOCHcharOPTINPUT

The change number of the contract. The change order number of the base contract is always initialized to 000. Each time you enter a 
change order for a contract, the system automatically increases the change order number by one. For example, the base contract is the change 
order number 000, the first change order is 001, the second is 002, and so on.

mnLineNo_LNIDLNIDMATH_NUMERICOPTINPUT

A number that identifies multiple occurrences, such as line numbers on a purchase order or other document. Generally, the system assigns 
this number,but in some cases you can override it.

szBillingLine_OPIMOPIMcharOPTINPUT

The pay item number as defined by the owner. This field is alphanumeric and can be up to 15 characters in length. It is recommended that 
you use numeric information for this pay item number.

mnBatchNo_ICUICUMATH_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.

jdApplicatnDate_APDTAPDTJDEDATEREQINPUT

The date of the last or current application. (An application is assigned each time an invoice is issued for the contract.)

jdWorkfileGLDate_DGJDGJJDEDATEREQINPUT

A date that identifies the financial period to which the transaction will be posted. You define financial periods for a date pattern code that you 
assign to the company record. The system compares the date that you enter on the transaction to the fiscal date pattern assigned to the 
company to retrieve the appropriate fiscal period number, as well as to perform date validations.

mnGLCentury_CTRYCTRYMATH_NUMERICOPTINPUT

The calendar century associated with the year. Enter is the first two digits of the year. For example, 19 indicates any year beginning with 19 
(1998, 1999), 20 indicates any year beginning with 20 (2000, 2001), and so on.

mnFiscalYear_FYFYMATH_NUMERICOPTINPUT

A number that identifies the fiscal year. Generally, you can either enter a number in this field or leave it blank to indicate the current fiscal 
year (as defined on the Company Setup form). Specify the year at the end of the first period rather than the year at the end of the fiscal period. 
For example, a fiscal year begins October 1, 1998 and ends September 30, 1999. The end of the first period is October 31, 1998. Specify the 
year 98 rather than 99.

mnPeriodNo_PNPNMATH_NUMERICOPTINPUT

A number indicating the current accounting period.  This number, used in conjunction with the Company Constants table (F0010) and the 
General Constants table (F0009), allows the user to define up to 14 accounting periods. See General Ledger Date.  The current period number 
is used to determine posted before and posted after cut off warning messages.  It is also used as the default accounting period in the 
preparation of financial reports.

jdServiceDate_DSVJDSVJJDEDATEREQINPUT

A date that indicates when you purchased goods or services, or when you incurred a tax liability. 

cExchangeRateDateBasis_ERDBERDBcharOPTINPUT

A code that controls which date the system uses to retrieve the exchange rate for the invoice. Valid values are: 1 Use the invoice date 
(default). 2 Use the G/L date of the invoice.

szBaseCurrency_CRCDCRCDcharOPTINPUT

A code that identifies the currency of a transaction. 

szForeignCurrency_CRCFCRCFcharOPTINPUT

The currency code of the insured amount.

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.

mnCurrencyRate_CRRDCRRDMATH_NUMERICOPTINPUT

A number (exchange rate) that a foreign currency amount is divided by to calculate a domestic currency amount. The number you enter in 
this field can have a maximum of seven decimal positions. If more are entered, the system adjusts to the nearest seven decimal positions. 

szBusinessUnit_MCUMCUcharREQINPUT

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.

cRetainageControl_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.

mnCustomerNumber_AN8OAN8OMATH_NUMERICOPTINPUT

The address book number to which the system posts billing and accounts receivable transactions.

szCompany_COCOcharOPTINPUT

A code that identifies a specific organization, fund, or other reporting entity. The company code must already exist in the Company 
Constants table (F0010) and must identify a reporting entity that has a complete balance sheet. At this level, you can have intercompany 
transactions. Note: You can use company 00000 for default values such as dates and automatic accounting instructions. You cannot use company 00000 
for transaction entries.

mnParentContractNo_PCTNPCTNMATH_NUMERICOPTINPUT

The parent contract number to which this particular contract is attached.

szParentContractType_PCTTPCTTcharOPTINPUT

The parent contract type to which this particular contract is attached.

szParentContractKeyCo_PCKOPCKOcharOPTINPUT

Parent Contract Document Company.

szHostBusinessUnit_JMCUJMCUcharREQINPUT

The Business Unit responsible for the job.  This is particularly useful during transfer pricing.

szBillingLineDescription_DL01DL01charOPTINPUT

A user defined name or remark.

cBillingLineType_PRTPPRTPcharOPTINPUT

A code that specifies the billing terms that are defined by the billing line on the contract. The system uses the predefined codes for the 
pricing type to access formulas and other information related to the calculation of billing and revenue amounts for the billing line. Valid alphabetic 
codes are: B Burden T Time and Materials U Unit Price L Lump Sum F Fee Line C Component M Milestone P Progress D Direct Draw R Rated 
Draw Valid numeric codes are: 0 Burden 1 Time and Materials 2 Unit Price 3 Lump Sum 4 Fee Line 5 Component 6 Milestone 7 Progress 8 Direct 
Draw 9 Rated Draw

szProjectNo_MCUSMCUScharOPTINPUT

Either a subsequent business unit or a project number. A subsequent business unit specifies where to charge costs (or revenues) when the 
original business unit has been closed or suspended. For example, the subsequent business unit can be used in corporate reorganizations 
when you close a business unit and direct all costs to the subsequent business unit. In this situation, you must enter journal entries to transfer 
existing balances. A project number is used to group business units within an overall business unit. For example, you can group jobs by 
project. In this case, the project business unit can also have accounts for tracking overhead costs that can be allocated to jobs.

szTaxExplanationCode_EXR1EXR1charOPTINPUT

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.

szTaxRateArea_TXA1TXA1charOPTINPUT

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.

szRetentionGLClass_RGLCRGLCcharREQINPUT

A code that designates the offset accounts for retainage, for example RETN or 1225. You set up the code as an automatic accounting 
instruction. Note:  Do not use code 9999. This is reserved for the post program and indicates that offsets should not be created.

cVertexActive_VVTXVVTXcharOPTINPUT

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. 

mnVertexJobNumber_JOBSJOBSMATH_NUMERICOPTINPUT

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

szVertexTransactionType_VVTYVVTYcharOPTINPUT

Vertex Sales and Use Tax transaction type.

szVertexProductCategory_VVTCVVTCcharOPTINPUT

User defined code used in the Vertex Tax Decision Maker for products or services that are non-taxable or are at a non-stanard rate.

szUpdageProgramID_PIDPIDcharREQINPUT

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.

szPaymentTermsCode01_PTCPTCcharREQINPUT

A code that specifies the terms of payment, including the percentage of discount available if the invoice is paid by the discount due date. 
Use a blank code to indicate the most frequently-used payment term. You define each type of payment term on the Payment Terms Revisions 
form. Examples of payment terms include: Blank Net 15 001      1/10 net 30 002      2/10 net 30 003      Due on the 10th day of every month 006     
Due upon receipt  This code prints on customer invoices.

mnRetainage_RTNGRTNGMATH_NUMERICOPTINPUT

This field is the retained dollars for a contract line.

mnRetainageForeign_FTNGFTNGMATH_NUMERICOPTINPUT

xThis field is the retained dollars for a contract line.

mnDeferredTaxDomestic_DDTRDDTRMATH_NUMERICOPTBOTH

The deferred tax associated with the retainage amount.

mnDeferredTaxForeign_FDTRFDTRMATH_NUMERICOPTBOTH

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

mnAmtTax2_STAMSTAMMATH_NUMERICOPTBOTH

The amount assessed and payable to tax authorities. It is the total of the VAT, use, and sales taxes (PST).

mnForeignTaxAmount_CTAMCTAMMATH_NUMERICOPTBOTH

The tax amount in foreign currency.  This can be the sales, use, or VAT tax. 

mnThisPeriod_THPDTHPDMATH_NUMERICOPTOUTPUT

The amount that is being billed for this contract pay item.

mnThisPeriodForeign_FHPDFHPDMATH_NUMERICOPTOUTPUT

The amount that is being billed for this contract pay item. On entry screens,you can enter this amount one of three ways:     o A Dollar 
Amount.     o A Percent Complete. Enter a percent sign % before or after the percent complete amount. For example, you can enter 10% complete as 
%10 or 10%.        The system calculates this amount as the Schedule of Values minus prior payments.     o Number of Units. Enter a forward 
slash / before or after the number of units. For example, you can enter 10 units as /10 or 10/. The system calculates this amount as the number 
of units multiplied by the unit rate. You must have a unit rate payment type and a valid unit price for the contract pay item in order to use this 
entry method.

mnAmtDiscountAvailable_ADSCADSCMATH_NUMERICOPTBOTH

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.

mnForeignDiscountAvail_CDSCDSMATH_NUMERICOPTBOTH

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

cErrorCode_ERRCERRCcharOPTINPUT

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).

mnAmountTaxable_ATXAATXAMATH_NUMERICOPTINPUT

The amount on which taxes are assessed.

mnForeignTaxableAmount_CTXACTXAMATH_NUMERICOPTINPUT

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

mnAmountTaxExempt_ATXNATXNMATH_NUMERICOPTINPUT

The amount upon which taxes are not assessed. This is the portion of the transaction not subject to sales, use, or VAT taxes because the 
products are tax-exempt or zero-rated.

mnForeignTaxExempt_CTXNCTXNMATH_NUMERICOPTINPUT

The foreign amount associated with this document which is not subject to sales, use or value-added tax due to the nature of the transaction 
and not due to the nature of the parties to the transaction (as in tax exemption).

cCalculateDiscountsYN_EV01EV01charOPTINPUT

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

Related Functions

None

Related Tables

None