addedInput schema / properties / as_of_date
Added value: +{
+ "description": "UTC date for days-overdue filters. Defaults to today and is fixed across continuation pages.",
+ "format": "date",
+ "type": "string"
+}
addedInput schema / properties / case_status
Added value: +{
+ "description": "Exact case-workflow status, including for invoice searches.",
+ "enum": [
+ "active",
+ "paused",
+ "promised",
+ "disputed",
+ "closed"
+ ],
+ "type": "string"
+}
addedInput schema / properties / currency
Added value: +{
+ "description": "ISO currency. Required with amount bounds; no currency conversion.",
+ "pattern": "^[A-Z]{3}$",
+ "type": "string"
+}
addedInput schema / properties / cursor
Added value: +{
+ "description": "next_cursor from the preceding page. Repeat the same filters; changed data requires restarting.",
+ "maxLength": 2048,
+ "type": "string"
+}
addedInput schema / properties / customer_id
Added value: +{
+ "description": "Exact SHVL customer ID.",
+ "maxLength": 120,
+ "type": "string"
+}
addedInput schema / properties / due_from
Added value: +{
+ "description": "Inclusive due date; cases use oldest overdue invoice date.",
+ "format": "date",
+ "type": "string"
+}
addedInput schema / properties / due_to
Added value: +{
+ "format": "date",
+ "type": "string"
+}
addedInput schema / properties / exclude_case_statuses
Added value: +{
+ "description": "Exclude these case-workflow statuses, including when searching invoices.",
+ "items": {
+ "enum": [
+ "active",
+ "paused",
+ "promised",
+ "disputed",
+ "closed"
+ ],
+ "type": "string"
+ },
+ "maxItems": 5,
+ "type": "array",
+ "uniqueItems": true
+}
addedInput schema / properties / exclude_statuses
Added value: +{
+ "description": "Statuses to exclude. Invoice searches use invoice status; cases and contacts use case status.",
+ "items": {
+ "enum": [
+ "authorised",
+ "overdue",
+ "paid",
+ "voided",
+ "deleted"
+ ],
+ "type": "string"
+ },
+ "maxItems": 10,
+ "type": "array",
+ "uniqueItems": true
+}
addedInput schema / properties / max_amount_minor
Added value: +{
+ "description": "Inclusive outstanding amount maximum in the selected currency.",
+ "minimum": 0,
+ "type": "integer"
+}
addedInput schema / properties / max_days_overdue
Added value: +{
+ "minimum": 0,
+ "type": "integer"
+}
addedInput schema / properties / min_amount_minor
Added value: +{
+ "description": "Inclusive outstanding amount minimum in the selected currency; cases use overdue balance.",
+ "minimum": 0,
+ "type": "integer"
+}
addedInput schema / properties / min_days_overdue
Added value: +{
+ "minimum": 0,
+ "type": "integer"
+}
addedInput schema / properties / promise_from
Added value: +{
+ "description": "Inclusive recorded payment-promise date; excludes cases without a promise.",
+ "format": "date",
+ "type": "string"
+}
addedInput schema / properties / promise_to
Added value: +{
+ "format": "date",
+ "type": "string"
+}
addedInput schema / properties / readiness_status
Added value: +{
+ "description": "Exact payment-readiness state of the associated case.",
+ "enum": [
+ "unchecked",
+ "ready",
+ "missing_reference",
+ "missing_evidence",
+ "portal_not_submitted",
+ "receipt_unconfirmed",
+ "waiting_approval",
+ "wrong_contact",
+ "query_open"
+ ],
+ "type": "string"
+}
addedOutput schema / properties / applied_filters
Added value: +{
+ "additionalProperties": false,
+ "properties": {
+ "as_of_date": {
+ "description": "UTC date for days-overdue filters. Defaults to today and is fixed across continuation pages.",
+ "format": "date",
+ "type": "string"
+ },
+ "case_status": {
+ "description": "Exact case-workflow status, including for invoice searches.",
+ "enum": [
+ "active",
+ "paused",
+ "promised",
+ "disputed",
+ "closed"
+ ],
+ "type": "string"
+ },
+ "currency": {
+ "description": "ISO currency. Required with amount bounds; no currency conversion.",
+ "pattern": "^[A-Z]{3}$",
+ "type": "string"
+ },
+ "customer_id": {
+ "description": "Exact SHVL customer ID.",
+ "maxLength": 120,
+ "type": "string"
+ },
+ "due_from": {
+ "description": "Inclusive due date; cases use oldest overdue invoice date.",
+ "format": "date",
+ "type": "string"
+ },
+ "due_to": {
+ "format": "date",
+ "type": "string"
+ },
+ "exclude_case_statuses": {
+ "description": "Exclude these case-workflow statuses, including when searching invoices.",
+ "items": {
+ "enum": [
+ "active",
+ "paused",
+ "promised",
+ "disputed",
+ "closed"
+ ],
+ "type": "string"
+ },
+ "maxItems": 5,
+ "type": "array",
+ "uniqueItems": true
+ },
+ "exclude_statuses": {
+ "description": "Statuses to exclude. Invoice searches use invoice status; cases and contacts use case status.",
+ "items": {
+ "type": "string"
+ },
+ "maxItems": 10,
+ "type": "array",
+ "uniqueItems": true
+ },
+ "max_amount_minor": {
+ "description": "Inclusive outstanding amount maximum in the selected currency.",
+ "minimum": 0,
+ "type": "integer"
+ },
+ "max_days_overdue": {
+ "minimum": 0,
+ "type": "integer"
+ },
+ "min_amount_minor": {
+ "description": "Inclusive outstanding amount minimum in the selected currency; cases use overdue balance.",
+ "minimum": 0,
+ "type": "integer"
+ },
+ "min_days_overdue": {
+ "minimum": 0,
+ "type": "integer"
+ },
+ "promise_from": {
+ "description": "Inclusive recorded payment-promise date; excludes cases without a promise.",
+ "format": "date",
+ "type": "string"
+ },
+ "promise_to": {
+ "format": "date",
+ "type": "string"
+ },
+ "readiness_status": {
+ "description": "Exact payment-readiness state of the associated case.",
+ "enum": [
+ "unchecked",
+ "ready",
+ "missing_reference",
+ "missing_evidence",
+ "portal_not_submitted",
+ "receipt_unconfirmed",
+ "waiting_approval",
+ "wrong_contact",
+ "query_open"
+ ],
+ "type": "string"
+ }
+ },
+ "type": "object"
+}
addedOutput schema / properties / as_of_date
Added value: +{
+ "format": "date",
+ "type": "string"
+}
addedOutput schema / properties / has_more
Added value: +{
+ "type": "boolean"
+}
addedOutput schema / properties / next_cursor
Added value: +{
+ "type": [
+ "string",
+ "null"
+ ]
+}
addedOutput schema / properties / returned_count
Added value: +{
+ "type": "integer"
+}
addedOutput schema / properties / total_count
Added value: +{
+ "description": "All matches after filters, before paging.",
+ "type": "integer"
+}
changedOutput schema / required
Previous value: -[
- "data_notice",
- "organisation",
- "source",
- "filters",
- "invoice_count",
- "invoices"
-]New value: +[
+ "data_notice",
+ "organisation",
+ "source",
+ "filters",
+ "invoice_count",
+ "invoices",
+ "applied_filters",
+ "total_count",
+ "returned_count",
+ "has_more",
+ "next_cursor",
+ "as_of_date"
+]