Sign in

v1

latestOpenAPI 3.1.0raw.githubusercontent.com2026-07-0217204.7 MB
Bill

Cancel a pending payment for a bill

The underlying payment is deleted and the bill sent back to returned.

post/v1/web/bill/{id}/cancel-payment

Path parameters

idstring required

Response

Default Response

idstring required
externalIdstring
creatorUserIdstring required
vendorIdstring
invoiceIdstring
currencyCodestring
invoiceDatestring date

ISO date string, YYYY-MM-DD

paymentDueDatestring date

The date that the invoice says the payment is due, in ISO date string, YYYY-MM-DD

totalAmountstring

number string

descriptionstring
paymentScheduledDatestring date

When the payment will be triggered, in ISO date string, YYYY-MM-DD. It should be far enough in advance so when the payment reaches the vendor, it is still before or on the paymentDueDate. Date is based on the payment processor's timezone, i.e. EST.

createdAtstring date-time required
updatedAtstring date-time required
submittedAtstring date-time
completedAtstring date-time