Invoice Object

business_id

string<biz_string>

required

The ID of the Business that the invoice is associated with

Example:

"biz_Pk2fNFDd8wj7EFeLWJywc7"

number

string

required

The number of the invoice. Must be unique across all invoices for a business.

Maximum string length: 255

Example:

"INV-1234567890"

description

string

required

The description of the invoice

Maximum string length: 512

Example:

"Invoice from Acme Corp"

total_amount

number

required

The amount of the invoice

Example:

520.56

source

enum<string>

required

The source of the invoice

Available options:

manual,

stripe

due_at

string<date-time>

required

The due date of the invoice

sent_at

string<date-time>

required

The date the invoice was sent

status

enum<string>

required

The status of the invoice

Available options:

open,

paid,

uncollectible,

voided,

refunded,

partially_refunded

Example:

"paid"

string<inv_string>

required

The ID of the invoice

Example:

"inv_GkBo16N66u2teKfFuFMMwf"

customer_id

string<cus_string>

required

The ID of the Customer that the invoice is associated with

Example:

"cus_WxcM3ypJ5boFxsNQzcqRXe"

total_paid

number

default:0

The amount of the invoice that has been paid

Example:

520.56

voided_at

string<date-time> | null

The date the invoice was voided

credit_amount

number | null

The amount to issue as a credit in the invoice

Example:

50

metadata_

Metadata · object

lines

InvoiceLinePublic · object[] | null

The lines of the invoice

Show child attributes

payments

InvoicePaymentPublic · object[] | null

The payments of the invoice

Show child attributes

List all InvoicesGet paginated list of invoices for a business with optional filtering.

⌘I

{
  "business_id": "<string>",
  "number": "<string>",
  "description": "<string>",
  "total_amount": 123,
  "source": "manual",
  "due_at": "2023-11-07T05:31:56Z",
  "sent_at": "2023-11-07T05:31:56Z",
  "status": "open",
  "id": "<string>",
  "customer_id": "<string>",
  "total_paid": 0,
  "voided_at": "2023-11-07T05:31:56Z",
  "credit_amount": 50,
  "metadata_": {},
  "lines": [
    {
      "description": "<string>",
      "ledger_id": "ldg_ErisumsAc7qgmbTctM7zKK",
      "amount": 123,
      "id": "<string>",
      "invoice_id": "<string>",
      "metadata_": {}
    }
  ],
  "payments": [
    {
      "invoice_id": "<string>",
      "transaction_id": "<string>",
      "payment_id": "<string>",
      "datetime": "2023-11-07T05:31:56Z",
      "payment_amount": 123,
      "id": "<string>",
      "invoice": "<unknown>"
    }
  ]
}

API Overview

Tenant

Business

Accounting