Void Credit Memo

Void an existing credit memo.

This creates a reversing journal entry to void the credit memo by reversing all debit and credit amounts. The credit memo status will be updated to reflect the void.

POST /coa/api/v1/credit-memo/{credit_memo_id}/void

Void Credit Memo

cURL

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

200

{
  "id": 123,
  "lines": [
    {
      "id": 123,
      "account_number": "<string>",
      "account_name": "<string>",
      "product_name": "<string>",
      "anrok_item_id": "<string>",
      "department_name": "<string>",
      "tags": [
        {
          "id": 123,
          "group_name": "<string>",
          "parent_name": "<string>",
          "is_deleted": false,
          "deleted_at": "2023-11-07T05:31:56Z",
          "name": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "last_modified_at": "2023-11-07T05:31:56Z",
          "customer": 123,
          "parent": 123,
          "is_active": true,
          "group": 123
        }
      ],
      "tax_rate_name": "<string>",
      "tax_rate_value": 0,
      "created_at": "2023-11-07T05:31:56Z",
      "last_modified_at": "2023-11-07T05:31:56Z",
      "customer": 123,
      "account": 123,
      "description": "<string>",
      "amount": 0,
      "tax": 0,
      "tax_description": "<string>",
      "tag_ids": [
        0
      ],
      "tag_group_ids": [
        0
      ],
      "product": 123,
      "tax_rate": 123,
      "department": 123
    }
  ],
  "payments": [
    {
      "id": 123,
      "payment_journal_entry_order": "<string>",
      "voided_journal_entry_order": "<string>",
      "invoice": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "last_modified_at": "2023-11-07T05:31:56Z",
      "customer": 123,
      "credit_memo": 123,
      "payment_journal_entry": 123,
      "currency": "<string>",
      "amount": 0,
      "payment_date": "2023-12-25",
      "voided_date": "2023-12-25",
      "payment_transaction": 123,
      "voided_journal_entry": 123
    }
  ],
  "amount_remaining": 123,
  "entity_name": "<string>",
  "entity_currency": "<string>",
  "client_name": "<string>",
  "client_email": "<string>",
  "contract_name": "<string>",
  "credit_account_number": "<string>",
  "credit_account_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_path": "<string>",
      "app": "<string>",
      "model": "<string>",
      "is_deleted": false,
      "deleted_at": "2023-11-07T05:31:56Z",
      "s3_content_type": "<string>",
      "s3_content_length": 1073741823,
      "object_id": 1073741823
    }
  ],
  "voided_date": "2023-12-25",
  "voided_journal_entry_order": "<string>",
  "last_modified_at": "2023-11-07T05:31:56Z",
  "is_deleted": false,
  "deleted_at": "2023-11-07T05:31:56Z",
  "search_vector": "<string>",
  "search_text": "<string>",
  "credit_memo_date": "2023-12-25",
  "created_at": "2023-11-07T05:31:56Z",
  "customer": 123,
  "entity": 123,
  "credit_memo_number": "<string>",
  "ref_number": "<string>",
  "applied_date": "2023-12-25",
  "message_on_credit_memo": "<string>",
  "currency": "<string>",
  "exchange_rate": 0,
  "exchange_rate_book": 0,
  "last_sent_at": "2023-11-07T05:31:56Z",
  "anrok_transaction_id": "<string>",
  "integration_id": "<string>",
  "integration_context": null,
  "vat_number": "<string>",
  "total_amount": 0,
  "amount_used": 0,
  "chat_id": -1,
  "client": 123,
  "credit_account": 123,
  "journal_entry": 123,
  "contract": 123,
  "voided_journal_entry": 123,
  "anrok_connection": 123,
  "avalara_connection": 123,
  "sphere_connection": 123
}

Authorizations

Authorization · string · header · required

Token-based authentication with required prefix "Token"

Path Parameters

credit_memo_id · integer · required

ID of the credit memo to void

Body

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

void_date · string<date> · required

Response

200 - application/json

id · integer · required · read-only

lines · object[] · required

Show child attributes

payments · object[] · required · read-only

Show child attributes

amount_remaining · number<double> · required · read-only

Calculate amount remaining from database fields

entity_name · string · required · read-only

entity_currency · string · required · read-only

client_name · string · required · read-only

client_email · string · required · read-only

contract_name · string · required · read-only

credit_account_number · string · required · read-only

credit_account_name · string | null · required · read-only

Combines account number and name in the format "number - name"

attachments · object[] · required · read-only

Show child attributes

voided_date · string<date> · required · read-only

voided_journal_entry_order · string · required · read-only

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

is_deleted · boolean · default: false · required · read-only

deleted_at · string<date-time> | null · required · read-only

search_vector · string | null · required · read-only

search_text · string | null · required · read-only

credit_memo_date · string<date> · required

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

customer · integer · required · read-only

entity · integer · required

credit_memo_number · string

credit_memo_type · enum<string>

• credit_memo - Credit Memo
• overpayment - Overpayment

Available options: credit_memo, overpayment

ref_number · string | null

Maximum string length: 120

applied_date · string<date> | null

message_on_credit_memo · string | null

application_status · Option 1 · enum<string> Option 2 · enum<string> Option 3 · any

• open - Open
• partially_used - Partially Used
• used - Used
• voided - Voided

Available options: open, partially_used, used, voided

currency · string

Maximum string length: 3

exchange_rate · number<double> | null

Required range: -100000000000000 < x < 100000000000000

exchange_rate_book · number<double> | null

Required range: -100000000000000 < x < 100000000000000

last_sent_at · string<date-time> | null

anrok_transaction_id · string | null

ID of the negation transaction in Anrok for this credit memo

Maximum string length: 255

integration_id · string | null

Maximum string length: 250

integration_context · unknown

vat_number · string | null

Maximum string length: 250

total_amount · number<double>

Sum of all line item amounts

Required range: -1000000000000000000 < x < 1000000000000000000

amount_used · number<double>

Sum of all non-voided payment amounts

Required range: -1000000000000000000 < x < 1000000000000000000

chat_id · integer | null

Required range: -2147483648 <= x <= 2147483647

client · integer | null

credit_account · integer | null

journal_entry · integer | null

contract · integer | null

voided_journal_entry · integer | null

anrok_connection · integer | null

avalara_connection · integer | null

sphere_connection · integer | null