Skip to navigation

Update Bill

View as Markdown

Updates a bill. Sending payment_term_id rebuilds payment_schedule from that term. Sending a due_date different from the current one replaces the term with that fixed date and clears payment_schedule.

Requires the can_modify_bill permission on the key owner’s role.

Keys: secret key only.

Authentication

AuthorizationBearer

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

identitystring
The identity for the active workspace.

Path parameters

idstringRequired

Request

This endpoint expects an object.
itemslist of objectsOptional
due_datedatetimeOptional
payment_term_idstringOptionalformat: "uuid"

Payment term to apply. Takes precedence over due_date. The document’s due dates and any early-payment discount are worked out from the term and returned in payment_schedule.

bill_datedatetimeOptional
adjustmentslist of objectsOptional
Replaces the adjustments on the bill. Send an empty array to remove them all, or leave the field out to keep the current adjustments.
account_numberstringOptional
exchange_ratedoubleOptional

Response

OK
dataobject
statusboolean
messagestring

Errors

401
Unauthorized Error
402
Payment Required Error
403
Forbidden Error