Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.getasset.com/llms.txt

Use this file to discover all available pages before exploring further.

​
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"

​
id
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

​
metadata
Metadata · object
​
lines
InvoiceLinePublic · object[] | null

The lines of the invoice

​
payments
InvoicePaymentPublic · object[] | null

The payments of the invoice

​
tags
Tags · object

Tag field name to tag value pairs attached to the invoice.

Example:
{ "Location": "NYC" }