# Tools · Finance

> MCP tools for the community's money: sales summary, customers, statement, balance, payouts and the fee simulation, and requesting or canceling payouts, with confirmation.

The community's cash: how much it sold, who pays, the statement, the available balance, payouts, and how much is left from a sale. Requesting or canceling a payout asks for your yes, with a summary. In amounts, only the platform fee shows up.

Each tool carries a badge: <span class="tool-kind tool-kind-read">Read-only</span> changes nothing, <span class="tool-kind tool-kind-write">Changes</span> creates or changes something right away, and <span class="tool-kind tool-kind-confirm">Asks to confirm</span> only acts after your yes to a summary. See [Money and confirmation](/mcp/dinheiro-e-confirmacao).

## In short

| Tool | What it does | Minimum role | Type |
|---|---|---|---|
| [`get_sales_summary`](#get-sales-summary) | Revenue, monthly series, revenue by product and subscribers | Admin or finance | <span class="tool-kind tool-kind-read">Read-only</span> |
| [`list_customers`](#list-customers) | Who pays and how much they've paid | Admin or finance | <span class="tool-kind tool-kind-read">Read-only</span> |
| [`list_ledger_entries`](#list-ledger-entries) | Statement entries | Admin or finance | <span class="tool-kind tool-kind-read">Read-only</span> |
| [`get_balance`](#get-balance) | Total, available, held and pending balance | Admin or finance | <span class="tool-kind tool-kind-read">Read-only</span> |
| [`list_payouts`](#list-payouts) | Payouts and their status | Admin or finance | <span class="tool-kind tool-kind-read">Read-only</span> |
| [`simulate_fee`](#simulate-fee) | How much the community receives from a sale | Admin | <span class="tool-kind tool-kind-read">Read-only</span> |
| [`request_payout`](#request-payout) | Requests a payout, with confirmation | Admin | <span class="tool-kind tool-kind-confirm">Asks to confirm</span> |
| [`cancel_payout`](#cancel-payout) | Cancels a pending payout, with confirmation | Admin | <span class="tool-kind tool-kind-confirm">Asks to confirm</span> |

## `get_sales_summary`

<span class="tool-kind tool-kind-read">Read-only</span>

**Sales summary.** Revenue and subscribers for a period. *Minimum role: admin or finance.*

| Parameter | Type | Required | Description |
|---|---|---|---|
| `period` | `7d`, `30d`, `90d`, `1y`, `custom` | No | The period |
| `start_date` | ISO 8601 date | No | With `period: custom` |
| `end_date` | ISO 8601 date | No | With `period: custom` |

**Returns:** the period's revenue, the month-by-month series, revenue by product, and active, past-due and canceled subscribers. For amounts, only the platform fee appears.

**Ask like this:** *"Chart the revenue for the last 12 months."* · *"Which product sold the most this quarter?"*

## `list_customers`

<span class="tool-kind tool-kind-read">Read-only</span>

**Who pays and how much they've paid.** Paying customers and the total each one has paid. *Minimum role: admin or finance.*

| Parameter | Type | Required | Description |
|---|---|---|---|
| `page`, `limit` | number | No | Pagination |

**Returns:** the customers, with name, email and total paid.

**Ask like this:** *"Who are the 10 customers who've paid the most?"*

## `list_ledger_entries`

<span class="tool-kind tool-kind-read">Read-only</span>

**Statement.** The statement entries, newest first. *Minimum role: admin or finance.*

| Parameter | Type | Required | Description |
|---|---|---|---|
| `entry_type` | text | No | One entry type: `SALE_GROSS`, `SALE_NET`, `PLATFORM_FEE`, `INSTALLMENT_INTEREST`, `REFUND`, `CHARGEBACK`, `PAYOUT_REQUESTED`… |
| `page`, `limit` | number | No | Pagination |

**Returns:** the entries, with date, type, description and amount. See [Balance and statement](/pagamentos/saldo-e-extrato).

**Ask like this:** *"What refunds were there this month?"*

## `get_balance`

<span class="tool-kind tool-kind-read">Read-only</span>

**Balance.** The community's balance. *Minimum role: admin or finance.*

Parameters: none.

**Returns:** the total balance, what's available for payout, what's held, and what's still to be released.

**Ask like this:** *"How much can I withdraw today?"*

## `list_payouts`

<span class="tool-kind tool-kind-read">Read-only</span>

**Payouts.** The payouts requested, with status. *Minimum role: admin or finance.*

| Parameter | Type | Required | Description |
|---|---|---|---|
| `status` | `PENDING`, `PROCESSING`, `COMPLETED`, `FAILED`, `CANCELED` | No | Only one status |
| `page`, `limit` | number | No | Pagination |

**Returns:** the payouts, with id (which `cancel_payout` needs), amount, fee, status and dates.

**Ask like this:** *"Did any payout fail?"*

## `simulate_fee`

<span class="tool-kind tool-kind-read">Read-only</span>

**How much I receive from a sale.** Simulates a sale: the amount, the platform fee and what the community receives. *Minimum role: admin.*

| Parameter | Type | Required | Description |
|---|---|---|---|
| `amount` | number | Yes | The sale amount, in reais |
| `payment_method` | `PIX`, `CREDIT_CARD`, `BOLETO` | No | The payment method |
| `installments` | number | No | Number of card installments |

**Returns:** the amount, the platform fee (which doesn't depend on the payment method) and the net. See [Platform fee](/pagamentos/taxa-da-plataforma).

**Ask like this:** *"If I sell a R$ 297 course, how much does the community keep?"*

## `request_payout`

<span class="tool-kind tool-kind-confirm">Asks to confirm</span>

**Request payout.** Requests a payout from the available balance to the registered bank account. *Minimum role: admin; finance can only read.*

| Parameter | Type | Required | Description |
|---|---|---|---|
| `amount` | number, in reais | Yes | Up to the available balance (check with `get_balance`) |

**The summary:** the action, the amount and the current balance.

**Ask like this:** *"How much do I have available? Withdraw R$ 2,000."*

**Notes:** the R$ 3.67 fee per payout and the rules are the same as in the dashboard. See [Payouts](/pagamentos/saque).

## `cancel_payout`

<span class="tool-kind tool-kind-confirm">Asks to confirm</span>

**Cancel payout.** Cancels a payout that is still pending. *Minimum role: admin.*

| Parameter | Type | Required | Description |
|---|---|---|---|
| `payout_id` | id | Yes | From `list_payouts` |

**The summary:** the action, the amount, the status and the request date.

**Ask like this:** *"Cancel the R$ 2,000 payout I requested today."*

## What doesn't exist

There is no **refund** tool: it stays in the dashboard. See [Common problems](/mcp/problemas-comuns#what-it-can-t-do-yet).

## Related

- [Tools](/mcp/ferramentas)
- [Recipes](/mcp/receitas)
- [Money and confirmation](/mcp/dinheiro-e-confirmacao)