Sign in

v1

latestOpenAPI 3.0.02026-08-068926279.2 KB
Invoices

List invoices

Returns a paginated list of invoices with filtering and statistics

get/invoices

Query parameters

yearstring
Example:2024

Filter by year (defaults to current year)

clientsinteger[]

Filter by client IDs

client_idinteger

Filter by a single client ID (returns all years)

projectsinteger[]

Filter by project IDs

statusesstring[]

Filter by statuses

searchstring

Search invoices

sort'document_id' | 'issue_date' | 'project_name' | 'client_name' | 'total' | 'amount_paid' | 'amount_outstanding' | 'invoice_status'

Sort field

direction'asc' | 'desc'

Sort direction

per_pageinteger

Items per page (max 100)

Response

Successful response

metaobject

Example response

{
  "data": [
    {
      "id": 1,
      "client_id": 1,
      "project_id": 1,
      "uuid": "550e8400-e29b-41d4-a716-446655440000",
      "document_id": "INV-001",
      "po_number": "PO-12345",
      "subject": "Website Development - January",
      "issue_date": "2024-01-15",
      "payment_due": 30,
      "due_date": "2024-02-15",
      "status": "sent",
      "total": 1500,
      "amount_due": 1500,
      "outstanding": 1500,
      "company_name": "Acme Corporation",
      "address": "123 Main St",
      "email": "billing@acme.com",
      "phone": "555-1234",
      "note": "Thank you for your business!",
      "online_payment": true,
      "automatically_send_payment_reminders": true
    }
  ]
}