StateSet API Docs

curl --location 'https://api.stateset.com/api/v1/invoices?status=sent&limit=10' \
--header 'Authorization: Bearer YOUR_API_KEY'

const invoices = await stateset.invoices.list({
  status: 'sent',
  limit: 10,
  overdue_only: false
});

invoices = stateset.invoices.list(
  status='sent',
  limit=10,
  overdue_only=False
)

{
  "object": "list",
  "data": [
    {
      "id": "inv_0901f083-aa1c-43c5-af5c-0a9d2fc64e30",
      "object": "invoice",
      "invoice_number": "INV-2024-0001",
      "status": "sent",
      "customer_id": "cust_abc123",
      "customer_name": "Acme Corporation",
      "issue_date": "2024-01-19",
      "due_date": "2024-02-18",
      "currency": "USD",
      "total_amount": 697500,
      "amount_due": 697500,
      "days_until_due": 30
    },
    {
      "id": "inv_7823f083-bb2c-54d6-bf6d-1b8e3fc75f41",
      "object": "invoice",
      "invoice_number": "INV-2024-0002",
      "status": "partially_paid",
      "customer_id": "cust_def456",
      "customer_name": "TechCorp Inc",
      "issue_date": "2024-01-15",
      "due_date": "2024-01-30",
      "currency": "USD",
      "total_amount": 125000,
      "amount_due": 50000,
      "days_until_due": 11
    }
  ],
  "has_more": true,
  "url": "/v1/invoices"
}

GET

api

invoices

curl --location 'https://api.stateset.com/api/v1/invoices?status=sent&limit=10' \
--header 'Authorization: Bearer YOUR_API_KEY'

const invoices = await stateset.invoices.list({
  status: 'sent',
  limit: 10,
  overdue_only: false
});

invoices = stateset.invoices.list(
  status='sent',
  limit=10,
  overdue_only=False
)

{
  "object": "list",
  "data": [
    {
      "id": "inv_0901f083-aa1c-43c5-af5c-0a9d2fc64e30",
      "object": "invoice",
      "invoice_number": "INV-2024-0001",
      "status": "sent",
      "customer_id": "cust_abc123",
      "customer_name": "Acme Corporation",
      "issue_date": "2024-01-19",
      "due_date": "2024-02-18",
      "currency": "USD",
      "total_amount": 697500,
      "amount_due": 697500,
      "days_until_due": 30
    },
    {
      "id": "inv_7823f083-bb2c-54d6-bf6d-1b8e3fc75f41",
      "object": "invoice",
      "invoice_number": "INV-2024-0002",
      "status": "partially_paid",
      "customer_id": "cust_def456",
      "customer_name": "TechCorp Inc",
      "issue_date": "2024-01-15",
      "due_date": "2024-01-30",
      "currency": "USD",
      "total_amount": 125000,
      "amount_due": 50000,
      "days_until_due": 11
    }
  ],
  "has_more": true,
  "url": "/v1/invoices"
}

This endpoint retrieves a paginated list of invoices. Use filters to narrow results by status, customer, date range, and more.

Authentication

This endpoint requires a valid API key with invoices:read permissions.

Authorization: Bearer YOUR_API_KEY

Query Parameters

integer

Number of items to return (default: 20, max: 100)

string

Cursor for pagination (invoice ID)

string

Filter by status: “draft”, “sent”, “viewed”, “partially_paid”, “paid”, “overdue”, “voided”

string

Filter by customer ID

string

Filter by issue date start (YYYY-MM-DD)

string

Filter by issue date end (YYYY-MM-DD)

string

Filter by due date start (YYYY-MM-DD)

string

Filter by due date end (YYYY-MM-DD)

boolean

Show only overdue invoices

string

Sort field: “created_at”, “issue_date”, “due_date”, “total_amount”

string

Sort order: “asc” or “desc” (default: “desc”)

Response

string

Object type, always “list”

array

Array of invoice objects

boolean

Whether more items exist

curl --location 'https://api.stateset.com/api/v1/invoices?status=sent&limit=10' \
--header 'Authorization: Bearer YOUR_API_KEY'

const invoices = await stateset.invoices.list({
  status: 'sent',
  limit: 10,
  overdue_only: false
});

invoices = stateset.invoices.list(
  status='sent',
  limit=10,
  overdue_only=False
)

{
  "object": "list",
  "data": [
    {
      "id": "inv_0901f083-aa1c-43c5-af5c-0a9d2fc64e30",
      "object": "invoice",
      "invoice_number": "INV-2024-0001",
      "status": "sent",
      "customer_id": "cust_abc123",
      "customer_name": "Acme Corporation",
      "issue_date": "2024-01-19",
      "due_date": "2024-02-18",
      "currency": "USD",
      "total_amount": 697500,
      "amount_due": 697500,
      "days_until_due": 30
    },
    {
      "id": "inv_7823f083-bb2c-54d6-bf6d-1b8e3fc75f41",
      "object": "invoice",
      "invoice_number": "INV-2024-0002",
      "status": "partially_paid",
      "customer_id": "cust_def456",
      "customer_name": "TechCorp Inc",
      "issue_date": "2024-01-15",
      "due_date": "2024-01-30",
      "currency": "USD",
      "total_amount": 125000,
      "amount_due": 50000,
      "days_until_due": 11
    }
  ],
  "has_more": true,
  "url": "/v1/invoices"
}

Refund Payment Get Invoice

StateSet One API

StateSet API v1

Customer Management

Order Management

Checkouts

Returns Management

Warranty Management

Wholesale Management

Inventory Management

ASN Management

Purchase Orders

Manufacturing

Warehouse Operations

CRM

Suppliers

E-commerce

Financial

Fulfillment

Communication

System

StateSet Response API

StateSet Cloud API

StateSet Commerce API

List Invoices

Authentication

Query Parameters

Response

​Authentication

​Query Parameters

​Response

Authentication

Query Parameters

Response