> ## Documentation Index > Fetch the complete documentation index at: https://docs.famulor.io/llms.txt > Use this file to discover all available pages before exploring further. # Get reseller financial overview or activity > Read the payment-account readiness, settlement balances, customer payments, bank payout history balance transactions or tax registration details for the credential’s own Whitelabel workspace. Requires owner or admin authority, Whitelabel access, API Access and billing:read. Financial data is returned only after payments and payouts are enabled and account verification is complete. Amounts are in settlement or transaction currency minor units, without display-currency conversion. Provider IDs, metadata, customer personal data, bank details, fee breakdowns and session secrets are excluded. This operation never moves funds. ## OpenAPI ````yaml /api-reference/openapi.json get /reseller/billing openapi: 3.1.0 info: title: Famulor API version: 1.0.0 description: >- REST API for Famulor. Authenticate with an API key (`fam_...`, created under **Settings → API Keys**) or an OAuth 2.0 access token (`fam_at_...`) as a Bearer token. Every response uses a consistent envelope: `{ "data": ... , "meta": { ... } }` on success and `{ "error": { "code", "message" } }` on failure. List endpoints paginate with `?limit=` (default 50, max 200) and `?offset=`; `meta.pagination.total` carries the total match count. REST operations require API Access through the workspace plan or a recurring add-on. Without it, regular operations return `403 api_access_required`. The invoice-payment and billing-portal operations remain available with a valid `billing:write` credential after a failed plan payment so an authorized owner, admin, or billing member can recover billing. The same customer-facing capabilities are available as MCP tools at `https://app.famulor.io/mcp` (Model Context Protocol, streamable HTTP) using the same credentials, scopes, and workspace access. MCP availability is controlled separately by Connect AI / MCP, not by API Access. servers: - url: https://app.famulor.io/api/v1 description: Hosted platform. - url: https://{domain}/api/v1 description: White-label tenant domain — same paths, tenant branding. variables: domain: default: app.famulor.io description: Your white-label tenant domain. security: - bearerAuth: [] tags: - name: Account description: Self-inspection of the calling credential. - name: Migrations description: Preview and import data from supported legacy platforms. - name: Assistants description: Create and manage voice assistants. - name: Tools description: >- Reusable tools (HTTP APIs and external MCP servers) assistants can call mid-conversation. - name: Voices description: Browse the text-to-speech voice library. - name: Calls description: Start outbound calls and read call history, transcripts and recordings. - name: History description: Unified conversation history across calls, messaging and assistant emails. - name: Campaigns description: Outbound calling campaigns with a compliant power dialer. - name: Leads description: Manage Audience contacts across campaigns, channels and Call QA metrics. - name: Segments description: >- Saved, dynamic lead filters — reusable audience definitions used for Audience search and campaign lead assignment. - name: Suppression description: Cross-channel marketing opt-outs and active workspace suppression records. - name: Callbacks description: >- Scheduled callbacks booked by the Schedule callback tool across voice, chat, and email. - name: Phone Numbers description: Marketplace numbers and customer-provided numbers. - name: Famulor Loop description: >- Personal business-phone access, directory, presence, devices, and Loop call recents. - name: SIP Trunks description: Bring your own SIP provider and numbers. - name: Carrier Connections description: Connect a supported carrier account and import its existing phone numbers. - name: Knowledge Bases description: RAG knowledge bases and documents for assistants. - name: Settings description: Workspace-level settings such as caller-memory defaults. - name: Billing description: Balance and minutes ledger of the key owner. - name: Automations description: >- Native workspace automations — list, create, update, trigger. Plan gate: automation_platform. - name: Milian Missions description: Recurring jobs that Milian runs unattended on schedule. - name: Integrations description: >- Calendar integrations (Cal.com, Calendly, Acuity Scheduling, Google Calendar, Outlook, native booking engine). Assign them to assistants to provide availability and booking tools, plus provider-supported appointment lookup, cancellation, and rescheduling. - name: Bookings description: >- Native booking engine — event types with weekly availability, public booking pages at /book/{workspace}/{slug}, and the bookings they produce. - name: Dashboards description: >- Custom analytics dashboards, reusable widgets, and tenant-scoped performance analytics. Requires the custom_dashboards plan feature. - name: Catalog description: >- Read-only platform catalogs — available models, supported assistant languages, and prompt templates. - name: Simulations description: Assistant simulation tests (plan-gated). - name: Versions description: Assistant configuration version history. - name: Caller IDs description: Outbound caller ID verification. - name: Widgets description: Web widget connectors. - name: Messaging description: >- Telegram, Slack, and Messenger text bots linked to assistants (Chat SDK). Includes conversation delay, inactivity end, and conversation-ended webhooks. - name: QA description: Cohort AI Quality Assurance runs over call transcripts. - name: White Label description: >- Manage white-label customer accounts, defaults, credit transfers and customer plan offers. Each endpoint documents its required scope and workspace eligibility. - name: API Keys description: >- Self-service API keys for the calling workspace or a same-brand workspace where the credential's user is owner/admin. A key can only mint further keys with a scope subset of its own. - name: Workspaces description: >- List visible workspaces, create an additional workspace for the key owner, and mint a dedicated credential for a selected owner/admin workspace. - name: SMS description: Outbound SMS from workspace phone numbers. paths: /reseller/billing: get: tags: - White Label summary: Get reseller financial overview or activity description: >- Read the payment-account readiness, settlement balances, customer payments, bank payout history balance transactions or tax registration details for the credential’s own Whitelabel workspace. Requires owner or admin authority, Whitelabel access, API Access and billing:read. Financial data is returned only after payments and payouts are enabled and account verification is complete. Amounts are in settlement or transaction currency minor units, without display-currency conversion. Provider IDs, metadata, customer personal data, bank details, fee breakdowns and session secrets are excluded. This operation never moves funds. operationId: getResellerBilling parameters: - name: view in: query schema: type: string enum: - overview - payments - payouts - transactions - tax default: overview description: >- Choose account overview, payments, payouts, balance transactions or tax registrations. - name: limit in: query description: Activity page size. schema: type: integer minimum: 1 maximum: 100 default: 25 - name: cursor in: query description: Opaque next_cursor from the preceding page for the same view. schema: type: string maxLength: 2048 responses: '200': description: >- Read-only overview or financial activity. Before activation the overview has empty balances. content: application/json: schema: type: object properties: data: oneOf: - type: object required: - connected - state - payments_enabled - payouts_enabled - balances properties: connected: type: boolean state: type: string enum: - not_connected - incomplete - in_review - action_required - ready payments_enabled: type: boolean payouts_enabled: type: boolean balances: type: array items: type: object required: - currency - available_minor - pending_minor properties: currency: type: string example: EUR available_minor: type: integer pending_minor: type: integer - type: object required: - view - items - next_cursor properties: view: type: string enum: - payments - payouts - transactions items: type: array items: type: object required: - amount_minor - currency - status - created_at properties: amount_minor: type: integer currency: type: string status: type: string created_at: type: string format: date-time received_minor: type: integer description: Amount received for a payment. arrival_date: type: string format: date description: Expected bank arrival date for a payout. net_minor: type: integer description: >- Net change in settlement minor units (transactions view). category: type: string description: >- Public transaction category (transactions view). available_on: type: string format: date description: >- Date the funds become available (transactions view). next_cursor: type: string nullable: true description: >- Opaque next-page cursor, valid for 24 hours for this account and view. Null ends pagination. - type: object required: - view - status - origin_country - registrations - next_cursor properties: view: type: string enum: - tax status: type: string enum: - active - pending origin_country: type: string nullable: true description: Business country code; addresses are excluded. registrations: type: array items: type: object required: - country - region - status - active_from - expires_at - registration_ref properties: country: type: string region: type: string nullable: true status: type: string enum: - active - scheduled - expired active_from: type: string format: date-time expires_at: type: string format: date-time nullable: true registration_ref: type: string description: >- Opaque account-bound reference valid for 24 hours. Refresh this view before updating an expired reference. next_cursor: type: string nullable: true '400': description: Invalid query or expired cursor. '401': description: Authentication required. '403': description: Required scope, role or Whitelabel access missing. '409': description: Payment account is not active for financial activity. '502': description: Payment account data temporarily unavailable. '503': description: Payment service temporarily unavailable. security: - bearerAuth: [] components: securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: API key description: >- API key (`fam_...`, created under **Settings → API Keys**) or an OAuth 2.0 access token (`fam_at_...`). REST operations also require API Access for the credential's workspace. Keys can be restricted to scopes such as `assistants:read`, `calls:write`, `campaigns:write`, `automations:read`, `dashboards:read`, `dashboards:write`, `leads:write`, `segments:write`, `loop:read`, `loop:write`, `phone_numbers:write`, `sip_trunks:write`, `knowledge:write`, `voices:read`, `billing:read`, `billing:write`, `settings:write`, `platform:read`, `platform:write`; a `*:write` scope implies the matching `*:read`. Automation and dashboard endpoints also accept the legacy `calls:*` scope. Keys without scope restrictions have full access within the workspace's available capabilities. ````