Skip to main content
GET
/
coa
/
api
/
v1
/
credit-memo
List Credit Memos
curl --request GET \
  --url https://api.meetcampfire.com/coa/api/v1/credit-memo \
  --header 'Authorization: <api-key>'
{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  "results": [
    {
      "count": 150,
      "next": "http://api.example.com/credit-memos/?limit=20&offset=20",
      "previous": null,
      "results": [
        {
          "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": [],
          "total_amount": 1000.23,
          "amount_used": 0,
          "amount_remaining": 1000.23,
          "entity_name": "Top Level",
          "entity_currency": "USD",
          "client_name": "Client A",
          "credit_account_name": "5230 - Cloud Credits",
          "attachments": [],
          "credit_memo_number": "CM-0000008",
          "voided_date": null,
          "ref_number": null,
          "credit_memo_date": "2025-07-01",
          "applied_date": null,
          "message_on_credit_memo": "Credit memo for annual subscription overpayment. Thank you for your business.",
          "application_status": "open",
          "currency": "USD",
          "exchange_rate": 1,
          "exchange_rate_book": 1,
          "created_at": "2025-07-25T21:04:38+0000",
          "last_modified_at": "2025-07-25T21:04:38+0000",
          "customer": 2,
          "entity": 54,
          "client": 33973,
          "credit_account": 41905,
          "journal_entry": 7491953,
          "contract": null,
          "voided_journal_entry": null
        }
      ]
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Token-based authentication with required prefix "Token"

Query Parameters

​
client
integer[]

Filter by client IDs (can specify multiple)

​
contract
integer[]

Filter by contract IDs (can specify multiple)

​
end_date
string

Filter credit memos created on or before this date (YYYY-MM-DD format)

​
entity
integer[]

Filter by entity IDs (can specify multiple)

​
limit
integer

Number of results to return per page

​
offset
integer

Number of results to skip for pagination

​
q
string

Search credit memo numbers, messages, and client names

​
sort
enum<string>

Sort results by field (prefix with - for descending)

Available options:
-amount_used,
-client_name,
-credit_memo_date,
-total_amount,
amount_used,
client_name,
credit_memo_date,
total_amount
​
start_date
string

Filter credit memos created on or after this date (YYYY-MM-DD format)

​
status
enum<string>

Filter by application status

Available options:
open,
partially_used,
used,
voided

Response

200 - application/json
​
count
integer
required
Example:

123

​
results
object[]
required
​
next
string<uri> | null
Example:

"http://api.example.org/accounts/?offset=400&limit=100"

​
previous
string<uri> | null
Example:

"http://api.example.org/accounts/?offset=200&limit=100"

⌘I