Version History
This section describes changes made in subsequent releases and the new features in this API:
| Release | Enhancements | API Version |
|---|---|---|
| 2026.2 | To improve functionality, we have introduced a new parameter by extending the following endpoint: - GET /api/v1/reports/status/{exportId} The new parameter is: exportType (string) which represents additional information about the type of export to be performed. | v1 |
| 2024.2-SP5 | To enable a service-level health check, we introduced a new endpoint: - GET /api/v1/healthCheck. It allows the API client to check the status of the dependent backend services. On the 200 response, the client receives the overall status information: healthy, degraded, unhealthy. Request fields clientId and locationId are deprecated in the request contract for POST /api/v1/reports/repository/init from this release. extnernalClientId and externalLocationId will be used instead of deprecated one. | v1 |
| 2024.2-SP5 | To support users to check rebates in print form, POST /api/v1/printforms endpoint under Local Accounts was enhanced with additional attributes; transaction.rebate, transaction.items.rebate and total.rebate. | v1 |
| 2024.2 | To enhance the Local Account invoice processing, we extended the CPaaS Reports API: - the POST /api/v1/printforms endpoint was moved from CPaaS Configuration API to CPaaS Reports API - we also enhanced this endpoint with the following optional request fields: transactions.items.ItemId, transactions.attributes, taxes.TaxAmount, transactions.items.name, taxes.percent, transactions.items.taxAmount - the transactions.items.description request field was removed from the POST /api/v1/printforms endpoint. The introduced changes enable the POS system to include all necessary country-specific data in the regional print forms (PDFs). | v1 |