Raw schema
{
"type": "object",
"properties": {
"entityId": {
"description": "Filter by entity (payer or vendor) ID(s) or foreign ID(s).",
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"entityGroupId": {
"description": "Filter by entity group ID.",
"type": "string"
},
"status": {
"description": "Invoice status filter (e.g. DRAFT, NEW, APPROVED, SCHEDULED, PAID).",
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"payerId": {
"description": "Filter by payer ID(s) or foreign ID(s).",
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"vendorId": {
"description": "Filter by vendor ID(s) or foreign ID(s).",
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"invoiceId": {
"description": "Filter by invoice ID(s) or foreign ID(s).",
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"search": {
"description": "Search by vendor name, invoice number, check number, or amount.",
"type": "string"
},
"startDate": {
"description": "Start date filter (ISO 8601).",
"type": "string"
},
"endDate": {
"description": "End date filter (ISO 8601).",
"type": "string"
},
"dateType": {
"description": "Date type to filter by (e.g. CREATED_AT, DUE_DATE).",
"type": "string"
},
"orderBy": {
"description": "Field to order by (e.g. CREATED_AT, AMOUNT, DUE_DATE).",
"type": "string"
},
"orderDirection": {
"description": "asc or desc.",
"type": "string"
},
"paymentType": {
"description": "Filter by payment type (e.g. recurring).",
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"approverId": {
"description": "Filter by assigned approver user ID(s).",
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"approverAction": {
"description": "Filter by approver action (use with approverId), e.g. APPROVE.",
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"creatorUserId": {
"description": "Filter by the user ID(s) that created the invoice.",
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"invoiceTemplateId": {
"description": "Filter by invoice template ID(s).",
"anyOf": [
{
"type": "string"
},
{
"type": "array",
"items": {
"type": "string"
}
}
]
},
"returnPayerMetadata": {
"description": "Include payer metadata in the response.",
"type": "boolean"
},
"returnVendorMetadata": {
"description": "Include vendor metadata in the response.",
"type": "boolean"
},
"returnPaymentTiming": {
"description": "Include payment timing in the response.",
"type": "boolean"
},
"limit": {
"description": "Max invoices to return (1-100, default 10).",
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 100
},
"startingAfter": {
"description": "Invoice ID cursor for pagination.",
"type": "string"
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}