Business Application Programming Interfaces (BAPIs) 
Description
BAPIs (Business Application Programming Interfaces) are open, business
-oriented programming interfaces for accessing data and business
processes in R/3 Systems from external systems. BAPIs are defined in
the Business Object Repository (BOR) as methods of SAP Business Objects
or SAP Interface Types and enable object-oriented access to Business Components (application components) in the R/3 System.
For information about BAPI interface technology refer to the R/3 Library under:
CA - Cross-Application Components
- Business Framework Architecture
- BAPI Technology
In Release 4.5A new developments in the BAPI area are:
- Methods of SAP Interface Types
BAPIs are now also defined as methods of SAP interface types so that outbound interfaces can be documented.
Functions implemented outside the R/3 System can be standardized and provided as BAPIs.
- New Functions for Using BAPIs in Asynchronous Data Transfer (Application Link Enabling).
For further information refer to the Release Notes for Application Link Enabling.
- BAPI Java Class Library in SAP Assistant
In Release 4.5A a dynamic BAPI Java class library is provided in SAP
Assistant, enabling object-oriented access to BAPIs from Java platforms. To call BAPIs the standard Java data types and classes can
be used instead of SAP internal data types and structures.
To use the BAPI Java Class Library, the RFC Java Class Library, also provided in Release 4.5A, must also be installed.
The Repository Browser is an ActiveX Control used for displaying the BAPI meta information in the Business Object Repository.
The Repository Browser can be used in all the COM-based development
environments and applications. For example, in SAP Assistant it is used to display BAPI meta data.
- The SAP R/3 DCOM Connector
The R/3 DCOM Connector, jointly developed by Microsoft and SAP, enables
R/3 objects and COM objects to be seamlessly integrated. SAP Business
Objects and their BAPIs can be transparently called from COM-based development tools and COM Components are provided in the SAP
development environment.
The R/3 DCOM Component Connector Software Development Kit (SDK) is shipped as a component of the RFC SDK for Windows NT.
- Integrating BAPIs in Microsoft's "Visual Studio 97" (Enterprise Edition)
In the future BAPIs from R/3-Release 3.1H and 4.0A will be provided
locally in Microsoft's development environment, Visual Studio 97 (Enterprise Edition).
- Accessing BAPIs from IBM's "Access Builder for SAP R/3"
BAPIs can be integrated into IBM's development environment, VisualAge
for Java using IBM's Access Builder for SAP R/3. BAPI-enabled Java
applications, Java applets and JavaBeans for the R/3 System can be
developed with the Access Builder for SAP R/3. Java developers can enhance the functionality of the R/3 System with additional Java
applications or link existing Java Applications to the R/3 System.
IBM's Access Builder for SAP R/3 is a component of VisualAge for Java
Enterprise Edition 2.0 and within the context of the VisualAge
Developer Domain is also available as a stand-alone development tool in the VisualAge Developer Domain.
- Accessing BAPIs through "Object Bridge" from Visual Edge
The middleware product "Object Bridge" from Visual Edge enables
automatic access to BAPIs from all CORBA 2.0-enabled Object Request
Brokers (ORBs) as well as from other object-oriented protocols, such as ActiveX/DCOM.
- Central Note on Obsolete BAPIs
All obsolete BAPIs
All obsolete BAPIs are listed in the Online Software Service (OSS) in
Note 0107644 "Composite Note for Obsolete BAPIs as of Release 4.5A".
Many new BAPIs have been implemented in Release 4.5A. Further details
of the new BAPIs listed below are provided in the BAPI Browser in the
R/3 System. (You can find an up-to-date list of BAPIs implemented in 4.5A in the Open BAPI Network).
New BAPIS in Basis/Cross-Applications:
Business Object BackgroundJob
(Externally controllable background (an interface))
Abort
(Cancel Job)
AddABAPStep
(Append Job Step With ABAP Program to a Job)
AddExternalStep
(Assign external program to job step)
CheckStatus
(Reconcile Job Status According to DB With Actual Status)
Close
(Complete job definition)
CountByName
(Count How Many Jobs There are With a Particular Name)
Delete
(Delete a job in the R/3 System)
GetDefinition
(Read job definition)
GetStatus
GetVariantListForReportname
(Determine all Defined Variants of an ABAP Program)
ModifyABAPStep
(Assign ABAP Program to a Particular Job Step)
ModifyExternalStep
(Assign External Program to a Particular Job Step)
Open
(Create Job)
ReadJoblog
(Read job log)
ReadSpoollist
(Read spool list of ABAP job step)
Select
(Select jobs according to various criteria)
StartAsSoonAsPossible
(Start job as soon as possible)
StartImmediately
(Start job immediately)+
Business Object BapiService
(General service functions for BAPIs)
ApplicationLogGetDetail
(Read details of entries in application log)
FieldhelpGetDocu
(Read input help on BAPI interface parameter)
InterfaceGetDocu
(Read BAPI interface documentation)
MessageGetDetail
(Read long text of error message)
TransactionCommit
(Execute external Commit when using BAPIs)
TransactionRollback
(Execute external Rollback when using BAPIs)
Business Object Barcode
(SAP ArchiveLink bar code entry)
SendList
(receive bar code confirmation from external archive)
Business Object BusPartnerEmployee
(Business partner employee)
GetInternalNumber
(new internal contact person numbers)
GetList
(List of addresses)
Business Object Currency
GetList
(list of currency codes in SAP System)
Business Object ExchangeRate
(Exchange rate)
Create
(Insert an entry in table of exchange rates)
CreateMultiple
(Insert one or more exchange rates in SAP tables)
GetCurrentRates
(List of exchange rates per exch.rate type and date)
GetDetail
(Exchange rate stored for exch.rate type, currency pair, value date)
GetFactors
(Display relevant factors for exchange rate)
GetListRateTypes
(List of all exchange rate types used for conversion)
SaveReplica
(Replication of currency rates)
Business Object FlightBooking
(Flight booking (SAP training))
Cancel
(Canceling a booking)
CreateFromData
(Create booking)
GetDetail
(Booking details)
GetList
(List of bookings)
Business Object FlightConnection
(Flight with connection data (SAP training))
GetDetail
(Flight details)
GetList
(List of flights)
Business Object FlightCustomer
(Customer (SAP training))
ChangePassword
(Change Internet password)
CheckPassword
(Check Internet password)
CreateFromData
(Generate)
Business Object ZH>HRMasterDataReplica
(Control object for HR master data replication)
SaveReplicaMultiple
(Replication of HR Master Data and HR Organizational Data)
Business Object OrgMasterDataReplica
(Control object for org. master data replication)
SaveReplicaMultiple
(Replication of HR organizational data)
Business Object PDobjecttypes
(PD object types)
GetDetailedList
(Object list with detailed information)
Business Object SystemMngmtSession
(Implementing the XMI)
CheckVersion
(Check Whether a Particular Version of an Interface is
Supported)
DescribeInterface
(Query Long Name of an Interface)
EnterLogmsg
(Enter External Message in XMI Log)
GetVersions
(Query Supported Versions of XMI Interfaces)
Logoff
(Log off an external management tool)
Logon
(Log onto an external management tool)
SelectLog
(Selection of Translated Entries in XMI Log)
SetAuditlevel
(Set Audit Level of an XMI Session)
UploadMsgFormats
(Transfer of External Message Formats)
Business Object SystemServiceInfo
(Information on R/3 System services (WPs))
GetBackgroundResourcesOnDate
(Determine all Background Resources Available on a Particular
Date)
GetBgrdResourcesOnDateOnServer
(Determine Background Resources of Server on Particular Date)
GetCurrentBackgroundResources
(Determine Background Resources Currently Available in System)
Business Object USER
(R/3 System user)
ActgroupsAssign
(Change whole activity group assignment)
ActgroupsDelete
(User: Delete whole activity group assignment)
Change
(Change user)
Clone
(Create a user clone using templates from other system)
Create
(Create a user)
Delete
(Delete a user)
Display
(Display object)
GetDetail
(Read user detail data)
Lock
(Lock user)
ProfilesAssign
(Assign profiles)
ProfilesDelete
(Delete all profile assignments)
Unlock
(Unlock user)
Business Object UserCompany
(Company for company address)
Clone
(Clone user company (especially address))
New BAPIs in Human Resources:
Interface Type RCVPEVTREC
Receiver for Check Data: Recording Time Events)
receiveCostCenter
(CC1: Download cost centers)
receiveInternalOrder
(CC1: Download internal orders)
receiveMiniMasterData
(CC1: Download HR mini-master)
receivePExpenses
(CC1: Download permitted external wage types)
receivePTBalance
(CC1: Download employee balances)
receiveTEventTypeGrp
(CC1: Download time event type groups)
receiveWBSElement
(CC1: Download WBS element)
requestPEvent
(CC1: Upload request for time events)
requestPExpenses
(CC1: Upload request for employee expenditures)
Interface Type RCVPEVTTGR
(Receiver for groups of work time event types)
receiveTEventTypeGrp
(KK1: Download time event type groups)
Interface Type RCVPEXPREC
(Receiver for inspection data for recording EE expenditures9
receivePExpenses
(Download permitted external wage types)
requestPExpenses
(KK1: Request upload employee expenditures)
Interface Type RCVPMINIMD (Receiver for HR mini-master)
receiveMiniMasterData
(KK1: Download HR mini-master)
Business Object BusinessEventtype
(Business event type)
GetListFromQualification
(Business event types for qualification specified)
GetListFromTarget
(Business event types for target group specified)
GetListFromName
(Business event types for object text specified)
GetListFromDescription
(Business event types for description specified)
SubtypesForDescription
(Sub objects of Description info type)
Business Object EmpBenefitStockpPlan
(Employee benefits - stock purchase plan)
GetBeneficiaries
(Beneficiaries for stock purchase plans)
GetPossBeneficiaries
(Possible beneficiaries for stock purchase plans)
EmployeeAbsence
(Employee absence)
GetdetailedList
(Read instances with data)
Business Object EmployeeAttAbs
Employee absence or attendance)
GetDetail
(Original derived absence/attendance data)
GetList
(List of existing absences/attendances accdg to selection criteria)
Business Object EmployeeBankDetail
(Bank details)
Getdetailedlist
(Read instances with data)
Business Object EmployeeBenAdjReason
(Employee benefits adjustment reason
GetList
(Define adjustment reasons that are currently valid for an employee)
Business-Objekt EmployeeBenefit
Employee - benefits)
CreateOffer
(Define benefits offer)
Business Object EmployeeDateSpecific
(Employee date specification)
Getdetailedlist
(Read instances with data)
Business Object EmployeeFamilyMember
(Employee family/related person)
Getdetailedlist
(Read instances with data)
Business Object EmployeeFamMemberUs
(Employee family/related person US)
Approve
(Unlock family )
Change
(Change family)
Create
(Create family)
Delete
(Delete family)
Getdetail
(Display family)
Getdetailedlist
(Read instances with data)
Getlist
(Read instances)
Request
(Create locked family)
Simulatecreation
(Simulation: create family)
Business Object EmployeeFiscalDataCA
(Employee tax data - Canada)
GetDetailedList
(Read instances with data)
Business Object EmployeeGenBenInfo
(Employee - general benefits information)
GetOpenEnrollmentPeriod
(Check if open enrollment period exists and period is
indicated)
Business Object EmployeePayrollAcc
(Employee payroll account)
GetDetail
(Remuneration statement for one personnel number)
GetDetailHtml
(Payroll form for employees in HTML format)
GetResultList
(Directory of payroll results for one personnel number)
Business Object EmployeePersonalData
(Employee personal data)
Getdetailedlist
(Read instances with data)
Business Object EmployeePrivAddress
(Private address of employee)
Getdetailedlist
(Read instances with data)
Business Object EmployeePrivateAdrUS
Private address of employee US)
Change
(Change address of employee)
Create
(Create address)
CreateSuccessor
(Create subsequent employee address)
Getdetail
(Read employee address)
Getdetailedlist
(Read instances with data)
Request
(Create locked employee address)
Simulatecreation
(Simulation: create employee address)
Business Object EmployeeTimeQuota
(EE time quota)
GetDetailedList
(Determine quota data for a personnel number)
Business Object EmployeeTimeValSpec
(Employee: EE Time Valuation Specifications)
Check
(Check different payment)
CheckBonus
(Check bonus)
CheckCurrency
(Check currency)
CheckPosition
(Check item)
CheckWageGroupLevel
(Check pay scale/level)
GetCurrency
(Determine currency)
Business Object EmployeeUser
(SAP user with HR master data)
GetEmployee
(Determine employee from SAP user)
Business Object EmployeeW4W5InfoUS
(MA W4/W5 taxes US)
Approve
(Unlock employee W4/W5 information record)
Change
(Change employee W4/W5 information record)
Create
(Create employee W4/W5 information record
Delete
(Delete employee W4/W5 information record)
GetDetail
(Read employee W4/W5 information record)
GetDetailedList
(Read Employee W4/W5 details of information instances)
GetList
(Read employee W4/W5 information instances)
Request
(Create locked employee W4/W5 information record)
SimulateCreation
(Simulation: Create W4/W5 information record)
Business Object JobRequirement
(Job requirement)
GetList
(Read requirement profile)
Business Object PTimeOverview
(Employee time overview)
SaveReplica
(Distribute employee's time overview)
Get
(Determine employee's time overview)
Replicate
(Trigger distribution of employee's time overview)
DeleteReplica
(delete distribution of employee's time overview)
Business Object PTManagerAttAbsence
(Manager for attendances/absences)
ManageChange
(Start and control "Change att./absences" process)
ManageCreation
(Start and control "Create att./absences" process)
ManageDelete
(Start and control "Delete att./absences" process)
Business Object PTManagerExtAttAbs
(Manager: External attendances/absences)
Check
(Check attendance/absence w/o acct assgmnt)
CheckCollision
(Collision check)
CheckQuota
(Check quota deduction)
CheckWithActivityAllocation
(Check attendance/absence with activity allocation)
CheckWithCostAssignment
(Check attendance/absence with cost allocation)
Insert
(Insert attendance/absence w/o acct assgmnt)
InsertWithActivityAllocation
(Insert attendance/absence with activity allocation)
GetDetailedList
(Reads details of objects)
Business Object PTManagerExtPEvent
(Manager: External Employee Time Events)
Insert
(KK1: Upload time events)
Business Object PTMgrExtPExpenses
(Manager: Billable Expenditures)
Insert
(KK1: Upload employee expenditures)
Business Object PTManagerExtTimeSpec
(Manager: External personnel time entries)
Display
(Display external data in infotype)
GetStatus
(Define status of record in interface table)
Business Object PTManagerExtRemunSpec
Manager: Ext. Remuneration Specifications)
Check
(Check ext. EE remun. info (w/o acct assgnmnt))
CheckWithActivityAllocation
(Check ext. EE remun. info (with activity allocation))
CheckWithCostAssignment
(Check ext. EE remun. info (with cost allocation))
Insert
(Insert ext. EE remuneration info in table (w/o acc.assgnmnt))
InsertWithActivityAllocation
(Insert EE remuneration info in table (with activity
allocation)
InsertWithCostAssignment
(Insert ext. EE remuneration info in table (w/cost assgnmt))
Business Object PayrollAccDocument
(Payroll accounting posting document for posting to Accounting)
Display_Acc
(Display document (from AC))
Business Object Qualification
(Qualifications of person)
GetList
(Read qualifications profile)
Business Object Qualificationtype
(Qualification type)
GetDetail
(Read detailed information)
GetList
(Read)
Business Object WorkflowObject
(Attendance)
BapiPrebookAttendance
(Book prebooking)
DeleteAttendance
(Delete attendance)
BookAttendance
(Book attendance)
Business Object Batch
(Batch)
Change
(Change batch)
Create
(Create batch)
GetDetail
(Batch detailed information)
LevelGet
(Determine batch level)
Replicate
(Distribute batch)
SaveReplica
(Replicate batch)
Business Object ControlRecipe
(Control recipe)
GetList
(Read control recipe lists)
Request
(Request and transfer control recipe)
Business Object DangerousGood
(Dangerous good)
Replicate
(Request dangerous goods instances)
SaveReplicaMultiple
(Save replicated dangerous goods instances)
Business Object GoodsMovement
(Goods movement)
CreateFromData
(BAPI posting of goods mvts with MB_CREATE_GOODS_MOVEMENT)
GetItems
(List goods movement items + header data)
Cancel
(Reverse goods movement)
GetDetail
(Display details of goods movement)
Business Object InboundDelivery
(Delivery)
ConfirmDecentral
(Verification of replaced inbound deliveries from a
decentralized system)
SaveReplica
(Duplication of inbound deliveries)
Business Object InspectionLot
(Inspection lot)
GetDetail
(Load detail data for inspection lot)
SetUsageDecision
(Make the automatic usage decision)
Business Object ItCustBillingDoc
(Customer individual billing document)
CreateFromData
(Create using external document)
Simulate
(Simulate using external document)
IsCancelled (Has the billing document been cancelled?)
CancelFromData
(Cancel)
Business Object
MatAllocationTable
(Material allocation table)
GetDetailedList
(List of alloc tbls and items for a store)
ConfirmRequest
(Report requested quantities for items and delivery phases)
Business Object MaterialPhysInv
(Material inventory)
ChangeCount
(Change count for particular items of a phys. inv. doc.)
Count
(Enter count for particular items of a phys. inv. doc.)
Create
(Create Physical Inventory Document)
GetDetail
(Read header and items of a phys. inv. doc.)
GetItems
(List of phys. inv. docs with headers and items)
GetList
(List of phys. inv. doc. header records)
PostDifferences
(Post difference)
Business Object OutboundDelivery
(Outbound delivery)
ConfirmDecentral
(BAPI for delivery confirmation from a decentralized
system)
SaveReplica
(Replicate deliveries)
Business Object PlannedOrder
(Planned order)
Change
(Change)
Create
(Create)
Delete
(Delete)
ExistenceCheck
(Check existence)
GetDetail
(Get header, components, and capacity data)
GetDetailedList
(Get details)
Business Object ProcessCharactrstcPI
(Process characteristic)
GetHelpvalues
(Get allowed values for process characteristic)
GetList
(Get list)
Business Object
ProcessMessagePI
(Process message)
Create
(Create)
ExistenceCheck
(Check process message existence)
Business Object ProdOrdConfirmation
(Production order confirmation)
Cancel
(Cancel production order confirmation)
CreateActConfMultiple
(Enter activity confirmation)
CreateAtHeaderLevelMultiple
(Enter order confirmation)
CreateTimeEventMultiple
(Enter time event confirmation)
CreateTimeTicketMultiple
(Enter time ticket confirmation)
ExistenceCheck
(Check existence of object)
GetAtHeaderLevelProposal
(Recommend data for order confirmation)
GetDetail
(Detailed data for production order confirmation)
GetList
(Confirmation lists)
GetTimeEventProposal
(Recommend data for time event confirmation)
GetTimeTicketProposal
(Recommend data for time ticket confirmation)
Business Object ProductCatalog
(Product catalog)
GetItem
(Reads individual product catalog item)
Business Object Promotion
(Promotion)
ChangeSitePlanning
(Change to plant planning data)
ConfirmRequest
(Confirmation of plant's required quantities)
GetAnnouncedList
(List of promotions for a plant)
Business Object PurchaseRequisition
Release
(Releases purchase requisition)
ResetRelease
(Cancels release of purchase requisition)
Business Object QualityNotification
(Quality notification)
GetKeyFigures
(Determining related quality notifications)
Business Object RetailMaterial
(Retail material)
SaveAdditionalsReplicas
(Create and change additionals (retail))
Business Object SalesAdditionalsReq
(Request for additionals)
Replicate
(Request detailed data on additionals)
Business Object ServiceEntrySheet
(Service entry sheet)
Create
(Create entry sheet)
Delete
(Delete entry sheet)
Business Object SettlementRequstList
(Settlement request list)
Create
(Create)
Business Object SingleSettlementReqs
(Single settlement request)
CreateMultiple
(Create)
Business Object SiteLayoutModule
(Plant layout module)
Change
(Change items of a layout module)
GetItem
(Material data for a layout module)
Business Object SourceOfSupplyDeterm
(Source of supply determination)
GetSourcesOfSupply material/material group)
Business Object AcctngGLPosting
(Accounting GL Posting)
Check
(Accounting: General G/L account posting)
Post
(Accounting: General G/L account posting)
Business Object AcctngSalesOrder
(Accounting sales order)
Check
(Accounting: Check sales order)
Post
(Accounting: Post sales order)
Business Object AcctngSalesQuotation
(Accounting sales quotation)
Check
(Accounting: Check customer quotation)
Post
(Accounting: Post customer quotation)
Business Object AcctngTravelExpenses
(Accounting travel expenses)
Check
(Accounting: Check trip)
Post
(Accounting: Post trip)
Business Object AssetAcquisition
(Asset Acquisition)
Check
(Check asset acquisition)
Post
(Post asset acquisition)
Business Object AssetPostCapitaliztn
(Asset Post-Capitalization)
Check
Business Object
AssetRetirement
(Asset Retirement)
Check
(Check asset retirement)
Post
(Post asset retirement)
Business Object BusProcStructureCO
(Business Process Structure CO)
Create
(Create fixed process structures for CO business processes)
Business Object
BusinessProcessCO
(Business process)
CreateMultiple
(Create one or more business processes)
GetDetail
(Detail information for business process on date)
GetList
(Determine list of business processes using selection criteria)
SetStructure
(Enter process template in business process master data)
Business Object ControllingArea
(Controlling area)
GetRelatedCompCodes
(Determine company codes assigned to one controlling area)
Business Object ControllingDocument
(Cost accounting document)
FindDetails
(Read CO documents: Manual Actual Postings)
Business Object CostActivityPlanning
(Overhead planning)
CheckActivityInput
(Check activity input)
CheckActivityOutput
(Check activity output: Quantities/prices)
PostActivityInput
(Post activity input)
PostActivityOutput
(Post activity output: Quantities/prices)
Business Object CostCenter
(Cost center)
GetActivityPrices
(Read prices for cost center/activity type)
GetActivityQuantities
(Read plan activity)
GetActivityTypes
(List of cost centers/activity types)
Business Object CostObject
(General Cost Object)
GetDetail
(Determine Details for a General Cost Object)
GetList
(Determine General Cost Objects for a Controlling Area)
Business Object CostObjectNode
(Cost Object Node)
GetDetail
(Determine Details for a Cost Object Node)
GetHierarchy
(Determine Cost Object Hierarchy)
GetList
(Determine Cost Object Node in a Controlling Area)
Business Object Customer
(Customer)
ChangeFromData1
(Change)
CreateFromData1
(Create)
GetContactList
(List of customer contact persons)
GetDetail1
(Provide details)
GetInternalNumber
(Provide internal custoemr number)
GetList (List of addresses)
Search1
(Search)
Business Object FinancialProduct
(Financial product (security class))
Change
(Change security)
CreateFromData
(Create security)
GetDetail
(Read security detailed data)
GetList
(Read security list)
Business Object FinancialTransaction
(Financial transaction)
Change
(Changing of transactions)
CreateFromData
(Transaction creation)
GetDetail
(Display of transactions)
GetList
(Transactions list)
Business Object FixedAsset
(Fixed asset)
Change
(Change asset)
CreateFromData
(Create asset)
GetList
(Information on selected assets)
Business Object GeneralLedger
(General ledger)
GetDocumentItems
(Determines document items in general ledger)
Business Object InternalOrder
(Internal order)
Create
(Create internal order from transferred data)
Business Object InvestmentProgram
Investment program)
SaveEntityReplicas
(Save assigned entities in summarization database)
SaveValueReplicas
(Save summarized values in summarization database)
Business Object ProfitCenterDocument
(Profit center document)
Delete
(Delete profit center documents)
Reverse
(Reversal of existing document line items)
SaveReplica
(Replicate PCA line items)
SaveReplicaPlanData
(Replicate profit center plan documents)
Business Object ResourceCO
(CO: Resource)
SaveReplica
(Replicate individual CO resources (ALE))
Business Object Vendor
(Vendor)
GetInternalNumber
(Supplies new internal vendor numbers)