curl --request POST \
  --url https://api.salesbricks.com/api/v2/invoices/search \
  --header 'Content-Type: application/json' \
  --header 'X-SALESBRICKS-KEY: <api-key>' \
  --data '
{
  "customer_id": "11111111-2222-3333-4444-555555555555",
  "statuses": [
    "PAST_DUE"
  ],
  "ordering": "-due_at"
}
'

{
  "count": 123,
  "results": [
    {
      "invoice_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "subscription_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "billed_company_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "invoice_number": "<string>",
      "due_at": "2023-11-07T05:31:56Z",
      "bill_at": "2023-11-07T05:31:56Z",
      "issued_at": "2023-11-07T05:31:56Z",
      "status": "<string>",
      "fully_paid_at": "2023-11-07T05:31:56Z",
      "grand_total": 123,
      "remaining_amount": 123,
      "currency": "<string>",
      "is_renewal_estimate": true,
      "payment_url": "<string>",
      "customer_name": "<string>",
      "time_zone": "<string>",
      "payments": [
        {
          "payment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "invoice_number": "<string>",
          "invoice_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "paid_amount": 123,
          "paid_at": "2023-11-07T05:31:56Z",
          "currency": "<string>",
          "error": "<string>"
        }
      ],
      "attachments": [
        "<unknown>"
      ],
      "line_items": [
        {
          "brick_name": "<string>",
          "brick_id": "<string>",
          "brick_code": "<string>",
          "quantity": 123,
          "tax": 123,
          "grand_total": 123,
          "starts_at": "2023-11-07T05:31:56Z",
          "ends_at": "2023-11-07T05:31:56Z"
        }
      ],
      "metadata": "<unknown>",
      "purchase_order": {
        "code": "<string>"
      }
    }
  ],
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100"
}

{
  "error": {
    "code": "ERR_NOT_FOUND",
    "message": "<string>",
    "error_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}

Invoices

Search invoices

Search your invoices, both subscription and standalone. Filters combine with AND, and at least one must be provided (ordering alone is not enough). Empty arrays are treated as omitted.

To list a customer’s standalone invoices, send customer_id with an explicit subscription_id: null.

Statuses are the raw invoice statuses the response’s status field reports. Voided invoices are included in results by default; they are excluded only when a statuses filter is provided that does not include VOIDED.

Dates. All *_date_min / *_date_max bounds are inclusive and interpreted in your account’s timezone (_min expands to start of day, _max to end of day). issued_date filters on the invoice’s billing-run date and paid_date on when it was fully paid. A due_date range filters on the due date only — it does not implicitly exclude paid invoices; combine with statuses to narrow.

Days past due is the number of whole days between the due date and now. Invoices with no outstanding balance (fully paid, or nothing due) have no days-past-due value and never match a days_past_due filter. For AR-aging queries combine with "statuses": ["PAST_DUE"].

Amounts are integer minor currency units (e.g. cents). amount_due is the remaining unpaid amount; paid_amount is the total paid so far, including partial payments.

search_term matches invoice numbers, customer names, invoice UUIDs, and amounts.

Ordering takes a single field name with an optional - prefix for descending: issued_at, due_at, or amount_due (remaining amount). Defaults to newest first.

Pagination is handled via query params (limit, offset).

POST

invoices

curl --request POST \
  --url https://api.salesbricks.com/api/v2/invoices/search \
  --header 'Content-Type: application/json' \
  --header 'X-SALESBRICKS-KEY: <api-key>' \
  --data '
{
  "customer_id": "11111111-2222-3333-4444-555555555555",
  "statuses": [
    "PAST_DUE"
  ],
  "ordering": "-due_at"
}
'

{
  "count": 123,
  "results": [
    {
      "invoice_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "subscription_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "billed_company_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "invoice_number": "<string>",
      "due_at": "2023-11-07T05:31:56Z",
      "bill_at": "2023-11-07T05:31:56Z",
      "issued_at": "2023-11-07T05:31:56Z",
      "status": "<string>",
      "fully_paid_at": "2023-11-07T05:31:56Z",
      "grand_total": 123,
      "remaining_amount": 123,
      "currency": "<string>",
      "is_renewal_estimate": true,
      "payment_url": "<string>",
      "customer_name": "<string>",
      "time_zone": "<string>",
      "payments": [
        {
          "payment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "invoice_number": "<string>",
          "invoice_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "paid_amount": 123,
          "paid_at": "2023-11-07T05:31:56Z",
          "currency": "<string>",
          "error": "<string>"
        }
      ],
      "attachments": [
        "<unknown>"
      ],
      "line_items": [
        {
          "brick_name": "<string>",
          "brick_id": "<string>",
          "brick_code": "<string>",
          "quantity": 123,
          "tax": 123,
          "grand_total": 123,
          "starts_at": "2023-11-07T05:31:56Z",
          "ends_at": "2023-11-07T05:31:56Z"
        }
      ],
      "metadata": "<unknown>",
      "purchase_order": {
        "code": "<string>"
      }
    }
  ],
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100"
}

{
  "error": {
    "code": "ERR_NOT_FOUND",
    "message": "<string>",
    "error_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}

Authorizations

X-SALESBRICKS-KEY

string

header

required

API key for authentication

Query Parameters

limit

integer

Number of results to return per page.

offset

integer

The initial index from which to return the results.

Body

Filters for searching your invoices.

invoice_numbers

string[]

Filter invoices by invoice number (e.g. '6c12021a-4')

invoice_ids

string<uuid>[]

Filter invoices by invoice ID

customer_id

string<uuid>

Filter invoices by customer ID

subscription_id

string<uuid> | null

Filter invoices by subscription ID. Pass null to match invoices with no subscription. Omit to apply no subscription filter.

statuses

enum<string>[]

Filter invoices by status.

Current status of the invoice. One of:

MUTED — Invoice will not be sent. Muted invoices come from migration cut-overs or from muting invoices in the product settings.
SCHEDULED — Scheduled to be issued on a future date.
OUTSTANDING — Issued and awaiting payment.
DUE — Payment is due.
PAST_DUE — Payment is past its due date.
PAID — Fully paid.
PARTIALLY_PAID — Partially paid, with a remaining balance.
ADJUSTED — Adjusted after issuance.
CREDITED — Settled by applying credit.
UNPAID — Unpaid.
PAUSED — Collection is paused.
VOIDED — Voided and no longer collectible.

MUTED - Muted
SCHEDULED - Scheduled
DRAFT - Draft
OUTSTANDING - Outstanding
DUE - Due
PAST_DUE - Past due
PAID - Paid
PARTIALLY_PAID - Partially Paid
ADJUSTED - Adjusted
CREDITED - Credited
UNPAID - Unpaid
PAUSED - Paused
VOIDED - Voided

Available options:

MUTED,

SCHEDULED,

DRAFT,

OUTSTANDING,

DUE,

PAST_DUE,

PAID,

PARTIALLY_PAID,

ADJUSTED,

CREDITED,

UNPAID,

PAUSED,

VOIDED

currencies

enum<string>[]

Filter invoices by currency (e.g. USD, EUR)

USD - United States Dollar
EUR - Euros
GBP - Great British Pound
AUD - Australian Dollar
CAD - Canadian Dollar
INR - Indian Rupee

Available options:

USD,

EUR,

GBP,

AUD,

CAD,

INR

metadata

object

Filter invoices by metadata. All supplied key/value pairs must be present on the invoice.

Show child attributes

due_date_min

string<date>

Earliest due date (inclusive, start of day in your account's timezone). Filters on due date only — paid invoices are not implicitly excluded; combine with statuses to narrow.

due_date_max

string<date>

Latest due date (inclusive, end of day in your account's timezone).

issued_date_min

string<date>

Earliest invoice date (inclusive, start of day in your account's timezone). Filters on the invoice's billing-run date — the date the invoice was generated.

issued_date_max

string<date>

Latest invoice date (inclusive, end of day in your account's timezone).

paid_date_min

string<date>

Earliest fully-paid date (inclusive, start of day in your account's timezone).

paid_date_max

string<date>

Latest fully-paid date (inclusive, end of day in your account's timezone).

days_past_due_min

integer

Minimum days between the due date and now (inclusive). Invoices with no outstanding balance have no days-past-due value and never match this filter.

Required range: x >= 0

days_past_due_max

integer

Maximum days between the due date and now (inclusive).

Required range: x >= 0

amount_due_min

integer

Minimum remaining unpaid amount in minor currency units (inclusive).

amount_due_max

integer

Maximum remaining unpaid amount in minor currency units (inclusive).

paid_amount_min

integer

Minimum total paid amount (including partial payments) in minor currency units (inclusive).

paid_amount_max

integer

Maximum total paid amount (including partial payments) in minor currency units (inclusive).

search_term

string

Free-text search across invoice numbers, customer names, invoice UUIDs, and amounts.

ordering

enum<string>

Order results by field, prefixed with '-' for descending. 'amount_due' is the remaining amount. Defaults to newest first.

issued_at - issued_at
-issued_at - -issued_at
due_at - due_at
-due_at - -due_at
amount_due - amount_due
-amount_due - -amount_due

Available options:

issued_at,

-issued_at,

due_at,

-due_at,

amount_due,

-amount_due

Response

count

integer

required

Total number of results across all pages

Example:

123

results

object[]

required

The results on this page

Show child attributes

string<uri> | null

URL of the next page of results, or null on the last page

Example:

"http://api.example.org/accounts/?offset=400&limit=100"

string<uri> | null

URL of the previous page of results, or null on the first page

Example:

"http://api.example.org/accounts/?offset=200&limit=100"

APIs

REST API Endpoints

Usage

Webhooks

Search invoices

Authorizations

Query Parameters

Body

Response