Semantics
Read-only. Returns each invoice with id, number, status, amount, currency, due_date, contact summary. Used to find overdue/unpaid invoices or to enumerate by criteria without already knowing the invoice number.
Invariants
- Pure read. No state change.
- Ordered by due_date asc by default.
When to use
When the user asks "which invoices are unpaid?" or "show me overdue invoices" or before `get_invoice` when the number isn't known.
Input schema
{
"type": "object",
"properties": {
"limit": {
"type": "number",
"maximum": 100,
"minimum": 1
},
"status_in": {
"type": "array",
"items": {
"enum": [
"draft",
"issued",
"paid",
"overdue",
"cancelled"
],
"type": "string"
}
},
"agent_vendor": {
"type": "string"
},
"contact_email": {
"type": "string",
"format": "email",
"description": "Optional. Filter to invoices issued to this contact."
}
},
"additionalProperties": false
}Output schema
{
"type": "object",
"required": [
"ok"
],
"properties": {
"ok": {
"type": "boolean"
},
"error": {
"type": "string"
},
"invoices": {
"type": "array",
"items": {
"type": "object",
"properties": {
"amount": {
"type": "number"
},
"due_at": {
"type": "string",
"format": "date-time"
},
"status": {
"type": "string"
},
"currency": {
"type": "string"
},
"invoice_id": {
"type": "string"
},
"contact_name": {
"type": "string"
},
"contact_email": {
"type": "string"
},
"invoice_number": {
"type": "string"
}
}
}
}
}
}