v1

latestOpenAPI 3.0.32026-07-26362271803.3 KB

Accounts Receivable

Void Invoice Payment

Void an existing invoice payment.

    This creates a reversing journal entry to void the payment and updates the invoice status.
    For Stripe payments, this will also process a refund through Stripe.

    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/invoice/{invoice_id}/payment/{payment_id}/void/

Path parameters

invoice_idinteger required

ID of the invoice

payment_idinteger required

ID of the payment to void

Request body

void_datestring date nullable

Response

idinteger required

credit_memostring required

payment_transaction_bank_descriptionstring required

payment_journal_entry_orderstring required

payment_intercompany_journalstring required

voided_journal_entry_orderstring required

withheld_amountnumber double nullable required

Tax withheld on this payment: sum of the payment's own withholding GL legs.

Summed over the payment's legs (not the invoice's withholding records) so a voided payment still shows what it originally withheld.

currencystring

amountnumber double

payment_datestring date nullable

created_atstring date-time required

voided_datestring date nullable

external_idstring nullable required

Stable upstream identifier for this payment (e.g. Stripe balance transaction 'btxn_...', Stripe credit note 'cn_...', or the mart's event external_id for customer-balance applications). Used as the natural dedup/idempotency key. Null for manually-entered payments.

last_modified_atstring date-time required

customerinteger required

invoiceinteger required

payment_journal_entryinteger nullable

payment_transactioninteger nullable

fx_gain_loss_realized_transactioninteger nullable

payment_term_discount_transactioninteger nullable

voided_journal_entryinteger nullable

payment_transactionsinteger[]