Skip to main content
GET
/
v1
/
invoices
Get all invoices
curl --request GET \
  --url https://api.example.com/v1/invoices \
  --header 'Authorization: Bearer <token>'
{
  "total": 123,
  "limit": 123,
  "offset": 123,
  "invoices": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "invoice_number": "<string>",
      "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "currency": "<string>",
      "total": 123,
      "due_date": "2023-11-07T05:31:56Z",
      "created_at": "2023-11-07T05:31:56Z"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
status
enum<string>

Filter by invoice status

Available options:
draft,
pending,
paid,
sent,
overdue
​
date_from
string<date-time>

Start date for filtering

​
date_to
string<date-time>

End date for filtering

​
currency
string

3-letter currency code

Required string length: 3
​
customer_id
string<uuid>

Filter by customer UUID

​
limit
integer
default:10

Number of records per page

Required range: 1 <= x <= 100
​
offset
integer
default:0

Number of records to skip

Required range: x >= 0

Response

List of invoices

​
total
integer
​
limit
integer
​
offset
integer
​
invoices
object[]