Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
The UUID of the business the bill belongs to
The UUID of the bill to update
Body
External ID for the bill within your platform.
When the bill was received.
When the bill is due. Cannot be specified along with bill_terms.
Payment terms for the bill. Cannot be specified along with due_at.
DUE_ON_RECEIPT
, NET_10
, NET_15
, NET_30
, NET_60
Memo for any text you would like to associate with the bill (for example, to display to end users).
ID of the vendor associated with the bill.
External ID of the vendor associated with the bill.
Updated line items for the bill.
Updated payments for the bill.
Updated additional sales tax line items.
Updated status of the bill.
RECEIVED
, PARTIALLY_PAID
, PAID
, VOIDED
Arbitrary custom metadata in JSON format with a size limit of 10KB
{
"custom_field": "value",
"any valid json": "below 10kb",
"nested": { "meaning of life": 42, "array": [] }
}
Any (typically user-visible) identifier you would like to associate with the bill. Can be used to filter when listing bills.
Response
Bill updated successfully
Unique identifier for the bill.
ID of the Business that received the bill.
Unique ID of the bill in your system.
Status of the bill.
RECEIVED
, PARTIALLY_PAID
, PAID
, VOIDED
Payment terms of the bill.
DUE_ON_RECEIPT
, NET_10
, NET_15
, NET_30
, NET_60
When the bill was received.
When the bill is due.
When the bill was paid.
When the bill was voided.
Memo for the bill for display.
Line items making up the bill
Additional sales tax line items
Sum of all additional taxes in cents
Subtotal of all line items in cents
Total amount including taxes in cents
Remaining balance after payments in cents
Payment allocations for this bill
Vendor credit allocations for this bill
When the bill was imported
When the bill was last updated
The vendor associated with this bill
Arbitrary custom metadata in JSON format with a size limit of 10KB
{
"custom_field": "value",
"any valid json": "below 10kb",
"nested": { "meaning of life": 42, "array": [] }
}
Any (typically user-visible) identifier you would like to associate with the bill. Can be used to filter when listing bills.