List invoices

Error

A valid request URL is required to generate request examples

{
  "items": [
    {
      "invoiceId": "094f10ca-616e-441c-b264-9a2305d6692d",
      "customerId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
      "invoiceNumber": "INV-2024-001",
      "status": "SENT",
      "dueDate": "2024-02-15",
      "createdAt": "2024-01-15T10:00:00Z",
      "updatedAt": "2024-01-15T10:00:00Z",
      "subtotalAmount": 29.99,
      "totalAmount": 29.89,
      "currency": "USD",
      "sentAt": "2024-01-15T10:00:00Z",
      "paidAt": "2024-02-10T14:30:00Z",
      "voidedAt": "2024-02-05T09:00:00Z",
      "invoiceUrl": "https://invoices.yourapp.com/094f10ca-616e-441c-b264-9a2305d6692d",
      "metadata": {}
    }
  ],
  "pagination": {
    "total": 123,
    "limit": 123,
    "offset": 123,
    "sort": {
      "key": "<string>",
      "direction": "ASC"
    }
  }
}

GET

invoices

Error

A valid request URL is required to generate request examples

{
  "items": [
    {
      "invoiceId": "094f10ca-616e-441c-b264-9a2305d6692d",
      "customerId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
      "invoiceNumber": "INV-2024-001",
      "status": "SENT",
      "dueDate": "2024-02-15",
      "createdAt": "2024-01-15T10:00:00Z",
      "updatedAt": "2024-01-15T10:00:00Z",
      "subtotalAmount": 29.99,
      "totalAmount": 29.89,
      "currency": "USD",
      "sentAt": "2024-01-15T10:00:00Z",
      "paidAt": "2024-02-10T14:30:00Z",
      "voidedAt": "2024-02-05T09:00:00Z",
      "invoiceUrl": "https://invoices.yourapp.com/094f10ca-616e-441c-b264-9a2305d6692d",
      "metadata": {}
    }
  ],
  "pagination": {
    "total": 123,
    "limit": 123,
    "offset": 123,
    "sort": {
      "key": "<string>",
      "direction": "ASC"
    }
  }
}

Authorizations

X-Api-Key

string

header

required

An API key that grants access to the Connect API. You can create and manage API keys in the portal.

Query Parameters

limit

integer

default:100

The maximum number of items to return.

Required range: 1 <= x <= 1000

offset

integer

default:0

The number of items to skip before starting to collect the result set.

Required range: x >= 0

customerId

string[]

Filter invoices by customer IDs

status

enum<string>[]

Filter invoices by status

Current status of the invoice lifecycle.

Available options:

DRAFT,

SENT,

PAID,

VOID,

OVERDUE

fromDate

string<date>

Filter invoices created from this date

toDate

string<date>

Filter invoices created up to this date

dueDateFrom

string<date>

Filter invoices with due date from this date

dueDateTo

string<date>

Filter invoices with due date up to this date

Response

Invoices retrieved successfully

items

object[]

required

Show child attributes

items.invoiceId

string

required

Unique identifier for the invoice.

Example:

"094f10ca-616e-441c-b264-9a2305d6692d"

items.customerId

string

required

The customer this invoice is for.

Example:

"f47ac10b-58cc-4372-a567-0e02b2c3d479"

items.invoiceNumber

string

required

Human-readable invoice number.

Example:

"INV-2024-001"

items.status

enum<string>

required

Current status of the invoice.

Available options:

DRAFT,

SENT,

PAID,

VOID,

OVERDUE

Example:

"SENT"

items.dueDate

string<date>

required

When payment is due.

Example:

"2024-02-15"

items.createdAt

string<date-time>

required

When the invoice was created.

Example:

"2024-01-15T10:00:00Z"

items.updatedAt

string<date-time>

required

When the invoice was last updated.

Example:

"2024-01-15T10:00:00Z"

items.subtotalAmount

number<decimal>

Subtotal amount before taxes and fees.

Example:

29.99

items.totalAmount

number<decimal>

Total amount due for the invoice.

Example:

29.89

items.currency

string

Invoice currency.

Example:

"USD"

items.sentAt

string<date-time>

When the invoice was sent to the customer (if status is sent or later).

Example:

"2024-01-15T10:00:00Z"

items.paidAt

string<date-time>

When the invoice was paid (if status is paid).

Example:

"2024-02-10T14:30:00Z"

items.voidedAt

string<date-time>

When the invoice was voided (if status is void).

Example:

"2024-02-05T09:00:00Z"

items.invoiceUrl

string<uri>

Hosted URL where customer can view the invoice.

Example:

"https://invoices.yourapp.com/094f10ca-616e-441c-b264-9a2305d6692d"

items.metadata

object

A set of key-value pairs that can be attached to an object for storing additional information in a semi-structured format.

Show child attributes

items.metadata.{key}

string

pagination

object

Show child attributes

pagination.total

integer

The total number of items available.

pagination.limit

integer

The maximum number of items to return.

pagination.offset

integer

The number of items to skip before starting to collect the items.

pagination.sort

object

The sorting criteria.

Show child attributes

pagination.sort.key

string

The key to sort by.

pagination.sort.direction

enum<string>

The direction to sort by.

Available options:

ASC,

DESC

Lease phone numbers Get invoice

⌘I

Getting started

Overview

API reference

Authorizations

Query Parameters

Response