Sapass

 Simplify SAP R/3 development with Excel VBA/VB RFC  
Home> Bapi>SettlementRequstList



Index

SettlementRequstList

SettlementRequstList


The business object Collective settlement request is a
settlement request that comprises several single settlement requests
whose amounts are to be settled collectively to an invoicing party.

Structure

A settlement request list contains several items that each contain a single settlement request.


11-Dec-2005


Methods

Available Methods


  • Change : Change [ BAPI_SETTLEMENTREQSLIST_CHANGE ]
  • Close : Agency Business: BAPI Close Settlement Request List [ BAPI_SETTLEMENTREQSLIST_CLOSE ]
  • Create : Create [ BAPI_SETTLEMENTREQSLIST_CREATE ]
  • GetList : Determine Documents [ BAPI_SETTREQSLIST_GETLIST ]
  • ReleaseMultiple : Release Documents to Accounting [ BAPI_SETTREQSLIST_RELEASE ]

11-Dec-2005


Change

Change


You use this method to change settlement request lists.

To do this, you use the document number to select the settlementrequest list to be changed, and use structure "LISTHEADDATAINX" toselect the fields to be changed at header level for the settlement request list.


You use structure "LISTHEADDATAIN" to enter the new values.

The documents in the settlement request list can be changed in the sameway via "HEADDATAINX", "HEADDATAIN", "ITEMDATAINX" and "ITEMDATAIN".

Messages are issued via "RETURN".

You can use structures "LISTHEADDATAOUT", "LISTITEMDATAOUT", "HEADDATAOUT" and "ITEMDATAOUT" to display the changed documents.

You can use structure "EXTENSIONIN" to include customer-specificfields. You must include these via an Append structure to structureBAPI_TE_KOMZRKE" for the document data and "BAPI_TE_KOMZRPE" for theitem data and "BAPI_TE_KOMZRLE" for the settlement request list. For
this BAPI, the field "REF_DOC" must be used as the key field, and field "DOCUMENT_NUMBER" left empty.

Notes

Caution: In method "BAPI_SETTLEMENTREQSLIST_CREATE", the field"PAYM_DOC" is used for the document instead of field "DOCUMENT_NUMBER".


Changeable fields

Header level Settlement request list

DOCUMENT_NUMBER Document number

BILL_DATE Posting date

CURRENCY Currency OS NCY

CURRENCY_ISO ISO code for currency


DOC_DATE Document date

REF_DOC_NO Reference

PAYMT_REF Payment reference

ALLOC_NMBR Assignment

GROSS_AMNT Total gross invoice amount

EXCH_RATE Directly quoted exchange rate


EXCH_RATE_V Indirectly quoted exchange rate

EX_RATE_FX Indicator for fixing exchange rate

TRANS_DATE Date for currency translation

PMNTTRMS Terms of payment key for the invoicing party

DSCNT1_TO Number of days for payment in the first condition


DSCT_PCT1 Cash discount percentage for payment in first
condition

DSCNT2_TO Number of days for payment in the second condition

DSCT_PCT2 Cash discount percentage for payment in second
condition


DSCNT3_TO Number of days for net due date

ADD_VAL_DY Additional value days of invoicing party

FIX_VAL_DY Fixed value date of the invoicing party

Header level Documents of the settlement request list


DOCUMENT_NUMBER Document number

BILL_DATE Posting date

CURRENCY Currency OS NCY

CURRENCY_ISO ISO code currency

DOC_DATE Document date

REF_DOC_NO Reference

PAYMT_REF Payment reference


ALLOC_NMBR Assignment

GROSS_AMNT Gross invoice amount

EXCH_RATE Directly quoted exchange rate

EXCH_RATE_V Indirectly quoted exchange rate

EX_RATE_FX Indicator for fixing exchange rate


TRANS_DATE Date for currency translation

PMNTTRMS Terms of payment key for invoicing party

DSCNT1_TO Number of days for payment in first condition

DSCT_PCT1 Cash discount percentage for payment in first
condition


DSCNT2_TO Number of days for payment in second condition

DSCT_PCT2 Cash discount percentage for payment in second
condition

DSCNT3_TO Number of days for net due date

ADD_VAL_DY Additional value days of the invoicing party


FIX_VAL_DY Fixed value date of the invoicing party

PMNTTRMS_DEB Terms of payment key, customer

DSCNT1_TO_DEB Cash discount 1 in days, customer

DSCT_PCT1_DEB Cash discoun 1 in percent, customer

DSCNT2_TO_DEB Cash discount 2 in days, customer


DSCT_PCT2_DEB Cash discount 2 in percent, customer

DSCNT3_TO_DEB Net due date, customer

PMNT_METH_DEB Payment method, customer

ADD_VAL_DY_DEB Additional value days, customer

FIX_VAL_DY_DEB Fixed value date, customer


PYMT_METH Payment method of invoicing party

INV_LIST_DATE Posting date of remuneration list

Item level Documents of the settlement request list

DOCUMENT_NUMBER Document number


ITEM Item

MATERIAL Material

MATL_GROUP Material group

VEND_PART Vendor subrange

COND_GROUP Condition group

PLANT Plant

TAX_CODE Input tax code


TAX_CODE_DEB Output tax code

NET_AMOUNT Net amount

GROSS Gross amount

TAX Tax amount

CASH_DISC Indicator - subject to cash discount

REF_DOC_HEAD Document number of reference document of business
partner


REF_DOC_ITEM Item number of reference document of business partner

PDOC_CAT Billing document type of reference document of business
partner

SHORT_TEXT Short text

TAXJURCODE Tax Jurisdiction Code


BUS_AREA Business area

COSTCENTER Cost center

PROFIT_CTR Profit center

NET_PRICE Net price

BON_GRP1 Settlement group 1 (purchasing)

BON_GRP2 Settlement group 2 (subsequent settlement)


BON_GRP3 Settlement group 3 (subsequent settlement)


11-Dec-2005


Close

Close


You use this method to close settlement request lists.

The settlement request list to be closed is identified by the paramter'DOCUMENTNUMBER'. However, if you only want to check whether thedocument is complete, before actually closing it, choose 'TESTRUN'. In
this case, the system checks whether the document can be closed or not.

Messages are issued via "RETURN".


11-Dec-2005


Create

Create


You can use this method to create settlement request lists.

As an input parameter, the list data must be transferred via structure.LISTHEADDATA. The document header data must also be transferred (via structure HEADDATA).

You transfer item data via table ITEMDATA. Item numbers can be assigned
manually in the appropriate fields, or automatically on the basis of the Customizing settings.

When a settlement request list has been successfully created, you get adocument number, some document header data and the link to the document number list.


Any errors that occur are announced via parameter RETURN.

Detailed information on the items in the document is contained in table ITEMDATAOUT.

You can add customer-specific fields by using structure EXTENSIONIN.These field must be added via an append structure to structure
BAPI_TE_KOMZRKE for document data, and BAPI_TE_KOMZRPE for item data,and BAPI_TE_KOMZRLE for the settlement request list. In this procedure,field REF_DOC must be used as a key field for this BAPI, and field DOCUMENT_NUMBER must be left free.


Notes

Caution: In structures HEADDATAOUT and LISTITEMDATAOUT, field PAYM_DOCis used for the document number, rather than the usual field DOCUMENT_NUMBER.

List header data:

1. Mandatory entries:

General

PAYTYPE Payment type


REF_DOC Number that uniquely identifies an external document

DIFF_INV Invoicing party

GROSS_AMNT Total invoice amount

BILL_TO Invoice recipient

CURRENCY Document currency

COMP_CODE Company code


Only for entries involving logistics data

PURCH_ORG Purchasing organization

PUR_GROUP Purchasing group

SALESORG Sales organization

DISTR_CHAN Distribution channel

DIVISION Division


2. Optional entries:

BILL_DATE Billing date

CURRENCY_ISO ISO code for currency

DOC_DATE Document date

REF_DOC_NO Reference document number

PAYMT_REF Payment reference

EXCH_RATE Exchange rate


EX_RATE_FX Indicator for exchange rate fixing

TRANS_DATE Conversion date for currency conversion

PMNTTRMS Terms of payment key for invoicing party

DSCNT1_TO Number of days for payment in first condition

DSCT_PCT1 Cash discount percentage for payment in first condition


DSCNT2_TO Number of days for payment in second condition

DSCT_PCT2 Cash discount percentage for payment in second condition

DSCNT3_TO Number of days for due date for net payment

If you enter a terms of payment key, you cannot enter terms of payment, and vice versa.


ADD_VAL_DY Additional value days of the invoicing party

FIX_VAL_DY Fixed value date of the invoicing party

You can only enter one of these two options

PMNTTRMS_DEB Terms of payment key for the invoicing party


DSCNT1_TO_DEB Number of days for payment in first condition

DSCT_PCT1_DEB Cash discount percentage for payment in first condition

DSCNT2_TO_DEB Number of days for payment in second condition

DSCT_PCT2_DEB Cash discount percentage for payment in second condition


DSCNT3_TO_DEB Number of days for due date for net payment

If you enter a terms of payment key, you cannot enter terms of payment, and vice versa.

ADD_VAL_DY_DEB Additional value days for invoicing party

FIX_VAL_DY_DEB Fixed value date of the invoice recipient


You can only enter one of these two options

PMNT_METH_DEB Payment method for invoice recipient

TESTRUN Switch to simulation (no changes made to DB)

EXCH_RATE_V Quantity-based exchange rate

ALLOC_NMBR Assignment


DOCID Barcode

Header data

1. Mandatory entries:

General

REF_DOC Number that uniquely identifies an external document

DIFF_INV Invoicing party

GROSS_AMNT Total invoice amount

BILL_TO Invoice recipient


CURRENCY Document currency

2. Optional entries:

PAYTYPE Payment type

If payment type and invoicing party exist, they are checked against the list header

BILL_DATE Billing date

CURRENCY_ISO ISO code for currenty


DOC_DATE Document date

REF_DOC_NO Reference document number

PAYMT_REF Payment reference

EXCH_RATE Exchange rate

EX_RATE_FX Indicator for exchange rate fixing

TRANS_DATE Conversion date for currency conversion


PMNTTRMS Terms of payment key for the invoicing party

DSCNT1_TO Number of days for payment in first condition

DSCT_PCT1 Cash discount percentage for payment in first condition

DSCNT2_TO Number of days for payment in second condition


DSCT_PCT2 Cash discount percentage for payment in second condition

DSCNT3_TO Number of days for due date for net payment

If you enter a terms of payment key, you cannot enter terms of payment, and vice versa.

ADD_VAL_DY Additional value days of the invoicing party


FIX_VAL_DY Fixed value date of the invoicing party

You can only enter one of these two options.

PMNTTRMS_DEB Terms of payment for the invoice recipient

DSCNT1_TO_DEB Number of days for payment in first condition

DSCT_PCT1_DEB Cash discount percentage for payment in first condition


DSCNT2_TO_DEB Number of days for payment in second condition

DSCT_PCT2_DEB Cash discount percentage for payment in second condition

DSCNT3_TO_DEB Number of days for due date for net payment

If you enter a terms of payment key, you cannot enter terms of payment, and vice versa.


ADD_VAL_DY_DEB Additional value days of the invoice recipient

FIX_VAL_DY_DEB Fixed value date of the invoice recipient

You can only enter one of these two options.

PMNT_METH_DEB Payment method for invoice recipient

TESTRUN Switch to simulation (no changes to DB)


PYMT_METH Payment method for invoicing party

INV_LIST_DATE Remuneration list date

ALLOC_NMBR Assignment

DOCID Barcode

Only for entries with logistics data

PURCH_ORG Purchasing organization


PUR_GROUP Purchasing group

SALESORG Sales organization

DISTR_CHAN Distribution channel

DIVISION Division

This data is checked against the list header data.

Only for entries without logistics data


COMP_CODE Company code

This data is checked against the list header data.

Item data

1. Mandatory entries

REF_DOC Number that uniquely identifies an external document.
This is used to assign the item data to the header data.


TAX_CODE Input tax code

TAX_CODE_DEB Output tax code

NET_AMOUNT Net amount for item

GROSS Gross amount for item

TAX Tax amount of the item

2. Optional entries:

General

REF_ITEM Document item


CASH_DISC Indicator - qualifying for cash discount

REF_DOC_HEAD Document number of preceding document at business partner

REF_DOC_ITEM Item number of preceding document at business partner

PDOC_CAT Billing category of preceding document at business
partner


SHORT_TEXT Short text

TAXJURCODE Tax jurisdiction code

BUS_AREA Business area

COSTCENTER Cost center

PROFIT_CTR Profit center

Only for entries with logistics data

MATL_GROUP Material group


MATERIAL Material

VEND_PART Vendor sub-range

COND_GROUP Condition group at vendor

PLANT Plant


11-Dec-2005


GetList

GetList


You use this method to request settlement request lists.

You use various structures to select the documents.

Settlement request lists are displayed via the structures "LISTHEADDATAOUT" (settlement request list), "LISTITEMDATAOUT"(documents of the settlement request list), "HEADDATAOUT" (header data
of the documents) and "ITEMDATAOUT" (item data of the documents).

Messages are returned via "RETURN".

Notes

Structures for selection

DOCUMENTNUMBERRANGE Document number

VENDORRANGE Vendor

PURCHORGRANGE Purchasing organization


PURGROUPRANGE Purchasing group

COMPCODERANGE Company code

BILLDATERANGE Posting date

INVLISTDATERANGE Remuneration list date

ACCTSTATUSRANGE Posting status

BILLTYPERANGE Billing document type


DOCDATERANGE Document date

REFDOCNORANGE Reference

ALLOCNMBRRANGE Assignment

PAYMTREFRANGE Payment reference


11-Dec-2005


ReleaseMultiple

ReleaseMultiple


You use this method to release settlement request lists to Financial Accounting.

You use various structures to select the documents that are to be released.

You can use structure "HEADDATAOUT" to display the released documents.

You can display the messages via "RETURN".


Notes

Structures for selection

DOCUMENTNUMBERRANGE Document number

VENDORRANGE Vendor

PURCHORGRANGE Purchasing organization

PURGROUPRANGE Purchasing group

COMPCODERANGE Company code


BILLDATERANGE Posting date

INVLISTDATERANGE Remuneration list date

PAYTYPERANGE Payment type

BILLTYPERANGE Billing document type

DOCDATERANGE Document date

REFDOCNORANGE Reference


ALLOCNMBRRANGE Allocation

PAYMTREFRANGE Payment reference


11-Dec-2005