Help Center
This help will guide you through the setup and usage of our point of sale cash register software.
Search by keyword in the help section:
🔗 Webhook (HTTP notifications)
Webhooks can be defined on the Configuration > General Options page, in the 'Interface Options' section.
Order registration notification
The webhook URL will be called automatically for each validated or completed order.
Parameters transmitted:
- type: validated or terminated
- orderID: accounting order number
- orderInternalID: internal identifier of the order
- creationDate: date the order was created
- validationDate: date of order validation
- valueDate: order value date
- price: total amount
- clientID: client identifier
- customer: customer data
- cashBoxID: cash register identifier
- deliveryMethod: delivery method
- PDFinvoice: link to the PDF invoice
- items: list of items in JSON format
- VATs: list of VAT rates and amounts
- VAT: total VAT amount
- isRefund: true/false if refund
- signatureVerificationURL: URL used to verify the webhook signature
📡 The webhook is called twice per command: once upon validation, once upon termination.
Cash register closure notification
The webhook URL will be called automatically each time the checkout is closed.
Parameters transmitted:
- type: cashBox_close or cashBox_open
- Total: total amount received during the period
- opened: date the cash register was opened
- closed: date the cash register was closed
- signatureVerificationURL: URL used to verify the webhook signature
📡 CashBox_open type notifications do not contain any other parameters and are only intended to transmit the change of state.
This document is made available under the terms of the licence Creative Commons Attribution 4.0 International (CC BY 4.0) .