HEhellobonsai
Invoices

List invoices

Lists your invoices, newest first, a page at a time. Each one arrives with its line items.

Filtering

  • filter[invoice_number] — one or more invoice numbers. This is how you turn a number your client quoted you into an invoice id.
  • filter[project_id] — one or more project ids.
  • filter[company_id] — one or more client company ids.
get/public-api/v1/invoices

Request

  • Base URL
    https://app.hellobonsai.com
  • URL
    https://app.hellobonsai.com/public-api/v1/invoices
  • Auth
    • OAuth 2
      Authorization code: https://app.hellobonsai.com/oauth/authorize
      Token URL: https://app.hellobonsai.com/oauth/token
    • or HTTP bearer

Query parameters

page[number]integer

Page to return, starting at 1.

page[size]integer

Records per page. Defaults to 25; anything above 100 is reduced to 100.

filter[invoice_number]string

One or more exact invoice numbers, comma-separated or repeated.

filter[project_id]string

One or more project ids, comma-separated or repeated.

filter[company_id]string

One or more client company ids, comma-separated or repeated. Find them with GET /public-api/v1/companies.

Response

A page of invoices, newest first, each with its line items.

Example response

{
  "data": [
    {
      "id": 3310,
      "invoice_number": "INV-001",
      "title": "Acme Corp Invoice",
      "currency": "USD",
      "issued_date": "2026-04-14",
      "due_date": "2026-04-28",
      "sent_date": "2026-04-14T09:12:04.000Z",
      "project_id": 51,
      "client_email": "alex@example.com",
      "public_url_token": "x7f2a9c4b1e8d",
      "created_at": "2026-04-14T09:12:04.000Z",
      "total_amount": "200.0",
      "discount_amount": "25.0",
      "status": "outstanding",
      "due_date_option": "custom",
      "company_id": 42,
      "client_name": "Acme Corp",
      "subtotal": "200.0",
      "tax_amount": "0.0",
      "kind": "recurring",
      "repeat_interval": "monthly",
      "repeat_finish_date": "2027-04-14",
      "series_id": 3310,
      "recurrence_active": true,
      "url": "https://app.hellobonsai.com/invoices/3391",
      "invoice_items": [
        {
          "id": 4471,
          "name": "Design",
          "description": "Homepage and pricing page",
          "amount": "2.0",
          "rate": "100.0",
          "unit_type": "per_hour",
          "total": "200.0"
        }
      ]
    }
  ],
  "meta": {
    "request_id": "b1f0d2c4-7a9e-4c3b-8d5f-1e2a3b4c5d6e",
    "pagination": {
      "page": 1,
      "page_size": 25,
      "has_more": true
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.