CStoreOffice® Support & Learning

Getting Started with Business Documents API

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.
  • Start calling the API with one of the above endpoints.

  • /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.

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
Products Hierarchy Catalogue (Taxonomy)

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
Cycle Count Physical Inventory inventory-item
Itemized Inventory report-exported
POS Journal Reports (TLogs) pos-journal-report
Shift Reports
Store Purchases (Invoice) invoice
General Journal general-journal-report
Lottery Purchases (Invoice) lottery-purchase
Lottery Sales lottery-sale

Before You Begin

Before you start using the Business Documents API, you need:

  1. Get the API authorization token.
  2. Prepare the input parameters for API request.
    This step is required only if you call the API at the business unit level.