Cloud POS Data Export/Intelligence API
Welcome to the Cloud POS API documentation. By using the API you agreed to the Terms and Conditions outlined on the API homepage.
- Available through https://intelligence.citruslime.com/BI/
- You need to make a HTTPS call with an Authorization token in the bearer and specify the content type as application/json
- Where a FromDate & ToDate parameter is accepted, there is the option to pass both, or only one.
- Where timestamp filtering is available, adding a param "?timestamp=123456" to the request will filter by timestamp (RowVersion).
Note: This value is updated when a record is changed or inserted, meaning you can apply a filter to the endpoints to filter for any timestamp greater than the maximum on the records, to retrieve only edited/created records since your last request.
Account Types
| URL : |
intelligence.citruslime.com/BI/AccountType.aspx |
| Data : |
All data is returned. |
| DBTimeStamp : |
DBTimeStamp as string.
DBTimeStamp as long. |
| Timestamp Filtering : |
✔
intelligence.citruslime.com/BI/AccountType.aspx?timestamp=123456
|
Brand
| URL : |
intelligence.citruslime.com/BI/Brand.aspx |
| Data : |
All data is returned. |
| DBTimeStamp : |
DBTimeStamp as string.
DBTimeStamp as long. |
| Timestamp Filtering : |
✔
intelligence.citruslime.com/BI/Brand.aspx?timestamp=123456
|
Cashier
| URL : |
intelligence.citruslime.com/BI/Cashier.aspx |
| URL with parameters : |
intelligence.citruslime.com/BI/Cashier.aspx?FromDate=30/07/2018 15:00&ToDate=01/08/2018 00:01 |
| Data : |
All data is available between 4am and 6am GMT.
With a datetime parameter, this will return Cashiers updated between those date/times. |
| DBTimeStamp : |
DBTimeStamp as string.
DBTimeStamp as long. |
| Timestamp Filtering : |
✔
intelligence.citruslime.com/BI/Cashier.aspx?timestamp=123456
|
Category
| URL : |
intelligence.citruslime.com/BI/Category.aspx |
| Data : |
All data is returned. |
| DBTimeStamp : |
DBTimeStamp as string.
DBTimeStamp as long. |
| Timestamp Filtering : |
✔
intelligence.citruslime.com/BI/Category.aspx?timestamp=123456
|
Courier Booking
| URL : |
intelligence.citruslime.com/BI/CourierBooking.aspx?OrderID=1234 |
| Data : |
This takes an OrderID as a parameter in the URL and returns the individual courier booking for that order. Returns a 404 response if there is no record available. |
| DBTimeStamp : |
DBTimeStamp not available. |
| Timestamp Filtering : |
✘ |
Customer
| URL : |
intelligence.citruslime.com/BI/Customer.aspx |
| URL with parameters : |
intelligence.citruslime.com/BI/Customer.aspx?FromDate=30/07/2018 15:00&ToDate=01/08/2018 00:01 |
| Data : |
All data is available between 4am and 6am GMT.
With a datetime parameter, this will return Customers updated between those date/times. |
| DBTimeStamp : |
DBTimeStamp as string.
DBTimeStamp as long. |
| Timestamp Filtering : |
✔
intelligence.citruslime.com/BI/Customer.aspx?timestamp=123456
|
Department
| URL : |
intelligence.citruslime.com/BI/Department.aspx |
| Data : |
All data is returned. |
| DBTimeStamp : |
DBTimeStamp as string.
DBTimeStamp as long. |
| Timestamp Filtering : |
✔
intelligence.citruslime.com/BI/Department.aspx?timestamp=123456
|
Inventory
| URL : |
intelligence.citruslime.com/BI/Inventory.aspx |
| URL with parameters : |
intelligence.citruslime.com/BI/Inventory.aspx?FromDate=30/07/2018 15:00&ToDate=01/08/2018 00:01 |
| Data : |
All data is available between 4am and 6am GMT.
With a datetime parameter, this will return Inventory updated between those date/times. |
| DBTimeStamp : |
DBTimeStamp as string.
DBTimeStamp as long. |
| Timestamp Filtering : |
✔
intelligence.citruslime.com/BI/Inventory.aspx?timestamp=123456
|
Item
| URL : |
intelligence.citruslime.com/BI/Item.aspx |
| URL with parameters : |
intelligence.citruslime.com/BI/Item.aspx?FromDate=30/07/2018 15:00&ToDate=01/08/2018 00:01 |
| Data : |
All data is available between 4am and 6am GMT.
With a datetime parameter, this will return Items updated between those date/times. |
| DBTimeStamp : |
DBTimeStamp as string.
DBTimeStamp as long. |
| Timestamp Filtering : |
✔
intelligence.citruslime.com/BI/Item.aspx?timestamp=123456
|
ItemMovementLog
| URL : |
intelligence.citruslime.com/BI/ItemMovementLog.aspx |
| URL with parameters : |
intelligence.citruslime.com/BI/ItemMovementLog.aspx?FromDate=30/07/2018 15:00&ToDate=01/08/2018 00:01 |
| Data : |
All data is available between 4am and 6am GMT.
With a datetime parameter, this will return Item Movement Logs posted between those date/times. |
| DBTimeStamp : |
DBTimeStamp not available |
| Timestamp Filtering : |
✘ |
Orders
| URL : |
intelligence.citruslime.com/BI/Order.aspx |
| URL with parameters : |
intelligence.citruslime.com/BI/Order.aspx?FromDate=30/07/2018 15:00&ToDate=01/08/2018 00:01 |
| Data : |
All data is available between 4am and 6am GMT.
With a datetime parameter, this will return Orders created between those date/times. |
| DBTimeStamp : |
DBTimeStamp as string.
DBTimeStamp as long. |
| Timestamp Filtering : |
✔
intelligence.citruslime.com/BI/Order.aspx?timestamp=123456
|
Order Entries
| URL : |
intelligence.citruslime.com/BI/OrderEntry.aspx?OrderID=1234 |
| Data : |
This takes an OrderID as a parameter in the URL and returns a list of Order Entries for that order. |
| DBTimeStamp : |
DBTimeStamp as string.
DBTimeStamp as long. |
| Timestamp Filtering : |
✔
intelligence.citruslime.com/BI/OrderEntry.aspx?timestamp=123456
|
Purchase Orders
| URL : |
intelligence.citruslime.com/BI/PurchaseOrder.aspx |
| URL with parameters : |
intelligence.citruslime.com/BI/PurchaseOrder.aspx?FromDate=30/07/2018 15:00&ToDate=01/08/2018 00:01 |
| Data : |
All data is available between 4am and 6am GMT.
With a datetime parameter, this will return Purchase Orders created between those date/times. |
| DBTimeStamp : |
DBTimeStamp as string.
DBTimeStamp as long. |
| Timestamp Filtering : |
✔
intelligence.citruslime.com/BI/PurchaseOrder.aspx?timestamp=123456
|
Purchase Order Entries
| URL : |
intelligence.citruslime.com/BI/PurchaseOrderEntry.aspx?PurchaseOrderID=1234 |
| Data : |
This takes an PurchaseOrderID as a parameter in the URL and returns a list of Purchase Order Entries for that purchase order. |
| DBTimeStamp : |
DBTimeStamp as string.
DBTimeStamp as long. |
| Timestamp Filtering : |
✔
intelligence.citruslime.com/BI/PurchaseOrderEntry.aspx?timestamp=123456
|
Reason Codes
| URL : |
intelligence.citruslime.com/BI/ReasonCode.aspx |
| Data : |
All data is returned. |
| DBTimeStamp : |
DBTimeStamp as string.
DBTimeStamp as long. |
| Timestamp Filtering : |
✔
intelligence.citruslime.com/BI/ReasonCode.aspx?timestamp=123456
|
Register
| URL : |
intelligence.citruslime.com/BI/Register.aspx |
| Data : |
All data is returned. |
| DBTimeStamp : |
DBTimeStamp as string.
DBTimeStamp as long. |
| Timestamp Filtering : |
✔
intelligence.citruslime.com/BI/Register.aspx?timestamp=123456
|
SalesRep
| URL : |
intelligence.citruslime.com/BI/SalesRep.aspx |
| URL with parameters : |
intelligence.citruslime.com/BI/SalesRep.aspx?FromDate=30/07/2018 15:00&ToDate=01/08/2018 00:01 |
| Data : |
All data is available between 4am and 6am GMT.
With a datetime parameter, this will return Sales Reps updated between those date/times. |
| DBTimeStamp : |
DBTimeStamp as string.
DBTimeStamp as long. |
| Timestamp Filtering : |
✔
intelligence.citruslime.com/BI/SalesRep.aspx?timestamp=123456
|
Season
| URL : |
intelligence.citruslime.com/BI/Season.aspx |
| Data : |
All data is returned. |
| DBTimeStamp : |
DBTimeStamp as string.
DBTimeStamp as long. |
| Timestamp Filtering : |
✔
intelligence.citruslime.com/BI/Season.aspx?timestamp=123456
|
Store
| URL : |
intelligence.citruslime.com/BI/Store.aspx |
| Data : |
All data is returned. |
| DBTimeStamp : |
DBTimeStamp as string.
DBTimeStamp as long. |
| Timestamp Filtering : |
✔
intelligence.citruslime.com/BI/Store.aspx?timestamp=123456
|
Supplier
| URL : |
intelligence.citruslime.com/BI/Supplier.aspx |
| URL with parameters : |
intelligence.citruslime.com/BI/Supplier.aspx?FromDate=30/07/2018 15:00&ToDate=01/08/2018 00:01 |
| Data : |
All data is available between 4am and 6am GMT.
With a datetime parameter, this will return Suppliers updated between those date/times. |
| DBTimeStamp : |
DBTimeStamp as string.
DBTimeStamp as long. |
| Timestamp Filtering : |
✔
intelligence.citruslime.com/BI/Supplier.aspx?timestamp=123456
|
Tax
| URL : |
intelligence.citruslime.com/BI/Tax.aspx |
| Data : |
All data is returned. |
| DBTimeStamp : |
DBTimeStamp as string.
DBTimeStamp as long. |
| Timestamp Filtering : |
✔
intelligence.citruslime.com/BI/Tax.aspx?timestamp=123456
|
Tender
| URL : |
intelligence.citruslime.com/BI/Tender.aspx |
| Data : |
All data is returned. |
| DBTimeStamp : |
DBTimeStamp as string.
DBTimeStamp as long. |
| Timestamp Filtering : |
✔
intelligence.citruslime.com/BI/Tender.aspx?timestamp=123456
|
TaxEntry
| URL : |
intelligence.citruslime.com/BI/TaxEntry.aspx |
| URL with parameters : |
intelligence.citruslime.com/BI/TaxEntry.aspx?FromDate=30/07/2018 15:00&ToDate=01/08/2018 00:01 |
| Data : |
All data is available between 4am and 6am GMT.
With a datetime parameter, this will return Tax Entries posted between those date/times. |
| DBTimeStamp : |
DBTimeStamp as string.
DBTimeStamp as long. |
| Timestamp Filtering : |
✔
intelligence.citruslime.com/BI/TaxEntry.aspx?timestamp=123456
|
TenderEntry
| URL : |
intelligence.citruslime.com/BI/TenderEntry.aspx |
| URL with parameters : |
intelligence.citruslime.com/BI/TenderEntry.aspx?FromDate=30/07/2018 15:00&ToDate=01/08/2018 00:01 |
| Data : |
All data is available between 4am and 6am GMT.
With a datetime parameter, this will return Tender Entries posted between those date/times. |
| DBTimeStamp : |
DBTimeStamp as string.
DBTimeStamp as long. |
| Timestamp Filtering : |
✔
intelligence.citruslime.com/BI/TenderEntry.aspx?timestamp=123456
|
Transaction
| URL : |
intelligence.citruslime.com/BI/Transaction.aspx |
| URL with parameters : |
intelligence.citruslime.com/BI/Transaction.aspx?FromDate=30/07/2018 15:00&ToDate=01/08/2018 00:01 |
| Data : |
All data is available between 4am and 6am GMT.
With a datetime parameter, this will return Transactions posted between those date/times. |
| DBTimeStamp : |
DBTimeStamp as string.
DBTimeStamp as long. |
| Timestamp Filtering : |
✔
intelligence.citruslime.com/BI/Transaction.aspx?timestamp=123456
|
TransactionEntry
| URL : |
intelligence.citruslime.com/BI/TransactionEntry.aspx |
| URL with parameters : |
intelligence.citruslime.com/BI/TransactionEntry.aspx?FromDate=30/07/2018 15:00&ToDate=01/08/2018 00:01 |
| Data : |
All data is available between 4am and 6am GMT.
With a datetime parameter, this will return Transaction Entries posted between those date/times. |
| DBTimeStamp : |
DBTimeStamp as string.
DBTimeStamp as long. |
| Timestamp Filtering : |
✔
intelligence.citruslime.com/BI/TransactionEntry.aspx?timestamp=123456
|