POST
/
coa
/
api
/
v1
/
credit-memo
/
{credit_memo_id}
/
void
/
Void Credit Memo
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"
}'
{
  "id": 123,
  "lines": [
    {
      "id": 123,
      "account_number": "<string>",
      "account_name": "<string>",
      "product_name": "<string>",
      "department_name": "<string>",
      "tags": [
        {
          "id": 123,
          "group_name": "<string>",
          "parent_name": "<string>",
          "parent": 123,
          "name": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "last_modified_at": "2023-11-07T05:31:56Z",
          "customer": 123,
          "group": 123
        }
      ],
      "description": "<string>",
      "amount": 0,
      "created_at": "2023-11-07T05:31:56Z",
      "last_modified_at": "2023-11-07T05:31:56Z",
      "customer": 123,
      "product": 123,
      "account": 123,
      "department": 123
    }
  ],
  "payments": [
    {
      "id": 123,
      "payment_journal_entry_order": "<string>",
      "invoice": "<string>",
      "currency": "<string>",
      "amount": 0,
      "payment_date": "2023-12-25",
      "created_at": "2023-11-07T05:31:56Z",
      "last_modified_at": "2023-11-07T05:31:56Z",
      "voided_date": "2023-12-25",
      "customer": 123,
      "credit_memo": 123,
      "payment_journal_entry": 123,
      "payment_transaction": 123,
      "voided_journal_entry": 123
    }
  ],
  "total_amount": "<string>",
  "amount_used": "<string>",
  "amount_remaining": "<string>",
  "entity_name": "<string>",
  "entity_currency": "<string>",
  "client_name": "<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_content_type": "<string>",
      "s3_content_length": 1073741823,
      "s3_path": "<string>",
      "object_id": 1073741823,
      "app": "<string>",
      "model": "<string>"
    }
  ],
  "credit_memo_number": "<string>",
  "voided_date": "2023-12-25",
  "voided_journal_entry_order": "<string>",
  "ref_number": "<string>",
  "credit_memo_date": "2023-12-25",
  "applied_date": "2023-12-25",
  "message_on_credit_memo": "<string>",
  "application_status": "open",
  "currency": "<string>",
  "exchange_rate": 0,
  "exchange_rate_book": 0,
  "created_at": "2023-11-07T05:31:56Z",
  "last_modified_at": "2023-11-07T05:31:56Z",
  "customer": 123,
  "entity": 123,
  "client": 123,
  "credit_account": 123,
  "journal_entry": 123,
  "contract": 123,
  "voided_journal_entry": 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

Response

200 - application/json

The response is of type object.