NettingHeaderAddCacheEntry

Maintain Account Netting Header Cache

Major Business Rule

Object Name: B03B0177

Parent DLL: CFIN

Location: Client/Server

Language: C

Functional Description

Purpose
This function is used to add a cache entry for the account netting header and it is part of the
Maintain Account Netting Header Cache function (B03B0177). The Account Netting MBFN (N03B0176), which
maintains and updates cache records for the account netting process, primarily uses this function. However,
this function is a standalone function and it can be called from other applications to directly
access the cache.

Setup Notes and Prerequisites
A valid job number is required in order to call this function.

Special Logic
None.

Technical Specification



Parameters


Item DescriptionI/OReq?Notes


JOBSmnJobNumberIYJob Number.


ACTNcDocumentActionIN


SYszSourceSystemCodeIN


VERSszInvoiceEntryVersionIN


VERSszVoucherEntryVersionIN


VERSszJournalEntryVersionIN


VERSszReceiptEntryVersionIN


VERSszPaymentEntryVersionIN


DOCmnDocumentNumberIN


DCTszDocumentTypeIN


KCOszDocumentCompanyIN


COszCompanyIN


AN8mnAddressNumberIN


PYRmnPayorNumberIN


DGJjdGLDateIN


DIVJjdDocumentDateIN


DSVJjdTaxServiceDateIN


PAAPmnTotalNettingAmountIN


BCRCszBaseCurrencyIN


CRRMcCurrencyModeIN


CRCDszTransactionCurrencyIN


CRRmnExchangeRateIN


CRR1mnTriangulationRate1IN


CRR2mnTriangulationRate2IN


CRCMcConversionMethodIN


EFTjdTransactionDateI N


PFAPmnForeignTotalNettingAmIN


MCUszBusinessUnitIN


GLCszGLOffsetIN


TXA1szTaxRateAreaIN


EXR1szTaxExplanationCodeIN


PTCszPaymentTermsIN


RYINcPaymentInstrumentIN


RMKszRemarkIN


ALPHszAlphaNameIN


PA8mnParentNumberIN


CTRYmnCenturyIN


FYmnFiscalYearIN


PNmnPeriodNumberIN








Related Tables


None.





Related Functions


None.





Processing


Validate required fields.


If validation fails,


   Set error.


Else,


   Set the account header cache key structure.


   Initialize the account netting header cache.


 If initialization failed,


      Set error.


 Else,


      Load the cache fields to the cache data structure.


  Add the record to the account netting header cache.


 Endif.


Endif.


Perform function clean-up.

Data Structure

D03B0177A - Account Netting Header Add Cache Entry

Parameter Name	Data Item	Data Type	Req/Opt	I/O/Both
mnJobNumber	JOBS	MATH_NUMERIC	REQ	INPUT
The job number (work station ID) which executed the particular job.
cDocumentAction	ACTN	char	OPT	INPUT
A code that specifies the action that is performed. Valid values are: A Add C Change
szSourceSystemCode	SY	char	OPT	INPUT
A user defined code (98/SY) that identifies a system. Valid values include: 01 Address Book 03B Accounts Receivable 04 Accounts Payable 09 General Accounting 11 Multicurrency
szInvoiceEntryVersion	VERS	char	OPT	INPUT
A user-defined set of specifications that control how applications and reports run. You use versions to group and save a set of user-defined processing option values and data selection and sequencing options. Interactive versions are associated with applications (usually as a menu selection). Batch versions are associated with batch jobs or reports. To run a batch process, you must choose a version.
szVoucherEntryVersion	VERS	char	OPT	INPUT
A user-defined set of specifications that control how applications and reports run. You use versions to group and save a set of user-defined processing option values and data selection and sequencing options. Interactive versions are associated with applications (usually as a menu selection). Batch versions are associated with batch jobs or reports. To run a batch process, you must choose a version.
szJournalEntryVersion	VERS	char	OPT	INPUT
A user-defined set of specifications that control how applications and reports run. You use versions to group and save a set of user-defined processing option values and data selection and sequencing options. Interactive versions are associated with applications (usually as a menu selection). Batch versions are associated with batch jobs or reports. To run a batch process, you must choose a version.
szReceiptEntryVersion	VERS	char	OPT	INPUT
A user-defined set of specifications that control how applications and reports run. You use versions to group and save a set of user-defined processing option values and data selection and sequencing options. Interactive versions are associated with applications (usually as a menu selection). Batch versions are associated with batch jobs or reports. To run a batch process, you must choose a version.
szPaymentEntryVersion	VERS	char	OPT	INPUT
A user-defined set of specifications that control how applications and reports run. You use versions to group and save a set of user-defined processing option values and data selection and sequencing options. Interactive versions are associated with applications (usually as a menu selection). Batch versions are associated with batch jobs or reports. To run a batch process, you must choose a version.
mnDocumentNumber	DOC	MATH_NUMERIC	OPT	INPUT
A number that identifies the original document, such as a voucher, invoice, or journal entry. On entry forms, you can assign the document number or let the system assign it using the Next Numbers program (P0002). Matching document numbers (DOCM) identify related documents in the Accounts Receivable and Accounts Payable systems. Examples of original and matching documents are: Accounts Payable o Original document - voucher o Matching document - payment Accounts Receivable o Original document - invoice o Matching document - receipt Note: In the Accounts Receivable system, the following transactions simultaneously generate original and matching documents: deductions, unapplied receipts, chargebacks, and drafts.
szDocumentType	DCT	char	OPT	INPUT
A user defined code (00/DT) that identifies the origin and purpose of the transaction. PeopleSoft reserves several prefixes for document types, such as, vouchers, invoices, receipts, and timesheets. The reserved document type prefixes for codes are: P Accounts payable documents R Accounts receivable documents T Time and Pay documents I Inventory documents O Purchase order documents S Sales order documents
szDocumentCompany	KCO	char	OPT	INPUT
A number that, with the document number, document type and G/L date, uniquely identifies an original document, such as invoice, voucher, or journal entry. If you use the Next Numbers by Company/Fiscal Year feature, the Automatic Next Numbers program (X0010) uses the document company to retrieve the correct next number for that company. If two or more original documents have the same document number and document type, you can use the document company to locate the desired document.
szCompany	CO	char	OPT	INPUT
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.
mnAddressNumber	AN8	MATH_NUMERIC	OPT	INPUT
A number that identifies an entry in the Address Book system, such as employee, applicant, participant, customer, supplier, tenant, or location.
mnPayorNumber	PYR	MATH_NUMERIC	OPT	INPUT
The address book number of the person or company that sends the payment.
jdGLDate	DGJ	JDEDATE	OPT	INPUT
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.
jdDocumentDate	DIVJ	JDEDATE	OPT	INPUT
The date that either you or the system assigns to an invoice or voucher. This can be either the date of the supplier's invoice to you or the date of your invoice to the customer.
jdTaxServiceDate	DSVJ	JDEDATE	OPT	INPUT
A date that indicates when you purchased goods or services, or when you incurred a tax liability.
mnTotalNettingAmount	PAAP	MATH_NUMERIC	OPT	INPUT
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.
szBaseCurrency	BCRC	char	OPT	INPUT
A code that represents the currency of the company for a transaction. For a foreign currency transaction, this is the currency code of the domestic side of the transaction.
cCurrencyMode	CRRM	char	OPT	INPUT
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.
szTransactionCurrency	CRCD	char	OPT	INPUT
A code that identifies the currency of a transaction.
mnExchangeRate	CRR	MATH_NUMERIC	OPT	INPUT
A number (exchange rate) that a foreign currency amount is multiplied by to calculate a domestic currency amount. The number in this field can have a maximum of seven decimal positions. If more are entered, the system adjusts to the nearest seven decimal positions.
mnTriangulationRate1	CRR1	MATH_NUMERIC	OPT	INPUT
The exchange rate from the foreign currency of the invoice to the triangulation currency (leg 1). This rate applies when you use triangulation to calculate the exchange rate for a receipt.
mnTriangulationRate2	CRR2	MATH_NUMERIC	OPT	INPUT
The exchange rate from the triangulation currency to the domestic currency (leg 2). This rate applies when you use triangulation to calculate the exchange rate for a receipt.
cConversionMethod	CRCM	char	OPT	INPUT
A value that specifies which method to use when converting from one currency to another. Valid values are: Y Multiplier method. The system multiplies the foreign amount by the multiplier exchange rate to calculate the domestic amount. Z Divisor method. The system divides the foreign amount by the divisor exchange rate to calculate the domestic amount.
jdTransactionDate	EFT	JDEDATE	OPT	INPUT
The date that identifies when a date is first valid. The effective date is used generically. It can be a lease effective date, a price or cost effective date, a currency effective date, a tax rate effective date, or whatever is appropriate.
mnForeignTotalNettingAmount	PFAP	MATH_NUMERIC	OPT	INPUT
The foreign amount to be paid on an A/P Payment run.
szBusinessUnit	MCU	char	OPT	INPUT
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.
szGLOffset	GLC	char	OPT	INPUT
A code that determines the trade account that the system uses as the offset when you post invoices or vouchers. The system concatenates the value that you enter to the AAI item RC (for Accounts Receivable) or PC (for Accounts Payable) to locate the trade account. For example, if you enter TRAD, the system searches for the AAI item RCTRAD (for receivables) or PCTRAD (for payables). You can assign up to four alphanumeric characters to represent the G/L offset or you can assign the three-character currency code (if you enter transactions in a multicurrency environment). You must, however, set up the corresponding AAI item for the system to use; otherwise, the system ignores the G/L offset and uses the account that is set up for PC or RC for the company specified. If you set up a default value in the G/L Offset field of the customer or supplier record, the system uses the value during transaction entry unless you override it. Note: Do not use code 9999. It is reserved for the post program and indicates that offsets should not be created.
szTaxRateArea	TXA1	char	OPT	INPUT
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	EXR1	char	OPT	INPUT
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.
szPaymentTerms	PTC	char	OPT	INPUT
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.
cPaymentInstrument	RYIN	char	OPT	INPUT
The user defined code (00/PY) that specifies how payments are made by the customer. For example: C Check D Draft T Electronic funds transfer
szRemark	RMK	char	OPT	INPUT
A generic field that you use for a remark, description, name, or address.
szAlphaName	ALPH	char	OPT	INPUT
The text that names or describes an address. This 40-character alphabetic field appears on a number of forms and reports. You can enter dashes, commas, and other special characters, but the system cannot search on them when you use this field to search for a name.
mnParentNumber	PA8	MATH_NUMERIC	OPT	INPUT
The address book number of the parent company. The system uses this number to associate a particular address with a parent company or location. Any value that you enter in this field updates the Address Organizational Structure Master table (F0150) for the blank structure type. This address number must exist in the Address Book Master table (F0101) for validation purposes. Examples of address book records that would have a parent number include: o Subsidiaries with parent companies o Branches with a home office o Job sites with a general contractor
mnCentury	CTRY	MATH_NUMERIC	OPT	INPUT
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	FY	MATH_NUMERIC	OPT	INPUT
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.
mnPeriodNumber	PN	MATH_NUMERIC	OPT	INPUT
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.

Related Functions

None

Related Tables

None

NettingHeaderCreateCache

Maintain Account Netting Header Cache

Major Business Rule

Object Name: B03B0177

Parent DLL: CFIN

Location: Client/Server

Language: C

Functional Description

Purpose
This function is used to create the cache for the account netting header and it is part of the
Maintain Account Netting Header Cache function (B03B0177). The Account Netting MBFN (N03B0176), which
maintains and updates cache records for the account netting process, primarily uses this function. However,
this function is a standalone function and it can be called from other applications to directly access
the cache. Use this function without passing any parameters to or from the function.

Setup Notes and Prerequisites
None.

Special Logic
None.

Technical Specification



Parameters


Item DescriptionI/OReq?Notes


JOBSmnJobNumberNoneNNot Used.





Related Tables


None.





Related Functions


None.





Processing


Set the account netting header cache key structure.


Initialize the account netting header cache.


If initialization failed,


   Set error.


Endif.


Perform function clean-up.

Data Structure

D03B0177B - Account Netting Header Create Cache

Parameter Name	Data Item	Data Type	Req/Opt	I/O/Both
mnJobNumber	JOBS	MATH_NUMERIC	OPT	NONE
The job number (work station ID) which executed the particular job.

Related Functions

None

Related Tables

None

NettingHeaderDeleteCacheEntry

Maintain Account Netting Header Cache

Major Business Rule

Object Name: B03B0177

Parent DLL: CFIN

Location: Client/Server

Language: C

Functional Description

Purpose
This function is used to delete a cache entry for the account netting header and it is part of the
Maintain Account Netting Header Cache function (B03B0177). The Account Netting MBFN (N03B0176), which
maintains and updates cache records for the account netting process, primarily uses this function.
However, this function is a standalone function and it can be called from other applications to directly
access the cache.

Setup Notes and Prerequisites
A valid job number is required in order to call this function.

Special Logic
None.

Technical Specification



Parameters


Item DescriptionI/OReq?Notes


JOBSmnJobNumberIYJob Number.





Related Tables


None.





Related Functions


None.





Processing


Validate required fields.


If validation fails,


   Set error.


Else,


   Set the account netting header cache key structure.


   Initialize the account netting header cache.


 If initialization failed,


      Set error.


 Else,


      Open the cursor for retrieval.


  If open cursor failed,


         Set error.


      Endif.


 Endif.


   If open cursor succeeded,


      Retrieve the account netting header cache record.


      If retrieval failed,


         Set error.


      Else,


         Delete the netting header cache record.


         If delete failed,


            Set error.


         Endif.


      Endif.


   Endif.


   Destroy the account netting header cache.


Endif.


Perform function clean-up.

Data Structure

D03B0177C - Account Netting Header Delete Cache Entry

Parameter Name	Data Item	Data Type	Req/Opt	I/O/Both
mnJobNumber	JOBS	MATH_NUMERIC	REQ	INPUT
The job number (work station ID) which executed the particular job.

Related Functions

None

Related Tables

None

NettingHeaderDestroyCache

Maintain Account Netting Header Cache

Major Business Rule

Object Name: B03B0177

Parent DLL: CFIN

Location: Client/Server

Language: C

Functional Description

Purpose
This function is used to destroy the cache for the account netting header and it is part of the
Maintain Account Netting Header Cache function (B03B0177). The Account Netting MBFN (N03B0176), which
maintains and updates cache records for the account netting process, primarily uses this function. However,
this function is a standalone function and it can be called from other applications to directly
access the cache. Use this function without passing any parameters to or from the function.

Setup Notes and Prerequisites
None.

Special Logic
None.

Technical Specification



Parameters


Item DescriptionI/OReq?Notes


JOBSmnJobNumberNoneNNot used.








Related Tables


None.





Related Functions


None.





Processing


Set the account header cache key structure.


Initialize the account netting header cache.


If initialization failed,


   Set error.


Else,


   Destroy the account netting header cache.


Endif.


Perform function clean-up.

Data Structure

D03B0177D - Account Netting Header Destroy Cache

Parameter Name	Data Item	Data Type	Req/Opt	I/O/Both
mnJobNumber	JOBS	MATH_NUMERIC	OPT	NONE
The job number (work station ID) which executed the particular job.

Related Functions

None

Related Tables

None

NettingHeaderReadCacheEntry

Maintain Account Netting Header Cache

Major Business Rule

Object Name: B03B0177

Parent DLL: CFIN

Location: Client/Server

Language: C

Functional Description

Purpose
This function is used to read a cache entry for the account netting header and it is part of the
Maintain Account Netting Header Cache function (B03B0177). The Account Netting MBFN (N03B0176), which
maintains and updates cache records for the account netting process, primarily uses this function.
However, this function is a standalone function and it can be called from other applications to directly
access the cache.

Setup Notes and Prerequisites
A valid job number is required in order to call this function.

Special Logic
None.

Technical Specification



Parameters


Item DescriptionI/OReq?Notes


JOBSmnJobNumberIYJob Number.


ACTNcDocumentActionON


SYszSourceSystemCodeON


VERSszInvoiceEntryVersionON


VERSszVoucherEntryVersionON


VERSszJournalEntryVersionON


VERSszReceiptEntryVersionON


VERSszPaymentEntryVersionON


DOCmnDocumentNumberON


DCTszDocumentTypeON


KCOszDocumentCompanyON


COszCompanyON


AN8mnAddressNumberON


PYRmnPayorNumberON


DGJjdGLDateON


DIVJjdDocumentDateON


DSVJjdTaxServiceDateON


PAAPmnTotalNettingAmountON


BCRCszBaseCurrencyON


CRRMcCurrencyModeON


CRCDszTransactionCurrencyON


CRRmnExchangeRateON


CRR1mnTriangulationRate1ON


CRR2mnTriangulationRate2ON


CRCMcConversionMethodON


EFTjdTransactionDateO N


PFAPmnForeignTotalNettingAmON


MCUszBusinessUnitON


GLCszGLOffsetON


TXA1szTaxRateAreaON


EXR1szTaxExplanationCodeON


PTCszPaymentTermsON


RYINcPaymentInstrumentON


RMKszRemarkON


ALPHszAlphaNameON


PA8mnParentNumberON


CTRYmnCenturyON


FYmnFiscalYearON


PNmnPeriodNumberON








Related Tables


None.





Related Functions


None.





Processing


Validate required fields.


If validation fails,


   Set error.


Else,


   Set the account header cache key structure.


   Initialize the account netting header cache.


 If initialization failed,


      Set error.


 Else,


      Open cursor for keyed retrieval.


  If open cursor failed,


         Set error.


      Endif.


 Endif.


   If open cursor succeeded,


      Retrieve the cache record using the specified key.


      If retrieval failed,


         Set error.


      Else,


   Load the output data structure.


  Endif.


  Destroy the account header netting cache.


 Endif.


Endif.


Perform function clean-up.

Data Structure

D03B0177E - Account Netting Header Read Cache Entry

Parameter Name	Data Item	Data Type	Req/Opt	I/O/Both
mnJobNumber	JOBS	MATH_NUMERIC	REQ	INPUT
The job number (work station ID) which executed the particular job.
cDocumentAction	ACTN	char	OPT	OUTPUT
A code that specifies the action that is performed. Valid values are: A Add C Change
szSourceSystemCode	SY	char	OPT	OUTPUT
A user defined code (98/SY) that identifies a system. Valid values include: 01 Address Book 03B Accounts Receivable 04 Accounts Payable 09 General Accounting 11 Multicurrency
szInvoiceEntryVersion	VERS	char	OPT	OUTPUT
A user-defined set of specifications that control how applications and reports run. You use versions to group and save a set of user-defined processing option values and data selection and sequencing options. Interactive versions are associated with applications (usually as a menu selection). Batch versions are associated with batch jobs or reports. To run a batch process, you must choose a version.
szVoucherEntryVersion	VERS	char	OPT	OUTPUT
A user-defined set of specifications that control how applications and reports run. You use versions to group and save a set of user-defined processing option values and data selection and sequencing options. Interactive versions are associated with applications (usually as a menu selection). Batch versions are associated with batch jobs or reports. To run a batch process, you must choose a version.
szJournalEntryVersion	VERS	char	OPT	OUTPUT
A user-defined set of specifications that control how applications and reports run. You use versions to group and save a set of user-defined processing option values and data selection and sequencing options. Interactive versions are associated with applications (usually as a menu selection). Batch versions are associated with batch jobs or reports. To run a batch process, you must choose a version.
szReceiptEntryVersion	VERS	char	OPT	OUTPUT
A user-defined set of specifications that control how applications and reports run. You use versions to group and save a set of user-defined processing option values and data selection and sequencing options. Interactive versions are associated with applications (usually as a menu selection). Batch versions are associated with batch jobs or reports. To run a batch process, you must choose a version.
szPaymentEntryVersion	VERS	char	OPT	OUTPUT
A user-defined set of specifications that control how applications and reports run. You use versions to group and save a set of user-defined processing option values and data selection and sequencing options. Interactive versions are associated with applications (usually as a menu selection). Batch versions are associated with batch jobs or reports. To run a batch process, you must choose a version.
mnDocumentNumber	DOC	MATH_NUMERIC	OPT	OUTPUT
A number that identifies the original document, such as a voucher, invoice, or journal entry. On entry forms, you can assign the document number or let the system assign it using the Next Numbers program (P0002). Matching document numbers (DOCM) identify related documents in the Accounts Receivable and Accounts Payable systems. Examples of original and matching documents are: Accounts Payable o Original document - voucher o Matching document - payment Accounts Receivable o Original document - invoice o Matching document - receipt Note: In the Accounts Receivable system, the following transactions simultaneously generate original and matching documents: deductions, unapplied receipts, chargebacks, and drafts.
szDocumentType	DCT	char	OPT	OUTPUT
A user defined code (00/DT) that identifies the origin and purpose of the transaction. PeopleSoft reserves several prefixes for document types, such as, vouchers, invoices, receipts, and timesheets. The reserved document type prefixes for codes are: P Accounts payable documents R Accounts receivable documents T Time and Pay documents I Inventory documents O Purchase order documents S Sales order documents
szDocumentCompany	KCO	char	OPT	OUTPUT
A number that, with the document number, document type and G/L date, uniquely identifies an original document, such as invoice, voucher, or journal entry. If you use the Next Numbers by Company/Fiscal Year feature, the Automatic Next Numbers program (X0010) uses the document company to retrieve the correct next number for that company. If two or more original documents have the same document number and document type, you can use the document company to locate the desired document.
szCompany	CO	char	OPT	OUTPUT
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.
mnAddressNumber	AN8	MATH_NUMERIC	OPT	OUTPUT
A number that identifies an entry in the Address Book system, such as employee, applicant, participant, customer, supplier, tenant, or location.
mnPayorNumber	PYR	MATH_NUMERIC	OPT	OUTPUT
The address book number of the person or company that sends the payment.
jdGLDate	DGJ	JDEDATE	OPT	OUTPUT
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.
jdDocumentDate	DIVJ	JDEDATE	OPT	OUTPUT
The date that either you or the system assigns to an invoice or voucher. This can be either the date of the supplier's invoice to you or the date of your invoice to the customer.
jdTaxServiceDate	DSVJ	JDEDATE	OPT	OUTPUT
A date that indicates when you purchased goods or services, or when you incurred a tax liability.
mnTotalNettingAmount	PAAP	MATH_NUMERIC	OPT	OUTPUT
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.
szBaseCurrency	BCRC	char	OPT	OUTPUT
A code that represents the currency of the company for a transaction. For a foreign currency transaction, this is the currency code of the domestic side of the transaction.
cCurrencyMode	CRRM	char	OPT	OUTPUT
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.
szTransactionCurrency	CRCD	char	OPT	OUTPUT
A code that identifies the currency of a transaction.
mnExchangeRate	CRR	MATH_NUMERIC	OPT	OUTPUT
A number (exchange rate) that a foreign currency amount is multiplied by to calculate a domestic currency amount. The number in this field can have a maximum of seven decimal positions. If more are entered, the system adjusts to the nearest seven decimal positions.
mnTriangulationRate1	CRR1	MATH_NUMERIC	OPT	OUTPUT
The exchange rate from the foreign currency of the invoice to the triangulation currency (leg 1). This rate applies when you use triangulation to calculate the exchange rate for a receipt.
mnTriangulationRate2	CRR2	MATH_NUMERIC	OPT	OUTPUT
The exchange rate from the triangulation currency to the domestic currency (leg 2). This rate applies when you use triangulation to calculate the exchange rate for a receipt.
cConversionMethod	CRCM	char	OPT	OUTPUT
A value that specifies which method to use when converting from one currency to another. Valid values are: Y Multiplier method. The system multiplies the foreign amount by the multiplier exchange rate to calculate the domestic amount. Z Divisor method. The system divides the foreign amount by the divisor exchange rate to calculate the domestic amount.
jdTransactionDate	EFT	JDEDATE	OPT	OUTPUT
The date that identifies when a date is first valid. The effective date is used generically. It can be a lease effective date, a price or cost effective date, a currency effective date, a tax rate effective date, or whatever is appropriate.
mnForeignTotalNettingAmount	PFAP	MATH_NUMERIC	OPT	OUTPUT
The foreign amount to be paid on an A/P Payment run.
szBusinessUnit	MCU	char	OPT	OUTPUT
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.
szGLOffset	GLC	char	OPT	OUTPUT
A code that determines the trade account that the system uses as the offset when you post invoices or vouchers. The system concatenates the value that you enter to the AAI item RC (for Accounts Receivable) or PC (for Accounts Payable) to locate the trade account. For example, if you enter TRAD, the system searches for the AAI item RCTRAD (for receivables) or PCTRAD (for payables). You can assign up to four alphanumeric characters to represent the G/L offset or you can assign the three-character currency code (if you enter transactions in a multicurrency environment). You must, however, set up the corresponding AAI item for the system to use; otherwise, the system ignores the G/L offset and uses the account that is set up for PC or RC for the company specified. If you set up a default value in the G/L Offset field of the customer or supplier record, the system uses the value during transaction entry unless you override it. Note: Do not use code 9999. It is reserved for the post program and indicates that offsets should not be created.
szTaxRateArea	TXA1	char	OPT	OUTPUT
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	EXR1	char	OPT	OUTPUT
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.
szPaymentTerms	PTC	char	OPT	OUTPUT
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.
cPaymentInstrument	RYIN	char	OPT	OUTPUT
The user defined code (00/PY) that specifies how payments are made by the customer. For example: C Check D Draft T Electronic funds transfer
szRemark	RMK	char	OPT	OUTPUT
A generic field that you use for a remark, description, name, or address.
szAlphaName	ALPH	char	OPT	OUTPUT
The text that names or describes an address. This 40-character alphabetic field appears on a number of forms and reports. You can enter dashes, commas, and other special characters, but the system cannot search on them when you use this field to search for a name.
mnParentNumber	PA8	MATH_NUMERIC	OPT	OUTPUT
The address book number of the parent company. The system uses this number to associate a particular address with a parent company or location. Any value that you enter in this field updates the Address Organizational Structure Master table (F0150) for the blank structure type. This address number must exist in the Address Book Master table (F0101) for validation purposes. Examples of address book records that would have a parent number include: o Subsidiaries with parent companies o Branches with a home office o Job sites with a general contractor
mnCentury	CTRY	MATH_NUMERIC	OPT	OUTPUT
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	FY	MATH_NUMERIC	OPT	OUTPUT
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.
mnPeriodNumber	PN	MATH_NUMERIC	OPT	OUTPUT
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.

Related Functions

None

Related Tables

None

NettingHeaderUpdateCacheEntry

Maintain Account Netting Header Cache

Major Business Rule

Object Name: B03B0177

Parent DLL: CFIN

Location: Client/Server

Language: C

Functional Description

Purpose
This function is used to update a cache entry for the account netting header and it is part of the
Maintain Account Netting Header Cache function (B03B0177). The Account Netting MBFN (N03B0176), which
maintains and updates cache records for the account netting process, primarily uses this function.
However, this function is a standalone function and it can be called from other applications to directly
access the cache.

Setup Notes and Prerequisites
A valid job number is required in order to call this function.

Special Logic
None.

Technical Specification



Parameters


Item DescriptionI/OReq?Notes


JOBSmnJobNumberIYJob Number.


ACTNcDocumentActionIN


SYszSourceSystemCodeIN


VERSszInvoiceEntryVersionIN


VERSszVoucherEntryVersionIN


VERSszJournalEntryVersionIN


VERSszReceiptEntryVersionIN


VERSszPaymentEntryVersionIN


DOCmnDocumentNumberIN


DCTszDocumentTypeIN


KCOszDocumentCompanyIN


COszCompanyIN


AN8mnAddressNumberIN


PYRmnPayorNumberIN


DGJjdGLDateIN


DIVJjdDocumentDateIN


DSVJjdTaxServiceDateIN


PAAPmnTotalNettingAmountIN


BCRCszBaseCurrencyIN


CRRMcCurrencyModeIN


CRCDszTransactionCurrencyIN


CRRmnExchangeRateIN


CRR1mnTriangulationRate1IN


CRR2mnTriangulationRate2IN


CRCMcConversionMethodIN


EFTjdTransactionDateI N


PFAPmnForeignTotalNettingAmIN


MCUszBusinessUnitIN


GLCszGLOffsetIN


TXA1szTaxRateAreaIN


EXR1szTaxExplanationCodeIN


PTCszPaymentTermsIN


RYINcPaymentInstrumentIN


RMKszRemarkIN


ALPHszAlphaNameIN


PA8mnParentNumberIN


CTRYmnCenturyIN


FYmnFiscalYearIN


PNmnPeriodNumberIN








Related Tables


None.





Related Functions


None.





Processing


Validate required fields.


If validation fails,


   Set error.


Else,


   Set the account header cache key structure.


   Initialize the account netting header cache.


 If initialization failed,


      Set error.


 Else,


      Open cursor for retrieval


  If open cursor failed,


   Set error.


  Endif.


 Endif.


 If open cursor succeeded,


  Retrieve the account netting header cache record.


  If retrieval failed,


   Set error.


  Else,


   Update the cache fields.


   If update failed,


    Set error.


   Endif.


  Endif.


 Destroy the account netting header cache.


 Endif.


Endif.


Perform function clean-up.

Data Structure

D03B0177F - Account Netting Header Update Cache Entry

Parameter Name	Data Item	Data Type	Req/Opt	I/O/Both
mnJobNumber	JOBS	MATH_NUMERIC	REQ	INPUT
The job number (work station ID) which executed the particular job.
cDocumentAction	ACTN	char	OPT	INPUT
A code that specifies the action that is performed. Valid values are: A Add C Change
szSourceSystemCode	SY	char	OPT	INPUT
A user defined code (98/SY) that identifies a system. Valid values include: 01 Address Book 03B Accounts Receivable 04 Accounts Payable 09 General Accounting 11 Multicurrency
szInvoiceEntryVersion	VERS	char	OPT	INPUT
A user-defined set of specifications that control how applications and reports run. You use versions to group and save a set of user-defined processing option values and data selection and sequencing options. Interactive versions are associated with applications (usually as a menu selection). Batch versions are associated with batch jobs or reports. To run a batch process, you must choose a version.
szVoucherEntryVersion	VERS	char	OPT	INPUT
A user-defined set of specifications that control how applications and reports run. You use versions to group and save a set of user-defined processing option values and data selection and sequencing options. Interactive versions are associated with applications (usually as a menu selection). Batch versions are associated with batch jobs or reports. To run a batch process, you must choose a version.
szJournalEntryVersion	VERS	char	OPT	INPUT
A user-defined set of specifications that control how applications and reports run. You use versions to group and save a set of user-defined processing option values and data selection and sequencing options. Interactive versions are associated with applications (usually as a menu selection). Batch versions are associated with batch jobs or reports. To run a batch process, you must choose a version.
szReceiptEntryVersion	VERS	char	OPT	INPUT
A user-defined set of specifications that control how applications and reports run. You use versions to group and save a set of user-defined processing option values and data selection and sequencing options. Interactive versions are associated with applications (usually as a menu selection). Batch versions are associated with batch jobs or reports. To run a batch process, you must choose a version.
szPaymentEntryVersion	VERS	char	OPT	INPUT
A user-defined set of specifications that control how applications and reports run. You use versions to group and save a set of user-defined processing option values and data selection and sequencing options. Interactive versions are associated with applications (usually as a menu selection). Batch versions are associated with batch jobs or reports. To run a batch process, you must choose a version.
mnDocumentNumber	DOC	MATH_NUMERIC	OPT	INPUT
A number that identifies the original document, such as a voucher, invoice, or journal entry. On entry forms, you can assign the document number or let the system assign it using the Next Numbers program (P0002). Matching document numbers (DOCM) identify related documents in the Accounts Receivable and Accounts Payable systems. Examples of original and matching documents are: Accounts Payable o Original document - voucher o Matching document - payment Accounts Receivable o Original document - invoice o Matching document - receipt Note: In the Accounts Receivable system, the following transactions simultaneously generate original and matching documents: deductions, unapplied receipts, chargebacks, and drafts.
szDocumentType	DCT	char	OPT	INPUT
A user defined code (00/DT) that identifies the origin and purpose of the transaction. PeopleSoft reserves several prefixes for document types, such as, vouchers, invoices, receipts, and timesheets. The reserved document type prefixes for codes are: P Accounts payable documents R Accounts receivable documents T Time and Pay documents I Inventory documents O Purchase order documents S Sales order documents
szDocumentCompany	KCO	char	OPT	INPUT
A number that, with the document number, document type and G/L date, uniquely identifies an original document, such as invoice, voucher, or journal entry. If you use the Next Numbers by Company/Fiscal Year feature, the Automatic Next Numbers program (X0010) uses the document company to retrieve the correct next number for that company. If two or more original documents have the same document number and document type, you can use the document company to locate the desired document.
szCompany	CO	char	OPT	INPUT
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.
mnAddressNumber	AN8	MATH_NUMERIC	OPT	INPUT
A number that identifies an entry in the Address Book system, such as employee, applicant, participant, customer, supplier, tenant, or location.
mnPayorNumber	PYR	MATH_NUMERIC	OPT	INPUT
The address book number of the person or company that sends the payment.
jdGLDate	DGJ	JDEDATE	OPT	INPUT
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.
jdDocumentDate	DIVJ	JDEDATE	OPT	INPUT
The date that either you or the system assigns to an invoice or voucher. This can be either the date of the supplier's invoice to you or the date of your invoice to the customer.
jdTaxServiceDate	DSVJ	JDEDATE	OPT	INPUT
A date that indicates when you purchased goods or services, or when you incurred a tax liability.
mnTotalNettingAmount	PAAP	MATH_NUMERIC	OPT	INPUT
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.
szBaseCurrency	BCRC	char	OPT	INPUT
A code that represents the currency of the company for a transaction. For a foreign currency transaction, this is the currency code of the domestic side of the transaction.
cCurrencyMode	CRRM	char	OPT	INPUT
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.
szTransactionCurrency	CRCD	char	OPT	INPUT
A code that identifies the currency of a transaction.
mnExchangeRate	CRR	MATH_NUMERIC	OPT	INPUT
A number (exchange rate) that a foreign currency amount is multiplied by to calculate a domestic currency amount. The number in this field can have a maximum of seven decimal positions. If more are entered, the system adjusts to the nearest seven decimal positions.
mnTriangulationRate1	CRR1	MATH_NUMERIC	OPT	INPUT
The exchange rate from the foreign currency of the invoice to the triangulation currency (leg 1). This rate applies when you use triangulation to calculate the exchange rate for a receipt.
mnTriangulationRate2	CRR2	MATH_NUMERIC	OPT	INPUT
The exchange rate from the triangulation currency to the domestic currency (leg 2). This rate applies when you use triangulation to calculate the exchange rate for a receipt.
cConversionMethod	CRCM	char	OPT	INPUT
A value that specifies which method to use when converting from one currency to another. Valid values are: Y Multiplier method. The system multiplies the foreign amount by the multiplier exchange rate to calculate the domestic amount. Z Divisor method. The system divides the foreign amount by the divisor exchange rate to calculate the domestic amount.
jdTransactionDate	EFT	JDEDATE	OPT	INPUT
The date that identifies when a date is first valid. The effective date is used generically. It can be a lease effective date, a price or cost effective date, a currency effective date, a tax rate effective date, or whatever is appropriate.
mnForeignTotalNettingAmount	PFAP	MATH_NUMERIC	OPT	INPUT
The foreign amount to be paid on an A/P Payment run.
szBusinessUnit	MCU	char	OPT	INPUT
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.
szGLOffset	GLC	char	OPT	INPUT
A code that determines the trade account that the system uses as the offset when you post invoices or vouchers. The system concatenates the value that you enter to the AAI item RC (for Accounts Receivable) or PC (for Accounts Payable) to locate the trade account. For example, if you enter TRAD, the system searches for the AAI item RCTRAD (for receivables) or PCTRAD (for payables). You can assign up to four alphanumeric characters to represent the G/L offset or you can assign the three-character currency code (if you enter transactions in a multicurrency environment). You must, however, set up the corresponding AAI item for the system to use; otherwise, the system ignores the G/L offset and uses the account that is set up for PC or RC for the company specified. If you set up a default value in the G/L Offset field of the customer or supplier record, the system uses the value during transaction entry unless you override it. Note: Do not use code 9999. It is reserved for the post program and indicates that offsets should not be created.
szTaxRateArea	TXA1	char	OPT	INPUT
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	EXR1	char	OPT	INPUT
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.
szPaymentTerms	PTC	char	OPT	INPUT
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.
cPaymentInstrument	RYIN	char	OPT	INPUT
The user defined code (00/PY) that specifies how payments are made by the customer. For example: C Check D Draft T Electronic funds transfer
szRemark	RMK	char	OPT	INPUT
A generic field that you use for a remark, description, name, or address.
szAlphaName	ALPH	char	OPT	INPUT
The text that names or describes an address. This 40-character alphabetic field appears on a number of forms and reports. You can enter dashes, commas, and other special characters, but the system cannot search on them when you use this field to search for a name.
mnParentNumber	PA8	MATH_NUMERIC	OPT	INPUT
The address book number of the parent company. The system uses this number to associate a particular address with a parent company or location. Any value that you enter in this field updates the Address Organizational Structure Master table (F0150) for the blank structure type. This address number must exist in the Address Book Master table (F0101) for validation purposes. Examples of address book records that would have a parent number include: o Subsidiaries with parent companies o Branches with a home office o Job sites with a general contractor
mnCentury	CTRY	MATH_NUMERIC	OPT	INPUT
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	FY	MATH_NUMERIC	OPT	INPUT
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.
mnPeriodNumber	PN	MATH_NUMERIC	OPT	INPUT
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.

Related Functions

None

Related Tables

None