Fonction SAP BAPI_BROKERREP_GETLIST - Use Selection Criteria to Read Broker Reports

Paramètre Reférence Type Long. Valeur par déf. Facultatif Description
INVOICINGPERIOD BAPIBROKER_PERIOD u 16 X Invoicing Period (from-to)
MAXROWS BAPIBROKREPCTRL-MAX_ROWS I 4 X Maximum Number of Lines of Hits
NO_AUTH_CHECK BAPIBROKREPCTRL-NO_AUTH_CHECK C 1 X

Paramètre Reférence Long. Facultatif Description
BROKERREPORTHEADERKEY BAPIBROKREPHEADER_KEY 12 Broker Report - BAPI Structure Broker Report Header
EXTENSIONIN BAPIPAREX 990 X Reference Structure for BAPI Parameters EXTENSIONIN/EXTENSIONOUT
EXTENSIONOUT BAPIPAREX 990 X Reference Structure for BAPI Parameters EXTENSIONIN/EXTENSIONOUT
RANGEBROKER BAPIFKKR_GPART 23 X BAPI: Ranges Structure for Business Partner (FI-CA)
RANGEBROKERCONTRACT BAPIFKKR_VTREF 43 X BAPI: Ranges Structure for Ref Specifications from Contract (FI-CA)
RANGESEARCHTERM BAPIBROKER_RANGE_SEARCHKEY 83 X Broker Report - BAPI Structure Broker Report Search Term
RANGESTATUS BAPIBROKER_RANGE_STATUS 5 X Broker Report - BAPI Structure Broker Report Status
RETURN BAPIRET2 548 Return Parameters

Functionality
The method delivers all broker report identifications for the specifiedselection criteria:

  • With the MAXROWS selection parameter, you can restrict the number
    • of broker report identifications to be output to the number you want.
    • With the RANGEPERIOD parameter, you can restrict the results by
      • specifying the invoicing period.
      • With the RANGEBROKER parameter, you can restrict the results by
        • specifying the reporting broker.
        • With the RANGEBROKERCONTRACT parameter, you can restrict the
          • results by specifying the contracts for the reporting broker.
          • With the RANGESEARCHITEM parameter, you can restrict the results
            • by specifying the search terms.
            • With the RANGESTATUS parameter, you can restrict the results by
              • specifying the broker report status.
              • With the RANGEFIKEY parameter, you can restrict the results by
                • specifying the reconciliation keys.
                • The BROKERREPORTHEADERKEY parameter contains the broker report
                  • identifications that have been found.

                  Notes

                  • You require the authorization to display a broker report (activity 03 in
                    • the I_VVBR_STM authorization object).
                    • If you require detailed information about the broker report
                      • identifications that have been found, you can get this with theBAPI_BROKERREP_GETDETAIL functionmodule.

                      Description
                      You can use the INVOICINGPERIOD parameter to restrict the outputlist to the specified period.
                      The system uses the date, if you use the proposal function to determineopen items on customer accounts and the commission account for thebroker.
                      You can use the upper and lower limit to check whether the data reportedby the broker is complete.
                      INCLUDE BAPI_CD_BROREP_MAXROWS OBJECT DOKU ID TX

                      Description
                      The BAPIBROKREPHEADER_KEY parameter contains the broker reportidentifications that have been found, under the REPORT component.

                      Description
                      The ExtensionIn parameter is used for customer enhancements. Thecustomer can use this to enter more selection criteria for the GetListmodule, to make further restrictions on the number of hits.

                      • You have the option of checking the contents of the ExtensionIn
                        • parameter in event V586.
                        • Event V587 allows the use of the ExtensionIn parameter to
                          • restrict the number of hits that is transferred with theBrokerReportHeaderKey parameter.
                          INCLUDE BAPI_CD_BROREP_EXINRANGEHINT OBJECT DOKU ID TX

                          Description
                          The ExtensionOut parameter is used for customer enhancements. Inaddition to the broker report ID, the customer can export more data, andtransfer more data from the BAPI.

                          • Event V587 can be used to fill the ExtensionOut parameter. The
                            • entire broker report header data is delivered in the Exit with theBrokerReportHeader parameter, which can be used to fill the ExtensionOutparameter.
                            INCLUDE BAPI_CD_BROREP_RANGE OBJECT DOKU ID TX
                            In this case, it is the business partner number for the reportingbroker.
                            INCLUDE BAPI_CD_BROREP_RANGE OBJECT DOKU ID TX
                            In this case, it is the broker contract for the reporting broker.
                            INCLUDE BAPI_CD_BROREP_RANGE OBJECT DOKU ID TX
                            In this case, it is the alternative search term for the broker report.
                            INCLUDE BAPI_CD_BROREP_RANGE OBJECT DOKU ID TX
                            In this case, it is the status for the broker report.
                            INCLUDE BAPI_CD_BROREP_RETURN OBJECT DOKU ID TX
                            After being called, the RETURN parameter contains:
                            • If no broker report item corresponds to the selection criteria: Message
                              • S231 (IBRO).