ReportParamsInput
input type
THE CATALOGUE PARAMETERS (THE REPORTS PROGRAM slice — R-110; one field per kind, a report declares which it takes): period — a preset (today · yesterday · this_week · last_week · this_month · last_month · this_quarter · year_to_date) or YYYY-MM-DD..YYYY-MM-DD (inclusive UTC days, at most 366); lens — an organization of your group; person — me or a user id; record — the ledger owner's id (a till session · an inventory item · a house account · a loyalty member · a gift card · an affiliate); axis — an axis word or id; status — a state word of the report's family; option — a yes/no switch; facility — ONE active facility of your group (stock on hand · shrink — the design). A field the report does not declare refuses VALIDATION/INVALID naming the legal ones. nextToken — the page cursor a partial answer handed back; every report takes it, opaque and tenant-bound. A cursor never saves: createReport refuses it.
Fields
| Field | Type | Required | Notes |
|---|---|---|---|
period | String | no | No further notes. |
lens | ID | no | No further notes. |
person | ID | no | No further notes. |
record | ID | no | No further notes. |
axis | String | no | No further notes. |
status | String | no | No further notes. |
option | Boolean | no | No further notes. |
facility | ID | no | No further notes. |
nextToken | String | no | No further notes. |