v1

latestOpenAPI 3.0.32026-07-26362271803.3 KB

Accounts Payable

Void Bill Payment

Void an existing bill payment.

    This creates a reversing journal entry to void the payment and updates the bill status.

    Optionally accepts a void_date in the request body to specify when the payment should be voided.
    If not provided, defaults to today's date.

post/coa/api/v1/bill/{bill_id}/payment/{payment_id}/void/

Path parameters

bill_idinteger required

ID of the bill

payment_idinteger required

ID of the payment to void

Request body

void_datestring date nullable

Response

idinteger required

payment_transaction_bank_descriptionstring required

payment_journal_entry_orderstring required

voided_journal_entry_orderstring required

withheld_amountnumber double nullable required

Tax withheld on this payment (AP): sum of the payment's withholding credit legs.

Reads the bill_withheld_by_je map that AccountingBillSerializer populated from prefetched records, so no per-payment query runs. Void reversals live on a different journal, so they are naturally excluded.

currencystring

amountnumber double

payment_datestring date nullable

sourcestring nullable

source_idstring nullable

created_atstring date-time required

voided_datestring date nullable

last_modified_atstring date-time required

customerinteger required

billinteger required

payment_journal_entryinteger required

payment_transactioninteger nullable

voided_journal_entryinteger nullable