SAP BAPI_DOCUMENT_GETSTATUS Function Module for Read Document Status









BAPI_DOCUMENT_GETSTATUS is a standard bapi document getstatus SAP function module available within SAP R/3 or S/4 Hana systems, depending on your version and release level. It is used for Read Document Status processing and below is the pattern details for this FM, showing its interface including any import and export parameters, exceptions etc. there is also a full "cut and paste" ABAP pattern code example, along with implementation ABAP coding, documentation and contribution comments specific to this or related objects.


See here to view full function module documentation and code listing for bapi document getstatus FM, simply by entering the name BAPI_DOCUMENT_GETSTATUS into the relevant SAP transaction such as SE37 or SE38.

Function Group: CVBAPI
Program Name: SAPLCVBAPI
Main Program: SAPLCVBAPI
Appliation area: M
Release date: 03-Jun-1998
Mode(Normal, Remote etc): Remote-Enabled
Update:



Function BAPI_DOCUMENT_GETSTATUS pattern details

In-order to call this FM within your sap programs, simply using the below ABAP pattern details to trigger the function call...or see the full ABAP code listing at the end of this article. You can simply cut and paste this code into your ABAP progrom as it is, including variable declarations.
CALL FUNCTION 'BAPI_DOCUMENT_GETSTATUS'"Read Document Status
  EXPORTING
   DOCUMENTTYPE =  "Document Type
   DOCUMENTNUMBER =  "Document Number
   DOCUMENTPART =  "Document Part
   DOCUMENTVERSION =  "Document Version

 IMPORTING
   STATUSEXTERN =  "Status Abbreviation
   STATUSINTERN =  "Internal Document Status
   STATUSDESCRIPTION =  "Status Description
   RETURN =  "BAPI Return
.



IMPORTING Parameters details for BAPI_DOCUMENT_GETSTATUS

DOCUMENTTYPE - Document Type

Data type: BAPI_DOC_AUX-DOCTYPE
Optional: No
Call by Reference: No ( called with pass by value option)

DOCUMENTNUMBER - Document Number

Data type: BAPI_DOC_AUX-DOCNUMBER
Optional: No
Call by Reference: No ( called with pass by value option)

DOCUMENTPART - Document Part

Data type: BAPI_DOC_AUX-DOCPART
Optional: No
Call by Reference: No ( called with pass by value option)

DOCUMENTVERSION - Document Version

Data type: BAPI_DOC_AUX-DOCVERSION
Optional: No
Call by Reference: No ( called with pass by value option)

EXPORTING Parameters details for BAPI_DOCUMENT_GETSTATUS

STATUSEXTERN - Status Abbreviation

Data type: BAPI_DOC_DRAW-STATUSEXTERN
Optional: No
Call by Reference: No ( called with pass by value option)

STATUSINTERN - Internal Document Status

Data type: BAPI_DOC_DRAW-STATUSINTERN
Optional: No
Call by Reference: No ( called with pass by value option)

STATUSDESCRIPTION - Status Description

Data type: BAPI_DOC_TDWS-DESCRIPTION
Optional: No
Call by Reference: No ( called with pass by value option)

RETURN - BAPI Return

Data type: BAPIRET2
Optional: No
Call by Reference: No ( called with pass by value option)

Copy and paste ABAP code example for BAPI_DOCUMENT_GETSTATUS Function Module

The ABAP code below is a full code listing to execute function module POPUP_TO_CONFIRM including all data declarations. The code uses the original data declarations rather than the latest in-line data DECLARATION SYNTAX but I have included an ABAP code snippet at the end to show how declarations would look using the newer method of declaring data variables on the fly. This will allow you to compare and fully understand the new inline method. Please note some of the newer syntax such as the @DATA is not available until a later 4.70 service pack (SP8), which i why i have stuck to the origianl for this example.

DATA:
lv_documenttype  TYPE BAPI_DOC_AUX-DOCTYPE, "   
lv_statusextern  TYPE BAPI_DOC_DRAW-STATUSEXTERN, "   
lv_statusintern  TYPE BAPI_DOC_DRAW-STATUSINTERN, "   
lv_documentnumber  TYPE BAPI_DOC_AUX-DOCNUMBER, "   
lv_documentpart  TYPE BAPI_DOC_AUX-DOCPART, "   
lv_statusdescription  TYPE BAPI_DOC_TDWS-DESCRIPTION, "   
lv_return  TYPE BAPIRET2, "   
lv_documentversion  TYPE BAPI_DOC_AUX-DOCVERSION. "   

  CALL FUNCTION 'BAPI_DOCUMENT_GETSTATUS'  "Read Document Status
    EXPORTING
         DOCUMENTTYPE = lv_documenttype
         DOCUMENTNUMBER = lv_documentnumber
         DOCUMENTPART = lv_documentpart
         DOCUMENTVERSION = lv_documentversion
    IMPORTING
         STATUSEXTERN = lv_statusextern
         STATUSINTERN = lv_statusintern
         STATUSDESCRIPTION = lv_statusdescription
         RETURN = lv_return
. " BAPI_DOCUMENT_GETSTATUS




ABAP code using 7.40 inline data declarations to call FM BAPI_DOCUMENT_GETSTATUS

The below ABAP code uses the newer in-line data declarations. This allows you to see the coding differences/benefits of the later inline syntax. Please note some of the newer syntax below, such as the @DATA is not available until 4.70 EHP 8.

"SELECT single DOCTYPE FROM BAPI_DOC_AUX INTO @DATA(ld_documenttype).
 
"SELECT single STATUSEXTERN FROM BAPI_DOC_DRAW INTO @DATA(ld_statusextern).
 
"SELECT single STATUSINTERN FROM BAPI_DOC_DRAW INTO @DATA(ld_statusintern).
 
"SELECT single DOCNUMBER FROM BAPI_DOC_AUX INTO @DATA(ld_documentnumber).
 
"SELECT single DOCPART FROM BAPI_DOC_AUX INTO @DATA(ld_documentpart).
 
"SELECT single DESCRIPTION FROM BAPI_DOC_TDWS INTO @DATA(ld_statusdescription).
 
 
"SELECT single DOCVERSION FROM BAPI_DOC_AUX INTO @DATA(ld_documentversion).
 


Search for further information about these or an SAP related objects



Comments on this SAP object

What made you want to lookup this SAP object? Please tell us what you were looking for and anything you would like to be included on this page!