Skip to main content
PATCH
Update a Bill

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

business_id
string<biz_string>
required

The id of the business

Example:

"biz_GA6EG2qFxA97NZHtxeLPUy"

bill_id
string<bil_string>
required

The id of the bill

Example:

"bil_WQMDNUHpBThYSNh4AprDBo"

Body

application/json
number
string | null

The new number of the bill

Example:

"BILL-002"

description
string | null

The new description of the bill

Example:

"Updated office supplies"

due_at
string<date-time> | null

The new due date of the bill in ISO-8601 format

Example:

"2025-03-01T00:00:00Z"

issued_at
string<date-time> | null

The new issued date of the bill in ISO-8601 format

Example:

"2025-01-20T00:00:00Z"

status
enum<string> | null

The new status of the bill

Available options:
open,
paid,
voided
Example:

"open"

line_changes
BillLineChanges · object | null

The changes to the lines of the bill

tags
Tags · object | null

Inline tag input to merge into the bill's tags. Each key is a tag field name that must already exist. A string upserts a single value and replaces all current values for that field. A list of {value, amount} objects replaces all current values for the field with the supplied set. A null (or empty list) removes all of the bill's values for that field. Fields not mentioned are left untouched. Per-field amounts follow the default rules (single value -> bill total; N values without amounts -> bill total / N; mixed is rejected) and the per-field sum must not exceed the bill total.

Example:

Response

Successful Response

data
BillPublic · object
required