BSimple API Changelog
This page records public changes to the BSimple API reference. Check it before upgrading an integration or relying on a capability that is not listed in the developer documentation.
Current release — API v1
The current public API is served under /api/v1 and provides scoped REST/JSON access to selected BSimple data.
Current resource families include:
- Leads and customers.
- Inventory and suppliers.
- Locations, PAR and reorder recommendations.
- Stocktakes.
- Purchase orders and stock transfers.
- Invoices, including draft invoice creation.
The current public release does not provide webhooks, bulk operations, file attachments, payment processing, invoice approval or sending, invoice editing or deletion, stocktake-count writes, purchase-order writes, transfer writes or general stock adjustments.
9 September 2026 — public documentation release
- Published the BSimple API overview for business owners and integration teams.
- Published the endpoint, authentication, scope, pagination and error reference.
- Added getting-started guidance and server-side key-handling examples.
- Added guides for draft invoice creation, inventory and stock reads, customer portals, and polling/reconciliation.
- Clarified that invoice creation creates a draft/pre-draft invoice and does not approve, send or pay it.
- Corrected public curl examples to use separate, valid headers.
Compatibility guidance
Treat endpoint paths, scope names and response envelopes in the API reference as the public contract. Do not depend on undocumented fields, internal admin endpoints or HTML responses.
If an integration depends on a capability that is not documented, ask BSimple to confirm it before building production behavior. When a future release changes an endpoint, scope or response shape, this page will record the migration guidance.
Before you contact support
Include the endpoint, HTTP method, status code, safe error code, request timestamp and the integration environment. Never include the API key, full customer records or sensitive invoice data.
For setup help, start with Getting started. For custom integration requirements, contact BSimple.