SalesReportSchemaDocument
/schema shape used by Product Sales and Payments. Sales Revenue and Profit & Loss use a different, flatter shape -- see their own components.{
"report": {
"key": "string",
"title": "string",
"page": "string",
"endpoint": "string",
"method": "GET"
},
"parameters": {
"property1": {
"type": "string",
"required": true,
"label": "string",
"format": "string",
"default": null,
"note": "string",
"sentinel": {
"property1": "string",
"property2": "string"
},
"options": [
{
"value": "string",
"label": "string",
"note": "string"
}
],
"options_by_report_type": {
"property1": [
{
"value": "string",
"label": "string",
"note": "string"
}
],
"property2": [
{
"value": "string",
"label": "string",
"note": "string"
}
]
}
},
"property2": {
"type": "string",
"required": true,
"label": "string",
"format": "string",
"default": null,
"note": "string",
"sentinel": {
"property1": "string",
"property2": "string"
},
"options": [
{
"value": "string",
"label": "string",
"note": "string"
}
],
"options_by_report_type": {
"property1": [
{
"value": "string",
"label": "string",
"note": "string"
}
],
"property2": [
{
"value": "string",
"label": "string",
"note": "string"
}
]
}
}
},
"columns": [
{
"key": "string",
"label": "string"
}
],
"notes": [
"string"
]
}