Sign in

v1

latestOpenAPI 3.0.32026-07-26362271803.3 KB
Accounts Receivable

List Credit Memos

    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
get/coa/api/v1/credit-memo

Query parameters

clientinteger[]

Filter by client IDs (can specify multiple)

contractinteger[]

Filter by contract IDs (can specify multiple)

end_datestring

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

entityinteger[]

Filter by entity IDs (can specify multiple)

limitinteger

Number of results to return per page

offsetinteger

Number of results to skip for pagination

qstring

Search credit memo numbers, messages, and client names

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'

Sort results by field (prefix with - for descending)

start_datestring

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

status'open' | 'partially_used' | 'used' | 'voided'

Filter by application status

Response

countinteger required
nextstring uri nullable
previousstring uri nullable

Example response

{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100"
}