Skip to main content
GET
/
api
/
invoices
List invoices
curl --request GET \
  --url https://dev.exante.app/api/invoices \
  --header 'Authorization: Bearer <token>'
{
  "status": "success",
  "status_code": 200,
  "message": "Success",
  "data": {
    "items": [
      {
        "uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "parent_contract": {
          "filename": "<string>",
          "uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "is_archived": true
        },
        "invoice_number": "<string>",
        "subtotal_cents": 123,
        "discount_cents": 123,
        "tax_cents": 123,
        "total": 123,
        "total_cents": 123,
        "pre_payment_credit_notes_cents": 123,
        "amount_due_cents": 123,
        "amount_paid_cents": 123,
        "amount_remaining_cents": 123,
        "overdue_days": 123,
        "issue_date": "2023-11-07T05:31:56Z",
        "due_date": "2023-11-07T05:31:56Z",
        "paid_date": "2023-11-07T05:31:56Z",
        "document_uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "status": "<string>",
        "collection_method": "<string>",
        "blueprint": {
          "is_active": true
        },
        "parties": {
          "client": {
            "uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "name": "<string>",
            "address": "<string>",
            "billing_contact": {
              "uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "party_uid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "name": "<string>",
              "title": "<string>",
              "email": "jsmith@example.com",
              "phone": "<string>"
            },
            "role": "<string>"
          }
        }
      }
    ],
    "_meta": {
      "page": 123,
      "per_page": 123,
      "total_pages": 123,
      "total_items": 123
    },
    "_links": {
      "self": "<string>",
      "next": "<string>",
      "prev": "<string>"
    }
  }
}
Returns a paginated list of accounts receivable invoices for one organization.

​
Organization scoping

  • If organization_uid is omitted, the API uses your default organization.
  • If you are not a member of the requested organization, the request is rejected.

​
Filtering

Most filters are string-based and can be combined in a single request.
  • party_name supports multiple names with |, for example Acme|Globex.
  • party_uids, status, and collection_method accept comma-separated values.
  • overdue_days accepts an exact value (15), a range (1-30), or comparison syntax (>90, <0).
  • total uses integer cents and accepts the same range/comparison syntax.
  • include_inactive=true includes invoices tied to archived documents or inactive blueprints.
GET /api/invoices?status=OVERDUE,PARTIALLY_PAID&party_name=Acme|Globex&overdue_days=>30

​
Sorting

Prefix sort fields with + for ascending or - for descending. Default sort is newest issue_date first. Supported sort fields:
  • due_date
  • issue_date
  • paid_date
  • total
  • status
  • collection_method
  • invoice_number
  • party_name
  • overdue_days

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
organization_uid
string<uuid>

Organization to scope the query to. Defaults to the user's default organization.

​
search
string

Search across invoice number and party name.

​
party_name
string

Filter by party name. Use | to provide multiple names.

​
party_uids
string

Comma-separated party UIDs. Takes precedence over party_name.

​
status
string

Comma-separated invoice statuses.

​
collection_method
string

Comma-separated collection methods: charge_automatically, send_invoice.

​
issue_date_from
string<date-time>

Inclusive lower bound for issue_date.

​
issue_date_to
string<date-time>

Inclusive upper bound for issue_date.

​
due_date_from
string<date-time>

Inclusive lower bound for due_date.

​
due_date_to
string<date-time>

Inclusive upper bound for due_date.

​
paid_date_from
string<date-time>

Inclusive lower bound for paid_date.

​
paid_date_to
string<date-time>

Inclusive upper bound for paid_date.

​
overdue_days
string

Filter by overdue days using 1-30, >90, <0, or an exact number.

​
total
string

Filter by total amount in cents using range/exact operators.

​
include_inactive
boolean
default:false

Include invoices tied to archived documents or inactive blueprints.

​
sort
string

Sort fields: due_date, issue_date, paid_date, total, status, collection_method, invoice_number, party_name, overdue_days. Prefix with + or -. Default is newest issue_date first.

​
page
integer
default:1
Required range: x >= 1
​
per_page
integer
default:10
Required range: 1 <= x <= 100

Response

Paginated invoice list

​
status
string
Example:

"success"

​
status_code
integer
Example:

200

​
message
string
Example:

"Success"

​
data
object