API reference
The billing account, invoices and their payment.
GET/v1/billing/account
the tenant's billing plan (current effective version and prices) and availability of payment through the provider. No plan - configured=false; prices are never shown as a fact without a tariff.
200BillingAccountView400401403404409412413415422428429503GET/v1/billing/invoices
| Field | Type | Required |
|---|---|---|
cursorquery | string | no |
limitquery | integer | no |
statusquery | enum: issued, partially_paid, paid, overdue, cancelled | no |
200InvoiceList400401403404409412413415422428429503GET/v1/billing/invoices/{invoice_id}
| Field | Type | Required |
|---|---|---|
invoice_idpath | string (uuid) | yes |
200Invoice400401403404409412413415422428429503POST/v1/billing/invoices/{invoice_id}/document
signed short-lived URL of the invoice PDF (same generator as reports). 409 bad_state while the document is being generated.
| Field | Type | Required |
|---|---|---|
invoice_idpath | string (uuid) | yes |
200Download400401403404409412413415422428429503POST/v1/billing/invoices/{invoice_id}/payments
starts or resumes the online payment of the amount due through the payment provider (NerezPay). One active online payment per invoice: a repeated call returns the active payment and its URL. Disabled online payment - 503 capability_disabled with the reason.
| Field | Type | Required |
|---|---|---|
invoice_idpath | string (uuid) | yes |
201InvoicePaymentStart400401403404409412413415422428429503