Skip to main content
GET
/
v2
/
invoices
List Invoices
curl --request GET \
  --url https://api.example.com/v2/invoices \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "created_at": "2023-11-07T05:31:56Z",
      "modified_at": "2023-11-07T05:31:56Z",
      "id": "<string>",
      "number": "<string>",
      "currency": "ADP",
      "amount_due": "<string>",
      "amount_paid": "<string>",
      "amount_remaining": "<string>",
      "total_amount": "<string>",
      "due_date": "2023-11-07T05:31:56Z",
      "issued_at": "2023-11-07T05:31:56Z",
      "paid_at": "2023-11-07T05:31:56Z",
      "promised_to_pay_date": "2023-12-25",
      "remote_created_at": "2023-11-07T05:31:56Z",
      "purchase_order_number": "<string>",
      "order_number": "<string>",
      "partner": {
        "created_at": "2023-11-07T05:31:56Z",
        "modified_at": "2023-11-07T05:31:56Z",
        "id": "<string>",
        "account_number": "<string>",
        "assignee_id": "<string>",
        "currency": "ADP",
        "email": "<string>",
        "name": "<string>",
        "legal_name": "<string>",
        "phone": "<string>",
        "parent_id": "<string>",
        "remote_id": "<string>",
        "object": "<string>"
      },
      "assignee": {
        "created_at": "2023-11-07T05:31:56Z",
        "modified_at": "2023-11-07T05:31:56Z",
        "id": "<string>",
        "email": "<string>",
        "name": "<string>",
        "given_name": "<string>",
        "family_name": "<string>",
        "profile_picture": "<string>",
        "object": "<string>"
      },
      "last_outreach_at": "2023-11-07T05:31:56Z",
      "last_outreach_to": "<string>",
      "last_outreach_channel": "email",
      "in_dispute": true,
      "remote_payment_status": "processing",
      "object": "<string>",
      "virtual_status": "draft",
      "days_overdue": 123,
      "days_until_due": 123,
      "payment_url": "<string>"
    }
  ],
  "current_page": 0,
  "total_records": 1,
  "next_page": 123
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
page
integer
default:0

Page number, 0 indexed.

Required range: x >= 0
​
limit
integer
default:100

Number of records per page.

Required range: 1 <= x <= 500
​
sort_by
enum<string> | null
Available options:
default,
due_date,
issued_at,
paid_at,
amount_due,
amount_remaining,
total_amount,
number,
last_outreach_at,
promised_to_pay_date
​
sort_order
enum<string>
default:desc
Available options:
asc,
desc
​
status__in
enum<string>[] | null

Filter by invoice status. Includes virtual statuses: 'processing' (open with payment), 'partially_paid', 'overdue' (open and past due)

Available options:
draft,
open,
uncollectible,
paid,
void,
processing,
overdue,
partially_paid
​
partner_id
string | null

Filter by partner ID

​
assignee_id
string | null

Filter by assignee ID

​
number__in
string[] | null

Filter by invoice numbers

​
amount_remaining_lte
string<decimal>
​
amount_remaining_gte
string<decimal>
​
due_date__gte
string<date> | null

Due date on or after

​
due_date__lte
string<date> | null

Due date on or before

​
issued_at__gte
string<date-time> | null

Issued at on or after

​
issued_at__lte
string<date-time> | null

Issued at on or before

​
promised_to_pay_date__lte
string<date-time> | null

Promised to pay on or before

​
promised_to_pay_date__gte
string<date-time> | null

Promised to pay on or after

​
search
string | null

Search in invoice number, partner name, account number, PO number, order number

​
has_outreach
boolean

Filter by whether invoice has had outreach

​
customer_outreach_paused
boolean

Filter by whether customer outreach is paused

Response

Successful Response

​
data
InvoiceList · object[]
required

The list of records.

​
current_page
integer
default:0
required

The current page.

​
total_records
integer | null
required

Total number of records.

Required range: x >= 0
​
next_page
integer | null
required

The next page number, if one exists.