Fonction SAP BAPI_BROKERREP_COLLECTITEMS - Summarization of Open Items to Be Cleared in Broker Report Items

Paramètre Reférence Type Long. Valeur par déf. Facultatif Description
CLEARINGCURRENCY BAPIDFKKCL-CURRENCY C 5 Transaction Currency
CLEARINGCURRENCYISO BAPIDFKKCL-CURRENCY_ISO C 3 ISO Currency Code
CLEARINGDATE BAPIDFKKCL-DOC_DATE D 8 SY-DATUM X Clearing Date
COINSTRANSF BAPIBROKREPCTRL-COINS_TRANSF C 1 X
NO_AUTH_CHECK BAPIBROKREPCTRL-NO_AUTH_CHECK C 1 X
REPORTID BAPIBROKREPHEADER-REPORT C 12 Broker Report - BAPI Structure Broker Report Header
TESTRUN BAPIBROKREPCTRL-TESTRUN C 1 X Single-Character Flag

Paramètre Reférence Long. Facultatif Description
BROKERREPORTITEM BAPIBROKREPITEM_DETAIL 518 X Broker Report: BAPI Structure Item Identification
BROKERREPORTITEMNUMB BAPIBROKREPITEM_IDENT 6 X Broker Report: BAPI Structure Item Identification
BROKERREPORTSELITEM BAPIBROKREPSELITEMC 73 Broker Report: BAPI Structure Selected Items
EXTENSIONIN BAPIPAREX 990 X Reference Structure for BAPI Parameters EXTENSIONIN/EXTENSIONOUT
EXTENSIONOUT BAPIPAREX 990 X Reference Structure for BAPI Parameters EXTENSIONIN/EXTENSIONOUT
RETURN BAPIRET2 548 X Return Parameters

Functionality
The method summarizes open items in broker report items.

  • In the REPORTID parameter, you specify the ID of the BrokerReport
    • business object to which items are to be added.
    • The broker report must have one of the following statuses:

      • Items can still be added (manual processing)
      Report processed with BAPI
      • Open items and the associated clearing information are stored in the
        • BROKERREPORTSELITEM parameter.
        • You specify the clearing currency in the CLEARINGCURRENCY or
          • CLEARINGCURRENCY_ISO parameter.
          • You enter the clearing date in the CLEARINGDATE parameter.

          • Customer fields in the created broker report items can be supplied using
            • the EXTENSIONIN parameter.
            • After processing the EXTENSIONIN parameter, event V546 runs to
              • fill the customer fields with information from the open items to becleared.
              • Event V545 runs to check the customer fields for the broker report
                • items.
                • If the broker report items were created, the identifications for the
                  • created items are stored in the BAPIBROKREPORTITEMNUMB parameter.
                  • Detailed information for the created broker report items is stored in
                    • the BROKERREPORTITEM parameter.
                    • The method is executed as a test run if you fill the TESTRUN
                      • parameter with 'X'.
                      • Event V583 also runs at the start of the
                        • method, and you can use it to check the parameters for the method.
                        • Event V594 runs at the end of the method, and
                          • you can use it to fill the ExtensionOutparameter.

                          Notes

                          • You require the authorization to change a broker report (activity 02 in
                            • the I_VVBR_STM authorization object).

                            Further information

                            • You can select open items using the GetOpenItems method.

                              • INCLUDE BAPI_CD_BROREP_CLEARINGCURR OBJECT DOKU ID TX

                              Description
                              Clearing currency for open items (ISO code).

                              Description
                              Clearing date for open items
                              Note
                              The clearing date is used to check business locks and withholding taxexemptions.
                              For example, if an open item possessing a payment lock for the clearingdate is delivered, an appropriate error message is written in the RETURNparameter and processing is cancelled.
                              INCLUDE BAPI_CD_BROREP_BROREPID OBJECT DOKU ID TX
                              INCLUDE BAPI_CD_BROREP_TESTRUN OBJECT DOKU ID TX

                              Description
                              If the method is called up in the update run, the parameter containsdetailed information about the created broker report items.
                              INCLUDE BAPI_CD_BROREP_ITEMNUMB OBJECT DOKU ID TX
                              INCLUDE BAPI_CD_BROREP_SELITEM OBJECT DOKU ID TX
                              INCLUDE BAPI_CD_BROREP_EXTENSIONINP OBJECT DOKU ID TX

                              • The information is passed on to the customer fields for all created
                                • broker report items.
                                • Alternatively, or in addition, you can use event
                                  • V546 to fill customer fields with theinformation from the documents to be cleared.

                                  Description
                                  You can fill the ExtensionOut parameter using theV594 event.
                                  INCLUDE BAPI_CD_BROREP_RETURN OBJECT DOKU ID TX
                                  After being called, the RETURN parameter contains:

                                  • Information method I501 (IBRO) - if the method was called in the test
                                    • run.
                                    • Success message S012 (IBRO) - if the broker report items were created.

                                    • Error message E013 (IBRO) - if the broker report items were not created
                                      • - as well as an appropriate error message about why the broker reportitems were not created.