Version: 0.1.0

ProAbono API Backoffice

The API Backoffice is the server-to-server interface to ProAbono. It exposes the catalogue (offers, features, pricing tables), the distribution side (customers), the subscription lifecycle, and the resulting finance records (invoices, invoice lines, payments, balance lines).

Conventions that apply to every endpoint:

• Authentication — HTTP Basic, using the agent key as the user name and the API key as the password. Both keys are available in the ProAbono backoffice, Integration section.
• Content type — application/json for every request and response.
• Field naming — PascalCase. Identifiers shared with your own system are prefixed with Reference (ReferenceCustomer, ReferenceOffer); the internal identifiers assigned by ProAbono are Id and Id<Resource>.
• Amounts — integers, in the smallest unit of the currency (cents).
• Rates — integers, in basis points: 2000 means 20%.
• Dates — ISO 8601 strings, for example 2025-01-31T00:00:00Z.
• Pagination — 1-based, through page and sizePage. sizePage=0 returns the total count only, without fetching any item.

Authentication

HTTP: Basic Auth

HTTP Basic authentication. The user name is the agent key and the password is the API key; both are available in the ProAbono backoffice, Integration section.

Security Scheme Type:	http
HTTP Authorization Scheme:	basic