> ## Documentation Index > Fetch the complete documentation index at: https://docs.getsales.io/llms.txt > Use this file to discover all available pages before exploring further. # Search credit ledger entries > Paid-call receipts - append-only: one row per billable waterfall step (failed paid steps too) with cost, tool, run/step, cell coordinates, spender. Use for: receipts of a run/cell/day/actor, "why was this cell charged twice". Requires a scope: playtable_sid/run_sid/object_sid/playtable_field_sid/created_at.gte/sid.in (else 422). Local mirror - the gtm-api ledger is authoritative billing; receipts hard-purge after 12 months. Spend totals → the metrics tool (counts here = call counts). Contract: - MCP tool `search_credit_ledger_entries`, registry package `mcp.playtables/credit_ledger_entries`, mount `id.billing`. - Operation `search`, response envelope `search`. - Flags: read only. ## OpenAPI ````yaml /api-reference/playtables/openapi.yaml post /api/credit-ledger-entries/search openapi: 3.0.3 info: title: 'GetSales public contract: gs.service.playtables' description: >- The data platform and the outreach engine: tables of people and companies, their enrichment columns, cells and runs, the data sources that feed them, sender profiles, the stoplist, the activity feed, the credit ledger, and the multichannel workflows with their per-person journeys and tasks. GENERATED. This document is projected from the Zod MCP tool registry in `product/mcp/gs.mcp` (one tool per public endpoint, 1:1). Do not edit it by hand; edit the tool definition and regenerate with `pnpm openapi:public`. Surface: the public `/api` contract of `gs.service.playtables`, 142 operations. This is the only OpenAPI document the platform publishes. Internal (`/internal`) and health endpoints are deliberately absent: they are not part of any contract, they can change without notice, and the service source is their only description. Conventions: - Auth is a bearer JWT, optionally narrowed by the `Team-SID` header. - Every success body is an MCP envelope: `success: true` plus one typed `operation` shape (`search`, `get`, `create`, `update`, `delete`, `metrics`, `group_by`, `action`), and a `meta` block with `trace_id` for support. - Every failure is the same `McpError` envelope with a code from a fixed 16-code taxonomy, so a client maps errors once. - Lists page with `page_size` (0 to 500, default 50) plus an opaque forward `cursor`; `page_size: 0` returns counts only. - On `GET` and `DELETE`, object-valued query parameters (`filter`, `sort`) travel as JSON text and array-valued ones repeat as `name[]=value`. - The MCP-only `_meta` field (usage analytics) never reaches the backend and is not part of this contract. version: '1.0' contact: name: GetSales url: https://getsales.io email: support@getsales.io license: name: Proprietary url: https://getsales.io/terms servers: - url: https://beta.getsales.io/playtables/v1 description: >- Production (the gateway path on the beta ring; the origin is provisioned per DEPLOY_MAP.md) security: - BearerJwt: [] TeamSid: [] tags: - name: activities description: >- Registry package `mcp.playtables/activities`, served on MCP mount `playtables.journeys`. - name: activity_objects description: >- Registry package `mcp.playtables/activity_objects`, served on MCP mount `playtables.people`. - name: companies description: >- Registry package `mcp.playtables/companies`, served on MCP mount `playtables.people`. - name: credit_ledger_entries description: >- Registry package `mcp.playtables/credit_ledger_entries`, served on MCP mount `id.billing`. - name: data_source_items description: >- Registry package `mcp.playtables/data_source_items`, served on MCP mount `playtables.sources`. - name: data_sources description: >- Registry package `mcp.playtables/data_sources`, served on MCP mount `playtables.sources`. - name: notes description: >- Registry package `mcp.playtables/notes`, served on MCP mount `playtables.pipeline`. - name: people description: >- Registry package `mcp.playtables/people`, served on MCP mount `playtables.people`. - name: pipeline_stages description: >- Registry package `mcp.playtables/pipeline_stages`, served on MCP mount `playtables.pipeline`. - name: plays description: >- Registry package `mcp.playtables/plays`, served on MCP mount `playtables.pipeline`. - name: playtable_field_values description: >- Registry package `mcp.playtables/playtable_field_values`, served on MCP mount `playtables.columns`. - name: playtable_fields description: >- Registry package `mcp.playtables/playtable_fields`, served on MCP mount `playtables.columns`. - name: playtable_runs description: >- Registry package `mcp.playtables/playtable_runs`, served on MCP mount `playtables.columns`. - name: playtable_views description: >- Registry package `mcp.playtables/playtable_views`, served on MCP mount `playtables.tables`. - name: playtables description: >- Registry package `mcp.playtables/playtables`, served on MCP mount `playtables.tables`. - name: result_pages description: >- Registry package `mcp.playtables/result_pages`, served on MCP mount `playtables.tables`. - name: sender_profiles description: >- Registry package `mcp.playtables/sender_profiles`, served on MCP mount `playtables.sources`. - name: stoplist_entries description: >- Registry package `mcp.playtables/stoplist_entries`, served on MCP mount `playtables.stoplist`. - name: tags description: >- Registry package `mcp.playtables/tags`, served on MCP mount `playtables.pipeline`. - name: workflow_attachments description: >- Registry package `mcp.playtables/workflow_attachments`, served on MCP mount `playtables.workflows`. - name: workflow_records description: >- Registry package `mcp.playtables/workflow_records`, served on MCP mount `playtables.journeys`. - name: workflow_sources description: >- Registry package `mcp.playtables/workflow_sources`, served on MCP mount `playtables.workflows`. - name: workflow_tasks description: >- Registry package `mcp.playtables/workflow_tasks`, served on MCP mount `playtables.journeys`. - name: workflow_versions description: >- Registry package `mcp.playtables/workflow_versions`, served on MCP mount `playtables.workflows`. - name: workflows description: >- Registry package `mcp.playtables/workflows`, served on MCP mount `playtables.workflows`. paths: /api/credit-ledger-entries/search: post: tags: - credit_ledger_entries summary: Search credit ledger entries description: >- Paid-call receipts - append-only: one row per billable waterfall step (failed paid steps too) with cost, tool, run/step, cell coordinates, spender. Use for: receipts of a run/cell/day/actor, "why was this cell charged twice". Requires a scope: playtable_sid/run_sid/object_sid/playtable_field_sid/created_at.gte/sid.in (else 422). Local mirror - the gtm-api ledger is authoritative billing; receipts hard-purge after 12 months. Spend totals → the metrics tool (counts here = call counts). Contract: - MCP tool `search_credit_ledger_entries`, registry package `mcp.playtables/credit_ledger_entries`, mount `id.billing`. - Operation `search`, response envelope `search`. - Flags: read only. operationId: search_credit_ledger_entries requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/SearchCreditLedgerEntriesRequest' responses: '200': description: '`search` success envelope.' content: application/json: schema: $ref: '#/components/schemas/SearchCreditLedgerEntriesResponse' 4XX: $ref: '#/components/responses/McpClientError' 5XX: $ref: '#/components/responses/McpServerError' components: schemas: SearchCreditLedgerEntriesRequest: type: object description: Request body of `search_credit_ledger_entries`. properties: filter: type: object properties: sid: type: object properties: eq: type: string minLength: 18 maxLength: 18 pattern: ^cl_en_ description: Credit ledger entry (receipt) sid (cl_en_…). in: type: array items: type: string minLength: 18 maxLength: 18 pattern: ^cl_en_ description: Credit ledger entry (receipt) sid (cl_en_…). additionalProperties: false description: Receipt sid(s), cl_en_ prefix (prefix-validated). playtable_sid: type: object properties: eq: type: string minLength: 18 maxLength: 18 pattern: ^pt_tb_ in: type: array items: type: string minLength: 18 maxLength: 18 pattern: ^pt_tb_ additionalProperties: false description: Per-table spend scope (pt_tb_…). object_type: type: object properties: eq: type: string enum: - people - company additionalProperties: false description: 'Residual inside scope: people | company.' object_sid: type: object properties: eq: type: string in: type: array items: type: string additionalProperties: false description: >- cr_pp_… / cr_co_… (mixed prefixes - not prefix-pinned); cell drill-down with playtable_field_sid. playtable_field_sid: type: object properties: eq: type: string minLength: 18 maxLength: 18 pattern: ^pt_fd_ in: type: array items: type: string minLength: 18 maxLength: 18 pattern: ^pt_fd_ additionalProperties: false description: Per-field spend scope (pt_fd_…). run_sid: type: object properties: eq: type: string minLength: 18 maxLength: 18 pattern: ^pt_rn_ in: type: array items: type: string minLength: 18 maxLength: 18 pattern: ^pt_rn_ is_null: type: boolean additionalProperties: false description: >- What a run cost (pt_rn_…); is_null:true = non-run spend (empty in v1 - the cell-waterfall writer always carries a run). tool_sid: type: object properties: eq: type: string maxLength: 64 in: type: array items: type: string maxLength: 64 additionalProperties: false description: Spend through one gtm-api tool (external sid, opaque). created_by_actor_sid: type: object properties: eq: type: string additionalProperties: false description: >- "What did this person spend" - projected from created_by.actor_sid. idempotency_key: type: object properties: eq: type: string maxLength: 128 additionalProperties: false description: 'Support/debug: locate one exact charge.' created_at: type: object properties: gte: type: string lte: type: string gt: type: string lt: type: string additionalProperties: false description: >- ISO 8601 range - day windows; combine bounds in one object. Ignored on metrics - period owns the window. description: >- Field filters, ANDed: {field: {eq | ne | in | nin | gte | lte | gt | lt | is_null}}; q inside it is free text. Omit for every row. include: type: array items: type: string enum: - field description: Relations to attach to every item; omit for the bare rows. sort: type: object properties: field: type: string enum: - created_at - cost description: The column to order by. direction: type: string enum: - asc - desc description: asc or desc; default desc. required: - field description: One column and its direction; omit for the default order. page_size: type: integer minimum: 0 maximum: 500 description: 0..500, default 50; 0 = counts only, 1 = the first row. cursor: type: string nullable: true description: pagination.next_cursor of the previous page. SearchCreditLedgerEntriesResponse: type: object properties: success: type: boolean enum: - true operation: type: string enum: - search items: type: array items: type: object properties: item: type: object properties: sid: type: string description: Receipt sid (cl_en_…). team_sid: type: string description: Owning team (ts_tm_…, external - gs.service.id). playtable_sid: type: string nullable: true description: >- pt_tb_… table context - see ./playtables.md; audit ref, may dangle after table delete. object_type: type: string nullable: true enum: - people - company description: >- Kind of the enriched row: people | company; null when the receipt has no cell context. object_sid: type: string nullable: true description: >- cr_pp_… / cr_co_… enriched row (polymorphic by object_type) - audit ref, may dangle. playtable_field_sid: type: string nullable: true description: >- pt_fd_… field whose waterfall spent - see ./playtable_fields.md; audit ref, may dangle. run_sid: type: string nullable: true description: >- pt_rn_… run that dispatched the step; outlives the run's 90-day purge as an opaque audit ref. step_index: type: integer nullable: true minimum: 0 description: >- Position in the materialized waterfall; matches the cell's meta.steps[step_index]. tool_sid: type: string description: gtm-api tool executed (external registry sid, max 64). provider_sid: type: string nullable: true description: >- Serving provider when gtm-api resolved one; display-only - presets hide provider chains. cost: type: number minimum: 0 exclusiveMinimum: true description: >- Credits this step charged (decimal(12,4), > 0 - zero-cost steps never receipt). idempotency_key: type: string description: >- Per-step dedup axis (max 128, DB UNIQUE) shared with the gtm-api call and the tool-result callback. created_by: type: object properties: actor_type: type: string enum: - user - support - api_key - system - agent actor_sid: type: string nullable: true team_sid: type: string actor_name: type: string nullable: true description: >- The OAuth client that acted ("Claude", "n8n"); null for a user, an API key or a system job. oauth_client_sid: type: string nullable: true description: >- The acting OAuth client (id_oc_*); null off the OAuth path. reason: type: string nullable: true description: >- Why a system actor wrote the row (snapshot_capture_job, ...); null otherwise. permissions: type: object additionalProperties: {} description: >- Internal audit context: the grant set the actor held at write time. Not a contract. cluster_id: type: integer nullable: true description: >- Internal audit context: the cluster that served the write. trace_id: type: string nullable: true description: >- Internal audit context: the trace id of the request that wrote the row. required: - actor_type - actor_sid - team_sid - permissions description: >- Spend attribution - the run initiator on whose behalf the worker spent (denormalized from the run at record time), NOT the row writer. created_at: type: string description: >- ISO 8601 UTC - the receipt clock and metrics period column. required: - sid - team_sid - playtable_sid - object_type - object_sid - playtable_field_sid - run_sid - step_index - tool_sid - provider_sid - cost - idempotency_key - created_by - created_at included: type: object properties: field: type: object properties: sid: type: string name: type: string slug: type: string category: type: string type: type: string required: - sid - name - slug - category - type description: >- 1:1 field whose waterfall spent (include[]=field): name/slug/preset for receipt display; hydrates soft-deleted fields too (audit context); absent when the field row is gone. required: - item - included pagination: type: object properties: next_cursor: type: string nullable: true has_more: type: boolean total_count: type: integer nullable: true required: - next_cursor - has_more - total_count applied_filters: type: object additionalProperties: {} includes: type: array items: type: string meta: type: object properties: trace_id: type: string description: UUID v7; same 128-bit value as the X-Trace-Id header. span_id: type: string pattern: ^[0-9a-f]{16}$ description: 16 hex chars, root span of this request. timestamp: type: string description: ISO 8601 UTC (Y-m-dTH:i:sZ), response time. duration_ms: type: integer minimum: 0 description: Server-side wall clock. team_sid: type: string nullable: true description: >- The team this call ran in (the token team, or the team_sid override). Null when unauthenticated; absent from pre-2026-08-20 backends. actor_type: type: string nullable: true description: >- user | agent | api_key | system. Null when unauthenticated; absent from pre-2026-08-20 backends. required: - trace_id - span_id - timestamp - duration_ms counts: type: object properties: total_count: type: integer minimum: 0 description: >- Receipts (paid calls) matching the filter - full filter scope, not the page. groups: type: object properties: playtable_sid: anyOf: - type: object additionalProperties: type: integer minimum: 0 - type: array items: {} description: 'Flat {pt_tb_ sid: call count} - which table is spending.' playtable_field_sid: anyOf: - type: object additionalProperties: type: integer minimum: 0 - type: array items: {} description: 'Flat {pt_fd_ sid: call count} - call concentration by field.' tool_sid: anyOf: - type: object additionalProperties: type: integer minimum: 0 - type: array items: {} description: >- Flat {tool_sid: call count} - calls through each gtm-api tool. created_date: anyOf: - type: object additionalProperties: type: integer minimum: 0 - type: array items: {} description: >- Flat {'YYYY-MM-DD': call count} - calls per UTC day (≤ 366 values under 12-month retention). required: - playtable_sid - playtable_field_sid - tool_sid - created_date description: >- One axis per CreditLedgerEntryGroupableFieldsEnum value (§4.17). Values are CALL COUNTS - credit sums live in the metrics tool. PHP empty map serialises as []. required: - total_count - groups required: - success - operation - items - pagination - applied_filters - includes - meta McpError: type: object properties: success: type: boolean enum: - false error: type: object properties: code: type: string enum: - validation_failed - nothing_to_update - not_found - relation_not_found - invalid_transition - limit_exceeded - payment_required - duplicate_rejected - conflict - delete_blocked - unauthorized - forbidden - rate_limited - internal_error - service_unavailable - not_implemented message: type: string recoverable: type: boolean suggestion: type: string field_errors: type: object additionalProperties: type: array items: type: object properties: rule: type: string message: type: string required: - rule - message blockers: type: array items: type: object properties: type: type: string description: >- Machine-readable blocker type (active_flow, pending_tasks, …). severity: type: string enum: - hard - soft description: >- hard = external action required; soft = acknowledge is enough. description: type: string entity_sid: type: string nullable: true count: type: integer resolution: type: string description: 'Hard: tool name to call. Soft: code for acknowledge[].' resolution_hint: type: string required: - type - severity - description - entity_sid - resolution - resolution_hint context: type: object additionalProperties: {} required: - code - message - recoverable meta: type: object properties: trace_id: type: string description: UUID v7; same 128-bit value as the X-Trace-Id header. span_id: type: string pattern: ^[0-9a-f]{16}$ description: 16 hex chars, root span of this request. timestamp: type: string description: ISO 8601 UTC (Y-m-dTH:i:sZ), response time. duration_ms: type: integer minimum: 0 description: Server-side wall clock. team_sid: type: string nullable: true description: >- The team this call ran in (the token team, or the team_sid override). Null when unauthenticated; absent from pre-2026-08-20 backends. actor_type: type: string nullable: true description: >- user | agent | api_key | system. Null when unauthenticated; absent from pre-2026-08-20 backends. required: - trace_id - span_id - timestamp - duration_ms required: - success - error responses: McpClientError: description: >- MCP error envelope. `error.code` is one of validation_failed, nothing_to_update, not_found, relation_not_found, invalid_transition, limit_exceeded, payment_required, duplicate_rejected, conflict, delete_blocked, unauthorized, forbidden, rate_limited, not_implemented. content: application/json: schema: $ref: '#/components/schemas/McpError' McpServerError: description: >- MCP error envelope with `error.code` internal_error or service_unavailable. content: application/json: schema: $ref: '#/components/schemas/McpError' securitySchemes: BearerJwt: type: http scheme: bearer bearerFormat: JWT description: >- Access token issued by gs.service.id. Its `access_identity` claim carries `team_sid`, `actor_sid` and `actor_type`, and that team scope is authoritative. TeamSid: type: apiKey in: header name: Team-SID description: >- Team scope for tokens that do not carry one. Ignored when the token already names a team. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.