Sign in
Invoices

List invoices

Get a paginated list of invoices with optional filtering

get/invoices

Query parameters

limitinteger

Number of items to return

afterstring

Specifies the cursor after which to start returning results. For the first page, this should be left empty. For subsequent pages, use the value of the end_cursor field from the previous response.

beforestring

Specifies the cursor before which to return results. Use this to paginate backwards. For example, to load the previous page, provide the value of the start_cursor field from the last response.

created_at_startstring

Filter by creation date start (RFC3339 format)

created_at_endstring

Filter by creation date end (RFC3339 format)

due_date_startstring

Filter by due date start (RFC3339 format)

due_date_endstring

Filter by due date end (RFC3339 format)

customer_idstring

Filter by customer ID

invoice_numberstring

Filter by invoice number

status'UPCOMING' | 'OVERDUE' | 'RECEIVED' | 'PAID' | 'ARCHIVED'

Filter by invoice status

Response

OK

end_cursorstring
has_next_pageboolean
has_previous_pageboolean
start_cursorstring

Example response

{
  "end_cursor": "gaFpxBACEaXBVABEYbHG+X9LyLnH",
  "has_next_page": true,
  "start_cursor": "gaFpxBACEaXBVABEYbHG+X9LyLnH"
}

Changes

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