SAP ABAP Interface IF_FOAP_AVIK (Payment Advice Header)

Hierarchy

☛ SAP_FIN (Software Component) SAP_FIN
   ⤷ FI-AP-AP (Application Component) Basic Functions
     ⤷ FOAP_CD_ASSIGNMENT (Package) Assignment of Open Credits and Payments

Meta Relationship - Used By

#	Relationship type	Used by	Short Description	Created on
1	Interface implementation (CLASS c. INTERFACES i_ref)	CL_FOAP_AVIK	Payment Advice Header	20040428

Properties

Interface	IF_FOAP_AVIK
Short Description	Payment Advice Header

General Data

Package	FOAP_CD_ASSIGNMENT	Assignment of Open Credits and Payments
Created	20040427	SAP
Last changed	20100310	SAP
Unicode checks active	☑

Forward declarations

Interface IF_FOAP_AVIK has no forward declaration.

Interfaces

Interface IF_FOAP_AVIK has no interface.

Friends

Interface IF_FOAP_AVIK has no friend.

Attributes

#	Attribute	Level	Visibility	Read only	Typing	Associated Type	Initial Value	Description	Created on
1	CLEARED	Constant	Public	☐	Type reference (TYPE)	ASTAT_AVIK	'C'	Payment Advice Status	20040511
2	CONFIRM_ADVICE_HEAD	Static Attribute	Public	☐	Object reference (TYPE REF TO)	IF_FOAP_AVIK		Payment Advice Note Transferred	20040706
3	CREATED	Constant	Public	☐	Type reference (TYPE)	FOAP_DB_STATUS	'CREA'	Is payment advice note saved to database?	20040503
4	CREATED_BY_FI	Constant	Public	☐	Type reference (TYPE)	ASTAT_AVIK	'F'	Payment Advice Status	20040511
5	CREATED_BY_SD	Constant	Public	☐	Type reference (TYPE)	ASTAT_AVIK	'S'	Payment Advice Status	20040511
6	CURRENT_ADVICE_HEAD	Static Attribute	Public	☐	Object reference (TYPE REF TO)	IF_FOAP_AVIK		Payment Advice Note Currently Being Processed	20040611
7	DB_STATUS	Instance attribute	Public	☐	Type reference (TYPE)	FOAP_DB_STATUS		Is payment advice note saved to database?	20040503
8	DELETED	Constant	Public	☐	Type reference (TYPE)	FOAP_DB_STATUS	'DELE'	Is payment advice note saved to database?	20040503
9	DROPPED	Constant	Public	☐	Type reference (TYPE)	ASTAT_AVIK	'D'	Payment Advice Status	20040621
10	POSTED	Constant	Public	☐	Type reference (TYPE)	ASTAT_AVIK	'P'	Payment Advice Status	20040511
11	TO_BE_DELETED_FROM_DB	Constant	Public	☐	Type reference (TYPE)	FOAP_DB_STATUS	'DBDL'	Is payment advice note saved to database?	20040503

Methods

#	Method	Level	Visibility	Method type	Description	Created on
1	ADD_ADVICE_ITEM	Instance method	Public	Method	Insert Payment Advice Note Item	20040428
2	COPY	Instance method	Public	Method	Copy Payment Advice Note	20040702
3	CREATE_ADVICE	Static method	Public	Method	Create New Payment Advice Note	20040428
4	CREATE_ADVICE_ON_DB	Instance method	Public	Method	Create Payment Advice Note on Database	20040507
5	DELETE	Instance method	Public	Method	Delete Payment Advice Note	20040503
6	DELETE_ADVICE_FROM_DB	Instance method	Public	Method	Delete Payment Advice Note from Database	20040611
7	DEQUEUE	Instance method	Public	Method	Unblock Payment Advice Note	20040527
8	DEQUEUE_ALL	Static method	Public	Method	Unblock All Payment Advice Notes	20040528
9	ENQUEUE	Instance method	Public	Method	Block Payment Advice Note	20040527
10	FACTORY_BY_ACCOUNT	Static method	Public	Method	All Payment Advice Notes for an Account Will Be Read	20040429
11	FACTORY_BY_VBELN	Static method	Public	Method	All Payment Advice Notes for A Sales Order Will Be Read	20040706
12	FORGET_ADVICE_ITEM	Instance method	Public	Method	Payment Advice Note Will Be Removed	20040505
13	GET	Instance method	Public	Method	Read Current AVIK Values	20040428
14	GET_ADVICE_ITEMS	Instance method	Public	Method	All Payment Advice Note Items for a Payment Advice Note	20040428
15	GET_ADVICE_ITEMS_BY_BSEG_KEY	Static method	Public	Method	Read Payment Advice Note Items from Buffer	20040428
16	GET_ADVICE_ITEMS_BY_VBAK_KEY	Static method	Public	Method	Read Payment Advice Note Items from Buffer	20040428
17	GET_ALL_DELETED_ADVICES	Static method	Public	Method	List of All Payment Advice Notes Held for Deletion	20040611
18	GET_SINGLE_ITEM_BY_BSEG	Instance method	Public	Method	Payment Advice Note Item for Line Item	20040527
19	NUMBER_OF_ADVICE_ITEMS	Instance method	Public	Method	Number of Payment Advice Note Line Items	20040617
20	READ_ADVICE_FROM_DB	Static method	Public	Method	Read Complete Payment Advice Note from Database	20040428
21	SET	Instance method	Public	Method	Write Current AVIK Values	20040428
22	UNDO_DELETE	Instance method	Public	Method	Cancel Deletion of Payment Advice Note	20040706

Events

Interface IF_FOAP_AVIK has no event.

Types

Interface IF_FOAP_AVIK has no local type.

Method Signatures

Method ADD_ADVICE_ITEM Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_ADVICE_ITEM	Call by reference	☐	Object reference (TYPE REF TO)	IF_FOAP_AVIP		Avisposition	20040428

Method ADD_ADVICE_ITEM on Interface IF_FOAP_AVIK has no exception.

Method COPY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RE_ADVICE_HEAD	Value transfer	☐	Object reference (TYPE REF TO)	IF_FOAP_AVIK		Aviskopf	20040702

Method COPY on Interface IF_FOAP_AVIK has no exception.

Method CREATE_ADVICE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_AVIK	Call by reference	☐	Type reference (TYPE)	AVIK		Aviskopf	20040428
2	Importing	IM_T_AVIP	Call by reference	☐	Type reference (TYPE)	FOAP_T_AVIP		Tabelle: Avispositionen	20040503
3	Returning	RE_ADVICE_HEAD	Value transfer	☐	Object reference (TYPE REF TO)	IF_FOAP_AVIK		Aviskopf	20040503

Method CREATE_ADVICE on Interface IF_FOAP_AVIK has no exception.

Method CREATE_ADVICE_ON_DB Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_UPDATE_TASK	Call by reference	☐	Type reference (TYPE)	BOOLEAN	SPACE	boolsche Variable (X=true, -=false, space=unknown)	20040609
2	Importing	IM_VBELN	Call by reference	☑	Type reference (TYPE)	VBELN_VA		Verkaufsbeleg	20040616

Method CREATE_ADVICE_ON_DB on Interface IF_FOAP_AVIK has no exception.

Method DELETE Signature

Method DELETE on Interface IF_FOAP_AVIK has no parameter.
Method DELETE on Interface IF_FOAP_AVIK has no exception.

Method DELETE_ADVICE_FROM_DB Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_UPDATE_TASK	Call by reference	☐	Type reference (TYPE)	BOOLEAN	SPACE	boolsche Variable (X=true, -=false, space=unknown)	20040611

Method DELETE_ADVICE_FROM_DB on Interface IF_FOAP_AVIK has no exception.

Method DEQUEUE Signature

Method DEQUEUE on Interface IF_FOAP_AVIK has no parameter.
Method DEQUEUE on Interface IF_FOAP_AVIK has no exception.

Method DEQUEUE_ALL Signature

Method DEQUEUE_ALL on Interface IF_FOAP_AVIK has no parameter.
Method DEQUEUE_ALL on Interface IF_FOAP_AVIK has no exception.

Method ENQUEUE Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RE_ERROR_MSG	Value transfer	☐	Type reference (TYPE)	BAPIRET2		Returnparameter	20040528

Method ENQUEUE on Interface IF_FOAP_AVIK has no exception.

Method FACTORY_BY_ACCOUNT Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_ACCOUNT	Call by reference	☐	Type reference (TYPE)	KTONR_AV		Kontonummer	20040429
2	Importing	IM_ACCOUNT_TYPE	Call by reference	☐	Type reference (TYPE)	KOART		Kontoart	20040429
3	Importing	IM_COMPANY_CODE	Call by reference	☐	Type reference (TYPE)	BUKRS		Buchungskreis	20040429

Method FACTORY_BY_ACCOUNT on Interface IF_FOAP_AVIK has no exception.

Method FACTORY_BY_VBELN Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_SALES_BUKRS	Call by reference	☑	Type reference (TYPE)	BUKRS		Buchungskreis	20080519
2	Importing	IM_SALES_DOC_NO	Call by reference	☐	Type reference (TYPE)	VBELN_VA		Verkaufsbeleg	20040706
3	Importing	IM_SALES_KOART	Call by reference	☑	Type reference (TYPE)	KOART		Kontoart	20080519
4	Importing	IM_SALES_KONTO	Call by reference	☑	Type reference (TYPE)	KUNAG		Auftraggeber	20080519

Method FACTORY_BY_VBELN on Interface IF_FOAP_AVIK has no exception.

Method FORGET_ADVICE_ITEM Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_ADVICE_ITEM	Call by reference	☐	Object reference (TYPE REF TO)	IF_FOAP_AVIP		Avisposition	20040505

Method FORGET_ADVICE_ITEM on Interface IF_FOAP_AVIK has no exception.

Method GET Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RE_AVIK	Value transfer	☐	Type reference (TYPE)	AVIK		Aviskopf	20040428

Method GET on Interface IF_FOAP_AVIK has no exception.

Method GET_ADVICE_ITEMS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RE_ADVICES	Value transfer	☐	Type reference (TYPE)	FOAP_T_AVIP_REF		Tabelle von Avispositionen	20040428

Method GET_ADVICE_ITEMS on Interface IF_FOAP_AVIK has no exception.

Method GET_ADVICE_ITEMS_BY_BSEG_KEY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_ACC_DOC_NO	Call by reference	☐	Type reference (TYPE)	BELNR_D		Belegnummer eines Buchhaltungsbeleges	20040428
2	Importing	IM_COMPANY_CODE	Call by reference	☐	Type reference (TYPE)	BUKRS		Buchungskreis	20040428
3	Importing	IM_FISCAL_YEAR	Call by reference	☐	Type reference (TYPE)	GJAHR		Geschäftsjahr	20040428
4	Importing	IM_LINEITEM_NO	Call by reference	☐	Type reference (TYPE)	BUZEI		Nummer der Buchungszeile innerhalb des Buchhaltungsbelegs	20040428
5	Returning	RE_ADVICES	Value transfer	☐	Type reference (TYPE)	FOAP_T_AVIP_REF		Tabelle von Avispositionen	20040428

Method GET_ADVICE_ITEMS_BY_BSEG_KEY on Interface IF_FOAP_AVIK has no exception.

Method GET_ADVICE_ITEMS_BY_VBAK_KEY Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_SALES_DOC_NO	Call by reference	☐	Type reference (TYPE)	VBELN_VA		Verkaufsbeleg	20040428
2	Returning	RE_ADVICES	Value transfer	☐	Type reference (TYPE)	FOAP_T_AVIP_REF		Tabelle von Avispositionen	20040428

Method GET_ADVICE_ITEMS_BY_VBAK_KEY on Interface IF_FOAP_AVIK has no exception.

Method GET_ALL_DELETED_ADVICES Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RE_ADVICE_HEADS	Value transfer	☐	Type reference (TYPE)	FOAP_T_AVIK_REF		Tabelle von Avispositionen	20040611

Method GET_ALL_DELETED_ADVICES on Interface IF_FOAP_AVIK has no exception.

Method GET_SINGLE_ITEM_BY_BSEG Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_ACC_DOC_NO	Call by reference	☐	Type reference (TYPE)	BELNR_D		Belegnummer eines Buchhaltungsbeleges	20040527
2	Importing	IM_COMPANY_CODE	Call by reference	☐	Type reference (TYPE)	BUKRS		Buchungskreis	20040527
3	Importing	IM_FISCAL_YEAR	Call by reference	☐	Type reference (TYPE)	GJAHR		Geschäftsjahr	20040527
4	Importing	IM_LINEITEM_NO	Call by reference	☐	Type reference (TYPE)	BUZEI		Nummer der Buchungszeile innerhalb des Buchhaltungsbelegs	20040527
5	Returning	RE_ADVICE_ITEM	Value transfer	☐	Object reference (TYPE REF TO)	IF_FOAP_AVIP		Avisposition	20040527

Method GET_SINGLE_ITEM_BY_BSEG on Interface IF_FOAP_AVIK has no exception.

Method NUMBER_OF_ADVICE_ITEMS Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Returning	RE_NO_ITEMS	Value transfer	☐	Type reference (TYPE)	I			20040617

Method NUMBER_OF_ADVICE_ITEMS on Interface IF_FOAP_AVIK has no exception.

Method READ_ADVICE_FROM_DB Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_ACCOUNT	Call by reference	☐	Type reference (TYPE)	KTONR_AV		Kontonummer	20040428
2	Importing	IM_ACCOUNT_TYPE	Call by reference	☐	Type reference (TYPE)	KOART_AV		Kontoart Zahlungsavise	20040428
3	Importing	IM_ADVICE_NO	Call by reference	☐	Type reference (TYPE)	AVSID		Avisnummer	20040428
4	Importing	IM_COMPANY_CODE	Call by reference	☐	Type reference (TYPE)	BUKRS		Buchungskreis	20040428
5	Returning	RE_ADVICE_HEAD	Value transfer	☐	Object reference (TYPE REF TO)	IF_FOAP_AVIK		Aviskopf	20040428

Method READ_ADVICE_FROM_DB on Interface IF_FOAP_AVIK has no exception.

Method SET Signature

#	Type	Parameter	Pass Value	Optional	Typing Method	Associated Type	Default value	Description	Created on
1	Importing	IM_AVIK	Call by reference	☐	Type reference (TYPE)	AVIK		Aviskopf	20040428

Method SET on Interface IF_FOAP_AVIK has no exception.

Method UNDO_DELETE Signature

Method UNDO_DELETE on Interface IF_FOAP_AVIK has no parameter.
Method UNDO_DELETE on Interface IF_FOAP_AVIK has no exception.

History

Last changed by/on	SAP	20100310
SAP Release Created in	500