curl --request POST \
--url https://api.meetcampfire.com/coa/api/v1/invoice/{invoice_id}/payment/{payment_id}/void/ \
--header 'Authorization: <api-key>'
{
"id": 123,
"credit_memo": "<string>",
"payment_transaction_bank_description": "<string>",
"payment_journal_entry_order": "<string>",
"voided_journal_entry_order": "<string>",
"currency": "<string>",
"amount": 0,
"payment_date": "2023-12-25",
"created_at": "2023-11-07T05:31:56Z",
"voided_date": "2023-12-25",
"source": "STRIPE",
"last_modified_at": "2023-11-07T05:31:56Z",
"customer": 123,
"invoice": 123,
"payment_journal_entry": 123,
"payment_transaction": 123,
"voided_journal_entry": 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.
curl --request POST \
--url https://api.meetcampfire.com/coa/api/v1/invoice/{invoice_id}/payment/{payment_id}/void/ \
--header 'Authorization: <api-key>'
{
"id": 123,
"credit_memo": "<string>",
"payment_transaction_bank_description": "<string>",
"payment_journal_entry_order": "<string>",
"voided_journal_entry_order": "<string>",
"currency": "<string>",
"amount": 0,
"payment_date": "2023-12-25",
"created_at": "2023-11-07T05:31:56Z",
"voided_date": "2023-12-25",
"source": "STRIPE",
"last_modified_at": "2023-11-07T05:31:56Z",
"customer": 123,
"invoice": 123,
"payment_journal_entry": 123,
"payment_transaction": 123,
"voided_journal_entry": 123
}
Token-based authentication with required prefix "Token"
ID of the invoice
ID of the payment to void
The response is of type object
.