Skip to main content
The invoices module provides tools to view client invoices, financial summaries, and transaction states.

Available Tools

list_invoices

List invoices issued to clients.
  • Type: Read-only
  • Important Input Fields:
    • clientId (string, optional): Filter invoices for a specific client.
    • status (string, optional): Filter by payment status (e.g. paid, open, overdue).
    • page (integer, optional): Page number.
    • limit (integer, optional): Items per page.

get_invoice

Retrieve detailed itemizations and status for an invoice.
  • Type: Read-only
  • Important Input Fields:
    • invoiceId (string, required): Unique identifier for the invoice.

summarize_invoices

Summarize invoice totals and collections statuses over a date range.
  • Type: Read-only
  • Important Input Fields:
    • dateFrom (string, required): Start date range filter.
    • dateTo (string, required): End date range filter.

create_client_invoice

Create a manual invoice or a standalone credit note for one member. Runs the same validation and side effects as the dashboard.
  • Type: Write (requires the tool in the grant’s write actions and userConfirmed: true)
  • Permission: finance.invoices.create with full member scope.
  • Important Input Fields:
    • clientId (string, required): The member.
    • invoiceType (string, required): invoice or creditnote.
    • paymentMethod (string, required): paymentLink (open invoice), cashOnhand (marked paid) or sepaIncasso (queues a direct debit; not allowed for credit notes).
    • sendMethod (string, required): self (no email) or email (emails the member).
    • items (array, required): 1-50 lines with name, price (VAT inclusive), quantity and optional vat percentage.
    • issueDate / dueDate (string, optional): YYYY-MM-DD.

credit_client_invoice

Create a full credit note for an existing member invoice and mark both as paid. Repeating the call returns the existing credit note.
  • Type: Write (requires the tool in the grant’s write actions and userConfirmed: true)
  • Permission: finance.invoices.credit with full scope.
  • Important Input Fields:
    • clientId (string, required): The invoice’s member.
    • invoiceId (string, required): The invoice to credit.
    • sendNotification (boolean, optional): Email the credit note to the member.

list_payment_requests

List payment requests (one-off payment links) with status open, paid, expired or cancelled. Filter by status or search on recipient or description.
  • Type: Read
  • Input Fields:
    • status (string, optional)
    • search (string, optional)
    • page (integer, optional)
    • limit (integer, optional)

create_payment_request Write

Create a one-off payment link for a member, like the dashboard payment request. amount is the total including VAT; vatPercentage defaults to the company setting. The member can pay via the returned publicUrl. Show the coach the member, amount and description, and get explicit confirmation first.
  • Type: Write (requires userConfirmed: true and the write-tool grant)
  • Input Fields:
    • clientId (string, required)
    • amount (number, required)
    • description (string, required)
    • vatPercentage (number, optional)
    • idempotencyKey (string, optional)

cancel_payment_request Write

Cancel one open payment request so its link can no longer be paid. Get explicit coach confirmation first.
  • Type: Write (requires userConfirmed: true and the write-tool grant)
  • Input Fields:
    • paymentRequestId (string, required)
    • idempotencyKey (string, optional)

list_transactions

List member payment transactions (memberships, products, payment links) with status, amount, product and linked invoice. Filter by status or search on member or product.
  • Type: Read
  • Input Fields:
    • status (string, optional)
    • search (string, optional)
    • page (integer, optional)
    • limit (integer, optional)

list_chargebacks

List direct debit chargebacks (reversed SEPA payments) with invoice, amount and resolution. chargebackStatus Open or Completed.
  • Type: Read
  • Input Fields:
    • chargebackStatus (string: Open, Completed, optional)
    • search (string, optional)
    • page (integer, optional)
    • limit (integer, optional)

update_chargeback_status Write

Set the follow-up status of up to 25 chargebacks to Completed (handled) or back to Open, like the dashboard bulk action. Get explicit coach confirmation first.
  • Type: Write (requires userConfirmed: true and the write-tool grant)
  • Input Fields:
    • chargebackIds (array, required)
    • status (string: Open, Completed, required)
    • idempotencyKey (string, optional)

Natural Language Examples

  • “List all overdue invoices in the last 30 days.”
  • “Retrieve details for invoice inv_9921.”

JSON-RPC Call Example (summarize_invoices)