Invoices API

Invoices come out of AlgaPSA billing runs, or you write them by hand. Use this API to read invoices, generate them from recurring templates, record payments and credits, and move each one through approve, finalize, and send.

The lifecycle

An invoice goes from draft to approved to finalized, then out to the client. Each step is its own call: POST /invoices/{id}/approve, then /finalize, then /send. Gate any of them behind your own checks. Once an invoice is finalized, record money against it with /payment and /credit.

Recurring and manual

Most invoices come from recurring templates. Manage those under /invoices/recurring, check the next run with POST /invoices/preview, then commit it with POST /invoices/generate. For a one-off, POST /invoices/manual writes a single invoice directly.

Read and export

GET /invoices lists and filters; /invoices/search runs a text query; /invoices/analytics and /invoices/export feed reporting. Line items and ledger entries sit under {id}/items and {id}/transactions.

PDF download

GET /invoices/{id}/pdf and POST /invoices/{id}/pdf both stream the rendered invoice as an application/pdf binary with a Content-Disposition: attachment header. Both methods return the same binary response. The caller must hold the invoice:read permission.

Endpoints

Every endpoint links through to its full parameters, request and response schemas, and code samples.