Bill Object

business_id

string<biz_string>

required

The ID of the Business that the bill is associated with

Example:

"biz_Pk2fNFDd8wj7EFeLWJywc7"

vendor_id

string<ven_string>

required

The ID of the Vendor that the bill is associated with

Example:

"ven_ErisumsAc7qgmbTctM7zKK"

number

string

required

The id or number of the bill

Maximum string length: 255

Example:

"BILL-001"

description

string

required

The description of the bill

Maximum string length: 512

Example:

"Cleaning services"

total_amount

number

required

The amount of the bill

total_paid

number

required

The amount of the bill that has been paid

due_at

string<date-time>

required

The due date of the bill

issued_at

string<date-time>

required

The date the bill was sent

status

enum<string>

required

The status of the bill

Available options:

open,

paid,

voided

string<bil_string>

required

The ID of the bill

Example:

"bil_WQMDNUHpBThYSNh4AprDBo"

voided_at

string<date-time> | null

The date the bill was voided

metadata_

Metadata · object

lines

BillLinePublic · object[] | null

The lines of the bill

Show child attributes

payments

BillPaymentPublic · object[] | null

The payments associated with the bill

Show child attributes

List all BillsGet paginated list of bills for a business with optional filtering.

⌘I

{
  "business_id": "<string>",
  "vendor_id": "<string>",
  "number": "<string>",
  "description": "<string>",
  "total_amount": 123,
  "total_paid": 123,
  "due_at": "2023-11-07T05:31:56Z",
  "issued_at": "2023-11-07T05:31:56Z",
  "status": "open",
  "id": "<string>",
  "voided_at": "2023-11-07T05:31:56Z",
  "metadata_": {},
  "lines": [
    {
      "description": "<string>",
      "ledger_id": "ldg_ErisumsAc7qgmbTctM7zKK",
      "amount": 123,
      "id": "<string>",
      "bill_id": "<string>",
      "metadata_": {}
    }
  ],
  "payments": [
    {
      "bill_id": "<string>",
      "transaction_id": "<string>",
      "payment_id": "<string>",
      "datetime": "2023-11-07T05:31:56Z",
      "payment_amount": 123,
      "id": "<string>",
      "bill": "<unknown>"
    }
  ]
}

API Overview

Tenant

Business

Accounting