GET/api/v1/financial/invoices

Product availabilityAlgaPSA

List invoices

Returns a paginated list of invoices for the tenant. Maps to ApiFinancialController.listInvoices() → FinancialService.listInvoices(), filtered and sorted by the supplied query parameters. Each item carries the invoice record (including client_name) plus HATEOAS links.

RBAC · financial

Query parameters

pagestringOptional

limitstringOptional

sortstringOptional

Sort field. One of created_at, updated_at, invoice_number, invoice_date, due_date, total_amount, status (defaults to created_at).

orderstringOptional

searchstringOptional

Matches invoice_number or client name.

created_fromstringOptional

created_tostringOptional

updated_fromstringOptional

updated_tostringOptional

is_activestringOptional

client_idstring <uuid>Optional

statusstringOptional

billing_cycle_idstring <uuid>Optional

due_date_fromstringOptional

due_date_tostringOptional

amount_minstringOptional

amount_maxstringOptional

is_manualstringOptional

has_credit_appliedstringOptional

Response body

Success response 200 · schema FinancialInvoiceApiPaginated

dataarray of objectRequired

itemsobject

paginationobjectRequired

pageintegerRequired

limitintegerRequired

totalintegerRequired

totalPagesintegerRequired

hasNextbooleanRequired

hasPrevbooleanRequired

metaobject

Response codes

200

Paginated invoice list returned.

400

Invalid query parameters.

401

API key missing/invalid.

403

financial:read permission denied.

500

Unexpected listing failure.

GET /api/v1/financial/invoices

cURL

curl -X GET "https://algapsa.com/api/v1/financial/invoices?page=string&limit=string&sort=string&order=asc&search=string&created_from=string" \
  -H "X-API-Key: $ALGA_API_KEY"

TypeScript

const response = await fetch("https://algapsa.com/api/v1/financial/invoices?page=string&limit=string&sort=string&order=asc&search=string&created_from=string", {
  method: "GET",
  headers: {
    "X-API-Key": "$ALGA_API_KEY",
  }
});
const data = await response.json();

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Get, "https://algapsa.com/api/v1/financial/invoices?page=string&limit=string&sort=string&order=asc&search=string&created_from=string");
request.Headers.TryAddWithoutValidation("X-API-Key", "$ALGA_API_KEY");
var response = await client.SendAsync(request);
var body = await response.Content.ReadAsStringAsync();

200 OK·application/json

{
  "data": [
    {}
  ],
  "pagination": {
    "page": 1,
    "limit": 1,
    "total": 1,
    "totalPages": 1,
    "hasNext": false,
    "hasPrev": false
  },
  "meta": {}
}