veryfront__list_invoicesAccess
No external-service connection is required. Use a Veryfront credential with access to the requested resources. Call type: Read-only.Arguments
| Field | Type | Required | Description and constraints |
|---|---|---|---|
kind | string | No | Which invoices to list. “issued” (default) lists finalized invoices. “upcoming” lists the preview of each active subscription, then draft invoices. Default: "issued". Values: "issued", "upcoming". |
sort_by | string | No | Sort field of the returned page. Defaults to “date” for issued invoices. Pages follow Stripe order, newest first; sorting orders the returned page only. Default: "date". Values: "date", "amount", "status". |
sort_order | string | No | Sort order of the returned page. Defaults to “desc”. Default: "desc". Values: "asc", "desc". |
limit | integer | No | Maximum number of invoices to return, 1 to 100. Defaults to 20. Default: 20. Minimum: 1. Maximum: 100. |
cursor | string | No | Opaque cursor pointing at the next page. Omit it to read the first page. Minimum length: 1. |
Example request
Send this JSON-RPC request through an initialized MCP client. Replace sample identifiers and values before calling the tool. See MCP client setup.request.json
{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "veryfront__list_invoices",
"arguments": {}
}
}
Result
The published output shape is summarized below. Inspect both the MCP response content andisError when handling a call.
| Field | Type | Required | Description and constraints |
|---|---|---|---|
data | object[] | Yes | Primary result records returned by the tool. |
page_info | object | Yes | Pagination cursor values for traversing the result set. |
Full schemas
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"enum": [
"issued",
"upcoming"
],
"description": "Which invoices to list. \"issued\" (default) lists finalized invoices. \"upcoming\" lists the preview of each active subscription, then draft invoices.",
"default": "issued"
},
"sort_by": {
"type": "string",
"enum": [
"date",
"amount",
"status"
],
"description": "Sort field of the returned page. Defaults to \"date\" for issued invoices. Pages follow Stripe order, newest first; sorting orders the returned page only.",
"default": "date"
},
"sort_order": {
"type": "string",
"enum": [
"asc",
"desc"
],
"description": "Sort order of the returned page. Defaults to \"desc\".",
"default": "desc"
},
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 100,
"description": "Maximum number of invoices to return, 1 to 100. Defaults to 20.",
"default": 20
},
"cursor": {
"type": "string",
"minLength": 1,
"description": "Opaque cursor pointing at the next page. Omit it to read the first page."
}
},
"additionalProperties": false,
"description": "Arguments for the list_invoices tool.",
"$schema": "http://json-schema.org/draft-07/schema#"
}
{
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Unique identifier for the returned record."
},
"number": {
"type": [
"string",
"null"
]
},
"status": {
"type": [
"string",
"null"
],
"description": "Lifecycle status for the returned record."
},
"description": {
"type": [
"string",
"null"
],
"description": "Human-readable description returned by the tool."
},
"amount_due": {
"type": "number"
},
"amount_paid": {
"type": "number"
},
"amount_total": {
"type": "number"
},
"applied_balance_amount": {
"type": "number"
},
"proration_amount": {
"type": "number"
},
"recurring_amount": {
"type": "number"
},
"currency": {
"type": "string"
},
"issued_at": {
"type": "string"
},
"hosted_invoice_url": {
"anyOf": [
{
"type": "string",
"format": "uri"
},
{
"type": "null",
"description": "The hosted invoice url returned by the tool."
}
]
},
"pdf_url": {
"anyOf": [
{
"type": "string",
"format": "uri"
},
{
"type": "null",
"description": "The pdf url returned by the tool."
}
]
}
},
"required": [
"id",
"number",
"status",
"description",
"amount_due",
"amount_paid",
"currency",
"issued_at",
"hosted_invoice_url",
"pdf_url"
],
"additionalProperties": false
},
"description": "Primary result records returned by the tool."
},
"page_info": {
"type": "object",
"properties": {
"self": {
"type": [
"string",
"null"
],
"description": "Cursor that refers to the current page."
},
"first": {
"type": "null"
},
"next": {
"type": [
"string",
"null"
],
"description": "Cursor for the next page when pagination is available."
},
"prev": {
"type": [
"string",
"null"
],
"description": "Cursor for the previous page when pagination is available."
}
},
"required": [
"self",
"first",
"next",
"prev"
],
"additionalProperties": false,
"description": "Pagination cursor values for traversing the result set."
}
},
"required": [
"data",
"page_info"
],
"additionalProperties": false,
"description": "Structured result returned by the list_invoices tool.",
"$schema": "http://json-schema.org/draft-07/schema#"
}