Skip to main content
GET
/
coa
/
api
/
v1
/
credit-memo
/
{id}
Retrieve Credit Memo
curl --request GET \
  --url https://api.meetcampfire.com/coa/api/v1/credit-memo/{id} \
  --header 'Authorization: <api-key>'
{
  "id": 4258,
  "lines": [
    {
      "id": 5449,
      "account_number": "4107",
      "account_name": "4107 - Subscription fees",
      "product_name": "Annual Subscription",
      "department_name": "Engineering",
      "tags": [
        {
          "id": 7736,
          "parent_name": null,
          "parent": null,
          "name": "Other",
          "created_at": "2025-06-18T21:09:34+0000",
          "last_modified_at": "2025-06-18T21:09:34+0000",
          "group": null
        }
      ],
      "description": "Credit for overpayment on annual subscription",
      "amount": 1000.23,
      "created_at": "2025-07-25T21:04:38+0000",
      "last_modified_at": "2025-07-25T21:04:38+0000",
      "product": 3679,
      "account": 169208,
      "department": 35
    }
  ],
  "payments": [
    {
      "id": 2205,
      "payment_journal_entry": 7495832,
      "payment_journal_entry_order": "JE-0007823",
      "payment_transaction": 19485762,
      "amount": 500,
      "payment_date": "2025-07-15",
      "created_at": "2025-07-15T14:30:22+0000",
      "last_modified_at": "2025-07-15T14:30:22+0000",
      "voided_date": null,
      "voided_journal_entry": null,
      "invoice": {
        "id": 47892,
        "invoice_number": "INV-0000512"
      }
    }
  ],
  "total_amount": 1000.23,
  "amount_used": 500,
  "amount_remaining": 500.23,
  "entity_name": "Top Level",
  "entity_currency": "USD",
  "client_name": "Client A",
  "contract_name": "Annual Service Agreement 2025",
  "credit_account_name": "5230 - Cloud Credits",
  "attachments": [
    {
      "id": 15643,
      "name": "credit_memo_supporting_docs.pdf",
      "file_size": 245760,
      "content_type": "application/pdf",
      "created_at": "2025-07-01T10:15:33+0000",
      "last_modified_at": "2025-07-01T10:15:33+0000"
    }
  ],
  "credit_memo_number": "CM-0000008",
  "voided_date": null,
  "voided_journal_entry_order": null,
  "ref_number": "REF-2025-0087",
  "credit_memo_date": "2025-07-01",
  "applied_date": "2025-07-15",
  "message_on_credit_memo": "Credit memo for annual subscription overpayment. Thank you for your business.",
  "application_status": "partially_used",
  "currency": "USD",
  "exchange_rate": 1,
  "exchange_rate_book": 1,
  "created_at": "2025-07-25T21:04:38+0000",
  "last_modified_at": "2025-07-15T14:30:22+0000",
  "customer": 2,
  "entity": 54,
  "client": 33973,
  "credit_account": 41905,
  "journal_entry": 7491953,
  "contract": 1892,
  "voided_journal_entry": null
}

Authorizations

​
Authorization
string
header
required

Token-based authentication with required prefix "Token"

Path Parameters

​
id
integer
required

Response

200 - application/json
​
id
integer
required
read-only
​
lines
object[]
required
​
payments
object[]
required
read-only
​
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
​
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
  • 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