The BSimple API is a REST and JSON interface for authorised external applications. It lets your own software read and manage selected BSimple leads, customers, inventory, operational records and invoices without exposing the rest of your account.
Who uses the BSimple API?
- Customer portals that need current stock, customer details or invoice information.
- External ordering sites that need to send customer or order information into BSimple.
- CRM and lead workflows that create, update or organise leads and customers.
- Internal dashboards that read locations, reorder recommendations, purchase orders or stocktake progress.
- Developers and integration teams replacing manual re-keying between systems.
What can the API do?
Leads and customers
Read, create, edit and archive leads and customers. Lead and customer tags can also be managed through the appropriate write scopes.
Inventory and suppliers
Search inventory by code, name or description, read item details and quantities, add inventory items, and read supplier records.
Locations and operational data
Read inventory locations, PAR targets, reorder recommendations, stocktakes, purchase orders and stock transfers. These operational resources are currently read-only through the public API.
The inventory and stock guide explains how these resources fit together.
Draft invoices
Create a draft invoice using inventory-backed lines, free-form service lines, or a mixture of both. BSimple validates the customer and item codes and applies configured pricing and GST rules. See the create a draft invoice guide.
Scoped access by design
Each API key is granted only the scopes required by its integration. A key belongs to one BSimple account and cannot access another account's data. The key secret is displayed once when created and stored as a SHA-256 hash.
Create separate keys for separate integrations, grant the smallest useful scope set, and revoke a key if it is no longer required. The getting-started guide covers the setup sequence.
Current boundaries
The current public API 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. These boundaries are part of the current API contract and may change through the API changelog.
Explore the reference
Use the developer documentation for authentication, scopes, response envelopes, pagination, filters, errors and the complete endpoint list. If you are designing a portal or external ordering workflow, read the guide to customer portal integrations.