The Shireburn Business Suite (SBS) API enables you to interact with SBS systems. You will need an API key which should be passed as a query string with each of the requests below.
Upon installation of the API, we always provide a test company that can be used for testing. When calling any API call, provide the relative test company key in the 'companyKey' query string. Contact Shireburn support or your client to get the company keys.
Currently, we do not support pagination, however we do have the 'GetStockDetailByReplicationId' call. If you have a problem of large stock data, i.e. GetStockDetail call takes too much time or causes a timeout issue, you can:
This call will only return the latest changes in the stock and not all the stock, so you can always sync the stock items in your database with SIMS.
A Sales Order is a committing of a stock quantity to a particular client. When a
sales order is posted succesfully, this can be viewed in the Sales Orders screen in SIMS and can be processed further for invoicing where the stock
quantity is then reduced.
A Transaction is a committed sale by the client where the payment has been
processed succesfully. This call can be used if you have a payment gateway implemented on your website where clients are paying directly for the products.
Example 1: One unit to be sold
Quantity: 1
Unit Price: €10.00 including VAT
Discount: 10%
Header
Total Value (net discount): €9.00
Total VAT: €1.62
Discount Amount (including VAT): €1.00
Lines
Quantity: 1
Unit Price (exclusive of VAT and is not discounted): 10 / 1.18 = 8.474
VAT Amount: (10 - 1 = 9 * 18%) = 1.62
Discount: (can be left blank)
Discount Amount (including VAT): 10 * 10% = €1
Example 2: Three units to be sold
Quantity: 3
Unit Price: €10 including VAT
Discount: 10%
Header
Total Value (net discount): €27
Total VAT: €4.86
Discount Amount (including VAT): €3
Lines
Quantity: 3
Unit Price (exclusive of VAT and is not discounted): 10 * (1/1.18) = 8.474
VAT Amount: 30 - 3 = 27 * 18% = 4.86
Discount: (can be left blank)
Discount Amount (including VAT): 30 * 10% = €3
Example 1: One unit to be sold
Quantity: 1
Unit Price: €10.00 including VAT
Discount: 10%
Final Price: €10.00 - 10% discount (€1) = €9.00
Example 2: Three units to be sold
Quantity: 3
Unit Price: €10 including VAT
Discount: 10%
Final Price: (€10 * 3) = €30.00 - 10% discount (€3) = €27.00
Generally, this error means that the server where the API is hosted is down. This can be due to a password change done on the server by the server administrators. You can contact your client to check with their IT server administrators. If the issue persists, contact Shireburn's Technical Support team to investigate the issue further.
If you have a large number of stock items, please refer to the Pagination section in the FAQ.
'{' and '}' are forbidden characters when posting calls. Make sure there are none of these in, for example, the stock descriptions.