Raw schema
{
"type": "object",
"properties": {
"state": {
"description": "Only invoices in this state.",
"type": "string",
"enum": [
"draft",
"approved",
"voided"
]
},
"contact_id": {
"type": "string",
"pattern": "^[A-Za-z0-9_-]{1,64}$",
"description": "Only invoices of this contact (from billy_list_contacts)."
},
"invoice_no": {
"description": "Exact invoice number.",
"type": "string",
"minLength": 1,
"maxLength": 50
},
"is_paid": {
"description": "true = only paid invoices, false = only unpaid.",
"type": "boolean"
},
"min_entry_date": {
"description": "Invoice date on or after (yyyy-mm-dd).",
"type": "string"
},
"max_entry_date": {
"description": "Invoice date on or before (yyyy-mm-dd).",
"type": "string"
},
"min_due_date": {
"description": "Due date on or after (yyyy-mm-dd).",
"type": "string"
},
"max_due_date": {
"description": "Due date on or before (yyyy-mm-dd); with is_paid=false this finds overdue invoices.",
"type": "string"
},
"entry_date_period": {
"type": "string",
"pattern": "^[A-Za-z0-9:.,-]{1,80}$",
"description": "Date period: all, year:2026, month:2026-03, quarter:2026-2, dates:2026-01-01...2026-01-31 ..."
},
"q": {
"description": "Free-text search over invoice number, order number, contact name, line description, amount.",
"type": "string",
"minLength": 1,
"maxLength": 100
},
"sort_property": {
"description": "Sort by (default entryDate).",
"type": "string",
"enum": [
"entryDate",
"dueDate",
"createdTime",
"invoiceNo",
"amount",
"balance",
"contact.name",
"approvedTime"
]
},
"sort_direction": {
"description": "Sort direction (default ASC).",
"type": "string",
"enum": [
"ASC",
"DESC"
]
},
"page": {
"description": "Page number, 1-based (default 1). Use next_page from the previous reply.",
"type": "integer",
"minimum": 1,
"maximum": 100000
},
"page_size": {
"description": "Records per page, 1-200 (default 50).",
"type": "integer",
"minimum": 1,
"maximum": 200
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}