ReceiptsEntryCheckCache

Maintain Receipts Entry Cache

Major Business Rule

Object Name: B03B0158

Parent DLL: CFIN

Location: Client/Server

Language: C

Functional Description

Purpose
This function is used to check the Receipts Entry cache for a specified invoice pay item. The
Receipts Entry cache is used by the Standard Receipts Entry (P03B102) and Draft Entry (P03B602) applications
to keep track of which invoices have been added to the entry grid. This cache stores only the invoice
document number (DOC), type (DCT), company (KCO), and pay item (SFX).

Setup Notes and Prerequisites
The Receipts Entry cache must exist before calling this function.

Special Logic
None.

Technical Specification




Parameters


Item DescriptionI/OReq?Notes


DOCmnDocumentNumberIYDocument Number of the specified invoice pay item.    


DCT  szDocumentType            I    Y       Document Type of the specified invoice pay item. 


KCOszDocumentCompanyIYDocument Company of the specified invoice pay item.


SFXszDocumentPayItemIYDocument Pay Item of the specified invoice pay item.


EV01cReturnStatusO '0' if the record was not found, '1' if the record was 

found.





Related Tables


None.





Related Functions


None.





Processing


Set cReturnStatus to '0'.


Validate required parameters.


If the number of records in the Receipts Entry cache is greater than zero,


 Open cursor.


 Retrieve record from the Receipts Entry cache.


 If the record was found,


  Set cReturnStatus equal to '1'.


 Close the cursor.

Parameter Name	Data Item	Data Type	Req/Opt	I/O/Both
mnDocumentNumber	DOC	MATH_NUMERIC	NONE	NONE
Item ab Descriptionab I/Oab Req?ab Notes DOCab mnDocumentNumberab Iab Yab Not Required for the Create or Destroy calls. Document Number of the specified invoice pay item. ^
szDocumentType	DCT	char	NONE	NONE
Item ab Descriptionab I/Oab Req?ab Notes DCTab szDocumentType I Y Not Required for the Create or Destroy calls. Document Type of the specified invoice pay item. ^
szDocumentCompany	KCO	char	NONE	NONE
Item ab Descriptionab I/Oab Req?ab Notes KCOab szDocumentCompanyab Iab Yab Not Required for the Create or Destroy calls. Document Company of the specified invoice pay item. ^
szDocumentPayItem	SFX	char	NONE	NONE
Item ab Descriptionab I/Oab Req?ab Notes SFXab szDocumentPayItemab Iab Yab Not Required for the Create or the Destroy calls. Document Pay Item of the specified invoice pay item. ^
cReturnStatus	EV01	char	NONE	NONE
Item ab Descriptionab I/Oab Req?ab Notes EV01ab cReturnStatusab Oab ab '0' if the record was not found, '1' if the record was found. ^

Data Structure

D03B0158 - Maintain Receipts Entry Cache

Item DescriptionI/OReq?Notes
DOCmnDocumentNumberIY      Not Required for the Create or Destroy calls.
                                               Document Number of the specified invoice pay item.
DCT  szDocumentType            I    Y    Not Required for the Create or Destroy calls.
                                               Document Type of the specified invoice pay item.
KCOszDocumentCompanyIY      Not Required for the Create or Destroy calls.
                                               Document Company of the specified invoice pay item.
SFXszDocumentPayItemIY      Not Required for the Create or Destroy calls.
                                               Document Pay Item of the specified invoice pay item.
EV01cReturnStatusO '0' if the record was not found, '1' if the record was
found.

^

Parameter Name Data Item Data Type Req/Opt I/O/Both

mnDocumentNumber DOC MATH_NUMERIC NONE NONE

Item ab Descriptionab I/Oab Req?ab Notes
DOCab mnDocumentNumberab Iab Yab Not Required for the Create or Destroy calls.
     Document Number of the specified
     invoice pay item.

^

szDocumentType DCT char NONE NONE

Item ab Descriptionab I/Oab Req?ab Notes

DCTab   szDocumentType            I    Y       Not Required for the Create or Destroy calls.
                                                Document Type of the specified invoice pay item.

^

szDocumentCompany KCO char NONE NONE

Item ab Descriptionab I/Oab Req?ab Notes
KCOab szDocumentCompanyab Iab Yab Not Required for the Create or Destroy calls.
                                               Document Company of the specified invoice pay item.

^

szDocumentPayItem SFX char NONE NONE

Item ab Descriptionab I/Oab Req?ab Notes
SFXab szDocumentPayItemab Iab Yab Not Required for the Create or the Destroy calls.
                                                Document Pay Item of the specified invoice pay item.

^

cReturnStatus EV01 char NONE NONE

Item ab Descriptionab I/Oab Req?ab Notes
EV01ab cReturnStatusab Oab ab '0' if the record was not found, '1' if the record was found.

^

Related Functions

None

Related Tables

None

ReceiptsEntryCreateCache
ReceiptsEntryCreateCache

Maintain Receipts Entry Cache

Major Business Rule

Object Name: B03B0158

Parent DLL: CFIN

Location: Client/Server

Language: C

Functional Description

Purpose
This function is used to create the Receipts Entry cache. The Receipts Entry cache is used by the
Standard Receipts Entry (P03B102) and Draft Entry (P03B602) applications to keep track of which invoices
have been added to the entry grid. This cache stores only the invoice document number (DOC), type
(DCT), company (KCO), and pay item (SFX).

Setup Notes and Prerequisites
None.

Special Logic
None.

Technical Specification

Parameters
Item DescriptionI/OReq?Notes
DOCmnDocumentNumber Not used.
DCTszDocumentType Not used.
KCOszDocumentCompany Not used.
SFXszDocumentPayItem Not used.
EV01cReturnStatusO '0' if unsuccessful, '1' if successful.

Related Tables
None.

Related Functions
None.

Processing
Initialize the Receipts Entry cache.
If successful,
Set cReturnStatus equal to '1'.
Else,
Set cReturnStatus equal to '0'.

Data Structure

D03B0158 - Maintain Receipts Entry Cache

Item DescriptionI/OReq?Notes
DOCmnDocumentNumberIY      Not Required for the Create or Destroy calls.
                                               Document Number of the specified invoice pay item.
DCT  szDocumentType            I    Y    Not Required for the Create or Destroy calls.
                                               Document Type of the specified invoice pay item.
KCOszDocumentCompanyIY      Not Required for the Create or Destroy calls.
                                               Document Company of the specified invoice pay item.
SFXszDocumentPayItemIY      Not Required for the Create or Destroy calls.
                                               Document Pay Item of the specified invoice pay item.
EV01cReturnStatusO '0' if the record was not found, '1' if the record was
found.

^

Parameter Name Data Item Data Type Req/Opt I/O/Both

mnDocumentNumber DOC MATH_NUMERIC NONE NONE

Item ab Descriptionab I/Oab Req?ab Notes
DOCab mnDocumentNumberab Iab Yab Not Required for the Create or Destroy calls.
     Document Number of the specified
     invoice pay item.

^

szDocumentType DCT char NONE NONE

Item ab Descriptionab I/Oab Req?ab Notes

DCTab   szDocumentType            I    Y       Not Required for the Create or Destroy calls.
                                                Document Type of the specified invoice pay item.

^

szDocumentCompany KCO char NONE NONE

Item ab Descriptionab I/Oab Req?ab Notes
KCOab szDocumentCompanyab Iab Yab Not Required for the Create or Destroy calls.
                                               Document Company of the specified invoice pay item.

^

szDocumentPayItem SFX char NONE NONE

Item ab Descriptionab I/Oab Req?ab Notes
SFXab szDocumentPayItemab Iab Yab Not Required for the Create or the Destroy calls.
                                                Document Pay Item of the specified invoice pay item.

^

cReturnStatus EV01 char NONE NONE

Item ab Descriptionab I/Oab Req?ab Notes
EV01ab cReturnStatusab Oab ab '0' if the record was not found, '1' if the record was found.

^

Related Functions

None

Related Tables

None

ReceiptsEntryDeleteCache
ReceiptsEntryDeleteCache

Maintain Receipts Entry Cache

Major Business Rule

Object Name: B03B0158

Parent DLL: CFIN

Location: Client/Server

Language: C

Functional Description

Purpose
This function is used to delete the specified invoice pay item from the Receipts Entry cache. The
Receipts Entry cache is used by the Standard Receipts Entry (P03B102) and Draft Entry (P03B602)
applications to keep track of which invoices have been added to the entry grid. This cache stores only the
invoice document number (DOC), type (DCT), company (KCO), and pay item (SFX).

Setup Notes and Prerequisites
The Receipts Entry cache must exist before calling this function.

Special Logic
None.

Technical Specification

Parameters
Item DescriptionI/OReq?Notes
DOCmnDocumentNumberIYDocument Number of the specified invoice pay item.
DCT  szDocumentType            I    Y       Document Type of the specified invoice pay item.
KCOszDocumentCompanyIYDocument Company of the specified invoice pay item.
SFXszDocumentPayItemIYDocument Pay Item of the specified invoice pay item.
EV01cReturnStatusO '0' if unsuccessful, '1' if successful.

Related Tables
None.

Related Functions
None.

Processing
Set cReturnStatus to '0'.
Validate required parameters.
If the number of records in the Receipts Entry cache is greater than zero,
Open cursor.
Retrieve record from the Receipts Entry cache.
If the record was found,
Delete the invoice from the Receipts Entry cache.
Set cReturnStatus equal to '1'.
Close the cursor.

^

Data Structure

D03B0158 - Maintain Receipts Entry Cache

Item DescriptionI/OReq?Notes
DOCmnDocumentNumberIY      Not Required for the Create or Destroy calls.
                                               Document Number of the specified invoice pay item.
DCT  szDocumentType            I    Y    Not Required for the Create or Destroy calls.
                                               Document Type of the specified invoice pay item.
KCOszDocumentCompanyIY      Not Required for the Create or Destroy calls.
                                               Document Company of the specified invoice pay item.
SFXszDocumentPayItemIY      Not Required for the Create or Destroy calls.
                                               Document Pay Item of the specified invoice pay item.
EV01cReturnStatusO '0' if the record was not found, '1' if the record was
found.

^

Parameter Name Data Item Data Type Req/Opt I/O/Both

mnDocumentNumber DOC MATH_NUMERIC NONE NONE

Item ab Descriptionab I/Oab Req?ab Notes
DOCab mnDocumentNumberab Iab Yab Not Required for the Create or Destroy calls.
     Document Number of the specified
     invoice pay item.

^

szDocumentType DCT char NONE NONE

Item ab Descriptionab I/Oab Req?ab Notes

DCTab   szDocumentType            I    Y       Not Required for the Create or Destroy calls.
                                                Document Type of the specified invoice pay item.

^

szDocumentCompany KCO char NONE NONE

Item ab Descriptionab I/Oab Req?ab Notes
KCOab szDocumentCompanyab Iab Yab Not Required for the Create or Destroy calls.
                                               Document Company of the specified invoice pay item.

^

szDocumentPayItem SFX char NONE NONE

Item ab Descriptionab I/Oab Req?ab Notes
SFXab szDocumentPayItemab Iab Yab Not Required for the Create or the Destroy calls.
                                                Document Pay Item of the specified invoice pay item.

^

cReturnStatus EV01 char NONE NONE

Item ab Descriptionab I/Oab Req?ab Notes
EV01ab cReturnStatusab Oab ab '0' if the record was not found, '1' if the record was found.

^

Related Functions

None

Related Tables

None

ReceiptsEntryDestroyCache
ReceiptsEntryDestroyCache

Maintain Receipts Entry Cache

Major Business Rule

Object Name: B03B0158

Parent DLL: CFIN

Location: Client/Server

Language: C

Functional Description

Purpose
This function is used to terminate the Receipts Entry cache and free its associated memory. Any
records within the cache will be lost. The Receipts Entry cache is used by the Standard Receipts Entry
(P03B102) and Draft Entry (P03B602) applications to keep track of which invoices have been added to the
entry grid. This cache stores only the invoice document number (DOC), type (DCT), company (KCO), and pay
item (SFX).

Setup Notes and Prerequisites
The Receipts Entry cache must exist before calling this function.

Special Logic
None.

Technical Specification

Parameters
Item DescriptionI/OReq?Notes
DOCmnDocumentNumber Not used.
DCTszDocumentType Not used.
KCOszDocumentCompany Not used.
SFXszDocumentPayItem Not used.
EV01cReturnStatusO '0' if unsuccessful, '1' if successful.

Related Tables
None.

Related Functions
None.

Processing
Set cReturnStatus to '0'.
Destroy the Receipts Entry cache.
If successful,
Set cReturnStatus to '1'.

^

Data Structure

D03B0158 - Maintain Receipts Entry Cache

Item DescriptionI/OReq?Notes
DOCmnDocumentNumberIY      Not Required for the Create or Destroy calls.
                                               Document Number of the specified invoice pay item.
DCT  szDocumentType            I    Y    Not Required for the Create or Destroy calls.
                                               Document Type of the specified invoice pay item.
KCOszDocumentCompanyIY      Not Required for the Create or Destroy calls.
                                               Document Company of the specified invoice pay item.
SFXszDocumentPayItemIY      Not Required for the Create or Destroy calls.
                                               Document Pay Item of the specified invoice pay item.
EV01cReturnStatusO '0' if the record was not found, '1' if the record was
found.

^

Parameter Name Data Item Data Type Req/Opt I/O/Both

mnDocumentNumber DOC MATH_NUMERIC NONE NONE

Item ab Descriptionab I/Oab Req?ab Notes
DOCab mnDocumentNumberab Iab Yab Not Required for the Create or Destroy calls.
     Document Number of the specified
     invoice pay item.

^

szDocumentType DCT char NONE NONE

Item ab Descriptionab I/Oab Req?ab Notes

DCTab   szDocumentType            I    Y       Not Required for the Create or Destroy calls.
                                                Document Type of the specified invoice pay item.

^

szDocumentCompany KCO char NONE NONE

Item ab Descriptionab I/Oab Req?ab Notes
KCOab szDocumentCompanyab Iab Yab Not Required for the Create or Destroy calls.
                                               Document Company of the specified invoice pay item.

^

szDocumentPayItem SFX char NONE NONE

Item ab Descriptionab I/Oab Req?ab Notes
SFXab szDocumentPayItemab Iab Yab Not Required for the Create or the Destroy calls.
                                                Document Pay Item of the specified invoice pay item.

^

cReturnStatus EV01 char NONE NONE

Item ab Descriptionab I/Oab Req?ab Notes
EV01ab cReturnStatusab Oab ab '0' if the record was not found, '1' if the record was found.

^

Related Functions

None

Related Tables

None

ReceiptsEntryWriteCache
ReceiptsEntryWriteCache

Maintain Receipts Entry Cache

Major Business Rule

Object Name: B03B0158

Parent DLL: CFIN

Location: Client/Server

Language: C

Functional Description

Purpose
This function is used to add an invoice pay item to the Receipts Entry cache. The Receipts Entry
cache is used by the Standard Receipts Entry (P03B102) and Draft Entry (P03B602) applications to keep
track of which invoices have been added to the entry grid. This cache stores only the invoice document
number (DOC), type (DCT), company (KCO), and pay item (SFX).

Setup Notes and Prerequisites
The Receipts Entry cache must exist before calling this function.

Special Logic
None.

Technical Specification

Parameters
Item DescriptionI/OReq?Notes
DOCmnDocumentNumberIYDocument Number of the specified invoice pay item.
DCT  szDocumentType            I    Y       Document Type of the specified invoice
     pay item.
KCOszDocumentCompanyIYDocument Company of the specified invoice pay item.
SFXszDocumentPayItemIYDocument Pay Item of the specified invoice pay item.
EV01cReturnStatusO '0' if unsuccessful, '1' if successful.

Related Tables
None.

Related Functions
None.

Processing
Set cReturnStatus to '0'.
Validate required parameters.
Add the specified invoice pay item to the Receipts Entry cache.
If successful,
Set cReturnStatus to '1'.

Data Structure

D03B0158 - Maintain Receipts Entry Cache

Item DescriptionI/OReq?Notes
DOCmnDocumentNumberIY      Not Required for the Create or Destroy calls.
                                               Document Number of the specified invoice pay item.
DCT  szDocumentType            I    Y    Not Required for the Create or Destroy calls.
                                               Document Type of the specified invoice pay item.
KCOszDocumentCompanyIY      Not Required for the Create or Destroy calls.
                                               Document Company of the specified invoice pay item.
SFXszDocumentPayItemIY      Not Required for the Create or Destroy calls.
                                               Document Pay Item of the specified invoice pay item.
EV01cReturnStatusO '0' if the record was not found, '1' if the record was
found.

^

Parameter Name Data Item Data Type Req/Opt I/O/Both

mnDocumentNumber DOC MATH_NUMERIC NONE NONE

Item ab Descriptionab I/Oab Req?ab Notes
DOCab mnDocumentNumberab Iab Yab Not Required for the Create or Destroy calls.
     Document Number of the specified
     invoice pay item.

^

szDocumentType DCT char NONE NONE

Item ab Descriptionab I/Oab Req?ab Notes

DCTab   szDocumentType            I    Y       Not Required for the Create or Destroy calls.
                                                Document Type of the specified invoice pay item.

^

szDocumentCompany KCO char NONE NONE

Item ab Descriptionab I/Oab Req?ab Notes
KCOab szDocumentCompanyab Iab Yab Not Required for the Create or Destroy calls.
                                               Document Company of the specified invoice pay item.

^

szDocumentPayItem SFX char NONE NONE

Item ab Descriptionab I/Oab Req?ab Notes
SFXab szDocumentPayItemab Iab Yab Not Required for the Create or the Destroy calls.
                                                Document Pay Item of the specified invoice pay item.

^

cReturnStatus EV01 char NONE NONE

Item ab Descriptionab I/Oab Req?ab Notes
EV01ab cReturnStatusab Oab ab '0' if the record was not found, '1' if the record was found.

^

Related Functions

None

Related Tables

None

TA NAME="ONEWORLD-BSFN" CONTENT="ReceiptsEntryCreateCache"> ReceiptsEntryCreateCache
ReceiptsEntryCreateCache

Maintain Receipts Entry Cache

Major Business Rule

Object Name: B03B0158

Parent DLL: CFIN

Location: Client/Server

Language: C

Functional Description

Purpose
This function is used to create the Receipts Entry cache. The Receipts Entry cache is used by the
Standard Receipts Entry (P03B102) and Draft Entry (P03B602) applications to keep track of which invoices
have been added to the entry grid. This cache stores only the invoice document number (DOC), type
(DCT), company (KCO), and pay item (SFX).

Setup Notes and Prerequisites
None.

Special Logic
None.

Technical Specification

Parameters
Item DescriptionI/OReq?Notes
DOCmnDocumentNumber Not used.
DCTszDocumentType Not used.
KCOszDocumentCompany Not used.
SFXszDocumentPayItem Not used.
EV01cReturnStatusO '0' if unsuccessful, '1' if successful.

Related Tables
None.

Related Functions
None.

Processing
Initialize the Receipts Entry cache.
If successful,
Set cReturnStatus equal to '1'.
Else,
Set cReturnStatus equal to '0'.

Data Structure

D03B0158 - Maintain Receipts Entry Cache

Item DescriptionI/OReq?Notes
DOCmnDocumentNumberIY      Not Required for the Create or Destroy calls.
                                               Document Number of the specified invoice pay item.
DCT  szDocumentType            I    Y    Not Required for the Create or Destroy calls.
                                               Document Type of the specified invoice pay item.
KCOszDocumentCompanyIY      Not Required for the Create or Destroy calls.
                                               Document Company of the specified invoice pay item.
SFXszDocumentPayItemIY      Not Required for the Create or Destroy calls.
                                               Document Pay Item of the specified invoice pay item.
EV01cReturnStatusO '0' if the record was not found, '1' if the record was
found.

^

Parameter Name Data Item Data Type Req/Opt I/O/Both

mnDocumentNumber DOC MATH_NUMERIC NONE NONE

Item ab Descriptionab I/Oab Req?ab Notes
DOCab mnDocumentNumberab Iab Yab Not Required for the Create or Destroy calls.
     Document Number of the specified
     invoice pay item.

^

szDocumentType DCT char NONE NONE

Item ab Descriptionab I/Oab Req?ab Notes

DCTab   szDocumentType            I    Y       Not Required for the Create or Destroy calls.
                                                Document Type of the specified invoice pay item.

^

szDocumentCompany KCO char NONE NONE

Item ab Descriptionab I/Oab Req?ab Notes
KCOab szDocumentCompanyab Iab Yab Not Required for the Create or Destroy calls.
                                               Document Company of the specified invoice pay item.

^

szDocumentPayItem SFX char NONE NONE

Item ab Descriptionab I/Oab Req?ab Notes
SFXab szDocumentPayItemab Iab Yab Not Required for the Create or the Destroy calls.
                                                Document Pay Item of the specified invoice pay item.

^

cReturnStatus EV01 char NONE NONE

Item ab Descriptionab I/Oab Req?ab Notes
EV01ab cReturnStatusab Oab ab '0' if the record was not found, '1' if the record was found.

^

Related Functions

None

Related Tables

None

ReceiptsEntryDeleteCache
ReceiptsEntryDeleteCache

Maintain Receipts Entry Cache

Major Business Rule

Object Name: B03B0158

Parent DLL: CFIN

Location: Client/Server