Fonction SAP BAPI_ADMGMTBILLDOC_GETLIST - IS-M/AM: BAPI Select Billing Document

Paramètre Reférence Type Long. Valeur par déf. Facultatif Description
ALLOC_NMBR BAPIBUSISM010_SEL-ALLOC_NMBR C 18 X Select By Assignment Number
BILLINGCATEGORY BAPIBUSISM010_SEL-BILLINGCATEGORY C 1 Select By Billing Category
BILLINGDATE_FROM BAPIBUSISM010_SEL-BILLINGDATE_FROM D 8 X Select By FROM Billing Document Date
BILLINGDATE_TO BAPIBUSISM010_SEL-BILLINGDATE_TO D 8 X Select By TO Billing Document Date
BILLINGTYPE BAPIBUSISM010_SEL-BILLINGTYPE C 4 X Select By Billing Document Type
CHANGEDBY BAPIBUSISM010_SEL-CHANGEDBY C 12 X Select By Last Modifier
CHANGEDON_FROM BAPIBUSISM010_SEL-CHANGEDON_FROM D 8 X Select By FROM Last Change Date
CHANGEDON_TO BAPIBUSISM010_SEL-CHANGEDON_TO D 8 X Select By TO Last Change Date
COMP_CODE BAPIBUSISM010_SEL-COMP_CODE C 4 X Select By Company Code
CREATEDBY BAPIBUSISM010_SEL-CREATEDBY C 12 X Select By Creator
CREATEDON_FROM BAPIBUSISM010_SEL-CREATEDON_FROM D 8 X Select By FROM Entry Date
CREATEDON_TO BAPIBUSISM010_SEL-CREATEDON_TO D 8 X Select By TO Entry Date
FIDOCUMENTSTATUS BAPIBUSISM010_SEL-FIDOCUMENTSTATUS C 1 X Select By Financial Accounting Document Status
ORDERREF_SEL BAPIBUSISM010_ORDERREF_SEL u 16 X Select By Order Reference for Item
POSTINGSTATUS BAPIBUSISM010_SEL-POSTINGSTATUS C 1 X Select By Status for Transfer to Accounting/ HR
PURCH_ORG BAPIBUSISM010_SEL-PURCH_ORG C 4 X Select By Purchasing Organization
REF_DOC_NO BAPIBUSISM010_SEL-REF_DOC_NO C 16 X Select By Reference Document Number
REF_DOC_NO_LONG BAPIBUSISM010_SEL-REF_DOC_NO_LONG C 35 X Reference Document Number (for Dependencies see Long Text)
SALESDOCCATEGORY BAPIBUSISM010_SEL-SALESDOCCATEGORY C 1 X Select By Sales Document Category
SALESORG BAPIBUSISM010_SEL-SALESORG C 4 X Select By Sales Organization
SALES_AGT_CONTRACT_NO BAPIBUSISM010_SEL-SALES_AGT_CONTRACT_NO C 10 X Select By Media Sales Agent Contract Number
SALES_AGT_SEL BAPIBUSISM010_SALES_AGT_SEL u 9 X Select by Sales Agent Assignment (Item)

Paramètre Reférence Long. Facultatif Description
BILLINGDOC_LIST BAPIBUSISM010_HEAD_KEY 10 X Result: Key for Billing Documents Determined
BILLINGITEM_LIST BAPIBUSISM010_ITEM_KEY 16 X Result: Key for Billing Document Items Determined
CANCELLATIONTYPE_SEL BAPIBUSISM010_CANCELTYPE 5 X Select By Reversal Type
EXTENSION_IN BAPIPAREX 990 X Reference Structure for BAPI ExtensionIn/ExtensionOut Parameters
PARTNER_SEL BAPIBUSISM008_PARTNER_SEL 30 X Select By Business Partner Numbers
PARTN_ROLE_SEL BAPIBUSISM008_PARTN_ROLE_SEL 2 X Select By Business Partner Roles
RETURN BAPIRET2 548 X Return Parameters
SELECTION_HEAD BAPIF4D 255 X Additional Free WHERE Clause for Selection Using JHTFK Table
SELECTION_ITEM BAPIF4D 255 X Additional Free WHERE Clause for Selection Using JHVFPALL View

Functionality
This method is used to select billing documents from theAdvertising Management component using various criteria.
Detailed data for selected billing documents can be read using theAdMgmtBilldoc.GetDetail method.
The system evaluates the selection criteria at header and partnerassignment level and returns the numbers of all billing documentsselected.

Notes
Parameters
Selection criteria are defined using the import parameter and thetables parameter, whose names end in the _SEL
suffix.
Selection parameters are always connected using a logical AND.
If you restrict selection using the PartnerSel orPartnRoleSel parameters, the system selects by the billingdocument header (JHTFK) and the partner assignment (JHTFPA). This meansthat billing documents without a partner assignment or those with ablank partner schema are ignored. Selection is not thereforeperformed using partner references (such as jhtfk-kunrg "payer") thatare specified in the document item.
Authorizations
This method only returns the numbers of billing documents for which theuser has display authorization (J_FAKT authorizationobject).
If the user is not authorized to display a billing document, this isindicated by an error message in the Return parameter.
User-defined selection criteria
Use the SelectionHead or SelectionItem parameters toprocess your own selection criteria for the billing header or item inthis BAPI.
Use the ExtensionIn parameter and the ISM_AM_BILLDOC_BAPIto process additional selection criteria in this BAPI.
Performance
INCLUDE ISMAM_BAPIGETLIST_PERFORMANC

Further information
Additional information on billing and settlement is available in theSAP Library under SAP Media -> Advertising Management -> Billingand Settlement.

Description
Search for billing documents for the assignment numberproposed.
INCLUDE ISMAM_BAPISELPARAM_INITIAL
INCLUDE ISMAM_BAPISELPARAM_FILLED

Efg_effect_database
INCLUDE ISMAM_BAPIGETLIST_NOINDEX

Description
Search for billing documents for the billing categoryproposed.
INCLUDE ISMAM_BAPISELPARAM_INITIAL
INCLUDE ISMAM_BAPISELPARAM_FILLED

Notes
This parameter must be specified.

Value range
System table TJH19 contains possible values here.

Efg_effect_database
INCLUDE ISMAM_BAPIGETLIST_NOINDEX

Description
Search for billing documents with an [actual billingdate] >= than the parameter value.

Explanation
INCLUDE ISMAM_BAPISELPARAM_DATEINTVL

Relations
BILLINGDATE_TOparameter

Efg_effect_database
INCLUDE ISMAM_BAPIGETLIST_NOINDEX

Description
Search for billing documents with an [actual billingdate] <= than the parameter value

Explanation
INCLUDE ISMAM_BAPISELPARAM_DATEINTVL

Relations
BILLINGDATE_FROM
parameter

Efg_effect_database
INCLUDE ISMAM_BAPIGETLIST_NOINDEX

Description
Search for billing documents for the billing type
proposed.
INCLUDE ISMAM_BAPISELPARAM_INITIAL
INCLUDE ISMAM_BAPISELPARAM_FILLED

Value range
The TJH05 Customizing table contains possible values. The billing typemust match the value in theBILLINGCATEGORYparameter.

Efg_effect_database
INCLUDE ISMAM_BAPIGETLIST_NOINDEX

Description
Search for billing documents with the last changed by
attribute.
INCLUDE ISMAM_BAPISELPARAM_INITIAL
INCLUDE ISMAM_BAPISELPARAM_FILLED

Description
Search for billing documents with a [change date] >=than the parameter value.

Explanation
INCLUDE ISMAM_BAPISELPARAM_DATEINTVL

Relations
CHANGEDON_TOparameter

Description
Search for billing documents with a [change date] <=than the parameter value.

Explanation
INCLUDE ISMAM_BAPISELPARAM_DATEINTVL

Relations
CHANGEDON_FROMparameters.

Efg_effect_database
INCLUDE ISMAM_BAPIGETLIST_NOINDEX

Description
Search for billing documents for the company code
proposed.
INCLUDE ISMAM_BAPISELPARAM_INITIAL
INCLUDE ISMAM_BAPISELPARAM_FILLED

Efg_effect_database
INCLUDE ISMAM_BAPIGETLIST_NOINDEX

Description
Search for billing documents created by the created by
user.
INCLUDE ISMAM_BAPISELPARAM_INITIAL
INCLUDE ISMAM_BAPISELPARAM_FILLED

Efg_effect_database
INCLUDE ISMAM_BAPIGETLIST_NOINDEX

Description
Search for billing documents with an [entry date] >=than the parameter value.

Explanation
INCLUDE ISMAM_BAPISELPARAM_DATEINTVL

Relations
CREATEDON_TOparameter

Efg_effect_database
INCLUDE ISMAM_BAPIGETLIST_NOINDEX

Description
Search for billing documents with an [entry date]than the parameter value.

Explanation
INCLUDE ISMAM_BAPISELPARAM_DATEINTVL

Relations
CREATEDON_FROMparameter.

Description
Search for billing documents for the FinancialAccounting document status proposed.
INCLUDE ISMAM_BAPISELPARAM_INITIAL
INCLUDE ISMAM_BAPISELPARAM_FILLED

Value range
Possible values are available in the fixed values for the ISMSTAFIdomain.

Efg_effect_database
INCLUDE ISMAM_BAPIGETLIST_NOINDEX

Description
Search for billing documents using the order
, order item and billing dataset
references in the billing items. The following applies to each ofthese reference keys:
INCLUDE ISMAM_BAPISELPARAM_INITIAL
INCLUDE ISMAM_BAPISELPARAM_FILLED

Notes
Selection using this external key is supported as standard by adatabase index.

Description
Search for billing documents for the posting status
proposed.
INCLUDE ISMAM_BAPISELPARAM_INITIAL
INCLUDE ISMAM_BAPISELPARAM_FILLED

Value range
Possible values are available in the fixed values for the JHRFBSKdomain.

Efg_effect_database
INCLUDE ISMAM_BAPIGETLIST_NOINDEX

Description
Search for billing documents for the purchasingorganization proposed.
INCLUDE ISMAM_BAPISELPARAM_INITIAL
INCLUDE ISMAM_BAPISELPARAM_FILLED

Value range
Possible values are available in the TJJAJ Customizing table.

Efg_effect_database
INCLUDE ISMAM_BAPIGETLIST_NOINDEX

Description
Search for billing documents for the reference documentnumber proposed.
INCLUDE ISMAM_BAPISELPARAM_INITIAL
INCLUDE ISMAM_BAPISELPARAM_FILLED

Efg_effect_database
INCLUDE ISMAM_BAPIGETLIST_NOINDEX

Description
Search for billing documents for the sales documentcategory proposed.
INCLUDE ISMAM_BAPISELPARAM_INITIAL
INCLUDE ISMAM_BAPISELPARAM_FILLED

Value range
Possible values are available in the fixed values for the ISPVBTYPdomain.

Abhaengigkeiten
If you have already specified theBILLINGTYPEparameter, you should leave the sales document category blank, sincethis is directly dependent on the billing type.

Efg_effect_database
INCLUDE ISMAM_BAPIGETLIST_NOINDEX

Description
Search for billing documents for the sales organizationproposed.
INCLUDE ISMAM_BAPISELPARAM_INITIAL
INCLUDE ISMAM_BAPISELPARAM_FILLED

Value range
Possible values are available in the TVKO Customizing table.

Efg_effect_database
INCLUDE ISMAM_BAPIGETLIST_NOINDEX

Description
Search for sales agent settlement documents for thesales agent contract proposed.
INCLUDE ISMAM_BAPISELPARAM_INITIAL
INCLUDE ISMAM_BAPISELPARAM_FILLED

Abhaengigkeiten
This selection should only be performed in conjunction withBILLINGCATEGORY= 'P' (sales agent settlement).
If you specify this parameter, you must leave theSALESORG parameterblank if the system is to find any documents.
It is not necessary to specify thePURCH_ORG parametersince this is uniquely dependent on the sales agent contract.

Efg_effect_database
INCLUDE ISMAM_BAPIGETLIST_NOINDEX

Description
Search for sales agent settlement documents using therequirement number, commissioncategory and sales agent assignment number forthe settlement Item. The following applies to each of the attributes:
INCLUDE ISMAM_BAPISELPARAM_INITIAL
INCLUDE ISMAM_BAPISELPARAM_FILLED

Notes
The
ORDERREF_SEL parameter can be used to make enhancements withreference to a sales agent assignment.

Efg_effect_database
INCLUDE ISMAM_BAPIGETLIST_NOINDEX

Description
This parameter contains the key for billing documents determined thatmatch the selection criteria transferred.

Description
This parameter contains the key for billing document items determinedthat match the selection criteria transferred.

Abhaengigkeiten
The key for billing items is only returned if you have used theORDERREF_SELorSALES_AGT_SELparameters to filter at item level or if you have used thePARTNER_SEL orPARTN_ROLE_SELpartners to search for document partners and partners were found atitem level (no header partners).

Description
Search for billing documents with specificcancellation types.

Value range
Define an ABAP range for the attribute.
Possible values for LOW and HIGH are available in the fixed values forthe STORNOTYP domain.

Beispiel
If you only want to search for documents that have been partially orentirely cancelled, include the following 2 lines in the table:
Sign,,Option,,Low,,High
I,,EQ,,X
I,,EQ,,T

Further information
More detailed information on the structure of a range table isavailable in the SAP Library under Selection Tables.

Default
If you do not make an entry for this parameter, selection is notrestricted using the cancellation type attribute.

Efg_effect_database
INCLUDE ISMAM_BAPIGETLIST_NOINDEX

Description
This parameter is used to transfer your own data to the BAPI. This datacan be used in the
BAPI_GETLIST_ADD_SELECTS method for theISM_AM_BILLDOC_BAPI BAdI to furtherrestrict the number of hits returned.

Further information
Additional information is available in the Customer Enhancement Conceptfor BAPIs unit in the BAPI programming guidelines.

Description
Enter those partners that are to appear in the relevant billingdocuments at header or item level here.

Value range
If you only make an entry in the PARTNER_SEL-
PARTNER_EXTERNAL field, the system determines thecontent of the PARTNER_SEL-
PARTNER field for selection using the JHTFPA-GPNR fieldautomatically prior to selection.

Default
If you make no entry for this parameter, the selection is notrestricted by the occurrence of specific parameters in the document.

Efg_effect_database
INCLUDE ISMAM_ADMGMTBILLDOC_JHTFPA

Description
Use this parameter to define the partner roles
that are to appear in the relevant billing documents.

Value range
Possible values are available in value table TJG39 for the JPARVWdomain or the partner schema for billing documents. (Customizing).

Default
If you do not make an entry for this parameter, the system selectsbilling documents regardless of the occurrence of specific parameters.

Efg_effect_database
INCLUDE ISMAM_ADMGMTBILLDOC_JHTFPA
INCLUDE ISM_BAPI_RETURN

Description
This parameter is used to transfer additional selection criteria forselection using table JHTFK (IS-M/AM billing header) in the form of anABAP WHERE clause.

Example
Include the two lines that have been highlighted here in the parameterto enhance the WHERE clause and read billing documents for whichpayment was made using the VISA or mastercard credit cards:
SELECT * FROM JHTFK
WHERE ....
AND
'( CCINS = '''VISA''' OR' "selection_head[1]
' CCINS = '''MC''' )' "selection_head[2]
.

Notes
Note that you can only use fields in table JHTFK. Any error in the datawill lead to an ABAP runtime error.
Additional information on making parameter entries is available in theLogical Requirements unit of the ABAP documentation.

Description
This parameter is used to transfer additional selection criteria forselection using the JHVFPALL view (IS-M/AM billing item) in the form ofan ABAP WHERE clause.

Example
Include the two lines that have been highlighted here in the parameterto enhance the WHERE clause and read billing documents that containitems that are generally incomplete or for which pricing is incomplete:
SELECT * FROM JHVFPALL
WHERE ....
AND
'( UVPRS = '''X''' OR' "selection_item[1]
' UVALL = '''X''' )' "selection_item[2]
.

Notes
Note that you can only use fields in the JHVFPALL view. Any error inthe data will lead to an ABAP runtime error.
Additional information on making parameter entries is available in theLogical Requirements unit of the ABAP documentation.