Skip to main content
POST
Void Bill Payment

Path Parameters

bill_id
integer
required

ID of the bill

payment_id
integer
required

ID of the payment to void

Body

void_date
string<date> | null

Response

200 - application/json
id
integer
required
read-only
payment_transaction_bank_description
string
required
read-only
payment_journal_entry_order
string
required
read-only
voided_journal_entry_order
string
required
read-only
withheld_amount
number<double> | null
required
read-only

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

Reads the bill_withheld_by_payment map that AccountingBillSerializer populated from prefetched records, so no per-payment query runs. A 0% payment maps to zero, which is distinct from a payment that recorded no withholding at all.

applied_debit_memo
object | null
required
read-only

The debit memo this payment applied, when the payment is a memo application (its journal entry carries a debit memo payment row).

Uses .all() so the detail view's prefetch chain serves it from cache.

created_at
string<date-time>
required
read-only
last_modified_at
string<date-time>
required
read-only
customer
integer
required
read-only
bill
integer
required
payment_journal_entry
integer
required
currency
string
Maximum string length: 3
amount
number<double>
Required range: -1000000000000000000 < x < 1000000000000000000
payment_date
string<date> | null
source
string | null
Maximum string length: 250
source_id
string | null
voided_date
string<date> | null
payment_transaction
integer | null
voided_journal_entry
integer | null