Skip to content

API Usage Reference

simitben edited this page Apr 10, 2026 · 5 revisions

API Usage Reference

Purpose

This page is the index for third-party integrators using SimBiz 6 API V3.

Base URL

  • Production example: https://[xxx].simbiz.cloud/api/v3

Authentication

All protected endpoints require:

  • Authorization: Bearer <token>
  • x-uid: <uid>

Token endpoint:

  • POST /api/v3/token

Date-Time Format

For list filters such as updated_from and updated_to, use:

  • YYYY-MM-DD HH:MM:SS

API Usage Pages by Module/Topic

Page Scope
Postman Collection (Download) full API request set for import
Postman Environment (Download) variable template for host/uid/secret/token
API-Usage-Auth-System token and health
API-Usage-Business-Partner business partner master data
API-Usage-Sales sales documents
API-Usage-Purchase purchase documents
API-Usage-Inventory item and stock APIs
API-Usage-Customer-Service support tickets
API-Usage-Accounting accounting and reports

Common Conventions

Topic Standard
Pagination page, per_page
Updated range filter updated_from, updated_to
Organization filter by id organization_id / org_id
Organization filter by code organization_code / org_code
Detail endpoint behavior does not require updated range filters

Postman Import Quick Start

  1. Download:
    • ../postman/SimBiz6-API-V3.postman_collection.json
    • ../postman/SimBiz6-API-V3.postman_environment.json
  2. Import both files into Postman.
  3. Select environment SimBiz6 API V3 - Default.
  4. Set secret, then run Auth and System > Get Token.
  5. Continue testing module endpoints.

Clone this wiki locally