Journals v3

The Sitoo Journals API is used for reading backups of POS journals in Sitoo. It is recommended to read the Sitoo API introduction before reading this document.

API Base URL

The service is available at the base URL https://journals.sitooapis.com/v3. To access the API you combine the base URL and the endpoint URL. Example for getting journal entries for a specific cash register:

GET https://journals.sitooapis.com/v3/journal-entries?register_id={DBFA5E0C-0BB4-431C-9EB3-471F88AE222E}&num=1000

Authentication

Authentication is done with the HTTP basic authentication mechanism over a secure connection. The API ID and password can be found in the Backoffice under settings/Sitoo REST API (Requires administrator privileges).

Using the API ID and password, add an extra header to the request for authentication:

"Authorization: Basic " + base64_encode("{API ID}" + ":" + "{password}");

Example header (API ID "10020-140" and password "buNxoOx2o5kM2JMc3VhBX20k4Gik4qKXyKfg332A"):

Authorization: Basic MTAwMjAtMTQwOmJ1TnhvT3gybzVrTTJKTWMzVmhCWDIwazRHaWs0cUtYeUtmZzMzMkE=)

POS Journal

Each POS (cash register) in Sitoo stores a log of events that occurred during usage. This log is often referred to as the "journal". This service holds a backup of the journal for easy access.

Journal Entry Types

Each entry in the journal has one of the following types and the object in the data property for the JournalEntry will be different depending on the specific type. This is a list of the types and their respective objects.

• cart-clear The cart was cleared by the POS staff. Data of type JournalCart.
• cart-item-add A cart item was added by the POS staff. Data of type JournalCartItem.
• cart-item-change A cart item was changed by the POS staff. Data of type JournalCartItem.
• cart-item-remove A cart item was removed by the POS staff. Data of type JournalCartItem.
• cart-payment-add A cart payment was added by the POS staff. Data of type JournalCartPayment.
• cart-payment-retry A failed cart payment was retried by the POS staff. Data of type JournalCartPayment.
• cart-payment-cancel A cart payment was cancelled before completion. Data of type JournalCartPayment.
• cart-payment-success A cart payment was successfully completed. Data of type JournalCartPayment.
• cart-payment-remove A successful cart payment was removed by the POS staff. Data of type JournalCartPayment.
• cart-voucher-add The cart was given a discount(voucher) by the POS staff. Data of type JournalCart.
• cart-voucher-remove The cart had a discount(voucher) removed by the POS staff. Data of type JournalCart.
• cash-bank A banking cash transaction performed in the POS. Data of type JournalCash.
• cash-bank-final A final banking transaction performed at the closing of the POS. Data of type JournalCash.
• cash-counted The amount of cash counted at the closing of the POS. Data of type JournalCash.
• cash-petty A petty cash transaction performed in the POS. Data of type JournalCash.
• cash-start The amount of cash at the start when opening a POS. This entry also indicates the opening of the POS. Data of type JournalCash.
• ctu-error A POS control unit error that occurred. Data of type JournalCtuError.
• login A POS staff login. Data of type JournalStaff.
• logout A POS staff logout. Data of type JournalStaff.
• open-cash-drawer An extra opening of the cash drawer. Data of type JournalStaff.
• printout A printout was made by the POS staff. Data of type JournalPrintout
• receipt A receipt that has been committed in the POS. That includes both sales and returns. Data of type JournalReceipt.
• report-x An X-Report generated while register is still open. Data of type JournalXReport.
• report-z A Z-Report generated when closing the register. Data of type JournalZReport.