Business Documents API uses the HTTP GET request methods and currently includes the following endpoints:
- Level selection endpoints:
/account-level-resources: Used for receiving the list of available resources at the account level./business-unit-level-resources: Used for receiving the list of available resources at the business unit level./business-documents: Used for receiving the list of available documents at the selected level./business-document: Used for receiving a certain document at the selected level.
Start calling the API with one of the above endpoints.
To learn more about calling the API, see Calling the Business Documents API.
Exported XML Files
The complete list of the XML files exported via API is presented in the sections below.
XML Files Exported at the Account Level
To export XML files at the account level, start calling the API from the /account-level-resources endpoint.
| Exported XML File | AP Document type identifier |
| Item Catalogue | price-book-item |
| Categories | categories |
| Departments | departments |
| Price Groups | price-groups |
| Promo Groups | promo-groups |
| Item Tags | item-tags |
XML Files Exported at the Business Unit Level
To export XML files at the business unit level, start calling the API from the /business-unit-level-resourcesendpoint.
| Exported XML File | API Document type identifier |
| Cost of Goods Sold | cost-of-goods-sold |
| Itemized Inventory | inventory-item |
| POS Journal Reports (TLogs) | pos-journal-report |
| Fuel Grade Movement (FGM) Report | shift_fuel-grade-movement |
| Item Sales Movement (ISM) Report | shift_item-sales-movement |
| Merchandise Code Movement (MCM) Report | shift_merchandise-code-movement |
| Miscellaneous Summary Movement (MSM) Report | shift_miscellaneous-summary-movement |
| Store Purchases (Invoice) | invoice |
| General Journal Conexxus Data Mapping | general-journal-report |
Before You Begin
Before you start using the Business Documents API, you need:
- Get the API authorization token.
- Prepare the input parameters for API request.
This step is required only if you call the API at the business unit level.
Consumer Integration
The Business Documents API represents the optimal way for consumer integration, while you can use other integration options, if required. For more information, see Consumer Integration.
