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

Void Invoice Payment

cURL

curl --request POST \
  --url https://api.meetcampfire.com/coa/api/v1/invoice/{invoice_id}/payment/{payment_id}/void/ \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "void_date": "2023-12-25"
}
'

200

{
  "id": 123,
  "credit_memo": "<string>",
  "payment_transaction_bank_description": "<string>",
  "payment_journal_entry_order": "<string>",
  "payment_intercompany_journal": "<string>",
  "voided_journal_entry_order": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "external_id": "<string>",
  "last_modified_at": "2023-11-07T05:31:56Z",
  "customer": 123,
  "invoice": 123,
  "currency": "<string>",
  "amount": 0,
  "payment_date": "2023-12-25",
  "voided_date": "2023-12-25",
  "payment_journal_entry": 123,
  "payment_transaction": 123,
  "fx_gain_loss_realized_transaction": 123,
  "payment_term_discount_transaction": 123,
  "voided_journal_entry": 123,
  "payment_transactions": [
    123
  ]
}

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

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

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

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

payment_type · enum<string> any · 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 · Option 1 · enum<string> Option 2 · enum<string> Option 3 · any

• 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[]