List invoices | Paid | Documentation

import { PaidClient } from "@paid-ai/paid-node";
async function main() {
    const client = new PaidClient({
        token: "YOUR_TOKEN_HERE",
    });
    await client.invoices.listInvoices({});
}
main();

{
  "data": [
    {
      "id": "string",
      "customerId": "string",
      "status": "building",
      "paymentStatus": "pending",
      "source": "order_based",
      "startDate": "2024-01-15T09:30:00Z",
      "issueDate": "2024-01-15T09:30:00Z",
      "currency": "string",
      "taxAmount": 1.1,
      "taxRate": 1.1,
      "taxStatus": "not_applicable",
      "invoiceTotalExcludingTax": 1.1,
      "invoiceTotal": 1.1,
      "amountDue": 1.1,
      "amountPaid": 1.1,
      "amountRemaining": 1.1,
      "creditNotesTotal": 1.1,
      "createdAt": "2024-01-15T09:30:00Z",
      "updatedAt": "2024-01-15T09:30:00Z",
      "taxExempt": true,
      "displayNumber": "string",
      "orderId": "string",
      "endDate": "2024-01-15T09:30:00Z",
      "postedDate": "2024-01-15T09:30:00Z",
      "dueDate": "2024-01-15T09:30:00Z",
      "metadata": {},
      "paymentLink": "string",
      "disputeLink": "string",
      "publicUrlToken": "string",
      "billingContactId": "string",
      "purchaseOrderReference": "string"
    }
  ],
  "pagination": {
    "limit": 1,
    "offset": 1,
    "total": 1,
    "hasMore": true
  }
}

Get a list of invoices for the organization

Authentication

AuthorizationBearer

API Key authentication using Bearer token

Query parameters

limitintegerOptional1-100Defaults to 10

offsetintegerOptional

customerIdstringOptional>=1 character

Filter by customer ID.

externalCustomerIdstringOptional>=1 character

Filter by customer external ID.

orderIdstringOptional>=1 character

Filter by the order this invoice was generated from.

statusenumOptional

Filter by invoice status.

paymentStatusenumOptional

Filter by payment status.

Allowed values:

issueDateFromstringOptional

Only invoices whose issue date is on or after this date. Accepts an ISO 8601 date or date-time. Date-only values (e.g. 2026-06-30) are treated as UTC; date-times without an explicit timezone offset are ambiguous, so include one (e.g. 2026-06-30T00:00:00-05:00) when precision matters.

issueDateTostringOptional

Only invoices whose issue date is on or before this date. Accepts an ISO 8601 date or date-time. Date-only values (e.g. 2026-06-30) are treated as UTC; date-times without an explicit timezone offset are ambiguous, so include one (e.g. 2026-06-30T00:00:00-05:00) when precision matters.

dueDateFromstringOptional

Only invoices whose due date is on or after this date. Invoices without a due date are not matched. Accepts an ISO 8601 date or date-time. Date-only values (e.g. 2026-06-30) are treated as UTC; date-times without an explicit timezone offset are ambiguous, so include one (e.g. 2026-06-30T00:00:00-05:00) when precision matters.

dueDateTostringOptional

Only invoices whose due date is on or before this date. Invoices without a due date are not matched. Accepts an ISO 8601 date or date-time. Date-only values (e.g. 2026-06-30) are treated as UTC; date-times without an explicit timezone offset are ambiguous, so include one (e.g. 2026-06-30T00:00:00-05:00) when precision matters.

displayNumberstringOptional>=1 character

Filter by the invoice number shown on the invoice, whether draft or posted (exact match).

purchaseOrderReferencestringOptional>=1 character

Filter by purchase order reference (exact match, whitespace-sensitive).

currencystringOptional>=1 character

Filter by invoice currency code (case-insensitive, e.g. USD).

Response

200

datalist of objects

paginationobject

Errors

400

Bad Request Error

403

Forbidden Error

500

Internal Server Error