--- title: "List Credit Memos" method: GET path: "/coa/api/v1/credit-memo" tags: ["Accounts Receivable"] --- # List Credit Memos `GET /coa/api/v1/credit-memo` Retrieves a paginated list of accounting credit memos with comprehensive filtering and sorting capabilities. This endpoint provides a powerful interface for browsing and searching credit memos with: - Advanced filtering by date ranges, status, clients, entities, and contracts - Full-text search across credit memo numbers, messages, and client names - Flexible sorting by multiple fields including amounts and relationships - Optimized performance with efficient database queries and pagination - Complete credit memo details including line items, payment status, and accounting relationships **Key Features:** - Date range filtering for credit memo creation and application dates - Status-based filtering (open, partially_used, used, voided) - Client and entity-based filtering with hierarchical client support - Contract association filtering for revenue recognition workflows - Full-text search capabilities across key fields **Query Parameters:** - `start_date`, `end_date`: Filter by credit memo date range - `status`: Filter by application status (open, partially_used, used, voided) - `q`: Full-text search across credit memo number, message, and client name - `client`: Filter by specific client IDs (supports multiple values) - `entity`: Filter by specific entity IDs (supports multiple values) - `contract`: Filter by specific contract IDs (supports multiple values) - `sort`: Sort by various fields (credit_memo_date, client_name, total_amount, etc.) - `limit`, `offset`: Pagination controls for large result sets ## Query parameters - `client` integer[] - `contract` integer[] - `end_date` string - `entity` integer[] - `limit` integer - `offset` integer - `q` string - `sort` '-amount_used' | '-client_name' | '-credit_memo_date' | '-credit_memo_number' | '-total_amount' | 'amount_used' | 'client_name' | 'credit_memo_date' | 'credit_memo_number' | 'total_amount' - `start_date` string - `status` 'open' | 'partially_used' | 'used' | 'voided' ## Response `200` - PaginatedAccountingCreditMemoList - `count` integer, required - `next` string, uri, nullable - `previous` string, uri, nullable - `results` AccountingCreditMemo[], required - `id` integer, required - `lines` AccountingCreditMemoLine[], required - `id` integer, required - `credit_memo` integer - `account_number` string, required - `account_name` string, nullable, required — Combines account number and name in the format "number - name" - `product_name` string, required - `anrok_item_id` string, required - `department_name` string, required - `tags` object[], required - `tax_rate_name` string, required - `tax_rate_value` number, double, required - `description` string, nullable - `amount` number, double - `tax` number, double - `tax_description` string, nullable - `tag_ids` integer[] - `tag_group_ids` integer[] - `created_at` string, date-time, required - `last_modified_at` string, date-time, required - `customer` integer, required - `product` integer, nullable - `account` integer, required - `tax_rate` integer, nullable - `department` integer, nullable - `payments` AccountingCreditMemoPayment[], required - `id` integer, required - `payment_journal_entry_order` string, required - `voided_journal_entry_order` string, nullable, required - `invoice` string, required - `currency` string - `amount` number, double - `payment_date` string, date, nullable - `created_at` string, date-time, required - `last_modified_at` string, date-time, required - `voided_date` string, date, nullable - `customer` integer, required - `credit_memo` integer, required - `payment_journal_entry` integer, required - `payment_transaction` integer, nullable - `voided_journal_entry` integer, nullable - `amount_remaining` number, double, required — Calculate amount remaining from database fields - `entity_name` string, required - `entity_currency` string, required - `client_name` string, required - `client_email` string, required - `contract_name` string, required - `credit_account_number` string, required - `credit_account_name` string, nullable, required — Combines account number and name in the format "number - name" - `attachments` File[], required - `id` integer, required - `customer` integer, required - `created_at` string, date-time, required - `created_by` integer, nullable, required - `created_by_name` string, required - `created_by_email` string, required - `last_modified_at` string, date-time, required - `name` string, required - `url` string, required - `s3_content_type` string, nullable - `s3_content_length` integer, nullable - `s3_path` string, required - `object_id` integer, nullable - `app` string, required - `model` string, required - `is_deleted` boolean, required - `deleted_at` string, date-time, nullable, required - `credit_memo_number` string - `migrated_journal_id` integer, nullable - `voided_date` string, date, required - `voided_journal_entry_order` string, required - `last_modified_at` string, date-time, required - `is_deleted` boolean, required - `deleted_at` string, date-time, nullable, required - `chat_uuid` string, uuid - `search_vector` string, nullable, required - `search_text` string, nullable, required - `credit_memo_type` 'credit_memo' | 'overpayment' — * `credit_memo` - Credit Memo * `overpayment` - Overpayment - `ref_number` string, nullable - `credit_memo_date` string, date, required - `applied_date` string, date, nullable - `message_on_credit_memo` string, nullable - `application_status` union - 'open' | 'partially_used' | 'used' | 'voided' — * `open` - Open * `partially_used` - Partially Used * `used` - Used * `voided` - Voided - '' - unknown - `currency` string - `exchange_rate` number, double, nullable - `exchange_rate_book` number, double, nullable - `created_at` string, date-time, required - `last_sent_at` string, date-time, nullable - `anrok_transaction_id` string, nullable — ID of the negation transaction in Anrok for this credit memo - `integration_id` string, nullable - `integration_context` unknown - `vat_number` string, nullable - `total_amount` number, double — Sum of all line item amounts - `amount_used` number, double — Sum of all non-voided payment amounts - `chat_id` integer, nullable - `customer` integer, required - `entity` integer, required - `client` integer, nullable - `credit_account` integer, nullable - `journal_entry` integer, nullable - `contract` integer, nullable - `voided_journal_entry` integer, nullable - `anrok_connection` integer, nullable - `avalara_connection` integer, nullable - `sphere_connection` integer, nullable --- [API](https://skmtc.net/campfire/apis/campfire-developer-apis.md) · [All operations](https://skmtc.net/campfire/apis/campfire-developer-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/campfire/campfire-developer-apis/versions/6945ebc3180e/schema)