curl --request POST \
--url https://api.meetcampfire.com/coa/api/v1/invoice/{invoice_id}/void/ \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
"void_date": "2023-12-25"
}'
{
"id": 123,
"lines": [
{
"id": 123,
"product_name": "<string>",
"stripe_product_id": "<string>",
"product_is_taxable": true,
"anrok_item_id": "<string>",
"service_date": "2023-12-25",
"description": "<string>",
"quantity": 123,
"rate": 123,
"currency": "<string>",
"amount": 0,
"tax": 0,
"tax_description": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"last_modified_at": "2023-11-07T05:31:56Z",
"customer": 123,
"product": 123
}
],
"payments": [
{
"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
}
],
"payment_journal_entries": [
123
],
"client_name": "<string>",
"client_email": "<string>",
"client_invoice_message": "<string>",
"client_use_stripe_auto_bill": true,
"status": "<string>",
"past_due_days": 123,
"entity_name": "<string>",
"entity_currency": "<string>",
"entity_invoice_message": "<string>",
"total_amount": 0,
"amount_paid": 0,
"amount_due": 123,
"contract_name": "<string>",
"attachments": [
{
"id": 123,
"customer": 123,
"created_at": "2023-11-07T05:31:56Z",
"created_by": 123,
"created_by_name": "<string>",
"created_by_email": "<string>",
"last_modified_at": "2023-11-07T05:31:56Z",
"name": "<string>",
"url": "<string>",
"s3_content_type": "<string>",
"s3_content_length": 1073741823,
"s3_path": "<string>",
"object_id": 1073741823,
"app": "<string>",
"model": "<string>"
}
],
"invoice_number": "<string>",
"stripe_connection_name": "<string>",
"stripe_connection_entity": 123,
"stripe_connection_billing_portal_enabled": true,
"avalara_connection_name": "<string>",
"avalara_connection_company": "<string>",
"tax_rate_name": "<string>",
"tax_rate_value": 0,
"revenue_transactions": [
123
],
"item_date": "2023-12-25",
"voided_journal_entry_order": "<string>",
"search_vector": "<string>",
"search_text": "<string>",
"auto_send_invoice": true,
"auto_send_invoice_at": "2023-12-25",
"auto_sent_at": "2023-12-25",
"reminder_sent_dates": "<any>",
"billing_address": "<string>",
"shipping_address": "<string>",
"terms": "net_7",
"ref_number": "<string>",
"purchase_order_number": "<string>",
"invoice_date": "2023-12-25",
"due_date": "2023-12-25",
"shipping_date": "2023-12-25",
"paid_date": "2023-12-25",
"uncollectible_date": "2023-12-25",
"sent_date": "2023-12-25",
"period_start": "2023-12-25",
"period_end": "2023-12-25",
"location_of_sale": "<string>",
"message_on_invoice": "<string>",
"payment_status": "open",
"warning_message": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"last_modified_at": "2023-11-07T05:31:56Z",
"currency": "<string>",
"exchange_rate": 0,
"exchange_rate_book": 0,
"last_sent_at": "2023-11-07T05:31:56Z",
"integration_id": "<string>",
"integration_context": "<any>",
"vat_number": "<string>",
"use_stripe_auto_bill": true,
"stripe_payment_link_id": "<string>",
"stripe_payment_intent_id": "<string>",
"stripe_invoice_id": "<string>",
"stripe_pdf_url": "<string>",
"stripe_payment_link": "<string>",
"source": "<string>",
"source_id": "<string>",
"voided_date": "2023-12-25",
"customer": 123,
"entity": 123,
"client": 123,
"bad_debt_journal_entry": 123,
"journal_entry": 123,
"contract": 123,
"avalara_connection": 123,
"sphere_connection": 123,
"anrok_connection": 123,
"tax_rate": 123,
"stripe_connection": 123,
"source_file": 123,
"voided_journal_entry": 123
}
Void an existing invoice.
This creates a reversing journal entry to void the invoice by reversing all debit and credit amounts. The invoice status will be updated to reflect the void.
curl --request POST \
--url https://api.meetcampfire.com/coa/api/v1/invoice/{invoice_id}/void/ \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
"void_date": "2023-12-25"
}'
{
"id": 123,
"lines": [
{
"id": 123,
"product_name": "<string>",
"stripe_product_id": "<string>",
"product_is_taxable": true,
"anrok_item_id": "<string>",
"service_date": "2023-12-25",
"description": "<string>",
"quantity": 123,
"rate": 123,
"currency": "<string>",
"amount": 0,
"tax": 0,
"tax_description": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"last_modified_at": "2023-11-07T05:31:56Z",
"customer": 123,
"product": 123
}
],
"payments": [
{
"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
}
],
"payment_journal_entries": [
123
],
"client_name": "<string>",
"client_email": "<string>",
"client_invoice_message": "<string>",
"client_use_stripe_auto_bill": true,
"status": "<string>",
"past_due_days": 123,
"entity_name": "<string>",
"entity_currency": "<string>",
"entity_invoice_message": "<string>",
"total_amount": 0,
"amount_paid": 0,
"amount_due": 123,
"contract_name": "<string>",
"attachments": [
{
"id": 123,
"customer": 123,
"created_at": "2023-11-07T05:31:56Z",
"created_by": 123,
"created_by_name": "<string>",
"created_by_email": "<string>",
"last_modified_at": "2023-11-07T05:31:56Z",
"name": "<string>",
"url": "<string>",
"s3_content_type": "<string>",
"s3_content_length": 1073741823,
"s3_path": "<string>",
"object_id": 1073741823,
"app": "<string>",
"model": "<string>"
}
],
"invoice_number": "<string>",
"stripe_connection_name": "<string>",
"stripe_connection_entity": 123,
"stripe_connection_billing_portal_enabled": true,
"avalara_connection_name": "<string>",
"avalara_connection_company": "<string>",
"tax_rate_name": "<string>",
"tax_rate_value": 0,
"revenue_transactions": [
123
],
"item_date": "2023-12-25",
"voided_journal_entry_order": "<string>",
"search_vector": "<string>",
"search_text": "<string>",
"auto_send_invoice": true,
"auto_send_invoice_at": "2023-12-25",
"auto_sent_at": "2023-12-25",
"reminder_sent_dates": "<any>",
"billing_address": "<string>",
"shipping_address": "<string>",
"terms": "net_7",
"ref_number": "<string>",
"purchase_order_number": "<string>",
"invoice_date": "2023-12-25",
"due_date": "2023-12-25",
"shipping_date": "2023-12-25",
"paid_date": "2023-12-25",
"uncollectible_date": "2023-12-25",
"sent_date": "2023-12-25",
"period_start": "2023-12-25",
"period_end": "2023-12-25",
"location_of_sale": "<string>",
"message_on_invoice": "<string>",
"payment_status": "open",
"warning_message": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"last_modified_at": "2023-11-07T05:31:56Z",
"currency": "<string>",
"exchange_rate": 0,
"exchange_rate_book": 0,
"last_sent_at": "2023-11-07T05:31:56Z",
"integration_id": "<string>",
"integration_context": "<any>",
"vat_number": "<string>",
"use_stripe_auto_bill": true,
"stripe_payment_link_id": "<string>",
"stripe_payment_intent_id": "<string>",
"stripe_invoice_id": "<string>",
"stripe_pdf_url": "<string>",
"stripe_payment_link": "<string>",
"source": "<string>",
"source_id": "<string>",
"voided_date": "2023-12-25",
"customer": 123,
"entity": 123,
"client": 123,
"bad_debt_journal_entry": 123,
"journal_entry": 123,
"contract": 123,
"avalara_connection": 123,
"sphere_connection": 123,
"anrok_connection": 123,
"tax_rate": 123,
"stripe_connection": 123,
"source_file": 123,
"voided_journal_entry": 123
}
Token-based authentication with required prefix "Token"
ID of the invoice to void
The response is of type object
.