Skip to main content

MCP Tools Reference

The PayRequest Billing Server provides four tools for managing invoices through AI assistants.

get-invoice-stats

Get aggregated statistics about your invoices including totals, pending amounts, and overdue counts.

Parameters

This tool takes no parameters.

Example Usage

“What are my invoice statistics?”

Response

Response Fields


list-invoices

List invoices with optional filtering by status. Returns invoice details including customer information, amounts, and dates.

Parameters

string
Filter by invoice status. Options:
  • pending - Includes pending, sent, and viewed invoices
  • paid - Only paid invoices
  • canceled - Only canceled invoices
  • refunded - Only refunded invoices
integer
default:"20"
Maximum number of invoices to return (1-100)

Example Usage

“Show me all pending invoices”
“List my last 10 paid invoices”

Response


get-overdue-invoices

Get a list of all overdue invoices with customer details, amounts, and days overdue. Sorted by due date (oldest first).

Parameters

integer
default:"20"
Maximum number of overdue invoices to return (1-100)

Example Usage

“Which invoices are overdue?”
“Show me the 5 most overdue invoices”

Response

Use Cases

Ask: “What invoices are overdue?” to start your day with a clear picture of outstanding payments.
Ask: “Show me the 5 most overdue invoices” to focus on the oldest unpaid invoices first.
Ask: “How much revenue is tied up in overdue invoices?” to understand your cash flow impact.

send-invoice-reminder

Send a payment reminder email for a specific invoice. The reminder is sent to the customer’s email address and logged in your activity history.

Parameters

integer
The ID of the invoice to send a reminder for
string
The invoice number (e.g., “INV-2025-042”) to send a reminder for
Provide either invoice_id OR invoice_number, not both.

Example Usage

“Send a reminder for invoice INV-2025-042”
“Remind the customer about invoice 1234”

Response

Validation

The tool validates before sending:

Activity Logging

Each reminder sent via MCP is logged with:
  • Timestamp
  • Customer email
  • Days overdue at time of sending
  • Source marked as “MCP API”
You can view these in Activity Log → filter by “Invoice reminder sent”.

Error Handling

All tools return errors in a consistent format:

Common Errors


Workflow Examples

Morning Billing Review

Automated Follow-up

Customer Query