Raw schema
{
"type": "object",
"properties": {
"filters": {
"description": "Search filters as an object. Unknown keys are refused by Sellsy. Keys: status [\"draft\"|\"due\"|\"payinprogress\"|\"paid\"|\"late\"|\"cancelled\"], number (exact), currency, date {start,end} dates YYYY-MM-DD, created {start,end} ISO date-times, updated {start,end} ISO date-times, owners [staff ids], assigned_staff_ids [..], contacts [contact ids], related_objects [{type,id}] (type company|individual|opportunity), is_deposit (bool), is_progress_invoice (bool).",
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {}
},
"limit": {
"description": "Records per page, 1-100 (default 25).",
"type": "integer",
"minimum": 1,
"maximum": 100
},
"offset": {
"description": "Paging cursor. Leave out for the first page. If the previous reply's pagination.offset is a string, pass it back unchanged for the next page. Only a number sets numeric paging: then pass the previous offset plus limit (0, 25, 50, ... for limit 25) until count is below limit.",
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 500
},
{
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
]
},
"order": {
"description": "Sort field: id, number, created, date, amount, due_date.",
"type": "string",
"maxLength": 40,
"pattern": "^[a-z_]+$"
},
"direction": {
"description": "Sort direction (default asc).",
"type": "string",
"enum": [
"asc",
"desc"
]
},
"field": {
"description": "Only return these fields, e.g. [\"id\",\"name\"] or [\"address.id\"], to keep replies small.",
"maxItems": 40,
"type": "array",
"items": {
"type": "string",
"maxLength": 100,
"pattern": "^[A-Za-z0-9.\\[\\]_-]+$"
}
},
"embed": {
"description": "Related objects to include (each may need an extra scope and is null without it), e.g. [\"invoicing_address\",\"main_contact\",\"cf.1542\"].",
"maxItems": 20,
"type": "array",
"items": {
"type": "string",
"maxLength": 60,
"pattern": "^[a-z_]+$|^cf\\.\\d+$"
}
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}