Skip to main content
POST
Update bill

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

businessId
string<uuid>
required

The UUID of the business the bill belongs to.

billId
string<uuid>
required

The UUID of the bill to update.

Body

application/json
external_id
string | null

External ID for the bill within your platform.

received_at
string<date-time>

When the bill was received.

due_at
string<date-time>

When the bill is due. Cannot be specified along with bill_terms.

bill_terms
enum<string>

Payment terms for the bill. Cannot be specified along with due_at.

Available options:
DUE_ON_RECEIPT,
NET_10,
NET_15,
NET_30,
NET_60
memo
string

Memo for any text you would like to associate with the bill (for example, to display to end users).

vendor_id
string<uuid>

ID of the vendor associated with the bill.

vendor_external_id
string

External ID of the vendor associated with the bill.

line_items
object[]

Updated line items for the bill.

payments
object[] | null

Payments for the bill. Omitting this field (or passing null) preserves any existing dedicated payments; passing an empty array [] removes all dedicated payments. Non-dedicated payments (those independently recorded or included in a vendor payout) are never removed by this field.

additional_sales_taxes
object[]

Updated additional sales tax line items.

status
enum<string>

Updated status of the bill.

Available options:
RECEIVED,
PARTIALLY_PAID,
PAID,
VOIDED
tags
object[]
metadata
object | null

Arbitrary custom metadata in JSON format with a size limit of 1KB.

Example:
reference_number
string | null

Any (typically user-visible) identifier you would like to associate with the bill. Can be used to filter when listing bills.

Response

200 - application/json

Bill updated successfully.

data
object
required