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"
}
'{
"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",
"payment_type": "CREDIT_MEMO",
"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",
"source": "STRIPE",
"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
]
}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.
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"
}
'{
"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",
"payment_type": "CREDIT_MEMO",
"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",
"source": "STRIPE",
"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
]
}Token-based authentication with required prefix "Token"
ID of the invoice
ID of the payment to void
Type of payment: credit memo application, bank transaction, or manual transaction
CREDIT_MEMO - Credit MemoBANK_TRANSACTION - Bank TransactionMANUAL_TRANSACTION - Manual TransactionCREDIT_MEMO, BANK_TRANSACTION, MANUAL_TRANSACTION 3-1000000000000000000 < x < 1000000000000000000STRIPE - StripeMANUAL - ManualSTRIPE, MANUAL