Please refer to the below for API version 1 (ie v1).
 Customers (GET)
Returns Customer data.
Collection
|
/v1/customers
|
Singleton
|
/v1/customers/XXXXXX
Where XXXXXX is the BBS customer code for a customer record
|
Collection Specific Parameters
Parameter
|
Description
|
Type
|
Default if Omitted
|
includeprospects
|
Include prospect accounts in response
|
Boolean (true / false)
|
false
|
includeclosed
|
Include closed accounts in response
|
Boolean (true / false)
|
false
|
search
|
Keywords to search for to filter results (case insensitive, separated by spaces)
|
String
|
No search filter is applied to results
|
Examples
Returns a list of customers, including prospective customers, in the Standard format.
https://abctra.users.bbserp.com.au:9001/api/v1/customers?includeprospects=true
|
Returns a list of customers, including prospective customers, where both the words LIME and LEMON appear in the customer record, in the detail format.
https://abctra.users.bbserp.com.au:9001/api/v1/customers?includeprospects=true&search=Lime Lemon&format=detail
|
Returns the detail for customer LIM001, in the expanded format.
https://abctra.users.bbserp.com.au:9001/api/v1/customers/LIM001?format=expanded
|
|
Products (GET)
Returns Product data.
Collection
|
/v1/products
|
Singleton
|
/v1/products/XXXXXXXXXXXX
Where XXXXXXXXXXXX is the BBS product code, Manf Part No, SKU, APN/barcode, supplier item code, additional product code, selling unit of measure, barcode or any other product code from the product record.
NOTE: If multiple products have the same code, a HTTP error 404 Not Found will be returned.
|
Collection Specific Parameters
Parameter
|
Description
|
Type
|
Default if Omitted
|
includediscontinued
|
Include discontinued products in response
|
Boolean (true / false)
|
false
|
search
|
Keywords to search for to filter results (case insensitive, separated by spaces)
|
String
|
No search filter is applied to results
|
Examples
Returns a list of products, including discontinued products, in the Standard format.
https://abctra.users.bbserp.com.au:9001/api/v1/products?includediscontinued=true
|
Returns a list of products, including discontinued products, where both the words STAINLESS and BOWL appear in the product record, in the detail format.
https://abctra.users.bbserp.com.au:9001/api/v1/products?includediscontinued=true&search=Stainless Bowl&format=detail
|
Returns the detail for product with a product code of FGES185, in the expanded format.
https://abctra.users.bbserp.com.au:9001/api/v1/products/FGES185?format=expanded
|
|
Stock Levels (GET)
Returns Stock Level data for products. Discontinued products are only returned in the data if there is stock available.
Collection
|
/v1/stocklevels
|
Singleton
|
/v1/stocklevels/XXXXXXXXXXXX
Where XXXXXXXXXXXX is the BBS product code, Manf Part No, SKU, APN/barcode, supplier item code, additional product code, selling unit of measure, barcode or any other product code on the product record.
NOTE: If multiple products have the same code, a HTTP error 404 Not Found will be returned.
|
Collection Specific Parameters
Parameter
|
Description
|
Type
|
Default if Omitted
|
search
|
Keywords to search for to filter results (case insensitive, separated by spaces)
|
String
|
No search filter is applied to results
|
Examples
Returns a list of stock levels for non-discontinued products, in the Standard format.
https://abctra.users.bbserp.com.au:9001/api/v1/stocklevels
|
Returns a list of stock levels for non-discontinued products, where both the words STAINLESS and BOWL appear in the product record, in the detail format.
https://abctra.users.bbserp.com.au:9001/api/v1/stocklevels?Stainless Bowl&format=detail
|
Returns the stock levels for product with a product code of FGES185, in the expanded format.
https://abctra.users.bbserp.com.au:9001/api/v1/stocklevels/FGES185?format=expanded
|
|
Sales Orders/Quotes (GET)
Returns Sales Order/Quote data
Collection
|
/v1/salesorders
|
Singleton
|
/v1/salesorders/XXXXXX
Where XXXXXX is the BBS sales order or quote number.
|
Collection Specific Parameters
Parameter
|
Description
|
Type
|
Default if Omitted
|
includeopen
|
Includes sales orders that are outstanding
|
Boolean (true / false)
|
true
|
includeinvoiced
|
Includes sales orders that are fully invoiced, and sales order lines that are fully invoiced
|
Boolean (true / false)
|
false
|
includequotes
|
Includes sales quotes
|
Boolean (true / false)
|
false
|
includecancelled
|
Includes sales orders and quotes that have been cancelled
|
Boolean (true / false)
|
false
|
orderdatefrom
|
Includes sales orders/quotes raised on or after this date
|
Date (YYYY-MM-DD)
|
First Order/Quote
|
orderdateto
|
Includes sales orders/quotes raised on or before this date
|
Date (YYYY-MM-DD)
|
Last Order/Quote
|
Examples
Returns a list of the first 1000 sales orders for the month of May 2025, regardless of whether they are invoiced or not, in the Standard format.
https://abctra.users.bbserp.com.au:9001/api/v1/salesorders/?includeopen=true&includequotes=false&includeinvoiced=true&includecancelled=false&OrderDateFrom=2025-05-01&OrderDateTo=2025-05-31&limit=1000&offset=0
|
Returns a list of the first 1000 outstanding sales orders, in the detail format.
https://abctra.users.bbserp.com.au:9001/api/v1/salesorders/?includeopen=true&includequotes=false&includeinvoiced=false&includecancelled=false&limit=1000&offset=0&format=detail
|
Returns the detail for single sales order number 000013, in the expanded format.
https://abctra.users.bbserp.com.au:9001/api/v1/salesorders/000013?format=expanded
|
|
Sales Invoices (GET)
Returns Sales Invoice data
Collection
|
/v1/salesinvoices
|
Singleton
|
/v1/salesinvoices/XXXXXX
Where XXXXXX is the BBS sales invoice or credit note number.
|
Collection Specific Parameters
Parameter
|
Description
|
Type
|
Default if Omitted
|
includeupdated
|
Includes updated sales invoices and credits
|
Boolean (true / false)
|
true
|
includeunupdated
|
Includes unupdated sales invoices and credits
|
Boolean (true / false)
|
false
|
includesaexcluded
|
Includes sales invoices and credits that have been flagged to be excluded from sales analysis
|
Boolean (true / false)
|
false
|
invdatefrom
|
Includes sales invoices/credits raised on or after this date
|
Date (YYYY-MM-DD)
|
First Invoice
|
invdateto
|
Includes sales invoices/credits raised on or before this date
|
Date (YYYY-MM-DD)
|
Last Invoice
|
Examples
Returns a list of the first 1000 sales updated invoices/credits for the month of May 2025, unless they have been excluded from sales analysis, in the standard format.
https://abctra.users.bbserp.com.au:9001/api/v1/salesinvoices/?includeupdated=true&includeunupdated=false&includesaexcluded=false&InvDateFrom=2025-05-01&InvDateTo=2025-05-31&limit=1000&offset=0
|
Returns a list of the first 1000 unupdated invoices, unless they have been excluded from sales analysis, in the standard format. in the detail format.
https://abctra.users.bbserp.com.au:9001/api/v1/salesinvoices/?includeupdated=false&includeunupdated=true&includesaexcluded=false&limit=1000&offset=0
|
Returns the detail for single sales invoice number 502123, in the expanded format.
https://abctra.users.bbserp.com.au:9001/api/v1/salesinvoices/502123?format=expanded
|
|
|
API Version 1 - Direct Database Table Access