> ## Documentation Index > Fetch the complete documentation index at: https://docs.arcuserp.com/llms.txt > Use this file to discover all available pages before exploring further. # List credit memos > List credit memos for the entity. Use `?account_id=` for account-scoped listing. Without `account_id`, returns entity-wide credit memos with cursor pagination. Returns the canonical Stripe-style list envelope (`object: list`, `data`, `has_more`, `next_cursor`). When `account_id` is supplied the response also includes top-level `credit_balance` (the account's total credit balance). Layer 1: entity_id from API key. ## OpenAPI ````yaml /openapi.yaml get /credits openapi: 3.1.0 info: title: Arcus ERP Public API version: 1.0.0 description: > Arcus ERP public REST API. Designed for external integrations and data migration. **Authentication.** Bearer token (API key) via the `Authorization` header. Format: `Authorization: Bearer ark_live_ent__` (or `ark_test_*` for sandbox). API keys are issued per-entity in **Settings > Developers > API Keys**. **Entity scoping.** The entity is encoded in the API key prefix; routes are flat (e.g. `/v1/accounts`, `/v1/orders`, `/v1/products`). A small set of platform endpoints (migration, reconciliation, events, webhook endpoints, API keys) use the `/v1/entities/{entity_id}/...` form -- those are noted in their tags. **Key capabilities.** - Related-resource hydration via `?expand[]=` (see `x-arcus-expand` on each resource). - Cursor-based pagination (`starting_after` / `ending_before` / `limit`). - Idempotency via the `Idempotency-Key` header. - Webhook events for asynchronous notification. - Conditional requests / ETag for cache validation. servers: - url: https://api.arcuserp.com/v1 description: Arcus ERP API (accepts both live `ark_live_*` and test `ark_test_*` keys) - url: https://dev-api.arcuserp.com/v1 description: >- Dev sandbox API (test-only data, accepts `ark_test_*` keys against dev RDS) security: [] paths: /credits: get: tags: - Payments summary: List credit memos description: > List credit memos for the entity. Use `?account_id=` for account-scoped listing. Without `account_id`, returns entity-wide credit memos with cursor pagination. Returns the canonical Stripe-style list envelope (`object: list`, `data`, `has_more`, `next_cursor`). When `account_id` is supplied the response also includes top-level `credit_balance` (the account's total credit balance). Layer 1: entity_id from API key. operationId: listCredits parameters: - name: account_id in: query schema: type: string format: uuid description: Filter to a specific account - name: limit in: query schema: type: integer minimum: 1 maximum: 500 default: 25 - name: starting_after in: query schema: type: string format: uuid description: >- Cursor for pagination (Stripe-style starting_after). Entity-wide list only. - name: expand[] in: query schema: type: array items: type: string enum: - data.account - data.source - data.applications style: form explode: true responses: '200': description: List of credit memos content: application/json: schema: type: object properties: object: type: string enum: - list data: type: array items: $ref: '#/components/schemas/CreditMemo' has_more: type: boolean next_cursor: type: string nullable: true url: type: string credit_balance: type: number description: Total credit balance (account-scoped only) '401': $ref: '#/components/responses/Error' '403': $ref: '#/components/responses/Error' security: - ApiKeyAuth: [] components: schemas: CreditMemo: type: object description: >- A customer credit issued (reduces account credit_balance or refunds a payment). properties: id: type: string format: uuid object: type: string enum: - credit_memo entity_id: type: string format: uuid readOnly: true account_id: type: string format: uuid credit_memo_number: type: string readOnly: true amount: type: number amount_applied: type: number readOnly: true amount_refunded: type: number readOnly: true reason: type: string enum: - return - write_off - goodwill - price_adjustment - duplicate_payment - other source_return_id: type: string format: uuid nullable: true source_order_id: type: string format: uuid nullable: true status: type: string enum: - issued - partially_applied - fully_applied - voided readOnly: true notes: type: string nullable: true issued_at: type: string format: date-time readOnly: true voided_at: type: string format: date-time nullable: true readOnly: true ErrorEnvelope: type: object description: | Canonical error response envelope. All API errors use this shape. required: - error - code properties: error: type: string description: Machine-readable error key example: not_found code: type: string description: Machine-readable error code (often same as error) example: not_found type: type: string enum: - validation_error - permission_error - not_found - conflict - rate_limit - internal - expand_error - not_implemented example: not_found hint: type: string description: Human-readable one-sentence explanation (English) example: >- The requested order does not exist or does not belong to this entity. param: type: string description: The parameter that caused the error, if applicable example: expand[0] required: type: string description: The scope required (only on insufficient_scope errors) example: accounts:read request_id: type: string description: >- Unique request ID for support tracing (maps to CloudWatch log stream) example: req_abc123 responses: Error: description: Error response (400/401/403/404/409/422/429/500) content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' securitySchemes: ApiKeyAuth: type: http scheme: bearer description: | API key issued per entity via Settings > Developers > API Keys. Each key carries scopes (e.g. orders:read, products:write). Bearer token format: Authorization: Bearer ark_live_ent__ Test keys use ark_test_ent__. Both are issued per entity via Settings > Developers > API Keys. ````