Overview

CPaaS Invoice API supports different operations and validations on invoices. This includes issuing invoices and batch issue documents, generating invoice number, controlling numbering of invoices, validating data received from the client, creating PDF files, storing documents, and communication with CTR (Central Transaction Repository).

Features

The CPaaS Invoice API enables POS to do the following operations:

• Issue invoices (POST/documents). (Note: POST /invoices endpoint is deprecated as of Release 2023.2)
• Generate a PDF file of the invoice (GET /documents/{id}/pdf). (Note: GET /invoices/{id}/pdf endpoint is deprecated as of Release 2023.2)
• Fetch the status of the document (GET /jobs/{id}/status).
• Check the status of the dependent backend services (GET /healthCheck).
• Issue documents in batch (POST /documents/batch)
• Retrieve valid complete invoice documents that can be included to recapitulative invoice (POST /documents/complete/available)
• Retrieve valid simple invoice documents that can be included to recapitulative invoice (POST /documents/simple/available)
• Retrieve a list of previously issued recapitulative invoices (POST /documents/batch/previous)

NOTES:

• The CPaaS API only supports certain regions. For configuration details please refer to the CPaaS Documentation Suite.

• The following endpoints:

  • POST /invoices,
  • POST /invoices/{id}/amend,
  • GET /invoices/{id}/pdf,
  • POST /invoices/{id}/duplicate,
  • POST /invoices /{id}/void

are deprecated as of Release 2023.2. The deprecated API versions have been superseded by a newer API version: POST /documents and GET /documents/{id}/pdf. For backward compatibility, the deprecated endpoints remain functional until further notice (max. 12 months), but we recommend that you use the new option instead.

Security

The CPaaS Invoice API supports OAuth 2.0 for authentication purposes.
The supported protocol for the CPaaS Invoice API is HTTPS.