Skip to main content
POST
Void Invoice Payment

Authorizations

Authorization
string
header
required

Token-based authentication with required prefix "Token"

Path Parameters

invoice_id
integer
required

ID of the invoice

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
credit_memo
string
required
read-only
payment_transaction_bank_description
string
required
read-only
payment_journal_entry_order
string
required
read-only
payment_intercompany_journal
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: 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.

created_at
string<date-time>
required
read-only
payment_type
required

Type of payment: credit memo application, bank transaction, or manual transaction

  • CREDIT_MEMO - Credit Memo
  • BANK_TRANSACTION - Bank Transaction
  • MANUAL_TRANSACTION - Manual Transaction
Available options:
CREDIT_MEMO,
BANK_TRANSACTION,
MANUAL_TRANSACTION
external_id
string | null
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.

Maximum string length: 256
last_modified_at
string<date-time>
required
read-only
customer
integer
required
read-only
invoice
integer
required
currency
string
Maximum string length: 3
amount
number<double>
Required range: -1000000000000000000 < x < 1000000000000000000
payment_date
string<date> | null
voided_date
string<date> | null
source
  • STRIPE - Stripe
  • MANUAL - Manual
Available options:
STRIPE,
MANUAL
payment_journal_entry
integer | null
payment_transaction
integer | null
fx_gain_loss_realized_transaction
integer | null
payment_term_discount_transaction
integer | null
voided_journal_entry
integer | null
payment_transactions
integer[]