@lotics/cli 0.321.15 → 0.321.17

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/src/cli.js CHANGED
@@ -1845,7 +1845,7 @@ async function saveSignedLinks(links, dir, timeoutMs) {
1845
1845
  }
1846
1846
 
1847
1847
  // src/version.ts
1848
- var VERSION = "0.321.15";
1848
+ var VERSION = "0.321.17";
1849
1849
 
1850
1850
  // src/timezone.ts
1851
1851
  function machineTimezone() {
@@ -1864,10 +1864,10 @@ import { spawn as spawn2 } from "node:child_process";
1864
1864
  var getting_started_default = '# Getting started\n\nA workspace is where one business keeps what it knows and does its daily work. **Records** are what it tracks, one table per kind of thing and one row per entry. **Apps** are the screens a team works in, one per main kind of record, each given to everyone who works its rows. **Documents** are the quotes, invoices and slips it sends, each a template filled from a record, or from the many rows of a period or a statement. A paper is the workspace\'s once it is made from a template or uploaded and filed on its record; a file left on the host\'s own disk, the user\'s included, reaches no one in the workspace. A procedure or policy no table holds is a **knowledge doc**; a price list, a customer list or the open orders are rows.\n\nOpen the one page for the job. Pages are read with the `docs` tool (`docs path="design"`; `lotics docs design` on the CLI).\n\n- **Build a workspace, or add an app:** `docs path="build"`. A bakery built call by call: tables with a check, the paper, the app, what the owner will ask an agent, the owner\'s rows, then pressing it.\n- **Which apps a business needs, and who gets each:** `docs path="app_architecture"`.\n- **Judge what you built:** `docs path="design/the-rubric"`. Six questions, each answered by a call.\n- **Change an app:** `docs path="reference/changing-an-app"`. `get_app`, then `set_app` with `nodes` and `base_version_id`. A table is changed with `get_table`, then `set_tables` with its `table_id` (`data_model`).\n- **Enforce a rule on a table:** `docs path="workflows/table-checks"`. A condition no create, update or delete may meet, whoever makes it, and the language it is written in.\n- **Make a document:** `docs path="document_templates"`. A template, its slots and loops, and the act that files it on a record.\n- **Enter data, count, answer a question:** `docs path="working_in_a_workspace"`. The right tool for each job; the value each field takes is `field_values`, choosing rows is `filters`.\n- **Rows owed on a weekly pattern (a diary every weekday, a class every Tuesday):** `docs path="reference/cadence"` for a table\'s `records.cadence`; the Act that `makes` them is `reference/act-node`.\n- **Rows an act proposes for a person to tick (a statement matched to the notes it pays):** the workflow body is `docs path="workflows/a-reviewed-act"`, calling the act is `agent_surface/a-reviewed-act`.\n- **Reach a connected service, or do what a button cannot:** `docs path="workflows"`. Triggers, steps and expressions; each service step is in `workflow_steps`.\n- **Who can reach what, or why something was refused:** `docs path="permissions"`.\n\nHow each record is drawn is `design`; every key is in `reference`; each screen in a complete workspace is `examples`.\n';
1865
1865
 
1866
1866
  // docs/build.md
1867
- var build_default = '# Build \u2014 a workspace or an app, call by call\n\nBuild from this page, `design` and the treatment the rows call for; a refusal names the `reference/<id>` page for the rest. The worked business: a bakery takes cake orders at the counter, a customer and one line per cake from the menu, moving taken, baking, ready, collected, with a slip printed when ready.\n\n`get_workspace` shows what already exists and `get_app` an app\'s tree: an app added or changed later starts there and states only the difference (`reference/changing-an-app`). Each write to an app makes a new version of it, and the live app is the only copy; sending an earlier tree restores the app, never a table or a row a write made, so try a write on a throwaway row. Before the first write, send the person who asked one message covering: the jobs and lists this business runs beyond those named, the trade\'s usual ones stated as defaults that stand; who does each job (`get_workspace` kind `member` lists the organization\'s people, not who works in this business or what each does); and the lists and papers they already keep, attached. A busy owner answers what comes first, so the message\'s first line is its first question, and it asks only what their papers and your defaults cannot settle, among them the papers they keep, asked by what they hold, and what else they keep track of; the defaults come after. "Go ahead" is a full answer. No second round: build from the answer. A short request names a business, not everything it runs on, so the workspace holds what that kind of business can\'t run without, such as what must never happen, what people are paid for and the papers it sends; your report names what you assumed, for them to change. What no one could guess from the data goes into a knowledge doc with `set_knowledge` (`knowledge_docs`).\n\n## 1. Tables and their checks: `set_tables`\n\nLinked tables go in one call, since they name each other by `ref`; `records` and checks may follow in the next call, so a refusal costs a patch rather than the whole document. A new table is named by its `ref`, which becomes its alias. One table per kind of thing, one column per fact, a link wherever one record points at another (`data_model`). A status is the stage of the work; a touch ("called") is a log row, a money fact ("paid in full") a formula, a quantity a number with its unit in `notation`. Read `design` before stating `records`, since a row\'s face, picture and mark are stated there. Over rows already there, read a sample before building on a field: one mostly empty holds up no screen. A table people work states `title` (who or what a row is; a code only where nothing else names it), `records` (an app over a table without it is refused) and `singular` (so is an Add over a table lacking it).\n\n```json\n{\n "tables": [\n {\n "ref": "customer", "label": "Customers", "singular": "Customer", "title": "name",\n "fields": {"name": {"type": "text", "label": "Name", "required": true}},\n "records": {"party": "person"}\n },\n {\n "ref": "menu_item", "label": "Menu", "singular": "Menu item", "title": "name",\n "fields": {\n "name": {"type": "text", "label": "Cake", "required": true},\n "price": {"type": "number", "label": "Price", "required": true, "notation": {"style": "currency", "currency": "USD"}}\n },\n "records": {"figure": "price"}\n },\n {\n "ref": "cake_order", "label": "Cake orders", "singular": "Cake order", "title": "reference",\n "fields": {\n "reference": {"type": "autonumber", "label": "Number", "prefix": "CK-"},\n "customer": {"type": "link", "label": "Customer", "table": "customer", "multi": false, "required": true},\n "due_on": {"type": "date", "label": "Pickup on"},\n "pay_by": {"type": "date", "label": "Pay balance by"},\n "lines": {"type": "link", "label": "Cakes", "table": "cake_line", "multi": true, "pair": "order"},\n "total": {"type": "rollup", "label": "Total", "via": "lines", "op": "sum", "field": "amount"},\n "prepaid": {"type": "number", "label": "Prepaid", "notation": {"style": "currency", "currency": "USD"}},\n "paid": {"type": "formula", "label": "Paid", "expression": "{total} > 0 && {prepaid} >= {total}", "output_type": "boolean"},\n "slip": {"type": "files", "label": "Slip"},\n "stage": {"type": "select", "label": "Stage", "default": ["taken"], "options": [\n {"alias": "taken", "label": "Taken", "color": "slate"}, {"alias": "baking", "label": "Baking", "color": "amber"},\n {"alias": "ready", "label": "Ready", "color": "blue"}, {"alias": "collected", "label": "Collected", "color": "green"}\n ]}\n },\n "records": {"subtitle": ["customer"], "figure": "total", "due": ["pay_by"], "settled": "paid", "status": {"field": "stage", "closed": ["collected"]}},\n "checks": {"pay_by_before_pickup": {"on": ["create", "update"], "field": "pay_by",\n "when": "!isNull(record.pay_by) && !isNull(record.due_on)", "fail_when": "record.pay_by > record.due_on",\n "message": "\\"The balance is due on or before the pickup day\\""}}\n },\n {\n "ref": "cake_line", "label": "Cakes on orders", "singular": "Cake", "title": "item",\n "fields": {\n "item": {"type": "link", "label": "Cake", "table": "menu_item", "multi": false, "required": true},\n "order": {"type": "link", "label": "Order", "table": "cake_order", "multi": false, "required": true, "pair": "lines"},\n "quantity": {"type": "number", "label": "Quantity", "required": true, "min": 1},\n "unit_price": {"type": "number", "label": "Unit price", "default_from": "item.price", "notation": {"style": "currency", "currency": "USD"}},\n "amount": {"type": "formula", "label": "Amount", "expression": "{quantity} * {unit_price}", "notation": {"style": "currency", "currency": "USD"}}\n },\n "unique": [["order", "item"]],\n "records": {"figure": "amount"}\n }\n ]\n}\n```\n\n`default_from` copies the menu\'s price when a line is made, so a later change leaves taken orders alone. `min`, `unique` and a check hold on every write; a check\'s language is `workflows/table-checks`, an effect after a write a table workflow (`workflows/table-workflows`). A check at its smallest, under an alias in the table\'s `checks`: `{"on": ["create"], "fail_when": "record.quantity < 1", "message": "\\"Quantity is at least 1\\""}`; `message` is an expression, so fixed text is a quoted string.\n\nA `date` field is a day, or a moment with `"format": "datetime"`; a time of day is a `text` field with `"format": "time"`. Days between two dates in a formula is `differenceInCalendarDays(later, earlier)`; the helpers are named exactly (`reference/formula`). Two rows that must not hold one resource at once are the table\'s `no_overlap`: `{"from": "start_at", "to": "end_at", "by": "room"}`, a list where a row holds two resources (`reference/no-overlap`).\n\n## 2. The paper: `set_template`\n\nAn Act names a template by its alias, made from its name (`order_slip`), so the paper comes first.\n\n```\nset_template {"type": "html", "name": "Order slip",\n "template": "<h1>{{reference}}</h1><p>{{customer}}, {{date due_on}}</p>{{#each lines}}<p>{{item}} \xD7 {{quantity}}</p>{{/each}}<p>{{money total \\"USD\\"}}</p>",\n "variables": {"reference": "string", "customer": "string", "due_on": "string", "lines": "array", "total": "string"}}\n```\n\nOne template per paper the owner sends. A slot is named after a field of the record; the cakes loop under the name of the link to them (`lines`). More: `document_templates`.\n\n## 3. The app and its acts: `set_app`\n\n**Which apps**, and who gets each, is `app_architecture`. **How each row reads** comes before the first List: `design/treatments` names the view per kind of row.\n\n**Start from one root List.** `{"type": "List", "entity": "cake_order"}` in the App\'s `children` is a whole app: the platform draws the page every row opens, the add and the Delete. `set_app` answers with what it drew and what it placed or folded; state only the difference.\n\n```json\n{\n "body": {\n "type": "App", "key": "counter", "name": "Counter",\n "children": [\n {"type": "List", "entity": "cake_order", "filters": ["customer"], "create": ["customer", "due_on", "pay_by"], "children": [\n {"type": "Reading", "label": "By pickup day", "value": "total", "by": "due_on"}\n ]}\n ],\n "pages": [\n {"type": "Record", "entity": "cake_order", "children": [\n {"type": "Section", "title": "Order", "at": ["taken", "baking"], "children": [\n "due_on",\n "pay_by",\n {"type": "List", "entity": "cake_line", "create": ["item", "quantity"]},\n {"type": "Act", "key": "start_baking", "label": "Start baking", "when": {"stage": ["taken"]}, "requires": ["due_on"], "asks": ["prepaid"], "set": {"stage": "baking"}},\n {"type": "Act", "key": "ready", "label": "Ready", "when": {"stage": ["baking"]}, "set": {"stage": "ready"}, "template": "order_slip", "into": "slip"}\n ]},\n {"type": "Section", "title": "Pickup", "at": ["ready"], "children": [\n {"field": "slip", "edit": false},\n {"type": "Act", "key": "collect", "label": "Collected", "when": {"stage": ["ready"], "paid": true}, "set": {"stage": "collected"}}\n ]}\n ]}\n ]\n }\n}\n```\n\n**Give each main List a band** of what its person watches, a figure or a chart in its `children`, never a bare count.\n\n**A press can be a mistake.** An Act also moves a row back (`when` the later stage, `set` the earlier), at the foot of the Section of the stage it leaves. **Someone with no seat** who signs or approves one record, a customer or a supplier, gets a Record\'s `Outside`: a link a member makes of that record.\n\n`dry_run` checks a body and writes nothing; then share each app (`app_architecture`). An Act\'s or stage\'s `owner` decides who presses.\n\n## 4. What the owner will ask an agent: Query and Workflow nodes\n\nWhat the business asks its assistant again and again (orders waiting for pickup) is a Query or Workflow node of the app, with a `description` for an agent that has not seen the screen (`agent_surface/declaring-more`). A figure\'s name is not its definition: which rows count, by which field, now or over a window, is the owner\'s; where no field holds it, say so rather than total a near one. The App\'s `description` heads what a member\'s chat agent reads every turn, so a standing process the app expects of it goes there. A connected service is reached by a Workflow node\'s step (`workflows`).\n\n## 5. The owner\'s rows: `create_records`\n\nBatch the owner\'s rows: the customers and menu, then the orders, linked by the ids those calls return, then each order\'s cakes (`field_values` has the value each type takes). Load as an admin: a row past the first stage is refused unless that stage\'s owner or an admin makes it, and a row loaded at a later stage states each earlier stage\'s date field (`<option>_at`). Example rows the papers ask for and do not list come from the owner\'s lists, each at the stage it should show, written like the owner\'s own rows (no flag field, no "Example" in a name) and listed in your report for the owner to keep or delete. An owner who sent no lists opens what you leave, so a few example rows, listed the same way, show them the app working.\n\n```\ncreate_records {"table_id": "cake_line", "field_keys": ["order", "item", "quantity"],\n "rows": [["<the order\'s record id>", "<Lemon cake\'s record id>", 2]]}\n```\n\n## 6. Verify: `run_app_workflow`, `screenshot_app`\n\nMove the owner\'s rows through the app as their person would, each only as far as the stage the owner says it is at. Every Act runs as `act_<key>`, the one name, handed what it asks. A dry run walks the moves and files nothing; then press each paper Act for real, on one row the owner\'s stage allows or on an example row left at its last stage: what is left on a row is what the owner opens. Prove a rule by sending the write with `dry_run: true`; never switch a check off. Only an admin passes `as_member`: it shows a member\'s view and reads, which is how each person\'s screen is checked. What the shots and runs must show is `design/the-rubric`.\n```\nrun_app_workflow {"app_id": "app_\u2026", "alias": "act_start_baking", "inputs": {"record_id": "rec_\u2026", "prepaid": 20}, "dry_run": true}\nscreenshot_app {"app_id": "app_\u2026", "as_member": "<member id>", "pages": [{}, {"record_id": "rec_\u2026"}]}\n```\n\n## 7. Hand over\n\nName the workspace and its organization after the business with `set_workspace` (`name`, `organization_name`, and `organization_language`: the language its papers, invitations and members default to, `vi` until set), and leave standing instructions there (`instructions`, one entry per rule): who the business is, its people\'s words, what any agent here must keep to. As an admin, invite the people named with `set_members` (`members` keyed by email, role `member` or `admin`), else say whom to invite.\n\nBefore you report, answer each question of `design/the-rubric` with a call, and put right or name each gap. Then show the owner what you built, job by job, each paper and what makes it, with the choices you made for them to change.\n';
1867
+ var build_default = '# Build \u2014 a workspace or an app, call by call\n\nBuild from this page, `design` and the treatment the rows call for; a refusal names the `reference/<id>` page for the rest. The worked business: a bakery takes cake orders at the counter, a customer and one line per cake from the menu, moving taken, baking, ready, collected, with a slip printed when ready.\n\n`get_workspace` shows what already exists and `get_app` an app\'s tree: an app added or changed later starts there and states only the difference (`reference/changing-an-app`). Each write to an app makes a new version of it, and the live app is the only copy; sending an earlier tree restores the app, never a table or a row a write made, so try a write on a throwaway row. Before the first write, send the person who asked one message covering: the jobs and lists this business runs beyond those named, the trade\'s usual ones stated as defaults that stand; who does each job (`get_workspace` kind `member` lists the organization\'s people, not who works in this business or what each does); and the lists and papers they already keep, attached. A busy owner answers what comes first, so the message\'s first line is its first question, and it asks only what their papers and your defaults cannot settle, among them the papers they keep, asked by what they hold, and what else they keep track of; the defaults come after. "Go ahead" is a full answer. No second round: build from the answer, and a paper or list that does not come with it is never waited for \u2014 build from your defaults now and say in your report which papers would sharpen it. A short request names a business, not everything it runs on, so the workspace holds what that kind of business can\'t run without, such as what must never happen, what people are paid for and the papers it sends; your report names what you assumed, for them to change. What no one could guess from the data goes into a knowledge doc with `set_knowledge` (`knowledge_docs`).\n\n## 1. Tables and their checks: `set_tables`\n\nLinked tables go in one call, since they name each other by `ref`; `records` and checks may follow in the next call, so a refusal costs a patch rather than the whole document. A new table is named by its `ref`, which becomes its alias. One table per kind of thing, one column per fact, a link wherever one record points at another (`data_model`). A status is the stage of the work; a touch ("called") is a log row, a money fact ("paid in full") a formula, a quantity a number with its unit in `notation`. Read `design` before stating `records`, since a row\'s face, picture and mark are stated there, and so is what goes wrong on a row and needs someone to act: an issue (`design/issues`). Over rows already there, read a sample before building on a field: one mostly empty holds up no screen. A table people work states `title` (who or what a row is; a code only where nothing else names it), `records` (an app over a table without it is refused) and `singular` (so is an Add over a table lacking it).\n\n```json\n{\n "tables": [\n {\n "ref": "customer", "label": "Customers", "singular": "Customer", "title": "name",\n "fields": {"name": {"type": "text", "label": "Name", "required": true}},\n "records": {"party": "person"}\n },\n {\n "ref": "menu_item", "label": "Menu", "singular": "Menu item", "title": "name",\n "fields": {\n "name": {"type": "text", "label": "Cake", "required": true},\n "price": {"type": "number", "label": "Price", "required": true, "notation": {"style": "currency", "currency": "USD"}}\n },\n "records": {"figure": "price"}\n },\n {\n "ref": "cake_order", "label": "Cake orders", "singular": "Cake order", "title": "reference",\n "fields": {\n "reference": {"type": "autonumber", "label": "Number", "prefix": "CK-"},\n "customer": {"type": "link", "label": "Customer", "table": "customer", "multi": false, "required": true},\n "due_on": {"type": "date", "label": "Pickup on"},\n "pay_by": {"type": "date", "label": "Pay balance by"},\n "lines": {"type": "link", "label": "Cakes", "table": "cake_line", "multi": true, "pair": "order"},\n "total": {"type": "rollup", "label": "Total", "via": "lines", "op": "sum", "field": "amount"},\n "prepaid": {"type": "number", "label": "Prepaid", "notation": {"style": "currency", "currency": "USD"}},\n "paid": {"type": "formula", "label": "Paid", "expression": "{total} > 0 && {prepaid} >= {total}", "output_type": "boolean"},\n "slip": {"type": "files", "label": "Slip"},\n "stage": {"type": "select", "label": "Stage", "default": ["taken"], "options": [\n {"alias": "taken", "label": "Taken", "color": "slate"}, {"alias": "baking", "label": "Baking", "color": "amber"},\n {"alias": "ready", "label": "Ready", "color": "blue"}, {"alias": "collected", "label": "Collected", "color": "green"}\n ]}\n },\n "records": {"subtitle": ["customer"], "figure": "total", "due": ["pay_by"], "settled": "paid", "status": {"field": "stage", "closed": ["collected"]}},\n "checks": {"pay_by_before_pickup": {"on": ["create", "update"], "field": "pay_by",\n "when": "!isNull(record.pay_by) && !isNull(record.due_on)", "fail_when": "record.pay_by > record.due_on",\n "message": "\\"The balance is due on or before the pickup day\\""}}\n },\n {\n "ref": "cake_line", "label": "Cakes on orders", "singular": "Cake", "title": "item",\n "fields": {\n "item": {"type": "link", "label": "Cake", "table": "menu_item", "multi": false, "required": true},\n "order": {"type": "link", "label": "Order", "table": "cake_order", "multi": false, "required": true, "pair": "lines"},\n "quantity": {"type": "number", "label": "Quantity", "required": true, "min": 1},\n "unit_price": {"type": "number", "label": "Unit price", "default_from": "item.price", "notation": {"style": "currency", "currency": "USD"}},\n "amount": {"type": "formula", "label": "Amount", "expression": "{quantity} * {unit_price}", "notation": {"style": "currency", "currency": "USD"}}\n },\n "unique": [["order", "item"]],\n "records": {"figure": "amount"}\n }\n ]\n}\n```\n\n`default_from` copies the menu\'s price when a line is made, so a later change leaves taken orders alone. `min`, `unique` and a check hold on every write; a check\'s language is `workflows/table-checks`, an effect after a write a table workflow (`workflows/table-workflows`). A check at its smallest, under an alias in the table\'s `checks`: `{"on": ["create"], "fail_when": "record.quantity < 1", "message": "\\"Quantity is at least 1\\""}`; `message` is an expression, so fixed text is a quoted string.\n\nA `date` field is a day, or a moment with `"format": "datetime"`; a time of day is a `text` field with `"format": "time"`. Days between two dates in a formula is `differenceInCalendarDays(later, earlier)`; the helpers are named exactly (`reference/formula`). Two rows that must not hold one resource at once are the table\'s `no_overlap`: `{"from": "start_at", "to": "end_at", "by": "room"}`, a list where a row holds two resources (`reference/no-overlap`).\n\n## 2. The paper: `set_template`\n\nAn Act names a template by its alias, made from its name (`order_slip`), so the paper comes first.\n\n```\nset_template {"type": "html", "name": "Order slip",\n "template": "<h1>{{reference}}</h1><p>{{customer}}, {{date due_on}}</p>{{#each lines}}<p>{{item}} \xD7 {{quantity}}</p>{{/each}}<p>{{money total \\"USD\\"}}</p>",\n "variables": {"reference": "string", "customer": "string", "due_on": "string", "lines": "array", "total": "string"}}\n```\n\nOne template per paper the owner sends. A slot is named after a field of the record; the cakes loop under the name of the link to them (`lines`). More: `document_templates`.\n\n## 3. The app and its acts: `set_app`\n\n**Which apps**, and who gets each, is `app_architecture`. **How each row reads** comes before the first List: `design/treatments` names the view per kind of row.\n\n**Start from one root List.** `{"type": "List", "entity": "cake_order"}` in the App\'s `children` is a whole app: the platform draws the page every row opens, the add and the Delete. `set_app` answers with what it drew and what it placed or folded; state only the difference.\n\n```json\n{\n "body": {\n "type": "App", "key": "counter", "name": "Counter",\n "children": [\n {"type": "List", "entity": "cake_order", "filters": ["customer"], "create": ["customer", "due_on", "pay_by"], "children": [\n {"type": "Reading", "label": "By pickup day", "value": "total", "by": "due_on"}\n ]}\n ],\n "pages": [\n {"type": "Record", "entity": "cake_order", "children": [\n {"type": "Section", "title": "Order", "at": ["taken", "baking"], "children": [\n "due_on",\n "pay_by",\n {"type": "List", "entity": "cake_line", "create": ["item", "quantity"]},\n {"type": "Act", "key": "start_baking", "label": "Start baking", "when": {"stage": ["taken"]}, "requires": ["due_on"], "asks": ["prepaid"], "set": {"stage": "baking"}},\n {"type": "Act", "key": "ready", "label": "Ready", "when": {"stage": ["baking"]}, "set": {"stage": "ready"}, "template": "order_slip", "into": "slip"}\n ]},\n {"type": "Section", "title": "Pickup", "at": ["ready"], "children": [\n {"field": "slip", "edit": false},\n {"type": "Act", "key": "collect", "label": "Collected", "when": {"stage": ["ready"], "paid": true}, "set": {"stage": "collected"}}\n ]}\n ]}\n ]\n }\n}\n```\n\n**Give each main List a band** of what its person watches, a figure or a chart in its `children`, never a bare count.\n\n**A press can be a mistake.** An Act also moves a row back (`when` the later stage, `set` the earlier), at the foot of the Section of the stage it leaves. **Someone with no seat** who signs or approves one record, a customer or a supplier, gets a Record\'s `Outside`: a link a member makes of that record.\n\n`dry_run` checks a body and writes nothing; then share each app (`app_architecture`). An Act\'s or stage\'s `owner` decides who presses.\n\n## 4. What the owner will ask an agent: Query and Workflow nodes\n\nWhat the business asks its assistant again and again (orders waiting for pickup) is a Query or Workflow node of the app, with a `description` for an agent that has not seen the screen (`agent_surface/declaring-more`). A figure\'s name is not its definition: which rows count, by which field, now or over a window, is the owner\'s; where no field holds it, say so rather than total a near one. The App\'s `description` heads what a member\'s chat agent reads every turn, so a standing process the app expects of it goes there. A connected service is reached by a Workflow node\'s step (`workflows`).\n\n## 5. The owner\'s rows: `create_records`\n\nBatch the owner\'s rows: the customers and menu, then the orders, linked by the ids those calls return, then each order\'s cakes (`field_values` has the value each type takes). Load as an admin: a row past the first stage is refused unless that stage\'s owner or an admin makes it, and a row loaded at a later stage states each earlier stage\'s date field (`<option>_at`). Example rows the papers ask for and do not list come from the owner\'s lists, each at the stage it should show, written like the owner\'s own rows (no flag field, no "Example" in a name) and listed in your report for the owner to keep or delete. An owner who sent no lists opens what you leave, so a few example rows, listed the same way, show them the app working.\n\n```\ncreate_records {"table_id": "cake_line", "field_keys": ["order", "item", "quantity"],\n "rows": [["<the order\'s record id>", "<Lemon cake\'s record id>", 2]]}\n```\n\n## 6. Verify: `run_app_workflow`, `screenshot_app`\n\nMove the owner\'s rows through the app as their person would, each only as far as the stage the owner says it is at. Every Act runs as `act_<key>`, the one name, handed what it asks. A dry run walks the moves and files nothing; then press each paper Act for real, on one row the owner\'s stage allows or on an example row left at its last stage: what is left on a row is what the owner opens. Prove a rule by sending the write with `dry_run: true`; never switch a check off. Only an admin passes `as_member`: it shows a member\'s view and reads, which is how each person\'s screen is checked. What the shots and runs must show is `design/the-rubric`.\n```\nrun_app_workflow {"app_id": "app_\u2026", "alias": "act_start_baking", "inputs": {"record_id": "rec_\u2026", "prepaid": 20}, "dry_run": true}\nscreenshot_app {"app_id": "app_\u2026", "as_member": "<member id>", "pages": [{}, {"record_id": "rec_\u2026"}]}\n```\n\n## 7. Hand over\n\nName the workspace and its organization after the business with `set_workspace` (`name`, `organization_name`, and `organization_language`: the language its papers, invitations and members default to, `vi` until set), and leave standing instructions there (`instructions`, one entry per rule): who the business is, its people\'s words, what any agent here must keep to. As an admin, invite the people named with `set_members` (`members` keyed by email, role `member` or `admin`), else say whom to invite.\n\nBefore you report, answer each question of `design/the-rubric` with a call, and put right or name each gap. Then show the owner what you built, job by job, each paper and what makes it, with the choices you made for them to change.\n';
1868
1868
 
1869
1869
  // docs/design.md
1870
- var design_default = '# Designing an app\n\nAn app is a tree of components: a List of one table, the Record a row opens, its Sections, the Acts that move it. The\ntree states COMPOSITION \u2014 which fields, lists and acts each job\'s screen holds; how each piece looks is the platform\'s,\none way per concept. A node the tree leaves out draws its default, from the table\'s facts (`records`, the stage, the\nwrite rules): a List\'s Readings band, the stage buttons, the picture, a Record\'s Sections. State a node to change it,\nor `false` at it to turn it off (`"readings": false`, a Record\'s `"row": { "image": false }`). A field is written where its Record declares it: a Section\'s Field, the table\'s face (title, line, picture, figure), or every field where the Record states no Section; the head, a line, a column or a board draws it, and never makes one written; every head part (`row.title`, each `row.subtitle` entry, `row.figure`, `row.image`) takes `edit: false` to be read. A drawn Field is a control unless it\nor its entity is read-only (`edit: false`); a stepped status never is, since Acts move it. Which apps a business needs is `app_architecture`.\n\n**The visual bar.** Every screen is judged against it; a miss is a change to the tree.\n\n- Each app looks like its own rows: the view its kind of row takes (`design/treatments`) \u2014 cards for things found by\n their photo, a calendar or lanes for dated work, faces for people and organisations. A List left as a table is drawn\n as one, the most common failure of an app; the answers of `set_app` and `get_app` note the view rows that are work in time call for (a calendar, lanes, a roster, a gantt where rows wait on one another).\n- What needs attention leads the row as a `Check`: a derived flag is a yes/no formula and a `Check` over it, in the warning\n tone on the row\'s line (in the danger tone where its `on` refuses an act the row offers); every other yes reads in the\n success tone. `records.mark` is a category\'s own mark, a select whose options carry a brand or glyph. A Check is stated\n once, on the entity it is true of: every List over those rows offers it in one filter of Checks, with how many hold it, and its `on` may name an Act of a record that lists them whole, through a List whose link is paired; the act holds those rows and the record first, so it cannot also send mail, notify, run an agent or wait in its own `workflow` \u2014 start that work from a workflow the act starts after.\n- A list\'s columns: the name and its lead, the status, then the columns the job reads on every row, as many as fit a desk. Each\n fact once: a column the row draws itself stands once. A generated number (`autonumber`) as the title yields\n the row\'s name to the subtitle\'s first part and stands first on its line.\n- A list worked by a date states `sort` on that date\'s column, newest first; without one, a register reads newest made\n first and a record\'s child List in the order its rows were added.\n- Someone is a face wherever they are read: a link to a table stating `records.party` draws its row\'s face; a member\n field is one already; select options naming people or organisations who are neither each take the `mark`\n `{"kind": "avatar", "name": "person"}`, never a colour dot.\n- A thing shows its picture, a file its preview, a plan its days on a time axis, a quantity a meter (`records.limits`) or\n a chart, a register its Readings, and long text reads whole (a markdown Field; `block: true` on plain long text).\n- An option with a `color` draws its dot where its select is drawn; one without reads as its word. A `mark` where a\n brand or glyph names the option, on every option of a select read down a column (how it was paid, the channel).\n- Every app states its tile\'s `color`, apart from the workspace\'s other apps where it can be.\n- The paperwork is the proof of the work: a files field per purpose (what arrived, what was issued to the customer, the\n carrier, the authority) in the Section where that work happens, and the source of a\n figure (a screenshot, an email, a sheet) on its row. Every files field is drawn somewhere. A paper a counterparty\n sends (a supplier\'s invoice, a delivery receipt) is added on the record it arrives with \u2014 the order it is for \u2014 and\n listed again where it is settled, never only in the counterparty\'s ledger.\n\n<!-- generated:start words -->\n\n**The words most builds state.** A node\'s page holds its rules and every other word: `reference/list-node`, `reference/records`, `reference/field`.\n\n**Table**\n\n- `ref` (alias): A created table\'s handle in this call\n- `label` (text, required): The table\'s name in the workspace\n- `singular` (text): One row of this table, in the business\'s own words\n- `title` (alias): The alias of the field that names a row wherever a link or a record shows one\n- `fields` (map of alias \u2192 Field, required): The table\'s columns, each under its alias, which is its key here and so is never stated inside it\n- `records` (any value): How a row is recognised\n- `checks` (map of alias \u2192 table check (`workflows/table-checks`)): The conditions a write of the table\'s rows may not meet, each under its alias\n- `unique` (list (at least one) of list of alias (at least one)): Sets of fields whose values no two live rows share\n\n**Any field**\n\n- `label` (text, required): The field\'s name in the workspace\n- `required` (boolean): Refuse a record whose cell for this field is empty\n- `default_from` (text): Copied when a record is made off the row a one-row link of this entity names\n\n**`number` field**\n\n- `notation` (notation): How the figure reads\n- `min` (number | text): Refuse a create or update whose value is below this\n\n**`select` field**\n\n- `options` (list of Select option (at least one), required): The choices, in the order every picker and every ladder lists them\n- `multi` (boolean): Allow multiple selections\n\n**`link` field**\n\n- `table` (text, required): The table the link points at\n- `multi` (boolean, required): Whether a row links to one row or many\n- `pair` (`true` | alias): Makes the link two-way\n\n**`formula` field**\n\n- `expression` (text, required): The expression, over fields of THIS entity by alias in braces\n- `output_type` (`"number"` | `"text"` | `"date"` | `"datetime"` | `"boolean"` | `"select"`): Holds a formula to the type its readers need\n\n**`rollup` field**\n\n- `via` (alias, required): The alias of a link of this table to roll up from\n- `op` (operation, required): The operation over the linked rows\n- `field` (alias): The alias of the field on the linked table the operation reads\n\n**`lookup` field**\n\n- `via` (alias, required): The alias of a link of this table to look up through\n- `field` (alias, required): The alias of the field on the linked table to show\n\n**`autonumber` field**\n\n- `prefix` (text): Literal prefix prepended to every display value (e.g. \'KH-\' \u2192 \'KH-001\')\n\n**`records`**\n\n- `subtitle` (list of alias (1\u20132)): Up to two fields read under the title wherever a row is drawn (a code, a date, a party)\n- `figure` (alias): The one number the row stands for, read at its right (a total, a quantity left)\n- `status` (Status): The stage a row moves through, a single select, drawn in the record\'s head, or its Side where the Side states it\n- `due` (list of alias (at least one)): Dates that are deadlines (stored, or computed as a date)\n- `image` (alias): A files field that pictures the row, or a one-row link to a table with a picture, whose picture the row leads with\n- `party` (`"person"` | `"organization"` | `"organisation"`): What each row is where the rows are people (a contact, a patient) or organisations (a customer, a supplier, a carrier)\n- `limits` (map of alias \u2192 (alias | number)): A number read against a bound\n- `starts` (map of alias \u2192 `"today"` | `"me"`): What a field of a row being added starts at, where that start is certain\n- `mark` (alias): A single select (or a lookup of one through a one-row link) whose option leads the row wherever a mark leads it\n- `settled` (alias): A yes/no of the row (stored, a formula: an invoice paid in full, or looked up through a one-row link: a line settled with its parent) that ends its deadlines\n\n**`records.status`**\n\n- `field` (alias, required): The single select that is the row\'s state, its options in the order the work goes through them, read as steps by itself on a record whose parts state no `at`\n- `closed` (list of alias (at least one)): Options that end the work\n- `history` (text): A table every write that sets or moves the status appends one row to (its link to this table, the new status, the moment and who)\n- `dates` (map of alias \u2192 alias): Option alias \u2192 a date field of this entity the record write path stamps with the moment a row moves into that option, or is made at it\n- `stages` (map of alias \u2192 Stage): Option alias \u2192 who owns that stage and how long it should take\n\n**App**\n\n- `key` (alias, required): The app\'s alias, its name among apps\n- `name` (text, required): The job, in the words of the people who do it\n- `children` (list of (List | Sheet | Query | Workflow) (at least one)): The App\'s Views in order\n- `color` (colour): The launcher tile\'s colour\n- `pages` (list of Record (at least one)): The page the rows of an entity open, one per entity, each a Record stating its `entity`\n\n**List**\n\n- `entity` (alias, required): The table whose rows the List draws\n- `create` (boolean | list of alias (at least one)): The fields an add asks\n- `columns` (list of (alias | Edit column)): Fields read after the row\'s title, each drawn though no row holds it\n- `label` (text): The register\'s name in the app\'s lists and tab strip\n- `filters` (list of (alias | Tiered filter | Listed filter) (at most 3)): Fields the reader narrows by every day, beside the stage chips\n- `children` (list of (Tab | Reading | Export | Act | List) (at least one)): Its Tabs, band Readings, Exports and Acts over ticked rows or every row in view\n- `key` (alias): Names the List among its siblings and in a Query\'s `list`\n- `sort` (Sort key | list of Sort key (at least one)): The rows\' order\n- `layout` (layout): A word, or an object stating one layout with its data\n- `remove` (boolean): Rows offer a Delete\n- `search` (list of alias (at least one) | `false`): Fields the search box reads\n- `where` (narrowing): A fixed narrowing on the server, for every reader\n- `group` (alias | `false`): A field the rows stand grouped by, a gantt drawing the groups as its lanes\n- `expect` (alias | Expect): What a record should hold, shown before it does\n- `opens` (narrowing): The view the register opens on, a chip the reader may take away\n\n**Record**\n\n- `entity` (alias, required): The table whose rows open on this page\n- `children` (list of (alias | Field | Fieldset | Section | Side | Outside | List | Reading | Statement | Act | Check) (at least one)): Parts (Section, Side), or for a one-part record its Fields, Fieldsets, Lists, Readings and Statements directly\n- `add` (`false` | list of alias (at least one)): What a new row asks where a picker of this entity offers one, anywhere in the App\n- `row` (Record row): How the App reads this entity\'s rows wherever it lists them\n- `door` (`"page"` | `"drawer"`): How a row opens, on a page or in a drawer\n\n**Section**\n\n- `title` (text): The part\'s heading\n- `key` (alias): Unique among its siblings\n- `children` (list of (alias | Field | Fieldset | List | Reading | Statement | Act | Check) (at least one)): What the part draws, in reading order\n- `at` (list of alias (at least one)): Options of the record\'s status during which this part is the work now\n- `when` (condition): Drawn only while this holds\n\n**Field**\n\n- `field` (alias, required): The field\'s alias\n- `edit` (boolean): Shows a value nobody changes here\n- `label` (text): The heading of the field\'s gallery or prose block, where it draws as one\n- `block` (boolean): Gives a field room of its own\n\n**Act**\n\n- `key` (alias, required): The act\'s name\n- `label` (text, required): The verb, as the reader says it\n- `when` (condition): The act works only while this holds\n- `set` (map of alias \u2192 value): What the act writes\n- `asks` (list of (alias | `{ "field": alias, "starts": "today" | "me" }` | Asked input) (at least one)): What the reader states on pressing\n- `confirm` (`true` | text): The press asks first\n- `requires` (list of alias (at least one)): Fields filled first, each drawn where the act stands\n- `template` (alias): A document template it makes a file from\n- `into` (alias): The record\'s files field keeping the document\n- `owner` (`"field"` | `"link.field"` | `{ "group": id }`): Who presses it\n- `workflow` (alias): The workflow it runs for what `set` cannot say\n- `danger` (`true`): The act destroys or cannot be undone\n\n**Check**\n\n- `field` (alias, required): A yes/no or text formula of the page\'s entity\n- `on` (`"all"` | list of (`"update"` | alias) (at least one)): What the standing check refuses\n- `resolve` (alias): An Act on one row of this entity that clears it\n\n**Reading**\n\n- `label` (text): What the figure is called\n- `value` (alias | `{ "avg": alias }`): A number field summed over the rows, or `{ avg }` averaged over the rows holding one\n- `by` (alias | Tiered filter): Splits the rows into parts\n- `where` (narrowing): Only the rows whose select holds one of these options, whose yes/no is this value, whose number or date meets its bounds (`gt`, `gte`, `lt`, `lte`; a date\'s `{ "now": true }` is read when the rows are), whose field is `{ "empty": true | false }`, or whose member field holds the reader (`{ "me": true }`)\n- `entity` (alias): The List\'s rows\n- `over` (alias): The date that places a row in time\n\n<!-- generated:end words -->\n\n## Look at it\n\nAfter an apply, `screenshot_app` draws each app as its people see it \u2014 the register, and a record by its `path` or its `record_id`\n(with a `path` on that record, such as one Section; `screen` for a later screen of a long one), up to six `pages` in one call \u2014 at a desk\'s width and a phone\'s, naming the columns a table left off at each width;\n`-o <dir>` saves the shots from the CLI. `set_app` with `app_id`, an empty `body` and `dry_run` answers what a write of the\nstored tree would be refused for now, and its notes. Answer `design/the-rubric`, change the tree with `nodes`, and write again. To go back,\nsend the tree saved before the change as `body` with `app_id`, nulling an App prop stated since (`words`, `scope`,\n`period`, `icon`); tables and rows stay as they are.\n\n## The rubric\n\nWhether the build does the owner\'s work, answered by a call each, never from what you meant to write:\n\n1. Each job the owner named, and each their kind of business cannot run without: which screen does it, and which press? Find each on a `screenshot_app` shot of the person who does it (`as_member`).\n2. Can an agent do each job in one call, an `act_<key>` or a Query or Workflow node whose `description` names it? `get_app` lists them; `run_app_workflow` with `dry_run` proves one (`agent_surface/prove-an-app-as-an-agent`).\n3. Is each kind of row in its treatment (`design/treatments`)? Timed work reads in a calendar or lanes, and a weekly plan as the dated rows it makes.\n4. Does each screen show the least its next step needs, each fact once, the signal that a step is due leading?\n5. Is anything cramped at desk or phone width?\n6. Is every paper and every Export made, those this kind of business sends unasked too, with no blank? Press each paper Act and read the file it files; prove an Export with `run_app_query` and `export`.\n\nA failed answer is a change to the tree, or a gap named to the owner.\n\n## Treatments\n\nThe answers of `set_app` and `get_app` note the view rows that are work in time call for (a calendar, lanes, a roster, a gantt\nwhere rows wait on one another), naming the node that would state it; a note refuses nothing. No other treatment below is noted.\nEach kind of row\'s view is chosen before its List is written:\n\n| The rows are | The treatment | Its own page |\n|---|---|---|\n| People or organisations | `records.party`, with a photo or logo as its `image` | |\n| Things with a photo, a scan or a paper | `records.image`; List `layout: "cards"` where the picture is how a row is found | `reference/cards` |\n| Read by their day | List `layout: "calendar"`; on a record, a child List with `layout: {"agenda": \u2026}` | `reference/calendar`, `reference/layouts` |\n| Ranked by a figure, or worked by a date | List `sort: {"field": \u2026, "desc": true}` on that column | |\n| Booked on a resource | List `layout: {"lanes": {"by": \u2026}}`, and the table\'s `no_overlap` \u2014 a list of rules where a row holds two (a room and a teacher) | `reference/lanes`, `reference/write-rules` |\n| A day\'s work given out to people or vehicles | List `layout: {"lanes": {"by": \u2026}}` over rows holding a day and no hour | `reference/lanes` |\n| A log of what happened | a child List with `layout: "timeline"` | `reference/layouts` |\n| Opened to be worked on | the Record\'s Sections \u2014 each one area of the record\'s data, its lists and field groups inside it; a status\'s stage acts stand at the foot of the rows they move, `at` where the work moves in steps; fields only one kind of row holds (a delay\'s cause, a safety issue\'s hours lost) in a Section whose `when` names that kind | |\n| Rows that each belong to another row | a child List on that row\'s Record, with `create` and `remove` \u2014 and a child\'s own rows a List in that child\'s page, as deep as the data goes, and every row\'s \u22EF offers Duplicate; a List with `same` where read-only | |\n| A related row\'s value on the list (the newest contract\'s end date) | a `lookup` field of the table, ordered, as a column | `reference/lookup` |\n| Moving through a status | an Act per move, `status.dates` for the moment of each stage, and the register\'s Readings | |\n| Counted over a period | the register\'s Tabs over one `period`; a Tab\'s `totals` for a child\'s sums before, during and through it; an open Tab\'s `where` reads only what was true at the period\'s end, never a status the row moves on from | |\n| Papers a case gathers | a List with `expect`; the papers made, an Act\'s `templates` | |\n| A plan of spans | List `layout: {"gantt": {"start": \u2026}}` | `reference/gantt` |\n| Stood at a place on a plan, flat or in 3D \u2014 pallets, bins | List `layout: {"plan": \u2026}`; places state `plan_place` | `reference/plan` |\n| Checked item by item against a standard | a List with `checklist: {"photo": \u2026, "clause": \u2026, "failed": [\u2026], "passed": \u2026}`: each row a mark (passed at `closed`, failed at a `failed` option, or by the yes/no `passed` names \u2014 a measured verdict, no task or status needed), its photo and the clause it is checked against; with `expect` on the standard\'s items, each item is a line marked the same way and filled by the block\'s columns | |\n| A place before and after the work | a List with `compare: {"before": \u2026, "after": \u2026}`: two files fields read side by side, or two value fields read as one struck-then-new column | |\n| Spots on a drawing | `records.pin: {"on": \u2026, "x": \u2026, "y": \u2026}` on the spots\' table: a record listing rows that link to them draws the picture with a numbered pin at each; the picture is the `on` row\'s `records.image` | `reference/record-places-pins-and-cadence` |\n| Photos that must be taken on site | `records.on_site: {"photos": [\u2026]}`: a photo taken through the camera keeps where the device stood, and a record holding one taken away says so | `reference/record-places-pins-and-cadence` |\n| The real size of the thing (a carton, a piece of furniture, a pallet) | `records.size: {"across": \u2026, "along": \u2026, "up": \u2026}`: three number fields in one length unit, read as one fact "400 \xD7 300 \xD7 250 mm" after the subtitle; a plan register draws each box at that size | `reference/record-places-pins-and-cadence`, `reference/plan` |\n| A number painted on the thing, or a barcode or QR code on it | `records.scan: "iso6346"` or `"text"` (read off one photo by an agent), or `"code"` (decoded on the device, no agent): the title read on a phone, beside each search matching it | `reference/record-places-pins-and-cadence` |\n| The rows a weekly pattern owes (a class\'s lessons on Tue and Thu at 16:00) | `records.cadence: [{"entity": \u2026, "on": "<a multi-select of mon\u2013sun>", "start": \u2026, "end": \u2026, "planned": \u2026, "except": \u2026}]` on the parent, and an Act `makes: "<child>"`: the press lists the rows still owed, each with what would stop it, and writes the ones ticked; pressed again it lists what is missing, and moves a row to the pattern\'s hours and copied fields where it differs and no person or linked row has touched it (ticked), else leaves it unticked saying why | `reference/record-places-pins-and-cadence` |\n| Who did what on which day | List `layout: "roster"` with the List of its cells inside | `reference/roster` |\n| Someone with no seat signs off one record (a buyer approves a proof, a client signs a handover) | the Record\'s `Outside`: the Fields and Lists the link shows as they are, and Acts that each move the status out of its `at` \u2014 a link a member makes of the record, never a seat; the link\'s page names the record only where the Outside states its title\'s field | |\n| Steps people drop out of between | a Reading with `steps` on the record whose child rows count them | |\n| A record\'s own numbers nobody keys, read at a glance | consecutive Readings with no `entity` (up to eight tiles) | |\n| Rows that are each a place a record is sent | a List with `expect` on the link to those places and `post`: each ticked, the post written there and read as its feed shows it | `reference/publish-desk` |\n| Papers an agent reads, where the owner asked for one | an Act\'s `intake` with `fills` | |\n| Calls and visits | an Act\'s `record` | |\n| Changes a workflow proposes that a person approves row by row \u2014 a price list applied, a statement matched to what is owed | an Act\'s `workflow` with `review`, its body returning a changeset in `data.review` | |\n| Documents covering lines | a List with `under` | |\n| Rows on file a record takes in | a List with `pick` | |\n| One owner\'s question across jobs | an App of Tabs and Readings and no register | |\n\nWhat these nodes do not state, a long-form writing page or a bespoke tool, is a custom-code app (`lotics app create <name> --custom`, `app_bindings`), never a new node.\n\n### Faces and pictures\n\n#### Party\n\n`records.party` is `"person"` where the rows are people (a contact, a patient, a driver) and\n`"organization"` where they are companies (a customer, a supplier, a carrier). Every surface drawing one of\nits rows then draws a face: its `image` (a photo, a logo), else its initials. Without it, a person is drawn as a thing. A workspace\nmember is a `member` field, and is drawn by their face already. A column holding a link to several rows of people,\nor several members, draws their faces as a stack that names them on hover. Worked: `examples/party`.\n\n#### Image\n\n`records.image` names the files field that pictures a row \u2014 a product\'s photo, a damage photo, a\nscan, a receipt. Every row of it then leads with its picture, or its paper\'s preview, wherever it is drawn \u2014\na row holding no picture leads with the placeholder; a link to it previews the file. `image` may instead name a\none-row link to a table with a picture (an order line\'s `item`): the row leads with that row\'s picture, still titled by\nits own words. Never a field an Act keeps the paper it makes in (`into`). List\n`layout: "cards"` where the picture is how a row is found. A files field the record keeps as a folder of\npapers is drawn as a Field, read whole. Worked: `examples/cards`.\n\n#### A link opens its row\n\nEvery row an app draws opens on its page, the one you state or a default. A List\'s rows default to the table\'s fields; a link\'s row defaults to its name, line, status and figure. State `pages/<e>` to show more or to edit.\n\n### Rows in time\n\nRows that each stand on a day, or hold a run of days or hours, are read where they stand in time \u2014 never\nas two date columns. A row holds a span when two dates a person states are ordered, the second after the first by a\n`min` or a table check, both required or the second the row\'s `due`; else it is an appointment when one required date\nis stated that no Act stamps, that a new row does not start at `today` and that is not derived. A stamp is an event,\nand a `due` is a deadline, never the day a row is held on. A `no_overlap` by a person or a value alone keeps one row at\na time each \u2014 a member\'s periods in turn \u2014 read by what they hold.\n\n#### Calendar\n\n`layout: "calendar"`, or `{ "calendar": { "date": "starts_at", "end": "ends_at" } }`: the rows by their day \u2014 a\nmonth, a week, a day or a list; an entry at its hour where `date` holds one, over its span where `end` names the date it\nruns to. The bare word takes both from the rows\' facts and is refused, naming `date`, where they name none. An entry pressed opens its row beside the calendar; where the app saves the row, a drag or F2 moves it. Worked:\n`examples/calendar`.\n\n#### Lanes\n\n`layout: {"lanes": {"by": \u2026}}` with `by` naming a one-row link whose target\'s rows are the lanes (a chair, a\nmachine, a room), each drawn even when empty: every row a block from the first date on its line to the\nsecond, and a free stretch adds a row there. `loads` reads what a lane carries against what it holds: hours summed\nwithin each day (across days, the fullest day, named), any other number the most its rows add up to at one time. A\n`no_overlap` `by` the same link refuses two rows on one resource at once. A lane per person: `by` a member field\nand `of` a role of the model, each member of it a lane, idle ones too. Worked: `examples/lanes`.\n\nA day\'s work given out (stops to drivers, jobs to technicians): rows holding a day and no hour read at one day as cards\nin lanes, those no lane holds, or holding no day, first in a tray. Each lane\'s head reads its count, its loads and its\nrow\'s status; a lane its link no longer admits (`options_where`) says so in its head and refuses a card. Where the app writes the link, cards ticked or\ndragged go to a lane in one write, every row checked before any is written, and the List\'s first `sort`, ascending on a\nnumber the app writes, is a card\'s place in its lane.\n\n#### Gantt\n\n`layout: {"gantt": {"start": \u2026}}` (and `end`, else the table\'s first `due`; a `due` is a deadline, never an appointment date): one bar a row over\nits run of days, read against today. `milestones` marks\ndates on the bar, `planned` the plan under it, `progress` how far it is done, `after` the rows it waits on;\nthe List\'s `group` is its lanes; a table holding rows under rows nests each bar under its row above, folded as the\nregister\'s outline is. A child List on a record with this layout draws the bars of the rows its link names. Worked: `examples/gantt`.\n\n#### Roster\n\n`layout: "roster"` with a List inside it over the child whose rows fill the days \u2014 one link back to the\nregister\'s table and a date on its line: what each row did on each day (shifts, runs, attendance). With\n`expect` (and `of`) on the cells the columns are the options of a select instead of days: which papers each row holds.\nAn `Export` with an html or Excel `template` prints the grid as the screen reads it (`document_templates/a-template`). Worked: `examples/roster`.\n\n#### Weekly pattern\n\nA row that owes a child\'s rows on set weekdays (a class\'s lessons, a person\'s shifts) states `records.cadence`, its days\na multi-select whose options are aliased `mon` to `sun`, and its times two `format: "time"` fields. The multi-select draws\nas a week strip wherever a person writes it; a Section holding the cadence\'s fields draws them as one week pattern; the\nrow\'s line reads it as one fact ("Tue, Thu \xB7 16:00\u201317:30"); a roster of the child reads each row\'s own days. An Act\n`makes: "<child>"` lists the rows still owed under the row each is made for, a group\'s count and tick at its head, a\nrow that would be refused unticked with why, and writes the ticked ones (`reference/record-places-pins-and-cadence`). A row that differs from a changed pattern is proposed as a move, ticked only where no person edited its day, end or a copied field and no row links to it; the class says how many rows differ.\n\n#### Agenda\n\nA child List with `layout: {"agenda": {\u2026}}` on a record: a child\'s planned entries by day, soonest first, today marked, each with its\npicture; within a day by the hour, or by a single select of the part of the day. `start` counts Day 1 from a\ndate of the record.\n\n#### Timeline\n\nA child List with `layout: "timeline"` on a record: a child read as a log of dated entries, newest first, with a composer \u2014 the\ncalls, visits and notes about the record, each with who and when, and its files where the child\'s `image`\nnames them. An app\'s Record draws no comment thread: a team\'s discussion on a record is a child table. Entries planned ahead are an agenda; the status\'s moves are its history. Worked:\n`examples/party`.\n\n### Moves and numbers\n\n#### Moves\n\nThe rows of a root List that a status stages towards its `closed` options move by Acts: each moves one option on to the next (`when` the\nstatus holds it, `set` to the next), at the foot of the Section whose work it ends. A status with nothing closed is a\ncondition a person sets. A value decided as a row reaches an outcome \u2014 why it was lost, refused, voided \u2014 is that\nAct\'s `asks`, never a field the reader must remember to fill. An Act reaching past the workspace \u2014 sending an invoice\nto a service, a letter by mail \u2014 runs its `workflow`, and what the workflow keeps from the answer (an invoice\'s id,\nits link) is named in the Act\'s `set`. Work sent back for changes moves back to the earlier\nstep; a hold is a yes/no field (and its reason) the step\'s Acts wait on in their `when`; work only some rows take is a\nstage\'s `when` (below); an issue to resolve is a row of its own. An Act also moves a row back (`when` the later\nstage, `set` the earlier): the row draws it beside the way on, and without one a row moved on by mistake stays until an\nadmin edits the table. What a `workflow` or a paper did stands, so a way back there is a correction of its own.\n\n#### Stages\n\nName each job\'s work plan by its shape: a status a person sets; a pipeline, where who holds the row and for how long\nmatter; or tasks, where only how many are done counts (`records.task`). A pipeline states each stage once in\n`records.status.stages` \u2014 its `owner` (a member field, a link\'s member field, or `{ "group": <id> }`, a member group) and its target\n`within` days \u2014 and the server holds it: only the owner\'s Acts move the row on, and a row created at a stage past the first is a move into that stage from nothing, which the stage\'s owner, an unowned stage\'s writer or a workspace admin (loading history) may make, on every path a row is written by, and a level an amount skips stands\nnamed with why. A move forward passes each owned stage between that binds the row, each its owner\'s. A stage\'s `when`\nnames the rows it binds, held as an Act\'s `when` holds them on the row\'s own fields, as the row stood before a write\nand as the write leaves it; with none, it binds every row. Expense claims over a limit wait for the finance group while\nsmaller ones go straight to payment: `"finance_review": { "owner": { "group": <id> }, "when": { "amount": { "gt": 5000000 } } }`.\nA row at a stage leaves it by its owner whatever its `when`; `dropped` names the closed options\nthat leave the work undone (cancelled, rejected), which whoever holds the row moves it to from any stage. A stage\'s owner gates who moves a row out of it; who may move a row into a stage ("only a bookkeeper marks an invoice paid") is a check. Late rows, rows due soon, a warning the line draws and rows waiting on the reader stand first in a\nregister; a register whose job is a strict order, a first-come queue, states `attention: false`.\n\n#### Stage dates and history\n\nWho changed what and when is the platform\'s audit trail, never a table and never shown by an app. When a stage\'s moment matters\nto the business \u2014 reported, filtered, printed \u2014 it is a date on the row that `records.status.dates` stamps as the row\nenters the option, whoever writes: the one way a status is timed, and the moment a stage\'s `within` runs from (each stage, and\neach open option of a status with stages, naming none gets `<option>_at`). A straight-line process is one select of its steps in order, each dated (a record whose parts state no `at` draws it as steps by itself: no date fields or formulas copy it); a move whose\nday may already be past `asks` that date with `starts: "today"`. `records.status.history` names a child the record write path appends one row to per\nstatus move (its link to the row, the new status, the moment and who) for a business that reports on every move: moves\nper person, or time in a stage a row re-enters. An event with facts of its own \u2014 a reason, an amount, a signature \u2014 is\nits own table, made by the act that records it. The rail reads the history. Worked: `examples/approval`, whose history is kept because a group\'s\nstage is signed once per person, read off who moved the row.\n\n#### Readings\n\nA List usually opens with one band of figures or a chart, chosen for what that person watches. Its Readings stand above the rows and its filters and read the rows under the open tab, never narrowed by the controls below them. Lead with the job\'s headline number \u2014\nits exception as a formula\'s yes/no in a Reading\'s `where` (what is short), never a stage the\nstatus chips already count, nor the overdue rows the register\'s summary line counts from `records.due` \u2014 then at most the mix (`by` a field) and the movement (`by` a date), varied by job. A movement over a date is stated, never defaulted; so is a sum, but for the one a status register with a money figure leads with by default: that figure over its open rows. A register with no such figure and no single select to split by gets no default band.\nA grid (`by` and `across`) reads on a Sheet. A Sheet \u2014 a View of Readings at the App\'s root, beside its Lists or alone \u2014\nanswers one owner\'s question across jobs, each Reading windowed by the reader\'s period (the App\'s `period`), and a\nList on it hands over the rows to act on. Many Readings stand on several Sheets, each a View the reader picks. A\ndashboard varies its charts by the job. A question one app\'s rows answer goes on a Sheet there; one spanning apps gets a small app of its own. A Record\'s Readings read its own child rows. Sums of each row\'s child rows are a Tab\'s `totals`. Worked: `examples/approval`, `examples/dashboard`.\n\n#### Funnel\n\nA Reading with `steps` reads a record\'s child rows as steps, each a number column summed over them \u2014 an order\'s lines\nfrom ordered to shipped. It states how much of the first step\neach later one keeps, the share lost between two neighbours, and the last over the first. State two to six\n`steps` in one unit; where the path turns \u2014 reach, then conversion \u2014 state two Readings one straight after the\nother, so the second\'s bars are read over its own first step, on one grid. A step no row holds a number in reads as not measured: leave it empty, never a zero nobody measured.\n\n#### Priced lines\n\nA quote\'s items, an estimate\'s works, a repair sheet\'s damages are lines priced off a book: a table whose\n`records` names each item, puts the code people type on its line and its price as its `figure`. The line links to\nit, asks the link and its quantities in its List\'s `create`, and copies the price (`default_from`), so the quote\nkeeps what was quoted when the book moves. A line\'s amount is a formula, the record\'s total a rollup over the rows\nthe List shows \u2014 what is not paid for is a second rollup, never a filter on the first, so each group subtotals.\nGroup the lines by the parts the record is quoted in (a container, a room, a leg), a field the line asks. A book worked only while a quote is written is the picker on the quote\'s lines; a book with a keeper, Acts or a history of its own is\nan app (`app_architecture`).\n\n### The record\n\n#### Sections\n\nA record is a head, its parts and at most one Side. From three parts it shows one part at a time; fewer stack. A part is one area of the record\'s data a person comes to for its own job, like the tabs of a settings page; its related lists and field groups sit inside it under their headings. A status\'s stages are not areas: their acts stand at the foot of the rows they move. State each\npart whole for the work there: a field may stand in any number of parts, and a field an Act requires draws beside it\nunstated. A step may hold nothing but its name. What a person needs in view at every part (who it is for, how to reach\nthem) goes in a Side: it leaves the head and stays on the rows; what only a stage\'s Act writes (an invoice\'s number,\na delivery\'s signature) stands empty before it, so it goes in that stage\'s Section (`at`), never the Side. The status\nstands in the head or the Side, never a Section. `row` changes how the app\'s rows read, never a page nor what the app writes. A List, Reading, Statement or Act stated alike in several\nSections draws once, in the first; a Check stated in a Section guards the whole record.\n\nThe Record\'s Sections, in the order the work reaches them: the fields people write, a Field per paper the record\nkeeps, a child List per child, the Acts at each one\'s foot. A register\'s `columns` are in the order the job reads them, as many as fit a desk; what is read only on the way deeper is the Record\'s, and a figure that is final only from a stage is a Field of that stage\'s Section, never a column read on every row at every stage. A register laid out in time (calendar, lanes, roster) opens the\ndefault record: every field a person writes. Behaviour belongs in an Act.\n\nA Section of more than about six fields reads as Fieldsets of related facts: a patient\'s record holds "Contact" and\n"Insurance" rather than one run of nine, each Fieldset\'s `label` a few words. A gallery or prose Field stands beside the Fieldsets (`reference/fieldset-node`). Fields stand two\nto a line in the order stated, and files, prose and a link to several rows take the whole line: stated after a lone\nshort field, one leaves the half beside that field empty.\n\n#### Children\n\nRows that each belong to one row of another table (a one-row link to it) are drawn under that row: a List on\nits Record, `layout: "timeline"` where they are a log, `layout: {"agenda": \u2026}` where they are planned on a day and within it, a roster of\nthem, or lanes of them by that link. Which children a record lists is the author\'s \u2014 one of them at least. A List\nlisting only some of them narrows by its `where`: a select (one leg\'s fees), or a yes/no \u2014 a formula\'s for what is\nstill owed \u2014 on a List that adds no rows. A child List stating no `create` asks the table\'s required fields, natural key and\ntitle; where defaults fill them all, it adds none. Rows on\nfile before the row they come to belong to \u2014 a job\'s cost lines before the supplier bill over them \u2014 are picked into\nit: a List with `pick`, often with no `create` and no `remove`.\n\n### Papers\n\n#### Expect\n\nA List with `expect` naming the child\'s title \u2014 a single select of kinds, or a one-row link to a\ncatalog: one line per kind, the ones not yet filled standing empty, filled in place. `of` narrows the kinds\nto the record\'s own multi-select of those it needs. The papers a case gathers, the fees a record knows it\nowes. Worked: `examples/case`.\n\n`only` lists the kinds a List holds a line for, so each kind stands in the Section whose job it is, once. The Act making a paper (`paper: "<child>.<kind>"`), stated in the Record beside its Sections and moving the record as any Act does, is its line\'s button while it applies, the upload in the \u22EF.\n\n#### Templates\n\nA paper the business makes is an Act\'s `template`, kept in the record\'s files field `into` \u2014 or several at\nonce, `templates`: listed where the Act stands, each made one as its file, each not yet made a placeholder,\nthe reader ticking which to make. Worked: `examples/case`.\n\n#### Intake\n\nA paper the business is brought and reads is an Act\'s `intake`: the press takes the papers, an agent reads\nthem, and each is filed as the line of its kind in the child the record `expect`s, while `fills` writes what\nthey state into the record\'s fields \u2014 a single link as a row the agent finds among those the app reads \u2014 shown before it is saved. Stated with `on: "view"` at the register\'s title, the papers make a NEW record instead: `fills` names what it requires, `<link>.<field>` fills the row a required link names (found on its entity\'s `natural_key`, else added), and the register opens the record made. Worked: `examples/case`.\n\nAn agent Act \u2014 an `intake`, a `record`\'s `fills` \u2014 spends a run on every press, so it is stated only where the\nowner asked for an agent to do that job; otherwise a paper brought is its `expect` line, and a person types what it states.\n\n#### Under\n\nA List with `under`: the documents that cover lines (an invoice over its fee lines) stand as headings\nover the lines they cover, and a line no document covers offers to make one. A document entered as it arrives over lines\nalready on file (a supplier bill) picks them with `pick` instead; choose one per document.\n\n### Calls\n\n#### Record act\n\nAn Act\'s `record`: the press records a call, visit or meeting \u2014 audio, transcript, screen where captured \u2014 and\nfiles it as a new row of the record\'s `timeline` child (`into`), stamped `at` and `by`; `fills` lets an agent fill\nthat row\'s fields from the transcript, where the owner asked. Worked: `examples/calls`.\n\n';
1870
+ var design_default = '# Designing an app\n\nAn app is a tree of components: a List of one table, the Record a row opens, its Sections, the Acts that move it. The\ntree states COMPOSITION \u2014 which fields, lists and acts each job\'s screen holds; how each piece looks is the platform\'s,\none way per concept. A node the tree leaves out draws its default, from the table\'s facts (`records`, the stage, the\nwrite rules): a List\'s Readings band, the stage buttons, the picture, a Record\'s Sections. State a node to change it,\nor `false` at it to turn it off (`"readings": false`, a Record\'s `"row": { "image": false }`). A field is written where its Record declares it: a Section\'s Field, the table\'s face (title, line, picture, figure), or every field where the Record states no Section; the head, a line, a column or a board draws it, and never makes one written; every head part (`row.title`, each `row.subtitle` entry, `row.figure`, `row.image`) takes `edit: false` to be read. A drawn Field is a control unless it\nor its entity is read-only (`edit: false`); a stepped status never is, since Acts move it. Which apps a business needs is `app_architecture`.\n\n**The visual bar.** Every screen is judged against it; a miss is a change to the tree.\n\n- Each app looks like its own rows: the view its kind of row takes (`design/treatments`) \u2014 cards for things found by\n their photo, a calendar or lanes for dated work, faces for people and organisations. A List left as a table is drawn\n as one, the most common failure of an app; the answers of `set_app` and `get_app` note the view rows that are work in time call for (a calendar, lanes, a roster, a gantt where rows wait on one another).\n- What needs attention leads the row as an issue its table declares (`design/issues`): a derived flag is an issue, in the\n warning tone on the row\'s line (in the danger tone where a Check\'s `on` refuses an act the row offers); every other yes\n reads in the success tone. `records.mark` is a category\'s own mark, a select whose options carry a brand or glyph.\n- A list\'s columns: the name and its lead, the status, then the columns the job reads on every row, as many as fit a desk. Each\n fact once: a column the row draws itself stands once. A generated number (`autonumber`) as the title yields\n the row\'s name to the subtitle\'s first part and stands first on its line.\n- A list worked by a date states `sort` on that date\'s column, newest first; without one, a register reads newest made\n first and a record\'s child List in the order its rows were added.\n- Someone is a face wherever they are read: a link to a table stating `records.party` draws its row\'s face; a member\n field is one already; select options naming people or organisations who are neither each take the `mark`\n `{"kind": "avatar", "name": "person"}`, never a colour dot.\n- A thing shows its picture, a file its preview, a plan its days on a time axis, a quantity a meter (`records.limits`) or\n a chart, a register its Readings, and long text reads whole (a markdown Field; `block: true` on plain long text).\n- An option with a `color` draws its dot where its select is drawn; one without reads as its word. A `mark` where a\n brand or glyph names the option, on every option of a select read down a column (how it was paid, the channel).\n- Every app states its tile\'s `color`, apart from the workspace\'s other apps where it can be.\n- The paperwork is the proof of the work: a files field per purpose (what arrived, what was issued to the customer, the\n carrier, the authority) in the Section where that work happens, and the source of a\n figure (a screenshot, an email, a sheet) on its row. Every files field is drawn somewhere. A paper a counterparty\n sends (a supplier\'s invoice, a delivery receipt) is added on the record it arrives with \u2014 the order it is for \u2014 and\n listed again where it is settled, never only in the counterparty\'s ledger.\n\n<!-- generated:start words -->\n\n**The words most builds state.** A node\'s page holds its rules and every other word: `reference/list-node`, `reference/records`, `reference/field`.\n\n**Table**\n\n- `ref` (alias): A created table\'s handle in this call\n- `label` (text, required): The table\'s name in the workspace\n- `singular` (text): One row of this table, in the business\'s own words\n- `title` (alias): The alias of the field that names a row wherever a link or a record shows one\n- `fields` (map of alias \u2192 Field, required): The table\'s columns, each under its alias, which is its key here and so is never stated inside it\n- `records` (any value): How a row is recognised\n- `checks` (map of alias \u2192 table check (`workflows/table-checks`)): The conditions a write of the table\'s rows may not meet, each under its alias\n- `unique` (list (at least one) of list of alias (at least one)): Sets of fields whose values no two live rows share\n\n**Any field**\n\n- `label` (text, required): The field\'s name in the workspace\n- `required` (boolean): Refuse a record whose cell for this field is empty\n- `default_from` (text): Copied when a record is made off the row a one-row link of this entity names\n\n**`number` field**\n\n- `notation` (notation): How the figure reads\n- `min` (number | text): Refuse a create or update whose value is below this\n\n**`select` field**\n\n- `options` (list of Select option (at least one), required): The choices, in the order every picker and every ladder lists them\n- `multi` (boolean): Allow multiple selections\n\n**`link` field**\n\n- `table` (text, required): The table the link points at\n- `multi` (boolean, required): Whether a row links to one row or many\n- `pair` (`true` | alias): Makes the link two-way\n\n**`formula` field**\n\n- `expression` (text, required): The expression, over fields of THIS entity by alias in braces\n- `output_type` (`"number"` | `"text"` | `"date"` | `"datetime"` | `"boolean"` | `"select"`): Holds a formula to the type its readers need\n\n**`rollup` field**\n\n- `via` (alias, required): The alias of a link of this table to roll up from\n- `op` (operation, required): The operation over the linked rows\n- `field` (alias): The alias of the field on the linked table the operation reads\n\n**`lookup` field**\n\n- `via` (alias, required): The alias of a link of this table to look up through\n- `field` (alias, required): The alias of the field on the linked table to show\n\n**`autonumber` field**\n\n- `prefix` (text): Literal prefix prepended to every display value (e.g. \'KH-\' \u2192 \'KH-001\')\n\n**`records`**\n\n- `subtitle` (list of alias (1\u20132)): Up to two fields read under the title wherever a row is drawn (a code, a date, a party)\n- `figure` (alias): The one number the row stands for, read at its right (a total, a quantity left)\n- `status` (Status): The stage a row moves through, a single select, drawn in the record\'s head, or its Side where the Side states it\n- `due` (list of alias (at least one)): Dates that are deadlines (stored, or computed as a date)\n- `image` (alias): A files field that pictures the row, or a one-row link to a table with a picture, whose picture the row leads with\n- `party` (`"person"` | `"organization"` | `"organisation"`): What each row is where the rows are people (a contact, a patient) or organisations (a customer, a supplier, a carrier)\n- `limits` (map of alias \u2192 (alias | number)): A number read against a bound\n- `starts` (map of alias \u2192 `"today"` | `"me"`): What a field of a row being added starts at, where that start is certain\n- `mark` (alias): A single select (or a lookup of one through a one-row link) whose option leads the row wherever a mark leads it\n- `settled` (alias): A yes/no of the row (stored, a formula: an invoice paid in full, or looked up through a one-row link: a line settled with its parent) that ends its deadlines\n\n**`records.status`**\n\n- `field` (alias, required): The single select that is the row\'s state, its options in the order the work goes through them, read as steps by itself on a record whose parts state no `at`\n- `closed` (list of alias (at least one)): Options that end the work\n- `history` (text): A table every write that sets or moves the status appends one row to (its link to this table, the new status, the moment and who)\n- `dates` (map of alias \u2192 alias): Option alias \u2192 a date field of this entity the record write path stamps with the moment a row moves into that option, or is made at it\n- `stages` (map of alias \u2192 Stage): Option alias \u2192 who owns that stage and how long it should take\n\n**App**\n\n- `key` (alias, required): The app\'s alias, its name among apps\n- `name` (text, required): The job, in the words of the people who do it\n- `children` (list of (List | Sheet | Query | Workflow) (at least one)): The App\'s Views in order\n- `color` (colour): The launcher tile\'s colour\n- `pages` (list of Record (at least one)): The page the rows of an entity open, one per entity, each a Record stating its `entity`\n\n**List**\n\n- `entity` (alias, required): The table whose rows the List draws\n- `create` (boolean | list of alias (at least one)): The fields an add asks\n- `columns` (list of (alias | Edit column)): Fields read after the row\'s title, each drawn though no row holds it\n- `label` (text): The register\'s name in the app\'s lists and tab strip\n- `filters` (list of (alias | Tiered filter | Listed filter) (at most 3)): Fields the reader narrows by every day, beside the stage chips\n- `children` (list of (Tab | Reading | Export | Act | List) (at least one)): Its Tabs, band Readings, Exports and Acts over ticked rows or every row in view\n- `key` (alias): Names the List among its siblings and in a Query\'s `list`\n- `sort` (Sort key | list of Sort key (at least one)): The rows\' order\n- `layout` (layout): A word, or an object stating one layout with its data\n- `remove` (boolean): Rows offer a Delete\n- `search` (list of alias (at least one) | `false`): Fields the search box reads\n- `where` (narrowing): A fixed narrowing on the server, for every reader\n- `group` (alias | `false`): A field the rows stand grouped by, a gantt drawing the groups as its lanes\n- `expect` (alias | Expect): What a record should hold, shown before it does\n- `opens` (narrowing): The view the register opens on, a chip the reader may take away\n\n**Record**\n\n- `entity` (alias, required): The table whose rows open on this page\n- `children` (list of (alias | Field | Fieldset | Section | Side | Outside | List | Reading | Statement | Act | Check) (at least one)): Parts (Section, Side), or for a one-part record its Fields, Fieldsets, Lists, Readings and Statements directly\n- `add` (`false` | list of alias (at least one)): What a new row asks where a picker of this entity offers one, anywhere in the App\n- `row` (Record row): How the App reads this entity\'s rows wherever it lists them\n- `door` (`"page"` | `"drawer"`): How a row opens, on a page or in a drawer\n\n**Section**\n\n- `title` (text): The part\'s heading\n- `key` (alias): Unique among its siblings\n- `children` (list of (alias | Field | Fieldset | List | Reading | Statement | Act | Check) (at least one)): What the part draws, in reading order\n- `at` (list of alias (at least one)): Options of the record\'s status during which this part is the work now\n- `when` (condition): Drawn only while this holds\n\n**Field**\n\n- `field` (alias, required): The field\'s alias\n- `edit` (boolean): Shows a value nobody changes here\n- `label` (text): The heading of the field\'s gallery or prose block, where it draws as one\n- `block` (boolean): Gives a field room of its own\n\n**Act**\n\n- `key` (alias, required): The act\'s name\n- `label` (text, required): The verb, as the reader says it\n- `when` (condition): The act works only while this holds\n- `set` (map of alias \u2192 value): What the act writes\n- `asks` (list of (alias | `{ "field": alias, "starts": "today" | "me" }` | Asked input) (at least one)): What the reader states on pressing\n- `confirm` (`true` | text): The press asks first\n- `requires` (list of alias (at least one)): Fields filled first, each drawn where the act stands\n- `template` (alias): A document template it makes a file from\n- `into` (alias): The record\'s files field keeping the document\n- `owner` (`"field"` | `"link.field"` | `{ "group": id }`): Who presses it\n- `workflow` (alias): The workflow it runs for what `set` cannot say\n- `danger` (`true`): The act destroys or cannot be undone\n\n**Check**\n\n- `field` (alias, required): A yes/no or text formula of the page\'s entity\n- `on` (`"all"` | list of (`"update"` | alias) (at least one)): What the standing issue refuses\n- `resolve` (alias): An Act on one row of this entity that clears it\n\n**Reading**\n\n- `label` (text): What the figure is called\n- `value` (alias | `{ "avg": alias }`): A number field summed over the rows, or `{ avg }` averaged over the rows holding one\n- `by` (alias | Tiered filter): Splits the rows into parts\n- `where` (narrowing): Only the rows whose select holds one of these options, whose yes/no is this value, whose number or date meets its bounds (`gt`, `gte`, `lt`, `lte`; a date\'s `{ "now": true }` is read when the rows are), whose field is `{ "empty": true | false }`, or whose member field holds the reader (`{ "me": true }`)\n- `entity` (alias): The List\'s rows\n- `over` (alias): The date that places a row in time\n\n<!-- generated:end words -->\n\n## Issues\n\nWhatever goes wrong on a row and needs a person to act \u2014 a line delivered short, a price missing, a customer over their\ncredit limit, a permit about to expire \u2014 is an issue its table declares in `records.issues`. A declared issue stands in\nevery app that draws its row, with no app stating it: first on the row\'s line (`+N` the others), in the record\'s\ncallout, in the List\'s filter of what needs checking with how many rows hold it, and those rows first. It never makes an\napp draw a row it did not, and never shows on an `Outside` page. What needs no one\'s action is no issue: a stage is the\nstatus, a category a select.\n\n- An issue is a formula of the row stating `output_type`: `"boolean"` stands while true; `"text"` stands while not empty,\n its words the sentence the reader sees \u2014 use it when the sentence must say what or how much ("Short 4 of 10").\n Its label is its name. Put the moment it matters in the formula, so it clears itself when the work is done.\n- The list is priority: an issue blocking the next step leads, then the earlier in the list.\n- `{ "rows": <link> }` on a parent rolls up every issue its child table declares, through a many-link paired to the\n child\'s one-row link back. The platform keeps a count on the parent per child issue, `<link>_<issue>`, labelled\n "<link label> \xB7 <issue label>"; never write it. The parent reads "2 rows left: Lines \xB7 Short".\n- A formula reading `now()` or `isToday()` (overdue, expiring within 30 days) is judged again every night, to the day.\n- An app\'s `Check` says what the issue does not: `on`, what it refuses in that app (`"update"`, `"all"`, or that\n entity\'s Acts), and `resolve`, the Act that clears it; one stating neither is refused, and one without `on` names a\n declared issue. A parent\'s Act is refused by a Check on the parent\'s count `on` that Act (never `"update"` or `"all"`: editing the rows clears it); the act then holds\n the parent while it runs, so its own `workflow` cannot send mail, notify, run an agent or wait \u2014 start that work from a\n workflow the act starts after.\n- A lock is a Check, not an issue: a yes/no such as paid in full refusing `"update"`, in no `records.issues`, since nothing\n is wrong with the row.\n- `get_table` reports each issue: rows holding it now, opened in the last 30 days, median days to clear.\n\nAn order whose lines can arrive short or unpriced, invoiced only when no line is short:\n\n```json5\n// order_line\n"fields": {\n "short": { "label": "Short", "type": "formula", "output_type": "text",\n "expression": "!isEmpty({delivered}) && {delivered} < {quantity} ? \\"Short \\" + toString({quantity} - {delivered}) + \\" of \\" + toString({quantity}) : \\"\\"" },\n "no_price": { "label": "No price", "type": "formula", "output_type": "boolean", "expression": "isEmpty({price})" }\n},\n"records": { "issues": ["short", "no_price"] }\n// order \u2014 `lines` is its many-link to order_line; the platform adds lines_short and lines_no_price\n"records": { "issues": [{ "rows": "lines" }] }\n// the order\'s Record in the app\n{ "type": "Check", "field": "lines_short", "on": ["invoice"] },\n{ "type": "Check", "field": "paid_in_full", "on": ["update"] }\n```\n\n## Look at it\n\nAfter an apply, `screenshot_app` draws each app as its people see it \u2014 the register, and a record by its `path` or its `record_id`\n(with a `path` on that record, such as one Section; `screen` for a later screen of a long one), up to six `pages` in one call \u2014 at a desk\'s width and a phone\'s, naming the columns a table left off at each width;\n`-o <dir>` saves the shots from the CLI. `set_app` with `app_id`, an empty `body` and `dry_run` answers what a write of the\nstored tree would be refused for now, and its notes. Answer `design/the-rubric`, change the tree with `nodes`, and write again. To go back,\nsend the tree saved before the change as `body` with `app_id`, nulling an App prop stated since (`words`, `scope`,\n`period`, `icon`); tables and rows stay as they are.\n\n## The rubric\n\nWhether the build does the owner\'s work, answered by a call each, never from what you meant to write:\n\n1. Each job the owner named, and each their kind of business cannot run without: which screen does it, and which press? Find each on a `screenshot_app` shot of the person who does it (`as_member`); one who cannot open the app is first invited (`set_members`) and given it (`set_access`) \u2014 an app nobody shares opens for admins alone.\n2. Can an agent do each job in one call, an `act_<key>` or a Query or Workflow node whose `description` names it? `get_app` lists them; `run_app_workflow` with `dry_run` proves one (`agent_surface/prove-an-app-as-an-agent`).\n3. Is each kind of row in its treatment (`design/treatments`)? Timed work reads in a calendar or lanes, and a weekly plan as the dated rows it makes.\n4. Does each screen show the least its next step needs, each fact once, the signal that a step is due leading?\n5. Is anything cramped at desk or phone width?\n6. Is every paper and every Export made, those this kind of business sends unasked too, with no blank? Press each paper Act and read the file it files; prove an Export with `run_app_query` and `export`.\n7. Is each thing that must never happen in this business (a step taken before its approval, stock below zero, a double booking) refused on every write? Prove each with a write sent `dry_run: true` that is refused (`workflows/table-checks`).\n\nA failed answer is a change to the tree, or a gap named to the owner.\n\n## Treatments\n\nThe answers of `set_app` and `get_app` note the view rows that are work in time call for (a calendar, lanes, a roster, a gantt\nwhere rows wait on one another), naming the node that would state it; a note refuses nothing. No other treatment below is noted.\nEach kind of row\'s view is chosen before its List is written:\n\n| The rows are | The treatment | Its own page |\n|---|---|---|\n| People or organisations | `records.party`, with a photo or logo as its `image` | |\n| Things with a photo, a scan or a paper | `records.image`; List `layout: "cards"` where the picture is how a row is found | `reference/cards` |\n| Read by their day | List `layout: "calendar"`; on a record, a child List with `layout: {"agenda": \u2026}` | `reference/calendar`, `reference/layouts` |\n| Ranked by a figure, or worked by a date | List `sort: {"field": \u2026, "desc": true}` on that column | |\n| Booked on a resource | List `layout: {"lanes": {"by": \u2026}}`, and the table\'s `no_overlap` \u2014 a list of rules where a row holds two (a room and a teacher) | `reference/lanes`, `reference/write-rules` |\n| A day\'s work given out to people or vehicles | List `layout: {"lanes": {"by": \u2026}}` over rows holding a day and no hour | `reference/lanes` |\n| A log of what happened | a child List with `layout: "timeline"` | `reference/layouts` |\n| Opened to be worked on | the Record\'s Sections \u2014 each one area of the record\'s data, its lists and field groups inside it; a status\'s stage acts stand at the foot of the rows they move, `at` where the work moves in steps; fields only one kind of row holds (a delay\'s cause, a safety issue\'s hours lost) in a Section whose `when` names that kind | |\n| Rows that each belong to another row | a child List on that row\'s Record, with `create` and `remove` \u2014 and a child\'s own rows a List in that child\'s page, as deep as the data goes, and every row\'s \u22EF offers Duplicate; a List with `same` where read-only | |\n| A related row\'s value on the list (the newest contract\'s end date) | a `lookup` field of the table, ordered, as a column | `reference/lookup` |\n| Moving through a status | an Act per move, `status.dates` for the moment of each stage, and the register\'s Readings | |\n| Counted over a period | the register\'s Tabs over one `period`; a Tab\'s `totals` for a child\'s sums before, during and through it; an open Tab\'s `where` reads only what was true at the period\'s end, never a status the row moves on from | |\n| Papers a case gathers | a List with `expect`; the papers made, an Act\'s `templates` | |\n| A plan of spans | List `layout: {"gantt": {"start": \u2026}}` | `reference/gantt` |\n| Stood at a place on a plan, flat or in 3D \u2014 pallets, bins | List `layout: {"plan": \u2026}`; places state `plan_place` | `reference/plan` |\n| Checked item by item against a standard | a List with `checklist: {"photo": \u2026, "clause": \u2026, "failed": [\u2026], "passed": \u2026}`: each row a mark (passed at `closed`, failed at a `failed` option, or by the yes/no `passed` names \u2014 a measured verdict, no task or status needed), its photo and the clause it is checked against; with `expect` on the standard\'s items, each item is a line marked the same way and filled by the block\'s columns | |\n| A place before and after the work | a List with `compare: {"before": \u2026, "after": \u2026}`: two files fields read side by side, or two value fields read as one struck-then-new column | |\n| Spots on a drawing | `records.pin: {"on": \u2026, "x": \u2026, "y": \u2026}` on the spots\' table: a record listing rows that link to them draws the picture with a numbered pin at each; the picture is the `on` row\'s `records.image` | `reference/record-places-pins-and-cadence` |\n| Photos that must be taken on site | `records.on_site: {"photos": [\u2026]}`: a photo taken through the camera keeps where the device stood, and a record holding one taken away says so | `reference/record-places-pins-and-cadence` |\n| The real size of the thing (a carton, a piece of furniture, a pallet) | `records.size: {"across": \u2026, "along": \u2026, "up": \u2026}`: three number fields in one length unit, read as one fact "400 \xD7 300 \xD7 250 mm" after the subtitle; a plan register draws each box at that size | `reference/record-places-pins-and-cadence`, `reference/plan` |\n| A number painted on the thing, or a barcode or QR code on it | `records.scan: "iso6346"` or `"text"` (read off one photo by an agent), or `"code"` (decoded on the device, no agent): the title read on a phone, beside each search matching it | `reference/record-places-pins-and-cadence` |\n| The rows a weekly pattern owes (a class\'s lessons on Tue and Thu at 16:00) | `records.cadence: [{"entity": \u2026, "on": "<a multi-select of mon\u2013sun>", "start": \u2026, "end": \u2026, "planned": \u2026, "except": \u2026}]` on the parent, and an Act `makes: "<child>"`: the press lists the rows still owed, each with what would stop it, and writes the ones ticked; pressed again it lists what is missing, and moves a row to the pattern\'s hours and copied fields where it differs and no person or linked row has touched it (ticked), else leaves it unticked saying why | `reference/record-places-pins-and-cadence` |\n| Who did what on which day | List `layout: "roster"` with the List of its cells inside | `reference/roster` |\n| Someone with no seat signs off one record (a buyer approves a proof, a client signs a handover) | the Record\'s `Outside`: the Fields and Lists the link shows as they are, and Acts that each move the status out of its `at` \u2014 a link a member makes of the record, never a seat; the link\'s page names the record only where the Outside states its title\'s field | |\n| Steps people drop out of between | a Reading with `steps` on the record whose child rows count them | |\n| A record\'s own numbers nobody keys, read at a glance | consecutive Readings with no `entity` (up to eight tiles) | |\n| Rows that are each a place a record is sent | a List with `expect` on the link to those places and `post`: each ticked, the post written there and read as its feed shows it | `reference/publish-desk` |\n| Papers an agent reads, where the owner asked for one | an Act\'s `intake` with `fills` | |\n| Calls and visits | an Act\'s `record` | |\n| Changes a workflow proposes that a person approves row by row \u2014 a price list applied, a statement matched to what is owed | an Act\'s `workflow` with `review`, its body returning a changeset in `data.review` | |\n| Documents covering lines | a List with `under` | |\n| Rows on file a record takes in | a List with `pick` | |\n| One owner\'s question across jobs | an App of Tabs and Readings and no register | |\n\nWhat these nodes do not state, a long-form writing page or a bespoke tool, is a custom-code app (`lotics app create <name> --custom`, `app_bindings`), never a new node.\n\n### Faces and pictures\n\n#### Party\n\n`records.party` is `"person"` where the rows are people (a contact, a patient, a driver) and\n`"organization"` where they are companies (a customer, a supplier, a carrier). Every surface drawing one of\nits rows then draws a face: its `image` (a photo, a logo), else its initials. Without it, a person is drawn as a thing. A workspace\nmember is a `member` field, and is drawn by their face already. A column holding a link to several rows of people,\nor several members, draws their faces as a stack that names them on hover. Worked: `examples/party`.\n\n#### Image\n\n`records.image` names the files field that pictures a row \u2014 a product\'s photo, a damage photo, a\nscan, a receipt. Every row of it then leads with its picture, or its paper\'s preview, wherever it is drawn \u2014\na row holding no picture leads with the placeholder; a link to it previews the file. `image` may instead name a\none-row link to a table with a picture (an order line\'s `item`): the row leads with that row\'s picture, still titled by\nits own words. Never a field an Act keeps the paper it makes in (`into`). List\n`layout: "cards"` where the picture is how a row is found. A files field the record keeps as a folder of\npapers is drawn as a Field, read whole. Worked: `examples/cards`.\n\n#### A link opens its row\n\nEvery row an app draws opens on its page, the one you state or a default. A List\'s rows default to the table\'s fields; a link\'s row defaults to its name, line, status and figure. State `pages/<e>` to show more or to edit.\n\n### Rows in time\n\nRows that each stand on a day, or hold a run of days or hours, are read where they stand in time \u2014 never\nas two date columns. A row holds a span when two dates a person states are ordered, the second after the first by a\n`min` or a table check, both required or the second the row\'s `due`; else it is an appointment when one required date\nis stated that no Act stamps, that a new row does not start at `today` and that is not derived. A stamp is an event,\nand a `due` is a deadline, never the day a row is held on. A `no_overlap` by a person or a value alone keeps one row at\na time each \u2014 a member\'s periods in turn \u2014 read by what they hold.\n\n#### Calendar\n\n`layout: "calendar"`, or `{ "calendar": { "date": "starts_at", "end": "ends_at" } }`: the rows by their day \u2014 a\nmonth, a week, a day or a list; an entry at its hour where `date` holds one, over its span where `end` names the date it\nruns to. The bare word takes both from the rows\' facts and is refused, naming `date`, where they name none. An entry pressed opens its row beside the calendar; where the app saves the row, a drag or F2 moves it. Worked:\n`examples/calendar`.\n\n#### Lanes\n\n`layout: {"lanes": {"by": \u2026}}` with `by` naming a one-row link whose target\'s rows are the lanes (a chair, a\nmachine, a room), each drawn even when empty: every row a block from the first date on its line to the\nsecond, and a free stretch adds a row there. `loads` reads what a lane carries against what it holds: hours summed\nwithin each day (across days, the fullest day, named), any other number the most its rows add up to at one time. A\n`no_overlap` `by` the same link refuses two rows on one resource at once. A lane per person: `by` a member field\nand `of` a role of the model, each member of it a lane, idle ones too. Worked: `examples/lanes`.\n\nA day\'s work given out (stops to drivers, jobs to technicians): rows holding a day and no hour read at one day as cards\nin lanes, those no lane holds, or holding no day, first in a tray. Each lane\'s head reads its count, its loads and its\nrow\'s status; a lane its link no longer admits (`options_where`) says so in its head and refuses a card. Where the app writes the link, cards ticked or\ndragged go to a lane in one write, every row checked before any is written, and the List\'s first `sort`, ascending on a\nnumber the app writes, is a card\'s place in its lane.\n\n#### Gantt\n\n`layout: {"gantt": {"start": \u2026}}` (and `end`, else the table\'s first `due`; a `due` is a deadline, never an appointment date): one bar a row over\nits run of days, read against today. `milestones` marks\ndates on the bar, `planned` the plan under it, `progress` how far it is done, `after` the rows it waits on;\nthe List\'s `group` is its lanes; a table holding rows under rows nests each bar under its row above, folded as the\nregister\'s outline is. A child List on a record with this layout draws the bars of the rows its link names. Worked: `examples/gantt`.\n\n#### Roster\n\n`layout: "roster"` with a List inside it over the child whose rows fill the days \u2014 one link back to the\nregister\'s table and a date on its line: what each row did on each day (shifts, runs, attendance). With\n`expect` (and `of`) on the cells the columns are the options of a select instead of days: which papers each row holds.\nAn `Export` with an html or Excel `template` prints the grid as the screen reads it (`document_templates/a-template`). Worked: `examples/roster`.\n\n#### Weekly pattern\n\nA row that owes a child\'s rows on set weekdays (a class\'s lessons, a person\'s shifts) states `records.cadence`, its days\na multi-select whose options are aliased `mon` to `sun`, and its times two `format: "time"` fields. The multi-select draws\nas a week strip wherever a person writes it; a Section holding the cadence\'s fields draws them as one week pattern; the\nrow\'s line reads it as one fact ("Tue, Thu \xB7 16:00\u201317:30"); a roster of the child reads each row\'s own days. An Act\n`makes: "<child>"` lists the rows still owed under the row each is made for, a group\'s count and tick at its head, a\nrow that would be refused unticked with why, and writes the ticked ones (`reference/record-places-pins-and-cadence`). A row that differs from a changed pattern is proposed as a move, ticked only where no person edited its day, end or a copied field and no row links to it; the class says how many rows differ.\n\n#### Agenda\n\nA child List with `layout: {"agenda": {\u2026}}` on a record: a child\'s planned entries by day, soonest first, today marked, each with its\npicture; within a day by the hour, or by a single select of the part of the day. `start` counts Day 1 from a\ndate of the record.\n\n#### Timeline\n\nA child List with `layout: "timeline"` on a record: a child read as a log of dated entries, newest first, with a composer \u2014 the\ncalls, visits and notes about the record, each with who and when, and its files where the child\'s `image`\nnames them. An app\'s Record draws no comment thread: a team\'s discussion on a record is a child table. Entries planned ahead are an agenda; the status\'s moves are its history. Worked:\n`examples/party`.\n\n### Moves and numbers\n\n#### Moves\n\nThe rows of a root List that a status stages towards its `closed` options move by Acts: each moves one option on to the next (`when` the\nstatus holds it, `set` to the next), at the foot of the Section whose work it ends. A status with nothing closed is a\ncondition a person sets. A value decided as a row reaches an outcome \u2014 why it was lost, refused, voided \u2014 is that\nAct\'s `asks`, never a field the reader must remember to fill. An Act reaching past the workspace \u2014 sending an invoice\nto a service, a letter by mail \u2014 runs its `workflow`, and what the workflow keeps from the answer (an invoice\'s id,\nits link) is named in the Act\'s `set`. Work sent back for changes moves back to the earlier\nstep; a hold is a yes/no field (and its reason) the step\'s Acts wait on in their `when`; work only some rows take is a\nstage\'s `when` (below); an issue to resolve is a row of its own. An Act also moves a row back (`when` the later\nstage, `set` the earlier): the row draws it beside the way on, and without one a row moved on by mistake stays until an\nadmin edits the table. What a `workflow` or a paper did stands, so a way back there is a correction of its own.\n\n#### Stages\n\nName each job\'s work plan by its shape: a status a person sets; a pipeline, where who holds the row and for how long\nmatter; or tasks, where only how many are done counts (`records.task`). A pipeline states each stage once in\n`records.status.stages` \u2014 its `owner` (a member field, a link\'s member field, or `{ "group": <id> }`, a member group) and its target\n`within` days \u2014 and the server holds it: only the owner\'s Acts move the row on, and a row created at a stage past the first is a move into that stage from nothing, which the stage\'s owner, an unowned stage\'s writer or a workspace admin (loading history) may make, on every path a row is written by, and a level an amount skips stands\nnamed with why. A move forward passes each owned stage between that binds the row, each its owner\'s. A stage\'s `when`\nnames the rows it binds, held as an Act\'s `when` holds them on the row\'s own fields, as the row stood before a write\nand as the write leaves it; with none, it binds every row. Expense claims over a limit wait for the finance group while\nsmaller ones go straight to payment: `"finance_review": { "owner": { "group": <id> }, "when": { "amount": { "gt": 5000000 } } }`.\nA row at a stage leaves it by its owner whatever its `when`; `dropped` names the closed options\nthat leave the work undone (cancelled, rejected), which whoever holds the row moves it to from any stage. A stage\'s owner gates who moves a row out of it; who may move a row into a stage ("only a bookkeeper marks an invoice paid") is a check. Late rows, rows due soon, a warning the line draws and rows waiting on the reader stand first in a\nregister; a register whose job is a strict order, a first-come queue, states `attention: false`.\n\n#### Stage dates and history\n\nWho changed what and when is the platform\'s audit trail, never a table and never shown by an app. When a stage\'s moment matters\nto the business \u2014 reported, filtered, printed \u2014 it is a date on the row that `records.status.dates` stamps as the row\nenters the option, whoever writes: the one way a status is timed, and the moment a stage\'s `within` runs from (each stage, and\neach open option of a status with stages, naming none gets `<option>_at`). A straight-line process is one select of its steps in order, each dated (a record whose parts state no `at` draws it as steps by itself: no date fields or formulas copy it); a move whose\nday may already be past `asks` that date with `starts: "today"`. `records.status.history` names a child the record write path appends one row to per\nstatus move (its link to the row, the new status, the moment and who) for a business that reports on every move: moves\nper person, or time in a stage a row re-enters. An event with facts of its own \u2014 a reason, an amount, a signature \u2014 is\nits own table, made by the act that records it. The rail reads the history. Worked: `examples/approval`, whose history is kept because a group\'s\nstage is signed once per person, read off who moved the row.\n\n#### Readings\n\nA List usually opens with one band of figures or a chart, chosen for what that person watches. Its Readings stand above the rows and its filters and read the rows under the open tab, never narrowed by the controls below them. Lead with the job\'s headline number \u2014\nits exception as a formula\'s yes/no in a Reading\'s `where` (what is short), never a stage the\nstatus chips already count, nor the overdue rows the register\'s summary line counts from `records.due` \u2014 then at most the mix (`by` a field) and the movement (`by` a date), varied by job. A movement over a date is stated, never defaulted; so is a sum, but for the one a status register with a money figure leads with by default: that figure over its open rows. A register with no such figure and no single select to split by gets no default band.\nA grid (`by` and `across`) reads on a Sheet. A Sheet \u2014 a View of Readings at the App\'s root, beside its Lists or alone \u2014\nanswers one owner\'s question across jobs, each Reading windowed by the reader\'s period (the App\'s `period`), and a\nList on it hands over the rows to act on. Many Readings stand on several Sheets, each a View the reader picks. A\ndashboard varies its charts by the job. A question one app\'s rows answer goes on a Sheet there; one spanning apps gets a small app of its own. A Record\'s Readings read its own child rows. Sums of each row\'s child rows are a Tab\'s `totals`. Worked: `examples/approval`, `examples/dashboard`.\n\n#### Funnel\n\nA Reading with `steps` reads a record\'s child rows as steps, each a number column summed over them \u2014 an order\'s lines\nfrom ordered to shipped. It states how much of the first step\neach later one keeps, the share lost between two neighbours, and the last over the first. State two to six\n`steps` in one unit; where the path turns \u2014 reach, then conversion \u2014 state two Readings one straight after the\nother, so the second\'s bars are read over its own first step, on one grid. A step no row holds a number in reads as not measured: leave it empty, never a zero nobody measured.\n\n#### Priced lines\n\nA quote\'s items, an estimate\'s works, a repair sheet\'s damages are lines priced off a book: a table whose\n`records` names each item, puts the code people type on its line and its price as its `figure`. The line links to\nit, asks the link and its quantities in its List\'s `create`, and copies the price (`default_from`), so the quote\nkeeps what was quoted when the book moves. A line\'s amount is a formula, the record\'s total a rollup over the rows\nthe List shows \u2014 what is not paid for is a second rollup, never a filter on the first, so each group subtotals.\nGroup the lines by the parts the record is quoted in (a container, a room, a leg), a field the line asks. A book worked only while a quote is written is the picker on the quote\'s lines; a book with a keeper, Acts or a history of its own is\nan app (`app_architecture`).\n\n### The record\n\n#### Sections\n\nA record is a head, its parts and at most one Side. From three parts it shows one part at a time; fewer stack. A part is one area of the record\'s data a person comes to for its own job, like the tabs of a settings page; its related lists and field groups sit inside it under their headings. A status\'s stages are not areas: their acts stand at the foot of the rows they move. State each\npart whole for the work there: a field may stand in any number of parts, and a field an Act requires draws beside it\nunstated. A step may hold nothing but its name. What a person needs in view at every part (who it is for, how to reach\nthem) goes in a Side: it leaves the head and stays on the rows; what only a stage\'s Act writes (an invoice\'s number,\na delivery\'s signature) stands empty before it, so it goes in that stage\'s Section (`at`), never the Side. The status\nstands in the head or the Side, never a Section. `row` changes how the app\'s rows read, never a page nor what the app writes. A List, Reading, Statement or Act stated alike in several\nSections draws once, in the first; a Check stated in a Section guards the whole record.\n\nThe Record\'s Sections, in the order the work reaches them: the fields people write, a Field per paper the record\nkeeps, a child List per child, the Acts at each one\'s foot. A register\'s `columns` are in the order the job reads them, as many as fit a desk; what is read only on the way deeper is the Record\'s, and a figure that is final only from a stage is a Field of that stage\'s Section, never a column read on every row at every stage. A register laid out in time (calendar, lanes, roster) opens the\ndefault record: every field a person writes. Behaviour belongs in an Act.\n\nA Section of more than about six fields reads as Fieldsets of related facts: a patient\'s record holds "Contact" and\n"Insurance" rather than one run of nine, each Fieldset\'s `label` a few words. A gallery or prose Field stands beside the Fieldsets (`reference/fieldset-node`). Fields stand two\nto a line in the order stated, and files, prose and a link to several rows take the whole line: stated after a lone\nshort field, one leaves the half beside that field empty.\n\n#### Children\n\nRows that each belong to one row of another table (a one-row link to it) are drawn under that row: a List on\nits Record, `layout: "timeline"` where they are a log, `layout: {"agenda": \u2026}` where they are planned on a day and within it, a roster of\nthem, or lanes of them by that link. Which children a record lists is the author\'s \u2014 one of them at least. A List\nlisting only some of them narrows by its `where`: a select (one leg\'s fees), or a yes/no \u2014 a formula\'s for what is\nstill owed \u2014 on a List that adds no rows. A child List stating no `create` asks the table\'s required fields, natural key and\ntitle; where defaults fill them all, it adds none. Rows on\nfile before the row they come to belong to \u2014 a job\'s cost lines before the supplier bill over them \u2014 are picked into\nit: a List with `pick`, often with no `create` and no `remove`.\n\n### Papers\n\n#### Expect\n\nA List with `expect` naming the child\'s title \u2014 a single select of kinds, or a one-row link to a\ncatalog: one line per kind, the ones not yet filled standing empty, filled in place. `of` narrows the kinds\nto the record\'s own multi-select of those it needs. The papers a case gathers, the fees a record knows it\nowes. Worked: `examples/case`.\n\n`only` lists the kinds a List holds a line for, so each kind stands in the Section whose job it is, once. The Act making a paper (`paper: "<child>.<kind>"`), stated in the Record beside its Sections and moving the record as any Act does, is its line\'s button while it applies, the upload in the \u22EF.\n\n#### Templates\n\nA paper the business makes is an Act\'s `template`, kept in the record\'s files field `into` \u2014 or several at\nonce, `templates`: listed where the Act stands, each made one as its file, each not yet made a placeholder,\nthe reader ticking which to make. Worked: `examples/case`.\n\n#### Intake\n\nA paper the business is brought and reads is an Act\'s `intake`: the press takes the papers, an agent reads\nthem, and each is filed as the line of its kind in the child the record `expect`s, while `fills` writes what\nthey state into the record\'s fields \u2014 a single link as a row the agent finds among those the app reads \u2014 shown before it is saved. Stated with `on: "view"` at the register\'s title, the papers make a NEW record instead: `fills` names what it requires, `<link>.<field>` fills the row a required link names (found on its entity\'s `natural_key`, else added), and the register opens the record made. Worked: `examples/case`.\n\nAn agent Act \u2014 an `intake`, a `record`\'s `fills` \u2014 spends a run on every press, so it is stated only where the\nowner asked for an agent to do that job; otherwise a paper brought is its `expect` line, and a person types what it states.\n\n#### Under\n\nA List with `under`: the documents that cover lines (an invoice over its fee lines) stand as headings\nover the lines they cover, and a line no document covers offers to make one. A document entered as it arrives over lines\nalready on file (a supplier bill) picks them with `pick` instead; choose one per document.\n\n### Calls\n\n#### Record act\n\nAn Act\'s `record`: the press records a call, visit or meeting \u2014 audio, transcript, screen where captured \u2014 and\nfiles it as a new row of the record\'s `timeline` child (`into`), stamped `at` and `by`; `fills` lets an agent fill\nthat row\'s fields from the transcript, where the owner asked. Worked: `examples/calls`.\n\n';
1871
1871
 
1872
1872
  // docs/app_architecture.md
1873
1873
  var app_architecture_default = '# App architecture \u2014 which apps, and who gets each\n\n**Which apps.** One app per main entity, a thing the owner\'s words give its own list. A row that makes sense only under one parent (an employee\'s contracts, an order\'s lines) is a child List on the parent\'s page, never another app or a Tab. A second root List is rare: one job working two unrelated entities side by side. A related row\'s value on the list is a lookup column; work over many rows (a month\'s payroll) an Act on the list\'s rows. A person\'s part of the work doesn\'t make an app; a different job may.\n\nOne bakery\'s wholesale arm, five people, seven apps:\n\n| App (its list) | Opened by | On a row\'s page |\n|---|---|---|\n| Customers | Sales rep, owner | Their prices, orders and unpaid invoices |\n| Products | Sales rep, head baker | Price breaks, recipe, stock on hand |\n| Orders | Sales rep, head baker, owner | Lines, the quote paper (an Act), the bake orders it starts |\n| Bake orders | Head baker | Steps, the Acts that move a stage, the tasting |\n| Suppliers | Buyer | Their price list and purchase orders |\n| Purchase orders | Buyer, storekeeper | Lines, goods received |\n| Materials | Storekeeper, buyer | Movements in and out, the Receive and Issue Acts |\n\nAn order\'s lines, a bake order\'s steps and a customer\'s prices make sense only under their parent: each is a child\nList on that row\'s page, never an app or a Tab. An order stands in the Orders app and on its customer\'s page: one\nrecord, one page. The owner reads the figures each register leads with. Each app\'s `name` is its list and its `description` says what is worked there:\n\n```json\n{\n "type": "App",\n "key": "orders",\n "name": "Orders",\n "description": "Takes a customer\'s order from quote to dispatch.",\n "children": [{ "type": "List", "entity": "order" }]\n}\n```\n\nHow each tree is composed is `design`.\n\n## Who gets each\n\nWho does which job is asked in `build`\'s one message before the first write. An app stays with admins until the answer comes, and sharing waits on it. `set_access` then gives each app to everyone who works its rows (ids from `get_workspace`); none loses access. They need no\ntable access: an app runs as its owner. With no `rows` on the App they read every row; where people differ, `rows`\nstates one rule per table (`reference/read-scope`):\n\n| The business says | The app states |\n|---|---|\n| Everyone sees every order | nothing |\n| Each rep sees only their own deals | `"rows": { "deal": { "any": [{ "field": "rep", "is": "self" }] } }` |\n| Reps see their own deals; managers see all | `"rows": { "deal": { "any": [{ "field": "rep", "is": "self" }, { "member_of": "<managers group id>" }] } }` |\n| Each branch manager sees their branch\'s orders | `"rows": { "order": { "any": [{ "through": ["branch"], "field": "manager", "is": "self" }] } }` |\n| Each employee sees only their own payslips; HR sees all | two apps: one stating `"payslip": { "any": [{ "field": "employee", "is": "self" }] }`, one for HR stating none |\n| Team leads see people, not salaries | an app that draws no salary field |\n\nA public link or an API key reaches every alias an app declares, so what outsiders may call is a second app over the\nsame tables, and the team\'s desk stays private (`app_bindings/api-apps`).\n';
@@ -1876,13 +1876,13 @@ var app_architecture_default = '# App architecture \u2014 which apps, and who ge
1876
1876
  var permissions_default = "# Permissions\n\nWho can reach what, what runs under whose access, and what a refusal means.\n\n## Who an agent is\n\nAn agent over MCP, or a terminal signed in with `lotics auth login`, acts as the member who approved it: it reaches\nwhat that member reaches, and no more. An `ltk_` key set to **Only selected ones** is its own narrow member: it reaches\nthe apps and tables named on it, and a share to the whole organization does not reach it. A key set to **All apps and\ntables** reaches the organization. `get_workspace` lists what the caller can use.\n\n## Ownership and sharing\n\nEvery table, app, knowledge doc, document template, skill, automation, notification workflow and connection has one\nowner. Everything starts private, and sharing is the only way to widen it. `set_access` gives a member, a group or the\nwhole organization a role on a resource (`working_in_a_workspace`). Several shares add up, the highest role wins, and\nthere is no deny.\n\n**Lists are shorter than reach.** A listing shows your own work and what is shared with you. An admin's listing says what it left out (`not_listed`), and `all: true` on `get_workspace` lists it: apps, knowledge docs and templates. An admin's agent lists every table, automation and connection without it. A doc search covers what is listed, so a member's private doc enters an admin's answers only with `all: true`. By id, an admin reaches anything. Sharing an item with yourself through `set_access` lists it from then on.\n\n| Role | Reaches |\n|---|---|\n| Organization owner, admin | Every resource |\n| Member | What they own and what is shared with them |\n\n## Two doors to data\n\n- **A table share.** Viewer reads, editor reads and writes. The table's `read_scope` can narrow which rows a member\n opens; it does not narrow an admin or the table's owner.\n- **An app share.** The app runs as its owner and shows what it declares, so a person needs no table access. The app's\n `rows` state which rows each person gets (`reference/read-scope`). What an app does not show, no one reads through it.\n\nHiding a column in a view is layout, not access: to keep a column from someone, give them an app that does not show it.\n\n## Links\n\nA link grants nothing: a linked table needs its own share. Someone who can open the linking table and not the target\nsees the link's title and any lookup, both stored on the row by the table's author, and cannot open the linked row.\n\n| Action through a link | Result |\n|---|---|\n| A filter crossing into a table the reader cannot open | `403`, on that query or saved view only |\n| A filter crossing into a table the reader opens under a row rule | Answered, matching only through rows they can see |\n| A write or a change request stating a new link | Needs the writer to read that row; a default or a copied row is not judged |\n| A table clone with rows | Needs a whole read of the source; a reader a rule narrows clones the structure |\n\nWhen people who open a table cannot open a table its links reach, `set_tables` and `set_access` say so and name them,\nand a person who owns the target or an admin can share it with them as viewer.\n\n## What runs, runs as its owner\n\nA workflow, app, automation and notification workflow uses its owner's current permissions. Pressing a button, answering\na card or filling a form only triggers it. If the owner loses access, the run fails. Only the owner or an admin writes a\nbody, and that includes a notification workflow and naming it on a card; it still runs as its owner.\n\nSaving a body needs its owner to be able to use every connection, template and knowledge doc it names. To inspect what a member would get, an admin passes `as_member` with a read or a dry run.\n\n## Connections\n\nA connection belongs to the company. Only an admin connects one, in Lotics under Settings \u2192 Connections. Admins and\nwhoever it is shared with can act through it, and it passes to an admin when its owner leaves. An app handed from one admin\nto another keeps its shares; any other handover clears them.\n\nA workflow step's `connected_account_id` is a literal, a constant bound to one, or a choice among them, so every possible\nvalue is judged at save; one read from an input, a record or a call is refused at save and at run. A document template\nmay come from data, and a run refuses one its owner cannot use. No tool calls a service directly\n(`workflows/reaching-a-connected-service`).\n\nAn automation that reads a mailbox stops and tells its owner when the connection is gone or they can no longer use it.\n\n## Reading a refusal\n\nA refusal states what is missing and never shows the content it refused. Nothing shares on its own: a `403` means a\nperson who owns the resource, or an admin, has to grant access.\n";
1877
1877
 
1878
1878
  // docs/working_in_a_workspace.md
1879
- var working_in_a_workspace_default = "# Working in a workspace \u2014 the right means for each job\n\nOnce tables and apps exist, an agent does the team's work through them. The means depends on what the work is.\n\n| The work | The means | Why |\n|---|---|---|\n| A business operation: move an order on, issue a paper, notify someone | `run_app_workflow` on the app's act, `act_<key>` | The outcome equals a person's press: status, stamps, documents, notifications. `update_records` on an act's field skips all of them. |\n| Data entry, a correction, loading the owner's lists | `create_records`, `update_records` | The table's rules hold for every writer. |\n| A rule or policy the business wrote | `get_workspace` with `search`, then `read_knowledge` | The business's own words, not a guess. |\n| A file someone hands over | `view_files`; `upload_file` to keep it. A picture reaches a CLI as a note naming `download_file` and `lotics file download <file_id>` | Reads its content; the upload files it in the workspace. When your host passes no bytes, `upload_file` with `person: true` gives the person a link to drop it on. |\n| A paper an app makes | the act that makes it, which files it on the record | `generate_document` makes an unattached file, for a paper no app makes. |\n| A connected service (KiotViet, MISA, a carrier) | a workflow step, reached through a Workflow node | No tool calls a service directly (`workflows/reaching-a-connected-service`). |\n| A figure or list the business defines, or an operation it repeats | the app's declared Query or Workflow node: `run_app_query`, `run_app_workflow` | The node is the business's own definition, found by `get_workspace` with `search` and read in `get_app`. |\n| A count or sum no app answers | `query_records` with `aggregate` (grouped by `group_by`), or its rows; `record_ids` reads those records by id | |\n\nFind the means in this order: `get_workspace` maps the workspace; `search` it by what is asked (\"overdue\"), which matches an app's declared Query and Workflow keys and descriptions and names the matching keys under the app; `get_app` lists that app's queries and workflows with their inputs. Run the declared node. Only a question no node answers goes to `query_records`.\n\n## Workspace settings and standing instructions\n\n`get_workspace` shows the workspace's settings (name, timezone, default currency) and, with kind `instruction`, its standing instructions. `set_workspace` changes them in one all-or-nothing patch: a setting it leaves out is unchanged, and `instructions` is a map keyed by instruction name where an entry creates or merges and `null` removes. A workspace-wide instruction arrives with the connection, in the instructions a host reads when an agent connects; the answer of `set_workspace` names any that no longer fit that block. An administrator writes them.\n\n## People\n\n`get_workspace` with kind `member` lists every member's name and id; an admin also sees each one's email, role, `managed` and `sign_in_name`, and, on kind `app`, `knowledge` or `template`, `not_listed`: how many more they can reach, which `all: true` lists. Listed docs and templates carry `access`. An admin also reads the credit limits there.\n\n`set_members` is an admin's: `members` is a map keyed by an email address, a member id or a managed member's sign-in name, and `groups` a map keyed by a group id, or by a group's name, which sets the group of that name or creates it (refused where several groups share it: key that entry by id). In `members`, an email no member holds invites that person (`role` is `member` or `admin`; the invitation email goes out), a current member's entry sets `name` and `role`, a removed member's entry restores them and takes only `name`, and `null` removes a member or cancels the invitation pending to that address. Sign-in names are compared in lowercase. A person adds a managed member and sets its password in Settings \u2192 Members. The organization keeps at least one admin: the last one cannot be demoted or removed. In `groups`, an entry sets `name`, `description` and the roster with `member_ids`, or with `add_member_ids` and `remove_member_ids` that leave the rest in place; a roster entry may be a key of `members`, so a person invited in the same call can join; `null` deletes the group. The whole input is checked before anything is written or sent; members are applied before groups, in the order given, and the caller's own step-down last. A member's tool list does not carry `set_members` or `set_workspace`.\n\n`set_access` gives members, groups or the whole organization a role on resources. Role `owner`, on one member, hands every resource listed to that member, whom only the resource's owner or an admin may name; a call cannot share an app and hand it over together, an app handed to or from a member loses its sharing, and an automation is turned off until its new owner turns it on. Handovers are applied one resource at a time, and a failure part-way names what was already applied. `set_workspace` takes `credit_limits` (`workspace`, `apps` by app id, `members` by member id; a number is the daily ceiling in credits, `null` removes it and asks for approval).\n\n## Comments\n\nEvery record read carries `comment_count`. `query_records` takes `comments: true` to return the thread (`limit` defaults to 20, 20 at most). Comments are written by people, on the record in Lotics or through the product's chat.\n\n## Deleting and restoring\n\nA keyed entry is removed by `null`: a field, check, view, option, instruction, query alias, a member or a group. A resource addressed by its id is deleted with `delete: true` and brought back with `restore: true`, beside its id: a table in a `set_tables` item (`{ table_id, delete: true }`; `cascade` deletes the links that point at the deleted tables and is refused unless the call deletes; `force` goes with a patch that loses stored values and is refused on a call that only deletes or restores), a knowledge doc (`set_knowledge` with `knowledge_doc_id`), a template (`set_template` with `template_id`), an app (`set_app` with `app_id`) and a workflow (`set_workflow` with `workflow_id`; a deletion only). Records are deleted by `delete_records` and brought back by `update_records` with `restore: true` and `record_ids` or `filters`: the rows their delete took come back with them, all or none, and a row needing its link stays deleted while the row it names does. `delete` takes no other key. A call that deletes asks for approval; one that does not never does.\n\n## Locking and changing a locked record\n\n`update_records` with `locked: true` locks the targets (write access) and `locked: false` unlocks them (the table's manager). Beside field edits, a record that is locked before and after the call is refused into `blocked`; an unlock lands before the edit and a lock after it. `request_change: { reason }` files one change request per blocked record instead, carrying the values the call resolves, and lists them in `requested` as `{ record_id, request_id }`; the unlocked targets of the same call are written, and the call and its requests are one transaction, so a request that cannot be filed leaves them unwritten too.\n\n## Undoing a write\n\nA write is put back by writing the value `query_audit_logs` shows before the change: `update_records` for a field, `update_records` with `restore: true` for a deleted record, with the rows its delete took, or an app's `restore_<entity>` where the row went by that app's Delete, `delete_records` for a record a run created.\n\n## Files\n\n`view_files` reads what a file says (up to 100 by id, or the files of a record's file field with `source`). Inside an app's agent only the `file_ids` a query returned may be opened, and `source` is refused. `download_file` returns a `download_url` and, for a caller on a key or a connector, the bytes (up to 512 KB; `bytes_omitted` says why they are absent). In the in-product chat the `download_url` is the stable address a signed-in member opens, so it is for the person, not a link a tool fetches.\n\n`upload_file` names one source:\n\n- `url`: a public http(s) address the server fetches.\n- `file`: the `{download_url, file_id}` reference a host hands over for a member's attachment (a ChatGPT file parameter arrives hydrated into this shape). Never construct one.\n- `files`: bytes you hold locally. Each entry gets an `upload_url`, valid for 5 minutes, on the same host as your other calls; PUT the bytes to it and the response is the `file_id`. Where your sandbox allows no outbound request to that host (in Claude, a Team or Enterprise owner lists it under Admin settings \u2192 Capabilities), the PUT fails before it leaves: give the person the file with `person: true` instead.\n- `person: true`: returns a `drop_url`, valid for an hour, to give the person, and a `ticket_id` per file; once they say they dropped the files, call again with each `ticket_id` for its `file_id`.\n\n## Doing an operation\n\n`get_app` lists the app's acts as `act_<key>` (or the `workflow` an Act names) with what each takes. `run_app_workflow` with `dry_run: true` writes nothing\nand answers what the run would do; the same call without it runs. An act refuses a row its conditions do not hold for,\nand says why (`agent_surface/a-refusal`).\n\n## Writing records\n\n`create_records` takes 50 records a call, 20 or more of one shape in columnar form (`field_keys` once, then `rows`);\n`update_records` changes one or many. Both name fields and select options by alias, and `field_values` gives each\ntype's value. Every write meets the table's rules (`reference/write-rules`): every broken rule is listed at once, and a\nlocked record answers under `blocked`. The owner's own lists (a menu with prices, customers, open orders) are rows of their\ntables, loaded this way after `set_tables`.\n\n## A business's tax ID\n\nNo tool resolves a business name to its tax ID. The customer's own papers carry the ID they are invoiced under: a PO's\ninvoicing footer, a contract, a past invoice. A web search limited to registry listings (`masothue.com`,\n`infodoanhnghiep.com`) shows each match's tax ID in its result, though those sites refuse a direct fetch; many companies\nshare a name, and the registered address is what tells them apart. For a\nVietnamese tax ID (a branch's with a `-00N` suffix), `https://api.vietqr.io/v2/business/{tax_id}` answers the\nregistered name, address and status (`NNT \u0111ang ho\u1EA1t \u0111\u1ED9ng` when active); it is rate-limited, answering 429 to a burst. A\nregistered address can differ from the one a PO prints. A company's code for paying a foreign contractor's tax on its\nbehalf shares its name and address; its registered name ends in `(NTNN)`, and it is not the code the company is invoiced\nunder.\n\n## Answering a question\n\n1. `get_app`: a Reading's query (its `key`) is the business's own figure for it. `run_app_query` with `alias` and\n `params` returns it; `filters`, `fields`, `sort` and `count` narrow the result.\n2. A period's total is one call per period, each with `from` and `to` or a date filter. `aggregate` groups a result by\n a column (`by`), a number's bands (`bands`) or a date column's day (`day`), and sums one (`sum`).\n3. A question no app answers is `query_records` over one table: its rows, or with `aggregate` counts and sums grouped by a\n field; `filters` is the grammar of both.\n\n## A worked day\n\nA customer asks for the status of order 1042, then the order is shipped:\n\n```\nget_workspace kind \"app\" \u2192 app_id of the sales desk\nget_app app_id \u2192 aliases: order_list, act_ship, \u2026\nrun_app_query app_id, alias \"order_list\", params {\"search\": \"1042\"}\nrun_app_workflow app_id, alias \"act_ship\", inputs {\"record_id\": \"rec_\u2026\"}, dry_run true\nrun_app_workflow the same call without dry_run\nquery_records table_id, aggregate {group_by \"stage\", count} \u2192 how many orders stand at each stage now\n```\n";
1879
+ var working_in_a_workspace_default = "# Working in a workspace \u2014 the right means for each job\n\nOnce tables and apps exist, an agent does the team's work through them. The means depends on what the work is.\n\n| The work | The means | Why |\n|---|---|---|\n| A business operation: move an order on, issue a paper, notify someone | `run_app_workflow` on the app's act, `act_<key>` | The outcome equals a person's press: status, stamps, documents, notifications. `update_records` on an act's field skips all of them. |\n| Data entry, a correction, loading the owner's lists | `create_records`, `update_records` | The table's rules hold for every writer. |\n| A rule or policy the business wrote | `get_workspace` with `search`, then `read_knowledge` | The business's own words, not a guess. |\n| A file someone hands over | `view_files`; `upload_file` to keep it. A picture reaches a CLI as a note naming `download_file` and `lotics file download <file_id>` | Reads its content; the upload files it in the workspace. When your host passes no bytes, `upload_file` with `person: true` gives the person a link to drop it on. |\n| A paper an app makes | the act that makes it, which files it on the record | `generate_document` makes an unattached file, for a paper no app makes. |\n| A connected service (KiotViet, MISA, a carrier) | a workflow step, reached through a Workflow node | No tool calls a service directly (`workflows/reaching-a-connected-service`). |\n| A figure or list the business defines, or an operation it repeats | the app's declared Query or Workflow node: `run_app_query`, `run_app_workflow` | The node is the business's own definition, found by `get_workspace` with `search` and read in `get_app`. |\n| A count or sum no app answers | `query_records` with `aggregate` (grouped by `group_by`), or its rows; `record_ids` reads those records by id | |\n\nFind the means in this order: `get_workspace` maps the workspace; `search` it by what is asked (\"overdue\"), which matches an app's declared Query and Workflow keys and descriptions and names the matching keys under the app; `get_app` lists that app's queries and workflows with their inputs. Run the declared node. Only a question no node answers goes to `query_records`.\n\n## Workspace settings and standing instructions\n\n`get_workspace` shows the workspace's settings (name, timezone, default currency) and, with kind `instruction`, its standing instructions. `set_workspace` changes them in one all-or-nothing patch: a setting it leaves out is unchanged, and `instructions` is a map keyed by instruction name where an entry creates or merges and `null` removes. A workspace-wide instruction arrives with the connection, in the instructions a host reads when an agent connects; the answer of `set_workspace` names any that no longer fit that block. An administrator writes them.\n\n## People\n\n`get_workspace` with kind `member` lists every member's name and id; an admin also sees each one's email, role, `managed` and `sign_in_name`, and, on kind `app`, `knowledge` or `template`, `not_listed`: how many more they can reach, which `all: true` lists. Listed docs and templates carry `access`. An admin also reads the credit limits there.\n\n`set_members` is an admin's: `members` is a map keyed by an email address, a member id or a managed member's sign-in name, and `groups` a map keyed by a group id, or by a group's name, which sets the group of that name or creates it (refused where several groups share it: key that entry by id). In `members`, an email no member holds invites that person (`role` is `member` or `admin`; the invitation email goes out), a current member's entry sets `name` and `role`, a removed member's entry restores them and takes only `name`, and `null` removes a member or cancels the invitation pending to that address. Sign-in names are compared in lowercase. A person adds a managed member and sets its password in Settings \u2192 Members. The organization keeps at least one admin: the last one cannot be demoted or removed. In `groups`, an entry sets `name`, `description` and the roster with `member_ids`, or with `add_member_ids` and `remove_member_ids` that leave the rest in place; a roster entry may be a key of `members`, so a person invited in the same call can join; `null` deletes the group. The whole input is checked before anything is written or sent; members are applied before groups, in the order given, and the caller's own step-down last. A member's tool list does not carry `set_members` or `set_workspace`.\n\n`set_access` gives members, groups or the whole organization a role on resources. Role `owner`, on one member, hands every resource listed to that member, whom only the resource's owner or an admin may name; a call cannot share an app and hand it over together, an app handed to or from a member loses its sharing, and an automation is turned off until its new owner turns it on. Handovers are applied one resource at a time, and a failure part-way names what was already applied. `set_workspace` takes `credit_limits` (`workspace`, `apps` by app id, `members` by member id; a number is the daily ceiling in credits, `null` removes it and asks for approval).\n\n## Comments\n\nA record read carries `comment_count` (a workflow body gets it when it reads it). `query_records` takes `comments: true` to return the thread (`limit` defaults to 20, 20 at most). Comments are written by people, on the record in Lotics or through the product's chat.\n\n## Deleting and restoring\n\nA keyed entry is removed by `null`: a field, check, view, option, instruction, query alias, a member or a group. A resource addressed by its id is deleted with `delete: true` and brought back with `restore: true`, beside its id: a table in a `set_tables` item (`{ table_id, delete: true }`; `cascade` deletes the links that point at the deleted tables and is refused unless the call deletes; `force` goes with a patch that loses stored values and is refused on a call that only deletes or restores), a knowledge doc (`set_knowledge` with `knowledge_doc_id`), a template (`set_template` with `template_id`), an app (`set_app` with `app_id`) and a workflow (`set_workflow` with `workflow_id`; a deletion only). Records are deleted by `delete_records` and brought back by `update_records` with `restore: true` and `record_ids` or `filters`: the rows their delete took come back with them, all or none, and a row needing its link stays deleted while the row it names does. `delete` takes no other key. A call that deletes asks for approval; one that does not never does.\n\n## Locking and changing a locked record\n\n`update_records` with `locked: true` locks the targets (write access) and `locked: false` unlocks them (the table's manager). Beside field edits, a record that is locked before and after the call is refused into `blocked`; an unlock lands before the edit and a lock after it. `request_change: { reason }` files one change request per blocked record instead, carrying the values the call resolves, and lists them in `requested` as `{ record_id, request_id }`; the unlocked targets of the same call are written, and the call and its requests are one transaction, so a request that cannot be filed leaves them unwritten too.\n\n## Undoing a write\n\nA write is put back by writing the value `query_audit_logs` shows before the change: `update_records` for a field, `update_records` with `restore: true` for a deleted record, with the rows its delete took, or an app's `restore_<entity>` where the row went by that app's Delete, `delete_records` for a record a run created.\n\n## Files\n\n`view_files` reads what a file says (up to 100 by id, or the files of a record's file field with `source`). Inside an app's agent only the `file_ids` a query returned may be opened, and `source` is refused. `download_file` returns a `download_url` and, for a caller on a key or a connector, the bytes (up to 512 KB; `bytes_omitted` says why they are absent). In the in-product chat the `download_url` is the stable address a signed-in member opens, so it is for the person, not a link a tool fetches.\n\n`upload_file` names one source:\n\n- `url`: a public http(s) address the server fetches.\n- `file`: the `{download_url, file_id}` reference a host hands over for a member's attachment (a ChatGPT file parameter arrives hydrated into this shape). Never construct one.\n- `files`: bytes you hold locally. Each entry gets an `upload_url`, valid for 5 minutes, on the same host as your other calls; PUT the bytes to it and the response is the `file_id`. Where your sandbox allows no outbound request to that host (in Claude, a Team or Enterprise owner lists it under Admin settings \u2192 Capabilities), the PUT fails before it leaves: give the person the file with `person: true` instead.\n- `person: true`: returns a `drop_url`, valid for an hour, to give the person, and a `ticket_id` per file; once they say they dropped the files, call again with each `ticket_id` for its `file_id`.\n\n## Doing an operation\n\n`get_app` lists the app's acts as `act_<key>` (or the `workflow` an Act names) with what each takes. `run_app_workflow` with `dry_run: true` writes nothing\nand answers what the run would do; the same call without it runs. An act refuses a row its conditions do not hold for,\nand says why (`agent_surface/a-refusal`).\n\n## Writing records\n\n`create_records` takes 50 records a call, 20 or more of one shape in columnar form (`field_keys` once, then `rows`);\n`update_records` changes one or many. Both name fields and select options by alias, and `field_values` gives each\ntype's value. Every write meets the table's rules (`reference/write-rules`): every broken rule is listed at once, and a\nlocked record answers under `blocked`. The owner's own lists (a menu with prices, customers, open orders) are rows of their\ntables, loaded this way after `set_tables`.\n\n## A business's tax ID\n\nNo tool resolves a business name to its tax ID. The customer's own papers carry the ID they are invoiced under: a PO's\ninvoicing footer, a contract, a past invoice. A web search limited to registry listings (`masothue.com`,\n`infodoanhnghiep.com`) shows each match's tax ID in its result, though those sites refuse a direct fetch; many companies\nshare a name, and the registered address is what tells them apart. For a\nVietnamese tax ID (a branch's with a `-00N` suffix), `https://api.vietqr.io/v2/business/{tax_id}` answers the\nregistered name, address and status (`NNT \u0111ang ho\u1EA1t \u0111\u1ED9ng` when active); it is rate-limited, answering 429 to a burst. A\nregistered address can differ from the one a PO prints. A company's code for paying a foreign contractor's tax on its\nbehalf shares its name and address; its registered name ends in `(NTNN)`, and it is not the code the company is invoiced\nunder.\n\n## Answering a question\n\n1. `get_app`: a Reading's query (its `key`) is the business's own figure for it. `run_app_query` with `alias` and\n `params` returns it; `filters`, `fields`, `sort` and `count` narrow the result.\n2. A period's total is one call per period, each with `from` and `to` or a date filter. `aggregate` groups a result by\n a column (`by`), a number's bands (`bands`) or a date column's day (`day`), and sums one (`sum`).\n3. A question no app answers is `query_records` over one table: its rows, or with `aggregate` counts and sums grouped by a\n field; `filters` is the grammar of both.\n\n## A worked day\n\nA customer asks for the status of order 1042, then the order is shipped:\n\n```\nget_workspace kind \"app\" \u2192 app_id of the sales desk\nget_app app_id \u2192 aliases: order_list, act_ship, \u2026\nrun_app_query app_id, alias \"order_list\", params {\"search\": \"1042\"}\nrun_app_workflow app_id, alias \"act_ship\", inputs {\"record_id\": \"rec_\u2026\"}, dry_run true\nrun_app_workflow the same call without dry_run\nquery_records table_id, aggregate {group_by \"stage\", count} \u2192 how many orders stand at each stage now\n```\n";
1880
1880
 
1881
1881
  // src/reference.md
1882
- var reference_default = '# Tables and apps\n\nThe tables of a workspace and the apps over them, each a JSON document. A table is a document, an item of\nthe tool `set_tables`: its fields, options, how a row is recognised, and the rules its writes\nfollow. An app is a tree of components, the `body` of the tool `set_app`: its Views \u2014 Lists of rows and Sheets of\nreadings \u2014 and the page each table\'s rows open. Each section is its own page, `reference/<section>`.\nWhich treatment each job\'s screen needs: the `design` reference. Each treatment worked through in an\napp: the `examples` reference.\n\n**What the documents compose with**\n\n- **Tables and fields** (`reference/tables`, `reference/read-scope`, `reference/field`) \u2014 a table\'s columns, options and links. A table document sits\n in the `tables` list of a `set_tables` call; a field sits under its alias in the table\'s `fields`.\n- **Records** (`reference/records`, then `reference/status`) \u2014 how a row of each table is RECOGNISED: its title, the line\n under it, its picture, its status, the one number it stands for. Stated once per table\n and read by every surface that draws one of its rows.\n- **Write rules** (`reference/write-rules`) \u2014 what a write finds, bounds and picks among.\n- **Apps** (`reference/app-tree`, then a page each) \u2014 the Lists and Sheets at the app\'s root, each a View of its own, and the\n page each table\'s rows open: which fields go where, the acts, and the checks that guard them.\n How each thing LOOKS is the runtime\'s, one treatment per concept; no prop here changes it.\n A screen the job needs and no component states is told to the person \u2014 the job, what the app\n drew, the word wanted \u2014 never props bent to approximate it.\n\n**The working order**\n\n1. The tables and fields the jobs touch, and a `records` entry for every table an\n app lists, opens or picks. Which apps a business needs is `app_architecture`.\n2. One `set_tables` call with the tables: a link names the table it points at by the `ref` of another\n item of the call, and the answer carries every table id and the aliases of the fields it added. A\n call carries at most 50 tables, 200 first rows a table, and 2000 rows and 2000 documents in all; more\n tables go in a further call, which names the earlier tables by alias. A call is checked whole and writes\n nothing when refused, listing everything wrong; `dry_run` is for reading the grants a write would make or\n deciding `force`.\n3. One `set_app` call per app. The tree names its tables and document templates by alias wherever it points at one;\n the App node\'s `tables` and `templates` maps are filled by `set_app`, never written.\n `set_app` with the tree as `body` creates the app, named by its `name`; a refused tree writes nothing and is listed whole, and `dry_run` is for reading the permissions the write\n would grant and remove (on the CLI, `lotics app apply <file>`, with `--check` for `dry_run`).\n4. Change an app afterwards one node at a time: `get_app` prints the `tree:`, each node\'s address under `node addresses:`\n and the `version` line, which is the `base_version_id` to send (the tree and addresses go to the app\'s author alone);\n `set_app` with `app_id`, `base_version_id` and `nodes`, a map from a node\'s address to a\n patch, changes it (`reference/changing-an-app`), and its answer states the permissions the change grants and removes. A table\n is changed by `set_tables` with its `table_id`, a merge patch over the document `get_table` answers. To go back,\n send the tree you saved before the change as `body` with `app_id`: it replaces `children` but keeps every App prop it\n omits (`words`, `scope`, `period`, `icon`), so null those. (On the CLI, `lotics app pull <app_id>` writes the tree as JSON and `lotics app apply\n <file>` sends an edited file, refused when the app has moved past the version the file was pulled at.) An app\n saved before apps were trees has no tree: `get_app` says so beside what it lets a person write, and `set_app` with\n `app_id` changes it by its whole tree as `body`, which replaces it, or by its name, description, icon and color alone.\n\n## The rules\n\n- **A `set_tables` call is all or nothing.** Every item is checked before any is written; an item\n without `table_id` makes a table, one with it patches that table.\n- **An app\'s labels decide its language.** A body names no locale \u2014 the words an\n app draws itself (its buttons, empty states, refusals) are in the language its\n own labels are written in, so a Vietnamese desk beside English ones answers in\n Vietnamese. The generated screens read the kit\'s\n pack, and a generated WRITE cannot: its refusals run on the server, so they are\n worded in that same language. Mix the two within one app and it answers in two. The app\'s own `words`\n (its words for a table, a field or an option) count as its labels: Vietnamese words over an English table\n make the app answer in Vietnamese.\n- **`set_tables` and `set_app` check all of it before anything is written**, and\n report every problem in one run rather than the first. The tables half of this\n page ends its keys with the rules the check enforces there, and `reference/app-rules` and the pages after it hold the app\'s, one sentence each\n under an id; a finding names its rule\'s id (`[list.filter]`), and\n `reference/<rule id>` is that one rule\'s page.\n\n## Top level\n\nEvery table of keys on this page is generated from the grammar a table document and an app tree are written in, so it is the whole of what a key may hold.\n\n<!-- generated:start top-level -->\n\n#### set_tables call\n\n| Key | Type | Meaning |\n|---|---|---|\n| `tables` | list of [Table item](#table-item), required | One or more, all or nothing; each item is a table document with these keys added. It creates a table (a `label` and `fields` at least) or, with `table_id`, patches one: the document it states merges into the table\'s own |\n| `rows` | map of alias \u2192 list of [Row](#row) | First records of the tables the call creates, keyed by each one\'s `ref` |\n| `force` | boolean | Consent to losing what rows hold: a field deleted, an option removed |\n| `dry_run` | boolean | Answer what the call would change, writing nothing: for reading the grants a write would make or deciding `force`. A refused call writes nothing too and lists every reason, so a dry run checks no more than the call does |\n\n#### Table item\n\n| Key | Type | Meaning |\n|---|---|---|\n| `ref` | alias | A created table\'s handle in this call: other items link to it, and `rows` are keyed by it |\n| `table_id` | text | The table to patch; absent, the item creates one. A patch states only what changes: `null` removes a key, a list replaces whole |\n\n<!-- generated:end top-level -->\n\n**A `set_tables` item is a table document** (`reference/tables`) with `ref` and `table_id` added, and the call\ntakes no other key. **A `set_app` body is an app tree** (`reference/app-tree`), whose root is an App node: its `tables` and\n`templates` each map a local alias the tree names to the id of the table or document template it means, from the\n`set_tables` answer or `get_table`. The tree is the only home of the app\'s `name`, `description`, `icon` and `color`;\n`set_app` takes it whole to create, or as a merge patch over the App node with `app_id`, or `nodes` with `app_id` to change one, and with `base_version_id` (the\nversion you read) it refuses a write over a newer one. Nothing is built code. An unknown key is an error, never ignored.\n\nA smallest call, two tables of plain fields, a select and a two-way link \u2014 nothing else is needed to write it:\n\n```json\n{\n "tables": [\n {\n "ref": "customer",\n "label": "Customers",\n "singular": "Customer",\n "fields": {\n "name": {"type": "text", "label": "Name", "required": true},\n "tier": {"type": "select", "label": "Tier", "options": [{"alias": "gold", "label": "Gold", "color": "yellow"}, {"alias": "standard", "label": "Standard", "color": "gray"}]},\n "orders": {"type": "link", "label": "Orders", "table": "order", "multi": true, "pair": "customer"}\n }\n },\n {\n "ref": "order",\n "label": "Orders",\n "singular": "Order",\n "fields": {\n "code": {"type": "text", "label": "Code", "required": true},\n "customer": {"type": "link", "label": "Customer", "table": "customer", "multi": false, "pair": "orders"},\n "amount": {"type": "number", "label": "Amount"}\n }\n }\n ]\n}\n```\n\n### Aliases\n\nEvery `alias` is a lowercase slug \u2014 a letter, then letters, digits and\nunderscores (`unit_price`, `so_1001`). Aliases are how a document and an app tree\nname a field, an option or a table; they are never shown to anyone. `label` is\nwhat a person sees.\n\nLabels must be unique within their namespace \u2014 two fields on one table, two options\non one field cannot share a label.\n\n## Tables\n\n<!-- generated:start table -->\n\n#### Table document\n\n| Key | Type | Meaning |\n|---|---|---|\n| `label` | text, required | The table\'s name in the workspace |\n| `singular` | text | One row of this table, in the business\'s own words \u2014 what a create\'s button and panel name |\n| `description` | text | The table\'s description, written onto the table in the workspace, where a caller of an app\'s queries and workflows reads it beside them |\n| `fields` | map of alias \u2192 [Field](#field), required | The table\'s columns, each under its alias, which is its key here and so is never stated inside it |\n| `read_scope` | [Read scope rule](#read-scope-rule) | Which rows a member reads. Absent, every member with access to the table reads every row. |\n| `unique` | list (at least one) of list of alias (at least one) | Sets of fields whose values no two live rows share \u2014 each a list of field aliases (text, number, date, a single select, a single member, or a link holding one row \u2014 `multi: false`); a single text field states `unique: true` on itself instead of a one-field set. A create or update landing a second row with the same values is refused. |\n| `title` | alias | The alias of the field that names a row wherever a link or a record shows one; absent, the first text field |\n| `colors` | any value | Row colors: a list of { filters, color }, the filter reading fields of this table by alias and a select\'s options by alias; one condition on its own is a group of one |\n| `records` | any value | How a row is recognised: the keys of the Record, Status and Cadence tables below but `title`, which sits above; a table they name is an id or a `ref`. A status `history` that names a `ref` no item of the call declares is made by the call as a table, `dates` add each date field they name, and a status with stages each stage and each open option they name none for its `<option>_at`, unless the document declares it; each is listed in the result\'s notes |\n| `natural_key` | list of alias (at least one) | The field aliases a row of this table is RECOGNISED by: an app\'s add and find-or-create reuse the row they find by these values, minting one only where nothing matches. A record tool or the API creates the row it is handed. |\n| `no_overlap` | [No overlap](#no-overlap) \\| list of [No overlap](#no-overlap) (at least 2) | No two rows hold overlapping spans (one rule, or a list of rules a row must each meet) \u2014 a create or update that would is refused, and so is a change to the dates or states of the row a span is read through that would make two rows overlap |\n| `checks` | map of alias \u2192 table check (`workflows/table-checks`) | The conditions a write of the table\'s rows may not meet, each under its alias: a merge patch edits one, and `null` removes it. Expressions name fields by alias |\n\n<!-- generated:end table -->\n\n<!-- generated:start rules-entity -->\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `entity.singular` | A table a List\'s `create` is mounted over \u2014 a root List\'s or a child List\'s that adds rows \u2014 states its `singular`: one row of it, in the business\'s words. |\n| `entity.link-format` | A text field of `format: "link"` holds web addresses; one whose rows hold a phone or a mail address states no format. |\n| `entity.read-scope` | A `read_scope` clause names a group (`member_of`) or a field of its table reached through one-row links: `"self"` a member field, options a single select declares; an `any` or an `all` groups clauses, and groups nest. |\n| `entity.unique` | A `unique` set names fields of its table once each, each holding one value to compare \u2014 text, a number, a date, a single select, a one-row link \u2014 and is stated once; a lone text field is `unique: true` on it. |\n\n<!-- generated:end rules-entity -->\n\n**`unique` is a set of values no two live rows share.** Each entry names fields\nof this table holding ONE value \u2014 text, number, date, a single select, a link\nwith `multi: false` \u2014 and a create or update landing a second row with the\nsame values is refused. A set of one text field is that field\'s own `unique:\ntrue`, so it is refused here. A create carries each set in the names its panel\nsends, so the panel can name the duplicate before the write does.\n\n**`singular` is what a create says** \u2014 `New Order`, `Add Claim line`, `H\u1ED3 s\u01A1\nm\u1EDBi` \u2014 while `label` names the table, so without it the button reads `New\nOrders`. Nothing derives it: English plurals are irregular, and no language is\nexempt. In a language without plural forms it is usually the label itself,\nless any word for the collection. A List that leaves `create` to its default adds nothing over a table that states\nnone (nor does the app\'s `words` state one); a `create` list stated over such a table is refused (`entity.singular`).\n\n**An app that only reads a table\'s rows draws them with `edit: false`** and states `create: false` and `remove: false` \u2014 a log of what the system sent, a copy of\nwhat another system holds. The app keeps the section and opens each row at rest, with no Add and no Delete; a party\nof it is picked, never found or minted; and the app writes no create, update or remove for it. It shapes that app, not who may write: a direct write \u2014 the records\nAPI, the chat agent, an import \u2014 follows the table\'s access, as on any table, and another app over the same rows\nstates its own tree.\n\n**`read_scope`** \u2014 which rows a member reads \u2014 is its own page, `reference/read-scope`.\n\n## Read scope\n\n<!-- generated:start read-scope -->\n\n#### Read scope rule\n\n| Key | Type | Meaning |\n|---|---|---|\n| `any` | list of ([Read scope by role](#read-scope-by-role) \\| [Read scope by member](#read-scope-by-member) \\| [Read scope by option](#read-scope-by-option) \\| [Read scope rule](#read-scope-rule)) (at least one) | A row is readable when ANY of these holds |\n| `all` | list of ([Read scope by role](#read-scope-by-role) \\| [Read scope by member](#read-scope-by-member) \\| [Read scope by option](#read-scope-by-option) \\| [Read scope rule](#read-scope-rule)) (at least one) | A row is readable when ALL of these hold |\n\n#### Read scope by role\n\n| Key | Type | Meaning |\n|---|---|---|\n| `member_of` | text, required | The id of a group (from Settings, or chat): whoever is in it reads the row |\n\n#### Read scope by member\n\n| Key | Type | Meaning |\n|---|---|---|\n| `through` | list of alias (1\u20133) | link aliases from this entity outward, each holding one row (`multi: false`) \u2014 the clause\'s field is on the entity the last hop lands on |\n| `field` | alias, required | A member field alias on this entity, or on the entity `through` lands on |\n| `is` | `"self"`, required | The members this column names on a row read that row |\n\n#### Read scope by option\n\n| Key | Type | Meaning |\n|---|---|---|\n| `through` | list of alias (1\u20133) | link aliases from this entity outward, each holding one row (`multi: false`) \u2014 the clause\'s field is on the entity the last hop lands on |\n| `field` | alias, required | A single-select field alias on this entity, or on the entity `through` lands on |\n| `is` | list of alias (at least one), required | Its option aliases whose rows are readable \u2014 naming none would hide every row |\n\n<!-- generated:end read-scope -->\n\n**A row rule is enforced by the platform.** A table\'s `read_scope` is resolved into its own row filters, so\nthe table tools, the data view and the API answer the same rows, and it caps what an app\'s owner can hand out: an\napp never reads beyond its owner\'s reach. An app states its own rule of each table it reads in `rows` on the App\nnode (`reference/app-tree`), in the grammar above. A `"self"` clause reads a column of one member or several, and every group\nand option a clause names must exist.\n\n**A rule holds through a link.** A filter through a link and a List\'s linked column read the linked row under the\nreader\'s own rule of it, and a link to a row the writer cannot read is refused. A lookup, rollup or copy is stored, so\nit reads one value for everyone who reads its table: one over a table with a rule takes `manage` on that table, and\n`get_table` of that table lists them as `crossings`.\n\n**An app runs under its owner\'s authority**, so the people it is shared with need the app and no access to its\ntables. Where they differ in what they may read, `rows` states it: one rule per table, evaluated against the caller,\nnarrowing the app\'s screens, its queries (the AI and MCP path), its writes and acts, and its workflow bodies and app\nagents, every row they read or write. A table `rows` states no rule of is read whole by everyone the app is shared\nwith, so a desk whose audience its sharing already decides states nothing. The rule holds for admins too: an app with people who see every row names them, as a group.\n\n**A row rule is never inherited.** A child read under a ruled record states\nits own in `rows`: the record\'s `member_of` clauses as they are, and its column clauses\n`through` the one-row link the child hangs by \u2014 over one hop or several, each a\nlink with `"multi": false`, since over several rows the rule would admit a\nreader any one of them admits while the editor\'s guard reads the first. Only the\nstatus history takes its record\'s rule.\n\n## Field\n\nEvery field carries the keys below, and its `type`\'s section adds the rest; a\ntype whose section names no `default` takes none. `label` may not contain `{` or\n`}` (formulas reference fields by label at the platform level). Every row in `rows` states each\n`required` field it carries (neither a default nor a `default_from` copy is applied to them), and a required\nLINK is written with its row: the table it names is created first, and tables\nwhose required links name each other are refused, since none of their rows could\never be created.\n\n**A table states who keys nothing.** Whether a person may change a field in an app is that app\'s statement\n(what its tree draws, and `edit: false`, `reference/app-tree`): a post\'s id a publishing workflow brings back, a count a sync fills, a status an act moves\nare left out of the apps that do not save them, and written by a workflow, the records API, the chat agent and an\nimport as the table\'s access allows. A formula, a rollup, a lookup and an autonumber are no one\'s to key already.\n\n<!-- generated:start field -->\n\n#### Field\n\n| Key | Type | Meaning |\n|---|---|---|\n| `type` | `"text"` \\| `"number"` \\| `"date"` \\| `"boolean"` \\| `"select"` \\| `"member"` \\| `"link"` \\| `"files"` \\| `"formula"` \\| `"rollup"` \\| `"lookup"` \\| `"autonumber"`, required | What the field holds \u2014 each type takes the further keys its own section lists |\n| `label` | text, required | The field\'s name in the workspace |\n| `description` | text | The field\'s description, written onto the field in the workspace |\n| `required` | boolean | Refuse a record whose cell for this field is empty. Every write path \u2014 create, update, an agent\'s tool call, a workflow\'s set \u2014 refuses the row by field name. A stored field is flagged only once every row holds a value. |\n\n<!-- generated:end field -->\n\n### `text`\n\n<!-- generated:start field-text -->\n\n| Key | Type | Meaning |\n|---|---|---|\n| `default` | text | Value pre-filled into a new record when none is supplied for this field; the write that makes the field required also fills it into every row holding it empty. |\n| `unique` | boolean | Unique values required |\n| `format` | `"text"` \\| `"link"` \\| `"markdown"` \\| `"time"` | How the words are drawn \u2014 plain, as a link that opens, or as markdown |\n| `default_from` | text | Copied when a record is made off the row a one-row link of this entity names \u2014 `<link alias>.<field alias>` \u2014 or, reading on through one-row links, off the row the last of them names \u2014 `<link alias>.<link alias>.<field alias>` \u2014 and never re-read, so the source changing later leaves the row alone. A value the add states wins; a select copies each option as this field\'s option of the same alias. |\n| `suggest` | [Suggest](#suggest) | A text field whose control offers, as the reader types, the distinct values a text field of a catalog table holds (a damage position\'s code among the codes on file); any text is still written |\n| `min` | number \\| text | Refuse a create or update whose value is below this: a constant for a number, or a field \u2014 `<field alias>` of the same row, or `<link alias>.<field alias>` of the one row a link names \u2014 of the same type (a return date after the departure, a line\'s day inside its trip). On a figure whose unit or currency is per row (its notation\'s `per_row`) a constant bound is only 0; bound it by a field of the row |\n| `max` | number \\| text | Refuse a create or update whose value is above this: a constant for a number, or a field of the same row or of the one row a link names |\n\n<!-- generated:end field-text -->\n\n### `number`\n\n<!-- generated:start field-number -->\n\n| Key | Type | Meaning |\n|---|---|---|\n| `default` | number | Value pre-filled into a new record when none is supplied for this field; the write that makes the field required also fills it into every row holding it empty. |\n| `notation` | [notation](#number) | How the figure reads: { "style": "decimal" }; money, { "style": "currency", "currency": an ISO 4217 code (USD, VND) }; or a quantity, { "style": "unit", "unit": "percent" (10 reads "10%"), or a measured code (g, kg, t, l, m3, cbm, mm, cm, m, km, m2, min, h, day), which converts and scales within its dimension, or any other noun of at most 12 characters (ki\u1EC7n, pallet, TEU), which never does }. A currency or unit read on each row from a single select of that row is { "per_row": that select }. Omitted, a decimal. |\n| `rating` | [Rating](#rating) | The figure is a grade: whole numbers 1 to `max` (3 to 10), empty or one of them, drawn as stars. Only on a plain decimal figure. |\n| `default_from` | text | Copied when a record is made off the row a one-row link of this entity names \u2014 `<link alias>.<field alias>` \u2014 or, reading on through one-row links, off the row the last of them names \u2014 `<link alias>.<link alias>.<field alias>` \u2014 and never re-read, so the source changing later leaves the row alone. A value the add states wins; a select copies each option as this field\'s option of the same alias. |\n| `min` | number \\| text | Refuse a create or update whose value is below this: a constant for a number, or a field \u2014 `<field alias>` of the same row, or `<link alias>.<field alias>` of the one row a link names \u2014 of the same type (a return date after the departure, a line\'s day inside its trip). On a figure whose unit or currency is per row (its notation\'s `per_row`) a constant bound is only 0; bound it by a field of the row |\n| `max` | number \\| text | Refuse a create or update whose value is above this: a constant for a number, or a field of the same row or of the one row a link names |\n\n#### Rating\n\n| Key | Type | Meaning |\n|---|---|---|\n| `max` | integer, required | The scale\'s top: the most stars a grade holds |\n\n<!-- generated:end field-number -->\n\n`notation` is how the number reads, and every surface reads it:\n`{ "style": "currency", "currency": "USD" }` prints as money in its code,\n`{ "style": "unit", "unit": "kg" }` as a quantity with its unit after it,\n`{ "style": "unit", "unit": "percent" }` as a percent \u2014 10 is "10%", never\nmultiplied \u2014 and `{ "style": "decimal" }`, or no notation, as a plain number. One\nkey, so a figure reads one way.\n\nAn absent number is drawn blank, except a `sum` or count rollup read as a meter\'s measure: nothing accumulated yet reads 0.\n\nA unit \u2014 `{ "style": "unit", "unit": "kg" }` \u2014 is what a figure counts or\nmeasures; `percent` aside, it is measured or counted. A **measured** unit is a code of one catalog \u2014 mass `g`\n`kg` `t`, volume `l` `m3` `cbm` (a cubic metre under freight\'s name), length\n`mm` `cm` `m` `km`, area `m2`, duration `min` `h` `day` \u2014 so a figure typed in\nanother unit of its dimension converts (`12,5 t` into a `kg` field is 12 500),\nand a tile or a chart reads it in the largest unit it reaches (12 500 kg as\n12,5 t\u1EA5n; CBM never scales) while a cell, a fact and a column always read in the\nfield\'s own. Any other noun of at most 12 characters (`ki\u1EC7n`, `pallet`, `TEU`) is a\n**counted** unit: a word after the figure that never converts. A measured unit is\nwritten as its code \u2014 `t\u1EA5n`, `KG` or `m\xB3` is refused, naming the code. A formula\nstates its own as its `notation`; a rollup that keeps the value (`sum`, `avg`,\n`median`, `min`, `max`, `range`) and a lookup carry the unit of the figure they\nread, exactly as they carry a currency, and a count carries none. A quantity is a\nnumber with its unit, never words (`3 cartons` in a text field): only a number\nsums, converts and reads down a column.\n\nA field\'s cells always hold figures in its own unit, so moving it between two\nunits of one dimension (`kg` to `t`) converts every stored figure \u2014 a change made\nin the workspace, in the field\'s settings (which say how many first) or through\n`set_tables`. Any other change of unit\nrelabels.\n\nA figure whose unit or currency varies by row names a single select of its own\nrow as `per_row` \u2014 `{ "style": "unit", "unit": { "per_row": "uom" } }`,\n`{ "style": "currency", "currency": { "per_row": "currency" } }` \u2014 or a lookup of\none through a one-link, a line reading its shipment\'s currency. That select\'s\noptions are the vocabulary: each label a unit (`chi\u1EBFc`, `kg`), or an ISO 4217 code\n(`USD`). A label outside it is refused when the figure is written and when the\nselect is \u2014 its options, its type or its deletion while a figure names it. A row\nwhose select is empty reads its figure bare. Every app reads each row\'s figure in\nits own row\'s unit, and a sum never mixes units: totals are one per unit (past three units a total the runtime draws over a set of rows \u2014\nsummary line, group totals and feet, a Sheet\'s table foot \u2014\nstates the count alone; a reading an author states draws every unit), a chart draws one at a time. A rollup that keeps the value (`sum`, `avg`, `min`\u2026)\nover such a figure stands only where the child\'s select is a lookup, through\nthe rollup\'s own link, of a select on this table \u2014 the rollup reads that\nselect\'s unit; otherwise it is refused. A lookup of such a figure stands only\nwhere its table also looks up the figure\'s select (stored, or itself looked up\nthrough one-row links) through the same one-link, and reads in that lookup; otherwise it is refused. A count is unaffected. Moving a field between a\nfixed and a per-row unit relabels.\n\n### `date`\n\n<!-- generated:start field-date -->\n\n| Key | Type | Meaning |\n|---|---|---|\n| `default` | text | Value pre-filled into a new record when none is supplied for this field; the write that makes the field required also fills it into every row holding it empty. A date string in the field\'s format. |\n| `format` | `"date"` \\| `"datetime"` \\| `"month"` \\| `"date_range"` \\| `"datetime_range"` | Whether the field holds a day or a moment, alone or as a span; `month` (stored YYYY-MM) holds a calendar month, a payroll or billing period: a full date written to it keeps its month. |\n| `timezone` | text | IANA timezone |\n| `derive_from` | `"created_at"` \\| `"updated_at"` | Auto-populate from the row\'s system timestamp; the field becomes read-only. |\n| `default_from` | text | Copied when a record is made off the row a one-row link of this entity names \u2014 `<link alias>.<field alias>` \u2014 or, reading on through one-row links, off the row the last of them names \u2014 `<link alias>.<link alias>.<field alias>` \u2014 and never re-read, so the source changing later leaves the row alone. A value the add states wins; a select copies each option as this field\'s option of the same alias. |\n| `min` | number \\| text | Refuse a create or update whose value is below this: a constant for a number, or a field \u2014 `<field alias>` of the same row, or `<link alias>.<field alias>` of the one row a link names \u2014 of the same type (a return date after the departure, a line\'s day inside its trip). On a figure whose unit or currency is per row (its notation\'s `per_row`) a constant bound is only 0; bound it by a field of the row |\n| `max` | number \\| text | Refuse a create or update whose value is above this: a constant for a number, or a field of the same row or of the one row a link names |\n\n<!-- generated:end field-date -->\n\nA `default` is refused beside `derive_from`: the platform stamps that date.\n\n### `boolean`\n\n<!-- generated:start field-boolean -->\n\n| Key | Type | Meaning |\n|---|---|---|\n| `default` | boolean | Value pre-filled into a new record when none is supplied for this field; the write that makes the field required also fills it into every row holding it empty. |\n| `default_from` | text | Copied when a record is made off the row a one-row link of this entity names \u2014 `<link alias>.<field alias>` \u2014 or, reading on through one-row links, off the row the last of them names \u2014 `<link alias>.<link alias>.<field alias>` \u2014 and never re-read, so the source changing later leaves the row alone. A value the add states wins; a select copies each option as this field\'s option of the same alias. |\n\n<!-- generated:end field-boolean -->\n\n### `select`\n\n<!-- generated:start field-select -->\n\n| Key | Type | Meaning |\n|---|---|---|\n| `default` | list of alias | Value pre-filled into a new record when none is supplied for this field; the write that makes the field required also fills it into every row holding it empty. Option alias(es) this field declares \u2014 one for single-select. |\n| `options` | list of [Select option](#select-option) (at least one), required | The choices, in the order every picker and every ladder lists them |\n| `multi` | boolean | Allow multiple selections |\n| `default_from` | text | Copied when a record is made off the row a one-row link of this entity names \u2014 `<link alias>.<field alias>` \u2014 or, reading on through one-row links, off the row the last of them names \u2014 `<link alias>.<link alias>.<field alias>` \u2014 and never re-read, so the source changing later leaves the row alone. A value the add states wins; a select copies each option as this field\'s option of the same alias. |\n\n#### Select option\n\n| Key | Type | Meaning |\n|---|---|---|\n| `alias` | alias, required | Stable local alias, unique within the field |\n| `label` | text, required | Display label for the option |\n| `color` | [colour](#select) | The colour the option\'s badge is drawn in; absent, the option reads as its word wherever its select is drawn |\n| `mark` | [mark](#select) | The option\'s own mark, drawn in place of its colour dot wherever the option is shown: the brand it is ({kind: "brand", name: one of facebook, instagram, threads, meta, tiktok, google-ads, zalo, linkedin, x, google-meet, youtube, telegram, whatsapp, gmail, google-drive, outlook, excel, kiotviet, misa, lark, payos, easyinvoice}) a kit glyph ({kind: "icon", name: "wrench"}) or the face of who it is, drawn from its label ({kind: "avatar", name: "person" or "organization"}). Every option of a field has one, or none does. A mark a reader does not draw falls back to the dot |\n| `short` | text | A few letters the option reads as where room is short \u2014 a table\'s column ("K5" for a long legal category) \u2014 its label shown on hover |\n\n<!-- generated:end field-select -->\n\nA patch of a select states its whole `options` list: a list replaces whole, so an option it leaves out is deleted. To\nrename or recolour one option, restate every option kept, each with its alias. Rows still holding a deleted option refuse\nthe patch unless `force`.\n\n```json\n{\n "options": [\n { "alias": "draft", "label": "Draft" },\n { "alias": "confirmed", "label": "Confirmed" },\n { "alias": "shipped", "label": "Shipped", "color": "green" }\n ]\n}\n```\n\n`color` is one of: `red`, `orange`, `amber`, `yellow`, `lime`, `green`,\n`emerald`, `teal`, `cyan`, `sky`, `blue`, `indigo`, `violet`, `purple`,\n`fuchsia`, `pink`, `rose`, `slate`, `gray`, `zinc`, `neutral`, `stone`.\nEvery option is drawn in its colour wherever it shows \u2014 a cell, a row\'s line,\na record, a picker, the bar a reading splits the rows by.\n\nAn option may carry its own `mark`, drawn in place of its colour dot wherever\nthe option is shown \u2014 a stage, a chip, a filter, a fact, an entry of a log, a\nreading\'s part, a lookup of the select on another table. Where the select is its\nrows\' `records` `mark`, a brand or glyph stands on the row\'s lead tile in the option\'s\ncolour, and an option with none leads with its colour dot there. A select a reader scans\ndown a column \u2014 how a payment was made, the channel, the mode \u2014 states one on every\noption, since a glyph reads before its word: the brand it IS\n(`{"kind": "brand", "name": "tiktok"}` \u2014 one of `facebook`, `instagram`,\n`threads`, `meta`, `tiktok`, `google-ads`, `zalo`, `linkedin`, `x`,\n`google-meet`, `youtube`, `telegram`, `whatsapp`, `gmail`, `google-drive`,\n`outlook`, `excel`, `kiotviet`, `misa`, `lark`, `payos`), a glyph the kit draws\n(`{"kind": "icon", "name": "wrench"}`; any other name is refused), or \u2014 where the\noptions name people or organisations who are no member and no row \u2014 the face of who\nit is, drawn from its label (`{"kind": "avatar", "name": "person"}` or\n`"organization"`). Every option of a select has one, or none does: a run of chips\nwhere one carries no mark reads as the one missing something. `set_tables` writes the\nmarks onto the table. The glyph names are `reference/field/option-glyphs`.\n\n```jsonc\n"options": [\n { "alias": "short_video", "label": "Short video", "color": "zinc", "mark": { "kind": "brand", "name": "tiktok" } },\n { "alias": "print", "label": "Print", "color": "amber", "mark": { "kind": "icon", "name": "newspaper" } }\n]\n```\n\n### Option glyphs\n\nThe kit\'s glyph names an option\'s `mark` takes:\n\n<!-- generated:start field-select-glyphs -->\n\nactivity, align-center, align-left, align-right, align-vertical-justify-center, align-vertical-justify-end, align-vertical-justify-start, arrow-down, arrow-down-a-z, arrow-down-up, arrow-down-wide-narrow, arrow-left, arrow-left-from-line, arrow-right, arrow-right-from-line, arrow-right-left, arrow-up, arrow-up-down, arrow-up-wide-narrow, arrow-up-z-a, ban, banknote, bed, bell, between-horizontal-start, between-vertical-start, bold, bolt, book-marked, book-open, book-text, bot, box, brackets, brain, briefcase, building-2, calculator, calendar, calendar-clock, calendar-off, camera, car, chart-column, check, chevron-down, chevron-left, chevron-right, chevron-up, chevrons-down-up, chevrons-up-down, circle-alert, circle-check, circle-x, clipboard-list, clipboard-paste, clock, code, code-xml, columns-3, columns-3-cog, combine, construction, container, copy, credit-card, database, decimals-arrow-left, decimals-arrow-right, dollar-sign, download, ellipsis, eraser, expand, external-link, eye, eye-off, file, file-csv, file-down, file-question, file-spreadsheet, file-stack, file-text, file-up, folder, folder-closed, folder-open, folder-pen, form, funnel-plus, funnel-x, gauge, globe, gpu, grid-2x2, grip-vertical, group, hand-coins, hash, heading, heading-1, heading-2, heading-3, history, house, image, inbox, info, italic, keyboard, languages, layout-dashboard, layout-grid, library-big, link-2, link-2-off, list, list-checks, list-collapse, list-filter, list-filter-plus, list-ordered, list-tree, loader, lock, lock-keyhole, lock-keyhole-open, lock-open, log-in, log-out, mail, map-pin, maximize-2, megaphone, menu, message-circle, message-circle-question-mark, message-square, messages-square, mic, minimize-2, minus, monitor, mouse, mouse-pointer-click, music, newspaper, notepad-text-dashed, package, paint-bucket, paintbrush-vertical, palette, panel-left, panel-left-close, panel-left-open, panel-right, panel-right-close, panel-right-open, paperclip, pause, pencil, percent, phone, pin, pin-off, plane, play, plug, plus, receipt, rectangle-ellipsis, redo, refresh-cw, repeat, rotate-ccw, rotate-cw, rows-3, scan, scan-line, scissors, search, send, settings, share, share-2, shield, shield-alert, shield-check, shopping-cart, sigma, sliders-horizontal, smile, smile-plus, snowflake, sparkles, split, square, square-check, square-pen, square-sigma, star, stethoscope, sticky-note, strikethrough, table, table-2, tag, target, text-quote, text-wrap, thumbs-down, thumbs-up, ticket, trash, trending-down, trending-up, triangle-alert, truck, tv-minimal, type, underline, undo, upload, user, user-check, user-pen, users, utensils, waypoints, workflow, wrench, x, zap, zoom-in, zoom-out\n\n<!-- generated:end field-select-glyphs -->\n\n### `member`\n\nA person picker over the workspace\'s members. No default. With no role it is still drawn \u2014\nface and name, ranked as a `party` \u2014 in a screen\'s `columns` and in the register\na record draws of these rows.\n\n<!-- generated:start field-member -->\n\n| Key | Type | Meaning |\n|---|---|---|\n| `multi` | boolean | Allow multiple selections |\n| `default_from` | text | Copied when a record is made off the row a one-row link of this entity names \u2014 `<link alias>.<field alias>` \u2014 or, reading on through one-row links, off the row the last of them names \u2014 `<link alias>.<link alias>.<field alias>` \u2014 and never re-read, so the source changing later leaves the row alone. A value the add states wins; a select copies each option as this field\'s option of the same alias. |\n\n<!-- generated:end field-member -->\n\n### `link`\n\n<!-- generated:start field-link -->\n\n| Key | Type | Meaning |\n|---|---|---|\n| `default_from` | text | Copied when a record is made off the row a one-row link of this entity names \u2014 `<link alias>.<field alias>` \u2014 or, reading on through one-row links, off the row the last of them names \u2014 `<link alias>.<link alias>.<field alias>` \u2014 and never re-read, so the source changing later leaves the row alone. A value the add states wins; a select copies each option as this field\'s option of the same alias. |\n| `options_where` | [filter](#filters) | Which rows of the target this link may point at \u2014 an `and` group of plain conditions over the TARGET table\'s own fields, each `field_key` a field alias. It narrows every picker of the link, and a save naming a row outside it is refused on every path \u2014 an app, the grid, an import, a workflow, the API. |\n| `same` | list of alias (at least one) | One-row links this row and each row this link points at must name alike \u2014 a fee\'s invoice is one of its own visit\'s, a box\'s seal one of its own shipping line\'s: each a one-row link of both tables to the same table, or a lookup of one (a line\'s shipping line looked up from its visit, never stored beside it). It narrows the picker\'s read to the rows naming what this row names, a row made from the picker names it too (set, never asked), and a write is refused wherever it lands \u2014 on the link, or on what the two rows compare. |\n| `table` | text, required | The table the link points at: its alias, or the `ref` of another item of the call |\n| `multi` | boolean, required | Whether a row links to one row or many: true, many; false, one. Where the link is paired, at most one of the two sides holds one |\n| `pair` | `true` \\| alias | Makes the link two-way: the alias of its partner field on the other table, which names this one back, or `true` to have the alias derived. Stated on one table, the partner is made on the other with the inverse cardinality; a many-to-many link states both sides |\n\n<!-- generated:end field-link -->\n\n**`multi` is stated on every link:** `true` holds several rows, `false` one \u2014 one customer on an\ninvoice, one project on a device. There is no default.\n\nA two-way link states `pair` on one table, as `true` or a free alias, and the partner is made on the\nother table with the inverse cardinality; a many-to-many link states both sides, since the inverse of\nmany is not decided. A pair stated on both sides is made once. Both tables are written in the one\ncall (`table` names the other item\'s `ref`). A link with no `pair` is one-way, and nothing is created on the target. Pair a link when\nthe target\'s own record should list what points at it, and leave it unpaired when it should not: either\nway the record plan draws the relation as a section on the side it points at, so an unpaired link costs\nthe target nothing. Of two paired links at most one holds one row.\nA link to its own table is paired with itself (a spouse) when `pair` is `true`, and with a second field of that table when `pair`\nnames its alias (a parent and its children, each stating the other); paired with itself it cannot hold one row.\n\n```jsonc\n// a field of table "order"\n"customer": { "type": "link", "label": "Customer", "table": "customer", "multi": false, "pair": "orders" }\n```\n\n```jsonc\n// a field of table "customer"\n"orders": { "type": "link", "label": "Orders", "table": "order", "multi": true, "pair": "customer" }\n```\n\n### `files`\n\nA row attaches documents to it (`reference/rows`). Each file\nis drawn by its kind, with no key to choose: a picture (an image, a video) as its\nthumbnail, a document (a PDF, a sheet) as its type\'s badge and its filename.\n\n### `formula`\n\nA formula states its keys on the field itself, beside `type` and `label`:\n`{ "type": "formula", "label": "Total", "expression": "{quantity} * {unit_price}", "notation": { "style": "currency", "currency": "USD" } }`.\n\n<!-- generated:start field-formula -->\n\n| Key | Type | Meaning |\n|---|---|---|\n| `expression` | text, required | The expression, over fields of THIS entity by alias in braces \u2014 `{quantity} * {unit_price}` |\n| `output_type` | `"number"` \\| `"text"` \\| `"date"` \\| `"datetime"` \\| `"boolean"` \\| `"select"` | Holds a formula to the type its readers need: absent, it is what the expression yields. Stated, it is checked against that and refused where they differ (a datetime is never stated date) |\n| `notation` | [notation](#number) | How the figure reads: { "style": "decimal" }; money, { "style": "currency", "currency": an ISO 4217 code (USD, VND) }; or a quantity, { "style": "unit", "unit": "percent" (10 reads "10%"), or a measured code (g, kg, t, l, m3, cbm, mm, cm, m, km, m2, min, h, day), which converts and scales within its dimension, or any other noun of at most 12 characters (ki\u1EC7n, pallet, TEU), which never does }. A currency or unit read on each row from a single select of that row is { "per_row": that select }. For a formula yielding a number. |\n| `link` | `true` | The formula yields a URL as text, drawn as a link that opens. |\n| `options` | list of [Select option](#select-option) (at least one) | The categories the formula yields, drawn as a single select\'s options are (read-only). The expression yields one of them as `{this_field:option}`, or null \u2014 `{days_idle} > 30 ? {warmth:cold} : {warmth:hot}`. Omit for a formula yielding a plain value. |\n\n<!-- generated:end field-formula -->\n\n`output_type` is what lets a role or a screen clause accept a computed value: a\ncaption over a derived name (`output_type: "text"`), a period over a settled date\n(`"date"`). A formula declaring no `output_type`, `notation` or `link` says nothing\nabout its result, and every rule that needs one refuses it by name. A formula stating\n`options` is a computed category: read-only, and read as a single select\nwherever it is drawn \u2014 a column, a filter, a reading\'s `by` or `where`.\n\n**A select reaches a formula as the KEYS of its chosen options**, a list \u2014\nnever their labels, and never their aliases \u2014 and a document has no keys: the\nworkspace mints them when the table is made. So an option is named in a formula\nas `{field:option}`, both aliases, and the write puts that option\'s key in its\nplace: `includes({kind}, {kind:crate})` for a select holding one or several,\n`{kind}[0] == {kind:crate}` for a single one. A select compared to its own words\n(`{kind} != "Crate"`) matches no row and computes the other branch everywhere,\nso the check refuses it and names the token. A select looked up through a link\nof one row (`multi: false`, or a chain of them) is named the same way:\n`{parent_stage} == {parent_stage:won}`. A lookup through a link holding several\nrows has no single option; it is tested on the table it lives on, in a formula of\nits own, and that result looked up.\n\n**The language.** The check refuses a call or a name the platform cannot run, naming what to write:\n\n<!-- generated:start field-formula-language -->\n\n- Operators: `+ - * / %`, `== != > < >= <=`, `&& || !`; `+` also joins text\n- Numbers: arithmetic is exact decimal (`0.1 * 3` is `0.3`), a division that does not end the nearest double; a comparison between two numbers reads both at 15 significant digits; `round` rounds a half away from zero (`round(-2.5)` is `-3`)\n- Conditionals: a ternary only \u2014 `{amount} > 100 ? "High" : "Low"`\n- Not supported: optional chaining (`?.`), nullish coalescing (`??`), template literals, arrow functions \u2014 use `get(obj, "path", default)`, `coalesce(v1, v2)`\n- Helpers are these names, spelled exactly; a spreadsheet function (`IF`, `SUM`, `LEN`, `DATEDIF`) is none of them, and a formula calling one is refused\n- Math: round(n,decimals?), ceil(n), floor(n), abs(n), min(a,b), max(a,b), sum(arr), mean(arr), clamp(n,min,max), percentage(part,total,decimals?), pow(base,exp), sqrt(n), mod(n,divisor)\n- A select reads as its option keys: compare it with `{field:option}`; read its name as text with `label({field})`\n- Strings: label(select) (the option\'s name; a multi-select\'s names joined ", "), upper(s), lower(s), trim(s), capitalize(s), length(s), contains(s,search), join(arr,sep), split(s,sep), replace(s,search,rep), replaceAll(s,search,rep), removeChars(s,chars) (s without any character that occurs in chars), removeSpaces(s) (s without any whitespace), startsWith(s,prefix), endsWith(s,suffix), substring(s,start,end?), padStart(s,len,char), padEnd(s,len,char), numberToWords(n, lang?) (lang \'vi\' default, or \'en\'), uuidFrom(s) (the same UUID for the same text)\n- Lists: includes(list,value), first(list), last(list), unique(list), compact(list) \u2014 length(list) counts one; join, sum, mean, first, last, unique and compact read a single value as a list of it\n- Dates: now(), formatDate(d,fmt), addDays(d,n), subDays(d,n), addHours(d,n), subHours(d,n), addMinutes(d,n), subMinutes(d,n), startOfDay(d), endOfDay(d), startOfMonth(d), endOfMonth(d), addMonths(d,n), differenceInCalendarDays(later,earlier) (days between two dates, whatever it is searched as: `daysBetween`, `diffDays`, `dateDiff`), differenceInHours(later,earlier), differenceInMinutes(later,earlier), isBefore(d1,d2), isAfter(d1,d2), isSameDay(d1,d2), isToday(d), isWithinRange(d,start,end), datesOn(from,until,days) (the days from..until falling on weekdays named `mon` to `sun`, as a list of dates), meetsBounds(value,kind,{gt,gte,lt,lte},tz?), parseDate(d)\n- Null/type: isNull(v), isEmpty(v) (also true for "" and []), coalesce(v1,v2,...), isString(v), isNumber(v), isBoolean(v), isArray(v), toNumber(v), toFigure(v), toString(v)\n- Other: formatCurrency(amount,locale,currency), formatDecimal(value,decimals,locale) (grouped quantity, no symbol; without decimals, `formatDecimal(value,locale)`, the decimals it holds, at most two, as the app draws a figure), get(obj,"path",default?)\n- Empty cells: a cell nobody filled is null inside a formula, whatever its type; one holding 0, false or "0" is not empty. Test it with `isEmpty({note})` \u2014 `{note} == ""` and `{done} == false` are false on an unset cell\n- Arithmetic over an empty cell: `+` and `-` read it as 0 beside a value (`{fee} + {surcharge}` is `{fee}` when the surcharge is empty, null when both are); `*`, `/`, `%` and a unary `-` yield null (`{price} * {qty}` is null, not 0, when the quantity is empty)\n- No helper throws on an empty cell: the math helpers and toNumber return null, the string helpers "". A value of the wrong type still errors. When EVERY field a formula reads is empty it is null \u2014 unless it reads each only as the argument of isEmpty, isNull or isNotNull (`!isEmpty({file})` is false there, not null)\n\n<!-- generated:end field-formula-language -->\n\n### `rollup`\n\nAggregates the records reached through a link on this table.\n\n<!-- generated:start field-rollup -->\n\n| Key | Type | Meaning |\n|---|---|---|\n| `filter` | [filter](#filters) group | Only linked records matching this filter are aggregated; one condition on its own is a group of one. Every `field_key` in it names a field alias on the linked entity, and a select condition\'s value names an option alias there. A traversal node reaches past that entity, so its `path` hops and inner `field_key` are fully-qualified `entity.field` aliases. |\n| `via` | alias, required | The alias of a link of this table to roll up from |\n| `op` | [operation](#rollup), required | The operation over the linked rows |\n| `field` | alias | The alias of the field on the linked table the operation reads; absent for `count` |\n\n<!-- generated:end field-rollup -->\n\nA rollup states `via` (a link of this table), `op` and \u2014 except for `count` \u2014 `field`, an alias on the\nlinked table; `op` is one of `count`,\n`sum`, `avg`, `median`, `min`, `max`, `range`, `empty`, `filled`,\n`percent_empty`, `percent_filled`, `unique`, `percent_unique`, `earliest`,\n`latest`, `date_range`, `checked`, `unchecked`, `percent_checked`,\n`percent_unchecked`. The operation must be one the aggregated field\'s type\nallows \u2014 `sum` over a number, `earliest` over a date, `filled` over any stored or\nformula field. A lookup is never rolled up: roll up the child\'s own field, or a formula\nover it. A rollup states no `notation`: `sum`, `avg`, `median`, `min`, `max` and `range`\nread in the aggregated figure\'s, a count as a plain number, and a `percent_*` as a\npercent (0\u2013100), in the app as in the table.\n\n### `lookup`\n\nDisplays a field from the linked records: `via` names a link of this table, `field` a field of the table it\npoints at. Through a link holding several rows it holds every linked row\'s value, which an app reads whole: a sort by\nits first value, a filter matching any value, a grouping counting the row under each; `order_by` (`field`, `direction`)\npicks the one row whose value shows instead.\n\n<!-- generated:start field-lookup -->\n\n| Key | Type | Meaning |\n|---|---|---|\n| `via` | alias, required | The alias of a link of this table to look up through |\n| `field` | alias, required | The alias of the field on the linked table to show |\n| `order_by` | [Lookup order](#lookup-order) | Show ONE linked row\'s value \u2014 the first in this order \u2014 rather than every linked row\'s |\n\n#### Lookup order\n\n| Key | Type | Meaning |\n|---|---|---|\n| `field` | alias, required | A field alias on the linked table the rows are ordered by |\n| `direction` | `"asc"` \\| `"desc"`, required | Which end of that order the one row is taken from |\n\n<!-- generated:end field-lookup -->\n\nInside a formula, a lookup holding one value is that value (`{due_soon}` is\n`true`, not `[true]`); several values are a list.\n\n### `autonumber`\n\n<!-- generated:start field-autonumber -->\n\n| Key | Type | Meaning |\n|---|---|---|\n| `prefix` | text | Literal prefix prepended to every display value (e.g. \'KH-\' \u2192 \'KH-001\'). Ignored when `template` is set. |\n| `padding` | integer | Zero-pad the integer to this width. Default 1 (no padding). 3 \u2192 \'001\', \'012\', \'123\', \'1234\' (overflow uses the actual width). Ignored when `template` is set. |\n| `template` | text | Format template with placeholder tokens evaluated at insert time. Tokens: {N} (raw integer), {N:W} (zero-padded to width W, e.g. {N:3} \u2192 001), {YEAR} (4-digit year), {YEAR:2} (2-digit year), {MONTH} (2-digit month), {DAY} (2-digit day). Date tokens use the workspace timezone. Example: \'HM-{YEAR}-{N:3}\' yields \'HM-2026-001\'. Stored as the composed string; subsequent template edits do NOT re-format existing rows (date tokens would lose the original creation date). |\n| `next` | integer | Sets the number the next row takes, once, as the patch is written; never below one past the highest number issued. On a field added to a table with rows, those rows are numbered from it in creation order. It is no setting of the field: a read of the table shows none |\n\n<!-- generated:end field-autonumber -->\n\nA refused write and a dry run take no number, so a table\'s numbers run without a gap; a removed row\'s number is not\nissued again.\n\n<!-- generated:start rules-field -->\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `field.default` | A default names options its select declares \u2014 one on a single select \u2014 and a date stamped by `derive_from` states none. |\n| `field.default-from` | A field\'s `default_from` reads `<link>.<field>` off the row a one-row link of its table names \u2014 a link no copy fills \u2014 or, through further one-row links, `<link>.<link>.<field>` off the row the last names, into a field of the same type, date format and notation that `derive_from` does not stamp (a figure read per row, into one whose select is copied from or looked up off the source\'s select by the same links): a lookup only through a one-row link, a link only into one to the same table, a select\'s option as this field\'s of the same alias (one it lacks is not copied), several values only into a field holding several. The server copies it on every add that fills the link and leaves the field empty, so a List\'s `create` sure to fill the link \u2014 a required one, or the record it files the row under \u2014 does not ask it by default. |\n| `field.option-mark` | An option\'s `mark` is one the kit draws, and a select\'s options mark every one or none. |\n| `field.unit-select` | A notation\'s `per_row` names a single select of the same row, or a lookup of one through a one-link, whose every option label is a unit, or an ISO 4217 code. |\n| `field.link` | A link targets a table of the call or the workspace: its `pair` a link on that table naming this one back \u2014 and of two paired links at most one reads one row (`multi: false`). |\n| `field.formula` | A formula parses, reads fields of its own table by alias, names an option as `{field:option}` of a select it holds, or looks up through a link of one row, and compares a select to its options\' keys, never their words. |\n| `field.formula-type` | A formula yields what it states \u2014 its `output_type` (the type the platform stores: a `"datetime"` is never stated `date`), else a figure where it states a `notation` and text where it states `link` \u2014 as the platform infers it from the expression when the field is created. |\n| `field.rollup` | A rollup aggregates, through a link of its table (`via`), a field of the linked table (`field`) by an operation (`op`) that field\'s type takes \u2014 a figure read in each row\'s own unit or currency only by an `op` that keeps its values whose child select is a lookup, through the rollup\'s own link, of a select on this table \u2014 filtered on fields of the linked table. |\n| `field.lookup` | A lookup reads (`field`), through a link of its table (`via`), a field of the linked table \u2014 a figure read in each row\'s own unit or currency only where this table looks up that row\'s select through the same one-row link \u2014 ordered by a field of it (`order_by`). |\n| `field.computed-cycle` | Computed fields never wait on each other in a loop: each is computed after what it reads. |\n\n<!-- generated:end rules-field -->\n\n## Filters\n\nA table\'s saved views are not part of its document: `set_table_views` writes them and `get_table` lists them. A view\'s\nfilter, a color rule\'s filter, `options_where` and a rollup\'s `filter` share one grammar. Every field reference is a\nfield ALIAS on that table.\n\nA filter is a group \u2014 `{ "node_type": "group", "logic": "and" | "or",\n"children": [ \u2026 ] }` \u2014 or one condition on its own, `{ "node_type":\n"condition", "field_key": "tier", "operator": "has_any_of", "value": ["gold"] }`. A sort is a list of `{ "field_key": \u2026, "order": "asc" |\n"desc" | null }`. A condition states no `type`: its field\'s type decides which `operator` it admits: `has_any_of` / `has_none_of` / `has_all_of` / `is_empty` /\n`is_not_empty` for a select, `equals` / `greater_than` / `less_than` for a\nnumber, `on` / `before` / `after` / `between` for a date, `contains` /\n`is_any_of` for text. A select condition\'s `value` names option ALIASES.\n\n<!-- generated:start rules-color -->\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `color.fields` | A color rule\'s filters name fields of its table. |\n\n<!-- generated:end rules-color -->\n\n## Groups and templates\n\nA member group and a document template are made on their own, outside a table document and an app tree. A tree names a\ntemplate by its alias. A table document names a group by its id, where a `read_scope` clause (`member_of`),\na stage owner (`group`) or a check\'s `member_of("<id>")` takes one. `get_workspace` kind `group` lists the groups with their ids and members; `set_members` creates,\nchanges or deletes one in its `groups` (an admin\'s verb).\n\n`{{name}}` in an `html` or `email` template is filled from the workflow\'s data. Inline content is refused where it holds a\nscript, a frame, a `<link>`, an inline event handler or a `javascript:` URL; an `html` one may be a fragment, kept as\nwritten and printed as a whole document.\n\nA template\'s markup is the `template` of `set_template`, as one JSON string. A paper shaped like a counterparty\'s \u2014 a letterhead, a reference line, a seal, a signature block \u2014 is an `html` template with a shell around the body; `document_templates` covers the types.\n\n**What an act\'s template is handed** is its record\'s own fields by alias: a\nselect, a member and a link as their words (a link as the linked row\'s title), a\nnumber, a date and a computed value that declares its kind raw (`2800000`,\n`2026-09-14`) and a files field as its file cells (`{id, name, mime, url}`, the photos in the order held; a child row\'s\nfiles likewise) \u2014 never a computed select. On one record it is\nhanded, too, the rows of each child List the record draws, listed under that child\'s\nlink\'s name for `{{#each <link>}}` (and under the child entity\'s alias too): every row filed under the record, oldest first, each\nby its own fields as the record\'s are, less its link back to the record. A List that only reads is listed under its `key`, its rows reached by its link\nor, for a `<link>.<link>` path, by both. Over\nseveral rows (at most 200) the rows are listed under the table\'s alias, for\n`{{#each <alias>}}`, an html paper hands each row its own child rows under the same names, with `<name>_totals`.\n\n**Photos in a paper.** A file cell is drawn only if whoever makes the paper may read that file, by the rule the file\nproxy applies; a file they may not read is never drawn. html: `{{#each photos}}<img src="{{url}}">{{/each}}`, each\nphoto inline, only those the data\'s file cells carry (a url typed into a text field stays a link). Word:\n`{{IMAGE picture(cover, 8)}}` for one file cell, and `{{FOR p IN photos}}{{IMAGE picture($p, 8)}}{{END-FOR p}}` for\nmany. Excel: `{{cover | picture:6}}` as the whole cell, and `{{#each photos}}` with `{{this | picture}}` for many, each\nrow growing to its picture. The number is the width in centimetres (8 by default, 6 in Excel); the height follows the\npicture. `picture` takes one image file cell: a list, a file that is no image and a file that cannot be read are\nrefused by name. Photos are embedded at most 1600 pixels across.\n\nHelpers print a raw value in the template\'s `locale` \u2014 `vi` or `en`, the organization\'s language where it states\nnone; each prints `""` for an empty value:\n\n| Helper | Prints (`vi` / `en`) |\n|---|---|\n| `{{money total "USD"}}` | `1.250,50 US$` / `$1,250.50`, in the currency\'s minor units; no code, a number |\n| `{{number qty}}`, `{{number qty unit}}` | `1.234,5` / `1,234.5`: grouped, up to 2 decimals; a unit as the second argument follows it (`{{number qty item_unit}}` prints `6 kg`, `2 l\xEDt` / `2 L`: a measured unit in the language\'s label, a counted noun such as `th\xF9ng` as written) |\n| `{{date issued_on}}` | `14/09/2026`, `14 Sep 2026` in an English template; a date-fns pattern as the second argument, `{{date at "dd/MM/yyyy HH:mm"}}`, literal text quoted (`"\'Ng\xE0y\' dd"`). A moment prints on the workspace\'s timezone |\n| `{{words total "USD"}}` | `M\u1ED9t ngh\xECn hai tr\u0103m n\u0103m m\u01B0\u01A1i \u0111\xF4 la M\u1EF9 n\u0103m m\u01B0\u01A1i xu` / `One thousand two hundred fifty US dollars and fifty cents`; no code, VND (`\u0111\u1ED3ng`) |\n| `{{qr link}}`, `{{code128 position 6}}` | the value as a QR code, or as a Code 128 barcode (ASCII text only), a picture the width of the optional second argument in centimetres, by default sized to the value (a module prints 0.5 mm in a QR code, 0.33 mm in a barcode); a width too narrow to scan is refused, naming the least that does; not in an email template |\n| `{{date (add_days issued_on -1)}}` | `13/09/2026`: the date shifted by whole days (`-1`: the day before), for `date` to print; a number field as the days, empty shifting none |\n\nA value it cannot read (`{{money "abc"}}`, `{{date "14/09/2026"}}`) fails the render. A field named like a\nhelper and written alone (`{{number}}`) prints its own value.\n\nA field printed as a code in the other types: Excel `{{position | qr}}` or `{{position | code128:6}}` as the whole\ncell and the last helper \u2014 the picture is anchored on the cell and its row grows to hold it; Word `{{IMAGE qr(position)}}` or `{{IMAGE code128(position, 6)}}`. An empty field draws no picture.\n\n## Rows\n\n`rows` of a `set_tables` call are the first records of the tables the call creates, keyed by each one\'s `ref`;\na patch of an existing table seeds none, so write its rows into the table. A sample, not a data set: rows past it go in with `create_records` once the tables exist, in the batches its description bounds.\n\n```jsonc\n"rows": {\n "customer": [\n { "ref": "acme", "fields": { "name": "Acme Trading", "tier": "gold" } }\n ]\n}\n```\n\n`rows` sits beside `tables` in the call, not inside a table.\n\n<!-- generated:start rows -->\n\n#### Row\n\n| Key | Type | Meaning |\n|---|---|---|\n| `ref` | text, required | Local handle for this row, referenced by other rows\' link fields |\n| `fields` | map of text \u2192 any value, required | Field alias \u2192 the value, read against the field\'s declared type |\n\n<!-- generated:end rows -->\n\n<!-- generated:start rules-rows -->\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `rows.ref` | A row\'s `ref` is unique within its table. |\n| `rows.required` | A row states every field its table requires: it is created with what it states, its fields\' defaults and copies unapplied. |\n| `rows.value` | A row\'s value fits its field: an option alias for a select, `"<table ref>:<row ref>"` of a row of the linked table in this call or a stored record\'s id for a link, `"self"` for a member, a `fil_` id for files, a date in the date grammar (an hour only on a datetime), a text, number, yes/no or null otherwise \u2014 and none on a computed field. |\n\n<!-- generated:end rules-rows -->\n\nA `ref` is lowercase letters, digits and underscores, and is never persisted.\n\n`fields` is keyed by field alias, and every value is read against the field\'s\nDECLARED type:\n\n| Field type | Value |\n|---|---|\n| `text` / `number` / `boolean` | the value itself |\n| `date` | `"2026-03-14"`, or a relative expression (below) |\n| `select` | the option ALIAS \u2014 `"gold"`, or `["gold","vip"]` for a multi-select |\n| `link` | `"<table ref>:<row ref>"` naming another row of this call \u2014 `"customer:acme"` \u2014 or the id of a record the linked table already holds, or an array for several; a paired link is stated on ONE side (the child\'s link to its parent) and its partner fills itself |\n| `member` | `"self"` only \u2014 the member making the call |\n| `files` | the `fil_` id of a file already in this workspace, or a list of them |\n| `formula`, `rollup`, `lookup`, `autonumber` | not allowed \u2014 the platform writes these |\n\n### Relative dates\n\nA date cell holds a literal `YYYY-MM-DD`, or an expression relative to the day\nthe call is made, so a screen that opens on "this month" is not empty a month\nlater:\n\n- `@today` \u2014 the day of the run, in the workspace\'s timezone\n- `@month-start` \u2014 the 1st of that month\n- either with a whole-day offset: `@today-14`, `@month-start+9`\n- on a date that holds its hour (`format: "datetime"`), that hour after the day, and always stated:\n `@today 14:30`, `@today+1 06:00`\n\n`@month-start` exists because `@today-N` cannot promise a month: applied on the\n2nd, `@today-3` lands in the previous one.\n\n## Records\n\n`records` says how a row of a table is RECOGNISED \u2014 stated once in the table\'s document, beside its\n`title` \u2014 and every surface that draws one of its rows reads the same\nstatement: the register\'s row, a picker\'s option, a link\'s chip, a child table\'s\nrow and the record\'s header. Every table an app lists, opens or picks has one. The rarer keys \u2014 `scan`, `cadence`, `place`, `on_site`, `pin`, `plan_place` and `size` \u2014 are stated on `reference/record-places-pins-and-cadence`.\n\n```jsonc\n// table "visit"\n"title": "container_no",\n"records": {\n "subtitle": ["customer", "arrived_on"],\n "image": "photos",\n "status": { "field": "stage", "closed": ["gone"], "history": "visit_history" },\n "figure": "total_fees",\n "due": ["free_until"]\n}\n```\n\n```jsonc\n// table "release": a release order read against what it allows \u2014 a meter wherever it shows\n"title": "release_no",\n"records": { "figure": "issued", "limits": { "issued": "units" } }\n```\n\n```jsonc\n// table "dossier": a straight-line process \u2014 the stage a select, each step\'s day the date it stamps\n"title": "applicant",\n"records": { "status": { "field": "stage", "closed": ["signed"], "dates": { "received": "received_on", "appraised": "appraised_on", "signed": "signed_on" } } }\n```\n\n<!-- generated:start records -->\n\n#### Record\n\n| Key | Type | Meaning |\n|---|---|---|\n| `subtitle` | list of alias (1\u20132) | Up to two fields read under the title wherever a row is drawn (a code, a date, a party): the first at the body ink and the rest muted, one line at a desk, a second on a phone; a card shows one line per column |\n| `image` | alias | A files field that pictures the row, or a one-row link to a table with a picture, whose picture the row leads with \u2014 never a files field an act keeps the document it makes in. Absent, a table with exactly one files field is pictured by the first image in it \u2014 never a paper or other file \u2014 unless the entry states a `mark` or puts that field in the title or subtitle; an app turns it off with `row.image: false`. |\n| `mark` | alias | A single select (or a lookup of one through a one-row link) whose option leads the row wherever a mark leads it \u2014 a list\'s row, the record\'s head, a link naming the row: the option\'s brand or glyph, else its colour dot, on a tile. The field stays a field: a subtitle run, a column, a section\'s control. A write setting a formula mark is refused (a derived flag is a Check) and a stored one keeps drawing; never beside `image` or `party`, and never the status field |\n| `description` | alias | A text field saying what the row is about \u2014 a plan\'s brief, a customer\'s note: read in its record\'s head under the title\'s line, its first lines at rest and whole on a press, and written from the head\'s \u270E. Never on a row\'s line |\n| `party` | `"person"` \\| `"organization"` \\| `"organisation"` | What each row is where the rows are people (a contact, a patient) or organisations (a customer, a supplier, a carrier); absent, the rows are things (an order, an item, a paper) |\n| `status` | [Status](#status) | The stage a row moves through, a single select, drawn in the record\'s head, or its Side where the Side states it |\n| `figure` | alias | The one number the row stands for, read at its right (a total, a quantity left) |\n| `limits` | map of alias \u2192 (alias \\| number) | A number read against a bound \u2014 a field of the same row or a constant \u2014 drawn as a meter wherever it shows |\n| `gates` | map of alias \u2192 (alias \\| number) | A pass mark on a meter `limits` bounds \u2014 a field of the same row or a constant; a percent field is its share of the bound, any other number an amount. The meter marks it and fills complete once past it |\n| `tolerance` | map of alias \u2192 number | How far past its `limits` bound a meter may stand, in percent of the bound: the bound is an amount expected (received against ordered), not a cap. Without one the bound is a cap, and past it is an overrun |\n| `due` | list of alias (at least one) | Dates that are deadlines (stored, or computed as a date): each counts down and turns overdue until the row is at a `closed` option or `settled` holds, whatever stage it has moved to. A deadline is never an appointment date or the day a stage starts |\n| `frees` | alias | A date ending the row\'s span of days on which what the row holds is free again (a check-out, a hire\'s return): a stay from the 3rd to the 5th holds the 3rd and the 4th, and another may start on the 5th \u2014 on a lanes board, a calendar, a roster and in `no_overlap` alike. Absent, a span of days holds its last day; a span of moments always frees its end |\n| `settled` | alias | A yes/no of the row (stored, a formula: an invoice paid in full, or looked up through a one-row link: a line settled with its parent) that ends its deadlines: while it is true, no `due` of the row counts down or turns overdue \u2014 in a cell, on its line, in its head, on a calendar or gantt, or in the overdue count. A Sheet\'s or reading\'s `where` reads it as any other yes/no |\n| `task` | `true` | A row is work someone finishes: wherever rows of it stand in a table \u2014 a register, a record\'s rows, the rows filed under one \u2014 each is led by a ring ticking it done and unticking it by the one write of the app making that move. Its status is a stored select with `closed` |\n| `applies` | map of alias \u2192 map of alias \u2192 (list of alias (at least one) \\| boolean) | Fields that apply only while their conditions hold (a length only on a line whose tariff charges by the metre): where one does not apply no add asks it and no surface shows it. Never the title; a required one starts at its `default` |\n| `starts` | map of alias \u2192 `"today"` \\| `"me"` | What a field of a row being added starts at, where that start is certain: `today` a date (a moment starts now), `me` a member, the reader adding it; every other field starts empty unless the reader narrowed the register to a value or the field declares a `default` |\n\n<!-- generated:end records -->\n\n<!-- generated:start rules-records -->\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `records.title` | A title is the one field naming the row \u2014 any field but a button or a yes/no \u2014 and the subtitle never names the title\'s own field. |\n| `records.image` | `image` is a files field, never one an Act keeps the documents it makes in (`into`), or a single link to a table with a picture (never beside a `party`). |\n| `records.mark` | `mark` is a single select or a lookup of one through a one-row link, never a formula (a write setting one is refused: a derived flag is a Check), never the status field, nor on the folder an App works inside (`scope`), which its switcher names by a picture or its initials. |\n| `records.description` | `description` is a text field, read in the record\'s head \u2014 never a Field of a part too. |\n| `records.figure` | A figure is a number. |\n| `records.applies` | `applies` holds a field of the row other than its title to conditions of the same row \u2014 a yes/no (stored or a formula) by `true` or `false`, a single select by its options, its own or looked up through a one-row link \u2014 never to itself; a required field it holds starts at a `default`. |\n| `records.limits` | `limits` bounds a number by a number field of the row, in its unit or one of the same dimension \u2014 or by a constant, where every row reads the figure in one unit. |\n| `records.gates` | `gates` marks a pass on a meter `limits` bounds: a percent field (its share of the bound), another number in the bound\'s unit, or a constant. |\n| `records.tolerance` | `tolerance` stands on a meter `limits` bounds. |\n| `records.starts` | `starts` starts a field a person writes \u2014 `"today"` a date or a moment (never a span), `me` a member \u2014 and a `create` that does not ask a field it starts writes that start. |\n| `records.due` | A deadline (`due`) is a date. |\n| `records.frees` | `frees` names a stored day, never a moment: a span of moments already frees its end. |\n| `records.settled` | `settled` names a yes/no of the row (stored, a formula, or looked up through a one-row link) beside a `due`: while it holds, the row\'s deadlines neither count down nor turn overdue. |\n| `records.task` | A task entity (`task`) states a `status` of a stored single select with `closed` options \u2014 its ring ticks a row done by moving it to one. |\n| `records.cadence-makes` | *Noted, never refused:* An entity with a multi-select of weekdays that no `cadence` reads, whose rows a one-row child holding a date stands under, states a `cadence` naming the child, and an Act `makes` its rows. |\n| `records.picture` | *Noted by the designer on a write, never refused:* Rows an App draws that each hold one files field no Act makes documents into, no call is filed into, no files gallery keeps and no List compares as a pair (`compare`) \u2014 and no figure \u2014 are pictured by it (`image`); where the workspace\'s files are known, the field holding images is the picture, a figure or not. |\n| `records.mark-derived` | *Noted, never refused:* A table whose `records.mark` is a formula keeps drawing it; a derived flag is a Check, so a write setting `mark` to a formula is refused (`records.mark`) and a stored one keeps drawing. |\n| `records.mark-lead` | *Noted by the designer on a write, never refused:* Rows an App draws of an entity that states a single select besides its status whose options state a mark, and states no `mark`, `image` or `party`, can lead with that field\'s option as their mark (`records.mark`). |\n| `records.stage-holder` | *Noted, never refused:* A stage owned by a member field of the row itself, where the table does not require that field and no `create` or Act of the App states it (asks, sets, requires or writes it), lets a row reach the stage with the field empty: require the field, or state it in a `create` or an Act. |\n\n<!-- generated:end rules-records -->\n\n- **The title names the row** by who or what it is \u2014 a link by the linked row (a job\n read by its customer). Any field but a button or a yes/no may title it, yet a code\n titles a row only where people name the row by it, else it is a `subtitle`; it is the table\'s own setting, which every link shows.\n- **One lead per row.** A row leads with its picture (`image`), a face (`party`) or the\n option of a single select it holds (`mark`) \u2014 never two. A `mark` draws that option\n on a tile: its brand or glyph, else its colour dot; a row holding none, a ring saying\n none is picked. The same tile heads the row\'s record and leads it where a link\n names it; the select stays a field \u2014 a subtitle run, a column, a section\'s control.\n- **A limit** reads a number against a bound \u2014 another field of the row, or a constant.\n A `gates` entry marks a pass on that meter: a percent field is its share of the\n bound, any other number an amount.\n- **A deadline** (`due`) counts down wherever it is drawn and is overdue once past while\n the work is open. A register over the table says how many rows in view are overdue on\n its summary line, and pressing that count narrows to them \u2014 no reading to state.\n- **A span\'s free day** (`frees`) is the end date on which what the row held is free\n again \u2014 a check-out, a hire\'s return. A stay from the 3rd to the 5th holds two nights:\n a lanes board, a calendar and a roster draw it through the 4th, and `no_overlap` lets\n the next stay start on the 5th. Without it a span of days holds its last day; a span of\n moments always ends as the next may begin.\n- **`starts`** is where an add\'s field begins, stated only where that is certain \u2014 a\n log\'s own day at `today`, a request\'s requester at `me`. Nothing else starts a field\n but its declared `default` and what the reader narrowed the register to.\n\n## Record places, pins and cadence\n\nThe rarer keys of `records`, stated beside the ones on `reference/records`: a title read off a photo (`scan`), the rows a child owes each day (`cadence`), where a row stands on a map (`place`, `on_site`) or on a picture (`pin`, `plan_place`).\n\n```jsonc\n// table "site": it owes a diary page each day it works, from breaking ground through handover\n"title": "name",\n"records": { "cadence": [{ "entity": "diary_page", "on": ["mon", "tue", "wed", "thu", "fri", "sat"], "from": "started", "until": "handed_over" }] }\n```\n\n<!-- generated:start records-places -->\n\n#### Record places\n\n| Key | Type | Meaning |\n|---|---|---|\n| `cadence` | list of [Cadence](#cadence) (at least one) | The rows of a child each row owes one of a day, on the days of the week listed or its own multi-select names (a site\'s diary page, Monday to Saturday; a class\'s Tuesdays and Thursdays at 16:00) \u2014 one entry a child, never owed on a day still to come; an Act\'s `makes` makes them. A roster of these rows over days marks a past day owed with none missing in the danger tone, counted in the legend; today\'s is due, offered to add and never marked; each row\'s total reads the days it holds of those owed |\n| `scan` | `"text"` \\| `"iso6346"` \\| `"code"` | Its title, a text field, is painted or printed on the thing a row is (a container\'s number, a seal\'s) and read off one photo on a phone, beside each search matching it and each field holding or picking it: `iso6346` a container number, refused unless its check digit holds; `text` as it stands; `code` a barcode or QR code on the thing, decoded on the device from the photo with no agent |\n| `place` | [Place](#place) | Where a row stands, as plain fields of it, drawn as one place where its record draws the address: how sure it is, a press opening it in the device\'s maps, and one taking it from where the device stands |\n| `plan_place` | [Plan place](#plan-place) | Each row is a place on the plan a `plan` register draws: its title the place\'s code, its subtitle a note. A flat list, no tree |\n| `on_site` | [On site](#on-site) | Photos taken where a place stands (a site diary\'s): a photo taken through a phone\'s camera here keeps where the device stood, marked at the place, away from it or unknown, and a record holding one taken away says so among its checks \u2014 one with no place (picked on a computer, or kept before places were) is marked and warns nothing; a place reaches only members of the organization, through the apps drawing these photos |\n| `pin` | [Pin](#pin) | Each row is a place on a picture (a snag on a flat\'s plan, a spot on a container\'s drawing): a List of these rows draws the picture its `on` row holds with a numbered pin at each row\'s own place, each row led by its number, the row opened lit on it and a pin pressed opening its row; where the List writes rows, a press on the bare picture adds one there, and a pin dragged moves its row. A List of rows that link to these by a single link draws their places the same way |\n| `size` | [Record size](#record-size) | The real size of the thing a row is (a carton, a piece of furniture, a pallet): three number fields stating one length unit alike, read as one fact \u2014 "400 \xD7 300 \xD7 250 mm", a part the row lacks "\u2014" \u2014 after the subtitle wherever the row\'s line and head draw facts, never also as the subtitle\'s fields. A plan register drawing these rows draws each box at this size |\n\n#### Cadence\n\n| Key | Type | Meaning |\n|---|---|---|\n| `entity` | text, required | The table owed: each of its rows stands on one row of this table by its single link to it, and on the first date of its line (`records` title or subtitle) |\n| `on` | list of `"mon"` \\| `"tue"` \\| `"wed"` \\| `"thu"` \\| `"fri"` \\| `"sat"` \\| `"sun"` (at least one) \\| alias, required | The days of the week one is owed on: listed (`mon` to `sun`, each once), or a multi-select of this row whose option aliases are `mon` to `sun` |\n| `from` | alias | A date of this row: the first day one is owed (a site breaking ground, a contract\'s start); absent, no first day |\n| `until` | alias | A date of this row: the last day one is owed (a site\'s handover, a contract\'s end); empty or absent, through today |\n| `start` | alias | A `format: "time"` field of this row (a lookup too): the time of day the child\'s first date starts at, where that date holds a moment |\n| `end` | alias | A `format: "time"` field of this row, where the child\'s second date holds a moment: the same day, or the next where it is earlier; or a number field of this row, the days each runs, where the child\'s dates are days (its last day is the first plus the days less one; an empty length leaves the row unplaced) |\n| `planned` | alias | A stored date of the child, by its alias on that table: the day it was made for, kept when it moves. Set by what makes it, and read for what is still owed; state it with the child\'s link in `unique` |\n| `except` | text | A table of closed days: each of its rows closes the days from the first date on its line to the second. Nothing is owed on them |\n\n#### Place\n\n| Key | Type | Meaning |\n|---|---|---|\n| `address` | alias, required | A text field: the address, as people write it |\n| `latitude` | alias, required | A number field: degrees north, negative south |\n| `longitude` | alias, required | A number field: degrees east, negative west |\n| `accuracy` | alias | A number field: how many metres off the device that gave the place said it may be |\n\n#### On site\n\n| Key | Type | Meaning |\n|---|---|---|\n| `photos` | list of alias (at least one), required | Files fields of this row holding photos taken on site |\n| `place` | alias | A single link of this row to the row whose `place` its photos are taken at (a diary page\'s site); absent, this row\'s own `place` |\n| `radius` | number, required | How many metres from the place a photo still counts as taken there |\n\n#### Pin\n\n| Key | Type | Meaning |\n|---|---|---|\n| `on` | alias, required | A single link of this row to the row whose picture (its `records` `image`) the place is on \u2014 a container\'s drawing, a floor\'s plan |\n| `x` | alias, required | A number field of this row: how far across that picture the place stands, in percent from its left edge |\n| `y` | alias, required | A number field of this row: how far down that picture the place stands, in percent from its top edge |\n\n#### Record size\n\n| Key | Type | Meaning |\n|---|---|---|\n| `across` | alias, required | A number field: the width of the thing a row is, across |\n| `along` | alias, required | A number field: its depth, along |\n| `up` | alias, required | A number field: its height, up |\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `records.scan` | A title read off a photo or a code (`scan`) is a text field the row stores. |\n| `records.cadence` | A `cadence` names each child once \u2014 its rows standing on one row of this entity by their single link and on the first date of their line \u2014 and its `on` lists each day of the week once, or names a multi-select of this entity whose options are all aliased mon to sun. `from` and `until` are two different days of this entity. `start` and `end` are `format: "time"` fields of this entity (a lookup too): `start` where the child\'s first date holds a moment, `end` where its second does, or `end` a number of days where its dates are days. `planned` is a stored date of the child, never its first or second. `except` is an entity whose line holds a date. |\n| `records.place` | A `place` names four different fields of the row: its address a text field, its latitude, longitude and accuracy number fields it stores. |\n| `records.plan_place` | A `plan_place` names `kind` and `reach_from` as single selects, `sheet` as a single select or a one-row link, `stacked` as a boolean and the rest as numbers, each a different field; `kind`, `x`, `y` required. `size` names three numbers (`across`, `along`, `up`) stating one cell in one length `unit` alike. A `sheet` linking to an entity that states an `image` draws that drawing under the places, `scale` (a number field of that entity) its width in cells; `scale` goes with such a `sheet` alone. |\n| `records.on_site` | `on_site` lists files fields of the row, each once, taken at the `place` of the row itself or of the one row a single link of it names (`place`), which states one. |\n| `records.pin` | A `pin` names a single link of the row (`on`) to an entity whose `records` states its `image` (a PDF is drawn as its first page), and two different number fields of the row, how far across (`x`) and down (`y`) that picture in percent. A List of rows whose own entity states a `pin` is drawn over that picture; `on`, `x` and `y` are set by the press that adds a row, never asked. |\n| `records.size` | A `size` names three different number fields of the row (`across`, `along`, `up`) stating one length unit alike (mm, cm, m or km); they read as one fact after the subtitle, so the subtitle never also names one. |\n\n<!-- generated:end records-places -->\n\n## Status\n\nA record\'s `status` is the stage a row moves through \u2014 a stored single select, each\noption\'s moment the date `dates` names. A record draws it as its dot and word where Act buttons on the page offer its moves, and as a control for the moves no drawn Act offers: choosing one runs its Act, asking and refusing as its button does.\n\n<!-- generated:start status -->\n\n#### Status\n\n| Key | Type | Meaning |\n|---|---|---|\n| `field` | alias, required | The single select that is the row\'s state, its options in the order the work goes through them, read as steps by itself on a record whose parts state no `at` |\n| `closed` | list of alias (at least one) | Options that end the work: a register opens on the rows not at them, and the badge reads muted |\n| `dropped` | list of alias (at least one) | Options of `closed` that leave the work undone (cancelled, rejected): whoever holds the row moves it to one from any stage, where every other move forward passes each owned stage between that binds the row (its `when`) and needs each one\'s owner, and a row leaving one enters a stage as a row made there does |\n| `history` | text | A table every write that sets or moves the status appends one row to (its link to this table, the new status, the moment and who) \u2014 by the record write path, whoever writes: for reporting on every move |\n| `dates` | map of alias \u2192 alias | Option alias \u2192 a date field of this entity the record write path stamps with the moment a row moves into that option, or is made at it \u2014 whoever writes. A value the same write states for that field wins, so past data loads as it happened \u2014 and the `history` records the move at that day, a row made at a later option recording each earlier one whose date the write states, in order; the platform never clears a stamp, so each is when the row last entered the option. A stage\'s date is made where none is named |\n| `stages` | map of alias \u2192 [Stage](#stage) | Option alias \u2192 who owns that stage and how long it should take: the owner alone takes a row out of it, by any write, and presses the acts offered there; every move forward past it of a row it binds (its `when`), and every such row made past it, is its owner\'s too. Its days run from the moment its `dates` field holds. In an app the status then moves only by acts that `set` one of its options \u2014 no save writes it and no act asks it |\n\n#### Stage\n\n| Key | Type | Meaning |\n|---|---|---|\n| `owner` | `"field"` \\| `"link.field"` \\| `{ "group": id }`, required | Who owns the stage: a member field of the row, `link.field` read through a one-row link (not at the stage a row opens at, whose owner made the row: a member field of the row itself), or `{ group }`. A member moves a row off only one stage that groups own, one at a time: the next waits on a different member, or on a stage stating no owner; a row made past a stage signs nothing there |\n| `within` | integer | Whole days the stage should take from the moment the row entered it |\n| `when` | map of alias \u2192 (list of alias (at least one) \\| boolean \\| [comparison](#values) \\| `{ "empty": true \\| false }`) | The rows that must pass this stage: a row meeting every entry on its own fields, as it stood before a write or as the write leaves it \u2014 a single select holding one of these options, a yes/no this value, a number or date meeting its bounds, a field empty or filled. Absent, every row must. A row at the stage leaves it by its owner either way |\n\n#### Stage group\n\n| Key | Type | Meaning |\n|---|---|---|\n| `group` | text, required | A group of the workspace, by id: its members press the act. One person moves a row off only one of the stages different groups own |\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `records.status` | A status is one single select, its options in the order the work goes through them, `closed` naming the ones that end it and `dropped` those of them reached from any stage. |\n| `records.history` | A declared status `history` has exactly one link to the row it records, one single select holding every option of the status (or a text), exactly one date and at most one member. |\n| `records.stages` | A stage\'s owner (`status.stages`) is a single member field of the row, one read through a one-row link (never at the stage a row opens at: its owner made the row, so it is a member field of the row itself), or a group, on an option that does not end the work; a group\'s stage needs the status `history` with who moved the row. Every write takes a row off a stage as its owner alone, and moves a row past it or makes a row past it as its owner alone where the stage binds the row (its `when`) \u2014 a move to a `dropped` option excepted, which whoever holds the row makes from any stage; a row leaving a dropped option, or holding none, enters a stage as one made there. Each stage\'s moment, and each open option\'s, is the date its `dates` names, made where none is named, which every write that opens or moves the status stamps; `within` runs from it. In an App a status with stages moves only by Acts that `set` one of its options \u2014 no save writes it or a date it stamps, and no Act asks either, sets it otherwise or writes either from a workflow; an Act moving a row forward past a stage another owner owns, into an option not `dropped`, keeps its `when` off every row that stage binds. |\n| `records.stage-when` | A stage\'s `when` names the rows that must pass it, as an Act\'s `when` holds them \u2014 single selects to their options, yes/nos to `true` or `false`, numbers and dates to bounds, any field to `{ "empty": true \\| false }` \u2014 on fields a write stores of the row itself: never the status, a formula, a lookup or a rollup, and never on the stage a row opens at. It binds a row meeting it as it stood before a write or as the write leaves it; absent, it binds every row. |\n\n<!-- generated:end status -->\n\n- **The status** is one single select. `closed` options end the work: a register opens\n on the rows not in them, a row holding no status among them. A `history` table gets one row per move \u2014 its link to this\n table, the new status (a select holding the same option aliases, or text), the\n moment (the stage\'s `dates` value where the write states a past one, so loaded rows keep\n the day they reached it) and who \u2014 appended by the record write path in every write that opens a row at a\n stage or moves it, whoever writes (the member behind the write is its `by`; an automation\n leaves it empty). A `history` the tables do not declare is derived, and needs no\n `records` of its own.\n- **When each step happened** is the date `dates` names for its option, stamped as the row\n enters it, whoever moves it. One way times a status: a straight-line process is a select\n whose options are its steps in order, each with its date \u2014 never a run of dates the stage\n is read off. An Act that moves the stage and `asks` the step\'s date with `starts: "today"`\n lets the reader record a day already past in the same press.\n\n## Write rules\n\nWhat a WRITE of a table\'s rows meets is stated in the table\'s document, where it applies: `min` and\n`max` on a number or date field, `options_where` and `same` on a link, `suggest` on a text field,\nand `no_overlap` and `natural_key` on the table. A key a field\'s type does not take is refused at\nits path, and a document has no `write_rules` key.\nEvery one but `natural_key` and `suggest` holds on every path a record is written by \u2014 the grid, a record\'s form, an import, a workflow, an\nagent, the API, an app \u2014 judged in the write\'s own transaction, every broken rule listed at once; the\nscreen and a picker only mirror them. A row that already breaks one stays editable until a write\ntouches what the rule reads. `natural_key` names the fields an app recognises a row by, to reuse it where an\nadd or a find-or-create meets it; a record tool or the API creates the row it is handed. `suggest` offers\nvalues in a text control and refuses none. An `options_where` link is refused where a write names a row the\nnarrowing does not admit, and every picker of the link offers only the rows it admits.\n\n```json\n{\n "tables": [\n {\n "ref": "customer",\n "label": "Customer",\n "fields": { "email": { "type": "text", "label": "Email", "unique": true } },\n "natural_key": ["email"]\n }\n ]\n}\n```\n\nA customer above is RECOGNISED by their address. An add that names one \u2014 from the customers\nregister or from a picker\'s "new" \u2014 reuses the row it matches and opens one only where nothing does,\nso the book never grows a second Acme.\n\n```json\n{\n "tables": [\n { "ref": "product", "label": "Product", "fields": { "name": { "type": "text", "label": "Name" }, "in_stock": { "type": "number", "label": "In stock" } } },\n {\n "ref": "order",\n "label": "Order",\n "fields": {\n "name": { "type": "text", "label": "Name" },\n "placed_on": { "type": "date", "label": "Placed on" },\n "due_on": { "type": "date", "label": "Due on" },\n "lines": { "type": "link", "label": "Lines", "table": "order_line", "multi": true, "pair": "order" }\n }\n },\n {\n "ref": "order_line",\n "label": "Order line",\n "fields": {\n "name": { "type": "text", "label": "Name" },\n "order": { "type": "link", "label": "Order", "table": "order", "multi": false, "pair": "lines" },\n "quantity": { "type": "number", "label": "Quantity", "min": 1, "max": 9999 },\n "ships_on": { "type": "date", "label": "Ships on", "min": "order.placed_on", "max": "order.due_on" },\n "product": {\n "type": "link",\n "label": "Product",\n "table": "product",\n "multi": false,\n "options_where": {\n "node_type": "group",\n "logic": "and",\n "children": [{ "node_type": "condition", "type": "number", "field_key": "in_stock", "operator": "greater_than", "value": 0 }]\n }\n }\n }\n }\n ]\n}\n```\n\nA line of nothing is not a line: `quantity` is refused on create and on update. A line ships inside\nits order\'s window \u2014 a bound read off the row a link names is judged when the line is written. Nothing is sold off an empty shelf: every picker of `product`\nreads only the rows that answer its `options_where`, and every save refuses the same rows again.\n\n```json\n{\n "tables": [\n {\n "ref": "booking",\n "label": "Booking",\n "fields": {\n "room": { "type": "text", "label": "Room" },\n "state": { "type": "select", "label": "State", "options": [{ "alias": "held", "label": "Held", "color": "blue" }, { "alias": "released", "label": "Released", "color": "gray" }] },\n "starts_on": { "type": "date", "label": "Starts on" },\n "ends_on": { "type": "date", "label": "Ends on", "min": "starts_on" }\n },\n "no_overlap": { "from": "starts_on", "to": "ends_on", "by": ["room"], "while": { "state": ["held"] } }\n }\n ]\n}\n```\n\nOne booking per room at a time, while it is held \u2014 a create or a save whose span overlaps another\nheld booking of the same room is refused.\n\nA table\'s `checks` (the conditions no write of its rows may meet) are stated in its document and hold on every path a record is written by; their keys, what they read and an example are on `workflows/table-checks`. What follows every committed write of its rows is a workflow, written with `set_workflow` (`workflows/table-workflows`).\n\n<!-- generated:start write-rules -->\n\n#### Suggest\n\n| Key | Type | Meaning |\n|---|---|---|\n| `table` | text, required | The table whose text field is offered from: its id, or its `ref` in this call |\n| `field` | alias, required | The alias of that table\'s stored text field; the field\'s control offers, as the reader types, the distinct values it holds, and any text is still written |\n\n#### No overlap\n\n| Key | Type | Meaning |\n|---|---|---|\n| `from` | text, required | The stored date (or datetime), or time of day (a `format: "time"` text field), a row\'s span starts on: `<field alias>` of the row, or `<link alias>.<field alias>` of the one row a one-row link names (a booking line\'s piece held for its booking\'s dates) |\n| `to` | text, required | The stored date (or datetime) a row\'s span ends on, named like `from` and through the same link \u2014 a day it holds, unless `records` names it the day the row `frees`; a moment another row may start at |\n| `by` | list of text (at least one) | Fields two rows share to compete for a span (the same employee, the same room): `<field alias>`, or `<link alias>.<field alias>` of the one row the span is read through. A field holding many values (a multi-select, a link to several rows, several members) competes where two rows share any one; absent, every row |\n| `while` | map of text \u2192 list of alias (at least one) | Only rows at these options of these selects hold their span (running, not closed), the select named like `from` \u2014 `<field alias>` or `<link alias>.<field alias>`; absent, every row |\n\n<!-- generated:end write-rules -->\n\n<!-- generated:start rules-write -->\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `write.natural-key` | A `natural_key` is text or a number a person types back, or a one-row link; a text key is unique \u2014 `unique: true`, or the key\'s fields as a set in the table\'s `unique`. |\n| `write.bounds` | `min` and `max` bound a number, a date or a time of day \u2014 by a constant a number, by a field of this row or of the one row a one-row link names either, of the same type and unit, never by itself \u2014 and `min` is never above `max`. |\n| `write.bound-per-row-unit` | On a figure whose unit or currency is the row\'s own (its notation\'s `per_row`) a constant bound is only 0 \u2014 bound it by a field of the row. |\n| `write.suggest` | `suggest` stands on a stored text field and names a `table` and a `field`, a stored text field of that table; the app reads that table, so it has a `records` entry. |\n| `write.same` | `same` stands on a link and names one-row links, or lookups of one, this table and the link\'s target both hold to one table. |\n| `write.options-where` | `options_where` narrows a link by an `"and"` group of plain conditions over the target\'s own fields \u2014 a number compared in one unit on every row, a select by options it declares. |\n| `write.no-overlap-night` | *Noted, never refused:* `no_overlap` between two times of day reads a span ending at or before its start within its own day: to midnight, then from midnight. |\n| `write.no-overlap-pair` | *Noted, never refused:* A dated table with a link to a person and a link to a resource, and a `no_overlap` by only one of them, lets the other be held twice: name each in a rule, in a list. |\n| `write.no-overlap` | `no_overlap` is a rule, or a list of rules a row must each meet, spanning two date fields or two `format: "time"` fields, the row\'s own or the one row a one-row link names (`booking.start_on`); `by` names values rows share \u2014 a link, a person, a text or a number, an option, a field of the one row the span is read through (`booking.room`), or a field of many values, which competes where two rows share any one; `while` names single selects by their options, the row\'s own or that linked row\'s. |\n\n<!-- generated:end rules-write -->\n\n- A `natural_key` is `text` or `number`, because a person types it back, or a\n one-row link, because a row is also recognised by the one row it belongs with (a\n fee by its visit and its kind). A key holding a `text` field is unique: `unique:\n true` on that field, or the key\'s fields as a set in the table\'s `unique` (a\n site by its customer and its name) \u2014 two rows sharing it would make\n find-or-create pick whichever the read answered first. An add asks the key by\n default.\n- A `same` link names only rows that name what this row names \u2014 a fee\'s invoice\n is one of its own visit\'s \u2014 through a one-row link both tables hold to one\n table; its picker offers nothing until the row names one. A row added under a\n record names what it copies off it (`default_from`) from the start, so a block\n expecting one line per row of the link lists that record\'s rows alone. A save\n of this row moving what the two compare is refused while they would name apart.\n- An `options_where` link may be left empty; a row it names is refused on every\n save that writes the link unless it holds the narrowing, and the refusal names\n the link and the row. A save that leaves the link alone is not judged, so a row\n still naming a row the narrowing no longer admits stays editable. A link naming\n one kind of a book\'s rows (a "Shipping line" among the parties) narrows to that\n kind, or its picker offers every row.\n\nA field\'s own `required` is not here: the field carries it, and every write\npath refuses the row by field name from it. `unique` is the text field\'s own\nclause (`reference/text`) \u2014 an add says so at the control before the column does. A\nfield the workspace writes (a formula, a rollup, a lookup, an autonumber, a date\nwith `derive_from`) is never asked, written or edited.\n\n## App tree\n\nAn app is a tree of components, assembled the way a page is written in JSX: pick a component, bind it to a table by\nname, and it draws well with no props, because its defaults come from the table\'s facts (`reference/records`, `reference/status`,\n`reference/write-rules`, `reference/field`). A prop overrides a default at its own node. No prop says how anything looks: the runtime\ndraws each concept one way, and a screen the job needs that no component states is told to the person \u2014 the job,\nwhat the app drew, the word wanted \u2014 never props bent to approximate it.\n\n**The smallest tree is one root List.** `{ "type": "App", "key": "orders", "name": "Orders", "children": [{ "type": "List", "entity": "order" }] }`\nis a whole app: the platform draws the rest from the tables \u2014 the page every row opens, a Section per stage with its moves\nat the foot, a child List per child, the band of readings, the add and the Delete. Every answer of `set_app` and `get_app`\nshows what it drew (`(default)` among the addresses) and says what it placed or folded in what you stated, so you state only\nthe difference. Lists at the root stand beside one another, two over one entity opening its one page.\n\nEach component is a page of its own: `reference/app-node`, `reference/list-node`, `reference/list-source`, `reference/record-node`, `reference/section-node`,\n`reference/side-node`, `reference/outside-node`, `reference/tab-node`, `reference/sheet-node`, `reference/field-node`, `reference/fieldset-node`, `reference/act-node`, `reference/check-node`,\n`reference/reading-node`, `reference/statement-node`, `reference/export-node`,\n`reference/query-node` and `reference/workflow-node`. Beside them: `reference/changing-an-app` and `reference/what-an-app-may-write`, `reference/layouts`, `reference/time-and-place-layouts` and\n`reference/publish-desk` for a List\'s `layout`, `reference/tasks`, and the rules, `reference/app-rules`,\n`reference/reading-rules`, `reference/statement-rules`, `reference/check-rules`, `reference/list-rules`, `reference/record-rules`, `reference/act-rules` and `reference/template-rules`.\n\n<!-- generated:start app-components -->\n\n| Component | Draws | Holds |\n|---|---|---|\n| [App](#app-node) | the launcher tile, the app\'s words, its Views (Lists and Sheets), and its API | List, Sheet, Query, Workflow, Record |\n| [List](#list-node) | rows of an entity: the register, a record\'s child rows, a roster\'s cells, related rows | Tab, Reading, Export, Act, List |\n| [Record](#record-node) | what a row opens: the head and the parts | Field, Fieldset, Section, Side, Outside, List, Reading, Statement, Act, Check |\n| [Section](#section-node) | a titled part of a record, and optionally a step of its path | Field, Fieldset, List, Reading, Statement, Act, Check |\n| [Side](#side-node) | the part the rest is worked from, beside them | Field, Fieldset, List, Reading, Statement, Act, Check |\n| [Outside](#outside-node) | what one record shows, and which acts it allows, to a person with no seat who opens a link a member made of it | Field, List, Act |\n| [Tab](#tab-node) | one view of a List\'s rows over a period | \u2014 |\n| [Sheet](#sheet-node) | a grid of Readings and Lists over the App\'s rows in its period | Reading, List |\n| [Field](#field-node) | one field: a control, a gallery, prose, a link and its picker, the rows filed under a back-link | \u2014 |\n| [Fieldset](#fieldset-node) | fields of a part read together under a heading of their own | Field |\n| [Act](#act-node) | a verb: what pressing it does | \u2014 |\n| [Check](#check-node) | a formula of the rows that warns, or refuses the writes and acts it names | \u2014 |\n| [Reading](#reading-node) | a number over rows: one figure, its parts, a grid, per period, steps; or a record\'s own figure; with `planned` and `done`, the work against its plan, day by day | \u2014 |\n| [Statement](#statement-node) | a figure built from figures of the record | \u2014 |\n| [Export](#export-node) | a report file of the rows in view | \u2014 |\n| [Query](#query-node) | nothing: a read for agents | \u2014 |\n| [Workflow](#workflow-node) | nothing: a verb for agents | \u2014 |\n\n<!-- generated:end app-components -->\n\n### A node\n\nA node is `{ "type": <Component>, "key"?, ...props, "children"?: [...] }`. `type` names the component, `key` its\nname among its siblings, the other keys its props, `children` the nodes it holds. An unknown prop is refused.\n\n- **Two shorthands, both for Field.** A bare string child is a Field (`"due_date"`); an object with `field` and no\n `type` is a Field with props (`{ "field": "price", "edit": false }`). Both work in every prop that lists fields:\n `create`, a Record\'s `row.subtitle` and `add`, and the `children` of a Record or a part. A column is a field\'s alias, or\n `{ "field", "edit": true }` for the line\'s own control, and takes no other prop.\n- **Fields and options are named by alias**, never by label. A tagged value is an object, never a magic string.\n- **`false` turns a default off at its node:** `"edit": false` makes a field read-only, `"create": false` and\n `"remove": false` take a List\'s add and Delete away, `"readings": false` its band; on a Record, `"row": { "figure": false }`\n drops the row\'s figure, `"row": { "status": { "edit": false } }` the status buttons (another app moves the stage) and\n `"row": { "image": false }` the picture.\n\n### Keys and addresses\n\nA key is unique among its siblings, the way a React key is. A node that binds data takes its key from what it binds:\n\n| Node | Key when none is stated |\n|---|---|\n| Field, Check | its field alias |\n| List | its entity alias |\n| Record | its `entity` alias |\n\nEvery other node states its key. Three kinds of key are unique across the whole app, because each is an API name:\nan Act\'s (its workflow is `act_<key>`, or the one it names), a Reading\'s (its query name for `run_app_query`), and a Query\'s or\nWorkflow\'s.\n\nA node\'s **address** is the path of keys from the app, such as `pages/customer/orders`; the app itself is `/` (the `in` of a node at the root), and its own key is part of no address. A patch may use any ending\nof that path that names exactly one node (`orders`). The exact path wins where one exists; an ending naming two\nnodes is refused, and the refusal lists both paths. `get_app` prints the tree with each node\'s address.\n\n### Values\n\n| Value | Written |\n|---|---|\n| now, the reader, an asked input | `{ "now": true }`, `{ "me": true }`, `{ "input": "name" }` |\n| a computed value | `{ "formula": "{cost} * 1.2" }` over the acted row\'s fields |\n| a call\'s own value, in a Query | `{ "param": "name" }` |\n| cleared | `null` in an Act\'s `set` |\n| an option | its alias |\n\nA **condition** (`when`) maps a select to a list of its option aliases and a yes/no to `true` or `false`; every entry\nholds. A number (a number, currency or percent field, or a formula or rollup yielding one) takes a comparison with any\nof `gt`, `gte`, `lt`, `lte` (at least one, never both `gt` and `gte` or both `lt` and `lte`), each a number; a date\ntakes the same keys with a day (`"2026-03-01"`), a moment on a datetime (`"2026-03-01T09:30"`) or `{ "now": true }`\n\u2014 today, or the current minute on a datetime, read when the rows are, so overdue is `{ "due_on": { "lt": { "now": true } } }`;\nand any field but a yes/no takes `{ "empty": true }` or `{ "empty": false }`. A comparison on a field it does not fit is\nrefused, naming the field, its type and what it takes. A `when` on an Act, a Section or other block, and a List\'s `where`\n(the register\'s or a child List\'s) take these; a child List that adds, picks or expects rows refuses a comparison in its\n`where`, since a row it holds could stand outside it. A **narrowing** (`opens`, a Reading\'s, a Tab\'s or an Export\'s `where`) takes these and also `{ "me": true }` on a member\nfield or a lookup of one, the reader; `where` on a root List or a record\'s child rows fixes the rows on the server for every reader, so it refuses\n`{ "me": true }` \u2014 open on it with `opens`; on a record\'s related rows (`same`, `app`) and on a Sheet\'s List it\nnarrows by the reader and takes it, and those two take no comparison.\n\n## Changing an app\n\n1. `get_workspace` with `kind: "app"` names the app. `get_app` prints the `tree:`, the `node addresses:` (the address of\n each node the app draws, `(default)` on those the tree leaves to the platform) and the `version` line, whose id is the `base_version_id` to send. A member who is not the\n app\'s author is shown no tree. Keep the tree: no tool reads an earlier one.\n2. `set_app` with `app_id`, `base_version_id` (that version: a newer write is refused, not overwritten) and `nodes`,\n (a refused change writes nothing, so `dry_run` is for reading the permissions it would grant and remove). Every answer\n states the permissions the change grants and removes.\n3. `screenshot_app` shows the result.\n\n`nodes` maps an address to a patch of that node. Read against the customers List and page of the account review (`reference/a-complete-workspace`), the call below makes `tier` read-only, moves the Orders Section ahead of Account, adds an Act to\nAccount and removes the Reading:\n\n```json\n{\n "type": "App",\n "key": "account_review",\n "name": "Account review",\n "children": [{ "type": "List", "entity": "customer", "children": [{ "type": "Reading", "key": "ordered_by_tier", "by": "tier", "value": "total_ordered" }] }],\n "pages": [\n {\n "type": "Record",\n "entity": "customer",\n "children": [\n { "type": "Section", "key": "account", "title": "Account", "children": ["tier"] },\n { "type": "Section", "key": "orders", "title": "Orders", "children": [{ "type": "List", "entity": "order" }] }\n ]\n }\n ]\n}\n```\n\n```json\n{\n "app_id": "<id of the app>",\n "base_version_id": "<current_version_id>",\n "nodes": {\n "tier": { "edit": false },\n "orders": { "before": "account" },\n "mark_gold": { "type": "Act", "in": "account", "label": "Make gold", "when": { "tier": ["standard"] }, "set": { "tier": "gold" } },\n "ordered_by_tier": null\n }\n}\n```\n\nEach entry applies in order:\n\n- **An existing node:** a JSON merge patch (RFC 7396) of its props; `null` drops a prop, and a list (`children`,\n `columns`) replaces the node\'s whole, as `layout` does: a patch states the whole layout.\n- **`null`:** removes the node and everything under it.\n- **An address naming no node, with `type`:** adds a node into the node its path names (`"pages/<entity>": { "type":\n "Record", \u2026 }` adds a Record page), or, for a bare key, into the node `in` names (`/` the app); its key is the\n address\'s last word, and a Field states `field` in place of `type`.\n- **`in`, `before`, `after`:** move a node into another, or ahead of or behind a sibling.\n\nThe app\'s own props (`name`, `description`, `icon`, `color`, `words`, `scope`, `period`) change\nthrough `body`, a merge patch over the App node. `dry_run` checks a change and writes nothing.\n\n| To change | State |\n|---|---|\n| a field read-only | `"edit": false` on its Field, or on the Section, Side or Record that draws it |\n| a column added or dropped | `columns` of the List, every column kept: a List that never stated `columns` draws none beyond the row\'s title and its `records` line |\n| a button | an Act node (`reference/act-node`); `confirm` makes its press ask first |\n| a label | the table\'s field `label` in `set_tables`, for every app; for this app alone, `body: { "words": { "<table>": { "fields": { "fee": "Consultation" }, "options": { "urgency": { "rush": "Same day" } } } } }`; a List\'s `label`, a Section\'s `title`, an Act\'s `label`, `add_label` on the add. A Field\'s `label` heads only a gallery or prose block |\n| the order of nodes and rows | `before` or `after` a sibling, or `in` another parent, in the node\'s entry (a Section ahead of another, a Field ahead of another in its Section); a List\'s `columns` read in the order stated; its rows read in its `sort`: `{ "sort": { "field": "collected_on", "desc": true } }` |\n| the row\'s second line | `row: { "subtitle": ["mechanic"] }` on the List: up to two fields under the title, in place of the table\'s `records` line, which stays as it is |\n| a picker\'s add | `add` on the linked table\'s page: `{ "type": "Record", "entity": "pet", "add": ["species", "microchip"] }` asks those fields of the new row; absent, the picker only picks. It holds in every picker of that table in the app |\n| a linked row fixed or deleted where its link stands | the linked table\'s page in `pages`: the link\'s card opens the row in the drawer as that page draws it, saving what it writes, with a Delete where it states `remove: true`. A table a List of the app draws is worked in that List |\n| a headline figure | a Reading in the List: `{ "type": "Reading", "in": "orders", "label": "Prepaid owed", "value": "prepaid", "where": { "stage": ["awaiting_payment"] } }` sums the rows in view; without a `value` it counts them |\n| a calendar and its date | `layout: { "calendar": { "date": "pickup_on" } }` on the List, with `end` for the date a row runs to (both days or both moments); the bare `"calendar"` takes them from the rows\' facts and is refused, naming `date`, where those name none |\n| a record\'s child lines | a List inside the Record\'s Section over the child table: `{ "type": "List", "in": "details", "entity": "repair_line" }`; the child table (one link back to the record) and the record\'s rollup over its rows come from `set_tables` first. Lines priced off a book: `docs path="design/treatments/moves-and-numbers/priced-lines"` |\n\n**A node the tree leaves to the platform has an address too.** `get_app` lists the nodes the app draws, those the stored\ntree does not state marked `(default)`: the Record with its Sections and Fields, the status buttons, the band of readings.\nPatch one by its address and the call states it first: the nearest node the tree does state gains the default child that\nleads to it, as drawn (the whole page in `pages` for an entity that states none, with its `row` picture, and the List\'s `columns` the\ndefaults added; every Section of a Record that states no part; every status button of the app, each in the Section of its\nstage; every reading of the band, since stating one stands the others down), then the patch applies. Defaults\noutside that subtree stay defaults, and the answer\'s notes say what was stated. Removing every reading, or every status\nbutton, is refused: a set no node states is drawn again by the platform, and only `readings: false` on the List or\n`row.status: { "edit": false }` on the Record draws none. **A stated subtree stays as it is**: a\nfield or option the tables gain later is not added to it, so name it in the tree. `{ "due_date": { "edit": false } }`\nover a sparse tree makes that field read-only and takes away `saves <table>: due_date` alone. An address that ends several\ndrawn nodes is refused, as for stated ones.\n\n**A write places what has one fix, and says so.** The stored tree is the placed one, `get_app` shows it, and the answer lists\neach placement at its address, so you read the difference instead of meeting a refusal:\n\n- `where: { "<field>": { "me": true } }` on a root List moves to `opens`, the chip that names the reader. A child List\n keeps the refusal: bound access with a row rule, or list the rows in a root List.\n- A read-only repeat of a field across a record\'s steps, or a Field beside the files or text block that draws it, is left\n out and said; the statement stays in the tree.\n- `door` on the page of an entity no root List and no Sheet\'s List is over, where the page states no Side, is\n not drawn and is said: its rows open in place. It stays stated, and applies once one of those or a root List does.\n\n## What an app may write\n\nAn app states no list of what it writes: the tree derives it, and the generated workflows accept exactly that, so it is\nalso what an agent can do through the app\'s API. `get_app` prints it beside the tree.\n\n1. **A save of field `f` of table `E`** exists when a node draws `f` on a page of `E`\'s rows (a Field in a Record,\n Section or Side, or a part of the head), the table lets a person write it (stored; not computed, stamped or the\n back side of a child\'s link), no Act of the app on `E`\'s rows writes it, and neither the node nor a container above it\n says `edit: false`. A row\'s stage is moved by an Act or the one button per move a status no Act moves gets, by hand only where its Record\'s `row.status` says `{ "edit": true }`, and by none where it says `{ "edit": false }`.\n2. **An add of `E`** exists for a List over `E` that writes its rows unless it says `create: false` (asking what it lists, and\n setting the link back to the record itself), and for every picker of `E` where `E`\'s page states `add`. An absent `create`\n stands down where the table states no `singular` (nor the app\'s `words`), or where `where` keeps a select at an option an\n Act sets other than the one a new row starts at; a stated `create` list over such a table is refused. A roster\'s cells and\n a document are added only where `create: true`.\n3. **A Delete of `E`** exists for a List over `E` unless it says `remove: false`, and for the table of each of that\n List\'s `sources` (a source has no `remove` of its own). A roster\'s cells, a document and a desk\'s rows are deleted only where `remove: true`.\n A Delete comes with `restore_<entity>`, which brings the row back with the rows its delete took, all or none.\n `remove: false` takes this app\'s Delete away and no more: the record tools, the API and other apps still delete. A row no\n surface may delete is a table check with `on: ["delete"]`.\n4. **An act** exists for each Act node. Every field it sets, asks, files into, signs or records is the act\'s, and read-only\n everywhere else in the app.\n5. **The table\'s contract holds on every path** and is not restated here: required, unique, no overlap, field rules, table\n checks, stage owners, history and the read scope. (`natural_key` is read by an app\'s add and find-or-create alone.)\n\nDrawing is reading or saving; a List that writes its rows also adds and deletes them, until it says `create: false` or `remove: false`, and a List below a part or a Record that says `edit: false` writes, adds and deletes none.\n\n### What a table gives a component\n\n| Table fact | Feeds |\n|---|---|\n| The title | every row\'s name: Lists, a Record\'s head, link chips, pickers, an add |\n| The row\'s line (`records` subtitle, figure, image, mark, party, description) | the row\'s line and head, cards, a checklist\'s photo |\n| The stage (`records` status) | the stage chips, a List\'s `opens`, the badge, an Act\'s moves, stage owners gating acts, a Section\'s `at` |\n| Deadlines (`records` due, settled, frees) | countdowns and overdue marks, the default sort, attention order, spans on lanes, calendars and rosters |\n| Bounds (`records` limits, gates, tolerance) | the figure\'s meter, wherever it stands |\n| Tasks and cadence (`records` task, cadence) | the ring on task rows, a roster\'s owed days |\n| Applicability and starts (`records` applies, starts) | a field shown and asked only where it applies; an add\'s starting values |\n| A field\'s `required`, `default`, `default_from`, `natural_key`, `unique` | what an add asks, and what it starts at |\n| A field\'s `notation`, `format`, options, `options_where` | money, units, chips, and what a picker offers |\n| The table\'s `read_scope` | which rows each reader reads, in every List |\n\n### Where the rules stand\n\n`reference/app-rules` and the rule pages after it are every rule the check holds over an app, by id, whichever component it concerns. A\n**language** is decided by the app\'s own words: a tree names no locale, so what an app draws itself (its buttons, empty\nstates, refusals) is in the language its labels are written in, and `words` count as labels. Mix two languages in one\napp and it answers in two.\n\n## App node\n\nAn app draws its launcher tile, its words, its Views and its API. It binds the tables it names: `set_app` fills\n`tables` with the id of every table alias the tree uses, and `templates` with that of every document template alias.\nA relabel on either side is a rename and no tree points at another table by accident.\n\n<!-- generated:start node-app -->\n\n| Key | Type | Meaning |\n|---|---|---|\n| `key` | alias, required | The app\'s alias, its name among apps; the App node is addressed `/`, and no address in it starts with this key |\n| `name` | text, required | The job, in the words of the people who do it |\n| `description` | text | What the job is for, in a sentence |\n| `icon` | text | A Lucide icon name in kebab-case the launcher tile draws |\n| `color` | [colour](#select) | The launcher tile\'s colour |\n| `words` | map of alias \u2192 [Table labels](#table-labels) | A table \u2192 the words this app draws for it |\n| `scope` | alias | The table whose one row the app works inside \u2014 the folder: every List over a table holding a one-row link to it lists the open folder\'s rows and files each add under it; absent, the app reads every row |\n| `folders` | alias | The key of a root List over the table `scope` names: it draws the folders the app opens on \u2014 its columns, filters, grouping, order and summary \u2014 and a row pressed is the folder entered; absent, the folders are listed by their anatomy |\n| `rows` | map of alias \u2192 [Read scope rule](#read-scope-rule) | Each table\'s row rule in this app, by its alias (a table the app only reaches, by the table\'s own alias): who of the people the app is shared with reads which rows, on its screens, its queries, its writes and its workflows. A table the app states none of is read whole by everyone it is shared with |\n| `uses` | list of alias (at least one) | Tables the app\'s Query and Workflow nodes read without drawing them, by alias: they join the tables the app reaches, so a workflow may name them |\n| `period` | `"today"` \\| `"week"` \\| `"month"` \\| `"quarter"` \\| `"year"` \\| [Period days](#period-days) | The window every Sheet opens on: "month", "quarter", "year" or { "days": 30 }; absent, the calendar month |\n| `tables` | map of alias \u2192 text | The id of each table the tree names, by its alias: filled by set_app, never written |\n| `templates` | map of alias \u2192 text | The id of each document template the tree names, by its alias: filled by set_app, never written |\n| `children` | list of ([List](#list-node) \\| [Sheet](#sheet-node) \\| [Query](#query-node) \\| [Workflow](#workflow-node)) (at least one) | The App\'s Views in order \u2014 Lists and Sheets, the first where the App opens \u2014 and its Queries and Workflows. Queries and Workflows alone: an API app, which a server calls with an app key |\n| `pages` | list of [Record](#record-node) (at least one) | The page the rows of an entity open, one per entity, each a Record stating its `entity`; every List over the entity, anywhere in the App, opens it, and a link\'s row no List lists. Absent, the platform draws the page |\n\n#### Table labels\n\n| Key | Type | Meaning |\n|---|---|---|\n| `label` | text | The table\'s name in the plural (a register\'s heading, a block\'s, a link\'s picker) |\n| `singular` | text | One row of the table, as the add and empty sentences name it |\n| `fields` | map of alias \u2192 text | A field alias \u2192 the words this app draws wherever it names the field; the table\'s field keeps its own label |\n| `options` | map of alias \u2192 map of alias \u2192 text | A select field alias \u2192 option alias \u2192 its words |\n\n<!-- generated:end node-app -->\n\n- **Every View at the root is a peer**: a List or a Sheet, in the order stated, the first where the App opens and the\n others each one entry of the App\'s lists, picked under its title, each at its own address: the first at the app\'s root (`/`), any other at `/<key>`, inside the folder where the App is scoped. A List states\n its `label`, any layout, its own Tabs, Readings and Exports, and may read `sources`; two may stand over one entity, and\n both open its one page. Whoever the app is shared with is shown every View, each table narrowed by the App\'s `rows`.\n A list people work every day as a desk of their own is another app.\n- **A Sheet** draws Readings and read-only Lists over the App\'s rows. The App\'s one `period` windows every reading of\n its Sheets placed in time: the calendar month by default, or `quarter`, `year` or `{ "days": 30 }`. An App of Sheets alone\n draws the pages its Sheets\' Lists open (a List naming no `app`), each from `pages` as any page is. A Sheet\'s List\n naming no `app` opens its row\'s page in this app, in the drawer over the Sheet, at `/<sheet key>/<row>`.\n- **Query and Workflow** nodes stand at the root and are never drawn.\n- **Writes:** nothing itself.\n\n## List node\n\nA List draws rows of one table. What its rows are depends on where it stands:\n\n- at the App root: a register, a View of its own among the App\'s;\n- under a Record, Section or Side: the record\'s child rows, filed through the child\'s one link to the record\n (`via` where it has several);\n- under a roster List: the rows that fill the roster\'s cells;\n- with `same` or `app`, or on a Sheet: related rows, read only.\n\nA List below a row\'s page is a View too: it takes Tabs, Readings and Exports as a root List does, and its rows open at\n`/<view>/<row>/<key>`, drawn alone with its band, its way back the row\'s page. An Export of it is the file of that one\nrow\'s rows.\n\n<!-- generated:start node-list -->\n\n| Key | Type | Meaning |\n|---|---|---|\n| `key` | alias | Names the List among its siblings and in a Query\'s `list`; absent, the entity alias |\n| `entity` | alias, required | The table whose rows the List draws |\n| `sources` | list of [List source](#list-source) (at least one) | Further tables read as one List with this entity |\n| `source_column` | `false` | Reads a List\'s tables as one: false, no column naming each row\'s table and no filter by it; absent, a List with `sources` draws both |\n| `scope` | alias | Says which folder a row files in: with the App\'s `scope`, the one-row link, where the table holds several |\n| `via` | alias \\| text | The child\'s link to the record, where it has several; a List that only reads may state `<link>.<link>`, reaching the record through a row of their own |\n| `same` | alias | A one-row link of the record: the rows sharing its row, the record left out, read only |\n| `where` | [narrowing](#app-tree) | A fixed narrowing on the server, for every reader: a condition (`reference/values`), and `<link>.<field>`, the rows whose one-row link names a row holding a select or yes/no so. A List that only reads (`same`, a Record with `edit: false`) also bounds a date or number by a field of the record, `{ "record": "<field>" }`: blank, it keeps no row; an Act\'s paper naming the List is handed the same rows; it is never an access bound, which the table\'s row rules are. An add holds only a select\'s option and a yes/no\'s value |\n| `expect` | alias \\| [Expect](#expect) | What a record should hold, shown before it does: one line per option of this select, or per row of this catalog link |\n| `under` | alias | Groups lines by the document covering them: a one-row link to it |\n| `covers` | integer | With a roster\'s cells over days: how many rows each day needs across every lane; a day holding fewer is marked Uncovered. Absent, no day is expected to hold any |\n| `edit` | `false` | Shows rows nobody changes here: false, this List only reads them |\n| `label` | text | The register\'s name in the app\'s lists and tab strip; absent, the entity\'s label. Never the noun of its rows, which is the table\'s label and singular (this app\'s `words`) |\n| `columns` | list of (alias \\| [Edit column](#edit-column)) | Fields read after the row\'s title, each drawn though no row holds it; `{ field, edit: true }` is the line\'s own control, at most 2. Absent: the title and the `records` line alone |\n| `filters` | list of (alias \\| [Tiered filter](#tiered-filter) \\| [Listed filter](#listed-filter)) (at most 3) | Fields the reader narrows by every day, beside the stage chips: a select, member, link, date, yes/no or number range of a field its rows draw (a column, the title, the line), never one drawn nowhere; a Reading\'s narrowing names the same; `tiers` bands a number or date; `values` states which values a pick lists |\n| `search` | list of alias (at least one) \\| `false` | Fields the search box reads; absent, every word of the row; false, no search box |\n| `group` | alias \\| `false` | A field the rows stand grouped by, a gantt drawing the groups as its lanes; absent, the reader may group by a filter\'s field; false, no grouping |\n| `sort` | [Sort key](#sort-key) \\| list of [Sort key](#sort-key) (at least one) | The rows\' order; absent, a register reads newest made first, a record\'s rows as added |\n| `opens` | [narrowing](#app-tree) | The view the register opens on, a chip the reader may take away: `where`\'s entries but a record bound, and `{ "me": true }` on a member field or a lookup of one |\n| `period` | `"today"` \\| `"week"` \\| `"month"` \\| `"quarter"` \\| `"year"` \\| [Period days](#period-days) | The window a table\'s or cards\' dated Tabs read, or the day, week or month a calendar or lanes board opens on; absent, this month |\n| `chips` | `false` | The line\'s one chip row, the stage chips: false, none \u2014 the List then holds every row at every stage, and a filter on the status picks among its options |\n| `checks` | `false` | The filter picking among the Checks its rows hold, each with how many hold it: false, none |\n| `attention` | `false` | Keeps a list in its own order: false, the sort menu offers no attention-first order |\n| `readings` | `false` | Leaves a list without figures above it: false, no band; absent, rows that move, fall due or carry money lead with one. Never with Readings stated |\n| `layout` | [layout](#layouts) | A word, or an object stating one layout with its data; absent, a table |\n| `beside` | `true` | Keeps the list in view while a row is worked: true, a row pressed opens beside this table; a root List drawn as a table. Absent, the page\'s `door` |\n| `compare` | [Compare](#compare) | Each row\'s before against its after: two files fields as a pair of photos, or two values of one type as one column |\n| `current` | alias | A child List of revisions: the child\'s date or number field ordering them. The latest reads as current, the others fold under "superseded \xB7 N"; the record shows the current file through a lookup of the child ordered by it |\n| `create` | boolean \\| list of alias (at least one) | The fields an add asks; `false`: rows are not added here. Absent: where this List writes its rows, the table\'s required fields, natural key and title; nothing where the table states no `singular` (nor the app\'s `words`), or `where` keeps a select at an option an Act sets other than the one a new row starts at. A roster\'s cells and a document add only where `true` |\n| `add_label` | text | The add button\'s words; absent, the platform\'s word and the singular |\n| `remove` | boolean | Rows offer a Delete. Absent: where this List writes its rows; `false`: this app\'s Delete alone is gone, and a row no surface may delete is a table check with `on: ["delete"]`. A roster\'s cells, a document and a desk\'s rows delete only where `true` |\n| `pick` | `true` | Also picks rows of the child that no record holds yet |\n| `when` | [condition](#app-tree) | Drawn only while this holds |\n| `children` | list of ([Tab](#tab-node) \\| [Reading](#reading-node) \\| [Export](#export-node) \\| [Act](#act-node) \\| [List](#list-node)) (at least one) | Its Tabs, band Readings, Exports and Acts over ticked rows or every row in view; under a roster the List of its cells, with `under` the List of its documents. An Act on one row and every Check stand in `pages/<entity>` |\n\n#### Edit column\n\n| Key | Type | Meaning |\n|---|---|---|\n| `field` | alias, required | The column\'s field |\n| `edit` | `true`, required | Lets a person change the value on the line: true, its own control, written in place |\n\n#### Expect\n\n| Key | Type | Meaning |\n|---|---|---|\n| `field` | alias, required | The child\'s title, one row per value: a single select or a one-row link to a catalog |\n| `of` | alias | Lets each record choose its lines: with a select, the record\'s own multi-select naming the options it expects, in place of every option |\n| `only` | list of alias (at least one) | Holds lines for some options alone: with a select, those options; never with `of` |\n\n#### Compare\n\n| Key | Type | Meaning |\n|---|---|---|\n| `before` | alias, required | The rows\' field holding what stood before: files, text, a number, a date or a single select |\n| `after` | alias, required | A field of the same type holding what stands after |\n| `edit` | `true` | The after is written on the line |\n\n#### Tiered filter\n\n| Key | Type | Meaning |\n|---|---|---|\n| `field` | alias, required | A number \u2014 stored, or a formula or rollup reading one \u2014 in one unit for every row |\n| `tiers` | list of number (at least one), required | The breakpoints between its bands, ascending, in the field\'s stored unit: under the first, from each to the next, from the last up \u2014 each band worded in the field\'s notation; a filter picks several at once |\n\n#### Listed filter\n\n| Key | Type | Meaning |\n|---|---|---|\n| `field` | alias, required | A select, member or link field |\n| `values` | `"all"` \\| `"held"`, required | The values its menu lists: all, every option, person or linked row, those no row holds at 0; held, only those the rows hold. A bare field lists a select\'s every option, a member\'s or link\'s held |\n\n#### Sort key\n\n| Key | Type | Meaning |\n|---|---|---|\n| `field` | alias, required | The field rows are ordered by |\n| `desc` | boolean | Latest or largest first; absent or false, soonest or smallest first |\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `list.scope` | With the App\'s `scope`, a List over a table holding one one-row link to the folder\'s table is filed in the open folder by it, and one holding several names it in `scope`; that link is required. A List over the folder\'s own table states no `scope`. |\n| `list.unscoped` | *Noted, never refused:* In an App that states `scope`, a List over a table holding no one-row link to the folder\'s table lists every row, in every folder; so does a Tab\'s totals over a child holding no single link to it. |\n\n<!-- generated:end node-list -->\n\nA List takes only the props its place lists:\n\n<!-- generated:start list-places -->\n\n| A List standing in | Takes |\n|---|---|\n| every List | `key`, `entity` |\n| every List on a record | `via`, `label`, `when`, `filters`, `search`, `group`, `sort`, `chips`, `checks`, `opens`, `period`, `attention`, `readings` |\n| a root List (the first is the register) | `label`, `columns`, `filters`, `search`, `group`, `sort`, `chips`, `checks`, `opens`, `period`, `attention`, `layout`, `beside`, `create`, `add_label`, `remove`, `readings`, `where`, `edit`, `sources`, `source_column`, `scope` |\n| a record\'s child rows, as a table, a checklist, a desk or a gantt (which refuses `under`, `pick`, `compare`, `current`, `expect` and an `edit: true` column) | `columns`, `create`, `add_label`, `where`, `under`, `remove`, `pick`, `layout`, `compare`, `current`, `expect` |\n| a record\'s child rows with `layout` an agenda | `columns`, `create`, `add_label`, `remove`, `layout`, `edit` |\n| a record\'s child rows with `layout` `"timeline"` | `create`, `add_label`, `remove`, `layout`, `edit` |\n| a record\'s related rows, read only (`same`, or a Record that is `edit: false`) | `where`, `columns`, `same`, `edit` |\n| the documents a child List\'s lines stand under (`under`), a List inside it | `create`, `remove` |\n| the cells of a roster, a List inside it | `expect`, `covers`, `create`, `remove` |\n| a Sheet\'s list, read only | `label`, `where`, `columns`, `sort` |\n\n<!-- generated:end list-places -->\n\n- **The page a child List\'s rows open** is the entity\'s page in `pages`: its Fields in stated order, those the rows\' saves write editable, and the List\'s `columns` are the line. A row opens in place under itself: its fields or Sections, then each List of its own children, at any depth; one row is open at a time. Every row of a List that adds rows offers "Duplicate" in its \u22EF: the add opens with the row\'s values of the List\'s `create` fields, filed under the row\'s own parent (in an outline, the row above it), never carrying a status, a computed value or files. With `edit: false` the List reads as a related-rows List does.\n- **Documents:** in a child List with `under`, a List over the document\'s table (`key`, `entity`, `create`, `remove`,\n Acts and Checks; the document\'s Fields and Lists stand in its page) is the one place the documents are added or deleted;\n `create` states `true`, and `remove` needs `create: true` beside it.\n- **Writes:** a layout move (a gantt bar, a lane\'s block, a plan\'s item) writes only fields the app already writes on the row\'s page.\n- **`create` asks:** `true` asks the title, the natural key and every required field a person writes, never a computed\n or stamped field or the link the place sets. An `expect` list also asks the key it makes its lines by, and their picture.\n- **`filters`:** a threshold the business names ("large orders") is a formula yes/no, and bands it names (new, warm, cold) a formula with options, never a range.\n- **`opens`** absent, the register opens on the open work (rows not at a `closed` stage).\n- **`expect`:** an empty line adds its row (a checklist of papers per case).\n\n## List source\n\nSources are further tables a root List reads beside its entity as one List: the same job kept in tables of their own (a legacy ledger, a second branch\'s register). Each is projected onto the List\'s fields \u2014 by alias, else by its `fields` (the List\'s field \u2192 the source\'s) \u2014 and options line up by alias; its `where` narrows its own rows. Each row opens its own table\'s page in `pages`, stated or refused (`list.source-page`), and runs the Acts and Checks that page states: nothing the List offers its own rows reaches a source\'s. The add offers each table, asking the List\'s `create` in that table\'s fields; a source lacking one adds no row. A column naming each row\'s table, and a filter by it, draw by default; `source_column: false` hides both. Every source holds the title and the scope, and may hold no stage (its rows wear none and stand in no stage chip); its `columns` name value fields of its own table (not links or files) drawn on its rows alone, on a lanes board only; a table, cards, lanes or a plan reads sources, and an Export\'s `sources` makes a report of some of them.\n\n<!-- generated:start node-list-source -->\n\n| Key | Type | Meaning |\n|---|---|---|\n| `entity` | alias, required | A further table this List reads beside its own entity: the same job over its rows |\n| `fields` | map of alias \u2192 alias | A field of the List\'s entity \u2192 this table\'s field holding the same fact, where their aliases differ |\n| `where` | [narrowing](#app-tree) | Which of this table\'s rows the List reads |\n| `columns` | list of alias (at least one) | Fields of this table with no counterpart in the List\'s entity, drawn on this table\'s rows alone |\n| `row` | [List source row](#list-source-row) | How the List reads this table\'s rows, where it differs from the table\'s `records` |\n\n#### List source row\n\n| Key | Type | Meaning |\n|---|---|---|\n| `status` | `{ "edit": true }` | Lets a person move this table\'s stage by hand in the List: `{ edit: true }` |\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `list.sources` | A List\'s `sources` each name another entity once (`entity`) \u2014 never the List\'s own \u2014 whose fields line up with the List\'s by alias, else by `fields` (a field the List reads, or one an Export prints \u2192 one of the source\'s): read as one column type (a day apart from a moment), one value or several alike, a link to the same entity. Each source holds the title, the List\'s folder link and what `where` keeps; it may hold no status \u2014 its rows wear none and stand in no status chip, only the total\'s. Its `columns` name fields of its own table that no List field stands for, drawn on its rows alone and only on a lanes board \u2014 a text, number, date, select or yes/no field, or a lookup of those, never a link or files; an alias a List field or another source\'s column holds is refused; its own `records` status stays its page\'s; the List is a table, cards, lanes or a plan, whose `at`, `across` and `up`, or lanes\' `by` and loads, line up like any field. Two sources holding a field of their own under one alias hold it as one kind of value. An Export\'s `sources` each name the List\'s entity or one of its sources, once, and one of them holds each field its `where` and `per` narrow by. A List with `sources` draws a column naming each row\'s table, and a filter by it; `source_column: false` draws neither. A source\'s rows open the page of its own entity, which states the Acts and Checks they run: each Act\'s `key` its own among the App\'s Acts. |\n| `list.source-lacks` | *Noted, never refused:* A source lacking a field its List\'s `create` asks adds no row; one lacking the select its List\'s plan marks or sizes by never marks or sizes its rows. A field only an Export prints, held by a source as another kind of value, prints blank on its rows. A Tab\'s `totals` over a child linking to no row of a source total nothing on its rows. |\n| `list.source-option-kin` | *Noted, never refused:* A source\'s option labelled as one of the List\'s, under another alias, reads apart from it: the List lists both and counts each on its own. |\n\n<!-- generated:end node-list-source -->\n\n## Layouts\n\nA List\'s `layout` is how it draws its rows: a word (`"table"`, `"cards"`, `"calendar"`, `"roster"`, `"timeline"`) or an\nobject stating one layout and the data it reads (`{ "gantt": \u2026 }`, `{ "lanes": \u2026 }`, `{ "plan": \u2026 }`, `{ "agenda": \u2026 }`,\n`{ "checklist": \u2026 }`, `{ "desk": \u2026 }`). Absent, a table: the word `"table"` is the register\'s, and a child List states a\nchecklist, a desk, a gantt, an agenda or `"timeline"`, else leaves `layout` out. Each layout reads what the rows already state \u2014 their\n`records` line, stage and dates \u2014 and the keys a layout adds stand on its section: here for an agenda and a checklist, `reference/time-and-place-layouts` for the rest, `reference/publish-desk` for a desk. Which one a job needs: the\n`design` reference. The register lays out as a table, cards, a calendar, a roster, a gantt, lanes or a plan; a record\'s\nchild rows as a table, a checklist, a desk, a gantt, an agenda or a timeline.\n\n### Table\n\n<!-- generated:start layout-doc-table -->\n\nAbsent `layout`, each row is one line: the table\'s `records` entry \u2014 its picture or mark, title and the line under it \u2014\nthen the stage, the `columns`, and the figure at the right; the title, the stage and a column of days or amounts sort\nthe rows by their header. A table groups its rows by `group`; a table or cards reads `Tab`s and the `sources` of its List.\n\n<!-- generated:end layout-doc-table -->\n\n### Cards\n\n<!-- generated:start layout-doc-cards -->\n\n`"cards"` draws each row as a card led by its picture \u2014 the `records` `image`, or the List\'s `row.image`: its title and\nthe line under it, its stage and what needs the reader (a deadline, a warning), then its figure and the `columns` at its\nfoot. Cards are for rows found by their picture (a product, a vehicle, a damage photo); rows with no picture read better\nas a table.\n\n<!-- generated:end layout-doc-cards -->\n\n### Calendar\n\n<!-- generated:start layout-doc-calendar -->\n\n`"calendar"` or `{ "calendar": { "date": "starts_at", "end": "ends_at" } }` places each row on its day \u2014 a month, a week,\na day or a list (a phone reads the list or a day): at its hour where `date` holds one, over its span where `end` names\nthe date it runs to, with its line\'s other words and the `columns` after its title. `date` and `end` are two dates of\nthe row, both days or both moments; a span of moments gives a phone its day view, and a day\'s `end` is the last day held\n(unless `records` names it the day the row `frees`). The bare word takes them from the rows\' facts: two dates a person\nstates, the second ordered after the first by a `min` or a table check, both required or the second the row\'s `due`; else the one required date a person states that no Act stamps and a new row does not start at today \u2014 and is refused, naming `date`, where the rows hold neither. A `due` is a deadline, never the day a row is held on. The calendar reads the window in view, and its count and the stage chips count that window, opening on every row.\n\n<!-- generated:end layout-doc-calendar -->\n\n<!-- generated:start layout-calendar -->\n\n#### Calendar keys\n\n| Key | Type | Meaning |\n|---|---|---|\n| `date` | alias, required | The date or moment of this entity each row stands on: a viewing\'s start, a hire\'s first day, a visit\'s day |\n| `end` | alias | The date or moment each row\'s span ends on, read as `date` is \u2014 two days or two moments (a moment\'s end gives a phone its day view); absent, a row stands on `date` alone |\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `list.calendar` | `layout: "calendar"` or `{ calendar: { date, end } }`: two dates of the row, both days or both moments; bare, it takes the rows\' span or appointment, else is refused, naming `date`. |\n\n<!-- generated:end layout-calendar -->\n\n### Roster\n\n<!-- generated:start layout-doc-roster -->\n\n`"roster"` draws the List\'s rows down the side and the days of a week or a month across; the roster\'s cells are a List\ninside it over the table whose rows fill the days \u2014 each stands on one row by its single link to it, and on the first\ndate of its line (a shift on a person\'s day, a run on a vehicle\'s), on every day through the second date where its line\nholds one. A cell reads its row\'s stage, else the first single select on its line (a shift\'s kind), several rows their\ncount. A day holding none stays empty: nothing was due, which is never an absence. A filled cell opens its row; an empty\none adds a row there, the register row and the day set. With `expect` on the cells (a single select of those rows) the\ncolumns are its options in place of days \u2014 a checklist of papers \u2014 and `of` names the ones each row expects: a gap among\nthem reads as one and adds its row, the others stand blank, and each row reads what it holds of them, `2/3`. Over days, a\nroster reads the `cadence` its table\'s `records` states (a site\'s diary page, Monday to Saturday from breaking ground to\nhandover): a past day owed with none is marked missing and counted, and each row reads the days it holds of those owed. A\nroster states no `columns` and needs no readings: its legend counts each state in view. `covers: 2` on the cells List says each day\nneeds two rows across every lane: a day holding fewer is marked "Uncovered" in its head, counted in the legend, and the\nExport\'s `columns` carry `covered` (false on such a day) for every day of the window.\n\n<!-- generated:end layout-doc-roster -->\n\n```json\n{ "type": "List", "entity": "operator", "layout": "roster", "filters": ["depot"], "children": [{ "type": "List", "entity": "run" }] }\n```\n\n### Timeline\n\n`"timeline"` reads a record\'s child rows as a log of dated entries, newest first, with a composer where the app adds\nentries, each corrected and removed where it stands. It is never the record\'s status history: the rail shows each\nmove. A timeline\'s moment is its child\'s first date, and who its member field. Rows each what happened on a day and who \u2014\na date on their line, a member, no stage and no figure \u2014 read best as a timeline.\n\n### Agenda\n\n`{ "agenda": { \u2026 } }` reads a record\'s child rows as planned entries on a time axis: by day, soonest first, each with its\npicture and the day that is today marked. The day is the first date on the child\'s row line (its `records` title or\nsubtitle); within a day entries follow a datetime there, else the first single select after the date. An entry with no day\nyet is a plan, listed first and dated in place. `start` is the record\'s date that is the first day: each day\'s heading\ncounts from it (Day 1, Day 2).\n\n<!-- generated:start layout-agenda -->\n\n#### Agenda keys\n\n| Key | Type | Meaning |\n|---|---|---|\n| `start` | alias | The record\'s date that is the first day: each day\'s heading counts from it; absent, the weekday and the date alone |\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `list.agenda` | An agenda List\'s child names a date on its row line (`records` title or subtitle); the layout\'s `start` is a date of the record. |\n| `list.agenda-note` | *Noted, never refused:* Rows each on a day and within it (at an hour, in a part of the day) listed as a table: a List with `layout: { agenda }` draws them by day. |\n| `list.timeline` | A timeline List\'s child holds a date to place its entries by. |\n| `list.timeline-note` | *Noted, never refused:* Rows each what happened on a day and who \u2014 a date on their line, a member, no status and no figure \u2014 listed as a table: a List with `layout: "timeline"` draws them as a timeline, newest first. |\n\n<!-- generated:end layout-agenda -->\n\n### Checklist\n\n`{ "checklist": { \u2026 } }` reads a record\'s child rows, which are tasks, as a checklist of checks: each one\'s mark \u2014 passed\nat a `closed` option, failed at a `failed` one, else still to check \u2014 its title, its columns as its words (a text column\nits note, on its own line), and on a line under its title its photo and its clause. Never grouped nor written in place.\n`passed` alone sets the mark, so rows with no `task` and no status are checks: a measured yes/no is the verdict. With\n`expect` on the standard\'s items, each item is a line marked the same way (a missing one still to check), filled in\nplace by the block\'s `columns` (a measured value, a note, a photo), so `photo` and `clause` are not named.\n\n<!-- generated:start layout-checklist -->\n\n#### Checklist keys\n\n| Key | Type | Meaning |\n|---|---|---|\n| `photo` | alias | The child\'s files field holding the photo each row is checked by; absent, the child\'s `records.image` |\n| `clause` | alias | The child\'s one-row link to what each row is checked against \u2014 a standard\'s clause, a rule |\n| `failed` | list of alias (at least one) | Options of the child\'s status a row stands failed at \u2014 none of them closed |\n| `passed` | alias | The child\'s yes/no field (stored or a formula) setting each row\'s mark: yes passed, no failed, empty still to check |\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `list.checklist` | A child List with `layout: { checklist }` reads a task entity\'s rows as checks \u2014 never under documents, grouped, edited in place or picked together by an Act over several, its columns no files; `photo` names a files field of the child, `clause` a one-row link of it, `failed` options of its status, none `closed`; `passed` a yes/no of it, stored or a formula, setting each mark (yes passed, no failed, empty still to check) and standing without `task` or a status. With `expect` the lines of a standard are the checks, each marked and filled by the block\'s columns (a measured value, a note, a photo), so `photo` and `clause` are not named. |\n\n<!-- generated:end layout-checklist -->\n\n## Time and place layouts\n\nThe layouts that place a List\'s rows in time or on a plan. Each is a `layout` object stating the data it reads.\n\n### Lanes\n\n<!-- generated:start layout-doc-lanes -->\n\n`{ "lanes": { "by": \u2026 } }` draws each row of the linked table as a lane (a chair, a machine, a room), empty ones too,\nand each row of the List as a block from the first date on its line to the second: over the hours of one day, where the\nfirst holds its hour (a week of them draws each day\'s cells, a block\'s time range its first fact), else over the days of one day, a week or a month. A press on a free stretch between blocks adds a row there, its lane and its start set, and its end where the next block\nbounds it. Rows naming no lane stand first, in a lane of their own; where the app writes the link, each block moves to\nanother lane from its menu. Inside a `scope`, the lanes are the ones whose own one-link names that scope\'s row. A span\'s\nend holds its day unless `records` names it the day the row `frees`.\n\nRows with no hour read at one day (`day`) as cards in lanes, not blocks over an axis: the rows no lane holds first, in a tray that\nalso holds the rows with no day, then each lane with its count and its status where its table states one; a lane its link no longer admits says so on its head and takes no new card. A card\'s lead is its\ntick; ticked cards, or one dragged, go to a lane together in one write, every row judged before any is written. The List\'s first\n`sort`, where it is a stored number the app writes, is a card\'s place in its lane. A week of such rows, or any rows with an hour,\nkeep the blocks.\n\nA person is a lane too: `by` may name a member field holding one person, with `of` the role (one of the model\'s\n`roles`) whose every member is a lane \u2014 `{ "lanes": { "by": "engineer", "of": "engineers" } }`. A row stands\nin the lane of the person it holds, and a `no_overlap` by that member keeps one row per person at a time. `of` is\nrequired with a member `by` and refused with a link; `loads` read a lane\'s row, which a person is not.\n\n`loads` names what a lane carries: `{ "weight": "payload", "volume": "box" }` sums each block\'s number and reads it\nagainst the lane row\'s own, at most two; each block then reads that number after its first column. A lane reads the most its standing blocks add up to at\none time in the window, named, past its bound, by how much and on which day or hour; hours add up within each day, and across days the fullest day is read, named. The two are in one unit, or two of\none dimension. `"per": "week"` holds the bound over the calendar week instead: a lane then reads the sum of its\nblocks over the week of the day in view, on a day, a week or a day of hours, and its head says "6 h of 40 h this week". A bound a single row must keep (no parcel heavier than its van) is a `max` on the field through the link,\nwhich refuses the move.\n\n<!-- generated:end layout-doc-lanes -->\n\n<!-- generated:start layout-lanes -->\n\n#### Lanes keys\n\n| Key | Type | Meaning |\n|---|---|---|\n| `by` | alias, required | A one-link of this entity whose target\'s rows are the lanes (a chair, a machine, a room), each drawn even when empty; or a member field holding one person, whose lanes are the members of the role `of` names |\n| `of` | alias | Shows a whole team, the idle included: with a member `by` only (refused with a link), the role, one of the model\'s `roles`, whose every member is a lane, drawn even when empty |\n| `loads` | map of alias \u2192 alias | What a lane carries against what it holds, at most 2: a number of this entity each block adds \u2192 a number of the lane\'s row it is held within, in one unit or two of one dimension |\n| `per` | `"day"` \\| `"week"` | With `loads` only: how long the bound holds. `day`, the default: the most a lane carries at one time or on one day. `week`: the sum of a lane\'s blocks over the calendar week of the day in view, on every size of the window |\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `list.lanes` | `layout: { lanes }`: `by` is a one-row link to a table whose document states `records`, the rows name a date on their line (a field of the row itself, or a lookup of its parent\'s date), a lane block\'s two ends are read alike (two days or two moments), and `loads` stands with it. |\n| `list.loads` | A lanes layout\'s `loads` names one to 2 numbers a lane block adds \u2014 never a percent \u2014 each against a number of the lane\'s row, in one unit or two of one dimension; `per` (day or week) stands only beside `loads`. |\n\n<!-- generated:end layout-lanes -->\n\n### Gantt\n\n<!-- generated:start layout-doc-gantt -->\n\n`{ "gantt": { \u2026 } }` draws each row as one bar on one axis of time: `{ "start": "etd", "end": "eta", "milestones":\n["cut_off"], "planned": { "end": "booked_eta" }, "progress": "done", "after": "waits_on" }`. `end` defaults to the table\'s\nfirst `due`, and a table with neither is refused; `start` and `end` are two dates of the row, both days or both moments,\nand each planned date is read as `start` is. `progress` is a percent (0\u2013100); absent, a row whose record lists its tasks\nfills to how many are done. `after` is a link to rows of the same table, each ending before the row starts. The bars\nstand in the lanes of the List\'s `group`. Where the app writes the row and a person writes a bar\'s date, the bar is\ndragged through the row\'s save; a computed date, one an Act sets, or a row the app does not write drags nothing. Over a\ntable that holds rows under rows, each bar stands under the row above it, indented and folded as the register\'s outline\nis, `group` still the outer section. A child List of a record may lay out as a gantt too: the bars of the rows the\nrecord\'s link names.\n\n<!-- generated:end layout-doc-gantt -->\n\n<!-- generated:start layout-gantt -->\n\n#### Gantt bar\n\n| Key | Type | Meaning |\n|---|---|---|\n| `start` | alias, required | A date of this entity each row\'s bar starts at (a sailing, a hire\'s start, a task\'s start) |\n| `end` | alias | The date each row\'s bar ends at, read as `start` is \u2014 two days or two moments; absent, the entity\'s first `due` |\n| `milestones` | list of alias (at least one) | Dates of the row marked on its bar\'s line as diamonds, each named by its label (a cut-off, a delivery, the end of free time) \u2014 never `start` or `end` |\n| `planned` | [Gantt plan](#gantt-plan) | The plan each row is read against, drawn as a thin bar under its own \u2014 each date read as `start` is; a missing one is the bar\'s own |\n| `progress` | alias | A percent of this entity (0\u2013100) filling each row\'s bar as far as the work is done; absent, how many of the row\'s tasks are done fills it where its record lists them, else the bar wears its status\'s tone |\n| `after` | alias | A link of this entity to its own rows each row waits on \u2014 it starts once they end (finish-to-start), an arrow from each; a row starting before one ends is drawn in the danger tone |\n\n#### Gantt plan\n\n| Key | Type | Meaning |\n|---|---|---|\n| `start` | alias | The date the row was planned to start at |\n| `end` | alias | The date the row was planned to end at (a booked arrival) |\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `list.gantt` | `layout: { gantt }`: `start` and `end` (absent, the entity\'s first `due`) are two different dates of the row, both days or both moments; each diamond (`milestones`) another date of it, each planned date read as `start` is, `progress` a percent and `after` a link to rows of the same entity. |\n\n<!-- generated:end layout-gantt -->\n\n### Plan\n\n<!-- generated:start layout-doc-plan -->\n\n`{ "plan": { \u2026 } }` draws things that stand at a place \u2014 pallets in a warehouse \u2014 on a plan of the places. The places are\nthe rows of a table whose `records` states a `plan_place` (a bay, an open area or a landmark, each at its spot on a sheet\nof the plan); `at` names the one-link of the List\'s rows to a place and, for an item in a bay, the row (`across`) and the\ntier (`up`) it stands in, counted from 1. A bay is drawn as its rows and tiers, an area with a count, a landmark as a\nlabelled frame; the reader sees a plan, one bay enlarged, and the same plan in 3D. The List may read other tables as\n`sources`: one plan of every table\'s items. Each item carries `__reach` \u2014 how many items stand in the way of taking it out\n(those above it where the place is `stacked`, and those in the rows between it and the side `reach_from` says the bay is\ntaken from) \u2014 so the list, its export and an agent\'s read all carry it; `<table>_plan_load` counts the rows each place\nholds. A move through the app is refused unless it clears the place, row and tier all three, or places the item at\na free cell of a bay \u2014 resting on a present item where the place is `stacked` \u2014 or at an area. Every other write (a grid edit, an import, a tool) holds one item to a cell only where the item\'s table states `unique: [<at>, <across>, <up>]`; a plan over a table stating none is noted. A plan opens on every row\nits `where` keeps, with no stage chip narrowing it. Rows with no place wait in a tray beside the plan. An Act that asks exactly a place (a link to the plan\'s places) and two numbers (the row and the tier) is answered by a pick on the plan, never by a form. On a desk a press opens a row\'s record in the panel beside the plan.\n\n<!-- generated:end layout-doc-plan -->\n\n```jsonc\n// table "bay"\n"title": "code",\n"records": { "plan_place": { "kind": "kind", "x": "x", "y": "y", "across": "rows", "up": "tiers", "reach_from": "taken_from", "stacked": "is_stack" } }\n```\n\n```json\n{ "type": "List", "entity": "pallet", "filters": ["line"], "layout": { "plan": { "at": "bay", "across": "row", "up": "tier" } } }\n```\n\n```jsonc\n// table "pallet": one item to a cell on every write, not only through the app\n"unique": [["bay", "row", "tier"]]\n```\n\n<!-- generated:start layout-plan -->\n\n#### Plan keys\n\n| Key | Type | Meaning |\n|---|---|---|\n| `at` | alias, required | A one-link of this entity to an entity whose `records` states a `plan_place`: where each row stands |\n| `across` | alias, required | A number field: the row of a bay a row stands in, counted from 1; empty at an area |\n| `up` | alias, required | A number field: the tier of a bay a row stands at, counted from 1 at the ground; empty at an area |\n| `fill` | alias | A single select the items are coloured by; absent, the first single select among the register\'s filters |\n| `mark` | [Plan mark](#plan-mark) | A row holding the option says the option\'s label on its box and is hatched in the option\'s own colour, and the legend names it by the label; over `sources`, the select is matched by option alias, and a source lacking the select never marks its rows |\n| `size` | [Plan size](#plan-size) | Each row\'s box as it stands in the world, in the one length unit its places\' `size` states: the option the row holds of the select names its box\'s width across, depth along and height; over `sources`, matched by option alias, as `mark` is; a row holding an option it does not name is drawn at its place\'s cell |\n\n#### Plan mark\n\n| Key | Type | Meaning |\n|---|---|---|\n| `field` | alias, required | A single select of this entity, or a lookup of one through a one-row link |\n| `option` | alias, required | An option alias of that select |\n\n#### Plan size\n\n| Key | Type | Meaning |\n|---|---|---|\n| `field` | alias, required | A single select of this entity, or a lookup of one through a one-row link |\n| `options` | map of alias \u2192 [Plan size box](#plan-size-box), required | The box of each option alias of that select |\n\n#### Plan size box\n\n| Key | Type | Meaning |\n|---|---|---|\n| `across` | number, required | The box\'s width across the bay\'s rows |\n| `along` | number, required | The box\'s depth along them |\n| `up` | number, required | The box\'s height |\n\n#### Plan place\n\n| Key | Type | Meaning |\n|---|---|---|\n| `kind` | alias, required | A single select, options aliased `bay` and, where the places have them, `area` and `landmark`: a bay holds rows and tiers, an area neither, a landmark nothing |\n| `sheet` | alias | The plan sheet it is on: a single select, or a one-row link to an entity whose `records` states its `image` \u2014 the sheet\'s drawing, which the places are drawn over (with `scale`) |\n| `scale` | alias | A number field of the sheet entity `sheet` links to: how many cells wide its drawing is, the plan\'s scale. Required where that entity states an `image`, and only then |\n| `x` | alias, required | A number field: left edge, in cells |\n| `y` | alias, required | A number field: top edge, in cells |\n| `width` | alias | A number field: an area\'s frame width, in cells |\n| `depth` | alias | A number field: an area\'s frame depth, in cells |\n| `across` | alias, required | A number field: a bay\'s rows |\n| `up` | alias, required | A number field: a bay\'s most tiers |\n| `reach_from` | alias | A single select, options aliased exactly `first`, `last`, `both`: the side boxes leave a bay from; a bay that names none has no reach and no arrow |\n| `stacked` | alias | A boolean field: true where items at this place rest on the one below (a stack), so a tier above the first needs a present item under it, shows floating without one, and an item\'s reach counts the items above it; false or empty, items sit at any tier and only the rows between a bay\'s reach side and the item are in the way |\n| `size` | [Plan place size](#plan-place-size) | The real size of ONE cell of the place, for 3D: three number fields stating one length `unit` alike. Absent, a cell is drawn at the size most of the sheet\'s places state, a unit cube where none states one |\n\n#### Plan place size\n\n| Key | Type | Meaning |\n|---|---|---|\n| `across` | alias, required | A number field: the width of one cell across the rows |\n| `along` | alias, required | A number field: the depth of one cell along the place |\n| `up` | alias, required | A number field: the height of one cell, one level |\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `list.plan` | `layout: { plan }`: `at` is a one-row link to an entity whose `records` states a `plan_place`, `across` and `up` two different numbers of the row, `fill` a single select; a plan List has no Tabs, `group` or `attention`. A write that sets `at`, `across` or `up` is refused unless it clears all three, or places the row at a free cell of a bay (a row from 1 to the bay\'s `across`, a tier from 1 to its `up`, resting on a present item), or at an area with neither. |\n| `list.plan-unique` | *Noted, never refused:* A plan\'s items (the List\'s table and each source) state `unique` on their place link, `across` and `up`: the app\'s moves refuse a taken cell, and the unique makes every other write hold it \u2014 the note names a table that states none. |\n| `list.plan-mark` | A plan\'s `mark` names a single select of the row, or a lookup of one through a one-row link, and an option of it by alias: a row holding that option is hatched on its box in the option\'s colour. A source that holds the select must hold it as a single select with that option; a source lacking it never marks its rows (`list.source-lacks`). |\n| `list.plan-size` | A plan\'s `size` names a single select of the row, or a lookup of one through a one-row link, and, by option alias, the box (`across`, `along`, `up` \u2014 positive, in the one length unit the places\' `size` states) of each option: a row holding one is drawn as that box. A source that holds the select must hold it as a single select; a source lacking it draws its rows at their places\' cells (`list.source-lacks`). |\n| `list.plan-box-size` | *Noted, never refused:* A plan whose places state a `size` and whose rows\' select options are ISO 6346 container size-type codes (`20DC`, `40HC`) states the box of each in `size`, from the ISO 668 dimensions, else every box is drawn at its place\'s cell. |\n\n<!-- generated:end layout-plan -->\n\n## Publish desk\n\nRows that are each a place the record is sent \u2014 a notice\'s boards, a listing\'s portals \u2014 are a record\'s child List with\n`expect` on the child\'s one-row link to the catalog of those places and `layout: { "desk": \u2026 }`:\n\n```json\n{\n "type": "List",\n "entity": "posting",\n "expect": "board",\n "columns": ["posted_link", "refusal"],\n "layout": { "desk": { "bodies": ["wording", "wording_abroad"], "text": "goes_out_as", "media": "pictures", "link": "page", "group": "reach", "network": "kind", "networks": { "company_page": "linkedin" } } }\n}\n```\n\nThe desk is where the post is written. `bodies` are the record\'s plain text fields it is written in (one per language,\nsay), each its editor between the list and the preview, saved as any field of the record is and drawn nowhere else on it.\nThe preview is `text` read over what is on screen: where `text` is a formula of the child, the desk computes that same\nformula over what is typed, so the post moves as it is written, and a place not ticked previews the words its row would\nhold. For that the formula reads only what a screen holds whole: stored values of its row, the record through lookups over\nthe link back to it, the place through lookups over `expect`, and formulas of the row over those \u2014 a rollup, a lookup\nthrough another link or the clock is refused, naming the field.\n\nEvery place the link admits is a line with a tick and that place\'s face: its picture, else the mark of the network it is on\nwhere `networks` names one. `group`, another single select of the place, stands the lines under its options in their\norder: a kind holding a ticked line is open, one holding none folded to its heading and its count. A tick makes the line\'s\nrow from its key alone \u2014 so nothing else the child requires is left without a default \u2014 and an untick deletes it until the\nrow\'s stage is `closed`: what went out is not taken back. It asks first only where a person wrote on the row. One line is\nworked beside the list and read as the post that place\'s feed shows: `text` is the child\'s words for that place, `media`\nand `link` the record\'s, and `network` the place\'s single select whose options `networks` names to a feed; an option not\nnamed reads on a plain card. Under the bodies stand the List\'s `columns` a person writes of the line\'s row; under the post,\nthe press copying its words beside the Acts of the child, then what the line and the `columns` hold that nobody writes\nthere (the link it went out at, why it was refused). A value an Act or a workflow fills is stated as that Act\'s, so the\ndesk never offers it as an empty box. Sending is an ordinary Act of the record.\n\n<!-- generated:start layout-desk -->\n\n#### Desk keys\n\n| Key | Type | Meaning |\n|---|---|---|\n| `bodies` | list of alias (1\u20133) | The record\'s plain text fields the post is written in, in order \u2014 one per language, say \u2014 at most 3: each its editor on the desk, between the list and the preview, and drawn nowhere else on the record |\n| `text` | alias, required | A text of the block\'s rows \u2014 stored, or a formula yielding text \u2014 holding the words that go out on that row\'s destination. A formula is computed on the desk too, over what is typed: it reads stored values of its row, the record through lookups over the link back to it, the destination through lookups over `expect`, and formulas of the row over those \u2014 never a rollup, another link or the clock |\n| `media` | alias, required | A files field of the record: the pictures or the video the post carries |\n| `link` | alias | A text field of the record holding a link (`format: "link"`), carried as the post\'s card |\n| `network` | alias, required | A single select of the entity `expect` links to, saying which network each destination is on |\n| `group` | alias | Another single select of the entity `expect` links to \u2014 the destination\'s kind \u2014 the lines stand grouped by: each option a heading in the select\'s order, a group holding no ticked line folded to its heading and its count, destinations holding no option last |\n| `networks` | map of alias \u2192 `"facebook"` \\| `"instagram"` \\| `"threads"` \\| `"x"` \\| `"linkedin"`, required | That select\'s options, each by its alias, to the network whose feed the post is previewed in \u2014 facebook, instagram, threads, x, linkedin. An option not named has no feed to imitate: its words read as a plain card |\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `list.post` | A child List with `layout: { desk }` needs `expect` on a one-row link \u2014 never a select, nor with `under`, `pick`, a checklist layout, `compare` or a `create` list, its line made by a tick from its key alone: its `bodies` are plain text fields of the record a person writes, drawn nowhere else on it; its `text` is a text of the child, stored or a formula yielding text \u2014 a formula reading only stored values of its row, lookups through the link back to the record or through `expect`, and formulas of the row over those, never the clock; its `media` a files field of the record and its `link` a text field of the record; its `network` a single select of the entity the link names, and `networks` holds options of that select, by alias, each to one of facebook, instagram, threads, x, linkedin; its `group` is another single select of that entity. |\n\n<!-- generated:end layout-desk -->\n\n## Record node\n\nA Record draws what a row opens: the head, then the parts.\n\n- **The head:** title, subtitle, picture, mark, party, figure and meter, deadlines, description \u2014 the\n table\'s `records` facts, overridden by the Record\'s `row`. `row` changes how the App\'s rows read wherever it lists them, and has nothing to do with arranging a page. The status stands in the head, or the Side where the Side states it, never in a Section.\n- **Where it stands:** a Record stands only in the App\'s `pages`, one per entity, stating its `entity`; every List over\n the entity opens it. With no page for an entity, the platform designs the record\'s Sections from the rows: the fields\n the head does not draw, child Lists, papers and Acts. A stated page stands exactly as written, so it replaces them.\n Under a child List, an absent page is every field of the child except the link back.\n- **Children:** either parts \u2014 `Section`, `Side` \u2014 or, for a one-part record, `Field`, `List`, `Reading`,\n `Statement` and `Act` directly. The two are never mixed. The page of an entity no root List and no Sheet\'s List (one stating no `app`) is over \u2014 a\n child List\'s, a document\'s or a roster cell\'s \u2014 holds `edit`, Fields, Sections of them with the Acts and the Lists of\n their rows\' own children, and the Lists of its rows\' own children; a row opened in place draws each Section under its\n title, an Act no Section holds at the last Section\'s foot, and a page with no Section its one section. Such a page\n holds what any page holds \u2014 a Reading, a Side \u2014 and one stating a Side opens its rows\n by its `door` instead of in place; any other `door` there is not drawn and stays stated.\n\n<!-- generated:start node-record -->\n\n| Key | Type | Meaning |\n|---|---|---|\n| `entity` | alias, required | The table whose rows open on this page: a page stands once per entity, in the App\'s `pages`, and every List over the entity opens it |\n| `row` | [Record row](#record-row) | How the App reads this entity\'s rows wherever it lists them \u2014 their line, figure, picture, deadlines and stage \u2014 where it differs from the table\'s `records` |\n| `add` | `false` \\| list of alias (at least one) | What a new row asks where a picker of this entity offers one, anywhere in the App: these fields; `false`: a picker only picks. Absent, the table\'s required fields, its natural key and its title, where the table states a `singular` |\n| `remove` | `true` | Lets a person delete a row reached through a link: true, it offers a Delete; rows a List lists are deleted as that List\'s `remove` says |\n| `door` | `"page"` \\| `"drawer"` | How a row opens, on a page or in a drawer: absent, a page where a part is a step or a Side or there are more than 3 parts, else a drawer |\n| `edit` | `false` | Shows a record nobody changes here: false, nothing it draws is written, a link\'s row of it included |\n| `children` | list of (alias \\| [Field](#field-node) \\| [Fieldset](#fieldset-node) \\| [Section](#section-node) \\| [Side](#side-node) \\| [Outside](#outside-node) \\| [List](#list-node) \\| [Reading](#reading-node) \\| [Statement](#statement-node) \\| [Act](#act-node) \\| [Check](#check-node)) (at least one) | Parts (Section, Side), or for a one-part record its Fields, Fieldsets, Lists, Readings and Statements directly \u2014 never both. Beside either stand Outsides, Checks (guarding this entity\'s Acts and saves) and Acts on one row, each placed at the foot of the part whose step it moves into, a correction in the head\'s \u22EF. Holding only Acts, Checks and Outsides, or absent, the record\'s Sections are the platform\'s: the fields the head does not draw, child Lists, papers and Acts. Otherwise it stands exactly as written |\n\n#### Record row\n\n| Key | Type | Meaning |\n|---|---|---|\n| `title` | [Record row title](#record-row-title) | The row\'s title field, stated for its `edit` alone |\n| `subtitle` | list of (alias \\| [Record row line field](#record-row-line-field)) (1\u20132) | Up to two fields read under the title, in place of the table\'s |\n| `figure` | alias \\| [Record row line field](#record-row-line-field) \\| `false` | The one number a row stands for, in place of the table\'s; false, none. `{ field, edit: false }` reads it without writing it |\n| `image` | alias \\| [Record row line field](#record-row-line-field) \\| `false` | A files field, or a one-row link to a table with a picture, that pictures a row, in place of the table\'s; false, none. `{ field, edit: false }` reads it without writing it |\n| `due` | list of alias (at least one) \\| `false` | Dates that count down, in place of the table\'s; false, none |\n| `status` | `false` \\| `{ "edit": true \\| false }` | Whether this app shows and moves the stage: false, it is not shown. `{ edit: true }`: the stage is also moved by hand. `{ edit: false }`: nobody moves it in this app, another app does. Absent, the stage stands in the record\'s head, or in the Side where the Side states it: choosing a move runs its Act, asking and refusing as its button does |\n\n#### Record row title\n\n| Key | Type | Meaning |\n|---|---|---|\n| `edit` | `false` | Keeps a row\'s name as it stands: false, the title is read; absent, it is written where the table lets a person write it |\n\n#### Record row line field\n\n| Key | Type | Meaning |\n|---|---|---|\n| `field` | alias, required | The field\'s alias |\n| `edit` | boolean | Shows a value nobody changes here: false, the field is drawn and read; absent or true, it is written where the table and the part holding it let a person write it |\n\n<!-- generated:end node-record -->\n\nThe door is a page where a part is a step or a Side, or where there are more than 3 parts; else a drawer. `door`\nis a judged choice of how a job is worked (one after another over a long record), so it is kept. A Section is one area of the record\'s data a person comes to for its own job, like the tabs of a settings page (a company\'s General,\nMembers, Billing): the related lists and field groups of that area sit inside it under their headings. A status\'s stages are not areas:\ntheir acts stand at the foot of the rows they move. From three parts on, the\nrecord shows one at a time: a press on a page\'s rail (a strip of the same names on a phone and in a drawer) flips to a part and returns\nto the top. It opens on the part the address names, else the step that is now, else the first. A part\'s rows and drafts are kept\nacross flips. With fewer parts they stack.\n\nA record shows no activity and no audit log: a history an app shows is table-backed \u2014 `records.status.dates`, `records.status.history`, an event table an act\nmakes \u2014 stated where the app shows it.\n\nA field may be stated in any number of parts, and each part draws what it states. Where parts stack it stands once: in the\nstep that is now if that step states it, else the first part stating it. A Section or a List with `when` is\ndrawn only while each named select of the record holds one of its options.\n\n## Section node\n\nA titled part of a record, and optionally a step of its path. A Section draws its plain Fields first, then its\nLists, Readings and Statements in the order stated; its Acts stand at its foot.\n\n<!-- generated:start node-section -->\n\n| Key | Type | Meaning |\n|---|---|---|\n| `key` | alias | Unique among its siblings; part of the node\'s address. Absent, the title\'s words as a slug, written once and kept |\n| `title` | text | The part\'s heading. Absent, the part draws none where it is the record\'s only part; beside others it is named by what the record is. A step states it |\n| `description` | text | A line under the heading |\n| `when` | [condition](#app-tree) | Drawn only while this holds |\n| `edit` | `false` | Shows a part nobody changes here: false, nothing in it is written |\n| `at` | list of alias (at least one) | Options of the record\'s status during which this part is the work now: a step of its path |\n| `children` | list of (alias \\| [Field](#field-node) \\| [Fieldset](#fieldset-node) \\| [List](#list-node) \\| [Reading](#reading-node) \\| [Statement](#statement-node) \\| [Act](#act-node) \\| [Check](#check-node)) (at least one) | What the part draws, in reading order; its Acts stand at its foot. A Fieldset holds Fields under a heading of their own. A Check stated here guards the entity as one beside the parts does |\n\n<!-- generated:end node-section -->\n\n#### Kinds of block\n\nWhat a Section draws beside its Fields is a block, of the kind its item states: a List a rows block, an outline where its table holds rows under rows, an agenda or a timeline by its layout, or a list that only reads; a Field a gallery of files or a prose block; a Statement and a Reading each its own.\n\n<!-- generated:start block-kinds -->\n\n| Kind | What it is |\n|---|---|\n| `rows` | Rows list a record\'s child rows under it, each a line in the register\'s row anatomy: a List standing in a Section, its rows linked to the record, narrowed by its `where`, opened in place, their Acts in each row\'s \u22EF; rows that hold pictures are cards, each led by its picture. A child List draws as rows unless its layout says otherwise; a `checklist` reads the rows as checks, a `desk` as the places the record is sent and a `gantt` as bars on an axis of time (the register\'s, over the rows the record\'s link names). |\n| `outline` | An outline draws a record\'s child rows as a tree where their table holds rows under rows (a task under a task, a part of a part): the top rows first, each row\'s sub-rows read when it is opened, with the count of them, closed of all, beside its name; a row adds a row under itself from its \u22EF. A List the reader narrows, orders by a header, groups or searches draws as plain rows. |\n| `agenda` | An agenda reads a record\'s child rows as planned entries on a time axis: by day, soonest first, each with its picture and the day that is today marked. The day is the first date on the child\'s row line; within a day entries follow a datetime there, else the first single select after the date. An entry with no day yet is a plan, listed first and dated in place. `start` is the record\'s date that is the first day: each day\'s heading counts from it (Day 1, Day 2). |\n| `timeline` | A timeline reads a record\'s child rows as a log of dated entries, newest first, with a composer where the app adds entries, each corrected and removed where it stands. It is never the record\'s status history: the rail shows each move. A timeline\'s moment is its child\'s first date, and who its member field. |\n| `files` | Files draw a run of the record\'s files fields as one gallery under a heading, each field\'s files as thumbnails with a drop zone to add to them. A files field, or a lookup of one, draws as a gallery unless its Field states `block: false`. |\n| `text` | Text draws one of the record\'s markdown fields as prose under a heading, edited in place where the app writes it. A markdown field draws as prose unless its Field states `block: false`; plain text is a control among the part\'s fields unless it states `block: true`. |\n| `choices` | Choices draws one of the record\'s multi-selects as a checklist under a heading: every option on a line of its own, ticked where the record holds it, ticked and unticked in place where the app writes it. A multi-select is a control among the part\'s fields unless its Field states `block: true`. |\n| `linked` | Linked draws the row a link of the record to one row names, whole and in place, as its page draws it \u2014 its fields, parts, Lists and Acts, read and written as that row\'s own \u2014 under a heading. A link draws as its row\'s chip unless its Field states `block: true`. |\n| `figures` | Figures draw numbers of the record (1 to 8) as tiles, each under its field\'s label. A tile holding nothing reads as not measured, never 0. |\n| `statement` | A statement builds one figure from figures of the record: each line a number of it with its operator and its label, the figures on one right edge, the last an `equals` drawn heaviest (a claim\'s payable, an invoice\'s total, a payslip\'s net). A line may carry the rows its figure adds up (`parts`), each listed under it. |\n| `reading` | A reading block draws a Reading over the child rows under the record, through their link to it: a number, a split into parts, a trend, a grid, a shortfall against stock, or the work against its plan. It stands in the record\'s strip beside the record\'s own figures. |\n| `list` | A list shows rows of another entity beside the record, read only: those linked to it, a path through a row of their own, or \u2014 with `same` \u2014 the siblings sharing a link of the record, the record itself left out. Each row reads in its `records` anatomy with the `columns` after its title, and opens on its page. |\n| `funnel` | A funnel counts steps people drop out of between, a column of each child row a step (2 to 8): one funnel over the rows under the record \u2014 each step its column summed, its bar over the first step, the share kept between two steps and from the first to the last. |\n\n<!-- generated:end block-kinds -->\n\n- **`at`** names the stage options during which the section is the work now \u2014 only on a record that\n truly moves through those stages: the rail marks it done, now or waiting, and it may hold nothing, its title being the step;\n one that is now and holds nothing says so. Two Sections at one option are both the work there, and the first opens. A step\n never hides a field, locks it or gates an act: fields stay writable as the write rules and checks allow, at any stage.\n- **Acts:** every Act on a record stands in the Section whose work it is. An Act moving the stage and offered at ONE step\n stands at that step\'s foot when it moves the work forward, to an exit later in the stage\'s options, or back to a step the\n work passes; one offered at several steps, or moving back into a step the work never passes, stands in the Section it\n enters, as its way in. One stated elsewhere stands there, and the answer says so. A correction (`danger`, and not one of\n its step\'s outcomes) waits in the Section heading\'s \u22EF.\n- **An exit** stands only once the record is in it, its reason there and its rail item apart from the path; until then the\n Act waits in the header\'s \u22EF.\n- **A document:** a Section that is no step and holds nothing but one `text` block over a markdown field reads as a document: the field is written in place with no box, saved when the writer leaves it, and the record reads in an article column while that part is in view.\n- **Writes:** its Fields and its Acts.\n\n## Side node\n\nThe one part drawn beside the rest \u2014 the photos looked at, the pool picked from, the facts kept in view. It stands on the\nright, beside the rail and the parts; on a phone it is one pinned line that opens in place. At most one Side to a record, on a page\ndoor.\n\n<!-- generated:start node-side -->\n\n| Key | Type | Meaning |\n|---|---|---|\n| `key` | alias | Unique among its siblings; part of the node\'s address. Absent, the title\'s words as a slug, written once and kept |\n| `title` | text, required | The part\'s heading |\n| `description` | text | A line under the heading |\n| `when` | [condition](#app-tree) | Drawn only while this holds |\n| `edit` | `false` | Shows a part nobody changes here: false, nothing in it is written |\n| `children` | list of (alias \\| [Field](#field-node) \\| [Fieldset](#fieldset-node) \\| [List](#list-node) \\| [Reading](#reading-node) \\| [Statement](#statement-node) \\| [Act](#act-node) \\| [Check](#check-node)) (at least one) | What the part draws, in reading order; its Acts stand at its foot. A Fieldset holds Fields under a heading of their own. A Check stated here guards the entity as one beside the parts does |\n\n<!-- generated:end node-side -->\n\nIt holds what a Section holds. A field it states, the status included, leaves the head and stays on list rows; the title stays in the head. Writes: its Fields and its Acts.\n\n## Outside node\n\nWhat one record shows, and which acts it allows, to a person with no seat who opens a link a member made of it. A member\npresses Create link on a record while its status stands in `at`; the link opens that one record until it expires, is\nrevoked, or its act moves the status out of `at`. The person sees the stated Fields and Lists and presses the stated Acts\nand nothing else. It stands directly in the Record of a table with a stored status select, whichever List over it opens the page.\n\n<!-- generated:start node-outside -->\n\n| Key | Type | Meaning |\n|---|---|---|\n| `key` | alias | Unique in the app: a link to the record names it. Absent, the title\'s words as a slug, written once and kept |\n| `title` | text, required | The heading of the page the person without a seat opens |\n| `description` | text | A line under the heading |\n| `at` | list of alias (at least one), required | Options of the record\'s status during which a link to it opens; none is owned by a stage, and each Act moves the status out of them |\n| `children` | list of (alias \\| [Field](#field-node) \\| [List](#list-node) \\| [Act](#act-node)) (at least one), required | Exactly what the link shows and allows: Fields read as values, Lists of child rows read as they are, and the Acts the person may press, each moving the status out of `at` |\n\n<!-- generated:end node-outside -->\n\n- **Fields** are read as values, in order; a lookup, a rollup or a formula is computed for the link only if stated here.\n A Field states nothing but its alias.\n- **Lists** read the child rows under the record as they are: `columns`, `label` and `where`.\n- **Acts** are the link\'s alone: no member, visitor or agent presses them. Each states `key`, `label`, `confirm`, `when`,\n `requires`, `asks`, `set`, `template` with `into`, or `sign`. `when` absent is the status held in `at`; `set` moves the\n status to an option outside `at`, so each press ends the visit. `asks` are text, numbers, dates or listed options. A\n `sign` is by a text field the signer types, with no witness: the link is the attestation.\n- `at` names options no stage owns, and no two Outsides of a table open during the same option.\n- **Writes:** its Acts, and nothing else.\n\n## Tab node\n\nA Tab is one view of a List\'s rows over a period: a register reporting a period \u2014 what stands at its end beside what came and went during it (the stock,\n the hires out, the tickets open) \u2014 reads its rows as Tabs over one `period` the reader picks above them. A Tab holds\n the rows `dated` within the period, those `open` at its end, or lists every row and draws what a child\'s rows came to\n in the period (`totals`). A Tab narrows its rows and holds no nodes; Readings stand beside it in the List and read the\n open Tab, or the one their `tab` names. Never date chips set by hand, and never a Tab per stage, which the chips split.\n Readings and Lists read apart from a List\'s rows stand on a Sheet, a View of the App\'s own.\n\n<!-- generated:start node-tab -->\n\n| Key | Type | Meaning |\n|---|---|---|\n| `key` | alias, required | Unique among its siblings; part of the node\'s address |\n| `label` | text, required | What the tab holds, in the reader\'s words |\n| `dated` | alias | A date: the tab holds the rows dated within the List\'s period |\n| `open` | [Tab open](#tab-open) | The tab holds the rows open at the period\'s end: begun, and not yet ended |\n| `totals` | [Tab totals](#tab-totals) | Each row\'s figures over a child\'s rows in the period |\n| `where` | [narrowing](#app-tree) | Only the rows whose select holds one of these options, whose yes/no is this value, or whose member field holds the reader (`{ "me": true }`) \u2014 every entry ANDed |\n| `sort` | [Sort key](#sort-key) \\| list of [Sort key](#sort-key) (at least one) | The order this tab\'s rows read in; absent, the List\'s |\n\n#### Tab open\n\n| Key | Type | Meaning |\n|---|---|---|\n| `from` | alias, required | The date a row begins on |\n| `to` | alias, required | The date a row ends on, empty while it is open |\n\n#### Tab totals\n\n| Key | Type | Meaning |\n|---|---|---|\n| `rows` | alias, required | An entity of this app whose rows each belong to one row of the register\'s entity: the rows the columns add |\n| `on` | alias, required | A date of the child placing each row in time: stored, a formula yielding a date, or a lookup of a date through a one-row link \u2014 never a moment or a span of days |\n| `columns` | list of [Totals column](#totals-column) (1\u20136), required | The figures drawn in place of the register\'s columns after each row\'s name, each under its own alias and label |\n\n#### Totals column\n\n| Key | Type | Meaning |\n|---|---|---|\n| `alias` | alias, required | The column\'s name: its address in the totals read |\n| `label` | text, required | What the column holds, in the reader\'s words |\n| `value` | alias \\| `{ "avg": alias }` | A number of the child (stored, a formula or a rollup) summed over the rows, or `{ avg }` averaged over the rows holding one, a window holding none drawing blank; absent, the rows are counted. A figure read in each row\'s own unit or currency stands only where the child\'s select is a lookup, through `via`, of a single select of the register\'s entity |\n| `where` | map of alias \u2192 (list of alias (at least one) \\| boolean) | Only the child\'s rows whose select holds one of these options, or whose yes/no is this value \u2014 every entry ANDed |\n| `window` | `"before"` \\| `"in"` \\| `"through"`, required | Which of the child\'s rows, by `on`, the column adds: `before` those dated before the period\'s first day, `in` those from its first day through its last, `through` those on or before its last day |\n\n#### Period days\n\n| Key | Type | Meaning |\n|---|---|---|\n| `days` | integer, required | How many days through today, at most 366 |\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `list.tabs` | A List\'s Tabs each have a `key` of their own, none the entity\'s alias or one a report template holds (`title`, `lines`, `readings`, `at`, `dates`, `period`, `per`); a Tab states one of `dated` and `open` (dates of its rows, `open`\'s two different) or `totals` (a child\'s rows windowed by the period); its `where` and `sort` hold as the List\'s do, and never narrow by the status, which its chips split. Only a table or cards List has Tabs, and a Reading\'s `tab` names one of them. A `period` opens a List on a window: over a table or cards a Tab that states `dated`, `open` or `totals` reads it; a calendar or a lanes board opens on `"today"`, `"week"` or `"month"` (a lanes board of hours, on `"today"` or `"week"`); no other layout draws one. Wrong: `period: "year"` over a table with no dated Tab. Right: a Tab stating `dated`, or no `period`. |\n| `list.tab-totals` | A Tab\'s `totals` name a child linked to the List\'s entity by a one-row link (a child linking the List\'s entity twice cannot be totalled), a date of the child, never a moment or a span, and 1 to 6 columns each under its own alias and label; a column\'s `value` is a number of the child, its `where` holds over the child\'s selects and yes/nos, and a value read in each row\'s own unit or currency stands only where that select of the child looks up, through its link, a single select of the List\'s entity, and the child links to no source\'s rows. A source\'s rows are totalled by the child\'s one link to them, by one field to one row; a source the child links to not at all totals nothing on its rows (`list.source-lacks`). Only a table List has them, and no Tab states `totals` beside `dated` or `open`. A column sums a number or counts rows, never `{ avg }`. |\n\n<!-- generated:end node-tab -->\n\nA `totals` Tab adds, per column, the child\'s rows `before` the period\'s first day, `in` the period, or `through` its last\nday, so `before` plus `in` of one value is its `through`:\n\n```json\n{\n "type": "Tab",\n "key": "items",\n "label": "Items",\n "totals": {\n "rows": "ledger_line",\n "on": "moved_on",\n "columns": [\n { "alias": "opening", "label": "Opening", "value": "quantity", "window": "before" },\n { "alias": "received", "label": "Received", "value": "quantity", "where": { "kind": ["receipt"] }, "window": "in" },\n { "alias": "issued", "label": "Issued", "value": "quantity", "where": { "kind": ["issue"] }, "window": "in" },\n { "alias": "closing", "label": "Closing", "value": "quantity", "window": "through" }\n ]\n }\n}\n```\n\n## Sheet node\n\nA Sheet is a grid of Readings and Lists over the App\'s rows in its `period`: each Reading a figure, each List the rows it lists. An App of one Sheet opens on it; an App of several draws a strip that picks one.\n\n<!-- generated:start node-sheet -->\n\n| Key | Type | Meaning |\n|---|---|---|\n| `key` | alias, required | Unique among the App\'s Views: the sheet\'s address, `/<key>` |\n| `label` | text, required | What the sheet holds, in the reader\'s words: its name among the App\'s Views |\n| `children` | list of ([Reading](#reading-node) \\| [List](#list-node)) (at least one), required | The Readings and Lists the sheet draws as a grid, in reading order: each Reading a figure over the App\'s rows in the App\'s `period`, each List the rows it lists |\n\n<!-- generated:end node-sheet -->\n\n## Field node\n\nA Field draws one field of the record it stands in. How it is drawn follows from the field\'s type and the table\'s facts:\n\n- a control or a value, with its notation, money, units and deadline countdown;\n- a files field as pictures and documents, a long or markdown text as prose written in place \u2014 a gallery or a prose block,\n with a heading (`label`) and a condition (`when`) of its own; a run of files Fields is one gallery;\n- a link as its row\'s chip, with a picker narrowed by `options_where`, offering a new row where the linked table\'s page\n states `add`;\n- the back side of a child\'s link as the rows filed under the record;\n- the fields an Act\'s `sign` writes as one signature.\n\n<!-- generated:start node-field -->\n\n| Key | Type | Meaning |\n|---|---|---|\n| `field` | alias, required | The field\'s alias |\n| `edit` | boolean | Shows a value nobody changes here: false, the field is drawn and read; absent or true, it is written where the table and the part holding it let a person write it |\n| `label` | text | The heading of the field\'s gallery or prose block, where it draws as one; absent, the field\'s label. A run of files fields takes the first one\'s |\n| `block` | boolean | Gives a field room of its own: true, a files, text or multi-select field draws as its own gallery, prose or checklist block, and a link to one row as that row drawn whole in place, as its page draws it; false: as a control among the part\'s fields. Absent, files and markdown fields draw as blocks, plain text, a multi-select and a link as a control |\n| `when` | [condition](#app-tree) | A gallery or prose block is shown only while the record\'s selects hold these options, its yes/nos these values, its numbers and dates meet their bounds and its `{ "empty": true \\| false }` fields are blank or filled |\n\n<!-- generated:end node-field -->\n\nA field drawn in the head (title, subtitle, picture, figure, stage) is never also a Field node. A Field is drawn once per\npage. **Writes:** the field, under `reference/app-tree`; a picker\'s add is the linked table\'s page\'s `add`.\n\n## Fieldset node\n\nA Fieldset heads a run of a part\'s Fields with a few words of its own: the facts of one kind among a part\'s many (a\nvehicle\'s plate, make and seats under "Vehicle"). It stands among a Section\'s or Side\'s children, or a one-part\nRecord\'s, and holds Fields alone \u2014 two or more, each drawn as a control, each in one Fieldset. A Field in it reads and is\nwritten as it would be in the part. A gallery or prose Field stands beside it, never in it.\n\n<!-- generated:start node-fieldset -->\n\n| Key | Type | Meaning |\n|---|---|---|\n| `key` | alias | Unique among its siblings; part of the node\'s address. Absent, the label\'s words as a slug, written once and kept |\n| `label` | text, required | The heading over the facts it holds, in the reader\'s words |\n| `children` | list of (alias \\| [Field](#field-node)) (at least 2), required | The Fields drawn under the label, in the order stated; each reads as it would in the part |\n\n<!-- generated:end node-fieldset -->\n\n## Act node\n\nAn Act is a verb, stated whole where it stands. Its place decides what it works on:\n\n- in a Section or Side, or in a one-part Record: one record, at that part\'s foot;\n- in a List, with `on`: the ticked rows or every row in view, each checked before any is written;\n- directly in a Record that holds parts: refused.\n\n<!-- generated:start node-act -->\n\n| Key | Type | Meaning |\n|---|---|---|\n| `key` | alias, required | The act\'s name; its workflow is `act_<key>`, or the `workflow` it names |\n| `label` | text, required | The verb, as the reader says it |\n| `when` | [condition](#app-tree) | The act works only while this holds |\n| `requires` | list of alias (at least one) | Fields filled first, each drawn where the act stands |\n| `recommends` | list of alias (at least one) | Fields it runs without and reads when filled |\n| `asks` | list of (alias \\| `{ "field": alias, "starts": "today" \\| "me" }` \\| [Asked input](#asked-input)) (at least one) | What the reader states on pressing: fields of the row (written by the act) or inputs; a `link` input\'s picker adds as its entity\'s page `add` says |\n| `set` | map of alias \u2192 [value](#app-tree) | What the act writes; each field is read-only elsewhere in the app |\n| `owner` | `"field"` \\| `"link.field"` \\| `{ "group": id }` | Who presses it: a member field of the row, `link.field` read through a one-row link, or `{ group }` by id. Absent, the owner of the stage it is offered at, or anyone the app is shared with where it stands at none |\n| `workflow` | alias | The workflow it runs for what `set` cannot say: one made under this name, its body set by `set_workflow`, or the app\'s Workflow node, taking the row as `record_id`; the act\'s guards head its body |\n| `template` | alias | A document template it makes a file from: html a PDF, excel a workbook, word a .docx; over several rows, one file of them all, an html paper hands each row its own lists under the names the record\'s paper uses |\n| `templates` | list of [Act template](#act-template) (at least 2) | Several papers made into `into`, instead of `template`: the reader ticks which |\n| `into` | alias | The record\'s files field keeping the document; remade, it replaces its own last paper, never a person\'s file |\n| `paper` | text | Its paper, `<child>.<kind>`: the line of the record\'s papers it stands on |\n| `intake` | alias | A child the record lists whose rows are its papers: the press takes papers, an agent reads them, each filed as a row of it. With `on: "view"`, they make a new record of the List\'s entity, and the save opens it |\n| `fills` | list of text (at least one) | With `intake`, what the papers may fill: a field of the record, `<link>.<field>` on the row a required one-row link names, or a child they add rows to; on a new record that row is found on its entity\'s `natural_key` or added. With `record`, fields of the new row an agent fills from the transcript |\n| `record` | [Recording](#recording) | The press records a call, visit or meeting, filed as a new row of a child the record lists |\n| `sign` | [Signature](#signature) | The press opens a pad; the act keeps the signature as a picture with who signed, when and the witness |\n| `review` | `true` | Lets a person approve what a workflow would write: with `workflow`, it only proposes a changeset of the act\'s table, and the reader ticks the rows to write |\n| `makes` | alias | The rows a record\'s `cadence` still owes of this child: the press lists them, each with what would stop it, and writes the ones ticked. Pressed again it lists only what is missing |\n| `confirm` | `true` \\| text | The press asks first: the question, or `true` for the act\'s label over the row |\n| `danger` | `true` | The act destroys or cannot be undone |\n| `on` | `"ticked"` \\| `"view"` | Which rows an Act over a List works on: `ticked`, those ticked in the List holding it; `view`, every row in view. Every Act a List holds states it, and no other |\n\n#### Asked input\n\n| Key | Type | Meaning |\n|---|---|---|\n| `input` | alias, required | A value the act asks for that is not a field of the record |\n| `label` | text, required | What the reader is asked, in their words |\n| `type` | `"text"` \\| `"long_text"` \\| `"number"` \\| `"date"` \\| `"select"` \\| `"link"` \\| `"member"` \\| `"file"`, required | What the reader states. A `file` is one uploaded file, handed to the act\'s authored `workflow` as its file id and read by nothing else |\n| `options` | list of [Select option](#select-option) (at least one) | The choices a `select` input offers, one picked \u2014 written into a select holding the same option aliases |\n| `entity` | alias | The entity a `link` input picks one row of |\n| `accepts` | list of `"sheet"` \\| `"pdf"` \\| `"document"` \\| `"photo"` (at least one) | The kinds of file a `file` input takes; absent, a sheet, a PDF or a document \u2014 a phone offers its camera only where `photo` is among them |\n| `required` | `true` | The act is refused without it |\n| `default` | alias | A field of the row whose value the input starts from, still changed at will |\n\n#### Set formula\n\n| Key | Type | Meaning |\n|---|---|---|\n| `formula` | text, required | A formula over the acted row\'s fields, `{alias}` each, read as the entity\'s own formulas read them |\n\n#### Act template\n\n| Key | Type | Meaning |\n|---|---|---|\n| `template` | alias, required | A document template made into `into` |\n| `when` | map of alias \u2192 (list of alias (at least one) \\| boolean) | The paper starts ticked while each named select of the record holds one of these options and each named yes/no (stored, or a formula \u2014 how a multi-select is tested: `includes({needs}, {needs:x})`) is this value \u2014 a suggestion the reader changes, never a refusal; absent, it starts ticked |\n\n#### Recording\n\n| Key | Type | Meaning |\n|---|---|---|\n| `into` | alias, required | A child the record lists in a timeline or rows block, linking back by a single link: each recording is a new row |\n| `audio` | alias, required | The child\'s files field the recording\'s audio is kept in |\n| `transcript` | alias, required | The child\'s text field the transcript is kept in, a speaker\'s turn per line |\n| `video` | alias | The child\'s files field the screen is kept in, where the recording captured it |\n| `at` | alias | The child\'s date field stamped with the moment the recording started |\n| `by` | alias | The child\'s member field set to the person who recorded |\n\n#### Signature\n\n| Key | Type | Meaning |\n|---|---|---|\n| `into` | alias, required | The record\'s files field the signature is kept in, as a picture \u2014 each signing replaces the one before |\n| `by` | alias, required | Who signed: a text field the signer types into (someone with no seat), or a member field set to the person pressing |\n| `at` | alias, required | The record\'s date field stamped with the server\'s time as the act runs |\n| `witness` | alias | Beside a text `by`, the member field set to the person pressing, who saw the signer sign |\n\n<!-- generated:end node-act -->\n\nAn Act whose `when` does not hold is not offered. One whose `requires` are empty is offered disabled, naming each; one whose\n`recommends` are empty names what it will leave blank and still presses; one a standing Check blocks is offered disabled in\nits words. The `act_<key>` workflow re-checks all three on the server, writes `set` and what was asked,\nand appends the status history. A field an act both `requires` and `asks` never disables the press. A field an Act `requires` draws in its part with no statement. An Act in a child List may `sign` the row pressed.\n\n- **Writes:** every field it sets, asks, files into, signs or records is the act\'s.\n- **Papers.** A button that makes a paper is `template` (or `templates`) with `into` and no workflow, made from the row as the act left it. `templates` keeps a paper not made yet as a placeholder, and the set downloads as one archive (`archive_<key>`). `into` files the paper in the row\'s own files field, a write of the row its table\'s lock refuses; a `paper` line is a row of its own, made on a locked record. `intake`: what the papers state of each field `fills` names is shown beside what the row holds, and the save writes only what differs. `sign`: the record reads `into` as one signature, and the act\'s paper is handed the picture under `into`\'s name (`{{#each signature}}<img src="{{url}}">{{/each}}` in an html template).\n- **`review: true`:** the workflow (`workflows`) reads and returns a changeset of the act\'s table in `data.review`; the rows the reader ticks are written each checked first, all or none. Over every row in view the act is handed no rows.\n- **A `when` that compares** splits one stage by an amount or a date with no formula field behind it; the server refuses a press the row does not meet, and a blank number or date meets no bound:\n\n```json\n{ "type": "Act", "key": "approve", "label": "Approve", "when": { "status": ["submitted"], "amount": { "lte": 5000000 } }, "set": { "status": "approved" } }\n```\n\n```json\n{ "type": "Act", "key": "gate_in", "label": "Make the gate-in EIR", "template": "eir_in", "into": "eir", "sign": { "into": "driver_signature", "by": "driver_name", "at": "signed_at", "witness": "signed_before" } }\n```\n\n## Check node\n\nA Check is a yes/no or text formula of the row of the Record page it stands in (`pages/<entity>`): it stands while true or non-empty, and a text\nformula\'s words are what the reader sees. Without `on` it only warns; with it, it refuses the saves and acts it names, on\nthe server, in every write it names.\n\n<!-- generated:start node-check -->\n\n| Key | Type | Meaning |\n|---|---|---|\n| `field` | alias, required | A yes/no or text formula of the page\'s entity: true or non-empty means the check stands |\n| `on` | `"all"` \\| list of (`"update"` \\| alias) (at least one) | What the standing check refuses: `update` is the rows\' saves, an Act key is that Act \u2014 on one row, or over a List\'s rows of this entity, or on a record that lists these rows (refused while any row holds the check) \u2014 and `all` is every Act and save; absent, it only warns |\n| `resolve` | alias | An Act on one row of this entity that clears it |\n\n<!-- generated:end node-check -->\n\n`update` is the rows\' saves; an Act key is that Act, on the same rows; `all` is every act and save.\nA rule that refuses a Delete is a check of the table, not a Check: state it in the table\'s `checks` with `on: ["delete"]`\n(`reference/write-rules`), where it holds for every way a row is deleted and a removal that cascades to child rows is refused whole.\nA Check is stated once, on the entity it is true of. Absent `on`, the Check warns where its rows are listed; `on` names the acts it refuses, including an Act of a record that lists its rows (a List bound to it by a link of the rows, keeping them all), refused on the server while any row holds the check, counted over the rows the presser reads (an Act that reads papers or records a call is not among them). A List over rows of an entity with Checks offers one filter of the Checks some of its rows hold, but one that stops their edits or deletes, each with how many; picking one narrows the List to exactly those rows, through the address\'s filter on the check\'s field. `checks: false` offers none.\nA Check stands on each row of its page\'s entity wherever the App lists or opens it \u2014 a root List\'s, a child List\'s, a\nsource\'s \u2014 and refuses the acts and saves it names, an Act over a List\'s rows of the entity included. A warning reading the figure of a meter that `gates` marks against its\nbound or its pass mark is refused: the meter already draws it.\n\nThe check field\'s `label` is its short name \u2014 "Over budget", "Release expired": a row\'s line says it in the check\'s tone\n(the most severe of several, and how many more), while its words whole are the row\'s tooltip. Label it as the reader names\nthe problem, in a few words, and let a text formula say the sentence: the callout over the record says the label, then the sentence after it where it says more. A check with `resolve` carries the first of those Acts the row offers as a button at the end of its line, pressing as the Act itself; one with none links to the first field its formula reads that the record draws.\nA yes/no formula whose yes needs attention (papers the customer still owes) is a Check: its yes reads in the warning tone\nwherever it is drawn, every other yes in the success tone \u2014 and the row\'s line says it, so it is no column of the List too.\n\nA Check that every app over a table states the same way restates the table\'s contract and belongs in the table\'s `checks`\n(`reference/write-rules`).\n\nA Check refusing `update` (or `edit: false` on a record, part or field) makes the rows read-only in this app alone, drawn\nunder the read-only mark, never as a lock. A lock is the table\'s: a table workflow, a person, or an Act whose workflow sets `locked: true` on `update_records` locks a row, and every door refuses its writes until a table manager unlocks it \u2014 `update_records` with\n`locked: false` in an app\'s run is judged as the member who pressed. A locked row reads locked in every app: its lock mark, its fields as values\nunder one line naming who can change it, its saves, Delete and each Act writing it refused \u2014 an Act that writes\nelsewhere, makes a paper it hands back, or unlocks it stays its workflow\'s to answer.\n\n## Reading node\n\nA Reading is a number over rows: one figure, its parts, a grid, a figure per period, steps; or a record\'s own figure. The\npicture is the runtime\'s, chosen from what the reading means \u2014 no prop picks a chart. The question is stated by which\nsplit it names:\n\n| Names | Answers |\n|---|---|\n| nothing | one figure: the rows counted, or `value` summed, `{ "avg": \u2026 }` averaged |\n| `by` | the figure per value of a select, one-row link, member or yes/no, or per band of a number\'s `tiers` |\n| `by` a date field | the figure per period (a trend); `ahead: true` reads forward over the rows still to come |\n| `by` a date field and `across` | the figure per period, each period\'s bar stacked by the values of `across` (a select\'s options in their order, a number\'s bands lowest first) \u2014 counted or summed, never averaged |\n| `by` and `across` | a grid, `by` down the side and `across` along the top |\n| `steps` | a funnel: 2 to 8 number fields summed, each kept as a share of the one before; in a record only |\n| `planned` and `done` | the work against its plan, day by day: a List\'s band over a folder, or a record\'s block, never a Sheet |\n| no `entity`, in a Record | the record\'s own `value`, a tile under its field\'s label; up to eight consecutive tiles draw as one strip |\n\n<!-- generated:start node-reading -->\n\n| Key | Type | Meaning |\n|---|---|---|\n| `key` | alias | The reading\'s query name, unique in the app. Absent, the label\'s words as a slug, else its kind and field, written once and kept |\n| `label` | text | What the figure is called: absent, a split\'s `by` field\'s label, a trend\'s summed `value`\'s (else the rows\'), a grid\'s two fields\'; one figure states its label; with `planned`, always stated |\n| `entity` | alias | The List\'s rows; in a Record, the child\'s rows under it; absent in a Record with no `by`: the record\'s own `value`; with `planned`, the rows that are the parts of the work, always stated |\n| `via` | alias \\| text | The child\'s link to the record, where it has several; in a Record, a figure may state `<link>.<link>`, reaching the record through a row of their own |\n| `value` | alias \\| `{ "avg": alias }` | A number field summed over the rows, or `{ avg }` averaged over the rows holding one \u2014 a row with no number is no part of it, and a part or period where no row holds one reads blank, never 0. An average stands as a figure, per period (`by` a date) or per part (`by` a select, one-row link, member, yes/no or tiered number), never across a grid or beside `on_hand`; its parts add up to nothing: it states no total, and its rest reads the average of all the rows the rest holds. Absent, the rows are counted |\n| `where` | [narrowing](#app-tree) | Only the rows whose select holds one of these options, whose yes/no is this value, whose number or date meets its bounds (`gt`, `gte`, `lt`, `lte`; a date\'s `{ "now": true }` is read when the rows are), whose field is `{ "empty": true \\| false }`, or whose member field holds the reader (`{ "me": true }`) \u2014 every entry ANDed |\n| `by` | alias \\| [Tiered filter](#tiered-filter) | Splits the rows into parts; a date field splits them per period |\n| `across` | alias \\| [Tiered filter](#tiered-filter) | Reads a split against a second field: with `by` a field, the columns of a grid; with `by` a date, what each period is made of, its bar stacked by this field\'s values (counted or summed, never averaged) |\n| `over` | alias | The date that places a row in time |\n| `ahead` | `true` | Shows what is coming, not what has been: with a date `by`, the current period and those after it |\n| `steps` | list of alias (2\u20138) | Number fields summed, each a step of a funnel |\n| `on_hand` | [Reading on hand](#reading-on-hand) | With `by` (and `across`): the Reading\'s rows are what is owed, per value of those fields; drawn beside what is on hand per the same values, and the shortfall |\n| `target` | number | The number the figure is read against; absent, its bound, where the table states one |\n| `better` | `"up"` \\| `"down"` | Which way is good, for the figure\'s tone; absent, read from the figure\'s shape |\n| `planned` | [Reading planned](#reading-planned) | The days each row\'s work is planned over, its share planned spread evenly across them \u2014 a row missing either is no part of the plan, and neither line counts it |\n| `done` | alias | With `planned`, the work against its plan: a percent field of the row the server computes, its share done today (0\u2013100) |\n| `finished` | alias | A date of the row: the day its work was finished, from which it stands at its `done` |\n| `tab` | alias | The Tab it reads, else the open one |\n| `when` | [condition](#app-tree) | Drawn only while this holds |\n\n#### Reading on hand\n\n| Key | Type | Meaning |\n|---|---|---|\n| `entity` | alias, required | The entity whose rows are what is on hand, all of them |\n| `value` | alias | A number field summed over those rows; absent, the rows are counted |\n| `by` | alias | The field of this entity matching the Reading\'s `by`; absent, the same alias |\n| `across` | alias | The field of this entity matching the Reading\'s `across`; absent, the same alias |\n| `where` | [narrowing](#app-tree) | Only the rows whose select holds one of these options, whose yes/no is this value, whose number or date meets its bounds (`gt`, `gte`, `lt`, `lte`; a date\'s `{ "now": true }` is read when the rows are), whose field is `{ "empty": true \\| false }`, or whose member field holds the reader (`{ "me": true }`) \u2014 every entry ANDed |\n\n#### Reading planned\n\n| Key | Type | Meaning |\n|---|---|---|\n| `start` | alias, required | A date of the row: the first day of its planned work |\n| `end` | alias, required | A date of the row: the last day of its planned work |\n\n<!-- generated:end node-reading -->\n\n#### Kinds of reading\n\n<!-- generated:start reading-kinds -->\n\n| Kind | What it is |\n|---|---|\n| `metric` | A metric is one number over an entity\'s rows: how many, or the sum or average of a number field. It is read against a target, or against the bound its `limits` states; placed in time by `over`, it shows its change over the recent periods and which way is good (`better`). |\n| `breakdown` | A breakdown splits an entity\'s rows into parts: each row is counted, or its number summed or averaged, under the one value of the field it is split by \u2014 a select\'s option, a linked row, a person, yes or no \u2014 or under the band of a number cut by `tiers`. |\n| `trend` | A trend counts an entity\'s rows, or sums or averages a number of them, per period of the date that places each row in time (`over`) \u2014 the periods up to today, or with `ahead` the current one and those after it, over the rows dated today or later; with `split`, each period\'s count or sum stacked by the values of one field. |\n| `pivot` | A pivot crosses two splits in a grid: each row of the entity is counted, or its number summed, under the pair of values it holds \u2014 one down the side (`rows`), one across the top (`columns`). |\n| `shortfall` | A shortfall sets what is still owed against what is on hand: the owed rows are counted, or a number of them summed, per value of the fields they are for (`by`, and `across`), beside every row of the stock (`on_hand`) matching those fields, with what falls short. |\n| `progress` | A progress reads the work against its plan: each row is a part of the work, planned over the days between two of its dates and done by a share the server computes, set against the plan day by day. Each row weighs its planned days. |\n| `list` | A list shows an entity\'s rows, each in its `records` anatomy \u2014 its title, its line, its status \u2014 with the fields read after the title (`columns`). |\n\n<!-- generated:end reading-kinds -->\n\nWhere a Reading stands decides which rows: a Sheet\'s every row, a List\'s rows in its open tab and folder (the search,\nthe status and the filters narrow the rows and leave the figures as they stand), a Record\'s the child\'s rows under the record. A Reading counts its rows, or sums the number\n`value` names \u2014 never a percent. `over` is a date, the row\'s own or its parent\'s through a lookup: a trend\'s periods, a\nfigure\'s recent periods, and what a Sheet\'s period windows. `where` keeps rows whose select holds one of the options, or\nwhose yes/no is the value, every entry ANDed \u2014 a band leads with the job\'s exception as a formula\'s yes/no (what is\nshort), never a stage the chips already count nor the overdue rows the register\'s summary line counts from `records.due`.\n\n- **A figure\'s change** is green where it moves the good way: a sum\'s rise, a count kept by `where` falling; `better` states\n the other way where that reads wrong (money going out). A value `limits` bounds reads against the sum of its bound\n (`10 / 14`); `target` reads one against a number nothing bounds.\n- **An average** is its sum over the rows that hold a value, divided by how many hold one; a row holding none is no part\n of it, and where none holds one the figure reads a dash, never 0. Under a Sheet\'s period it is the average over the\n period so far, never a sum of averages. A share is an average too: a number formula that is `100` on the rows that count\n and `0` on the others, in percent notation, averaged. Only a single figure averages.\n- **Bands.** `by` and `across` each take, in place of a field, a number by its `tiers` \u2014 `{ "field", "tiers" }` \u2014\n splitting the rows by the bands those breakpoints cut: `[1, 31, 61]` over days late reads not due, 1\u201330, 31\u201360 and over\n 60, the aged report. Every band is drawn in the bands\' own order, one holding no row at zero; rows holding no number\n stand apart. On a List a band is a door: a press narrows the rows to it. In a List\'s band, a split by one or two\n breakpoints stands in it, and one by three or more stands whole under it.\n- **In a List,** Readings stand under the title in one compact band: the job\'s headline number first, then at most the mix\n and the movement. A picture stands only where it splits the rows in view into two parts or more, one holding two rows or\n more. The summary line already totals the figure and the chips count the rows, so a figure summing the figure, or counting\n the rows of a table with a stage, is refused unless its `where` narrows it.\n- **Name.** A Reading\'s `key` is the query it is read by (`run_app_query`).\n- **The work against its plan** (`planned` and `done`, `label` and `entity` stated) takes none of a figure\'s props: the\n share of the work planned and the share done, cumulative day by day, today\'s two at its foot. Each row is a part of the\n work, its plan spread evenly over its planned days and weighing its planned days. Its share done today is `done`, a\n percent the server computes; on an earlier day, its `done` from its `finished` day on and nothing before it.\n\n## Statement node\n\nA Statement draws a figure the record works out from its own figures \u2014 a claim\'s payable, an invoice\'s total, a payslip\'s\nnet \u2014 line by line in the order the arithmetic runs: each line a number of the record, the first stating no `op`, the last\nan `equals`. Every figure is a field the server computes or a person writes; the screen adds nothing up. A line\'s `parts`\nlists the rows its figure carries, each read from its own row, and that figure is what they add up to \u2014 a formula, rollup\nor lookup, or the server\'s copy when the record is made (`default_from`), which nothing writes after.\n\n<!-- generated:start node-statement -->\n\n| Key | Type | Meaning |\n|---|---|---|\n| `key` | alias | The statement\'s name, unique among its siblings. Absent, the label\'s words as a slug, written once and kept |\n| `label` | text | What the statement is called: absent, the label of what it comes to |\n| `lines` | list of [Statement line](#statement-line) (at least 3), required | The figures it is built from, top to bottom, ending in the one it comes to |\n| `when` | [condition](#app-tree) | Drawn only while this holds |\n\n#### Statement line\n\n| Key | Type | Meaning |\n|---|---|---|\n| `field` | alias, required | A number of the record \u2014 stored, a formula, a rollup or a lookup \u2014 read on the line after its label |\n| `op` | `"plus"` \\| `"minus"` \\| `"times"` \\| `"equals"` | How the line works on the lines above it \u2014 `plus`, `minus`, `times`, or `equals` for what they come to, a formula, rollup or lookup the server computes; absent on the first line, which the rest work from |\n| `rate` | alias | A percent of the record read after the line\'s label: the rate its figure is taken at (retention at 5 %) |\n| `parts` | [Statement parts](#statement-parts) | The rows the line\'s figure carries, each listed under it with its words and its own figure \u2014 read from those rows, never a copy of them. The line\'s figure is what they add up to, drawn read: a formula, rollup or lookup, or a value the server copies when the record is made (`default_from`) that nothing writes after |\n\n#### Statement parts\n\n| Key | Type | Meaning |\n|---|---|---|\n| `rows` | alias, required | The entity whose rows the line\'s figure carries \u2014 the record\'s own for the earlier rows of the same thing |\n| `same` | alias, required | A one-link the record and those rows both hold: the rows naming what the record names in it |\n| `at` | alias | A moment (a datetime) of those rows no person keys \u2014 when each was certified: with `before`, only the rows whose moment stands before the record\'s, earliest first; absent with it, every row so named, in their own order |\n| `before` | alias | A moment (a datetime) of the record no person keys \u2014 when it was made: the moment the rows\' `at` stands before; stated with `at` |\n| `where` | map of alias \u2192 (list of alias (at least one) \\| boolean \\| `{ "empty": true \\| false }` \\| [comparison](#values)) | Only the rows whose single select holds one of these options, whose yes/no (stored, or a formula) is this value, whose number or date meets its bounds, or whose field is empty or filled \u2014 read so on the server |\n| `columns` | list of alias (1\u20132), required | The rows\' fields read as each one\'s words, in order (its date, its percent) |\n| `figure` | alias, required | The rows\' number each one reads at the figures\' edge, frozen when the row was certified: a stored number an act fills (`{ "formula": \u2026 }` as it runs) or the server copies when the row is made (`default_from`) \u2014 never one a person keys, nor a formula, rollup or lookup the server recomputes |\n\n<!-- generated:end node-statement -->\n\n```json\n{\n "type": "Statement",\n "key": "claim",\n "lines": [\n { "field": "contract_value" },\n { "field": "done_to_date", "op": "times" },\n { "field": "value_to_date", "op": "equals" },\n { "field": "certified_before", "op": "minus", "parts": { "rows": "claim", "same": "contract", "at": "certified_at", "before": "made_at", "where": { "kind": ["work"] }, "columns": ["claimed_on", "done_to_date"], "figure": "certified_value" } },\n { "field": "claim_value", "op": "equals" },\n { "field": "retention", "op": "minus", "rate": "retention_rate" },\n { "field": "payable", "op": "equals" }\n ],\n "when": { "kind": ["work"] }\n}\n```\n\n## Export node\n\nAn Export is a report file of the rows in view: the title, a line per chip, the search and the moment it was exported, the\nReadings, and every row, at most 20,000. With no props, the one Export is the workbook of the List\'s columns, the Readings\non a sheet before the rows. A List states the reports the business sends \u2014 one a button, several one menu \u2014 each a `label`,\na `description`, and a `template` filled with `title`, `lines`, `readings`, `at` (the moment it was made), `dates` (each\ndate filter\'s `from` and `to` by field) and the rows under the table\'s alias (an html one made a PDF, an excel one a\nworkbook). A report\'s `filename` names its file in the template grammar over the same keys but the rows. Where `per` is a\none-row link, `per_row.<field>` reads a text, number, date or yes/no field of the picked row, and `| add_days:<n>` shifts a\ndate by whole days (`n` a number or such a field, empty for none): `Stock {{per}} {{period.to | add_days:per_row.day_offset | format:"dd.MM.yyyy"}}`. A report of some\nrows (`where`), or of one value the reader picks (`per`: one file per value), is made of the List as those chips would\nnarrow it; the screen keeps the chips and rows it shows. A report sent outside the business \u2014 a partner\'s stock, a\nfiling \u2014 is `fixed`: the same file from every screen and device, of what the reader narrowed only the period and the\ndate chips reaching it, never their status, other chips or search.\n\nProve an Export with `run_app_query` and `export` (`agent_surface/exporting-a-file`): the answer is the file it makes.\n\n<!-- generated:start node-export -->\n\n| Key | Type | Meaning |\n|---|---|---|\n| `key` | alias | The report\'s name, unique in the app. Absent, the label\'s words as a slug, written once and kept |\n| `label` | text | The report\'s name; absent on the one Export that stands for the register\'s workbook |\n| `description` | text | What the report is for, in a sentence |\n| `template` | alias | An html or excel document template the report fills, with `title`, `lines`, `readings`, `at`, `dates`, `period`, `per` and `per_row` (a one-row `per`\'s picked row, the fields `filename` reads); absent, the workbook of the List\'s columns |\n| `filename` | text | The file\'s name, at most 500 characters, in the template grammar, over one value each: `title`, `at`, `dates.<field>.from` or `.to`, `period.from` or `.to`, `per`, `per_row.<field>` (a text, number, date or yes/no field of the row a one-row `per` picks), `lines \\| lookup:<n>`; `\\| add_days:<n>` shifts a date by whole days, `n` a number or `per_row.<field>`. Absent, the report\'s label |\n| `where` | [narrowing](#app-tree) | Only the rows whose select holds one of these options, whose yes/no is this value, or whose member field holds the reader (`{ "me": true }`) \u2014 every entry ANDed |\n| `per` | alias | A select, member or one-row link the reader picks one value of: one file of that value |\n| `sources` | list of alias (at least one) | Of the List\'s entity and its sources, the tables the report reads; absent, all |\n| `fixed` | `true` | The same file from every screen: only its `where`, its `per`, the period and the date chips narrow it, never the reader\'s status, other chips or search; absent, the rows in view |\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `list.export-report` | A List\'s Exports each have their own `label`; `per` picks one option, person or one-link row \u2014 never of the status, the folder or a field its `where` fixes. |\n| `list.export-key` | An Export is named by its key alone: no two Exports of an app share one. |\n| `list.export-filename` | An Export\'s `filename` is words and `{{value}}` placeholders, each value one of `title`, `at`, `dates.<field>.from` or `.to` (a date filter of the List), `period.from` or `.to` (a List with Tabs), `per`, `per_row.<field>` (a field of the row a one-link `per` picks) and `lines \\| lookup:<n>`, through helpers that exist and take the arguments given. |\n| `list.export-template` | A template an Export fills is an html or an Excel one (a Word register stays a workflow body) and reads at its root only `title`, `lines`, `readings`, `at`, `dates`, `period`, `per`, `per_row` (and `columns`, on a roster) and its rows under the List\'s entity alias \u2014 an entity named none of those \u2014 and is the document of no Act. |\n\n<!-- generated:end node-export -->\n\n## Query node\n\nA Query is a read for agents, never drawn. An app generates a query for everything its screen reads (`agent_surface` lists them); a Query declares one the screen never asks, called through `run_app_query` or the app\'s API: the\ntable whose rows it reads, the fields each row returns, and what narrows them.\n\n<!-- generated:start node-query -->\n\n| Key | Type | Meaning |\n|---|---|---|\n| `description` | text, required | What the query answers, read by whoever calls it by its alias \u2014 at most 300 characters |\n| `params` | map of alias \u2192 ([Workflow value](#workflow-value) \\| a typed input (`app_bindings`)) | What a call states, by name: with `rows` or `list`, values a `where` entry reads; with `ast`, typed inputs the ast reads as `{{params.<name>}} |\n| `fields` | list of alias (at least one) | The fields each row returns, by alias: with `rows` or `list`. `ast` states its own |\n| `sort` | [Sort key](#sort-key) \\| list of [Sort key](#sort-key) (at least one) | The order the rows return in; absent, the order the entity\'s list reads in |\n| `limit` | integer | The most rows returned |\n| `key` | alias, required | The query\'s name, what `run_app_query` calls; unique in the app |\n| `rows` | alias | The table whose rows it reads, under the app\'s row rule of it and, where the table holds one one-row link to the App\'s `scope`, inside the folder the call states. A Query states `rows`, `list` or `ast`, one of the three |\n| `list` | alias | The key of a root List of the App: the rows read as that List reads them \u2014 its `where`, its folder and its order. A Query states `rows`, `list` or `ast`, one of the three |\n| `ast` | a query tree (`app_bindings`) | The whole read, where `rows` or `list` cannot state it: a join, a union, a group, a window or a computed column. Fields and tables by alias |\n| `templates` | map of text \u2192 a document template (`app_bindings`) | Document templates an export of this query\'s rows may fill, by the name the export asks for. An export names one of these or none; a template it does not declare is refused. |\n| `where` | map of alias \u2192 [condition](#query-node) | What narrows the rows, as a List\'s `where` does: a select\'s options, a yes/no\'s value, a number or date meeting its bounds (`gt`, `gte`, `lt`, `lte`), a field `{ "empty": true \\| false }`, `{ "me": true }` on a member field \u2014 or a value the call states (`{ "param": name }`), or a date or number range of params (`{ "from": \u2026, "to": \u2026 }`) |\n\n#### Query param\n\n| Key | Type | Meaning |\n|---|---|---|\n| `param` | text, required | A param of this query: the condition holds what the call states for it, and is left out where the call states none |\n\n#### Query range\n\n| Key | Type | Meaning |\n|---|---|---|\n| `from` | [Query param](#query-param) | The param the field is on or after \u2014 a date\'s first day, a number\'s least |\n| `to` | [Query param](#query-param) | The param the field is on or before \u2014 a date\'s last day, a number\'s most |\n\n<!-- generated:end node-query -->\n\n```json\n{\n "type": "Query",\n "key": "fees_unbilled",\n "description": "A customer\'s fees no invoice covers yet, oldest first.",\n "params": {\n "customer": { "type": "record_link", "entity": "customer", "description": "The customer whose fees are read." },\n "since": { "type": "date", "required": false, "description": "Only fees charged on or after this day." }\n },\n "rows": "fee",\n "fields": ["visit", "service", "amount", "charged_on"],\n "where": { "billed": false, "customer": { "param": "customer" }, "charged_on": { "from": { "param": "since" } } },\n "sort": { "field": "charged_on" },\n "limit": 200\n}\n```\n\nAn entry of `where` holds what a Reading\'s `where` holds, or a value the call states: `{ "param": "<name>" }`. A required\nparam is always stated; one stating `required: false` may be left out, and the condition reading it then narrows nothing.\nA query reads under its table\'s read scope, as every read of the app does. A caller counts, sums or averages its rows\nwith `run_app_query`\'s `aggregate`. `set_app` compiles a Query with the rest of the app: no code is set.\n\nEvery Reading of the app is a query too, returning its groups, called by its key. A Tab\'s `totals` read is called by\n`<table>_totals_<tab>` with the period\'s two days, `from` and `to`, both required.\n\nA query reads one table: on an app whose List reads `sources`, it names a source\'s own table, never the\nList\'s. A param compares a field holding one value \u2014 or, as a range, a date or a number \u2014 and never a number read in each\nrow\'s own unit or currency, nor a date holding a span.\n\n## Workflow node\n\nA Workflow is a verb for agents, never drawn: a job no press of the screen starts \u2014 an agent or a service handing the app a\nfile, or a list of rows to reconcile a table against. It states what it takes and what it hands back; a table is named by\nits alias in `tables` and a select by `<table>.<field>`. It is called through the app, by `run_app_workflow` or the app\'s\nAPI. On an app shared by a public link it runs only for someone who holds the app, and a visitor\'s call is refused as an\nalias the app does not have.\n\n<!-- generated:start node-workflow -->\n\n| Key | Type | Meaning |\n|---|---|---|\n| `description` | text, required | What the workflow does, read by whoever calls it by its alias \u2014 at most 300 characters |\n| `inputs` | map of text \u2192 [Workflow value](#workflow-value) | What a call hands it, by name \u2014 checked before its body runs |\n| `outputs` | map of text \u2192 [Workflow value](#workflow-value) | What its body returns as `data`, by name \u2014 checked as it returns; absent, read off the body |\n| `key` | alias, required | The workflow\'s name, what `run_app_workflow` calls; unique in the app |\n\n#### Workflow value\n\n| Key | Type | Meaning |\n|---|---|---|\n| `type` | `"text"` \\| `"number"` \\| `"boolean"` \\| `"date"` \\| `"datetime"` \\| `"email"` \\| `"json"` \\| `"record_link"` \\| `"select"` \\| `"member"` \\| `"file"` \\| `"object"` \\| `"array"`, required | What the value is |\n| `description` | text | What the value is for, read by whoever calls the workflow |\n| `required` | boolean | Lets a caller leave the value out: false; absent or true, it is always there |\n| `multi` | `true` | A `record_link`, `select`, `member` or `file` holding several |\n| `entity` | alias | The entity a `record_link` names a row of |\n| `field` | text | `<entity>.<field>`: the select field whose options a `select` takes, as the field holds them when the workflow runs |\n| `options` | list of (alias \\| [Select option](#select-option)) (at least one) | The values a `select` takes, where no field holds them: aliases, or the objects a field\'s `options` take |\n| `fields` | map of text \u2192 [Workflow value](#workflow-value) | An `object`\'s values, by name |\n| `items` | [Workflow value](#workflow-value) | What each item of an `array` is |\n\n<!-- generated:end node-workflow -->\n\n```json\n{\n "type": "Workflow",\n "key": "reconcile_fees",\n "description": "Reconciles a visit\'s fees against the lines of the carrier\'s statement.",\n "inputs": {\n "visit": { "type": "record_link", "entity": "visit" },\n "statement": { "type": "file", "required": false },\n "lines": { "type": "array", "items": { "type": "object", "fields": { "service": { "type": "select", "field": "fee.service" }, "amount": { "type": "number" } } } }\n },\n "outputs": { "added": { "type": "number" }, "changed": { "type": "number" } }\n}\n```\n\nIts code is set on the app, never stated in the tree: `set_workflow` with a `source` whose `on({ type: "app", app_id, alias })` header names the app and the key, leaving\n`inputs` and `outputs` out \u2014 the code is checked against what the node declares. Every `set_app` keeps that code and holds\nwhat it takes, what it hands back and its description to the node. `set_app` keeps the code where it still meets a change\nof what the workflow takes or hands back; a change it does not meet is refused unless the same `set_app` carries the new\ncode in `workflows`, each as `set_workflow` takes it. With no code yet it refuses every call, and each `set_app` says so. A\nWorkflow the tree stops declaring is archived with its key.\n\n## Tasks\n\nA table whose `records` states `"task": true` \u2014 its status a stored select with `closed` \u2014 is work someone finishes.\nEvery List of its rows draws it alike, each row led by a ring. Ticking the ring moves the row to a closed option by the\none write the app already has for that move: the Act of that table setting a closed option, offered on an open row and\nasking nothing, else its own save where people write the status \u2014 stamping what that act stamps and appending the\nstatus history. Unticking runs the Act moving a closed row back, else the save back to the status\'s default. A move no\nwrite reaches leaves the ring disabled and the check notes it. An Act with `on: "ticked"` completes several at once.\n\nA record listing task rows filed under it by a link holding one row says how much of that work is done \u2014 those at a\nclosed option of all \u2014 wherever its row is drawn: a meter on its head, a column of its register\'s rows, a card\'s foot, a\ncalendar entry, a gantt\'s or a lane\'s bar. No rollup is stated for it.\n\n```json\n{\n "tables": [\n {\n "ref": "project",\n "label": "Projects",\n "singular": "Project",\n "fields": {\n "name": { "label": "Name", "required": true, "type": "text" },\n "lead": { "label": "Lead", "type": "member" }\n },\n "title": "name",\n "records": {}\n },\n {\n "ref": "task",\n "label": "Tasks",\n "singular": "Task",\n "fields": {\n "title": { "label": "Title", "required": true, "type": "text" },\n "project": { "label": "Project", "required": true, "type": "link", "table": "project", "multi": false },\n "assignee": { "label": "Assignee", "type": "member" },\n "status": {\n "label": "Status",\n "required": true,\n "default": ["todo"],\n "type": "select",\n "options": [\n { "alias": "todo", "label": "To do", "color": "slate" },\n { "alias": "done", "label": "Done", "color": "green" }\n ]\n },\n "due": { "label": "Due", "type": "date", "format": "date" },\n "done_on": { "label": "Done on", "type": "date", "format": "date" }\n },\n "title": "title",\n "records": {\n "subtitle": ["assignee"],\n "due": ["due"],\n "task": true,\n "starts": { "assignee": "me" },\n "status": { "field": "status", "closed": ["done"] }\n }\n }\n ]\n}\n```\n\n```json\n{\n "body": {\n "type": "App",\n "key": "projects",\n "name": "Projects",\n "color": "blue",\n "tables": { "project": "<id of the project table>", "task": "<id of the task table>" },\n "templates": {},\n "children": [\n {\n "type": "List",\n "entity": "project"\n }\n ],\n "pages": [\n {\n "type": "Record",\n "entity": "project",\n "children": [\n {\n "type": "Section",\n "key": "work",\n "title": "Work",\n "children": [\n "lead",\n {\n "type": "List",\n "entity": "task",\n "columns": ["due"],\n "children": [\n { "type": "Act", "key": "complete_all", "label": "Complete", "on": "ticked", "when": { "status": ["todo"] }, "set": { "status": "done", "done_on": { "now": true } } }\n ]\n }\n ]\n }\n ]\n },\n {\n "type": "Record",\n "entity": "task",\n "children": [\n { "type": "Act", "key": "complete", "label": "Complete", "when": { "status": ["todo"] }, "set": { "status": "done", "done_on": { "now": true } } },\n { "type": "Act", "key": "reopen", "label": "Reopen", "when": { "status": ["done"] }, "set": { "status": "todo", "done_on": null } }\n ]\n }\n ]\n }\n}\n```\n\nThe tasks as a register of their own, for one person: a one-part Record holds its Fields and Acts directly.\n\n```json\n{\n "body": {\n "type": "App",\n "key": "my_tasks",\n "name": "My tasks",\n "color": "teal",\n "tables": { "project": "<id of the project table>", "task": "<id of the task table>" },\n "templates": {},\n "children": [\n {\n "type": "List",\n "entity": "task",\n "opens": { "assignee": { "me": true } },\n "children": [\n { "type": "Reading", "label": "Open", "where": { "status": ["todo"] } }\n ]\n }\n ],\n "pages": [\n {\n "type": "Record",\n "entity": "task",\n "door": "drawer",\n "children": [\n "project",\n "due",\n { "type": "Act", "key": "finish", "label": "Finish", "when": { "status": ["todo"] }, "set": { "status": "done", "done_on": { "now": true } } },\n { "type": "Act", "key": "undo", "label": "Undo", "when": { "status": ["done"] }, "set": { "status": "todo", "done_on": null } }\n ]\n }\n ]\n }\n}\n```\n\n## App rules\n\nEvery rule the check enforces over an app, one sentence each under an id; a finding names its rule\'s id\n(`[list.filter]`), and `reference/<rule id>` is that one rule\'s page. A sentence names the node and the prop an author writes (`List.create`, a `Section`);\neach area stands in the tree where this table says:\n\n| Area | Stands at |\n|---|---|\n| `app` | what every write meets (the tree\'s keys, the names it declares, the tables and rows it carries), the App, and the register List\'s props that belong to the app: `words` (labels), `color`, `scope`, sources, the root Views |\n| `template` | the document templates an Act makes and an Export fills |\n| `list` | a List: its columns, filters, search, group, sort, layout, tabs, period, export, and what a child List holds |\n| `reading` | a Reading |\n| `record` | a Record and its parts: Section, Side, Act placement |\n| `statement` | a Statement |\n| `act` | an Act |\n| `check` | a Check |\n\n<!-- generated:start rules-app -->\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `app.schema` | Every key is one its table lists, holding the type its row gives, and every required key is stated. |\n| `app.names-declared` | Every alias a key names is declared: a table of the App\'s `tables`, a field of the table the node reads, an option of the select it names, an Act `key` of the App, a template of its `templates`, or an app. |\n| `app.record-home` | A Record stands in the App\'s `pages`, never inside a List: one page per entity, opened from the Lists over it. |\n| `app.spec-claims` | Every workflow a tree\'s screens run is one the app binds, taking each input the screens send. |\n| `app.spec-sound` | The app a tree compiles to reads every column its screens draw and carries what each needs: a tree refused for it meets a fault of the platform\'s, which is reported, and no change to the tree is owed. |\n| `app.compile-lowers` | Every screen, read and write a tree states lowers to the app\'s spec: a tree the compiler cannot lower is refused at the App. |\n| `app.tables` | A call declares at least one table and at most 50; send the rest in a second call. |\n| `app.rows-cap` | Rows are a sample: at most 200 per entity, 2000 per call and 2000 documents attached \u2014 a real data set goes in with `create_records` once the tables exist. |\n| `app.alias-scope` | An alias is unique where it is named: tables and fields in their table, options in their select. |\n| `app.label-unique` | A label is unique where it is found by its label: fields in their table, options in their select. |\n| `app.filter` | A filter \u2014 a view\'s, a rollup\'s \u2014 tests fields of the entity it reads, through links as `entity.field` hops each standing on the entity the last lands on, by options its select declares. |\n| `app.input-once` | The fields the App\'s saves, adds and Acts of a table send are each sent under one input name: a files or many-link field is sent as `<alias>_added` (and `<alias>_removed` by a save or an Act), so no other field of the write is so named, and none takes an input the workflow names itself, such as `record_id`, the input naming the row. |\n| `app.alias-unique` | An App\'s `key` is unique among apps, and an Act\'s among the Acts of its App, every List\'s included. |\n| `app.icon` | An App\'s `icon` is a Lucide icon name in kebab-case, as `receipt` or `trending-up` are. |\n| `app.add-label` | A List\'s `add_label` stands only where it adds rows (`create`), in words that are not empty and hold no `{` or `}`. |\n| `app.labels` | An App\'s `words` name a table it reads and a field or option of it, in words that are not empty and hold no `{` or `}`; no two fields of a table, nor two options of a field, show the same words. |\n| `app.records-entry` | Every table an App draws a List over, opens or picks from \u2014 a root List\'s, a child List\'s, a linked row\'s, a documents List\'s \u2014 has a `records` entry. |\n| `app.scope` | The App\'s `scope` names the table whose one row the app works inside (the folder), a table whose row rule can bind; every List over a table linking to it is filed in the open folder (`list.scope`). Stated again on such a List as a `columns`, `filters` or `search` entry, `group`, `where`, `opens`, a Field of a part, a `create` question or a report\'s `where` or `per`, its folder link is left out and said: the App already narrows every read to it and files every add under it. |\n| `app.folders` | The App\'s `folders` names a root List over the table its `scope` names: that List draws the folders the app opens on, and a row pressed is the folder entered. |\n| `app.when` | A node\'s `when` holds single selects to options, yes/nos to `true` or `false` (stored, a formula of one \u2014 a formula with `options` is a select \u2014 or, offering a node, a lookup through a link to one row), numbers and dates to bounds (`gt`, `gte`, `lt`, `lte`; a date\'s bound is a day, a moment on a datetime, or `{ "now": true }`) and any field but a yes/no to `{ "empty": true \\| false }` \u2014 a number read in each row\'s own unit or currency takes only the bound 0, and a lookup takes none. |\n| `app.asked-written` | What a List\'s `create` asks, what an Act\'s `asks` asks and what `starts` fills is a field a person writes \u2014 never a formula, rollup, lookup, autonumber or a date the workspace stamps. |\n| `app.own-rows` | A many-link to rows that each belong to one row of this entity is never a `create` question or an Act\'s `asks`: those rows are the record\'s own, each written by its own write. |\n| `app.create-asks` | A List\'s `create` asks fields a person writes \u2014 never the link or the folder it files the row under, which the add sets itself. |\n| `app.create-required` | A List\'s `create` asks every field its entity requires that nothing else fills \u2014 a `default`, `starts`, the record or folder it files the row under, or a `default_from` over a link it fills \u2014 or the server refuses every add. |\n| `app.row` | A Record\'s `row` states only what differs from `records`: a `subtitle` that is not the title, a number for its `figure`, dates for its `due`, an `image` that is a files picture no Act makes documents into, or `false` for a figure, deadlines or picture the entity states and the App draws none of. `row` changes what the head draws, never what the App writes (`record.edit-declared`). |\n| `app.restates` | *Noted, never refused:* A key the tree states that the platform sets the same without it \u2014 a `label` the table\'s or field\'s own, a `row.subtitle` the table\'s, a `door`, an add or a layout end the default gives, a row rule a status history inherits \u2014 changes nothing: the write keeps it and says so. |\n| `app.tasks` | *Noted, never refused:* A task entity an App lists whose rows no write of the App moves to a closed option (its ring stands disabled), or that an Act ticks done and none moves back. |\n| `app.same-list` | *Noted, never refused:* A root List over a table another App of the workspace lists at its root. Unnarrowed, every reader sees the same list, and a row\'s rail shows only that app\'s parts, so no one sees the whole path. A different job narrows with `where` and `columns`; a shared job stays one app, `owner` on its Acts and stages deciding who presses. |\n| `app.views-jobs` | *Noted, never refused:* An App of more than two Views, or a Sheet of more than six Readings, asks whether each is a job someone does on its own: Views of one job read better as one List\'s filters, tabs or Readings, and a Sheet reads at a glance with few. |\n| `app.workflow-value` | A value a Workflow takes or hands back states what its type needs and nothing another type does: a `"record_link"` its `entity`, a `"select"` its `options` or the `field` holding them \u2014 never both \u2014 an `"object"` its `fields`, an `"array"` its `items`; `multi` stands on a `"record_link"`, `"select"`, `"member"` or `"file"`; an output is never a `"member"` or a `"file"`; and a value nests at most 8 deep. |\n| `app.query` | A Query reads `rows` of one table \u2014 under the App\'s row rule of it and inside the open folder where the table holds one one-row link to the App\'s `scope` (one holding several is read through `list`) \u2014 or a root List\'s rows as that List reads them (`list`: its `where`, folder and order; never a List reading `sources`), one of the two; it returns them as `fields`, ordered by `sort` and bounded by `limit`; each param is a number, a yes/no, a date, a select, a one-row link or a member holding one, read by an entry of `where` on a field of its type \u2014 a date by a range, a number by either, and never a number read in each row\'s own unit or currency or a date holding a span. |\n| `app.generated-name` | A name the App makes is taken by nothing the App states: no Query, Workflow, Reading or List `key` is the name of a read or a workflow the App makes, an Act\'s own `workflow` among them; where the App makes two reads spelled alike, the later takes the next free ordinal (`_2`, `_3`). |\n| `app.surface-described` | *Noted, never refused:* A value a Workflow takes, and a param a Query takes, that states no `description`: the one line a caller reads to fill it. |\n| `app.keys-unique` | No two children of one node share a key: an address names one node. |\n| `app.states-list` | An App states a List whose rows it lists, only Sheets of Readings, or only Queries and Workflows for a server to call. |\n| `app.period` | An App\'s `period` is the window every Sheet opens on, so it stands in an App that holds a Sheet: a List states its own `period`. |\n| `app.dashboard-words` | An App that holds Sheets and no List reads every table\'s rows whole and states no `words` or `scope`: those are an App with a List\'s. |\n| `app.entity-once` | The App\'s Lists and their sources work a table one way: its rows ticked as tasks by the same moves, and their work counted by the same kinds of task rows. |\n| `app.add-filed` | The Lists adding rows of one table file them by one link: where two Lists add them by different links, each is refused naming the other\'s \u2014 state `create: false` on every List but the one whose link files them. Wrong: a List adding `booking` rows filed by `freelancer` beside one filed by `production`. Right: one states `create: false`. |\n| `app.adds-field` | A picker\'s `add` names fields of its table a person writes, each once. |\n| `app.edits` | *Noted by the designer on a write, never refused:* The fields an app\'s saves may change are the fields its surfaces write \u2014 a record\'s save, a child row\'s, an in-place column, a lane, gantt or plan move \u2014 less what its own Acts change; the designer notes an app whose saves change none. |\n\n<!-- generated:end rules-app -->\n\n## Reading rules\n\n<!-- generated:start rules-reading -->\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `reading.value` | A Reading sums a number, never a percent \u2014 percents do not add up; a value of `{ avg }` reads one. |\n| `reading.average` | `{ avg }` averages a Reading\'s `value` over the rows holding one, read against a plain `target` \u2014 never a value `limits` bounds, whose bound is a sum. |\n| `reading.split` | `by` and `across` split by one value each row holds \u2014 a single select, a one-row link, one member or a yes/no, stored or a formula, a lookup through one-row links as the field it reads \u2014 or by the bands `tiers` cut a number read in one unit on every row; a date `by` splits them per period, as a trend, each period stacked by `across` where it states one; a grid crosses two different fields. Never by the select that sets the unit or currency of the number summed: its figure already reads once per unit. |\n| `reading.over` | `over` is a date: the row\'s own, stored or a formula, or its parent\'s through a lookup over a one-row link. |\n| `reading.where` | A reading\'s and a Query\'s `where` keep rows by a select\'s options, a yes/no\'s `true` or `false`, a number or date\'s bounds (`gt`, `gte`, `lt`, `lte`; a date\'s `{ "now": true }`), `{ "empty": true \\| false }`, or a member field, a lookup of one, or a member of the row a one-row link names (`<link>.<member>`), holding the reader (`{ "me": true }`); a List\'s `where` also keeps rows by `<link>.<field>`, a select or yes/no of the row a one-row link names; a Query\'s `where` also holds a field to what the call states (`param`, `from`, `to`). |\n| `reading.target` | `target` reads a value nothing bounds \u2014 a value `limits` bounds reads against the sum of its bound. |\n| `reading.better` | `better` needs `over`: a change is read over the periods its date places the rows in. |\n| `reading.progress` | A Reading stating `planned` and `done` (the work against its plan) reads dates of its rows for `planned` and `finished`, and a number for `done`. |\n| `reading.progress-alone` | A Reading stating `planned` or `done` is the work against its plan: it names its `entity` and states `planned` and `done`, with `finished`, `where`, `via`, `tab`, `when` and `label` beside them, and none of a figure\'s props (`value`, `by`, `across`, `over`, `ahead`, `steps`, `on_hand`, `target`, `better`). It stands in a List\'s band or a record, never on a Sheet. |\n| `reading.key` | A Reading\'s `key` is its query\'s name, and a List that only reads is called by its `key`, else its entity\'s alias: each its own among the App\'s Readings, Lists that only read and Queries. |\n| `reading.tabs` | A Sheet holds Readings and Lists, one at least; a Reading stands in a Sheet or in a List\'s band. |\n| `reading.restate` | *Noted, never refused:* A Sheet\'s count tile counting the rows a List beside it lists under the same `where` and tab, and a List\'s band counting its rows past a deadline, say what the List already draws: its head counts the first, its overdue chip the second. |\n| `reading.period` | An App\'s `period` is the one its Sheets open on \u2014 "month", "quarter", "year" or { "days": 30 } \u2014 and it stands only over a Reading placed in time by `over`. |\n| `reading.funnel-place` | A Reading with `steps` (a funnel) stands in a part of a Record: a band and a Sheet draw none. |\n| `reading.on-hand-split` | A Reading with `on_hand` compares what is owed with what is on hand per value of one field, or two: its `by` and `across` name fields, never bands. |\n| `reading.average-kind` | An average (`value: { avg }`) is a figure\'s, a trend\'s (`by` a date) or a breakdown\'s (`by` a select, one-row link, member, yes/no or tiered number): its Reading states no `on_hand` or `across`. |\n| `reading.via-path` | A Reading\'s `via` is a path (`<link>.<link>`, reaching the record through a row of the child\'s own) only on a Record\'s page, over a number, a split, a trend, a grid or a shortfall of the child\'s rows \u2014 never in a List\'s band or on a Sheet, nor on the record\'s own figure, a funnel or the work against its plan. |\n| `reading.grid-rows` | `across` splits a grid\'s columns, and stands only beside the `by` splitting its rows. |\n| `reading.band-off` | `readings: false` turns off the band a register leads with by default: a List stating it states no Readings, which are the band. |\n\n<!-- generated:end rules-reading -->\n\n## Statement rules\n\n<!-- generated:start rules-statement -->\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `statement.lines` | A Statement\'s `lines` are numbers of the record, each once \u2014 the first stating no `op`, every other one, the last an `"equals"` \u2014 each `"equals"` a formula, rollup or lookup, and a `rate` a number of the record. |\n| `statement.rows` | A line\'s `parts` read rows of an entity holding `same`, a one-link of the record\'s to the same entity; `at`, a moment of those rows, and `before`, a moment of the record (datetimes, never days), stated together; their `columns` and `figure` are those rows\' fields, the figure a number. |\n| `statement.parts-keyed` | A line\'s `parts` add up to its figure, so no person keys it: a formula, rollup or lookup, a value the server copies when the record is made (`default_from`) that no `create` asks and no save or Act writes, or a stored number the App\'s saves leave out \u2014 the line draws it read; each part\'s `figure` is frozen when its row was certified \u2014 a stored number an Act fills, the server copies or the App\'s saves leave out, never one a person keys or the server recomputes \u2014 and no person keys the moments `at` and `before` either. |\n\n<!-- generated:end rules-statement -->\n\n## Check rules\n\n<!-- generated:start rules-check -->\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `check.field` | A Check\'s `field` is a yes/no or text formula of the rows of the page\'s entity. |\n| `check.of` | A Check stands in `pages/<entity>` and reads a yes/no or text formula of that entity. |\n| `check.not-placed` | A Check\'s field is never also placed on the record as a Field \u2014 the line under the head says it. |\n| `check.on` | A Check\'s `on` names what it refuses: `"update"` (the saves), the `key` of an Act over the Check\'s entity \u2014 on one row or over a List\'s rows \u2014 or `"all"`. One refusing a record\'s Acts through a List of that record\'s rows needs the List\'s link paired, so a row filed under the record waits for the Act pressed on it. It binds this App alone; a Delete is the table\'s checks\' to refuse. |\n| `check.resolve` | A Check\'s `resolve` names an Act of this App on one row of the Check\'s entity, not refused by the Check, and drawn as a button \u2014 never a correction. |\n| `check.restates-meter` | A warning reading a gated meter\'s figure against its bound or pass mark is refused \u2014 the meter draws it. |\n\n<!-- generated:end rules-check -->\n\n## List rules\n\nThe rules of a List\'s props and of what a child List holds. A layout\'s, a Tab\'s, an Export\'s and a desk\'s rules stand with their keys.\n\n<!-- generated:start rules-list -->\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `list.key-shape` | A List\'s key is not a record id\'s shape. |\n| `list.peers-read` | Root Lists over one table may state different `where`, unless one holds a `where` through a link, `sources` or a `plan` layout. |\n| `list.column-drawn` | A List\'s `columns` stand beside what the row draws itself: a column of its title, subtitle, picture, status, figure or meter\'s bound, of a child List\'s link back, or one named twice, stands once where the row seats it. |\n| `list.columns-budget` | *Noted, never refused:* A List\'s `columns`, each at the width of its kind, are told against the room a desk leaves beside its name and the row\'s own status, deadline and figure; what does not fit folds onto the name\'s line. |\n| `list.chips` | `chips: false` stops a register opening on status options. |\n| `list.filter` | A List\'s `filters` name a select, a member, a link, a date, a yes/no or a number of the List\'s own rows \u2014 a lookup through one-row links as the field it reads \u2014 never the status its chips draw, nor one `where` fixes; `values` only on a select, member or link. |\n| `list.filter-split` | *Noted, never refused:* A `filters` entry on a field a Reading of the List with `by` or `across` splits the rows by \u2014 a press on its part narrows by it too; a member\'s filter, which narrows to the reader\'s own rows, is never noted. |\n| `list.filter-unshown` | A `filters` entry of a List, a child List included, names a field its rows show: a `columns` entry, the row\'s title, line, picture, status, figure, deadline or meter\'s bound, the unit or currency a drawn figure is read in, a warning its line says, the group or lane it stands under, or a formula drawn where every field it reads is. A filter on a field no row shows is refused: make it a column or part of the row\'s line, or drop it. |\n| `list.narrow-unshown` | A narrowing the List `opens` on and a press in a Reading\'s band (a part, a grid cell, a figure\'s `where`) name a field its rows show, as a `filters` entry does (`list.filter-unshown`). A narrowing to the reader needs none. |\n| `list.tiers` | `tiers` band a number read in one unit on every row; a figure read in each row\'s own unit or currency is named bare. |\n| `list.search-undrawn` | *Noted, never refused:* A List\'s `search` matches all of a row\'s text, drawn or not: where a lookup, rollup, copy or link of its rows reads another entity under a row rule the List\'s readers are not all inside, it finds rows by text the List draws none of. |\n| `list.search` | A List\'s `search` names text, a code, or a link \u2014 matched by its row\'s title. |\n| `list.sort` | Each `sort` key of a List or a Tab names a field of the List\'s rows that holds an order \u2014 never files \u2014 and no field twice. |\n| `list.group` | A List\'s `group` names one value per row \u2014 a single select, a one-row link, one member, a date, a yes/no or a text, a lookup through one-row links as the field it reads \u2014 the status too, but never on a task list\'s block, whose chips narrow it; only a table or cards List groups, and a gantt into its lanes; grouping by the title needs a `row.subtitle` to lead each row. |\n| `list.readings-own` | A Reading in a List reads the List\'s own entity; another entity\'s stands on a Sheet. |\n| `list.readings-bands` | A Reading in a List that bands a number by `tiers` has that field with the same tiers among the List\'s `filters`, which a press on a band narrows by. |\n| `list.readings-restate` | A Reading with no `by` in a List never sums the row\'s figure, counts the rows, or counts one stage\'s rows, unless it is placed in time (`over`): the summary line and the status chips already do, but draw no change against the last period. Instead, for the summed figure: a mix `by` a field or a sum under a `where`; for the rows counted: a sum of the figure under a `where`, a mix `by` a field or a yes/no in `where`. |\n| `list.where-opens` | A List\'s `where` and `opens` hold a select\'s options, a yes/no\'s value, a number or date\'s bounds (`lte`, `gte`; a date\'s `{ "now": true }`; a number read in each row\'s own unit or currency takes only 0) and `{ "empty": true \\| false }`; `opens` alone names the reader \u2014 a member field or a lookup of one holding `{ "me": true }`, or, on a status whose `stages` have owners, the rows waiting on the reader \u2014 and takes fields only, on the status only options. A field `where` fixes to options is never a filter nor opened otherwise, and `opens` stays among the options `where` keeps. A List laid out as a `plan` keeps its items by options and yes/nos alone. |\n| `list.roster` | A `layout: "roster"` List holds the List of its cells: the cells\' entity has one single link to this one and a date on its line (its own field, or a lookup of its parent\'s date); a roster draws no `columns`, and an `expect` stands only on the cells List. |\n| `list.roster-covers` | `covers` is a whole number from 1, only on a roster\'s cells List over days, never beside an `expect`. |\n| `list.roster-expect` | A roster cells List\'s `expect` is a single select of its rows, and its `of` this entity\'s multi-select whose every option is one of `expect`\'s. |\n| `list.source-page` | A source\'s entity states a Record page in the App\'s `pages`. |\n| `list.band-pivot` | *Noted, never refused:* A Reading with `across` (a grid) among a List\'s Readings: its grid reads on a Sheet, and the band leads with a figure (a Reading with no `by`). |\n| `list.headline` | *Noted by the designer on a write, never refused:* A List over rows that fall due or carry money and have no status whose steps the chips count, laid out as a table, cards or a gantt, has Readings \u2014 they split the rows by a field they show. |\n| `list.figures-lead` | *Noted, never refused:* A root List over a table holding a status, or a money field beside a date, to count or total states a Reading, or a Tab with totals, above its rows: what a person watches, as a figure or a chart. |\n| `list.title-only` | *Noted, never refused:* A root List whose rows draw their title alone: a subtitle, a figure, a status, a deadline, a picture, a face or `columns` says what each row is. |\n| `list.people-undrawn` | *Noted, never refused:* A root List drawn in columns, stating fewer than two besides the figure, where a table whose rows are people links to its table: the paired link holding several of them is not a column of it, or the link is not paired. |\n| `list.layout-call` | *Noted, never refused:* A root List that states no layout, over rows a board layout\'s own resolver resolves (a calendar, a gantt, lanes, or a roster of rows a `cadence` owes), draws a table; the note names each layout and its key. A deadline or a stamped date is never a day rows stand on. |\n| `list.lanes-overlap` | *Noted, never refused:* Lanes of dated rows by a link with no `no_overlap`. |\n| `list.lanes-order` | *Noted, never refused:* Lanes giving rows at a day, whose first ascending `sort` is no stored number the app writes. |\n| `list.where-bound` | A bound read from the record (`{ "record": \u2026 }`) in `where` narrows only a List that reads its rows \u2014 `same`, or `edit: false`. |\n| `list.where-reader` | A root List\'s `opens` names the reader (`{ "me": true }`), never its `where`. Wrong: `where: { crew_lead: { me: true } }` on a child List. Right: a row rule bounds access, or a root List over the entity states `opens: { crew_lead: { me: true } }`. |\n| `list.where-reader-path` | A path reader `<link>.<field>` names a one-row link and a member field of the row it links. |\n| `list.props` | A node states only its place\'s props: a List those of a root List, a roster\'s cells, a rows, agenda, timeline or read-only List of a record (which take every prop of a View but `sources`), a document or a Sheet; the Record of a List that opens no row in place and a source\'s entity page `entity`, `edit` and its children; a Sheet its `key`, `label` and children. |\n| `list.holds` | A List holds what its place draws: a root List its Tabs, Readings, Exports, Acts over ticked rows or every row in view, sources and, under a roster, the List of its cells; a child List its Tabs, Readings, Exports, Acts over ticked rows and, with `under`, the List of its documents; a Sheet its Readings and Lists. An Act on one row and every Check stand in `pages/<entity>`. |\n| `list.layout-place` | The register lays out as a table, cards, a calendar, a roster, a gantt, lanes or a plan; a child List writing its rows as a table, checklist, desk or gantt; any child List as an agenda or timeline. |\n| `list.edit-column` | An edit column (`{ "field": \u2026, "edit": true }`) stands in a child List only: the register\'s rows are written where they open. |\n| `list.child-link` | A child List reads a child linked to the record; `via` names the link where the child links more than once. |\n| `list.row-blocks` | A List drawn as lines (`expect`, `under` or a desk) opens no row in place, so no List stands below its rows; a plain list of rows holds one. |\n| `list.title-back` | Where a child\'s title is its link back to the record, its first other `row.subtitle` names it there \u2014 a text, a code, a select, a link or a member, never a number or a date. |\n| `list.where` | A child List\'s `where` names single selects of the child by the options they hold (a row holding none stands in no such List; one held at a single option is never also a column), yes/nos by value, numbers and dates by bounds, and fields by `{ "empty": true \\| false }`. A yes/no, a bound or a blank is never held: a child List adds rows only at a stored yes/no\'s start, none under a bound or a blank, and never picks, expects or stands lines under documents. |\n| `list.under` | `under` names the child\'s one-row link to a document entity that pairs a many-link back and is read under this record by its one link; the lines\' columns never read the document (its heading does) nor hold long text. |\n| `list.under-once` | Documents drawn over their lines (`under`) are never listed again as a List of their own. |\n| `list.edits` | A child List\'s editable columns (`{ "field", "edit": true }`) name at most two of the child\'s columns or its figure that the App\'s saves write \u2014 a number, a date, a few words, one option or a one-row link, never a files or long-text field, the List\'s `via` nor a link it must name alike (a link\'s `same`) \u2014 never on an `expect` List. |\n| `list.remove-roster` | A roster cells List\'s `remove: true` offers the Delete of its rows, so it stands only over rows the App writes. |\n| `list.attention` | `attention: false` keeps a table\'s or cards\' rows in the List\'s own order; a calendar, lanes, a gantt and a roster stand their rows in time and lift none. |\n| `list.remove-documents` | The documents List inside a child List with `under` states `remove: true` only over documents the App writes. |\n| `list.compare` | A child List\'s `compare` names two different fields of the child, `before` and `after`: two files fields, or two values of one type (text but long text, a number, a date, a single select), never with `expect`. Over files on a checklist layout, `before` is the check\'s `photo`. Over values neither side is a column or something the row draws already, two numbers share a notation, no column is long text, and the layout is no checklist. |\n| `list.current` | A child List\'s `current` names a date or number of the child (stored, or a formula) that orders revisions: the latest row is current, the rest fold as superseded. Never with `group`, `under`, `expect`, `checklist`, `compare`, `desk` or `pick`, nor beside a column of long text. |\n| `list.pick` | A child List\'s `pick` links rows of the child through `via` \u2014 an optional one-row link a person writes, no Act writes, no other rule compares rows by and no `under` List stands lines under \u2014 paired with a many-link of the record its own save writes; the child\'s `read_scope` reads a row naming no record through `via`; never with `expect` or `under`, nor where the App\'s saves leave out the child or the many-link. |\n| `list.narrow` | A child List\'s `filters`, `search`, `group` and `sort` follow the register\'s rules over the child\'s rows, its status among them but on a task list (its chips); never on the link back or a select its `where` holds at one option, nor on an `expect` List; an `under` List is grouped by its documents. |\n| `list.expect` | `expect` names the child\'s title \u2014 a single select or a one-row link a person writes, never the link back \u2014 on a child added in the List; its `columns` name a field filled in place (not on a desk, whose lines are ticked) and its `create` takes the file where the child is pictured by one. |\n| `list.expect-fills` | An expected line is made from its key and its first filled column \u2014 a desk\'s from its key alone \u2014 so every other field the child requires has a default, a start or a `default_from`, or is read first. |\n| `list.expect-of` | An `expect` object\'s `of` or `only` needs a select: `of` names the record\'s multi-select of the title\'s options; `only` names options of a single select, never with `of` or a `where` on it, one List per option; an Act\'s `paper` is drawn in one. |\n| `list.post-option` | A desk\'s `text` formula names, as `{field:option}`, only options that select states. |\n| `list.funnel` | A Reading\'s `steps` (a funnel) are 2 to 8 numbers of its child, each named once \u2014 stored, a formula or a rollup \u2014 all in one notation, never a percent nor a unit read on each row. |\n| `list.list` | A read-only child List (`same`, or a Record that is `edit: false`) lists the rows of an entity that link to the record by its one link (`via` where it has several); with `same`, a one-row link of the record, it lists the rows sharing that link\'s row \u2014 the record left out \u2014 by the listed entity\'s one link to that row\'s entity (likewise `via`). `same` stands in a Record, never on a Sheet. Its Record\'s Fields \u2014 at least one, each a field of the listed entity named once, never its title nor a `columns` entry \u2014 are what an opened row shows, read-only. |\n| `list.figures` | A Record\'s own figures (Readings with no `entity` or `by`, whose `value` names the field) are 1 to 8 numbers of the record, each a tile. |\n| `list.create-boolean` | A document\'s and a roster\'s cells\' `create` is `true` or `false`: their add asks the table\'s defaults. |\n| `list.via-path` | A `<link>.<link>` `via` only reads rows, through a row of their own: a List writing its rows lists a child linked to the row it stands under. |\n| `list.beside` | `beside` opens a row beside a table: a root List drawn as a table states it, never a board, cards, a calendar or a List of a record. |\n| `list.create-empty` | A child List stating `create: true` asks the fields of its add (where the table\'s defaults ask none, state `create: false` or those fields); one stating no `create` adds none. |\n| `list.read-scope` | A child read under a record whose rows a `read_scope` narrows states its own \u2014 a row rule is not inherited, save the status history\'s, which takes its record\'s. |\n| `list.unworked-stage` | *Noted, never refused:* A register lists rows (every open one, else those its `where` keeps) at a stage no Act of the App is offered at and no Section stands at, though the App states the stages it works: keep them out with `where`, or leave them to the App working them. |\n| `list.under-note` | *Noted, never refused:* Rows holding a paper that cover another List\'s lines, listed apart with no add of their own stated: `under` draws them over the lines they cover. |\n| `list.expect-note` | *Noted, never refused:* Rows each a kind of paper, listed with no `expect` and no `where` on the kind, that no Act files a call into or `fills`: the missing lines read as what a record needs. |\n\n<!-- generated:end rules-list -->\n\n## Record rules\n\n<!-- generated:start rules-record -->\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `record.placed-once` | A child List, a Reading, a Statement and an Act each stand once in a Record; the same block stated in several Sections is that one placement, drawn in the first and said where repeated, and a repeat that differs from the first is refused; a set of papers stands where its Act does. A Field may be stated in several parts: parts that stack draw it once, parts a reader navigates each draw it. The head draws the title, line, picture, status, figure and the nearest open deadline, and a Field of a part standing there stands aside unless a person writes it in the part; what a Side states stands only in the Side. |\n| `record.check-lifted` | *Noted, never refused:* A Check stated inside a part guards the whole record, as one beside the parts does: it stands at the page, and is said. |\n| `record.foot-total` | A child List\'s foot totals the child\'s figure and each summed column over the rows it lists; the record\'s rollup summing that field over those rows (the same `where`) is that foot, never also a Field of a part. |\n| `record.section-holds` | A part without `at` (Section, Side) holds Fields, Fieldsets, child Lists, Readings, Statements or Acts. |\n| `record.linked` | A link drawn as a block (`block: true`) is a link to one row of a table the App states a Record page of: the row stands in place as that page draws it. |\n| `record.fieldset` | A Fieldset stands in a part, or in a one-part Record, and holds two or more Fields drawn as controls \u2014 never a gallery or prose Field (`block`) \u2014 each Field in one Fieldset. |\n| `record.parts` | *Noted by the designer on a write, never refused:* A List laid out as a table, cards or a gantt opens a Record whose Sections hold the fields people write, a files Field per paper and the Acts no stage places, a Section per stage the status states (in option order) with the moves offered there at its foot, and a child List per child, a table\'s own rows that belong to a row of it included. |\n| `record.lists` | *Noted by the designer on a write, never refused:* A table some App records, whose rows other rows each belong to (a one-row link to it, never its status history), draws some of them under its row \u2014 a child List in its Record, a List with `layout` roster or lanes by that link, or an App over them working inside one of its rows at a time (`scope`). |\n| `record.at` | A Section\'s `at` names options of the record\'s status; a record with no status has no steps. |\n| `record.edit-declared` | What an App writes of a row is what its Record declares: each Field its Sections state, the table\'s face (`records`: title, line, picture, figure, description) and, where the Record states no part, every field a person writes \u2014 each unless `edit: false` reads it \u2014 beside what an Act requires and a list of child rows its block writes. The head as `row` restates it (each part takes `edit: false`, read and never written), a column, an expected line, a `compare` and a layout\'s move draw a declared field with its control and never declare one: one naming a field no Section declares is refused. A tree stored before the rule rebuilds as it was. |\n| `record.edit-unseated` | *Noted, never refused:* A field of the table\'s face the `row` leaves out of the head, that no Section, column, layout or Act of the App writes, is written nowhere in this App: said, and a Section stating it makes it the App\'s to write. |\n| `record.beside-door` | A Record whose entity a root List opens `beside` its table states no `door`: the rows open beside the table. |\n| `record.key-clash` | A Record\'s List blocks, filed rows and links share one namespace of `key`s: none repeats but the same block stated again (`record.placed-once`), a List\'s default being its table, and a link\'s or a filed field\'s being its alias; a List and a link at one key, or one alias leading to two tables, is refused. Where unkeyed Lists over one entity stand in different Sections of a page, each takes its Section\'s key as its own, unless they are stated alike (one block stated again) or two stand in one Section, which nothing tells apart: those stay unkeyed. |\n| `record.side` | At most one Side stands in a Record, on a page `door`. |\n| `record.history` | No part of a Record reads the entity\'s status history (`status.history`): the rail reads each move. |\n| `record.section-acts` | An Act in a part works on the record itself; an Act over ticked rows or every row in view stands in a List. |\n| `record.move-home` | *Noted, never refused:* A status move offered at one step stands at that step\'s foot when it moves the work forward, to an exit, or back to a step the work passes \u2014 one a row starts at, or one an Act moves the work forward into or on from; one offered at several steps, or moving back into a step the work never passes, stands in the Section whose `at` holds the status it enters, as its way in. A move written in another Section, or in none, stands there and is said. |\n| `record.act-staged` | An Act at a staged Section\'s foot is offered only during that Section\'s steps: its `when` holds the status to options the Section\'s `at` names. A tree\'s Act with no `when` at the foot of a Section staged at one step is offered at that step and said; a correction stays offered at every step, and an exit is refused. |\n| `record.act-hidden` | An Act is never offered only while its part\'s `when` hides the part. |\n| `record.outside-place` | An Outside stands directly in a Record whose table states a stored status select, and its `key` is unique in the App: a link to a record names it. |\n| `record.outside-at` | An Outside\'s `at` names options of the record\'s status that no stage owns, and no two Outsides of a record open during the same option. |\n| `record.outside-field` | An Outside\'s Fields are read as values, each a field of the record shown once, never `edit`, `when` or a label of its own. |\n| `record.outside-list` | An Outside\'s Lists read the child rows under the record as they are: their `columns`, `label` and `where` only, never an add, a Delete, a pick, a filter, a search, a link that opens, or a bound read from the record. |\n| `record.outside-where` | An Outside List\'s `where` keeps the child rows by single selects held at options, yes/nos at values, numbers and dates between bounds, and fields by `{ "empty": \u2026 }`. |\n| `record.outside-act` | An Outside\'s Acts are its alone and each ends the visit: `when` holds the status to `at`, `set` moves it to an option outside `at`, `asks` are text, numbers, dates or listed options, `requires` names fields the Outside shows or the act asks, a `sign` is by a text field with no witness, and none states `on`, `workflow`, `templates`, `paper`, `intake`, `record`, `review`, `danger`, `recommends` or `me`. |\n| `record.holds` | A Record stands in the App\'s `pages`, once per entity some List of the app or of a Sheet is over, or whose rows a link the app draws names. Every Record holds the same: parts (Section, Side) or the Fields, Fieldsets, Lists, Readings and Statements of its one part, never both; beside either stand Outsides, Checks and Acts on one row; holding only those, the record\'s Sections are the platform\'s. The page of an entity whose rows a child List opens no row of in place (an agenda, a timeline, a read-only List) holds Fields alone. |\n| `record.remove` | A Record\'s `remove` deletes a row opened from a link; an entity a List lists is deleted as that List\'s `remove` says. |\n| `record.field-heading` | A Field drawn as a control states no `label` or `when`: only a gallery or prose Field (`block`) has a heading and a condition. |\n| `record.section-owners` | *Noted, never refused:* A Section holding acts offered at stages that different owners work \u2014 a role apiece, or a member field apiece \u2014 is two jobs in one: each owner\'s part is a Section of its own. |\n| `record.stage-field` | *Noted, never refused:* A field of a record with a status that only Acts offered at some of its stages write \u2014 no `create` asks it, no Field of the page draws it written \u2014 and that a Side or a Section shown at every stage draws, stands empty before those stages: it is stated in a Section `at` them, where it is the work then. |\n| `record.rows-repeated` | *Noted, never refused:* A Record that lists the same rows (a List of one table through one link) in two or more Sections lists them once, in the Section they belong to: a Section is one area of the record\'s data. |\n\n<!-- generated:end rules-record -->\n\n## Act rules\n\n<!-- generated:start rules-act -->\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `act.paper-note` | *Noted, never refused:* A made paper kept in a field of a record that lists its papers by kind: it is one of those lines. |\n| `act.moves` | *Noted by the designer on a write, never refused:* The rows of a root List of the App that a stored status stages towards `closed` options are moved by an Act of the App (on a page, a List or an Outside), or by its authored `workflow` \u2014 each open option moves to the next, the last to the first closed one. |\n| `act.set-not-asked` | A field an Act `set`s (an option, a value, `{ "now": true }`, `{ "me": true }`, an input) or `sign`s is the Act\'s outcome: the App\'s `create` never asks it, and a required one takes a `default`. A `formula` only starts a value, which a person may change after. |\n| `act.owner` | An Act\'s `owner` is a single member field of its row, a one-row link\'s member field (`link.field`), or `{ "group": <id> }` of a group the workspace holds: the press is that owner\'s, or the one standing in for them. An Act handed no row (`review`, `intake`, or over the list asking a person something) has no row to read a member field from, so its owner is a group. |\n| `act.owner-stage` | *Noted, never refused:* An Act that moves no status and is offered while the status holds a stage another member owns is pressed by that stage\'s owner: state its `owner` for someone else to press it. |\n| `act.owner-moves` | An Act stating `owner` moves no row off a stage another owner owns: the server refuses that move to anyone else, so the press would be refused. A move from an option no one owns is fine. |\n| `act.asks-set` | A field an Act `asks`, `set`s or `sign`s is stated by one of them: what the Act writes is its outcome, never also asked, and no field is written by two clauses of one Act. |\n| `act.starts` | `starts` (an ask `{ field, starts }`) starts a field the Act asks \u2014 `"today"` a date or a moment (never a span), `me` a member \u2014 for the reader pressing it, who changes it at will. |\n| `act.set-formula` | `set: { <field>: { formula } }` reads fields of the acted row and computes what the field holds \u2014 a number, a date, text, a yes/no or a single select\'s option (`{field:option}`), typed as the entity\'s own formulas are \u2014 never the status; a bound a write rule holds the field to is checked on the computed value as the Act runs. |\n| `act.set-formula-option` | A `{field:option}` token of a `set` formula names an option that select states. |\n| `act.of` | An Act in a child List works on that child: the one row pressed \u2014 or, with `on: "ticked"`, the rows ticked together where the record lists them as tasks \u2014 never the rows in view. |\n| `act.writes-line-key` | An Act never writes the link or the key naming an expected line under its record \u2014 a line\'s key is stated by filling it. |\n| `act.makes-or-runs` | An Act makes a document (`template`, `templates`) or runs an authored `workflow`, never both \u2014 the workflow makes what it needs. |\n| `act.does-nothing` | An Act does something: it `set`s a value, `asks` a field, runs a `workflow`, makes a document, takes an `intake`, a `record` or a `sign`, or `makes` the rows a cadence owes. |\n| `act.view` | An Act over every row in view (`on: "view"`) writes (`set`), makes a document, runs a workflow or reads papers into a new record, and states no `requires`. |\n| `act.requires-written` | A field an Act requires that only an Act writes is written by an Act offered together with it, or asked by the Act itself. |\n| `act.recommends` | A field an Act `recommends` is not also in its `requires`. |\n| `act.set` | `set` writes each field a value it holds \u2014 an option alias, a number, a yes/no, a text, `{ "now": true }` on a date, `{ "me": true }` on a member, `{ "input": "<name>" }` of an input the Act asks of the same kind \u2014 or clears an optional one with `null`. |\n| `act.into` | `into` is a files field of the one record the Act is pressed on, beside its `template` or `templates`. |\n| `act.paper-list` | A List a made paper names is one it can list: none keeps its rows by the reader, and no name is reached by a child List that writes its rows and one that only reads them, or by two of either, at once. |\n| `act.paper-list-field` | A List a made paper names is not also a field of the record, other than the link to those rows; an outline\'s rows are handed their depth as `level`, so they hold no field of that name. |\n| `act.paper-loop` | A loop of an html or Word paper that prints a field of each item runs over a link of the record or a table linking to it once (their rows are read under the app\'s row rules), or a List\'s rows \u2014 never over a link inside a child row, or one to rows the app cannot read, which a paper is handed as titles; over several rows an html paper holds the same one level inside `{{#each <alias>}}`, where each row is handed its own lists; a List\'s rows are looped for their fields, never printed whole; a loop runs over a name the paper is handed, never one it is not, which prints an empty table. |\n| `act.paper-cells` | A paper does not draw a cell for each title of a link inside the row of a List it loops over: the titles of a link line up with no column, so a cell packs left under the wrong date. Lay the rows out on a roster and export it, or draw a List. |\n| `act.paper` | `paper` is a kind the record lists its papers by, on one record \u2014 never beside `into` or `templates`; one maker per kind. |\n| `act.templates` | `templates` names each template once, kept in `into`, on one record pressed alone \u2014 never beside `template` or `asks`, in a child List, or with an `on` over several rows. |\n| `act.intake` | `intake` names a child the record lists in a child List with `expect` on its title \u2014 a single select, the paper\'s kind \u2014 and is narrowed by no `where`, holding exactly one files field and needing nothing an added line does not fill; the Act runs on one record (rows it finds by natural key need the link filing them under the record paired), or over the view (`on: "view"`) where the papers make a new record, states `fills`, and states nothing but its `label`, `when` and `requires` beside them \u2014 over the view no `when` or `requires`, the record has no row yet. |\n| `act.record` | `record` names a child the record draws in a timeline List or a child List with no `expect`, `under` or `where`, linking back by one single link, its row needing nothing the recording does not write: `audio` and `video` files fields, `transcript` text, `at` a date, `by` a member, each its own field; on one record, stating only `label`, `when`, `requires` and `fills` beside it. |\n| `act.sign` | `sign` runs on one record: `into` a files field, `by` a text field the signer types or a member field set to the person pressing, `at` a date, `witness` a member field \u2014 stated exactly beside a text `by` \u2014 each a field of its own that the Act does not also ask or set, and no other Act signs into `into`. |\n| `act.fills` | `fills` names each once, only beside `intake` or `record`. Beside `record`: a field of the recording\'s row the recording does not write, never a link. Beside `intake`: a field of the record, `<link>.<field>` on the row a required one-row link names (never beside that link), or a child the record adds rows of in a child List with no `expect`, `under` or `where`, filled in the fields its `create` asks \u2014 every one a new row needs among them. Each field filled is one a person writes \u2014 text, a number, a date, a yes/no, options or a single link\'s row \u2014 never a status, a field an Act writes or a link `same` narrows; a link\'s row is one the App reads of its entity. Over the view the papers make a new record, so `fills` names every field the record requires that nothing fills itself \u2014 the review asks the ones no paper states \u2014 and the row a required one-row link names is found on its entity\'s `natural_key` once `<link>.<field>` fills every field of it, left as it is, else added with the fields filled, so `fills` names each field that row requires too. |\n| `act.fills-drawn` | *Noted, never refused:* A field `fills` writes that the record draws nowhere: the review shows the change, the record does not. |\n| `act.fills-new` | *Noted, never refused:* A child `fills` adds rows of, whose natural key the papers cannot state: every row read is added, so the same papers read twice list them twice. Over the view, so is the row a required link names where the papers fill no natural key of it. |\n| `act.input` | An input has a name of its own \u2014 never another ask\'s, a field the act sends under that name (one it asks, one a `set` takes from an input, a typed `sign.by`, a `requires`), `sign.into`, or the record input its workflow takes (nor `approved` beside `review`) \u2014 `options` exactly when it is a select, `entity` exactly when it is a link, and a `default` field holding what it states. An input starts empty, or from its `default`, and never reads, shadows or overwrites a field of the row: an act that adds a subtask may ask `name`, though the row has a `name`. A `"file"` input is read by the Act\'s authored `workflow` alone, starts empty, and is never written into a field by `set`. |\n| `act.review` | `review: true` stands beside an authored `workflow` on an Act over the record, the ticked rows or every row in view (never on a List reading `sources`), never beside `set`, `template`, `templates`, `intake`, `record`, `sign` or `confirm`, nor in a child List, and it asks inputs only, none named `approved`. Its workflow is that Act\'s alone, run by no other Act. The workflow calls only steps that read \u2014 no agent \u2014 and returns a changeset of the entity\'s table in `data.review`, the same for the same inputs and rows; the platform writes the rows `approved` names, each only while the run proposes it as the caller read it. Over every row in view (`on: "view"`) it is handed no rows and states no `when`: its workflow reads the rows it may change, whatever the view is narrowed to, and no bound on a run\'s rows applies. |\n| `act.makes` | `makes` names a child that the Act\'s entity states a `cadence` for, in a Record or in a List with `on: "view"` or `"ticked"` that is not a child List; never beside `set`, `workflow`, `template`, `templates`, `intake`, `record`, `sign`, `review` or `of`. The app lists the child\'s rows in a List, and every field of the child that the cadence does not fill and that a row requires has a `default_from`, a `default` or an autonumber, since the app writes the child. The child states a `unique` of its link to the parent and the `planned` date (the day its cadence fills, where the cadence states no `planned`), so two presses at once make a day once, and the cadence states `start` where the child\'s first date holds a moment. |\n| `act.workflow` | An Act\'s authored `workflow` body parses once the guards the Act states are placed above it: the code is the author\'s, the guards above it the platform\'s. A declared Workflow an Act runs takes the row pressed as `record_id` (a required record_link to the act\'s rows), is run by that one Act, over one row, which asks only its inputs and states no `set`, papers, `intake`, `record` or `review`. An authored `workflow` is one Act\'s. Where a Check refuses the Act through a List of its record\'s rows, the workflow holds those rows as one transaction and so cannot mail, notify, run an agent or wait. |\n| `act.set-tagged` | An Act\'s `set` states the moment as `{ "now": true }`, the person pressing as `{ "me": true }` and an input as `{ "input": \u2026 }` \u2014 never the strings `"now"`, `"me"` or `"input:\u2026"`. |\n\n<!-- generated:end rules-act -->\n\n## Template rules\n\nThe rules of the document templates an Act makes and an Export fills.\n\n<!-- generated:start rules-template -->\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `template.kind` | An Act\'s `template` is an html, excel or word document template and an Export\'s `template` an html or excel one, never an email or pdf-form one. |\n| `template.marker` | Every marker of a Word template an Act makes is filled by that Act: a field of its entity, or a list of the child rows its record lists (the entity\'s own alias over several rows). |\n| `template.act` | *Noted, never refused:* In an App none of whose Acts runs an authored `workflow`, every html, excel or word template is made by an Act (`template`, `templates`) or filled by an Export \u2014 the note names the app over the table whose fields it prints most, where the Act belongs. |\n\n<!-- generated:end rules-template -->\n\n## What the workspace remembers\n\nThe workspace holds every table, field and select option under an id that never changes, whatever its\nlabel or alias becomes. `set_tables` answers each table\'s id, and an\napp\'s body names tables and templates by those ids, so a relabel on either side is a rename and no body\npoints at another table by accident.\n\nA table `set_tables` refuses to write, or an id the workspace no longer holds, is a refusal by name. `set_tables` with `{ table_id, restore: true }` puts a deleted table back.\n\n## A complete workspace\n\nTwo main entities, so two apps: a sales desk over the orders, where an order is taken and shipped, and an account review\nover the customers, where an account manager reads each customer by tier. What belongs to a row is a child List on that\nrow\'s page, never another app or a Tab: a customer\'s orders are on the customer\'s page, and each order is also a row of\nthe sales desk, one record with one page (`app_architecture`).\n\nOne `set_tables` call makes both tables: each item carries a `ref`, and a link names the table it points\nat by the `ref` of the other item. Its answer carries each table\'s id. One `set_app` call then makes each\napp, `{ "body": \u2026 }`: the tree\'s root names the app by its `key` and `name`, and the tables it uses in `tables` by those ids,\nshown here as placeholders to replace.\n\n```json\n{\n "tables": [\n {\n "ref": "customer",\n "label": "Customers",\n "singular": "Customer",\n "fields": {\n "name": {"label": "Name", "required": true, "type": "text"},\n "logo": {"label": "Logo", "type": "files"},\n "tier": {\n "label": "Tier",\n "default": ["standard"],\n "type": "select",\n "options": [\n {"alias": "standard", "label": "Standard", "color": "slate"},\n {"alias": "gold", "label": "Gold", "color": "amber"}\n ]\n },\n "orders": {"label": "Orders", "type": "link", "pair": "customer", "table": "order", "multi": true},\n "total_ordered": {"label": "Total ordered", "type": "rollup", "via": "orders", "op": "sum", "field": "amount"}\n },\n "title": "name",\n "records": {"image": "logo", "party": "organization", "figure": "total_ordered"}\n },\n {\n "ref": "order",\n "label": "Orders",\n "singular": "Order",\n "fields": {\n "code": {"label": "Order no.", "type": "text", "unique": true},\n "placed_on": {"label": "Placed on", "type": "date", "format": "date"},\n "amount": {"label": "Amount", "type": "number", "notation": {"style": "currency", "currency": "VND"}},\n "total": {\n "label": "Total with VAT",\n "type": "formula",\n "expression": "{amount} * 1.1",\n "notation": {"style": "currency", "currency": "VND"}\n },\n "customer": {"label": "Customer", "type": "link", "pair": "orders", "table": "customer", "multi": false},\n "note": {"label": "Note", "type": "text"},\n "stage": {\n "label": "Stage",\n "default": ["draft"],\n "type": "select",\n "options": [\n {"alias": "draft", "label": "Draft", "color": "slate"},\n {"alias": "confirmed", "label": "Confirmed", "color": "blue"},\n {"alias": "shipped", "label": "Shipped", "color": "green"}\n ]\n }\n },\n "title": "customer",\n "records": {\n "subtitle": ["code", "placed_on"],\n "figure": "amount",\n "status": {"field": "stage", "closed": ["shipped"]},\n "starts": {"placed_on": "today"}\n }\n }\n ]\n}\n```\n\n```json\n{\n "body": {\n "type": "App",\n "key": "account_review",\n "name": "Account review",\n "color": "blue",\n "tables": {"customer": "<id of the customer table>", "order": "<id of the order table>"},\n "templates": {},\n "children": [\n {\n "type": "List",\n "entity": "customer",\n "columns": ["tier"],\n "children": [\n {"type": "Reading", "key": "ordered_by_tier", "by": "tier", "value": "total_ordered"}\n ]\n }\n ],\n "pages": [\n {\n "type": "Record",\n "entity": "customer",\n "children": [\n {"type": "Section", "key": "account", "title": "Account", "children": ["tier"]},\n {\n "type": "Section",\n "key": "orders",\n "title": "Orders",\n "children": [{"type": "List", "entity": "order", "columns": ["total"], "create": ["code", "amount"]}]\n }\n ]\n }\n ]\n }\n}\n```\n\n```json\n{\n "body": {\n "type": "App",\n "key": "sales_desk",\n "name": "Sales desk",\n "color": "violet",\n "tables": {"customer": "<id of the customer table>", "order": "<id of the order table>"},\n "templates": {},\n "children": [\n {\n "type": "List",\n "entity": "order",\n "filters": ["customer"],\n "create": ["code", "customer", "placed_on"],\n "children": [\n {"type": "Reading", "by": "placed_on", "value": "amount"}\n ]\n }\n ],\n "pages": [\n {\n "type": "Record",\n "entity": "order",\n "door": "drawer",\n "children": [\n {\n "type": "Section",\n "key": "order",\n "title": "Order",\n "children": [\n "note",\n {\n "type": "Act",\n "key": "confirm",\n "label": "Confirm",\n "when": {"stage": ["draft"]},\n "set": {"stage": "confirmed"}\n },\n {\n "type": "Act",\n "key": "ship",\n "label": "Ship",\n "when": {"stage": ["confirmed"]},\n "set": {"stage": "shipped"}\n }\n ]\n }\n ]\n }\n ]\n }\n}\n```\n\nThe account review leaves the door a record opens through and the rows it opens in to the system, each the default the\ntable\'s facts give; the sales desk states a drawer. Each List names what its add asks (`create`). The customer\'s orders are a block in its "Orders" section, never its own `Orders`\nlink as a field as well: one fact, one place. An order is titled by its customer and read by its number under it; the\nList names what its add asks, since a subtitle or a figure is never asked by default. `Total ordered` is a rollup, so it\nis read and never asked; the sales desk\'s record opens in a drawer, because its rows are worked one after another. An\norder\'s `stage` is its status (`records.status`), moved only by the app\'s acts: they set it, so the app\'s saves leave it\nout, each act names the stage it is offered at (`when`) and the one it sets, and the register opens on the orders not yet\nshipped (`closed`).\n';
1882
+ var reference_default = '# Tables and apps\n\nThe tables of a workspace and the apps over them, each a JSON document. A table is a document, an item of\nthe tool `set_tables`: its fields, options, how a row is recognised, and the rules its writes\nfollow. An app is a tree of components, the `body` of the tool `set_app`: its Views \u2014 Lists of rows and Sheets of\nreadings \u2014 and the page each table\'s rows open. Each section is its own page, `reference/<section>`.\nWhich treatment each job\'s screen needs: the `design` reference. Each treatment worked through in an\napp: the `examples` reference.\n\n**What the documents compose with**\n\n- **Tables and fields** (`reference/tables`, `reference/read-scope`, `reference/field`) \u2014 a table\'s columns, options and links. A table document sits\n in the `tables` list of a `set_tables` call; a field sits under its alias in the table\'s `fields`.\n- **Records** (`reference/records`, then `reference/status`) \u2014 how a row of each table is RECOGNISED: its title, the line\n under it, its picture, its status, the one number it stands for. Stated once per table\n and read by every surface that draws one of its rows.\n- **Write rules** (`reference/write-rules`) \u2014 what a write finds, bounds and picks among.\n- **Apps** (`reference/app-tree`, then a page each) \u2014 the Lists and Sheets at the app\'s root, each a View of its own, and the\n page each table\'s rows open: which fields go where, the acts, and the checks that guard them.\n How each thing LOOKS is the runtime\'s, one treatment per concept; no prop here changes it.\n A screen the job needs and no component states is told to the person \u2014 the job, what the app\n drew, the word wanted \u2014 never props bent to approximate it.\n\n**The working order**\n\n1. The tables and fields the jobs touch, and a `records` entry for every table an\n app lists, opens or picks. Which apps a business needs is `app_architecture`.\n2. One `set_tables` call with the tables: a link names the table it points at by the `ref` of another\n item of the call, and the answer carries every table id and the aliases of the fields it added. A\n call carries at most 50 tables, 200 first rows a table, and 2000 rows and 2000 documents in all; more\n tables go in a further call, which names the earlier tables by alias. A call is checked whole and writes\n nothing when refused, listing everything wrong; `dry_run` is for reading the grants a write would make or\n deciding `force`.\n3. One `set_app` call per app. The tree names its tables and document templates by alias wherever it points at one;\n the App node\'s `tables` and `templates` maps are filled by `set_app`, never written.\n `set_app` with the tree as `body` creates the app, named by its `name`; a refused tree writes nothing and is listed whole, and `dry_run` is for reading the permissions the write\n would grant and remove (on the CLI, `lotics app apply <file>`, with `--check` for `dry_run`).\n4. Change an app afterwards one node at a time: `get_app` prints the `tree:`, each node\'s address under `node addresses:`\n and the `version` line, which is the `base_version_id` to send (the tree and addresses go to the app\'s author alone);\n `set_app` with `app_id`, `base_version_id` and `nodes`, a map from a node\'s address to a\n patch, changes it (`reference/changing-an-app`), and its answer states the permissions the change grants and removes. A table\n is changed by `set_tables` with its `table_id`, a merge patch over the document `get_table` answers. To go back,\n send the tree you saved before the change as `body` with `app_id`: it replaces `children` but keeps every App prop it\n omits (`words`, `scope`, `period`, `icon`), so null those. (On the CLI, `lotics app pull <app_id>` writes the tree as JSON and `lotics app apply\n <file>` sends an edited file, refused when the app has moved past the version the file was pulled at.) An app\n saved before apps were trees has no tree: `get_app` says so beside what it lets a person write, and `set_app` with\n `app_id` changes it by its whole tree as `body`, which replaces it, or by its name, description, icon and color alone.\n\n## The rules\n\n- **A `set_tables` call is all or nothing.** Every item is checked before any is written; an item\n without `table_id` makes a table, one with it patches that table.\n- **An app\'s labels decide its language.** A body names no locale \u2014 the words an\n app draws itself (its buttons, empty states, refusals) are in the language its\n own labels are written in, so a Vietnamese desk beside English ones answers in\n Vietnamese. The generated screens read the kit\'s\n pack, and a generated WRITE cannot: its refusals run on the server, so they are\n worded in that same language. Mix the two within one app and it answers in two. The app\'s own `words`\n (its words for a table, a field or an option) count as its labels: Vietnamese words over an English table\n make the app answer in Vietnamese.\n- **`set_tables` and `set_app` check all of it before anything is written**, and\n report every problem in one run rather than the first. The tables half of this\n page ends its keys with the rules the check enforces there, and `reference/app-rules` and the pages after it hold the app\'s, one sentence each\n under an id; a finding names its rule\'s id (`[list.filter]`), and\n `reference/<rule id>` is that one rule\'s page.\n\n## Top level\n\nEvery table of keys on this page is generated from the grammar a table document and an app tree are written in, so it is the whole of what a key may hold.\n\n<!-- generated:start top-level -->\n\n#### set_tables call\n\n| Key | Type | Meaning |\n|---|---|---|\n| `tables` | list of [Table item](#table-item), required | One or more, all or nothing; each item is a table document with these keys added. It creates a table (a `label` and `fields` at least) or, with `table_id`, patches one: the document it states merges into the table\'s own |\n| `rows` | map of alias \u2192 list of [Row](#row) | First records of the tables the call creates, keyed by each one\'s `ref` |\n| `force` | boolean | Consent to losing what rows hold: a field deleted, an option removed |\n| `dry_run` | boolean | Answer what the call would change, writing nothing: for reading the grants a write would make or deciding `force`. A refused call writes nothing too and lists every reason, so a dry run checks no more than the call does |\n\n#### Table item\n\n| Key | Type | Meaning |\n|---|---|---|\n| `ref` | alias | A created table\'s handle in this call: other items link to it, and `rows` are keyed by it |\n| `table_id` | text | The table to patch; absent, the item creates one. A patch states only what changes: `null` removes a key, a list replaces whole |\n\n<!-- generated:end top-level -->\n\n**A `set_tables` item is a table document** (`reference/tables`) with `ref` and `table_id` added, and the call\ntakes no other key. **A `set_app` body is an app tree** (`reference/app-tree`), whose root is an App node: its `tables` and\n`templates` each map a local alias the tree names to the id of the table or document template it means, from the\n`set_tables` answer or `get_table`. The tree is the only home of the app\'s `name`, `description`, `icon` and `color`;\n`set_app` takes it whole to create, or as a merge patch over the App node with `app_id`, or `nodes` with `app_id` to change one, and with `base_version_id` (the\nversion you read) it refuses a write over a newer one. Nothing is built code. An unknown key is an error, never ignored.\n\nA smallest call, two tables of plain fields, a select and a two-way link \u2014 nothing else is needed to write it:\n\n```json\n{\n "tables": [\n {\n "ref": "customer",\n "label": "Customers",\n "singular": "Customer",\n "fields": {\n "name": {"type": "text", "label": "Name", "required": true},\n "tier": {"type": "select", "label": "Tier", "options": [{"alias": "gold", "label": "Gold", "color": "yellow"}, {"alias": "standard", "label": "Standard", "color": "gray"}]},\n "orders": {"type": "link", "label": "Orders", "table": "order", "multi": true, "pair": "customer"}\n }\n },\n {\n "ref": "order",\n "label": "Orders",\n "singular": "Order",\n "fields": {\n "code": {"type": "text", "label": "Code", "required": true},\n "customer": {"type": "link", "label": "Customer", "table": "customer", "multi": false, "pair": "orders"},\n "amount": {"type": "number", "label": "Amount"}\n }\n }\n ]\n}\n```\n\n### Aliases\n\nEvery `alias` is a lowercase slug \u2014 a letter, then letters, digits and\nunderscores (`unit_price`, `so_1001`). Aliases are how a document and an app tree\nname a field, an option or a table; they are never shown to anyone. `label` is\nwhat a person sees.\n\nLabels must be unique within their namespace \u2014 two fields on one table, two options\non one field cannot share a label.\n\n## Tables\n\n<!-- generated:start table -->\n\n#### Table document\n\n| Key | Type | Meaning |\n|---|---|---|\n| `label` | text, required | The table\'s name in the workspace |\n| `singular` | text | One row of this table, in the business\'s own words \u2014 what a create\'s button and panel name |\n| `description` | text | The table\'s description, written onto the table in the workspace, where a caller of an app\'s queries and workflows reads it beside them |\n| `fields` | map of alias \u2192 [Field](#field), required | The table\'s columns, each under its alias, which is its key here and so is never stated inside it |\n| `read_scope` | [Read scope rule](#read-scope-rule) | Which rows a member reads. Absent, every member with access to the table reads every row. |\n| `unique` | list (at least one) of list of alias (at least one) | Sets of fields whose values no two live rows share \u2014 each a list of field aliases (text, number, date, a single select, a single member, or a link holding one row \u2014 `multi: false`); a single text field states `unique: true` on itself instead of a one-field set. A create or update landing a second row with the same values is refused. |\n| `title` | alias | The alias of the field that names a row wherever a link or a record shows one; absent, the first text field |\n| `colors` | any value | Row colors: a list of { filters, color }, the filter reading fields of this table by alias and a select\'s options by alias; one condition on its own is a group of one |\n| `records` | any value | How a row is recognised: the keys of the Record, Status and Cadence tables below but `title`, which sits above; a table they name is an id or a `ref`. A status `history` that names a `ref` no item of the call declares is made by the call as a table, `dates` add each date field they name, and a status with stages each stage and each open option they name none for its `<option>_at`, unless the document declares it; each is listed in the result\'s notes |\n| `natural_key` | list of alias (at least one) | The field aliases a row of this table is RECOGNISED by: an app\'s add and find-or-create reuse the row they find by these values, minting one only where nothing matches. A record tool or the API creates the row it is handed. |\n| `no_overlap` | [No overlap](#no-overlap) \\| list of [No overlap](#no-overlap) (at least 2) | No two rows hold overlapping spans (one rule, or a list of rules a row must each meet) \u2014 a create or update that would is refused, and so is a change to the dates or states of the row a span is read through that would make two rows overlap |\n| `checks` | map of alias \u2192 table check (`workflows/table-checks`) | The conditions a write of the table\'s rows may not meet, each under its alias: a merge patch edits one, and `null` removes it. Expressions name fields by alias |\n\n<!-- generated:end table -->\n\n<!-- generated:start rules-entity -->\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `entity.singular` | A table a List\'s `create` is mounted over \u2014 a root List\'s or a child List\'s that adds rows \u2014 states its `singular`: one row of it, in the business\'s words. |\n| `entity.link-format` | A text field of `format: "link"` holds web addresses; one whose rows hold a phone or a mail address states no format. |\n| `entity.read-scope` | A `read_scope` clause names a group (`member_of`) or a field of its table reached through one-row links: `"self"` a member field, options a single select declares; an `any` or an `all` groups clauses, and groups nest. |\n| `entity.unique` | A `unique` set names fields of its table once each, each holding one value to compare \u2014 text, a number, a date, a single select, a one-row link \u2014 and is stated once; a lone text field is `unique: true` on it. |\n\n<!-- generated:end rules-entity -->\n\n**`unique` is a set of values no two live rows share.** Each entry names fields\nof this table holding ONE value \u2014 text, number, date, a single select, a link\nwith `multi: false` \u2014 and a create or update landing a second row with the\nsame values is refused. A set of one text field is that field\'s own `unique:\ntrue`, so it is refused here. A create carries each set in the names its panel\nsends, so the panel can name the duplicate before the write does.\n\n**`singular` is what a create says** \u2014 `New Order`, `Add Claim line`, `H\u1ED3 s\u01A1\nm\u1EDBi` \u2014 while `label` names the table, so without it the button reads `New\nOrders`. Nothing derives it: English plurals are irregular, and no language is\nexempt. In a language without plural forms it is usually the label itself,\nless any word for the collection. A List that leaves `create` to its default adds nothing over a table that states\nnone (nor does the app\'s `words` state one); a `create` list stated over such a table is refused (`entity.singular`).\n\n**An app that only reads a table\'s rows draws them with `edit: false`** and states `create: false` and `remove: false` \u2014 a log of what the system sent, a copy of\nwhat another system holds. The app keeps the section and opens each row at rest, with no Add and no Delete; a party\nof it is picked, never found or minted; and the app writes no create, update or remove for it. It shapes that app, not who may write: a direct write \u2014 the records\nAPI, the chat agent, an import \u2014 follows the table\'s access, as on any table, and another app over the same rows\nstates its own tree.\n\n**`read_scope`** \u2014 which rows a member reads \u2014 is its own page, `reference/read-scope`.\n\n## Read scope\n\n<!-- generated:start read-scope -->\n\n#### Read scope rule\n\n| Key | Type | Meaning |\n|---|---|---|\n| `any` | list of ([Read scope by role](#read-scope-by-role) \\| [Read scope by member](#read-scope-by-member) \\| [Read scope by option](#read-scope-by-option) \\| [Read scope rule](#read-scope-rule)) (at least one) | A row is readable when ANY of these holds |\n| `all` | list of ([Read scope by role](#read-scope-by-role) \\| [Read scope by member](#read-scope-by-member) \\| [Read scope by option](#read-scope-by-option) \\| [Read scope rule](#read-scope-rule)) (at least one) | A row is readable when ALL of these hold |\n\n#### Read scope by role\n\n| Key | Type | Meaning |\n|---|---|---|\n| `member_of` | text, required | The id of a group (from Settings, or chat): whoever is in it reads the row |\n\n#### Read scope by member\n\n| Key | Type | Meaning |\n|---|---|---|\n| `through` | list of alias (1\u20133) | link aliases from this entity outward, each holding one row (`multi: false`) \u2014 the clause\'s field is on the entity the last hop lands on |\n| `field` | alias, required | A member field alias on this entity, or on the entity `through` lands on |\n| `is` | `"self"`, required | The members this column names on a row read that row |\n\n#### Read scope by option\n\n| Key | Type | Meaning |\n|---|---|---|\n| `through` | list of alias (1\u20133) | link aliases from this entity outward, each holding one row (`multi: false`) \u2014 the clause\'s field is on the entity the last hop lands on |\n| `field` | alias, required | A single-select field alias on this entity, or on the entity `through` lands on |\n| `is` | list of alias (at least one), required | Its option aliases whose rows are readable \u2014 naming none would hide every row |\n\n<!-- generated:end read-scope -->\n\n**A row rule is enforced by the platform.** A table\'s `read_scope` is resolved into its own row filters, so\nthe table tools, the data view and the API answer the same rows, and it caps what an app\'s owner can hand out: an\napp never reads beyond its owner\'s reach. An app states its own rule of each table it reads in `rows` on the App\nnode (`reference/app-tree`), in the grammar above. A `"self"` clause reads a column of one member or several, and every group\nand option a clause names must exist.\n\n**A rule holds through a link.** A filter through a link and a List\'s linked column read the linked row under the\nreader\'s own rule of it, and a link to a row the writer cannot read is refused. A lookup, rollup or copy is stored, so\nit reads one value for everyone who reads its table: one over a table with a rule takes `manage` on that table, and\n`get_table` of that table lists them as `crossings`.\n\n**An app runs under its owner\'s authority**, so the people it is shared with need the app and no access to its\ntables. Where they differ in what they may read, `rows` states it: one rule per table, evaluated against the caller,\nnarrowing the app\'s screens, its queries (the AI and MCP path), its writes and acts, and its workflow bodies and app\nagents, every row they read or write. A table `rows` states no rule of is read whole by everyone the app is shared\nwith, so a desk whose audience its sharing already decides states nothing. The rule holds for admins too: an app with people who see every row names them, as a group.\n\n**A row rule is never inherited.** A child read under a ruled record states\nits own in `rows`: the record\'s `member_of` clauses as they are, and its column clauses\n`through` the one-row link the child hangs by \u2014 over one hop or several, each a\nlink with `"multi": false`, since over several rows the rule would admit a\nreader any one of them admits while the editor\'s guard reads the first. Only the\nstatus history takes its record\'s rule.\n\n## Field\n\nEvery field carries the keys below, and its `type`\'s section adds the rest; a\ntype whose section names no `default` takes none. `label` may not contain `{` or\n`}` (formulas reference fields by label at the platform level). Every row in `rows` states each\n`required` field it carries (neither a default nor a `default_from` copy is applied to them), and a required\nLINK is written with its row: the table it names is created first, and tables\nwhose required links name each other are refused, since none of their rows could\never be created.\n\n**A table states who keys nothing.** Whether a person may change a field in an app is that app\'s statement\n(what its tree draws, and `edit: false`, `reference/app-tree`): a post\'s id a publishing workflow brings back, a count a sync fills, a status an act moves\nare left out of the apps that do not save them, and written by a workflow, the records API, the chat agent and an\nimport as the table\'s access allows. A formula, a rollup, a lookup and an autonumber are no one\'s to key already.\n\n<!-- generated:start field -->\n\n#### Field\n\n| Key | Type | Meaning |\n|---|---|---|\n| `type` | `"text"` \\| `"number"` \\| `"date"` \\| `"boolean"` \\| `"select"` \\| `"member"` \\| `"link"` \\| `"files"` \\| `"formula"` \\| `"rollup"` \\| `"lookup"` \\| `"autonumber"`, required | What the field holds \u2014 each type takes the further keys its own section lists |\n| `label` | text, required | The field\'s name in the workspace |\n| `description` | text | The field\'s description, written onto the field in the workspace |\n| `required` | boolean | Refuse a record whose cell for this field is empty. Every write path \u2014 create, update, an agent\'s tool call, a workflow\'s set \u2014 refuses the row by field name. A stored field is flagged only once every row holds a value. |\n\n<!-- generated:end field -->\n\n### `text`\n\n<!-- generated:start field-text -->\n\n| Key | Type | Meaning |\n|---|---|---|\n| `default` | text | Value pre-filled into a new record when none is supplied for this field; the write that makes the field required also fills it into every row holding it empty. |\n| `unique` | boolean | Unique values required |\n| `format` | `"text"` \\| `"link"` \\| `"markdown"` \\| `"time"` | How the words are drawn \u2014 plain, as a link that opens, or as markdown |\n| `default_from` | text | Copied when a record is made off the row a one-row link of this entity names \u2014 `<link alias>.<field alias>` \u2014 or, reading on through one-row links, off the row the last of them names \u2014 `<link alias>.<link alias>.<field alias>` \u2014 and never re-read, so the source changing later leaves the row alone. A value the add states wins; a select copies each option as this field\'s option of the same alias. |\n| `suggest` | [Suggest](#suggest) | A text field whose control offers, as the reader types, the distinct values a text field of a catalog table holds (a damage position\'s code among the codes on file); any text is still written |\n| `min` | number \\| text | Refuse a create or update whose value is below this: a constant for a number, or a field \u2014 `<field alias>` of the same row, or `<link alias>.<field alias>` of the one row a link names \u2014 of the same type (a return date after the departure, a line\'s day inside its trip). On a figure whose unit or currency is per row (its notation\'s `per_row`) a constant bound is only 0; bound it by a field of the row |\n| `max` | number \\| text | Refuse a create or update whose value is above this: a constant for a number, or a field of the same row or of the one row a link names |\n\n<!-- generated:end field-text -->\n\n### `number`\n\n<!-- generated:start field-number -->\n\n| Key | Type | Meaning |\n|---|---|---|\n| `default` | number | Value pre-filled into a new record when none is supplied for this field; the write that makes the field required also fills it into every row holding it empty. |\n| `notation` | [notation](#number) | How the figure reads: { "style": "decimal" }; money, { "style": "currency", "currency": an ISO 4217 code (USD, VND) }; or a quantity, { "style": "unit", "unit": "percent" (10 reads "10%"), or a measured code (g, kg, t, l, m3, cbm, mm, cm, m, km, m2, min, h, day), which converts and scales within its dimension, or any other noun of at most 12 characters (ki\u1EC7n, pallet, TEU), which never does }. A currency or unit read on each row from a single select of that row is { "per_row": that select }. Omitted, a decimal. |\n| `rating` | [Rating](#rating) | The figure is a grade: whole numbers 1 to `max` (3 to 10), empty or one of them, drawn as stars. Only on a plain decimal figure. |\n| `default_from` | text | Copied when a record is made off the row a one-row link of this entity names \u2014 `<link alias>.<field alias>` \u2014 or, reading on through one-row links, off the row the last of them names \u2014 `<link alias>.<link alias>.<field alias>` \u2014 and never re-read, so the source changing later leaves the row alone. A value the add states wins; a select copies each option as this field\'s option of the same alias. |\n| `min` | number \\| text | Refuse a create or update whose value is below this: a constant for a number, or a field \u2014 `<field alias>` of the same row, or `<link alias>.<field alias>` of the one row a link names \u2014 of the same type (a return date after the departure, a line\'s day inside its trip). On a figure whose unit or currency is per row (its notation\'s `per_row`) a constant bound is only 0; bound it by a field of the row |\n| `max` | number \\| text | Refuse a create or update whose value is above this: a constant for a number, or a field of the same row or of the one row a link names |\n\n#### Rating\n\n| Key | Type | Meaning |\n|---|---|---|\n| `max` | integer, required | The scale\'s top: the most stars a grade holds |\n\n<!-- generated:end field-number -->\n\n`notation` is how the number reads, and every surface reads it:\n`{ "style": "currency", "currency": "USD" }` prints as money in its code,\n`{ "style": "unit", "unit": "kg" }` as a quantity with its unit after it,\n`{ "style": "unit", "unit": "percent" }` as a percent \u2014 10 is "10%", never\nmultiplied \u2014 and `{ "style": "decimal" }`, or no notation, as a plain number. One\nkey, so a figure reads one way.\n\nAn absent number is drawn blank, except a `sum` or count rollup read as a meter\'s measure: nothing accumulated yet reads 0.\n\nA unit \u2014 `{ "style": "unit", "unit": "kg" }` \u2014 is what a figure counts or\nmeasures; `percent` aside, it is measured or counted. A **measured** unit is a code of one catalog \u2014 mass `g`\n`kg` `t`, volume `l` `m3` `cbm` (a cubic metre under freight\'s name), length\n`mm` `cm` `m` `km`, area `m2`, duration `min` `h` `day` \u2014 so a figure typed in\nanother unit of its dimension converts (`12,5 t` into a `kg` field is 12 500),\nand a tile or a chart reads it in the largest unit it reaches (12 500 kg as\n12,5 t\u1EA5n; CBM never scales) while a cell, a fact and a column always read in the\nfield\'s own. Any other noun of at most 12 characters (`ki\u1EC7n`, `pallet`, `TEU`) is a\n**counted** unit: a word after the figure that never converts. A measured unit is\nwritten as its code \u2014 `t\u1EA5n`, `KG` or `m\xB3` is refused, naming the code. A formula\nstates its own as its `notation`; a rollup that keeps the value (`sum`, `avg`,\n`median`, `min`, `max`, `range`) and a lookup carry the unit of the figure they\nread, exactly as they carry a currency, and a count carries none. A quantity is a\nnumber with its unit, never words (`3 cartons` in a text field): only a number\nsums, converts and reads down a column.\n\nA field\'s cells always hold figures in its own unit, so moving it between two\nunits of one dimension (`kg` to `t`) converts every stored figure \u2014 a change made\nin the workspace, in the field\'s settings (which say how many first) or through\n`set_tables`. Any other change of unit\nrelabels.\n\nA figure whose unit or currency varies by row names a single select of its own\nrow as `per_row` \u2014 `{ "style": "unit", "unit": { "per_row": "uom" } }`,\n`{ "style": "currency", "currency": { "per_row": "currency" } }` \u2014 or a lookup of\none through a one-link, a line reading its shipment\'s currency. That select\'s\noptions are the vocabulary: each label a unit (`chi\u1EBFc`, `kg`), or an ISO 4217 code\n(`USD`). A label outside it is refused when the figure is written and when the\nselect is \u2014 its options, its type or its deletion while a figure names it. A row\nwhose select is empty reads its figure bare. Every app reads each row\'s figure in\nits own row\'s unit, and a sum never mixes units: totals are one per unit (past three units a total the runtime draws over a set of rows \u2014\nsummary line, group totals and feet, a Sheet\'s table foot \u2014\nstates the count alone; a reading an author states draws every unit), a chart draws one at a time. A rollup that keeps the value (`sum`, `avg`, `min`\u2026)\nover such a figure stands only where the child\'s select is a lookup, through\nthe rollup\'s own link, of a select on this table \u2014 the rollup reads that\nselect\'s unit; otherwise it is refused. A lookup of such a figure stands only\nwhere its table also looks up the figure\'s select (stored, or itself looked up\nthrough one-row links) through the same one-link, and reads in that lookup; otherwise it is refused. A count is unaffected. Moving a field between a\nfixed and a per-row unit relabels.\n\n### `date`\n\n<!-- generated:start field-date -->\n\n| Key | Type | Meaning |\n|---|---|---|\n| `default` | text | Value pre-filled into a new record when none is supplied for this field; the write that makes the field required also fills it into every row holding it empty. A date string in the field\'s format. |\n| `format` | `"date"` \\| `"datetime"` \\| `"month"` \\| `"date_range"` \\| `"datetime_range"` | Whether the field holds a day or a moment, alone or as a span; `month` (stored YYYY-MM) holds a calendar month, a payroll or billing period: a full date written to it keeps its month. |\n| `timezone` | text | IANA timezone |\n| `derive_from` | `"created_at"` \\| `"updated_at"` | Auto-populate from the row\'s system timestamp; the field becomes read-only. |\n| `default_from` | text | Copied when a record is made off the row a one-row link of this entity names \u2014 `<link alias>.<field alias>` \u2014 or, reading on through one-row links, off the row the last of them names \u2014 `<link alias>.<link alias>.<field alias>` \u2014 and never re-read, so the source changing later leaves the row alone. A value the add states wins; a select copies each option as this field\'s option of the same alias. |\n| `min` | number \\| text | Refuse a create or update whose value is below this: a constant for a number, or a field \u2014 `<field alias>` of the same row, or `<link alias>.<field alias>` of the one row a link names \u2014 of the same type (a return date after the departure, a line\'s day inside its trip). On a figure whose unit or currency is per row (its notation\'s `per_row`) a constant bound is only 0; bound it by a field of the row |\n| `max` | number \\| text | Refuse a create or update whose value is above this: a constant for a number, or a field of the same row or of the one row a link names |\n\n<!-- generated:end field-date -->\n\nA `default` is refused beside `derive_from`: the platform stamps that date.\n\n### `boolean`\n\n<!-- generated:start field-boolean -->\n\n| Key | Type | Meaning |\n|---|---|---|\n| `default` | boolean | Value pre-filled into a new record when none is supplied for this field; the write that makes the field required also fills it into every row holding it empty. |\n| `default_from` | text | Copied when a record is made off the row a one-row link of this entity names \u2014 `<link alias>.<field alias>` \u2014 or, reading on through one-row links, off the row the last of them names \u2014 `<link alias>.<link alias>.<field alias>` \u2014 and never re-read, so the source changing later leaves the row alone. A value the add states wins; a select copies each option as this field\'s option of the same alias. |\n\n<!-- generated:end field-boolean -->\n\n### `select`\n\n<!-- generated:start field-select -->\n\n| Key | Type | Meaning |\n|---|---|---|\n| `default` | list of alias | Value pre-filled into a new record when none is supplied for this field; the write that makes the field required also fills it into every row holding it empty. Option alias(es) this field declares \u2014 one for single-select. |\n| `options` | list of [Select option](#select-option) (at least one), required | The choices, in the order every picker and every ladder lists them |\n| `multi` | boolean | Allow multiple selections |\n| `default_from` | text | Copied when a record is made off the row a one-row link of this entity names \u2014 `<link alias>.<field alias>` \u2014 or, reading on through one-row links, off the row the last of them names \u2014 `<link alias>.<link alias>.<field alias>` \u2014 and never re-read, so the source changing later leaves the row alone. A value the add states wins; a select copies each option as this field\'s option of the same alias. |\n\n#### Select option\n\n| Key | Type | Meaning |\n|---|---|---|\n| `alias` | alias, required | Stable local alias, unique within the field |\n| `label` | text, required | Display label for the option |\n| `color` | [colour](#select) | The colour the option\'s badge is drawn in; absent, the option reads as its word wherever its select is drawn |\n| `mark` | [mark](#select) | The option\'s own mark, drawn in place of its colour dot wherever the option is shown: the brand it is ({kind: "brand", name: one of facebook, instagram, threads, meta, tiktok, google-ads, zalo, linkedin, x, google-meet, youtube, telegram, whatsapp, gmail, google-drive, outlook, excel, kiotviet, misa, lark, payos, easyinvoice}) a kit glyph ({kind: "icon", name: "wrench"}) or the face of who it is, drawn from its label ({kind: "avatar", name: "person" or "organization"}). Every option of a field has one, or none does. A mark a reader does not draw falls back to the dot |\n| `short` | text | A few letters the option reads as where room is short \u2014 a table\'s column ("K5" for a long legal category) \u2014 its label shown on hover |\n\n<!-- generated:end field-select -->\n\nA patch of a select states its whole `options` list: a list replaces whole, so an option it leaves out is deleted. To\nrename or recolour one option, restate every option kept, each with its alias. Rows still holding a deleted option refuse\nthe patch unless `force`.\n\n```json\n{\n "options": [\n { "alias": "draft", "label": "Draft" },\n { "alias": "confirmed", "label": "Confirmed" },\n { "alias": "shipped", "label": "Shipped", "color": "green" }\n ]\n}\n```\n\n`color` is one of: `red`, `orange`, `amber`, `yellow`, `lime`, `green`,\n`emerald`, `teal`, `cyan`, `sky`, `blue`, `indigo`, `violet`, `purple`,\n`fuchsia`, `pink`, `rose`, `slate`, `gray`, `zinc`, `neutral`, `stone`.\nEvery option is drawn in its colour wherever it shows \u2014 a cell, a row\'s line,\na record, a picker, the bar a reading splits the rows by.\n\nAn option may carry its own `mark`, drawn in place of its colour dot wherever\nthe option is shown \u2014 a stage, a chip, a filter, a fact, an entry of a log, a\nreading\'s part, a lookup of the select on another table. Where the select is its\nrows\' `records` `mark`, a brand or glyph stands on the row\'s lead tile in the option\'s\ncolour, and an option with none leads with its colour dot there. A select a reader scans\ndown a column \u2014 how a payment was made, the channel, the mode \u2014 states one on every\noption, since a glyph reads before its word: the brand it IS\n(`{"kind": "brand", "name": "tiktok"}` \u2014 one of `facebook`, `instagram`,\n`threads`, `meta`, `tiktok`, `google-ads`, `zalo`, `linkedin`, `x`,\n`google-meet`, `youtube`, `telegram`, `whatsapp`, `gmail`, `google-drive`,\n`outlook`, `excel`, `kiotviet`, `misa`, `lark`, `payos`), a glyph the kit draws\n(`{"kind": "icon", "name": "wrench"}`; any other name is refused), or \u2014 where the\noptions name people or organisations who are no member and no row \u2014 the face of who\nit is, drawn from its label (`{"kind": "avatar", "name": "person"}` or\n`"organization"`). Every option of a select has one, or none does: a run of chips\nwhere one carries no mark reads as the one missing something. `set_tables` writes the\nmarks onto the table. The glyph names are `reference/field/option-glyphs`.\n\n```jsonc\n"options": [\n { "alias": "short_video", "label": "Short video", "color": "zinc", "mark": { "kind": "brand", "name": "tiktok" } },\n { "alias": "print", "label": "Print", "color": "amber", "mark": { "kind": "icon", "name": "newspaper" } }\n]\n```\n\n### Option glyphs\n\nThe kit\'s glyph names an option\'s `mark` takes:\n\n<!-- generated:start field-select-glyphs -->\n\nactivity, align-center, align-left, align-right, align-vertical-justify-center, align-vertical-justify-end, align-vertical-justify-start, arrow-down, arrow-down-a-z, arrow-down-up, arrow-down-wide-narrow, arrow-left, arrow-left-from-line, arrow-right, arrow-right-from-line, arrow-right-left, arrow-up, arrow-up-down, arrow-up-wide-narrow, arrow-up-z-a, ban, banknote, bed, bell, between-horizontal-start, between-vertical-start, bold, bolt, book-marked, book-open, book-text, bot, box, brackets, brain, briefcase, building-2, calculator, calendar, calendar-clock, calendar-off, camera, car, chart-column, check, chevron-down, chevron-left, chevron-right, chevron-up, chevrons-down-up, chevrons-up-down, circle-alert, circle-check, circle-x, clipboard-list, clipboard-paste, clock, code, code-xml, columns-3, columns-3-cog, combine, construction, container, copy, credit-card, database, decimals-arrow-left, decimals-arrow-right, dollar-sign, download, ellipsis, eraser, expand, external-link, eye, eye-off, file, file-csv, file-down, file-question, file-spreadsheet, file-stack, file-text, file-up, folder, folder-closed, folder-open, folder-pen, form, funnel-plus, funnel-x, gauge, globe, gpu, grid-2x2, grip-vertical, group, hand-coins, hash, heading, heading-1, heading-2, heading-3, history, house, image, inbox, info, italic, keyboard, languages, layout-dashboard, layout-grid, library-big, link-2, link-2-off, list, list-checks, list-collapse, list-filter, list-filter-plus, list-ordered, list-tree, loader, lock, lock-keyhole, lock-keyhole-open, lock-open, log-in, log-out, mail, map-pin, maximize-2, megaphone, menu, message-circle, message-circle-question-mark, message-square, messages-square, mic, minimize-2, minus, monitor, mouse, mouse-pointer-click, music, newspaper, notepad-text-dashed, package, paint-bucket, paintbrush-vertical, palette, panel-left, panel-left-close, panel-left-open, panel-right, panel-right-close, panel-right-open, paperclip, pause, pencil, percent, phone, pin, pin-off, plane, play, plug, plus, receipt, rectangle-ellipsis, redo, refresh-cw, repeat, rotate-ccw, rotate-cw, rows-3, scan, scan-line, scissors, search, send, settings, share, share-2, shield, shield-alert, shield-check, shopping-cart, sigma, sliders-horizontal, smile, smile-plus, snowflake, sparkles, split, square, square-check, square-pen, square-sigma, star, stethoscope, sticky-note, strikethrough, table, table-2, tag, target, text-quote, text-wrap, thumbs-down, thumbs-up, ticket, trash, trending-down, trending-up, triangle-alert, truck, tv-minimal, type, underline, undo, upload, user, user-check, user-pen, users, utensils, waypoints, workflow, wrench, x, zap, zoom-in, zoom-out\n\n<!-- generated:end field-select-glyphs -->\n\n### `member`\n\nA person picker over the workspace\'s members. No default. With no role it is still drawn \u2014\nface and name, ranked as a `party` \u2014 in a screen\'s `columns` and in the register\na record draws of these rows.\n\n<!-- generated:start field-member -->\n\n| Key | Type | Meaning |\n|---|---|---|\n| `multi` | boolean | Allow multiple selections |\n| `default_from` | text | Copied when a record is made off the row a one-row link of this entity names \u2014 `<link alias>.<field alias>` \u2014 or, reading on through one-row links, off the row the last of them names \u2014 `<link alias>.<link alias>.<field alias>` \u2014 and never re-read, so the source changing later leaves the row alone. A value the add states wins; a select copies each option as this field\'s option of the same alias. |\n\n<!-- generated:end field-member -->\n\n### `link`\n\n<!-- generated:start field-link -->\n\n| Key | Type | Meaning |\n|---|---|---|\n| `default_from` | text | Copied when a record is made off the row a one-row link of this entity names \u2014 `<link alias>.<field alias>` \u2014 or, reading on through one-row links, off the row the last of them names \u2014 `<link alias>.<link alias>.<field alias>` \u2014 and never re-read, so the source changing later leaves the row alone. A value the add states wins; a select copies each option as this field\'s option of the same alias. |\n| `options_where` | [filter](#filters) | Which rows of the target this link may point at \u2014 an `and` group of plain conditions over the TARGET table\'s own fields, each `field_key` a field alias. It narrows every picker of the link, and a save naming a row outside it is refused on every path \u2014 an app, the grid, an import, a workflow, the API. |\n| `same` | list of alias (at least one) | One-row links this row and each row this link points at must name alike \u2014 a fee\'s invoice is one of its own visit\'s, a box\'s seal one of its own shipping line\'s: each a one-row link of both tables to the same table, or a lookup of one (a line\'s shipping line looked up from its visit, never stored beside it). It narrows the picker\'s read to the rows naming what this row names, a row made from the picker names it too (set, never asked), and a write is refused wherever it lands \u2014 on the link, or on what the two rows compare. |\n| `table` | text, required | The table the link points at: its alias, or the `ref` of another item of the call |\n| `multi` | boolean, required | Whether a row links to one row or many: true, many; false, one. Where the link is paired, at most one of the two sides holds one |\n| `pair` | `true` \\| alias | Makes the link two-way: the alias of its partner field on the other table, which names this one back, or `true` to have the alias derived. Stated on one table, the partner is made on the other with the inverse cardinality; a many-to-many link states both sides |\n\n<!-- generated:end field-link -->\n\n**`multi` is stated on every link:** `true` holds several rows, `false` one \u2014 one customer on an\ninvoice, one project on a device. There is no default.\n\nA two-way link states `pair` on one table, as `true` or a free alias, and the partner is made on the\nother table with the inverse cardinality; a many-to-many link states both sides, since the inverse of\nmany is not decided. A pair stated on both sides is made once. Both tables are written in the one\ncall (`table` names the other item\'s `ref`). A link with no `pair` is one-way, and nothing is created on the target. Pair a link when\nthe target\'s own record should list what points at it, and leave it unpaired when it should not: either\nway the record plan draws the relation as a section on the side it points at, so an unpaired link costs\nthe target nothing. Of two paired links at most one holds one row.\nA link to its own table is paired with itself (a spouse) when `pair` is `true`, and with a second field of that table when `pair`\nnames its alias (a parent and its children, each stating the other); paired with itself it cannot hold one row.\n\n```jsonc\n// a field of table "order"\n"customer": { "type": "link", "label": "Customer", "table": "customer", "multi": false, "pair": "orders" }\n```\n\n```jsonc\n// a field of table "customer"\n"orders": { "type": "link", "label": "Orders", "table": "order", "multi": true, "pair": "customer" }\n```\n\n### `files`\n\nA row attaches documents to it (`reference/rows`). Each file\nis drawn by its kind, with no key to choose: a picture (an image, a video) as its\nthumbnail, a document (a PDF, a sheet) as its type\'s badge and its filename.\n\n### `formula`\n\nA formula states its keys on the field itself, beside `type` and `label`:\n`{ "type": "formula", "label": "Total", "expression": "{quantity} * {unit_price}", "notation": { "style": "currency", "currency": "USD" } }`.\n\n<!-- generated:start field-formula -->\n\n| Key | Type | Meaning |\n|---|---|---|\n| `expression` | text, required | The expression, over fields of THIS entity by alias in braces \u2014 `{quantity} * {unit_price}` |\n| `output_type` | `"number"` \\| `"text"` \\| `"date"` \\| `"datetime"` \\| `"boolean"` \\| `"select"` | Holds a formula to the type its readers need: absent, it is what the expression yields. Stated, it is checked against that and refused where they differ (a datetime is never stated date) |\n| `notation` | [notation](#number) | How the figure reads: { "style": "decimal" }; money, { "style": "currency", "currency": an ISO 4217 code (USD, VND) }; or a quantity, { "style": "unit", "unit": "percent" (10 reads "10%"), or a measured code (g, kg, t, l, m3, cbm, mm, cm, m, km, m2, min, h, day), which converts and scales within its dimension, or any other noun of at most 12 characters (ki\u1EC7n, pallet, TEU), which never does }. A currency or unit read on each row from a single select of that row is { "per_row": that select }. For a formula yielding a number. |\n| `link` | `true` | The formula yields a URL as text, drawn as a link that opens. |\n| `options` | list of [Select option](#select-option) (at least one) | The categories the formula yields, drawn as a single select\'s options are (read-only). The expression yields one of them as `{this_field:option}`, or null \u2014 `{days_idle} > 30 ? {warmth:cold} : {warmth:hot}`. Omit for a formula yielding a plain value. |\n\n<!-- generated:end field-formula -->\n\n`output_type` is what lets a role or a screen clause accept a computed value: a\ncaption over a derived name (`output_type: "text"`), a period over a settled date\n(`"date"`). A formula declaring no `output_type`, `notation` or `link` says nothing\nabout its result, and every rule that needs one refuses it by name. A formula stating\n`options` is a computed category: read-only, and read as a single select\nwherever it is drawn \u2014 a column, a filter, a reading\'s `by` or `where`.\n\n**A select reaches a formula as the KEYS of its chosen options**, a list \u2014\nnever their labels, and never their aliases \u2014 and a document has no keys: the\nworkspace mints them when the table is made. So an option is named in a formula\nas `{field:option}`, both aliases, and the write puts that option\'s key in its\nplace: `includes({kind}, {kind:crate})` for a select holding one or several,\n`{kind}[0] == {kind:crate}` for a single one. A select compared to its own words\n(`{kind} != "Crate"`) matches no row and computes the other branch everywhere,\nso the check refuses it and names the token. A select looked up through a link\nof one row (`multi: false`, or a chain of them) is named the same way:\n`{parent_stage} == {parent_stage:won}`. A lookup through a link holding several\nrows has no single option; it is tested on the table it lives on, in a formula of\nits own, and that result looked up.\n\n**The language.** The check refuses a call or a name the platform cannot run, naming what to write:\n\n<!-- generated:start field-formula-language -->\n\n- Operators: `+ - * / %`, `== != > < >= <=`, `&& || !`; `+` also joins text\n- Numbers: arithmetic is exact decimal (`0.1 * 3` is `0.3`), a division that does not end the nearest double; a comparison between two numbers reads both at 15 significant digits; `round` rounds a half away from zero (`round(-2.5)` is `-3`)\n- Conditionals: a ternary only \u2014 `{amount} > 100 ? "High" : "Low"`\n- Not supported: optional chaining (`?.`), nullish coalescing (`??`), template literals, arrow functions \u2014 use `get(obj, "path", default)`, `coalesce(v1, v2)`\n- Helpers are these names, spelled exactly; a spreadsheet function (`IF`, `SUM`, `LEN`, `DATEDIF`) is none of them, and a formula calling one is refused\n- Math: round(n,decimals?), ceil(n), floor(n), abs(n), min(a,b), max(a,b), sum(arr), mean(arr), clamp(n,min,max), percentage(part,total,decimals?), pow(base,exp), sqrt(n), mod(n,divisor)\n- A select reads as its option keys: compare it with `{field:option}`; read its name as text with `label({field})`\n- Strings: label(select) (the option\'s name; a multi-select\'s names joined ", "), upper(s), lower(s), trim(s), capitalize(s), length(s), contains(s,search), join(arr,sep), split(s,sep), replace(s,search,rep), replaceAll(s,search,rep), removeChars(s,chars) (s without any character that occurs in chars), removeSpaces(s) (s without any whitespace), startsWith(s,prefix), endsWith(s,suffix), substring(s,start,end?), padStart(s,len,char), padEnd(s,len,char), numberToWords(n, lang?) (lang \'vi\' default, or \'en\'), uuidFrom(s) (the same UUID for the same text)\n- Lists: includes(list,value), first(list), last(list), unique(list), compact(list) \u2014 length(list) counts one; join, sum, mean, first, last, unique and compact read a single value as a list of it\n- Dates: now(), formatDate(d,fmt), addDays(d,n), subDays(d,n), addHours(d,n), subHours(d,n), addMinutes(d,n), subMinutes(d,n), startOfDay(d), endOfDay(d), startOfMonth(d), endOfMonth(d), addMonths(d,n), differenceInCalendarDays(later,earlier) (days between two dates, whatever it is searched as: `daysBetween`, `diffDays`, `dateDiff`), differenceInHours(later,earlier), differenceInMinutes(later,earlier), isBefore(d1,d2), isAfter(d1,d2), isSameDay(d1,d2), isToday(d), isWithinRange(d,start,end), datesOn(from,until,days) (the days from..until falling on weekdays named `mon` to `sun`, as a list of dates), meetsBounds(value,kind,{gt,gte,lt,lte},tz?), parseDate(d)\n- Null/type: isNull(v), isEmpty(v) (also true for "" and []), coalesce(v1,v2,...), isString(v), isNumber(v), isBoolean(v), isArray(v), toNumber(v), toFigure(v), toString(v)\n- Other: formatCurrency(amount,locale,currency), formatDecimal(value,decimals,locale) (grouped quantity, no symbol; without decimals, `formatDecimal(value,locale)`, the decimals it holds, at most two, as the app draws a figure), get(obj,"path",default?)\n- Empty cells: a cell nobody filled is null inside a formula, whatever its type; one holding 0, false or "0" is not empty. Test it with `isEmpty({note})` \u2014 `{note} == ""` and `{done} == false` are false on an unset cell\n- Arithmetic over an empty cell: `+` and `-` read it as 0 beside a value (`{fee} + {surcharge}` is `{fee}` when the surcharge is empty, null when both are); `*`, `/`, `%` and a unary `-` yield null (`{price} * {qty}` is null, not 0, when the quantity is empty)\n- No helper throws on an empty cell: the math helpers and toNumber return null, the string helpers "". A value of the wrong type still errors. When EVERY field a formula reads is empty it is null \u2014 unless it reads each only as the argument of isEmpty, isNull or isNotNull (`!isEmpty({file})` is false there, not null)\n\n<!-- generated:end field-formula-language -->\n\n### `rollup`\n\nAggregates the records reached through a link on this table.\n\n<!-- generated:start field-rollup -->\n\n| Key | Type | Meaning |\n|---|---|---|\n| `filter` | [filter](#filters) group | Only linked records matching this filter are aggregated; one condition on its own is a group of one. Every `field_key` in it names a field alias on the linked entity, and a select condition\'s value names an option alias there. A traversal node reaches past that entity, so its `path` hops and inner `field_key` are fully-qualified `entity.field` aliases. |\n| `via` | alias, required | The alias of a link of this table to roll up from |\n| `op` | [operation](#rollup), required | The operation over the linked rows |\n| `field` | alias | The alias of the field on the linked table the operation reads; absent for `count` |\n\n<!-- generated:end field-rollup -->\n\nA rollup states `via` (a link of this table), `op` and \u2014 except for `count` \u2014 `field`, an alias on the\nlinked table; `op` is one of `count`,\n`sum`, `avg`, `median`, `min`, `max`, `range`, `empty`, `filled`,\n`percent_empty`, `percent_filled`, `unique`, `percent_unique`, `earliest`,\n`latest`, `date_range`, `checked`, `unchecked`, `percent_checked`,\n`percent_unchecked`. The operation must be one the aggregated field\'s type\nallows \u2014 `sum` over a number, `earliest` over a date, `filled` over any stored or\nformula field. A lookup is never rolled up: roll up the child\'s own field, or a formula\nover it. A rollup states no `notation`: `sum`, `avg`, `median`, `min`, `max` and `range`\nread in the aggregated figure\'s, a count as a plain number, and a `percent_*` as a\npercent (0\u2013100), in the app as in the table.\n\n### `lookup`\n\nDisplays a field from the linked records: `via` names a link of this table, `field` a field of the table it\npoints at. Through a link holding several rows it holds every linked row\'s value, which an app reads whole: a sort by\nits first value, a filter matching any value, a grouping counting the row under each; `order_by` (`field`, `direction`)\npicks the one row whose value shows instead.\n\n<!-- generated:start field-lookup -->\n\n| Key | Type | Meaning |\n|---|---|---|\n| `via` | alias, required | The alias of a link of this table to look up through |\n| `field` | alias, required | The alias of the field on the linked table to show |\n| `order_by` | [Lookup order](#lookup-order) | Show ONE linked row\'s value \u2014 the first in this order \u2014 rather than every linked row\'s |\n\n#### Lookup order\n\n| Key | Type | Meaning |\n|---|---|---|\n| `field` | alias, required | A field alias on the linked table the rows are ordered by |\n| `direction` | `"asc"` \\| `"desc"`, required | Which end of that order the one row is taken from |\n\n<!-- generated:end field-lookup -->\n\nInside a formula, a lookup holding one value is that value (`{due_soon}` is\n`true`, not `[true]`); several values are a list.\n\n### `autonumber`\n\n<!-- generated:start field-autonumber -->\n\n| Key | Type | Meaning |\n|---|---|---|\n| `prefix` | text | Literal prefix prepended to every display value (e.g. \'KH-\' \u2192 \'KH-001\'). Ignored when `template` is set. |\n| `padding` | integer | Zero-pad the integer to this width. Default 1 (no padding). 3 \u2192 \'001\', \'012\', \'123\', \'1234\' (overflow uses the actual width). Ignored when `template` is set. |\n| `template` | text | Format template with placeholder tokens evaluated at insert time. Tokens: {N} (raw integer), {N:W} (zero-padded to width W, e.g. {N:3} \u2192 001), {YEAR} (4-digit year), {YEAR:2} (2-digit year), {MONTH} (2-digit month), {DAY} (2-digit day). Date tokens use the workspace timezone. Example: \'HM-{YEAR}-{N:3}\' yields \'HM-2026-001\'. Stored as the composed string; subsequent template edits do NOT re-format existing rows (date tokens would lose the original creation date). |\n| `next` | integer | Sets the number the next row takes, once, as the patch is written; never below one past the highest number issued. On a field added to a table with rows, those rows are numbered from it in creation order. It is no setting of the field: a read of the table shows none |\n\n<!-- generated:end field-autonumber -->\n\nA refused write and a dry run take no number, so a table\'s numbers run without a gap; a removed row\'s number is not\nissued again.\n\n<!-- generated:start rules-field -->\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `field.default` | A default names options its select declares \u2014 one on a single select \u2014 and a date stamped by `derive_from` states none. |\n| `field.default-from` | A field\'s `default_from` reads `<link>.<field>` off the row a one-row link of its table names \u2014 a link no copy fills \u2014 or, through further one-row links, `<link>.<link>.<field>` off the row the last names, into a field of the same type, date format and notation that `derive_from` does not stamp (a figure read per row, into one whose select is copied from or looked up off the source\'s select by the same links): a lookup only through a one-row link, a link only into one to the same table, a select\'s option as this field\'s of the same alias (one it lacks is not copied), several values only into a field holding several. The server copies it on every add that fills the link and leaves the field empty, so a List\'s `create` sure to fill the link \u2014 a required one, or the record it files the row under \u2014 does not ask it by default. |\n| `field.option-mark` | An option\'s `mark` is one the kit draws, and a select\'s options mark every one or none. |\n| `field.unit-select` | A notation\'s `per_row` names a single select of the same row, or a lookup of one through a one-link, whose every option label is a unit, or an ISO 4217 code. |\n| `field.link` | A link targets a table of the call or the workspace: its `pair` a link on that table naming this one back \u2014 and of two paired links at most one reads one row (`multi: false`). |\n| `field.formula` | A formula parses, reads fields of its own table by alias, names an option as `{field:option}` of a select it holds, or looks up through a link of one row, and compares a select to its options\' keys, never their words. |\n| `field.formula-type` | A formula yields what it states \u2014 its `output_type` (the type the platform stores: a `"datetime"` is never stated `date`), else a figure where it states a `notation` and text where it states `link` \u2014 as the platform infers it from the expression when the field is created. |\n| `field.rollup` | A rollup aggregates, through a link of its table (`via`), a field of the linked table (`field`) by an operation (`op`) that field\'s type takes \u2014 a figure read in each row\'s own unit or currency only by an `op` that keeps its values whose child select is a lookup, through the rollup\'s own link, of a select on this table \u2014 filtered on fields of the linked table. |\n| `field.lookup` | A lookup reads (`field`), through a link of its table (`via`), a field of the linked table \u2014 a figure read in each row\'s own unit or currency only where this table looks up that row\'s select through the same one-row link \u2014 ordered by a field of it (`order_by`). |\n| `field.computed-cycle` | Computed fields never wait on each other in a loop: each is computed after what it reads. |\n\n<!-- generated:end rules-field -->\n\n## Filters\n\nA table\'s saved views are not part of its document: `set_table_views` writes them and `get_table` lists them. A view\'s\nfilter, a color rule\'s filter, `options_where` and a rollup\'s `filter` share one grammar. Every field reference is a\nfield ALIAS on that table.\n\nA filter is a group \u2014 `{ "node_type": "group", "logic": "and" | "or",\n"children": [ \u2026 ] }` \u2014 or one condition on its own, `{ "node_type":\n"condition", "field_key": "tier", "operator": "has_any_of", "value": ["gold"] }`. A sort is a list of `{ "field_key": \u2026, "order": "asc" |\n"desc" | null }`. A condition states no `type`: its field\'s type decides which `operator` it admits: `has_any_of` / `has_none_of` / `has_all_of` / `is_empty` /\n`is_not_empty` for a select, `equals` / `greater_than` / `less_than` for a\nnumber, `on` / `before` / `after` / `between` for a date, `contains` /\n`is_any_of` for text. A select condition\'s `value` names option ALIASES.\n\n<!-- generated:start rules-color -->\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `color.fields` | A color rule\'s filters name fields of its table. |\n\n<!-- generated:end rules-color -->\n\n## Groups and templates\n\nA member group and a document template are made on their own, outside a table document and an app tree. A tree names a\ntemplate by its alias. A table document names a group by its id, where a `read_scope` clause (`member_of`),\na stage owner (`group`) or a check\'s `member_of("<id>")` takes one. `get_workspace` kind `group` lists the groups with their ids and members; `set_members` creates,\nchanges or deletes one in its `groups` (an admin\'s verb).\n\n`{{name}}` in an `html` or `email` template is filled from the workflow\'s data. Inline content is refused where it holds a\nscript, a frame, a `<link>`, an inline event handler or a `javascript:` URL; an `html` one may be a fragment, kept as\nwritten and printed as a whole document.\n\nA template\'s markup is the `template` of `set_template`, as one JSON string. A paper shaped like a counterparty\'s \u2014 a letterhead, a reference line, a seal, a signature block \u2014 is an `html` template with a shell around the body; `document_templates` covers the types.\n\n**What an act\'s template is handed** is its record\'s own fields by alias: a\nselect, a member and a link as their words (a link as the linked row\'s title), a\nnumber, a date and a computed value that declares its kind raw (`2800000`,\n`2026-09-14`) and a files field as its file cells (`{id, name, mime, url}`, the photos in the order held; a child row\'s\nfiles likewise) \u2014 never a computed select. On one record it is\nhanded, too, the rows of each child List the record draws, listed under that child\'s\nlink\'s name for `{{#each <link>}}` (and under the child entity\'s alias too): every row filed under the record, oldest first, each\nby its own fields as the record\'s are, less its link back to the record. A List that only reads is listed under its `key`, its rows reached by its link\nor, for a `<link>.<link>` path, by both. Over\nseveral rows (at most 200) the rows are listed under the table\'s alias, for\n`{{#each <alias>}}`, an html paper hands each row its own child rows under the same names, with `<name>_totals`.\n\n**Photos in a paper.** A file cell is drawn only if whoever makes the paper may read that file, by the rule the file\nproxy applies; a file they may not read is never drawn. html: `{{#each photos}}<img src="{{url}}">{{/each}}`, each\nphoto inline, only those the data\'s file cells carry (a url typed into a text field stays a link). Word:\n`{{IMAGE picture(cover, 8)}}` for one file cell, and `{{FOR p IN photos}}{{IMAGE picture($p, 8)}}{{END-FOR p}}` for\nmany. Excel: `{{cover | picture:6}}` as the whole cell, and `{{#each photos}}` with `{{this | picture}}` for many, each\nrow growing to its picture. The number is the width in centimetres (8 by default, 6 in Excel); the height follows the\npicture. `picture` takes one image file cell: a list, a file that is no image and a file that cannot be read are\nrefused by name. Photos are embedded at most 1600 pixels across.\n\nHelpers print a raw value in the template\'s `locale` \u2014 `vi` or `en`, the organization\'s language where it states\nnone; each prints `""` for an empty value:\n\n| Helper | Prints (`vi` / `en`) |\n|---|---|\n| `{{money total "USD"}}` | `1.250,50 US$` / `$1,250.50`, in the currency\'s minor units; no code, a number |\n| `{{number qty}}`, `{{number qty unit}}` | `1.234,5` / `1,234.5`: grouped, up to 2 decimals; a unit as the second argument follows it (`{{number qty item_unit}}` prints `6 kg`, `2 l\xEDt` / `2 L`: a measured unit in the language\'s label, a counted noun such as `th\xF9ng` as written) |\n| `{{date issued_on}}` | `14/09/2026`, `14 Sep 2026` in an English template; a date-fns pattern as the second argument, `{{date at "dd/MM/yyyy HH:mm"}}`, literal text quoted (`"\'Ng\xE0y\' dd"`). A moment prints on the workspace\'s timezone |\n| `{{words total "USD"}}` | `M\u1ED9t ngh\xECn hai tr\u0103m n\u0103m m\u01B0\u01A1i \u0111\xF4 la M\u1EF9 n\u0103m m\u01B0\u01A1i xu` / `One thousand two hundred fifty US dollars and fifty cents`; no code, VND (`\u0111\u1ED3ng`) |\n| `{{qr link}}`, `{{code128 position 6}}` | the value as a QR code, or as a Code 128 barcode (ASCII text only), a picture the width of the optional second argument in centimetres, by default sized to the value (a module prints 0.5 mm in a QR code, 0.33 mm in a barcode); a width too narrow to scan is refused, naming the least that does; not in an email template |\n| `{{date (add_days issued_on -1)}}` | `13/09/2026`: the date shifted by whole days (`-1`: the day before), for `date` to print; a number field as the days, empty shifting none |\n\nA value it cannot read (`{{money "abc"}}`, `{{date "14/09/2026"}}`) fails the render. A field named like a\nhelper and written alone (`{{number}}`) prints its own value.\n\nA field printed as a code in the other types: Excel `{{position | qr}}` or `{{position | code128:6}}` as the whole\ncell and the last helper \u2014 the picture is anchored on the cell and its row grows to hold it; Word `{{IMAGE qr(position)}}` or `{{IMAGE code128(position, 6)}}`. An empty field draws no picture.\n\n## Rows\n\n`rows` of a `set_tables` call are the first records of the tables the call creates, keyed by each one\'s `ref`;\na patch of an existing table seeds none, so write its rows into the table. A sample, not a data set: rows past it go in with `create_records` once the tables exist, in the batches its description bounds.\n\n```jsonc\n"rows": {\n "customer": [\n { "ref": "acme", "fields": { "name": "Acme Trading", "tier": "gold" } }\n ]\n}\n```\n\n`rows` sits beside `tables` in the call, not inside a table.\n\n<!-- generated:start rows -->\n\n#### Row\n\n| Key | Type | Meaning |\n|---|---|---|\n| `ref` | text, required | Local handle for this row, referenced by other rows\' link fields |\n| `fields` | map of text \u2192 any value, required | Field alias \u2192 the value, read against the field\'s declared type |\n\n<!-- generated:end rows -->\n\n<!-- generated:start rules-rows -->\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `rows.ref` | A row\'s `ref` is unique within its table. |\n| `rows.required` | A row states every field its table requires: it is created with what it states, its fields\' defaults and copies unapplied. |\n| `rows.value` | A row\'s value fits its field: an option alias for a select, `"<table ref>:<row ref>"` of a row of the linked table in this call or a stored record\'s id for a link, `"self"` for a member, a `fil_` id for files, a date in the date grammar (an hour only on a datetime), a text, number, yes/no or null otherwise \u2014 and none on a computed field. |\n\n<!-- generated:end rules-rows -->\n\nA `ref` is lowercase letters, digits and underscores, and is never persisted.\n\n`fields` is keyed by field alias, and every value is read against the field\'s\nDECLARED type:\n\n| Field type | Value |\n|---|---|\n| `text` / `number` / `boolean` | the value itself |\n| `date` | `"2026-03-14"`, or a relative expression (below) |\n| `select` | the option ALIAS \u2014 `"gold"`, or `["gold","vip"]` for a multi-select |\n| `link` | `"<table ref>:<row ref>"` naming another row of this call \u2014 `"customer:acme"` \u2014 or the id of a record the linked table already holds, or an array for several; a paired link is stated on ONE side (the child\'s link to its parent) and its partner fills itself |\n| `member` | `"self"` only \u2014 the member making the call |\n| `files` | the `fil_` id of a file already in this workspace, or a list of them |\n| `formula`, `rollup`, `lookup`, `autonumber` | not allowed \u2014 the platform writes these |\n\n### Relative dates\n\nA date cell holds a literal `YYYY-MM-DD`, or an expression relative to the day\nthe call is made, so a screen that opens on "this month" is not empty a month\nlater:\n\n- `@today` \u2014 the day of the run, in the workspace\'s timezone\n- `@month-start` \u2014 the 1st of that month\n- either with a whole-day offset: `@today-14`, `@month-start+9`\n- on a date that holds its hour (`format: "datetime"`), that hour after the day, and always stated:\n `@today 14:30`, `@today+1 06:00`\n\n`@month-start` exists because `@today-N` cannot promise a month: applied on the\n2nd, `@today-3` lands in the previous one.\n\n## Records\n\n`records` says how a row of a table is RECOGNISED \u2014 stated once in the table\'s document, beside its\n`title` \u2014 and every surface that draws one of its rows reads the same\nstatement: the register\'s row, a picker\'s option, a link\'s chip, a child table\'s\nrow and the record\'s header. Every table an app lists, opens or picks has one. The rarer keys \u2014 `scan`, `cadence`, `place`, `on_site`, `pin`, `plan_place` and `size` \u2014 are stated on `reference/record-places-pins-and-cadence`.\n\n```jsonc\n// table "visit"\n"title": "container_no",\n"records": {\n "subtitle": ["customer", "arrived_on"],\n "image": "photos",\n "status": { "field": "stage", "closed": ["gone"], "history": "visit_history" },\n "figure": "total_fees",\n "due": ["free_until"]\n}\n```\n\n```jsonc\n// table "release": a release order read against what it allows \u2014 a meter wherever it shows\n"title": "release_no",\n"records": { "figure": "issued", "limits": { "issued": "units" } }\n```\n\n```jsonc\n// table "dossier": a straight-line process \u2014 the stage a select, each step\'s day the date it stamps\n"title": "applicant",\n"records": { "status": { "field": "stage", "closed": ["signed"], "dates": { "received": "received_on", "appraised": "appraised_on", "signed": "signed_on" } } }\n```\n\n<!-- generated:start records -->\n\n#### Record\n\n| Key | Type | Meaning |\n|---|---|---|\n| `subtitle` | list of alias (1\u20132) | Up to two fields read under the title wherever a row is drawn (a code, a date, a party): the first at the body ink and the rest muted, one line at a desk, a second on a phone; a card shows one line per column |\n| `image` | alias | A files field that pictures the row, or a one-row link to a table with a picture, whose picture the row leads with \u2014 never a files field an act keeps the document it makes in. Absent, a table with exactly one files field is pictured by the first image in it \u2014 never a paper or other file \u2014 unless the entry states a `mark` or puts that field in the title or subtitle; an app turns it off with `row.image: false`. |\n| `mark` | alias | A single select (or a lookup of one through a one-row link) whose option leads the row wherever a mark leads it \u2014 a list\'s row, the record\'s head, a link naming the row: the option\'s brand or glyph, else its colour dot, on a tile. The field stays a field: a subtitle run, a column, a section\'s control. A write setting a formula mark is refused (a derived flag is an issue) and a stored one keeps drawing; never beside `image` or `party`, and never the status field |\n| `description` | alias | A text field saying what the row is about \u2014 a plan\'s brief, a customer\'s note: read in its record\'s head under the title\'s line, its first lines at rest and whole on a press, and written from the head\'s \u270E. Never on a row\'s line |\n| `party` | `"person"` \\| `"organization"` \\| `"organisation"` | What each row is where the rows are people (a contact, a patient) or organisations (a customer, a supplier, a carrier); absent, the rows are things (an order, an item, a paper) |\n| `status` | [Status](#status) | The stage a row moves through, a single select, drawn in the record\'s head, or its Side where the Side states it |\n| `figure` | alias | The one number the row stands for, read at its right (a total, a quantity left) |\n| `limits` | map of alias \u2192 (alias \\| number) | A number read against a bound \u2014 a field of the same row or a constant \u2014 drawn as a meter wherever it shows |\n| `gates` | map of alias \u2192 (alias \\| number) | A pass mark on a meter `limits` bounds \u2014 a field of the same row or a constant; a percent field is its share of the bound, any other number an amount. The meter marks it and fills complete once past it |\n| `tolerance` | map of alias \u2192 number | How far past its `limits` bound a meter may stand, in percent of the bound: the bound is an amount expected (received against ordered), not a cap. Without one the bound is a cap, and past it is an overrun |\n| `due` | list of alias (at least one) | Dates that are deadlines (stored, or computed as a date): each counts down and turns overdue until the row is at a `closed` option or `settled` holds, whatever stage it has moved to. A deadline is never an appointment date or the day a stage starts |\n| `frees` | alias | A date ending the row\'s span of days on which what the row holds is free again (a check-out, a hire\'s return): a stay from the 3rd to the 5th holds the 3rd and the 4th, and another may start on the 5th \u2014 on a lanes board, a calendar, a roster and in `no_overlap` alike. Absent, a span of days holds its last day; a span of moments always frees its end |\n| `settled` | alias | A yes/no of the row (stored, a formula: an invoice paid in full, or looked up through a one-row link: a line settled with its parent) that ends its deadlines: while it is true, no `due` of the row counts down or turns overdue \u2014 in a cell, on its line, in its head, on a calendar or gantt, or in the overdue count. A Sheet\'s or reading\'s `where` reads it as any other yes/no |\n| `task` | `true` | A row is work someone finishes: wherever rows of it stand in a table \u2014 a register, a record\'s rows, the rows filed under one \u2014 each is led by a ring ticking it done and unticking it by the one write of the app making that move. Its status is a stored select with `closed` |\n| `applies` | map of alias \u2192 map of alias \u2192 (list of alias (at least one) \\| boolean) | Fields that apply only while their conditions hold (a length only on a line whose tariff charges by the metre): where one does not apply no add asks it and no surface shows it. Never the title; a required one starts at its `default` |\n| `starts` | map of alias \u2192 `"today"` \\| `"me"` | What a field of a row being added starts at, where that start is certain: `today` a date (a moment starts now), `me` a member, the reader adding it; every other field starts empty unless the reader narrowed the register to a value or the field declares a `default` |\n| `issues` | list of (alias \\| [Rolled issues](#rolled-issues)) (at least one) | What is wrong with a row, in priority order, standing in every app that draws it: a formula of the row stating `output_type` boolean (true stands) or text (non-empty stands, its words the sentence), named by alias \u2014 its label is the issue\'s name; or `{ rows: <link> }`, a many-link paired to a one-row link, which rolls up the issues the linked table declares itself, each kept as a count on this table (`<link>_<issue>`), at that position. A derived flag is an issue: state a yes/no formula for each case |\n\n#### Rolled issues\n\n| Key | Type | Meaning |\n|---|---|---|\n| `rows` | alias, required | A many-link of this table, paired to a one-row link on the linked table, which declares issues of its own: each is counted here as `<link>_<issue>`, a roll-up of the linked rows holding it |\n\n<!-- generated:end records -->\n\n<!-- generated:start rules-records -->\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `records.title` | A title is the one field naming the row \u2014 any field but a button or a yes/no \u2014 and the subtitle never names the title\'s own field. |\n| `records.image` | `image` is a files field, never one an Act keeps the documents it makes in (`into`), or a single link to a table with a picture (never beside a `party`). |\n| `records.mark` | `mark` is a single select or a lookup of one through a one-row link, never a formula (a write setting one is refused: a derived flag is an issue), never the status field, nor on the folder an App works inside (`scope`), which its switcher names by a picture or its initials. |\n| `records.description` | `description` is a text field, read in the record\'s head \u2014 never a Field of a part too. |\n| `records.issues` | An issue is a formula of the row stating `output_type` "boolean" or "text" (a derived flag is an issue, never a select), listed once among the table\'s issues, or `{ rows }` naming a many-link paired to a one-row link, listed once, to a table that declares issues of its own \u2014 each rolled issue held as the count `<link>_<issue>` on the table. |\n| `records.figure` | A figure is a number. |\n| `records.applies` | `applies` holds a field of the row other than its title to conditions of the same row \u2014 a yes/no (stored or a formula) by `true` or `false`, a single select by its options, its own or looked up through a one-row link \u2014 never to itself; a required field it holds starts at a `default`. |\n| `records.limits` | `limits` bounds a number by a number field of the row, in its unit or one of the same dimension \u2014 or by a constant, where every row reads the figure in one unit. |\n| `records.gates` | `gates` marks a pass on a meter `limits` bounds: a percent field (its share of the bound), another number in the bound\'s unit, or a constant. |\n| `records.tolerance` | `tolerance` stands on a meter `limits` bounds. |\n| `records.starts` | `starts` starts a field a person writes \u2014 `"today"` a date or a moment (never a span), `me` a member \u2014 and a `create` that does not ask a field it starts writes that start. |\n| `records.due` | A deadline (`due`) is a date. |\n| `records.frees` | `frees` names a stored day, never a moment: a span of moments already frees its end. |\n| `records.settled` | `settled` names a yes/no of the row (stored, a formula, or looked up through a one-row link) beside a `due`: while it holds, the row\'s deadlines neither count down nor turn overdue. |\n| `records.task` | A task entity (`task`) states a `status` of a stored single select with `closed` options \u2014 its ring ticks a row done by moving it to one. |\n| `records.cadence-makes` | *Noted, never refused:* An entity with a multi-select of weekdays that no `cadence` reads, whose rows a one-row child holding a date stands under, states a `cadence` naming the child, and an Act `makes` its rows. |\n| `records.picture` | *Noted by the designer on a write, never refused:* Rows an App draws that each hold one files field no Act makes documents into, no call is filed into, no files gallery keeps and no List compares as a pair (`compare`) \u2014 and no figure \u2014 are pictured by it (`image`); where the workspace\'s files are known, the field holding images is the picture, a figure or not. |\n| `records.mark-derived` | *Noted, never refused:* A table whose `records.mark` is a formula keeps drawing it; a derived flag is an issue, so a write setting `mark` to a formula is refused (`records.mark`) and a stored one keeps drawing. |\n| `records.mark-lead` | *Noted by the designer on a write, never refused:* Rows an App draws of an entity that states a single select besides its status whose options state a mark, and states no `mark`, `image` or `party`, can lead with that field\'s option as their mark (`records.mark`). |\n| `records.stage-holder` | *Noted, never refused:* A stage owned by a member field of the row itself, where the table does not require that field and no `create` or Act of the App states it (asks, sets, requires or writes it), lets a row reach the stage with the field empty: require the field, or state it in a `create` or an Act. |\n\n<!-- generated:end rules-records -->\n\n- **The title names the row** by who or what it is \u2014 a link by the linked row (a job\n read by its customer). Any field but a button or a yes/no may title it, yet a code\n titles a row only where people name the row by it, else it is a `subtitle`; it is the table\'s own setting, which every link shows.\n- **One lead per row.** A row leads with its picture (`image`), a face (`party`) or the\n option of a single select it holds (`mark`) \u2014 never two. A `mark` draws that option\n on a tile: its brand or glyph, else its colour dot; a row holding none, a ring saying\n none is picked. The same tile heads the row\'s record and leads it where a link\n names it; the select stays a field \u2014 a subtitle run, a column, a section\'s control.\n- **A limit** reads a number against a bound \u2014 another field of the row, or a constant.\n A `gates` entry marks a pass on that meter: a percent field is its share of the\n bound, any other number an amount.\n- **A deadline** (`due`) counts down wherever it is drawn and is overdue once past while\n the work is open. A register over the table says how many rows in view are overdue on\n its summary line, and pressing that count narrows to them \u2014 no reading to state.\n- **A span\'s free day** (`frees`) is the end date on which what the row held is free\n again \u2014 a check-out, a hire\'s return. A stay from the 3rd to the 5th holds two nights:\n a lanes board, a calendar and a roster draw it through the 4th, and `no_overlap` lets\n the next stay start on the 5th. Without it a span of days holds its last day; a span of\n moments always ends as the next may begin.\n- **`starts`** is where an add\'s field begins, stated only where that is certain \u2014 a\n log\'s own day at `today`, a request\'s requester at `me`. Nothing else starts a field\n but its declared `default` and what the reader narrowed the register to.\n\n## Record places, pins and cadence\n\nThe rarer keys of `records`, stated beside the ones on `reference/records`: a title read off a photo (`scan`), the rows a child owes each day (`cadence`), where a row stands on a map (`place`, `on_site`) or on a picture (`pin`, `plan_place`).\n\n```jsonc\n// table "site": it owes a diary page each day it works, from breaking ground through handover\n"title": "name",\n"records": { "cadence": [{ "entity": "diary_page", "on": ["mon", "tue", "wed", "thu", "fri", "sat"], "from": "started", "until": "handed_over" }] }\n```\n\n<!-- generated:start records-places -->\n\n#### Record places\n\n| Key | Type | Meaning |\n|---|---|---|\n| `cadence` | list of [Cadence](#cadence) (at least one) | The rows of a child each row owes one of a day, on the days of the week listed or its own multi-select names (a site\'s diary page, Monday to Saturday; a class\'s Tuesdays and Thursdays at 16:00) \u2014 one entry a child, never owed on a day still to come; an Act\'s `makes` makes them. A roster of these rows over days marks a past day owed with none missing in the danger tone, counted in the legend; today\'s is due, offered to add and never marked; each row\'s total reads the days it holds of those owed |\n| `scan` | `"text"` \\| `"iso6346"` \\| `"code"` | Its title, a text field, is painted or printed on the thing a row is (a container\'s number, a seal\'s) and read off one photo on a phone, beside each search matching it and each field holding or picking it: `iso6346` a container number, refused unless its check digit holds; `text` as it stands; `code` a barcode or QR code on the thing, decoded on the device from the photo with no agent |\n| `place` | [Place](#place) | Where a row stands, as plain fields of it, drawn as one place where its record draws the address: how sure it is, a press opening it in the device\'s maps, and one taking it from where the device stands |\n| `plan_place` | [Plan place](#plan-place) | Each row is a place on the plan a `plan` register draws: its title the place\'s code, its subtitle a note. A flat list, no tree |\n| `on_site` | [On site](#on-site) | Photos taken where a place stands (a site diary\'s): a photo taken through a phone\'s camera here keeps where the device stood, marked at the place, away from it or unknown, and a record holding one taken away says so among its checks \u2014 one with no place (picked on a computer, or kept before places were) is marked and warns nothing; a place reaches only members of the organization, through the apps drawing these photos |\n| `pin` | [Pin](#pin) | Each row is a place on a picture (a snag on a flat\'s plan, a spot on a container\'s drawing): a List of these rows draws the picture its `on` row holds with a numbered pin at each row\'s own place, each row led by its number, the row opened lit on it and a pin pressed opening its row; where the List writes rows, a press on the bare picture adds one there, and a pin dragged moves its row. A List of rows that link to these by a single link draws their places the same way |\n| `size` | [Record size](#record-size) | The real size of the thing a row is (a carton, a piece of furniture, a pallet): three number fields stating one length unit alike, read as one fact \u2014 "400 \xD7 300 \xD7 250 mm", a part the row lacks "\u2014" \u2014 after the subtitle wherever the row\'s line and head draw facts, never also as the subtitle\'s fields. A plan register drawing these rows draws each box at this size |\n\n#### Cadence\n\n| Key | Type | Meaning |\n|---|---|---|\n| `entity` | text, required | The table owed: each of its rows stands on one row of this table by its single link to it, and on the first date of its line (`records` title or subtitle) |\n| `on` | list of `"mon"` \\| `"tue"` \\| `"wed"` \\| `"thu"` \\| `"fri"` \\| `"sat"` \\| `"sun"` (at least one) \\| alias, required | The days of the week one is owed on: listed (`mon` to `sun`, each once), or a multi-select of this row whose option aliases are `mon` to `sun` |\n| `from` | alias | A date of this row: the first day one is owed (a site breaking ground, a contract\'s start); absent, no first day |\n| `until` | alias | A date of this row: the last day one is owed (a site\'s handover, a contract\'s end); empty or absent, through today |\n| `start` | alias | A `format: "time"` field of this row (a lookup too): the time of day the child\'s first date starts at, where that date holds a moment |\n| `end` | alias | A `format: "time"` field of this row, where the child\'s second date holds a moment: the same day, or the next where it is earlier; or a number field of this row, the days each runs, where the child\'s dates are days (its last day is the first plus the days less one; an empty length leaves the row unplaced) |\n| `planned` | alias | A stored date of the child, by its alias on that table: the day it was made for, kept when it moves. Set by what makes it, and read for what is still owed; state it with the child\'s link in `unique` |\n| `except` | text | A table of closed days: each of its rows closes the days from the first date on its line to the second. Nothing is owed on them |\n\n#### Place\n\n| Key | Type | Meaning |\n|---|---|---|\n| `address` | alias, required | A text field: the address, as people write it |\n| `latitude` | alias, required | A number field: degrees north, negative south |\n| `longitude` | alias, required | A number field: degrees east, negative west |\n| `accuracy` | alias | A number field: how many metres off the device that gave the place said it may be |\n\n#### On site\n\n| Key | Type | Meaning |\n|---|---|---|\n| `photos` | list of alias (at least one), required | Files fields of this row holding photos taken on site |\n| `place` | alias | A single link of this row to the row whose `place` its photos are taken at (a diary page\'s site); absent, this row\'s own `place` |\n| `radius` | number, required | How many metres from the place a photo still counts as taken there |\n\n#### Pin\n\n| Key | Type | Meaning |\n|---|---|---|\n| `on` | alias, required | A single link of this row to the row whose picture (its `records` `image`) the place is on \u2014 a container\'s drawing, a floor\'s plan |\n| `x` | alias, required | A number field of this row: how far across that picture the place stands, in percent from its left edge |\n| `y` | alias, required | A number field of this row: how far down that picture the place stands, in percent from its top edge |\n\n#### Record size\n\n| Key | Type | Meaning |\n|---|---|---|\n| `across` | alias, required | A number field: the width of the thing a row is, across |\n| `along` | alias, required | A number field: its depth, along |\n| `up` | alias, required | A number field: its height, up |\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `records.scan` | A title read off a photo or a code (`scan`) is a text field the row stores. |\n| `records.cadence` | A `cadence` names each child once \u2014 its rows standing on one row of this entity by their single link and on the first date of their line \u2014 and its `on` lists each day of the week once, or names a multi-select of this entity whose options are all aliased mon to sun. `from` and `until` are two different days of this entity. `start` and `end` are `format: "time"` fields of this entity (a lookup too): `start` where the child\'s first date holds a moment, `end` where its second does, or `end` a number of days where its dates are days. `planned` is a stored date of the child, never its first or second. `except` is an entity whose line holds a date. |\n| `records.place` | A `place` names four different fields of the row: its address a text field, its latitude, longitude and accuracy number fields it stores. |\n| `records.plan_place` | A `plan_place` names `kind` and `reach_from` as single selects, `sheet` as a single select or a one-row link, `stacked` as a boolean and the rest as numbers, each a different field; `kind`, `x`, `y` required. `size` names three numbers (`across`, `along`, `up`) stating one cell in one length `unit` alike. A `sheet` linking to an entity that states an `image` draws that drawing under the places, `scale` (a number field of that entity) its width in cells; `scale` goes with such a `sheet` alone. |\n| `records.on_site` | `on_site` lists files fields of the row, each once, taken at the `place` of the row itself or of the one row a single link of it names (`place`), which states one. |\n| `records.pin` | A `pin` names a single link of the row (`on`) to an entity whose `records` states its `image` (a PDF is drawn as its first page), and two different number fields of the row, how far across (`x`) and down (`y`) that picture in percent. A List of rows whose own entity states a `pin` is drawn over that picture; `on`, `x` and `y` are set by the press that adds a row, never asked. |\n| `records.size` | A `size` names three different number fields of the row (`across`, `along`, `up`) stating one length unit alike (mm, cm, m or km); they read as one fact after the subtitle, so the subtitle never also names one. |\n\n<!-- generated:end records-places -->\n\n## Status\n\nA record\'s `status` is the stage a row moves through \u2014 a stored single select, each\noption\'s moment the date `dates` names. A record draws it as its dot and word where Act buttons on the page offer its moves, and as a control for the moves no drawn Act offers: choosing one runs its Act, asking and refusing as its button does.\n\n<!-- generated:start status -->\n\n#### Status\n\n| Key | Type | Meaning |\n|---|---|---|\n| `field` | alias, required | The single select that is the row\'s state, its options in the order the work goes through them, read as steps by itself on a record whose parts state no `at` |\n| `closed` | list of alias (at least one) | Options that end the work: a register opens on the rows not at them, and the badge reads muted |\n| `dropped` | list of alias (at least one) | Options of `closed` that leave the work undone (cancelled, rejected): whoever holds the row moves it to one from any stage, where every other move forward passes each owned stage between that binds the row (its `when`) and needs each one\'s owner, and a row leaving one enters a stage as a row made there does |\n| `history` | text | A table every write that sets or moves the status appends one row to (its link to this table, the new status, the moment and who) \u2014 by the record write path, whoever writes: for reporting on every move |\n| `dates` | map of alias \u2192 alias | Option alias \u2192 a date field of this entity the record write path stamps with the moment a row moves into that option, or is made at it \u2014 whoever writes. A value the same write states for that field wins, so past data loads as it happened \u2014 and the `history` records the move at that day, a row made at a later option recording each earlier one whose date the write states, in order; the platform never clears a stamp, so each is when the row last entered the option. A stage\'s date is made where none is named |\n| `stages` | map of alias \u2192 [Stage](#stage) | Option alias \u2192 who owns that stage and how long it should take: the owner alone takes a row out of it, by any write, and presses the acts offered there; every move forward past it of a row it binds (its `when`), and every such row made past it, is its owner\'s too. Its days run from the moment its `dates` field holds. In an app the status then moves only by acts that `set` one of its options \u2014 no save writes it and no act asks it |\n\n#### Stage\n\n| Key | Type | Meaning |\n|---|---|---|\n| `owner` | `"field"` \\| `"link.field"` \\| `{ "group": id }`, required | Who owns the stage: a member field of the row, `link.field` read through a one-row link (not at the stage a row opens at, whose owner made the row: a member field of the row itself), or `{ group }`. A member moves a row off only one stage that groups own, one at a time: the next waits on a different member, or on a stage stating no owner; a row made past a stage signs nothing there |\n| `within` | integer | Whole days the stage should take from the moment the row entered it |\n| `when` | map of alias \u2192 (list of alias (at least one) \\| boolean \\| [comparison](#values) \\| `{ "empty": true \\| false }`) | The rows that must pass this stage: a row meeting every entry on its own fields, as it stood before a write or as the write leaves it \u2014 a single select holding one of these options, a yes/no this value, a number or date meeting its bounds, a field empty or filled. Absent, every row must. A row at the stage leaves it by its owner either way |\n\n#### Stage group\n\n| Key | Type | Meaning |\n|---|---|---|\n| `group` | text, required | A group of the workspace, by id: its members press the act. One person moves a row off only one of the stages different groups own |\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `records.status` | A status is one single select, its options in the order the work goes through them, `closed` naming the ones that end it and `dropped` those of them reached from any stage. |\n| `records.history` | A declared status `history` has exactly one link to the row it records, one single select holding every option of the status (or a text), exactly one date and at most one member. |\n| `records.stages` | A stage\'s owner (`status.stages`) is a single member field of the row, one read through a one-row link (never at the stage a row opens at: its owner made the row, so it is a member field of the row itself), or a group, on an option that does not end the work; a group\'s stage needs the status `history` with who moved the row. Every write takes a row off a stage as its owner alone, and moves a row past it or makes a row past it as its owner alone where the stage binds the row (its `when`) \u2014 a move to a `dropped` option excepted, which whoever holds the row makes from any stage; a row leaving a dropped option, or holding none, enters a stage as one made there. Each stage\'s moment, and each open option\'s, is the date its `dates` names, made where none is named, which every write that opens or moves the status stamps; `within` runs from it. In an App a status with stages moves only by Acts that `set` one of its options \u2014 no save writes it or a date it stamps, and no Act asks either, sets it otherwise or writes either from a workflow; an Act moving a row forward past a stage another owner owns, into an option not `dropped`, keeps its `when` off every row that stage binds. |\n| `records.stage-when` | A stage\'s `when` names the rows that must pass it, as an Act\'s `when` holds them \u2014 single selects to their options, yes/nos to `true` or `false`, numbers and dates to bounds, any field to `{ "empty": true \\| false }` \u2014 on fields a write stores of the row itself: never the status, a formula, a lookup or a rollup, and never on the stage a row opens at. It binds a row meeting it as it stood before a write or as the write leaves it; absent, it binds every row. |\n\n<!-- generated:end status -->\n\n- **The status** is one single select. `closed` options end the work: a register opens\n on the rows not in them, a row holding no status among them. A `history` table gets one row per move \u2014 its link to this\n table, the new status (a select holding the same option aliases, or text), the\n moment (the stage\'s `dates` value where the write states a past one, so loaded rows keep\n the day they reached it) and who \u2014 appended by the record write path in every write that opens a row at a\n stage or moves it, whoever writes (the member behind the write is its `by`; an automation\n leaves it empty). A `history` the tables do not declare is derived, and needs no\n `records` of its own.\n- **When each step happened** is the date `dates` names for its option, stamped as the row\n enters it, whoever moves it. One way times a status: a straight-line process is a select\n whose options are its steps in order, each with its date \u2014 never a run of dates the stage\n is read off. An Act that moves the stage and `asks` the step\'s date with `starts: "today"`\n lets the reader record a day already past in the same press.\n\n## Write rules\n\nWhat a WRITE of a table\'s rows meets is stated in the table\'s document, where it applies: `min` and\n`max` on a number or date field, `options_where` and `same` on a link, `suggest` on a text field,\nand `no_overlap` and `natural_key` on the table. A key a field\'s type does not take is refused at\nits path, and a document has no `write_rules` key.\nEvery one but `natural_key` and `suggest` holds on every path a record is written by \u2014 the grid, a record\'s form, an import, a workflow, an\nagent, the API, an app \u2014 judged in the write\'s own transaction, every broken rule listed at once; the\nscreen and a picker only mirror them. A row that already breaks one stays editable until a write\ntouches what the rule reads. `natural_key` names the fields an app recognises a row by, to reuse it where an\nadd or a find-or-create meets it; a record tool or the API creates the row it is handed. `suggest` offers\nvalues in a text control and refuses none. An `options_where` link is refused where a write names a row the\nnarrowing does not admit, and every picker of the link offers only the rows it admits.\n\n```json\n{\n "tables": [\n {\n "ref": "customer",\n "label": "Customer",\n "fields": { "email": { "type": "text", "label": "Email", "unique": true } },\n "natural_key": ["email"]\n }\n ]\n}\n```\n\nA customer above is RECOGNISED by their address. An add that names one \u2014 from the customers\nregister or from a picker\'s "new" \u2014 reuses the row it matches and opens one only where nothing does,\nso the book never grows a second Acme.\n\n```json\n{\n "tables": [\n { "ref": "product", "label": "Product", "fields": { "name": { "type": "text", "label": "Name" }, "in_stock": { "type": "number", "label": "In stock" } } },\n {\n "ref": "order",\n "label": "Order",\n "fields": {\n "name": { "type": "text", "label": "Name" },\n "placed_on": { "type": "date", "label": "Placed on" },\n "due_on": { "type": "date", "label": "Due on" },\n "lines": { "type": "link", "label": "Lines", "table": "order_line", "multi": true, "pair": "order" }\n }\n },\n {\n "ref": "order_line",\n "label": "Order line",\n "fields": {\n "name": { "type": "text", "label": "Name" },\n "order": { "type": "link", "label": "Order", "table": "order", "multi": false, "pair": "lines" },\n "quantity": { "type": "number", "label": "Quantity", "min": 1, "max": 9999 },\n "ships_on": { "type": "date", "label": "Ships on", "min": "order.placed_on", "max": "order.due_on" },\n "product": {\n "type": "link",\n "label": "Product",\n "table": "product",\n "multi": false,\n "options_where": {\n "node_type": "group",\n "logic": "and",\n "children": [{ "node_type": "condition", "type": "number", "field_key": "in_stock", "operator": "greater_than", "value": 0 }]\n }\n }\n }\n }\n ]\n}\n```\n\nA line of nothing is not a line: `quantity` is refused on create and on update. A line ships inside\nits order\'s window \u2014 a bound read off the row a link names is judged when the line is written. Nothing is sold off an empty shelf: every picker of `product`\nreads only the rows that answer its `options_where`, and every save refuses the same rows again.\n\n```json\n{\n "tables": [\n {\n "ref": "booking",\n "label": "Booking",\n "fields": {\n "room": { "type": "text", "label": "Room" },\n "state": { "type": "select", "label": "State", "options": [{ "alias": "held", "label": "Held", "color": "blue" }, { "alias": "released", "label": "Released", "color": "gray" }] },\n "starts_on": { "type": "date", "label": "Starts on" },\n "ends_on": { "type": "date", "label": "Ends on", "min": "starts_on" }\n },\n "no_overlap": { "from": "starts_on", "to": "ends_on", "by": ["room"], "while": { "state": ["held"] } }\n }\n ]\n}\n```\n\nOne booking per room at a time, while it is held \u2014 a create or a save whose span overlaps another\nheld booking of the same room is refused.\n\nA table\'s `checks` (the conditions no write of its rows may meet) are stated in its document and hold on every path a record is written by; their keys, what they read and an example are on `workflows/table-checks`. What follows every committed write of its rows is a workflow, written with `set_workflow` (`workflows/table-workflows`).\n\n<!-- generated:start write-rules -->\n\n#### Suggest\n\n| Key | Type | Meaning |\n|---|---|---|\n| `table` | text, required | The table whose text field is offered from: its id, or its `ref` in this call |\n| `field` | alias, required | The alias of that table\'s stored text field; the field\'s control offers, as the reader types, the distinct values it holds, and any text is still written |\n\n#### No overlap\n\n| Key | Type | Meaning |\n|---|---|---|\n| `from` | text, required | The stored date (or datetime), or time of day (a `format: "time"` text field), a row\'s span starts on: `<field alias>` of the row, or `<link alias>.<field alias>` of the one row a one-row link names (a booking line\'s piece held for its booking\'s dates) |\n| `to` | text, required | The stored date (or datetime) a row\'s span ends on, named like `from` and through the same link \u2014 a day it holds, unless `records` names it the day the row `frees`; a moment another row may start at |\n| `by` | list of text (at least one) | Fields two rows share to compete for a span (the same employee, the same room): `<field alias>`, or `<link alias>.<field alias>` of the one row the span is read through. A field holding many values (a multi-select, a link to several rows, several members) competes where two rows share any one; absent, every row |\n| `while` | map of text \u2192 list of alias (at least one) | Only rows at these options of these selects hold their span (running, not closed), the select named like `from` \u2014 `<field alias>` or `<link alias>.<field alias>`; absent, every row |\n\n<!-- generated:end write-rules -->\n\n<!-- generated:start rules-write -->\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `write.natural-key` | A `natural_key` is text or a number a person types back, or a one-row link; a text key is unique \u2014 `unique: true`, or the key\'s fields as a set in the table\'s `unique`. |\n| `write.bounds` | `min` and `max` bound a number, a date or a time of day \u2014 by a constant a number, by a field of this row or of the one row a one-row link names either, of the same type and unit, never by itself \u2014 and `min` is never above `max`. |\n| `write.bound-per-row-unit` | On a figure whose unit or currency is the row\'s own (its notation\'s `per_row`) a constant bound is only 0 \u2014 bound it by a field of the row. |\n| `write.suggest` | `suggest` stands on a stored text field and names a `table` and a `field`, a stored text field of that table; the app reads that table, so it has a `records` entry. |\n| `write.same` | `same` stands on a link and names one-row links, or lookups of one, this table and the link\'s target both hold to one table. |\n| `write.options-where` | `options_where` narrows a link by an `"and"` group of plain conditions over the target\'s own fields \u2014 a number compared in one unit on every row, a select by options it declares. |\n| `write.no-overlap-night` | *Noted, never refused:* `no_overlap` between two times of day reads a span ending at or before its start within its own day: to midnight, then from midnight. |\n| `write.no-overlap-pair` | *Noted, never refused:* A dated table with a link to a person and a link to a resource, and a `no_overlap` by only one of them, lets the other be held twice: name each in a rule, in a list. |\n| `write.no-overlap` | `no_overlap` is a rule, or a list of rules a row must each meet, spanning two date fields or two `format: "time"` fields, the row\'s own or the one row a one-row link names (`booking.start_on`); `by` names values rows share \u2014 a link, a person, a text or a number, an option, a field of the one row the span is read through (`booking.room`), or a field of many values, which competes where two rows share any one; `while` names single selects by their options, the row\'s own or that linked row\'s. |\n\n<!-- generated:end rules-write -->\n\n- A `natural_key` is `text` or `number`, because a person types it back, or a\n one-row link, because a row is also recognised by the one row it belongs with (a\n fee by its visit and its kind). A key holding a `text` field is unique: `unique:\n true` on that field, or the key\'s fields as a set in the table\'s `unique` (a\n site by its customer and its name) \u2014 two rows sharing it would make\n find-or-create pick whichever the read answered first. An add asks the key by\n default.\n- A `same` link names only rows that name what this row names \u2014 a fee\'s invoice\n is one of its own visit\'s \u2014 through a one-row link both tables hold to one\n table; its picker offers nothing until the row names one. A row added under a\n record names what it copies off it (`default_from`) from the start, so a block\n expecting one line per row of the link lists that record\'s rows alone. A save\n of this row moving what the two compare is refused while they would name apart.\n- An `options_where` link may be left empty; a row it names is refused on every\n save that writes the link unless it holds the narrowing, and the refusal names\n the link and the row. A save that leaves the link alone is not judged, so a row\n still naming a row the narrowing no longer admits stays editable. A link naming\n one kind of a book\'s rows (a "Shipping line" among the parties) narrows to that\n kind, or its picker offers every row.\n\nA field\'s own `required` is not here: the field carries it, and every write\npath refuses the row by field name from it. `unique` is the text field\'s own\nclause (`reference/text`) \u2014 an add says so at the control before the column does. A\nfield the workspace writes (a formula, a rollup, a lookup, an autonumber, a date\nwith `derive_from`) is never asked, written or edited.\n\n## App tree\n\nAn app is a tree of components, assembled the way a page is written in JSX: pick a component, bind it to a table by\nname, and it draws well with no props, because its defaults come from the table\'s facts (`reference/records`, `reference/status`,\n`reference/write-rules`, `reference/field`). A prop overrides a default at its own node. No prop says how anything looks: the runtime\ndraws each concept one way, and a screen the job needs that no component states is told to the person \u2014 the job,\nwhat the app drew, the word wanted \u2014 never props bent to approximate it.\n\n**The smallest tree is one root List.** `{ "type": "App", "key": "orders", "name": "Orders", "children": [{ "type": "List", "entity": "order" }] }`\nis a whole app: the platform draws the rest from the tables \u2014 the page every row opens, a Section per stage with its moves\nat the foot, a child List per child, the band of readings, the add and the Delete. Every answer of `set_app` and `get_app`\nshows what it drew (`(default)` among the addresses) and says what it placed or folded in what you stated, so you state only\nthe difference. Lists at the root stand beside one another, two over one entity opening its one page.\n\nEach component is a page of its own: `reference/app-node`, `reference/list-node`, `reference/list-source`, `reference/record-node`, `reference/section-node`,\n`reference/side-node`, `reference/outside-node`, `reference/tab-node`, `reference/sheet-node`, `reference/field-node`, `reference/fieldset-node`, `reference/act-node`, `reference/check-node`,\n`reference/reading-node`, `reference/statement-node`, `reference/export-node`,\n`reference/query-node` and `reference/workflow-node`. Beside them: `reference/changing-an-app` and `reference/what-an-app-may-write`, `reference/layouts`, `reference/time-and-place-layouts` and\n`reference/publish-desk` for a List\'s `layout`, `reference/tasks`, and the rules, `reference/app-rules`,\n`reference/reading-rules`, `reference/statement-rules`, `reference/check-rules`, `reference/list-rules`, `reference/record-rules`, `reference/act-rules` and `reference/template-rules`.\n\n<!-- generated:start app-components -->\n\n| Component | Draws | Holds |\n|---|---|---|\n| [App](#app-node) | the launcher tile, the app\'s words, its Views (Lists and Sheets), and its API | List, Sheet, Query, Workflow, Record |\n| [List](#list-node) | rows of an entity: the register, a record\'s child rows, a roster\'s cells, related rows | Tab, Reading, Export, Act, List |\n| [Record](#record-node) | what a row opens: the head and the parts | Field, Fieldset, Section, Side, Outside, List, Reading, Statement, Act, Check |\n| [Section](#section-node) | a titled part of a record, and optionally a step of its path | Field, Fieldset, List, Reading, Statement, Act, Check |\n| [Side](#side-node) | the part the rest is worked from, beside them | Field, Fieldset, List, Reading, Statement, Act, Check |\n| [Outside](#outside-node) | what one record shows, and which acts it allows, to a person with no seat who opens a link a member made of it | Field, List, Act |\n| [Tab](#tab-node) | one view of a List\'s rows over a period | \u2014 |\n| [Sheet](#sheet-node) | a grid of Readings and Lists over the App\'s rows in its period | Reading, List |\n| [Field](#field-node) | one field: a control, a gallery, prose, a link and its picker, the rows filed under a back-link | \u2014 |\n| [Fieldset](#fieldset-node) | fields of a part read together under a heading of their own | Field |\n| [Act](#act-node) | a verb: what pressing it does | \u2014 |\n| [Check](#check-node) | an issue the table declares that refuses the writes and acts it names, or names the act that clears it | \u2014 |\n| [Reading](#reading-node) | a number over rows: one figure, its parts, a grid, per period, steps; or a record\'s own figure; with `planned` and `done`, the work against its plan, day by day | \u2014 |\n| [Statement](#statement-node) | a figure built from figures of the record | \u2014 |\n| [Export](#export-node) | a report file of the rows in view | \u2014 |\n| [Query](#query-node) | nothing: a read for agents | \u2014 |\n| [Workflow](#workflow-node) | nothing: a verb for agents | \u2014 |\n\n<!-- generated:end app-components -->\n\n### A node\n\nA node is `{ "type": <Component>, "key"?, ...props, "children"?: [...] }`. `type` names the component, `key` its\nname among its siblings, the other keys its props, `children` the nodes it holds. An unknown prop is refused.\n\n- **Two shorthands, both for Field.** A bare string child is a Field (`"due_date"`); an object with `field` and no\n `type` is a Field with props (`{ "field": "price", "edit": false }`). Both work in every prop that lists fields:\n `create`, a Record\'s `row.subtitle` and `add`, and the `children` of a Record or a part. A column is a field\'s alias, or\n `{ "field", "edit": true }` for the line\'s own control, and takes no other prop.\n- **Fields and options are named by alias**, never by label. A tagged value is an object, never a magic string.\n- **`false` turns a default off at its node:** `"edit": false` makes a field read-only, `"create": false` and\n `"remove": false` take a List\'s add and Delete away, `"readings": false` its band; on a Record, `"row": { "figure": false }`\n drops the row\'s figure, `"row": { "status": { "edit": false } }` the status buttons (another app moves the stage) and\n `"row": { "image": false }` the picture.\n\n### Keys and addresses\n\nA key is unique among its siblings, the way a React key is. A node that binds data takes its key from what it binds:\n\n| Node | Key when none is stated |\n|---|---|\n| Field, Check | its field alias |\n| List | its entity alias |\n| Record | its `entity` alias |\n\nEvery other node states its key. Three kinds of key are unique across the whole app, because each is an API name:\nan Act\'s (its workflow is `act_<key>`, or the one it names), a Reading\'s (its query name for `run_app_query`), and a Query\'s or\nWorkflow\'s.\n\nA node\'s **address** is the path of keys from the app, such as `pages/customer/orders`; the app itself is `/` (the `in` of a node at the root), and its own key is part of no address. A patch may use any ending\nof that path that names exactly one node (`orders`). The exact path wins where one exists; an ending naming two\nnodes is refused, and the refusal lists both paths. `get_app` prints the tree with each node\'s address.\n\n### Values\n\n| Value | Written |\n|---|---|\n| now, the reader, an asked input | `{ "now": true }`, `{ "me": true }`, `{ "input": "name" }` |\n| a computed value | `{ "formula": "{cost} * 1.2" }` over the acted row\'s fields |\n| a call\'s own value, in a Query | `{ "param": "name" }` |\n| cleared | `null` in an Act\'s `set` |\n| an option | its alias |\n\nA **condition** (`when`) maps a select to a list of its option aliases and a yes/no to `true` or `false`; every entry\nholds. A number (a number, currency or percent field, or a formula or rollup yielding one) takes a comparison with any\nof `gt`, `gte`, `lt`, `lte` (at least one, never both `gt` and `gte` or both `lt` and `lte`), each a number; a date\ntakes the same keys with a day (`"2026-03-01"`), a moment on a datetime (`"2026-03-01T09:30"`) or `{ "now": true }`\n\u2014 today, or the current minute on a datetime, read when the rows are, so overdue is `{ "due_on": { "lt": { "now": true } } }`;\nand any field but a yes/no takes `{ "empty": true }` or `{ "empty": false }`. A comparison on a field it does not fit is\nrefused, naming the field, its type and what it takes. A `when` on an Act, a Section or other block, and a List\'s `where`\n(the register\'s or a child List\'s) take these; a child List that adds, picks or expects rows refuses a comparison in its\n`where`, since a row it holds could stand outside it. A **narrowing** (`opens`, a Reading\'s, a Tab\'s or an Export\'s `where`) takes these and also `{ "me": true }` on a member\nfield or a lookup of one, the reader; `where` on a root List or a record\'s child rows fixes the rows on the server for every reader, so it refuses\n`{ "me": true }` \u2014 open on it with `opens`; on a record\'s related rows (`same`, `app`) and on a Sheet\'s List it\nnarrows by the reader and takes it, and those two take no comparison.\n\n## Changing an app\n\n1. `get_workspace` with `kind: "app"` names the app. `get_app` prints the `tree:`, the `node addresses:` (the address of\n each node the app draws, `(default)` on those the tree leaves to the platform) and the `version` line, whose id is the `base_version_id` to send. A member who is not the\n app\'s author is shown no tree. Keep the tree: no tool reads an earlier one.\n2. `set_app` with `app_id`, `base_version_id` (that version: a newer write is refused, not overwritten) and `nodes`,\n (a refused change writes nothing, so `dry_run` is for reading the permissions it would grant and remove). Every answer\n states the permissions the change grants and removes.\n3. `screenshot_app` shows the result.\n\n`nodes` maps an address to a patch of that node. Read against the customers List and page of the account review (`reference/a-complete-workspace`), the call below makes `tier` read-only, moves the Orders Section ahead of Account, adds an Act to\nAccount and removes the Reading:\n\n```json\n{\n "type": "App",\n "key": "account_review",\n "name": "Account review",\n "children": [{ "type": "List", "entity": "customer", "children": [{ "type": "Reading", "key": "ordered_by_tier", "by": "tier", "value": "total_ordered" }] }],\n "pages": [\n {\n "type": "Record",\n "entity": "customer",\n "children": [\n { "type": "Section", "key": "account", "title": "Account", "children": ["tier"] },\n { "type": "Section", "key": "orders", "title": "Orders", "children": [{ "type": "List", "entity": "order" }] }\n ]\n }\n ]\n}\n```\n\n```json\n{\n "app_id": "<id of the app>",\n "base_version_id": "<current_version_id>",\n "nodes": {\n "tier": { "edit": false },\n "orders": { "before": "account" },\n "mark_gold": { "type": "Act", "in": "account", "label": "Make gold", "when": { "tier": ["standard"] }, "set": { "tier": "gold" } },\n "ordered_by_tier": null\n }\n}\n```\n\nEach entry applies in order:\n\n- **An existing node:** a JSON merge patch (RFC 7396) of its props; `null` drops a prop, and a list (`children`,\n `columns`) replaces the node\'s whole, as `layout` does: a patch states the whole layout.\n- **`null`:** removes the node and everything under it.\n- **An address naming no node, with `type`:** adds a node into the node its path names (`"pages/<entity>": { "type":\n "Record", \u2026 }` adds a Record page), or, for a bare key, into the node `in` names (`/` the app); its key is the\n address\'s last word, and a Field states `field` in place of `type`.\n- **`in`, `before`, `after`:** move a node into another, or ahead of or behind a sibling.\n\nThe app\'s own props (`name`, `description`, `icon`, `color`, `words`, `scope`, `period`) change\nthrough `body`, a merge patch over the App node. `dry_run` checks a change and writes nothing.\n\n| To change | State |\n|---|---|\n| a field read-only | `"edit": false` on its Field, or on the Section, Side or Record that draws it |\n| a column added or dropped | `columns` of the List, every column kept: a List that never stated `columns` draws none beyond the row\'s title and its `records` line |\n| a button | an Act node (`reference/act-node`); `confirm` makes its press ask first |\n| a label | the table\'s field `label` in `set_tables`, for every app; for this app alone, `body: { "words": { "<table>": { "fields": { "fee": "Consultation" }, "options": { "urgency": { "rush": "Same day" } } } } }`; a List\'s `label`, a Section\'s `title`, an Act\'s `label`, `add_label` on the add. A Field\'s `label` heads only a gallery or prose block |\n| the order of nodes and rows | `before` or `after` a sibling, or `in` another parent, in the node\'s entry (a Section ahead of another, a Field ahead of another in its Section); a List\'s `columns` read in the order stated; its rows read in its `sort`: `{ "sort": { "field": "collected_on", "desc": true } }` |\n| the row\'s second line | `row: { "subtitle": ["mechanic"] }` on the List: up to two fields under the title, in place of the table\'s `records` line, which stays as it is |\n| a picker\'s add | `add` on the linked table\'s page: `{ "type": "Record", "entity": "pet", "add": ["species", "microchip"] }` asks those fields of the new row; absent, the picker only picks. It holds in every picker of that table in the app |\n| a linked row fixed or deleted where its link stands | the linked table\'s page in `pages`: the link\'s card opens the row in the drawer as that page draws it, saving what it writes, with a Delete where it states `remove: true`. A table a List of the app draws is worked in that List |\n| a headline figure | a Reading in the List: `{ "type": "Reading", "in": "orders", "label": "Prepaid owed", "value": "prepaid", "where": { "stage": ["awaiting_payment"] } }` sums the rows in view; without a `value` it counts them |\n| a calendar and its date | `layout: { "calendar": { "date": "pickup_on" } }` on the List, with `end` for the date a row runs to (both days or both moments); the bare `"calendar"` takes them from the rows\' facts and is refused, naming `date`, where those name none |\n| a record\'s child lines | a List inside the Record\'s Section over the child table: `{ "type": "List", "in": "details", "entity": "repair_line" }`; the child table (one link back to the record) and the record\'s rollup over its rows come from `set_tables` first. Lines priced off a book: `docs path="design/treatments/moves-and-numbers/priced-lines"` |\n\n**A node the tree leaves to the platform has an address too.** `get_app` lists the nodes the app draws, those the stored\ntree does not state marked `(default)`: the Record with its Sections and Fields, the status buttons, the band of readings.\nPatch one by its address and the call states it first: the nearest node the tree does state gains the default child that\nleads to it, as drawn (the whole page in `pages` for an entity that states none, with its `row` picture, and the List\'s `columns` the\ndefaults added; every Section of a Record that states no part; every status button of the app, each in the Section of its\nstage; every reading of the band, since stating one stands the others down), then the patch applies. Defaults\noutside that subtree stay defaults, and the answer\'s notes say what was stated. Removing every reading, or every status\nbutton, is refused: a set no node states is drawn again by the platform, and only `readings: false` on the List or\n`row.status: { "edit": false }` on the Record draws none. **A stated subtree stays as it is**: a\nfield or option the tables gain later is not added to it, so name it in the tree. `{ "due_date": { "edit": false } }`\nover a sparse tree makes that field read-only and takes away `saves <table>: due_date` alone. An address that ends several\ndrawn nodes is refused, as for stated ones.\n\n**A write places what has one fix, and says so.** The stored tree is the placed one, `get_app` shows it, and the answer lists\neach placement at its address, so you read the difference instead of meeting a refusal:\n\n- `where: { "<field>": { "me": true } }` on a root List moves to `opens`, the chip that names the reader. A child List\n keeps the refusal: bound access with a row rule, or list the rows in a root List.\n- A read-only repeat of a field across a record\'s steps, or a Field beside the files or text block that draws it, is left\n out and said; the statement stays in the tree.\n- `door` on the page of an entity no root List and no Sheet\'s List is over, where the page states no Side, is\n not drawn and is said: its rows open in place. It stays stated, and applies once one of those or a root List does.\n\n## What an app may write\n\nAn app states no list of what it writes: the tree derives it, and the generated workflows accept exactly that, so it is\nalso what an agent can do through the app\'s API. `get_app` prints it beside the tree.\n\n1. **A save of field `f` of table `E`** exists when a node draws `f` on a page of `E`\'s rows (a Field in a Record,\n Section or Side, or a part of the head), the table lets a person write it (stored; not computed, stamped or the\n back side of a child\'s link), no Act of the app on `E`\'s rows writes it, and neither the node nor a container above it\n says `edit: false`. A row\'s stage is moved by an Act or the one button per move a status no Act moves gets, by hand only where its Record\'s `row.status` says `{ "edit": true }`, and by none where it says `{ "edit": false }`.\n2. **An add of `E`** exists for a List over `E` that writes its rows unless it says `create: false` (asking what it lists, and\n setting the link back to the record itself), and for every picker of `E` where `E`\'s page states `add`. An absent `create`\n stands down where the table states no `singular` (nor the app\'s `words`), or where `where` keeps a select at an option an\n Act sets other than the one a new row starts at; a stated `create` list over such a table is refused. A roster\'s cells and\n a document are added only where `create: true`.\n3. **A Delete of `E`** exists for a List over `E` unless it says `remove: false`, and for the table of each of that\n List\'s `sources` (a source has no `remove` of its own). A roster\'s cells, a document and a desk\'s rows are deleted only where `remove: true`.\n A Delete comes with `restore_<entity>`, which brings the row back with the rows its delete took, all or none.\n `remove: false` takes this app\'s Delete away and no more: the record tools, the API and other apps still delete. A row no\n surface may delete is a table check with `on: ["delete"]`.\n4. **An act** exists for each Act node. Every field it sets, asks, files into, signs or records is the act\'s, and read-only\n everywhere else in the app.\n5. **The table\'s contract holds on every path** and is not restated here: required, unique, no overlap, field rules, table\n checks, stage owners, history and the read scope. (`natural_key` is read by an app\'s add and find-or-create alone.)\n\nDrawing is reading or saving; a List that writes its rows also adds and deletes them, until it says `create: false` or `remove: false`, and a List below a part or a Record that says `edit: false` writes, adds and deletes none.\n\n### What a table gives a component\n\n| Table fact | Feeds |\n|---|---|\n| The title | every row\'s name: Lists, a Record\'s head, link chips, pickers, an add |\n| The row\'s line (`records` subtitle, figure, image, mark, party, description) | the row\'s line and head, cards, a checklist\'s photo |\n| The stage (`records` status) | the stage chips, a List\'s `opens`, the badge, an Act\'s moves, stage owners gating acts, a Section\'s `at` |\n| Deadlines (`records` due, settled, frees) | countdowns and overdue marks, the default sort, attention order, spans on lanes, calendars and rosters |\n| Bounds (`records` limits, gates, tolerance) | the figure\'s meter, wherever it stands |\n| Tasks and cadence (`records` task, cadence) | the ring on task rows, a roster\'s owed days |\n| Applicability and starts (`records` applies, starts) | a field shown and asked only where it applies; an add\'s starting values |\n| A field\'s `required`, `default`, `default_from`, `natural_key`, `unique` | what an add asks, and what it starts at |\n| A field\'s `notation`, `format`, options, `options_where` | money, units, chips, and what a picker offers |\n| The table\'s `read_scope` | which rows each reader reads, in every List |\n\n### Where the rules stand\n\n`reference/app-rules` and the rule pages after it are every rule the check holds over an app, by id, whichever component it concerns. A\n**language** is decided by the app\'s own words: a tree names no locale, so what an app draws itself (its buttons, empty\nstates, refusals) is in the language its labels are written in, and `words` count as labels. Mix two languages in one\napp and it answers in two.\n\n## App node\n\nAn app draws its launcher tile, its words, its Views and its API. It binds the tables it names: `set_app` fills\n`tables` with the id of every table alias the tree uses, and `templates` with that of every document template alias.\nA relabel on either side is a rename and no tree points at another table by accident.\n\n<!-- generated:start node-app -->\n\n| Key | Type | Meaning |\n|---|---|---|\n| `key` | alias, required | The app\'s alias, its name among apps; the App node is addressed `/`, and no address in it starts with this key |\n| `name` | text, required | The job, in the words of the people who do it |\n| `description` | text | What the job is for, in a sentence |\n| `icon` | text | A Lucide icon name in kebab-case the launcher tile draws |\n| `color` | [colour](#select) | The launcher tile\'s colour |\n| `words` | map of alias \u2192 [Table labels](#table-labels) | A table \u2192 the words this app draws for it |\n| `scope` | alias | The table whose one row the app works inside \u2014 the folder: every List over a table holding a one-row link to it lists the open folder\'s rows and files each add under it; absent, the app reads every row |\n| `folders` | alias | The key of a root List over the table `scope` names: it draws the folders the app opens on \u2014 its columns, filters, grouping, order and summary \u2014 and a row pressed is the folder entered; absent, the folders are listed by their anatomy |\n| `rows` | map of alias \u2192 [Read scope rule](#read-scope-rule) | Each table\'s row rule in this app, by its alias (a table the app only reaches, by the table\'s own alias): who of the people the app is shared with reads which rows, on its screens, its queries, its writes and its workflows. A table the app states none of is read whole by everyone it is shared with |\n| `uses` | list of alias (at least one) | Tables the app\'s Query and Workflow nodes read without drawing them, by alias: they join the tables the app reaches, so a workflow may name them |\n| `period` | `"today"` \\| `"week"` \\| `"month"` \\| `"quarter"` \\| `"year"` \\| [Period days](#period-days) | The window every Sheet opens on: "month", "quarter", "year" or { "days": 30 }; absent, the calendar month |\n| `tables` | map of alias \u2192 text | The id of each table the tree names, by its alias: filled by set_app, never written |\n| `templates` | map of alias \u2192 text | The id of each document template the tree names, by its alias: filled by set_app, never written |\n| `children` | list of ([List](#list-node) \\| [Sheet](#sheet-node) \\| [Query](#query-node) \\| [Workflow](#workflow-node)) (at least one) | The App\'s Views in order \u2014 Lists and Sheets, the first where the App opens \u2014 and its Queries and Workflows. Queries and Workflows alone: an API app, which a server calls with an app key |\n| `pages` | list of [Record](#record-node) (at least one) | The page the rows of an entity open, one per entity, each a Record stating its `entity`; every List over the entity, anywhere in the App, opens it, and a link\'s row no List lists. Absent, the platform draws the page |\n\n#### Table labels\n\n| Key | Type | Meaning |\n|---|---|---|\n| `label` | text | The table\'s name in the plural (a register\'s heading, a block\'s, a link\'s picker) |\n| `singular` | text | One row of the table, as the add and empty sentences name it |\n| `fields` | map of alias \u2192 text | A field alias \u2192 the words this app draws wherever it names the field; the table\'s field keeps its own label |\n| `options` | map of alias \u2192 map of alias \u2192 text | A select field alias \u2192 option alias \u2192 its words |\n\n<!-- generated:end node-app -->\n\n- **Every View at the root is a peer**: a List or a Sheet, in the order stated, the first where the App opens and the\n others each one entry of the App\'s lists, picked under its title, each at its own address: the first at the app\'s root (`/`), any other at `/<key>`, inside the folder where the App is scoped. A List states\n its `label`, any layout, its own Tabs, Readings and Exports, and may read `sources`; two may stand over one entity, and\n both open its one page. Whoever the app is shared with is shown every View, each table narrowed by the App\'s `rows`.\n A list people work every day as a desk of their own is another app.\n- **A Sheet** draws Readings and read-only Lists over the App\'s rows. The App\'s one `period` windows every reading of\n its Sheets placed in time: the calendar month by default, or `quarter`, `year` or `{ "days": 30 }`. An App of Sheets alone\n draws the pages its Sheets\' Lists open (a List naming no `app`), each from `pages` as any page is. A Sheet\'s List\n naming no `app` opens its row\'s page in this app, in the drawer over the Sheet, at `/<sheet key>/<row>`.\n- **Query and Workflow** nodes stand at the root and are never drawn.\n- **Writes:** nothing itself.\n\n## List node\n\nA List draws rows of one table. What its rows are depends on where it stands:\n\n- at the App root: a register, a View of its own among the App\'s;\n- under a Record, Section or Side: the record\'s child rows, filed through the child\'s one link to the record\n (`via` where it has several);\n- under a roster List: the rows that fill the roster\'s cells;\n- with `same` or `app`, or on a Sheet: related rows, read only.\n\nA List below a row\'s page is a View too: it takes Tabs, Readings and Exports as a root List does, and its rows open at\n`/<view>/<row>/<key>`, drawn alone with its band, its way back the row\'s page. An Export of it is the file of that one\nrow\'s rows.\n\n<!-- generated:start node-list -->\n\n| Key | Type | Meaning |\n|---|---|---|\n| `key` | alias | Names the List among its siblings and in a Query\'s `list`; absent, the entity alias |\n| `entity` | alias, required | The table whose rows the List draws |\n| `sources` | list of [List source](#list-source) (at least one) | Further tables read as one List with this entity |\n| `source_column` | `false` | Reads a List\'s tables as one: false, no column naming each row\'s table and no filter by it; absent, a List with `sources` draws both |\n| `scope` | alias | Says which folder a row files in: with the App\'s `scope`, the one-row link, where the table holds several |\n| `via` | alias \\| text | The child\'s link to the record, where it has several; a List that only reads may state `<link>.<link>`, reaching the record through a row of their own |\n| `same` | alias | A one-row link of the record: the rows sharing its row, the record left out, read only |\n| `where` | [narrowing](#app-tree) | A fixed narrowing on the server, for every reader: a condition (`reference/values`), and `<link>.<field>`, the rows whose one-row link names a row holding a select or yes/no so. A List that only reads (`same`, a Record with `edit: false`) also bounds a date or number by a field of the record, `{ "record": "<field>" }`: blank, it keeps no row; an Act\'s paper naming the List is handed the same rows; it is never an access bound, which the table\'s row rules are. An add holds only a select\'s option and a yes/no\'s value |\n| `expect` | alias \\| [Expect](#expect) | What a record should hold, shown before it does: one line per option of this select, or per row of this catalog link |\n| `under` | alias | Groups lines by the document covering them: a one-row link to it |\n| `covers` | integer | With a roster\'s cells over days: how many rows each day needs across every lane; a day holding fewer is marked Uncovered. Absent, no day is expected to hold any |\n| `edit` | `false` | Shows rows nobody changes here: false, this List only reads them |\n| `label` | text | The register\'s name in the app\'s lists and tab strip; absent, the entity\'s label. Never the noun of its rows, which is the table\'s label and singular (this app\'s `words`) |\n| `columns` | list of (alias \\| [Edit column](#edit-column)) | Fields read after the row\'s title, each drawn though no row holds it; `{ field, edit: true }` is the line\'s own control, at most 2. Absent: the title and the `records` line alone |\n| `filters` | list of (alias \\| [Tiered filter](#tiered-filter) \\| [Listed filter](#listed-filter)) (at most 3) | Fields the reader narrows by every day, beside the stage chips: a select, member, link, date, yes/no or number range of a field its rows draw (a column, the title, the line), never one drawn nowhere; a Reading\'s narrowing names the same; `tiers` bands a number or date; `values` states which values a pick lists |\n| `search` | list of alias (at least one) \\| `false` | Fields the search box reads; absent, every word of the row; false, no search box |\n| `group` | alias \\| `false` | A field the rows stand grouped by, a gantt drawing the groups as its lanes; absent, the reader may group by a filter\'s field; false, no grouping |\n| `sort` | [Sort key](#sort-key) \\| list of [Sort key](#sort-key) (at least one) | The rows\' order; absent, a register reads newest made first, a record\'s rows as added |\n| `opens` | [narrowing](#app-tree) | The view the register opens on, a chip the reader may take away: `where`\'s entries but a record bound, and `{ "me": true }` on a member field or a lookup of one |\n| `period` | `"today"` \\| `"week"` \\| `"month"` \\| `"quarter"` \\| `"year"` \\| [Period days](#period-days) | The window a table\'s or cards\' dated Tabs read, or the day, week or month a calendar or lanes board opens on; absent, this month |\n| `chips` | `false` | The line\'s one chip row, the stage chips: false, none \u2014 the List then holds every row at every stage, and a filter on the status picks among its options |\n| `checks` | `false` | The filter picking among the Checks its rows hold, each with how many hold it: false, none |\n| `attention` | `false` | Keeps a list in its own order: false, the sort menu offers no attention-first order |\n| `readings` | `false` | Leaves a list without figures above it: false, no band; absent, rows that move, fall due or carry money lead with one. Never with Readings stated |\n| `layout` | [layout](#layouts) | A word, or an object stating one layout with its data; absent, a table |\n| `beside` | `true` | Keeps the list in view while a row is worked: true, a row pressed opens beside this table; a root List drawn as a table. Absent, the page\'s `door` |\n| `compare` | [Compare](#compare) | Each row\'s before against its after: two files fields as a pair of photos, or two values of one type as one column |\n| `current` | alias | A child List of revisions: the child\'s date or number field ordering them. The latest reads as current, the others fold under "superseded \xB7 N"; the record shows the current file through a lookup of the child ordered by it |\n| `create` | boolean \\| list of alias (at least one) | The fields an add asks; `false`: rows are not added here. Absent: where this List writes its rows, the table\'s required fields, natural key and title; nothing where the table states no `singular` (nor the app\'s `words`), or `where` keeps a select at an option an Act sets other than the one a new row starts at. A roster\'s cells and a document add only where `true` |\n| `add_label` | text | The add button\'s words; absent, the platform\'s word and the singular |\n| `remove` | boolean | Rows offer a Delete. Absent: where this List writes its rows; `false`: this app\'s Delete alone is gone, and a row no surface may delete is a table check with `on: ["delete"]`. A roster\'s cells, a document and a desk\'s rows delete only where `true` |\n| `pick` | `true` | Also picks rows of the child that no record holds yet |\n| `when` | [condition](#app-tree) | Drawn only while this holds |\n| `children` | list of ([Tab](#tab-node) \\| [Reading](#reading-node) \\| [Export](#export-node) \\| [Act](#act-node) \\| [List](#list-node)) (at least one) | Its Tabs, band Readings, Exports and Acts over ticked rows or every row in view; under a roster the List of its cells, with `under` the List of its documents. An Act on one row and every Check stand in `pages/<entity>` |\n\n#### Edit column\n\n| Key | Type | Meaning |\n|---|---|---|\n| `field` | alias, required | The column\'s field |\n| `edit` | `true`, required | Lets a person change the value on the line: true, its own control, written in place |\n\n#### Expect\n\n| Key | Type | Meaning |\n|---|---|---|\n| `field` | alias, required | The child\'s title, one row per value: a single select or a one-row link to a catalog |\n| `of` | alias | Lets each record choose its lines: with a select, the record\'s own multi-select naming the options it expects, in place of every option |\n| `only` | list of alias (at least one) | Holds lines for some options alone: with a select, those options; never with `of` |\n\n#### Compare\n\n| Key | Type | Meaning |\n|---|---|---|\n| `before` | alias, required | The rows\' field holding what stood before: files, text, a number, a date or a single select |\n| `after` | alias, required | A field of the same type holding what stands after |\n| `edit` | `true` | The after is written on the line |\n\n#### Tiered filter\n\n| Key | Type | Meaning |\n|---|---|---|\n| `field` | alias, required | A number \u2014 stored, or a formula or rollup reading one \u2014 in one unit for every row |\n| `tiers` | list of number (at least one), required | The breakpoints between its bands, ascending, in the field\'s stored unit: under the first, from each to the next, from the last up \u2014 each band worded in the field\'s notation; a filter picks several at once |\n\n#### Listed filter\n\n| Key | Type | Meaning |\n|---|---|---|\n| `field` | alias, required | A select, member or link field |\n| `values` | `"all"` \\| `"held"`, required | The values its menu lists: all, every option, person or linked row, those no row holds at 0; held, only those the rows hold. A bare field lists a select\'s every option, a member\'s or link\'s held |\n\n#### Sort key\n\n| Key | Type | Meaning |\n|---|---|---|\n| `field` | alias, required | The field rows are ordered by |\n| `desc` | boolean | Latest or largest first; absent or false, soonest or smallest first |\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `list.scope` | With the App\'s `scope`, a List over a table holding one one-row link to the folder\'s table is filed in the open folder by it, and one holding several names it in `scope`; that link is required. A List over the folder\'s own table states no `scope`. |\n| `list.unscoped` | *Noted, never refused:* In an App that states `scope`, a List over a table holding no one-row link to the folder\'s table lists every row, in every folder; so does a Tab\'s totals over a child holding no single link to it. |\n\n<!-- generated:end node-list -->\n\nA List takes only the props its place lists:\n\n<!-- generated:start list-places -->\n\n| A List standing in | Takes |\n|---|---|\n| every List | `key`, `entity` |\n| every List on a record | `via`, `label`, `when`, `filters`, `search`, `group`, `sort`, `chips`, `checks`, `opens`, `period`, `attention`, `readings` |\n| a root List (the first is the register) | `label`, `columns`, `filters`, `search`, `group`, `sort`, `chips`, `checks`, `opens`, `period`, `attention`, `layout`, `beside`, `create`, `add_label`, `remove`, `readings`, `where`, `edit`, `sources`, `source_column`, `scope` |\n| a record\'s child rows, as a table, a checklist, a desk or a gantt (which refuses `under`, `pick`, `compare`, `current`, `expect` and an `edit: true` column) | `columns`, `create`, `add_label`, `where`, `under`, `remove`, `pick`, `layout`, `compare`, `current`, `expect` |\n| a record\'s child rows with `layout` an agenda | `columns`, `create`, `add_label`, `remove`, `layout`, `edit` |\n| a record\'s child rows with `layout` `"timeline"` | `create`, `add_label`, `remove`, `layout`, `edit` |\n| a record\'s related rows, read only (`same`, or a Record that is `edit: false`) | `where`, `columns`, `same`, `edit` |\n| the documents a child List\'s lines stand under (`under`), a List inside it | `create`, `remove` |\n| the cells of a roster, a List inside it | `expect`, `covers`, `create`, `remove` |\n| a Sheet\'s list, read only | `label`, `where`, `columns`, `sort` |\n\n<!-- generated:end list-places -->\n\n- **The page a child List\'s rows open** is the entity\'s page in `pages`: its Fields in stated order, those the rows\' saves write editable, and the List\'s `columns` are the line. A row opens in place under itself: its fields or Sections, then each List of its own children, at any depth; one row is open at a time. Every row of a List that adds rows offers "Duplicate" in its \u22EF: the add opens with the row\'s values of the List\'s `create` fields, filed under the row\'s own parent (in an outline, the row above it), never carrying a status, a computed value or files. With `edit: false` the List reads as a related-rows List does.\n- **Documents:** in a child List with `under`, a List over the document\'s table (`key`, `entity`, `create`, `remove`,\n Acts and Checks; the document\'s Fields and Lists stand in its page) is the one place the documents are added or deleted;\n `create` states `true`, and `remove` needs `create: true` beside it.\n- **Writes:** a layout move (a gantt bar, a lane\'s block, a plan\'s item) writes only fields the app already writes on the row\'s page.\n- **`create` asks:** `true` asks the title, the natural key and every required field a person writes, never a computed\n or stamped field or the link the place sets. An `expect` list also asks the key it makes its lines by, and their picture.\n- **`filters`:** a threshold the business names ("large orders") is a formula yes/no, and bands it names (new, warm, cold) a formula with options, never a range.\n- **`opens`** absent, the register opens on the open work (rows not at a `closed` stage).\n- **`expect`:** an empty line adds its row (a checklist of papers per case).\n\n## List source\n\nSources are further tables a root List reads beside its entity as one List: the same job kept in tables of their own (a legacy ledger, a second branch\'s register). Each is projected onto the List\'s fields \u2014 by alias, else by its `fields` (the List\'s field \u2192 the source\'s) \u2014 and options line up by alias; its `where` narrows its own rows. Each row opens its own table\'s page in `pages`, stated or refused (`list.source-page`), and runs the Acts and Checks that page states: nothing the List offers its own rows reaches a source\'s. The add offers each table, asking the List\'s `create` in that table\'s fields; a source lacking one adds no row. A column naming each row\'s table, and a filter by it, draw by default; `source_column: false` hides both. Every source holds the title and the scope, and may hold no stage (its rows wear none and stand in no stage chip); its `columns` name value fields of its own table (not links or files) drawn on its rows alone, on a lanes board only; a table, cards, lanes or a plan reads sources, and an Export\'s `sources` makes a report of some of them.\n\n<!-- generated:start node-list-source -->\n\n| Key | Type | Meaning |\n|---|---|---|\n| `entity` | alias, required | A further table this List reads beside its own entity: the same job over its rows |\n| `fields` | map of alias \u2192 alias | A field of the List\'s entity \u2192 this table\'s field holding the same fact, where their aliases differ |\n| `where` | [narrowing](#app-tree) | Which of this table\'s rows the List reads |\n| `columns` | list of alias (at least one) | Fields of this table with no counterpart in the List\'s entity, drawn on this table\'s rows alone |\n| `row` | [List source row](#list-source-row) | How the List reads this table\'s rows, where it differs from the table\'s `records` |\n\n#### List source row\n\n| Key | Type | Meaning |\n|---|---|---|\n| `status` | `{ "edit": true }` | Lets a person move this table\'s stage by hand in the List: `{ edit: true }` |\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `list.sources` | A List\'s `sources` each name another entity once (`entity`) \u2014 never the List\'s own \u2014 whose fields line up with the List\'s by alias, else by `fields` (a field the List reads, or one an Export prints \u2192 one of the source\'s): read as one column type (a day apart from a moment), one value or several alike, a link to the same entity. Each source holds the title, the List\'s folder link and what `where` keeps; it may hold no status \u2014 its rows wear none and stand in no status chip, only the total\'s. Its `columns` name fields of its own table that no List field stands for, drawn on its rows alone and only on a lanes board \u2014 a text, number, date, select or yes/no field, or a lookup of those, never a link or files; an alias a List field or another source\'s column holds is refused; its own `records` status stays its page\'s; the List is a table, cards, lanes or a plan, whose `at`, `across` and `up`, or lanes\' `by` and loads, line up like any field. Two sources holding a field of their own under one alias hold it as one kind of value. An Export\'s `sources` each name the List\'s entity or one of its sources, once, and one of them holds each field its `where` and `per` narrow by. A List with `sources` draws a column naming each row\'s table, and a filter by it; `source_column: false` draws neither. A source\'s rows open the page of its own entity, which states the Acts and Checks they run: each Act\'s `key` its own among the App\'s Acts. |\n| `list.source-lacks` | *Noted, never refused:* A source lacking a field its List\'s `create` asks adds no row; one lacking the select its List\'s plan marks or sizes by never marks or sizes its rows. A field only an Export prints, held by a source as another kind of value, prints blank on its rows. A Tab\'s `totals` over a child linking to no row of a source total nothing on its rows. |\n| `list.source-option-kin` | *Noted, never refused:* A source\'s option labelled as one of the List\'s, under another alias, reads apart from it: the List lists both and counts each on its own. |\n\n<!-- generated:end node-list-source -->\n\n## Layouts\n\nA List\'s `layout` is how it draws its rows: a word (`"table"`, `"cards"`, `"calendar"`, `"roster"`, `"timeline"`) or an\nobject stating one layout and the data it reads (`{ "gantt": \u2026 }`, `{ "lanes": \u2026 }`, `{ "plan": \u2026 }`, `{ "agenda": \u2026 }`,\n`{ "checklist": \u2026 }`, `{ "desk": \u2026 }`). Absent, a table: the word `"table"` is the register\'s, and a child List states a\nchecklist, a desk, a gantt, an agenda or `"timeline"`, else leaves `layout` out. Each layout reads what the rows already state \u2014 their\n`records` line, stage and dates \u2014 and the keys a layout adds stand on its section: here for an agenda and a checklist, `reference/time-and-place-layouts` for the rest, `reference/publish-desk` for a desk. Which one a job needs: the\n`design` reference. The register lays out as a table, cards, a calendar, a roster, a gantt, lanes or a plan; a record\'s\nchild rows as a table, a checklist, a desk, a gantt, an agenda or a timeline.\n\n### Table\n\n<!-- generated:start layout-doc-table -->\n\nAbsent `layout`, each row is one line: the table\'s `records` entry \u2014 its picture or mark, title and the line under it \u2014\nthen the stage, the `columns`, and the figure at the right; the title, the stage and a column of days or amounts sort\nthe rows by their header. A table groups its rows by `group`; a table or cards reads `Tab`s and the `sources` of its List.\n\n<!-- generated:end layout-doc-table -->\n\n### Cards\n\n<!-- generated:start layout-doc-cards -->\n\n`"cards"` draws each row as a card led by its picture \u2014 the `records` `image`, or the List\'s `row.image`: its title and\nthe line under it, its stage and what needs the reader (a deadline, a warning), then its figure and the `columns` at its\nfoot. Cards are for rows found by their picture (a product, a vehicle, a damage photo); rows with no picture read better\nas a table.\n\n<!-- generated:end layout-doc-cards -->\n\n### Calendar\n\n<!-- generated:start layout-doc-calendar -->\n\n`"calendar"` or `{ "calendar": { "date": "starts_at", "end": "ends_at" } }` places each row on its day \u2014 a month, a week,\na day or a list (a phone reads the list or a day): at its hour where `date` holds one, over its span where `end` names\nthe date it runs to, with its line\'s other words and the `columns` after its title. `date` and `end` are two dates of\nthe row, both days or both moments; a span of moments gives a phone its day view, and a day\'s `end` is the last day held\n(unless `records` names it the day the row `frees`). The bare word takes them from the rows\' facts: two dates a person\nstates, the second ordered after the first by a `min` or a table check, both required or the second the row\'s `due`; else the one required date a person states that no Act stamps and a new row does not start at today \u2014 and is refused, naming `date`, where the rows hold neither. A `due` is a deadline, never the day a row is held on. The calendar reads the window in view, and its count and the stage chips count that window, opening on every row.\n\n<!-- generated:end layout-doc-calendar -->\n\n<!-- generated:start layout-calendar -->\n\n#### Calendar keys\n\n| Key | Type | Meaning |\n|---|---|---|\n| `date` | alias, required | The date or moment of this entity each row stands on: a viewing\'s start, a hire\'s first day, a visit\'s day |\n| `end` | alias | The date or moment each row\'s span ends on, read as `date` is \u2014 two days or two moments (a moment\'s end gives a phone its day view); absent, a row stands on `date` alone |\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `list.calendar` | `layout: "calendar"` or `{ calendar: { date, end } }`: two dates of the row, both days or both moments; bare, it takes the rows\' span or appointment, else is refused, naming `date`. |\n\n<!-- generated:end layout-calendar -->\n\n### Roster\n\n<!-- generated:start layout-doc-roster -->\n\n`"roster"` draws the List\'s rows down the side and the days of a week or a month across; the roster\'s cells are a List\ninside it over the table whose rows fill the days \u2014 each stands on one row by its single link to it, and on the first\ndate of its line (a shift on a person\'s day, a run on a vehicle\'s), on every day through the second date where its line\nholds one. A cell reads its row\'s stage, else the first single select on its line (a shift\'s kind), several rows their\ncount. A day holding none stays empty: nothing was due, which is never an absence. A filled cell opens its row; an empty\none adds a row there, the register row and the day set. With `expect` on the cells (a single select of those rows) the\ncolumns are its options in place of days \u2014 a checklist of papers \u2014 and `of` names the ones each row expects: a gap among\nthem reads as one and adds its row, the others stand blank, and each row reads what it holds of them, `2/3`. Over days, a\nroster reads the `cadence` its table\'s `records` states (a site\'s diary page, Monday to Saturday from breaking ground to\nhandover): a past day owed with none is marked missing and counted, and each row reads the days it holds of those owed. A\nroster states no `columns` and needs no readings: its legend counts each state in view. `covers: 2` on the cells List says each day\nneeds two rows across every lane: a day holding fewer is marked "Uncovered" in its head, counted in the legend, and the\nExport\'s `columns` carry `covered` (false on such a day) for every day of the window.\n\n<!-- generated:end layout-doc-roster -->\n\n```json\n{ "type": "List", "entity": "operator", "layout": "roster", "filters": ["depot"], "children": [{ "type": "List", "entity": "run" }] }\n```\n\n### Timeline\n\n`"timeline"` reads a record\'s child rows as a log of dated entries, newest first, with a composer where the app adds\nentries, each corrected and removed where it stands. It is never the record\'s status history: the rail shows each\nmove. A timeline\'s moment is its child\'s first date, and who its member field. Rows each what happened on a day and who \u2014\na date on their line, a member, no stage and no figure \u2014 read best as a timeline.\n\n### Agenda\n\n`{ "agenda": { \u2026 } }` reads a record\'s child rows as planned entries on a time axis: by day, soonest first, each with its\npicture and the day that is today marked. The day is the first date on the child\'s row line (its `records` title or\nsubtitle); within a day entries follow a datetime there, else the first single select after the date. An entry with no day\nyet is a plan, listed first and dated in place. `start` is the record\'s date that is the first day: each day\'s heading\ncounts from it (Day 1, Day 2).\n\n<!-- generated:start layout-agenda -->\n\n#### Agenda keys\n\n| Key | Type | Meaning |\n|---|---|---|\n| `start` | alias | The record\'s date that is the first day: each day\'s heading counts from it; absent, the weekday and the date alone |\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `list.agenda` | An agenda List\'s child names a date on its row line (`records` title or subtitle); the layout\'s `start` is a date of the record. |\n| `list.agenda-note` | *Noted, never refused:* Rows each on a day and within it (at an hour, in a part of the day) listed as a table: a List with `layout: { agenda }` draws them by day. |\n| `list.timeline` | A timeline List\'s child holds a date to place its entries by. |\n| `list.timeline-note` | *Noted, never refused:* Rows each what happened on a day and who \u2014 a date on their line, a member, no status and no figure \u2014 listed as a table: a List with `layout: "timeline"` draws them as a timeline, newest first. |\n\n<!-- generated:end layout-agenda -->\n\n### Checklist\n\n`{ "checklist": { \u2026 } }` reads a record\'s child rows, which are tasks, as a checklist of checks: each one\'s mark \u2014 passed\nat a `closed` option, failed at a `failed` one, else still to check \u2014 its title, its columns as its words (a text column\nits note, on its own line), and on a line under its title its photo and its clause. Never grouped nor written in place.\n`passed` alone sets the mark, so rows with no `task` and no status are checks: a measured yes/no is the verdict. With\n`expect` on the standard\'s items, each item is a line marked the same way (a missing one still to check), filled in\nplace by the block\'s `columns` (a measured value, a note, a photo), so `photo` and `clause` are not named.\n\n<!-- generated:start layout-checklist -->\n\n#### Checklist keys\n\n| Key | Type | Meaning |\n|---|---|---|\n| `photo` | alias | The child\'s files field holding the photo each row is checked by; absent, the child\'s `records.image` |\n| `clause` | alias | The child\'s one-row link to what each row is checked against \u2014 a standard\'s clause, a rule |\n| `failed` | list of alias (at least one) | Options of the child\'s status a row stands failed at \u2014 none of them closed |\n| `passed` | alias | The child\'s yes/no field (stored or a formula) setting each row\'s mark: yes passed, no failed, empty still to check |\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `list.checklist` | A child List with `layout: { checklist }` reads a task entity\'s rows as checks \u2014 never under documents, grouped, edited in place or picked together by an Act over several, its columns no files; `photo` names a files field of the child, `clause` a one-row link of it, `failed` options of its status, none `closed`; `passed` a yes/no of it, stored or a formula, setting each mark (yes passed, no failed, empty still to check) and standing without `task` or a status. With `expect` the lines of a standard are the checks, each marked and filled by the block\'s columns (a measured value, a note, a photo), so `photo` and `clause` are not named. |\n\n<!-- generated:end layout-checklist -->\n\n## Time and place layouts\n\nThe layouts that place a List\'s rows in time or on a plan. Each is a `layout` object stating the data it reads.\n\n### Lanes\n\n<!-- generated:start layout-doc-lanes -->\n\n`{ "lanes": { "by": \u2026 } }` draws each row of the linked table as a lane (a chair, a machine, a room), empty ones too,\nand each row of the List as a block from the first date on its line to the second: over the hours of one day, where the\nfirst holds its hour (a week of them draws each day\'s cells, a block\'s time range its first fact), else over the days of one day, a week or a month. A press on a free stretch between blocks adds a row there, its lane and its start set, and its end where the next block\nbounds it. Rows naming no lane stand first, in a lane of their own; where the app writes the link, each block moves to\nanother lane from its menu. Inside a `scope`, the lanes are the ones whose own one-link names that scope\'s row. A span\'s\nend holds its day unless `records` names it the day the row `frees`.\n\nRows with no hour read at one day (`day`) as cards in lanes, not blocks over an axis: the rows no lane holds first, in a tray that\nalso holds the rows with no day, then each lane with its count and its status where its table states one; a lane its link no longer admits says so on its head and takes no new card. A card\'s lead is its\ntick; ticked cards, or one dragged, go to a lane together in one write, every row judged before any is written. The List\'s first\n`sort`, where it is a stored number the app writes, is a card\'s place in its lane. A week of such rows, or any rows with an hour,\nkeep the blocks.\n\nA person is a lane too: `by` may name a member field holding one person, with `of` the role (one of the model\'s\n`roles`) whose every member is a lane \u2014 `{ "lanes": { "by": "engineer", "of": "engineers" } }`. A row stands\nin the lane of the person it holds, and a `no_overlap` by that member keeps one row per person at a time. `of` is\nrequired with a member `by` and refused with a link; `loads` read a lane\'s row, which a person is not.\n\n`loads` names what a lane carries: `{ "weight": "payload", "volume": "box" }` sums each block\'s number and reads it\nagainst the lane row\'s own, at most two; each block then reads that number after its first column. A lane reads the most its standing blocks add up to at\none time in the window, named, past its bound, by how much and on which day or hour; hours add up within each day, and across days the fullest day is read, named. The two are in one unit, or two of\none dimension. `"per": "week"` holds the bound over the calendar week instead: a lane then reads the sum of its\nblocks over the week of the day in view, on a day, a week or a day of hours, and its head says "6 h of 40 h this week". A bound a single row must keep (no parcel heavier than its van) is a `max` on the field through the link,\nwhich refuses the move.\n\n<!-- generated:end layout-doc-lanes -->\n\n<!-- generated:start layout-lanes -->\n\n#### Lanes keys\n\n| Key | Type | Meaning |\n|---|---|---|\n| `by` | alias, required | A one-link of this entity whose target\'s rows are the lanes (a chair, a machine, a room), each drawn even when empty; or a member field holding one person, whose lanes are the members of the role `of` names |\n| `of` | alias | Shows a whole team, the idle included: with a member `by` only (refused with a link), the role, one of the model\'s `roles`, whose every member is a lane, drawn even when empty |\n| `loads` | map of alias \u2192 alias | What a lane carries against what it holds, at most 2: a number of this entity each block adds \u2192 a number of the lane\'s row it is held within, in one unit or two of one dimension |\n| `per` | `"day"` \\| `"week"` | With `loads` only: how long the bound holds. `day`, the default: the most a lane carries at one time or on one day. `week`: the sum of a lane\'s blocks over the calendar week of the day in view, on every size of the window |\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `list.lanes` | `layout: { lanes }`: `by` is a one-row link to a table whose document states `records`, the rows name a date on their line (a field of the row itself, or a lookup of its parent\'s date), a lane block\'s two ends are read alike (two days or two moments), and `loads` stands with it. |\n| `list.loads` | A lanes layout\'s `loads` names one to 2 numbers a lane block adds \u2014 never a percent \u2014 each against a number of the lane\'s row, in one unit or two of one dimension; `per` (day or week) stands only beside `loads`. |\n\n<!-- generated:end layout-lanes -->\n\n### Gantt\n\n<!-- generated:start layout-doc-gantt -->\n\n`{ "gantt": { \u2026 } }` draws each row as one bar on one axis of time: `{ "start": "etd", "end": "eta", "milestones":\n["cut_off"], "planned": { "end": "booked_eta" }, "progress": "done", "after": "waits_on" }`. `end` defaults to the table\'s\nfirst `due`, and a table with neither is refused; `start` and `end` are two dates of the row, both days or both moments,\nand each planned date is read as `start` is. `progress` is a percent (0\u2013100); absent, a row whose record lists its tasks\nfills to how many are done. `after` is a link to rows of the same table, each ending before the row starts. The bars\nstand in the lanes of the List\'s `group`. Where the app writes the row and a person writes a bar\'s date, the bar is\ndragged through the row\'s save; a computed date, one an Act sets, or a row the app does not write drags nothing. Over a\ntable that holds rows under rows, each bar stands under the row above it, indented and folded as the register\'s outline\nis, `group` still the outer section. A child List of a record may lay out as a gantt too: the bars of the rows the\nrecord\'s link names.\n\n<!-- generated:end layout-doc-gantt -->\n\n<!-- generated:start layout-gantt -->\n\n#### Gantt bar\n\n| Key | Type | Meaning |\n|---|---|---|\n| `start` | alias, required | A date of this entity each row\'s bar starts at (a sailing, a hire\'s start, a task\'s start) |\n| `end` | alias | The date each row\'s bar ends at, read as `start` is \u2014 two days or two moments; absent, the entity\'s first `due` |\n| `milestones` | list of alias (at least one) | Dates of the row marked on its bar\'s line as diamonds, each named by its label (a cut-off, a delivery, the end of free time) \u2014 never `start` or `end` |\n| `planned` | [Gantt plan](#gantt-plan) | The plan each row is read against, drawn as a thin bar under its own \u2014 each date read as `start` is; a missing one is the bar\'s own |\n| `progress` | alias | A percent of this entity (0\u2013100) filling each row\'s bar as far as the work is done; absent, how many of the row\'s tasks are done fills it where its record lists them, else the bar wears its status\'s tone |\n| `after` | alias | A link of this entity to its own rows each row waits on \u2014 it starts once they end (finish-to-start), an arrow from each; a row starting before one ends is drawn in the danger tone |\n\n#### Gantt plan\n\n| Key | Type | Meaning |\n|---|---|---|\n| `start` | alias | The date the row was planned to start at |\n| `end` | alias | The date the row was planned to end at (a booked arrival) |\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `list.gantt` | `layout: { gantt }`: `start` and `end` (absent, the entity\'s first `due`) are two different dates of the row, both days or both moments; each diamond (`milestones`) another date of it, each planned date read as `start` is, `progress` a percent and `after` a link to rows of the same entity. |\n\n<!-- generated:end layout-gantt -->\n\n### Plan\n\n<!-- generated:start layout-doc-plan -->\n\n`{ "plan": { \u2026 } }` draws things that stand at a place \u2014 pallets in a warehouse \u2014 on a plan of the places. The places are\nthe rows of a table whose `records` states a `plan_place` (a bay, an open area or a landmark, each at its spot on a sheet\nof the plan); `at` names the one-link of the List\'s rows to a place and, for an item in a bay, the row (`across`) and the\ntier (`up`) it stands in, counted from 1. A bay is drawn as its rows and tiers, an area with a count, a landmark as a\nlabelled frame; the reader sees a plan, one bay enlarged, and the same plan in 3D. The List may read other tables as\n`sources`: one plan of every table\'s items. Each item carries `__reach` \u2014 how many items stand in the way of taking it out\n(those above it where the place is `stacked`, and those in the rows between it and the side `reach_from` says the bay is\ntaken from) \u2014 so the list, its export and an agent\'s read all carry it; `<table>_plan_load` counts the rows each place\nholds. A move through the app is refused unless it clears the place, row and tier all three, or places the item at\na free cell of a bay \u2014 resting on a present item where the place is `stacked` \u2014 or at an area. Every other write (a grid edit, an import, a tool) holds one item to a cell only where the item\'s table states `unique: [<at>, <across>, <up>]`; a plan over a table stating none is noted. A plan opens on every row\nits `where` keeps, with no stage chip narrowing it. Rows with no place wait in a tray beside the plan. An Act that asks exactly a place (a link to the plan\'s places) and two numbers (the row and the tier) is answered by a pick on the plan, never by a form. On a desk a press opens a row\'s record in the panel beside the plan.\n\n<!-- generated:end layout-doc-plan -->\n\n```jsonc\n// table "bay"\n"title": "code",\n"records": { "plan_place": { "kind": "kind", "x": "x", "y": "y", "across": "rows", "up": "tiers", "reach_from": "taken_from", "stacked": "is_stack" } }\n```\n\n```json\n{ "type": "List", "entity": "pallet", "filters": ["line"], "layout": { "plan": { "at": "bay", "across": "row", "up": "tier" } } }\n```\n\n```jsonc\n// table "pallet": one item to a cell on every write, not only through the app\n"unique": [["bay", "row", "tier"]]\n```\n\n<!-- generated:start layout-plan -->\n\n#### Plan keys\n\n| Key | Type | Meaning |\n|---|---|---|\n| `at` | alias, required | A one-link of this entity to an entity whose `records` states a `plan_place`: where each row stands |\n| `across` | alias, required | A number field: the row of a bay a row stands in, counted from 1; empty at an area |\n| `up` | alias, required | A number field: the tier of a bay a row stands at, counted from 1 at the ground; empty at an area |\n| `fill` | alias | A single select the items are coloured by; absent, the first single select among the register\'s filters |\n| `mark` | [Plan mark](#plan-mark) | A row holding the option says the option\'s label on its box and is hatched in the option\'s own colour, and the legend names it by the label; over `sources`, the select is matched by option alias, and a source lacking the select never marks its rows |\n| `size` | [Plan size](#plan-size) | Each row\'s box as it stands in the world, in the one length unit its places\' `size` states: the option the row holds of the select names its box\'s width across, depth along and height; over `sources`, matched by option alias, as `mark` is; a row holding an option it does not name is drawn at its place\'s cell |\n\n#### Plan mark\n\n| Key | Type | Meaning |\n|---|---|---|\n| `field` | alias, required | A single select of this entity, or a lookup of one through a one-row link |\n| `option` | alias, required | An option alias of that select |\n\n#### Plan size\n\n| Key | Type | Meaning |\n|---|---|---|\n| `field` | alias, required | A single select of this entity, or a lookup of one through a one-row link |\n| `options` | map of alias \u2192 [Plan size box](#plan-size-box), required | The box of each option alias of that select |\n\n#### Plan size box\n\n| Key | Type | Meaning |\n|---|---|---|\n| `across` | number, required | The box\'s width across the bay\'s rows |\n| `along` | number, required | The box\'s depth along them |\n| `up` | number, required | The box\'s height |\n\n#### Plan place\n\n| Key | Type | Meaning |\n|---|---|---|\n| `kind` | alias, required | A single select, options aliased `bay` and, where the places have them, `area` and `landmark`: a bay holds rows and tiers, an area neither, a landmark nothing |\n| `sheet` | alias | The plan sheet it is on: a single select, or a one-row link to an entity whose `records` states its `image` \u2014 the sheet\'s drawing, which the places are drawn over (with `scale`) |\n| `scale` | alias | A number field of the sheet entity `sheet` links to: how many cells wide its drawing is, the plan\'s scale. Required where that entity states an `image`, and only then |\n| `x` | alias, required | A number field: left edge, in cells |\n| `y` | alias, required | A number field: top edge, in cells |\n| `width` | alias | A number field: an area\'s frame width, in cells |\n| `depth` | alias | A number field: an area\'s frame depth, in cells |\n| `across` | alias, required | A number field: a bay\'s rows |\n| `up` | alias, required | A number field: a bay\'s most tiers |\n| `reach_from` | alias | A single select, options aliased exactly `first`, `last`, `both`: the side boxes leave a bay from; a bay that names none has no reach and no arrow |\n| `stacked` | alias | A boolean field: true where items at this place rest on the one below (a stack), so a tier above the first needs a present item under it, shows floating without one, and an item\'s reach counts the items above it; false or empty, items sit at any tier and only the rows between a bay\'s reach side and the item are in the way |\n| `size` | [Plan place size](#plan-place-size) | The real size of ONE cell of the place, for 3D: three number fields stating one length `unit` alike. Absent, a cell is drawn at the size most of the sheet\'s places state, a unit cube where none states one |\n\n#### Plan place size\n\n| Key | Type | Meaning |\n|---|---|---|\n| `across` | alias, required | A number field: the width of one cell across the rows |\n| `along` | alias, required | A number field: the depth of one cell along the place |\n| `up` | alias, required | A number field: the height of one cell, one level |\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `list.plan` | `layout: { plan }`: `at` is a one-row link to an entity whose `records` states a `plan_place`, `across` and `up` two different numbers of the row, `fill` a single select; a plan List has no Tabs, `group` or `attention`. A write that sets `at`, `across` or `up` is refused unless it clears all three, or places the row at a free cell of a bay (a row from 1 to the bay\'s `across`, a tier from 1 to its `up`, resting on a present item), or at an area with neither. |\n| `list.plan-unique` | *Noted, never refused:* A plan\'s items (the List\'s table and each source) state `unique` on their place link, `across` and `up`: the app\'s moves refuse a taken cell, and the unique makes every other write hold it \u2014 the note names a table that states none. |\n| `list.plan-mark` | A plan\'s `mark` names a single select of the row, or a lookup of one through a one-row link, and an option of it by alias: a row holding that option is hatched on its box in the option\'s colour. A source that holds the select must hold it as a single select with that option; a source lacking it never marks its rows (`list.source-lacks`). |\n| `list.plan-size` | A plan\'s `size` names a single select of the row, or a lookup of one through a one-row link, and, by option alias, the box (`across`, `along`, `up` \u2014 positive, in the one length unit the places\' `size` states) of each option: a row holding one is drawn as that box. A source that holds the select must hold it as a single select; a source lacking it draws its rows at their places\' cells (`list.source-lacks`). |\n| `list.plan-box-size` | *Noted, never refused:* A plan whose places state a `size` and whose rows\' select options are ISO 6346 container size-type codes (`20DC`, `40HC`) states the box of each in `size`, from the ISO 668 dimensions, else every box is drawn at its place\'s cell. |\n\n<!-- generated:end layout-plan -->\n\n## Publish desk\n\nRows that are each a place the record is sent \u2014 a notice\'s boards, a listing\'s portals \u2014 are a record\'s child List with\n`expect` on the child\'s one-row link to the catalog of those places and `layout: { "desk": \u2026 }`:\n\n```json\n{\n "type": "List",\n "entity": "posting",\n "expect": "board",\n "columns": ["posted_link", "refusal"],\n "layout": { "desk": { "bodies": ["wording", "wording_abroad"], "text": "goes_out_as", "media": "pictures", "link": "page", "group": "reach", "network": "kind", "networks": { "company_page": "linkedin" } } }\n}\n```\n\nThe desk is where the post is written. `bodies` are the record\'s plain text fields it is written in (one per language,\nsay), each its editor between the list and the preview, saved as any field of the record is and drawn nowhere else on it.\nThe preview is `text` read over what is on screen: where `text` is a formula of the child, the desk computes that same\nformula over what is typed, so the post moves as it is written, and a place not ticked previews the words its row would\nhold. For that the formula reads only what a screen holds whole: stored values of its row, the record through lookups over\nthe link back to it, the place through lookups over `expect`, and formulas of the row over those \u2014 a rollup, a lookup\nthrough another link or the clock is refused, naming the field.\n\nEvery place the link admits is a line with a tick and that place\'s face: its picture, else the mark of the network it is on\nwhere `networks` names one. `group`, another single select of the place, stands the lines under its options in their\norder: a kind holding a ticked line is open, one holding none folded to its heading and its count. A tick makes the line\'s\nrow from its key alone \u2014 so nothing else the child requires is left without a default \u2014 and an untick deletes it until the\nrow\'s stage is `closed`: what went out is not taken back. It asks first only where a person wrote on the row. One line is\nworked beside the list and read as the post that place\'s feed shows: `text` is the child\'s words for that place, `media`\nand `link` the record\'s, and `network` the place\'s single select whose options `networks` names to a feed; an option not\nnamed reads on a plain card. Under the bodies stand the List\'s `columns` a person writes of the line\'s row; under the post,\nthe press copying its words beside the Acts of the child, then what the line and the `columns` hold that nobody writes\nthere (the link it went out at, why it was refused). A value an Act or a workflow fills is stated as that Act\'s, so the\ndesk never offers it as an empty box. Sending is an ordinary Act of the record.\n\n<!-- generated:start layout-desk -->\n\n#### Desk keys\n\n| Key | Type | Meaning |\n|---|---|---|\n| `bodies` | list of alias (1\u20133) | The record\'s plain text fields the post is written in, in order \u2014 one per language, say \u2014 at most 3: each its editor on the desk, between the list and the preview, and drawn nowhere else on the record |\n| `text` | alias, required | A text of the block\'s rows \u2014 stored, or a formula yielding text \u2014 holding the words that go out on that row\'s destination. A formula is computed on the desk too, over what is typed: it reads stored values of its row, the record through lookups over the link back to it, the destination through lookups over `expect`, and formulas of the row over those \u2014 never a rollup, another link or the clock |\n| `media` | alias, required | A files field of the record: the pictures or the video the post carries |\n| `link` | alias | A text field of the record holding a link (`format: "link"`), carried as the post\'s card |\n| `network` | alias, required | A single select of the entity `expect` links to, saying which network each destination is on |\n| `group` | alias | Another single select of the entity `expect` links to \u2014 the destination\'s kind \u2014 the lines stand grouped by: each option a heading in the select\'s order, a group holding no ticked line folded to its heading and its count, destinations holding no option last |\n| `networks` | map of alias \u2192 `"facebook"` \\| `"instagram"` \\| `"threads"` \\| `"x"` \\| `"linkedin"`, required | That select\'s options, each by its alias, to the network whose feed the post is previewed in \u2014 facebook, instagram, threads, x, linkedin. An option not named has no feed to imitate: its words read as a plain card |\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `list.post` | A child List with `layout: { desk }` needs `expect` on a one-row link \u2014 never a select, nor with `under`, `pick`, a checklist layout, `compare` or a `create` list, its line made by a tick from its key alone: its `bodies` are plain text fields of the record a person writes, drawn nowhere else on it; its `text` is a text of the child, stored or a formula yielding text \u2014 a formula reading only stored values of its row, lookups through the link back to the record or through `expect`, and formulas of the row over those, never the clock; its `media` a files field of the record and its `link` a text field of the record; its `network` a single select of the entity the link names, and `networks` holds options of that select, by alias, each to one of facebook, instagram, threads, x, linkedin; its `group` is another single select of that entity. |\n\n<!-- generated:end layout-desk -->\n\n## Record node\n\nA Record draws what a row opens: the head, then the parts.\n\n- **The head:** title, subtitle, picture, mark, party, figure and meter, deadlines, description \u2014 the\n table\'s `records` facts, overridden by the Record\'s `row`. `row` changes how the App\'s rows read wherever it lists them, and has nothing to do with arranging a page. The status stands in the head, or the Side where the Side states it, never in a Section.\n- **Where it stands:** a Record stands only in the App\'s `pages`, one per entity, stating its `entity`; every List over\n the entity opens it. With no page for an entity, the platform designs the record\'s Sections from the rows: the fields\n the head does not draw, child Lists, papers and Acts. A stated page stands exactly as written, so it replaces them.\n Under a child List, an absent page is every field of the child except the link back.\n- **Children:** either parts \u2014 `Section`, `Side` \u2014 or, for a one-part record, `Field`, `List`, `Reading`,\n `Statement` and `Act` directly. The two are never mixed. The page of an entity no root List and no Sheet\'s List (one stating no `app`) is over \u2014 a\n child List\'s, a document\'s or a roster cell\'s \u2014 holds `edit`, Fields, Sections of them with the Acts and the Lists of\n their rows\' own children, and the Lists of its rows\' own children; a row opened in place draws each Section under its\n title, an Act no Section holds at the last Section\'s foot, and a page with no Section its one section. Such a page\n holds what any page holds \u2014 a Reading, a Side \u2014 and one stating a Side opens its rows\n by its `door` instead of in place; any other `door` there is not drawn and stays stated.\n\n<!-- generated:start node-record -->\n\n| Key | Type | Meaning |\n|---|---|---|\n| `entity` | alias, required | The table whose rows open on this page: a page stands once per entity, in the App\'s `pages`, and every List over the entity opens it |\n| `row` | [Record row](#record-row) | How the App reads this entity\'s rows wherever it lists them \u2014 their line, figure, picture, deadlines and stage \u2014 where it differs from the table\'s `records` |\n| `add` | `false` \\| list of alias (at least one) | What a new row asks where a picker of this entity offers one, anywhere in the App: these fields; `false`: a picker only picks. Absent, the table\'s required fields, its natural key and its title, where the table states a `singular` |\n| `remove` | `true` | Lets a person delete a row reached through a link: true, it offers a Delete; rows a List lists are deleted as that List\'s `remove` says |\n| `door` | `"page"` \\| `"drawer"` | How a row opens, on a page or in a drawer: absent, a page where a part is a step or a Side or there are more than 3 parts, else a drawer |\n| `edit` | `false` | Shows a record nobody changes here: false, nothing it draws is written, a link\'s row of it included |\n| `children` | list of (alias \\| [Field](#field-node) \\| [Fieldset](#fieldset-node) \\| [Section](#section-node) \\| [Side](#side-node) \\| [Outside](#outside-node) \\| [List](#list-node) \\| [Reading](#reading-node) \\| [Statement](#statement-node) \\| [Act](#act-node) \\| [Check](#check-node)) (at least one) | Parts (Section, Side), or for a one-part record its Fields, Fieldsets, Lists, Readings and Statements directly \u2014 never both. Beside either stand Outsides, Checks (guarding this entity\'s Acts and saves) and Acts on one row, each placed at the foot of the part whose step it moves into, a correction in the head\'s \u22EF. Holding only Acts, Checks and Outsides, or absent, the record\'s Sections are the platform\'s: the fields the head does not draw, child Lists, papers and Acts. Otherwise it stands exactly as written |\n\n#### Record row\n\n| Key | Type | Meaning |\n|---|---|---|\n| `title` | [Record row title](#record-row-title) | The row\'s title field, stated for its `edit` alone |\n| `subtitle` | list of (alias \\| [Record row line field](#record-row-line-field)) (1\u20132) | Up to two fields read under the title, in place of the table\'s |\n| `figure` | alias \\| [Record row line field](#record-row-line-field) \\| `false` | The one number a row stands for, in place of the table\'s; false, none. `{ field, edit: false }` reads it without writing it |\n| `image` | alias \\| [Record row line field](#record-row-line-field) \\| `false` | A files field, or a one-row link to a table with a picture, that pictures a row, in place of the table\'s; false, none. `{ field, edit: false }` reads it without writing it |\n| `due` | list of alias (at least one) \\| `false` | Dates that count down, in place of the table\'s; false, none |\n| `status` | `false` \\| `{ "edit": true \\| false }` | Whether this app shows and moves the stage: false, it is not shown. `{ edit: true }`: the stage is also moved by hand. `{ edit: false }`: nobody moves it in this app, another app does. Absent, the stage stands in the record\'s head, or in the Side where the Side states it: choosing a move runs its Act, asking and refusing as its button does |\n\n#### Record row title\n\n| Key | Type | Meaning |\n|---|---|---|\n| `edit` | `false` | Keeps a row\'s name as it stands: false, the title is read; absent, it is written where the table lets a person write it |\n\n#### Record row line field\n\n| Key | Type | Meaning |\n|---|---|---|\n| `field` | alias, required | The field\'s alias |\n| `edit` | boolean | Shows a value nobody changes here: false, the field is drawn and read; absent or true, it is written where the table and the part holding it let a person write it |\n\n<!-- generated:end node-record -->\n\nThe door is a page where a part is a step or a Side, or where there are more than 3 parts; else a drawer. `door`\nis a judged choice of how a job is worked (one after another over a long record), so it is kept. A Section is one area of the record\'s data a person comes to for its own job, like the tabs of a settings page (a company\'s General,\nMembers, Billing): the related lists and field groups of that area sit inside it under their headings. A status\'s stages are not areas:\ntheir acts stand at the foot of the rows they move. From three parts on, the\nrecord shows one at a time: a press on a page\'s rail (a strip of the same names on a phone and in a drawer) flips to a part and returns\nto the top. It opens on the part the address names, else the step that is now, else the first. A part\'s rows and drafts are kept\nacross flips. With fewer parts they stack.\n\nA record shows no activity and no audit log: a history an app shows is table-backed \u2014 `records.status.dates`, `records.status.history`, an event table an act\nmakes \u2014 stated where the app shows it.\n\nA field may be stated in any number of parts, and each part draws what it states. Where parts stack it stands once: in the\nstep that is now if that step states it, else the first part stating it. A Section or a List with `when` is\ndrawn only while each named select of the record holds one of its options.\n\n## Section node\n\nA titled part of a record, and optionally a step of its path. A Section draws its plain Fields first, then its\nLists, Readings and Statements in the order stated; its Acts stand at its foot.\n\n<!-- generated:start node-section -->\n\n| Key | Type | Meaning |\n|---|---|---|\n| `key` | alias | Unique among its siblings; part of the node\'s address. Absent, the title\'s words as a slug, written once and kept |\n| `title` | text | The part\'s heading. Absent, the part draws none where it is the record\'s only part; beside others it is named by what the record is. A step states it |\n| `description` | text | A line under the heading |\n| `when` | [condition](#app-tree) | Drawn only while this holds |\n| `edit` | `false` | Shows a part nobody changes here: false, nothing in it is written |\n| `at` | list of alias (at least one) | Options of the record\'s status during which this part is the work now: a step of its path |\n| `children` | list of (alias \\| [Field](#field-node) \\| [Fieldset](#fieldset-node) \\| [List](#list-node) \\| [Reading](#reading-node) \\| [Statement](#statement-node) \\| [Act](#act-node) \\| [Check](#check-node)) (at least one) | What the part draws, in reading order; its Acts stand at its foot. A Fieldset holds Fields under a heading of their own. A Check stated here guards the entity as one beside the parts does |\n\n<!-- generated:end node-section -->\n\n#### Kinds of block\n\nWhat a Section draws beside its Fields is a block, of the kind its item states: a List a rows block, an outline where its table holds rows under rows, an agenda or a timeline by its layout, or a list that only reads; a Field a gallery of files or a prose block; a Statement and a Reading each its own.\n\n<!-- generated:start block-kinds -->\n\n| Kind | What it is |\n|---|---|\n| `rows` | Rows list a record\'s child rows under it, each a line in the register\'s row anatomy: a List standing in a Section, its rows linked to the record, narrowed by its `where`, opened in place, their Acts in each row\'s \u22EF; rows that hold pictures are cards, each led by its picture. A child List draws as rows unless its layout says otherwise; a `checklist` reads the rows as checks, a `desk` as the places the record is sent and a `gantt` as bars on an axis of time (the register\'s, over the rows the record\'s link names). |\n| `outline` | An outline draws a record\'s child rows as a tree where their table holds rows under rows (a task under a task, a part of a part): the top rows first, each row\'s sub-rows read when it is opened, with the count of them, closed of all, beside its name; a row adds a row under itself from its \u22EF. A List the reader narrows, orders by a header, groups or searches draws as plain rows. |\n| `agenda` | An agenda reads a record\'s child rows as planned entries on a time axis: by day, soonest first, each with its picture and the day that is today marked. The day is the first date on the child\'s row line; within a day entries follow a datetime there, else the first single select after the date. An entry with no day yet is a plan, listed first and dated in place. `start` is the record\'s date that is the first day: each day\'s heading counts from it (Day 1, Day 2). |\n| `timeline` | A timeline reads a record\'s child rows as a log of dated entries, newest first, with a composer where the app adds entries, each corrected and removed where it stands. It is never the record\'s status history: the rail shows each move. A timeline\'s moment is its child\'s first date, and who its member field. |\n| `files` | Files draw a run of the record\'s files fields as one gallery under a heading, each field\'s files as thumbnails with a drop zone to add to them. A files field, or a lookup of one, draws as a gallery unless its Field states `block: false`. |\n| `text` | Text draws one of the record\'s markdown fields as prose under a heading, edited in place where the app writes it. A markdown field draws as prose unless its Field states `block: false`; plain text is a control among the part\'s fields unless it states `block: true`. |\n| `choices` | Choices draws one of the record\'s multi-selects as a checklist under a heading: every option on a line of its own, ticked where the record holds it, ticked and unticked in place where the app writes it. A multi-select is a control among the part\'s fields unless its Field states `block: true`. |\n| `linked` | Linked draws the row a link of the record to one row names, whole and in place, as its page draws it \u2014 its fields, parts, Lists and Acts, read and written as that row\'s own \u2014 under a heading. A link draws as its row\'s chip unless its Field states `block: true`. |\n| `figures` | Figures draw numbers of the record (1 to 8) as tiles, each under its field\'s label. A tile holding nothing reads as not measured, never 0. |\n| `statement` | A statement builds one figure from figures of the record: each line a number of it with its operator and its label, the figures on one right edge, the last an `equals` drawn heaviest (a claim\'s payable, an invoice\'s total, a payslip\'s net). A line may carry the rows its figure adds up (`parts`), each listed under it. |\n| `reading` | A reading block draws a Reading over the child rows under the record, through their link to it: a number, a split into parts, a trend, a grid, a shortfall against stock, or the work against its plan. It stands in the record\'s strip beside the record\'s own figures. |\n| `list` | A list shows rows of another entity beside the record, read only: those linked to it, a path through a row of their own, or \u2014 with `same` \u2014 the siblings sharing a link of the record, the record itself left out. Each row reads in its `records` anatomy with the `columns` after its title, and opens on its page. |\n| `funnel` | A funnel counts steps people drop out of between, a column of each child row a step (2 to 8): one funnel over the rows under the record \u2014 each step its column summed, its bar over the first step, the share kept between two steps and from the first to the last. |\n\n<!-- generated:end block-kinds -->\n\n- **`at`** names the stage options during which the section is the work now \u2014 only on a record that\n truly moves through those stages: the rail marks it done, now or waiting, and it may hold nothing, its title being the step;\n one that is now and holds nothing says so. Two Sections at one option are both the work there, and the first opens. A step\n never hides a field, locks it or gates an act: fields stay writable as the write rules and checks allow, at any stage.\n- **Acts:** every Act on a record stands in the Section whose work it is. An Act moving the stage and offered at ONE step\n stands at that step\'s foot when it moves the work forward, to an exit later in the stage\'s options, or back to a step the\n work passes; one offered at several steps, or moving back into a step the work never passes, stands in the Section it\n enters, as its way in. One stated elsewhere stands there, and the answer says so. A correction (`danger`, and not one of\n its step\'s outcomes) waits in the Section heading\'s \u22EF.\n- **An exit** stands only once the record is in it, its reason there and its rail item apart from the path; until then the\n Act waits in the header\'s \u22EF.\n- **A document:** a Section that is no step and holds nothing but one `text` block over a markdown field reads as a document: the field is written in place with no box, saved when the writer leaves it, and the record reads in an article column while that part is in view.\n- **Writes:** its Fields and its Acts.\n\n## Side node\n\nThe one part drawn beside the rest \u2014 the photos looked at, the pool picked from, the facts kept in view. It stands on the\nright, beside the rail and the parts; on a phone it is one pinned line that opens in place. At most one Side to a record, on a page\ndoor.\n\n<!-- generated:start node-side -->\n\n| Key | Type | Meaning |\n|---|---|---|\n| `key` | alias | Unique among its siblings; part of the node\'s address. Absent, the title\'s words as a slug, written once and kept |\n| `title` | text, required | The part\'s heading |\n| `description` | text | A line under the heading |\n| `when` | [condition](#app-tree) | Drawn only while this holds |\n| `edit` | `false` | Shows a part nobody changes here: false, nothing in it is written |\n| `children` | list of (alias \\| [Field](#field-node) \\| [Fieldset](#fieldset-node) \\| [List](#list-node) \\| [Reading](#reading-node) \\| [Statement](#statement-node) \\| [Act](#act-node) \\| [Check](#check-node)) (at least one) | What the part draws, in reading order; its Acts stand at its foot. A Fieldset holds Fields under a heading of their own. A Check stated here guards the entity as one beside the parts does |\n\n<!-- generated:end node-side -->\n\nIt holds what a Section holds. A field it states, the status included, leaves the head and stays on list rows; the title stays in the head. Writes: its Fields and its Acts.\n\n## Outside node\n\nWhat one record shows, and which acts it allows, to a person with no seat who opens a link a member made of it. A member\npresses Create link on a record while its status stands in `at`; the link opens that one record until it expires, is\nrevoked, or its act moves the status out of `at`. The person sees the stated Fields and Lists and presses the stated Acts\nand nothing else. It stands directly in the Record of a table with a stored status select, whichever List over it opens the page.\n\n<!-- generated:start node-outside -->\n\n| Key | Type | Meaning |\n|---|---|---|\n| `key` | alias | Unique in the app: a link to the record names it. Absent, the title\'s words as a slug, written once and kept |\n| `title` | text, required | The heading of the page the person without a seat opens |\n| `description` | text | A line under the heading |\n| `at` | list of alias (at least one), required | Options of the record\'s status during which a link to it opens; none is owned by a stage, and each Act moves the status out of them |\n| `children` | list of (alias \\| [Field](#field-node) \\| [List](#list-node) \\| [Act](#act-node)) (at least one), required | Exactly what the link shows and allows: Fields read as values, Lists of child rows read as they are, and the Acts the person may press, each moving the status out of `at` |\n\n<!-- generated:end node-outside -->\n\n- **Fields** are read as values, in order; a lookup, a rollup or a formula is computed for the link only if stated here.\n A Field states nothing but its alias.\n- **Lists** read the child rows under the record as they are: `columns`, `label` and `where`.\n- **Acts** are the link\'s alone: no member, visitor or agent presses them. Each states `key`, `label`, `confirm`, `when`,\n `requires`, `asks`, `set`, `template` with `into`, or `sign`. `when` absent is the status held in `at`; `set` moves the\n status to an option outside `at`, so each press ends the visit. `asks` are text, numbers, dates or listed options. A\n `sign` is by a text field the signer types, with no witness: the link is the attestation.\n- `at` names options no stage owns, and no two Outsides of a table open during the same option.\n- **Writes:** its Acts, and nothing else.\n\n## Tab node\n\nA Tab is one view of a List\'s rows over a period: a register reporting a period \u2014 what stands at its end beside what came and went during it (the stock,\n the hires out, the tickets open) \u2014 reads its rows as Tabs over one `period` the reader picks above them. A Tab holds\n the rows `dated` within the period, those `open` at its end, or lists every row and draws what a child\'s rows came to\n in the period (`totals`). A Tab narrows its rows and holds no nodes; Readings stand beside it in the List and read the\n open Tab, or the one their `tab` names. Never date chips set by hand, and never a Tab per stage, which the chips split.\n Readings and Lists read apart from a List\'s rows stand on a Sheet, a View of the App\'s own.\n\n<!-- generated:start node-tab -->\n\n| Key | Type | Meaning |\n|---|---|---|\n| `key` | alias, required | Unique among its siblings; part of the node\'s address |\n| `label` | text, required | What the tab holds, in the reader\'s words |\n| `dated` | alias | A date: the tab holds the rows dated within the List\'s period |\n| `open` | [Tab open](#tab-open) | The tab holds the rows open at the period\'s end: begun, and not yet ended |\n| `totals` | [Tab totals](#tab-totals) | Each row\'s figures over a child\'s rows in the period |\n| `where` | [narrowing](#app-tree) | Only the rows whose select holds one of these options, whose yes/no is this value, or whose member field holds the reader (`{ "me": true }`) \u2014 every entry ANDed |\n| `sort` | [Sort key](#sort-key) \\| list of [Sort key](#sort-key) (at least one) | The order this tab\'s rows read in; absent, the List\'s |\n\n#### Tab open\n\n| Key | Type | Meaning |\n|---|---|---|\n| `from` | alias, required | The date a row begins on |\n| `to` | alias, required | The date a row ends on, empty while it is open |\n\n#### Tab totals\n\n| Key | Type | Meaning |\n|---|---|---|\n| `rows` | alias, required | An entity of this app whose rows each belong to one row of the register\'s entity: the rows the columns add |\n| `on` | alias, required | A date of the child placing each row in time: stored, a formula yielding a date, or a lookup of a date through a one-row link \u2014 never a moment or a span of days |\n| `columns` | list of [Totals column](#totals-column) (1\u20136), required | The figures drawn in place of the register\'s columns after each row\'s name, each under its own alias and label |\n\n#### Totals column\n\n| Key | Type | Meaning |\n|---|---|---|\n| `alias` | alias, required | The column\'s name: its address in the totals read |\n| `label` | text, required | What the column holds, in the reader\'s words |\n| `value` | alias \\| `{ "avg": alias }` | A number of the child (stored, a formula or a rollup) summed over the rows, or `{ avg }` averaged over the rows holding one, a window holding none drawing blank; absent, the rows are counted. A figure read in each row\'s own unit or currency stands only where the child\'s select is a lookup, through `via`, of a single select of the register\'s entity |\n| `where` | map of alias \u2192 (list of alias (at least one) \\| boolean) | Only the child\'s rows whose select holds one of these options, or whose yes/no is this value \u2014 every entry ANDed |\n| `window` | `"before"` \\| `"in"` \\| `"through"`, required | Which of the child\'s rows, by `on`, the column adds: `before` those dated before the period\'s first day, `in` those from its first day through its last, `through` those on or before its last day |\n\n#### Period days\n\n| Key | Type | Meaning |\n|---|---|---|\n| `days` | integer, required | How many days through today, at most 366 |\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `list.tabs` | A List\'s Tabs each have a `key` of their own, none the entity\'s alias or one a report template holds (`title`, `lines`, `readings`, `at`, `dates`, `period`, `per`); a Tab states one of `dated` and `open` (dates of its rows, `open`\'s two different) or `totals` (a child\'s rows windowed by the period); its `where` and `sort` hold as the List\'s do, and never narrow by the status, which its chips split. Only a table or cards List has Tabs, and a Reading\'s `tab` names one of them. A `period` opens a List on a window: over a table or cards a Tab that states `dated`, `open` or `totals` reads it; a calendar or a lanes board opens on `"today"`, `"week"` or `"month"` (a lanes board of hours, on `"today"` or `"week"`); no other layout draws one. Wrong: `period: "year"` over a table with no dated Tab. Right: a Tab stating `dated`, or no `period`. |\n| `list.tab-totals` | A Tab\'s `totals` name a child linked to the List\'s entity by a one-row link (a child linking the List\'s entity twice cannot be totalled), a date of the child, never a moment or a span, and 1 to 6 columns each under its own alias and label; a column\'s `value` is a number of the child, its `where` holds over the child\'s selects and yes/nos, and a value read in each row\'s own unit or currency stands only where that select of the child looks up, through its link, a single select of the List\'s entity, and the child links to no source\'s rows. A source\'s rows are totalled by the child\'s one link to them, by one field to one row; a source the child links to not at all totals nothing on its rows (`list.source-lacks`). Only a table List has them, and no Tab states `totals` beside `dated` or `open`. A column sums a number or counts rows, never `{ avg }`. |\n\n<!-- generated:end node-tab -->\n\nA `totals` Tab adds, per column, the child\'s rows `before` the period\'s first day, `in` the period, or `through` its last\nday, so `before` plus `in` of one value is its `through`:\n\n```json\n{\n "type": "Tab",\n "key": "items",\n "label": "Items",\n "totals": {\n "rows": "ledger_line",\n "on": "moved_on",\n "columns": [\n { "alias": "opening", "label": "Opening", "value": "quantity", "window": "before" },\n { "alias": "received", "label": "Received", "value": "quantity", "where": { "kind": ["receipt"] }, "window": "in" },\n { "alias": "issued", "label": "Issued", "value": "quantity", "where": { "kind": ["issue"] }, "window": "in" },\n { "alias": "closing", "label": "Closing", "value": "quantity", "window": "through" }\n ]\n }\n}\n```\n\n## Sheet node\n\nA Sheet is a grid of Readings and Lists over the App\'s rows in its `period`: each Reading a figure, each List the rows it lists. An App of one Sheet opens on it; an App of several draws a strip that picks one.\n\n<!-- generated:start node-sheet -->\n\n| Key | Type | Meaning |\n|---|---|---|\n| `key` | alias, required | Unique among the App\'s Views: the sheet\'s address, `/<key>` |\n| `label` | text, required | What the sheet holds, in the reader\'s words: its name among the App\'s Views |\n| `children` | list of ([Reading](#reading-node) \\| [List](#list-node)) (at least one), required | The Readings and Lists the sheet draws as a grid, in reading order: each Reading a figure over the App\'s rows in the App\'s `period`, each List the rows it lists |\n\n<!-- generated:end node-sheet -->\n\n## Field node\n\nA Field draws one field of the record it stands in. How it is drawn follows from the field\'s type and the table\'s facts:\n\n- a control or a value, with its notation, money, units and deadline countdown;\n- a files field as pictures and documents, a long or markdown text as prose written in place \u2014 a gallery or a prose block,\n with a heading (`label`) and a condition (`when`) of its own; a run of files Fields is one gallery;\n- a link as its row\'s chip, with a picker narrowed by `options_where`, offering a new row where the linked table\'s page\n states `add`;\n- the back side of a child\'s link as the rows filed under the record;\n- the fields an Act\'s `sign` writes as one signature.\n\n<!-- generated:start node-field -->\n\n| Key | Type | Meaning |\n|---|---|---|\n| `field` | alias, required | The field\'s alias |\n| `edit` | boolean | Shows a value nobody changes here: false, the field is drawn and read; absent or true, it is written where the table and the part holding it let a person write it |\n| `label` | text | The heading of the field\'s gallery or prose block, where it draws as one; absent, the field\'s label. A run of files fields takes the first one\'s |\n| `block` | boolean | Gives a field room of its own: true, a files, text or multi-select field draws as its own gallery, prose or checklist block, and a link to one row as that row drawn whole in place, as its page draws it; false: as a control among the part\'s fields. Absent, files and markdown fields draw as blocks, plain text, a multi-select and a link as a control |\n| `when` | [condition](#app-tree) | A gallery or prose block is shown only while the record\'s selects hold these options, its yes/nos these values, its numbers and dates meet their bounds and its `{ "empty": true \\| false }` fields are blank or filled |\n\n<!-- generated:end node-field -->\n\nA field drawn in the head (title, subtitle, picture, figure, stage) is never also a Field node. A Field is drawn once per\npage. **Writes:** the field, under `reference/app-tree`; a picker\'s add is the linked table\'s page\'s `add`.\n\n## Fieldset node\n\nA Fieldset heads a run of a part\'s Fields with a few words of its own: the facts of one kind among a part\'s many (a\nvehicle\'s plate, make and seats under "Vehicle"). It stands among a Section\'s or Side\'s children, or a one-part\nRecord\'s, and holds Fields alone \u2014 two or more, each drawn as a control, each in one Fieldset. A Field in it reads and is\nwritten as it would be in the part. A gallery or prose Field stands beside it, never in it.\n\n<!-- generated:start node-fieldset -->\n\n| Key | Type | Meaning |\n|---|---|---|\n| `key` | alias | Unique among its siblings; part of the node\'s address. Absent, the label\'s words as a slug, written once and kept |\n| `label` | text, required | The heading over the facts it holds, in the reader\'s words |\n| `children` | list of (alias \\| [Field](#field-node)) (at least 2), required | The Fields drawn under the label, in the order stated; each reads as it would in the part |\n\n<!-- generated:end node-fieldset -->\n\n## Act node\n\nAn Act is a verb, stated whole where it stands. Its place decides what it works on:\n\n- in a Section or Side, or in a one-part Record: one record, at that part\'s foot;\n- in a List, with `on`: the ticked rows or every row in view, each checked before any is written;\n- directly in a Record that holds parts: refused.\n\n<!-- generated:start node-act -->\n\n| Key | Type | Meaning |\n|---|---|---|\n| `key` | alias, required | The act\'s name; its workflow is `act_<key>`, or the `workflow` it names |\n| `label` | text, required | The verb, as the reader says it |\n| `when` | [condition](#app-tree) | The act works only while this holds |\n| `requires` | list of alias (at least one) | Fields filled first, each drawn where the act stands |\n| `recommends` | list of alias (at least one) | Fields it runs without and reads when filled |\n| `asks` | list of (alias \\| `{ "field": alias, "starts": "today" \\| "me" }` \\| [Asked input](#asked-input)) (at least one) | What the reader states on pressing: fields of the row (written by the act) or inputs; a `link` input\'s picker adds as its entity\'s page `add` says |\n| `set` | map of alias \u2192 [value](#app-tree) | What the act writes; each field is read-only elsewhere in the app |\n| `owner` | `"field"` \\| `"link.field"` \\| `{ "group": id }` | Who presses it: a member field of the row, `link.field` read through a one-row link, or `{ group }` by id. Absent, the owner of the stage it is offered at, or anyone the app is shared with where it stands at none |\n| `workflow` | alias | The workflow it runs for what `set` cannot say: one made under this name, its body set by `set_workflow`, or the app\'s Workflow node, taking the row as `record_id`; the act\'s guards head its body |\n| `template` | alias | A document template it makes a file from: html a PDF, excel a workbook, word a .docx; over several rows, one file of them all, an html paper hands each row its own lists under the names the record\'s paper uses |\n| `templates` | list of [Act template](#act-template) (at least 2) | Several papers made into `into`, instead of `template`: the reader ticks which |\n| `into` | alias | The record\'s files field keeping the document; remade, it replaces its own last paper, never a person\'s file |\n| `paper` | text | Its paper, `<child>.<kind>`: the line of the record\'s papers it stands on |\n| `intake` | alias | A child the record lists whose rows are its papers: the press takes papers, an agent reads them, each filed as a row of it. With `on: "view"`, they make a new record of the List\'s entity, and the save opens it |\n| `fills` | list of text (at least one) | With `intake`, what the papers may fill: a field of the record, `<link>.<field>` on the row a required one-row link names, or a child they add rows to; on a new record that row is found on its entity\'s `natural_key` or added. With `record`, fields of the new row an agent fills from the transcript |\n| `record` | [Recording](#recording) | The press records a call, visit or meeting, filed as a new row of a child the record lists |\n| `sign` | [Signature](#signature) | The press opens a pad; the act keeps the signature as a picture with who signed, when and the witness |\n| `review` | `true` | Lets a person approve what a workflow would write: with `workflow`, it only proposes a changeset of the act\'s table, and the reader ticks the rows to write |\n| `makes` | alias | The rows a record\'s `cadence` still owes of this child: the press lists them, each with what would stop it, and writes the ones ticked. Pressed again it lists only what is missing |\n| `confirm` | `true` \\| text | The press asks first: the question, or `true` for the act\'s label over the row |\n| `danger` | `true` | The act destroys or cannot be undone |\n| `on` | `"ticked"` \\| `"view"` | Which rows an Act over a List works on: `ticked`, those ticked in the List holding it; `view`, every row in view. Every Act a List holds states it, and no other |\n\n#### Asked input\n\n| Key | Type | Meaning |\n|---|---|---|\n| `input` | alias, required | A value the act asks for that is not a field of the record |\n| `label` | text, required | What the reader is asked, in their words |\n| `type` | `"text"` \\| `"long_text"` \\| `"number"` \\| `"date"` \\| `"select"` \\| `"link"` \\| `"member"` \\| `"file"`, required | What the reader states. A `file` is one uploaded file, handed to the act\'s authored `workflow` as its file id and read by nothing else |\n| `options` | list of [Select option](#select-option) (at least one) | The choices a `select` input offers, one picked \u2014 written into a select holding the same option aliases |\n| `entity` | alias | The entity a `link` input picks one row of |\n| `accepts` | list of `"sheet"` \\| `"pdf"` \\| `"document"` \\| `"photo"` (at least one) | The kinds of file a `file` input takes; absent, a sheet, a PDF or a document \u2014 a phone offers its camera only where `photo` is among them |\n| `required` | `true` | The act is refused without it |\n| `default` | alias | A field of the row whose value the input starts from, still changed at will |\n\n#### Set formula\n\n| Key | Type | Meaning |\n|---|---|---|\n| `formula` | text, required | A formula over the acted row\'s fields, `{alias}` each, read as the entity\'s own formulas read them |\n\n#### Act template\n\n| Key | Type | Meaning |\n|---|---|---|\n| `template` | alias, required | A document template made into `into` |\n| `when` | map of alias \u2192 (list of alias (at least one) \\| boolean) | The paper starts ticked while each named select of the record holds one of these options and each named yes/no (stored, or a formula \u2014 how a multi-select is tested: `includes({needs}, {needs:x})`) is this value \u2014 a suggestion the reader changes, never a refusal; absent, it starts ticked |\n\n#### Recording\n\n| Key | Type | Meaning |\n|---|---|---|\n| `into` | alias, required | A child the record lists in a timeline or rows block, linking back by a single link: each recording is a new row |\n| `audio` | alias, required | The child\'s files field the recording\'s audio is kept in |\n| `transcript` | alias, required | The child\'s text field the transcript is kept in, a speaker\'s turn per line |\n| `video` | alias | The child\'s files field the screen is kept in, where the recording captured it |\n| `at` | alias | The child\'s date field stamped with the moment the recording started |\n| `by` | alias | The child\'s member field set to the person who recorded |\n\n#### Signature\n\n| Key | Type | Meaning |\n|---|---|---|\n| `into` | alias, required | The record\'s files field the signature is kept in, as a picture \u2014 each signing replaces the one before |\n| `by` | alias, required | Who signed: a text field the signer types into (someone with no seat), or a member field set to the person pressing |\n| `at` | alias, required | The record\'s date field stamped with the server\'s time as the act runs |\n| `witness` | alias | Beside a text `by`, the member field set to the person pressing, who saw the signer sign |\n\n<!-- generated:end node-act -->\n\nAn Act whose `when` does not hold is not offered. One whose `requires` are empty is offered disabled, naming each; one whose\n`recommends` are empty names what it will leave blank and still presses; one a standing Check blocks is offered disabled in\nits words. The `act_<key>` workflow re-checks all three on the server, writes `set` and what was asked,\nand appends the status history. A field an act both `requires` and `asks` never disables the press. A field an Act `requires` draws in its part with no statement. An Act in a child List may `sign` the row pressed.\n\n- **Writes:** every field it sets, asks, files into, signs or records is the act\'s.\n- **Papers.** A button that makes a paper is `template` (or `templates`) with `into` and no workflow, made from the row as the act left it. `templates` keeps a paper not made yet as a placeholder, and the set downloads as one archive (`archive_<key>`). `into` files the paper in the row\'s own files field, a write of the row its table\'s lock refuses; a `paper` line is a row of its own, made on a locked record. `intake`: what the papers state of each field `fills` names is shown beside what the row holds, and the save writes only what differs. `sign`: the record reads `into` as one signature, and the act\'s paper is handed the picture under `into`\'s name (`{{#each signature}}<img src="{{url}}">{{/each}}` in an html template).\n- **`review: true`:** the workflow (`workflows`) reads and returns a changeset of the act\'s table in `data.review`; the rows the reader ticks are written each checked first, all or none. Over every row in view the act is handed no rows.\n- **A `when` that compares** splits one stage by an amount or a date with no formula field behind it; the server refuses a press the row does not meet, and a blank number or date meets no bound:\n\n```json\n{ "type": "Act", "key": "approve", "label": "Approve", "when": { "status": ["submitted"], "amount": { "lte": 5000000 } }, "set": { "status": "approved" } }\n```\n\n```json\n{ "type": "Act", "key": "gate_in", "label": "Make the gate-in EIR", "template": "eir_in", "into": "eir", "sign": { "into": "driver_signature", "by": "driver_name", "at": "signed_at", "witness": "signed_before" } }\n```\n\n## Check node\n\nA Check is a yes/no or text formula of the row of the Record page it stands in (`pages/<entity>`): it stands while true or non-empty, and a text\nformula\'s words are what the reader sees. With `on` it refuses the saves and acts it names, on the server, in every write it names, and\nmay name any yes/no or text formula of its entity. With no `on` it names an issue the entity declares in `records.issues`, warns, and may\nstate the Act that `resolve`s it; a Check with neither is refused. A Check on a count never names `update` or `all`: the edits of its rows are what clear it.\n\n<!-- generated:start node-check -->\n\n| Key | Type | Meaning |\n|---|---|---|\n| `field` | alias, required | A yes/no or text formula of the page\'s entity \u2014 an issue it declares in `records.issues` where the Check states no `on` \u2014 or the count of rows a link lists that hold one |\n| `on` | `"all"` \\| list of (`"update"` \\| alias) (at least one) | What the standing issue refuses: `update` is the rows\' saves, an Act key is that Act \u2014 on one row, or over a List\'s rows of this entity \u2014 and `all` is every Act and save. A record\'s Acts are refused by a Check on the count its issues roll up from the rows it lists |\n| `resolve` | alias | An Act on one row of this entity that clears it. A Check states an `on` or a `resolve`: the declared issue stands without one |\n\n<!-- generated:end node-check -->\n\n`update` is the rows\' saves; an Act key is that Act, on the same rows; `all` is every act and save.\nA rule that refuses a Delete is a check of the table, not a Check: state it in the table\'s `checks` with `on: ["delete"]`\n(`reference/write-rules`), where it holds for every way a row is deleted and a removal that cascades to child rows is refused whole.\nA Check is stated once, on the entity it is true of. Absent `on`, the Check warns where its rows are listed; `on` names the acts it refuses. A record\'s Act is refused by the record\'s own Check on the count its rows\' issue rolls up (`records.issues` with `{ rows }`), never by `update` or `all`: it is judged on the stored count, with the record held while the Act runs. A List over rows of an entity with Checks offers one filter of the Checks some of its rows hold, but one that stops their edits or deletes, each with how many; picking one narrows the List to exactly those rows, through the address\'s filter on the check\'s field. `checks: false` offers none.\nA Check stands on each row of its page\'s entity wherever the App lists or opens it \u2014 a root List\'s, a child List\'s, a\nsource\'s \u2014 and refuses the acts and saves it names, an Act over a List\'s rows of the entity included. A warning reading the figure of a meter that `gates` marks against its\nbound or its pass mark is refused: the meter already draws it.\n\nThe check field\'s `label` is its short name \u2014 "Over budget", "Release expired": a row\'s line says it in the check\'s tone\n(the most severe of several, and how many more), while its words whole are the row\'s tooltip. Label it as the reader names\nthe problem, in a few words, and let a text formula say the sentence: the callout over the record says the label, then the sentence after it where it says more. A check with `resolve` carries the first of those Acts the row offers as a button at the end of its line, pressing as the Act itself; one with none links to the first field its formula reads that the record draws.\nA yes/no formula whose yes needs attention (papers the customer still owes) is a Check: its yes reads in the warning tone\nwherever it is drawn, every other yes in the success tone \u2014 and the row\'s line says it, so it is no column of the List too.\n\nA Check that every app over a table states the same way restates the table\'s contract and belongs in the table\'s `checks`\n(`reference/write-rules`).\n\nA Check refusing `update` (or `edit: false` on a record, part or field) makes the rows read-only in this app alone, drawn\nunder the read-only mark, never as a lock. A lock is the table\'s: a table workflow, a person, or an Act whose workflow sets `locked: true` on `update_records` locks a row, and every door refuses its writes until a table manager unlocks it \u2014 `update_records` with\n`locked: false` in an app\'s run is judged as the member who pressed. A locked row reads locked in every app: its lock mark, its fields as values\nunder one line naming who can change it, its saves, Delete and each Act writing it refused \u2014 an Act that writes\nelsewhere, makes a paper it hands back, or unlocks it stays its workflow\'s to answer.\n\n## Reading node\n\nA Reading is a number over rows: one figure, its parts, a grid, a figure per period, steps; or a record\'s own figure. The\npicture is the runtime\'s, chosen from what the reading means \u2014 no prop picks a chart. The question is stated by which\nsplit it names:\n\n| Names | Answers |\n|---|---|\n| nothing | one figure: the rows counted, or `value` summed, `{ "avg": \u2026 }` averaged |\n| `by` | the figure per value of a select, one-row link, member or yes/no, or per band of a number\'s `tiers` |\n| `by` a date field | the figure per period (a trend); `ahead: true` reads forward over the rows still to come |\n| `by` a date field and `across` | the figure per period, each period\'s bar stacked by the values of `across` (a select\'s options in their order, a number\'s bands lowest first) \u2014 counted or summed, never averaged |\n| `by` and `across` | a grid, `by` down the side and `across` along the top |\n| `steps` | a funnel: 2 to 8 number fields summed, each kept as a share of the one before; in a record only |\n| `planned` and `done` | the work against its plan, day by day: a List\'s band over a folder, or a record\'s block, never a Sheet |\n| no `entity`, in a Record | the record\'s own `value`, a tile under its field\'s label; up to eight consecutive tiles draw as one strip |\n\n<!-- generated:start node-reading -->\n\n| Key | Type | Meaning |\n|---|---|---|\n| `key` | alias | The reading\'s query name, unique in the app. Absent, the label\'s words as a slug, else its kind and field, written once and kept |\n| `label` | text | What the figure is called: absent, a split\'s `by` field\'s label, a trend\'s summed `value`\'s (else the rows\'), a grid\'s two fields\'; one figure states its label; with `planned`, always stated |\n| `entity` | alias | The List\'s rows; in a Record, the child\'s rows under it; absent in a Record with no `by`: the record\'s own `value`; with `planned`, the rows that are the parts of the work, always stated |\n| `via` | alias \\| text | The child\'s link to the record, where it has several; in a Record, a figure may state `<link>.<link>`, reaching the record through a row of their own |\n| `value` | alias \\| `{ "avg": alias }` | A number field summed over the rows, or `{ avg }` averaged over the rows holding one \u2014 a row with no number is no part of it, and a part or period where no row holds one reads blank, never 0. An average stands as a figure, per period (`by` a date) or per part (`by` a select, one-row link, member, yes/no or tiered number), never across a grid or beside `on_hand`; its parts add up to nothing: it states no total, and its rest reads the average of all the rows the rest holds. Absent, the rows are counted |\n| `where` | [narrowing](#app-tree) | Only the rows whose select holds one of these options, whose yes/no is this value, whose number or date meets its bounds (`gt`, `gte`, `lt`, `lte`; a date\'s `{ "now": true }` is read when the rows are), whose field is `{ "empty": true \\| false }`, or whose member field holds the reader (`{ "me": true }`) \u2014 every entry ANDed |\n| `by` | alias \\| [Tiered filter](#tiered-filter) | Splits the rows into parts; a date field splits them per period |\n| `across` | alias \\| [Tiered filter](#tiered-filter) | Reads a split against a second field: with `by` a field, the columns of a grid; with `by` a date, what each period is made of, its bar stacked by this field\'s values (counted or summed, never averaged) |\n| `over` | alias | The date that places a row in time |\n| `ahead` | `true` | Shows what is coming, not what has been: with a date `by`, the current period and those after it |\n| `steps` | list of alias (2\u20138) | Number fields summed, each a step of a funnel |\n| `on_hand` | [Reading on hand](#reading-on-hand) | With `by` (and `across`): the Reading\'s rows are what is owed, per value of those fields; drawn beside what is on hand per the same values, and the shortfall |\n| `target` | number | The number the figure is read against; absent, its bound, where the table states one |\n| `better` | `"up"` \\| `"down"` | Which way is good, for the figure\'s tone; absent, read from the figure\'s shape |\n| `planned` | [Reading planned](#reading-planned) | The days each row\'s work is planned over, its share planned spread evenly across them \u2014 a row missing either is no part of the plan, and neither line counts it |\n| `done` | alias | With `planned`, the work against its plan: a percent field of the row the server computes, its share done today (0\u2013100) |\n| `finished` | alias | A date of the row: the day its work was finished, from which it stands at its `done` |\n| `tab` | alias | The Tab it reads, else the open one |\n| `when` | [condition](#app-tree) | Drawn only while this holds |\n\n#### Reading on hand\n\n| Key | Type | Meaning |\n|---|---|---|\n| `entity` | alias, required | The entity whose rows are what is on hand, all of them |\n| `value` | alias | A number field summed over those rows; absent, the rows are counted |\n| `by` | alias | The field of this entity matching the Reading\'s `by`; absent, the same alias |\n| `across` | alias | The field of this entity matching the Reading\'s `across`; absent, the same alias |\n| `where` | [narrowing](#app-tree) | Only the rows whose select holds one of these options, whose yes/no is this value, whose number or date meets its bounds (`gt`, `gte`, `lt`, `lte`; a date\'s `{ "now": true }` is read when the rows are), whose field is `{ "empty": true \\| false }`, or whose member field holds the reader (`{ "me": true }`) \u2014 every entry ANDed |\n\n#### Reading planned\n\n| Key | Type | Meaning |\n|---|---|---|\n| `start` | alias, required | A date of the row: the first day of its planned work |\n| `end` | alias, required | A date of the row: the last day of its planned work |\n\n<!-- generated:end node-reading -->\n\n#### Kinds of reading\n\n<!-- generated:start reading-kinds -->\n\n| Kind | What it is |\n|---|---|\n| `metric` | A metric is one number over an entity\'s rows: how many, or the sum or average of a number field. It is read against a target, or against the bound its `limits` states; placed in time by `over`, it shows its change over the recent periods and which way is good (`better`). |\n| `breakdown` | A breakdown splits an entity\'s rows into parts: each row is counted, or its number summed or averaged, under the one value of the field it is split by \u2014 a select\'s option, a linked row, a person, yes or no \u2014 or under the band of a number cut by `tiers`. |\n| `trend` | A trend counts an entity\'s rows, or sums or averages a number of them, per period of the date that places each row in time (`over`) \u2014 the periods up to today, or with `ahead` the current one and those after it, over the rows dated today or later; with `split`, each period\'s count or sum stacked by the values of one field. |\n| `pivot` | A pivot crosses two splits in a grid: each row of the entity is counted, or its number summed, under the pair of values it holds \u2014 one down the side (`rows`), one across the top (`columns`). |\n| `shortfall` | A shortfall sets what is still owed against what is on hand: the owed rows are counted, or a number of them summed, per value of the fields they are for (`by`, and `across`), beside every row of the stock (`on_hand`) matching those fields, with what falls short. |\n| `progress` | A progress reads the work against its plan: each row is a part of the work, planned over the days between two of its dates and done by a share the server computes, set against the plan day by day. Each row weighs its planned days. |\n| `list` | A list shows an entity\'s rows, each in its `records` anatomy \u2014 its title, its line, its status \u2014 with the fields read after the title (`columns`). |\n\n<!-- generated:end reading-kinds -->\n\nWhere a Reading stands decides which rows: a Sheet\'s every row, a List\'s rows in its open tab and folder (the search,\nthe status and the filters narrow the rows and leave the figures as they stand), a Record\'s the child\'s rows under the record. A Reading counts its rows, or sums the number\n`value` names \u2014 never a percent. `over` is a date, the row\'s own or its parent\'s through a lookup: a trend\'s periods, a\nfigure\'s recent periods, and what a Sheet\'s period windows. `where` keeps rows whose select holds one of the options, or\nwhose yes/no is the value, every entry ANDed \u2014 a band leads with the job\'s exception as a formula\'s yes/no (what is\nshort), never a stage the chips already count nor the overdue rows the register\'s summary line counts from `records.due`.\n\n- **A figure\'s change** is green where it moves the good way: a sum\'s rise, a count kept by `where` falling; `better` states\n the other way where that reads wrong (money going out). A value `limits` bounds reads against the sum of its bound\n (`10 / 14`); `target` reads one against a number nothing bounds.\n- **An average** is its sum over the rows that hold a value, divided by how many hold one; a row holding none is no part\n of it, and where none holds one the figure reads a dash, never 0. Under a Sheet\'s period it is the average over the\n period so far, never a sum of averages. A share is an average too: a number formula that is `100` on the rows that count\n and `0` on the others, in percent notation, averaged. Only a single figure averages.\n- **Bands.** `by` and `across` each take, in place of a field, a number by its `tiers` \u2014 `{ "field", "tiers" }` \u2014\n splitting the rows by the bands those breakpoints cut: `[1, 31, 61]` over days late reads not due, 1\u201330, 31\u201360 and over\n 60, the aged report. Every band is drawn in the bands\' own order, one holding no row at zero; rows holding no number\n stand apart. On a List a band is a door: a press narrows the rows to it. In a List\'s band, a split by one or two\n breakpoints stands in it, and one by three or more stands whole under it.\n- **In a List,** Readings stand under the title in one compact band: the job\'s headline number first, then at most the mix\n and the movement. A picture stands only where it splits the rows in view into two parts or more, one holding two rows or\n more. The summary line already totals the figure and the chips count the rows, so a figure summing the figure, or counting\n the rows of a table with a stage, is refused unless its `where` narrows it.\n- **Name.** A Reading\'s `key` is the query it is read by (`run_app_query`).\n- **The work against its plan** (`planned` and `done`, `label` and `entity` stated) takes none of a figure\'s props: the\n share of the work planned and the share done, cumulative day by day, today\'s two at its foot. Each row is a part of the\n work, its plan spread evenly over its planned days and weighing its planned days. Its share done today is `done`, a\n percent the server computes; on an earlier day, its `done` from its `finished` day on and nothing before it.\n\n## Statement node\n\nA Statement draws a figure the record works out from its own figures \u2014 a claim\'s payable, an invoice\'s total, a payslip\'s\nnet \u2014 line by line in the order the arithmetic runs: each line a number of the record, the first stating no `op`, the last\nan `equals`. Every figure is a field the server computes or a person writes; the screen adds nothing up. A line\'s `parts`\nlists the rows its figure carries, each read from its own row, and that figure is what they add up to \u2014 a formula, rollup\nor lookup, or the server\'s copy when the record is made (`default_from`), which nothing writes after.\n\n<!-- generated:start node-statement -->\n\n| Key | Type | Meaning |\n|---|---|---|\n| `key` | alias | The statement\'s name, unique among its siblings. Absent, the label\'s words as a slug, written once and kept |\n| `label` | text | What the statement is called: absent, the label of what it comes to |\n| `lines` | list of [Statement line](#statement-line) (at least 3), required | The figures it is built from, top to bottom, ending in the one it comes to |\n| `when` | [condition](#app-tree) | Drawn only while this holds |\n\n#### Statement line\n\n| Key | Type | Meaning |\n|---|---|---|\n| `field` | alias, required | A number of the record \u2014 stored, a formula, a rollup or a lookup \u2014 read on the line after its label |\n| `op` | `"plus"` \\| `"minus"` \\| `"times"` \\| `"equals"` | How the line works on the lines above it \u2014 `plus`, `minus`, `times`, or `equals` for what they come to, a formula, rollup or lookup the server computes; absent on the first line, which the rest work from |\n| `rate` | alias | A percent of the record read after the line\'s label: the rate its figure is taken at (retention at 5 %) |\n| `parts` | [Statement parts](#statement-parts) | The rows the line\'s figure carries, each listed under it with its words and its own figure \u2014 read from those rows, never a copy of them. The line\'s figure is what they add up to, drawn read: a formula, rollup or lookup, or a value the server copies when the record is made (`default_from`) that nothing writes after |\n\n#### Statement parts\n\n| Key | Type | Meaning |\n|---|---|---|\n| `rows` | alias, required | The entity whose rows the line\'s figure carries \u2014 the record\'s own for the earlier rows of the same thing |\n| `same` | alias, required | A one-link the record and those rows both hold: the rows naming what the record names in it |\n| `at` | alias | A moment (a datetime) of those rows no person keys \u2014 when each was certified: with `before`, only the rows whose moment stands before the record\'s, earliest first; absent with it, every row so named, in their own order |\n| `before` | alias | A moment (a datetime) of the record no person keys \u2014 when it was made: the moment the rows\' `at` stands before; stated with `at` |\n| `where` | map of alias \u2192 (list of alias (at least one) \\| boolean \\| `{ "empty": true \\| false }` \\| [comparison](#values)) | Only the rows whose single select holds one of these options, whose yes/no (stored, or a formula) is this value, whose number or date meets its bounds, or whose field is empty or filled \u2014 read so on the server |\n| `columns` | list of alias (1\u20132), required | The rows\' fields read as each one\'s words, in order (its date, its percent) |\n| `figure` | alias, required | The rows\' number each one reads at the figures\' edge, frozen when the row was certified: a stored number an act fills (`{ "formula": \u2026 }` as it runs) or the server copies when the row is made (`default_from`) \u2014 never one a person keys, nor a formula, rollup or lookup the server recomputes |\n\n<!-- generated:end node-statement -->\n\n```json\n{\n "type": "Statement",\n "key": "claim",\n "lines": [\n { "field": "contract_value" },\n { "field": "done_to_date", "op": "times" },\n { "field": "value_to_date", "op": "equals" },\n { "field": "certified_before", "op": "minus", "parts": { "rows": "claim", "same": "contract", "at": "certified_at", "before": "made_at", "where": { "kind": ["work"] }, "columns": ["claimed_on", "done_to_date"], "figure": "certified_value" } },\n { "field": "claim_value", "op": "equals" },\n { "field": "retention", "op": "minus", "rate": "retention_rate" },\n { "field": "payable", "op": "equals" }\n ],\n "when": { "kind": ["work"] }\n}\n```\n\n## Export node\n\nAn Export is a report file of the rows in view: the title, a line per chip, the search and the moment it was exported, the\nReadings, and every row, at most 20,000. With no props, the one Export is the workbook of the List\'s columns, the Readings\non a sheet before the rows. A List states the reports the business sends \u2014 one a button, several one menu \u2014 each a `label`,\na `description`, and a `template` filled with `title`, `lines`, `readings`, `at` (the moment it was made), `dates` (each\ndate filter\'s `from` and `to` by field) and the rows under the table\'s alias (an html one made a PDF, an excel one a\nworkbook). A report\'s `filename` names its file in the template grammar over the same keys but the rows. Where `per` is a\none-row link, `per_row.<field>` reads a text, number, date or yes/no field of the picked row, and `| add_days:<n>` shifts a\ndate by whole days (`n` a number or such a field, empty for none): `Stock {{per}} {{period.to | add_days:per_row.day_offset | format:"dd.MM.yyyy"}}`. A report of some\nrows (`where`), or of one value the reader picks (`per`: one file per value), is made of the List as those chips would\nnarrow it; the screen keeps the chips and rows it shows. A report sent outside the business \u2014 a partner\'s stock, a\nfiling \u2014 is `fixed`: the same file from every screen and device, of what the reader narrowed only the period and the\ndate chips reaching it, never their status, other chips or search.\n\nProve an Export with `run_app_query` and `export` (`agent_surface/exporting-a-file`): the answer is the file it makes.\n\n<!-- generated:start node-export -->\n\n| Key | Type | Meaning |\n|---|---|---|\n| `key` | alias | The report\'s name, unique in the app. Absent, the label\'s words as a slug, written once and kept |\n| `label` | text | The report\'s name; absent on the one Export that stands for the register\'s workbook |\n| `description` | text | What the report is for, in a sentence |\n| `template` | alias | An html or excel document template the report fills, with `title`, `lines`, `readings`, `at`, `dates`, `period`, `per` and `per_row` (a one-row `per`\'s picked row, the fields `filename` reads); absent, the workbook of the List\'s columns |\n| `filename` | text | The file\'s name, at most 500 characters, in the template grammar, over one value each: `title`, `at`, `dates.<field>.from` or `.to`, `period.from` or `.to`, `per`, `per_row.<field>` (a text, number, date or yes/no field of the row a one-row `per` picks), `lines \\| lookup:<n>`; `\\| add_days:<n>` shifts a date by whole days, `n` a number or `per_row.<field>`. Absent, the report\'s label |\n| `where` | [narrowing](#app-tree) | Only the rows whose select holds one of these options, whose yes/no is this value, or whose member field holds the reader (`{ "me": true }`) \u2014 every entry ANDed |\n| `per` | alias | A select, member or one-row link the reader picks one value of: one file of that value |\n| `sources` | list of alias (at least one) | Of the List\'s entity and its sources, the tables the report reads; absent, all |\n| `fixed` | `true` | The same file from every screen: only its `where`, its `per`, the period and the date chips narrow it, never the reader\'s status, other chips or search; absent, the rows in view |\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `list.export-report` | A List\'s Exports each have their own `label`; `per` picks one option, person or one-link row \u2014 never of the status, the folder or a field its `where` fixes. |\n| `list.export-key` | An Export is named by its key alone: no two Exports of an app share one. |\n| `list.export-filename` | An Export\'s `filename` is words and `{{value}}` placeholders, each value one of `title`, `at`, `dates.<field>.from` or `.to` (a date filter of the List), `period.from` or `.to` (a List with Tabs), `per`, `per_row.<field>` (a field of the row a one-link `per` picks) and `lines \\| lookup:<n>`, through helpers that exist and take the arguments given. |\n| `list.export-template` | A template an Export fills is an html or an Excel one (a Word register stays a workflow body) and reads at its root only `title`, `lines`, `readings`, `at`, `dates`, `period`, `per`, `per_row` (and `columns`, on a roster) and its rows under the List\'s entity alias \u2014 an entity named none of those \u2014 and is the document of no Act. |\n\n<!-- generated:end node-export -->\n\n## Query node\n\nA Query is a read for agents, never drawn. An app generates a query for everything its screen reads (`agent_surface` lists them); a Query declares one the screen never asks, called through `run_app_query` or the app\'s API: the\ntable whose rows it reads, the fields each row returns, and what narrows them.\n\n<!-- generated:start node-query -->\n\n| Key | Type | Meaning |\n|---|---|---|\n| `description` | text, required | What the query answers, read by whoever calls it by its alias \u2014 at most 300 characters |\n| `params` | map of alias \u2192 ([Workflow value](#workflow-value) \\| a typed input (`app_bindings`)) | What a call states, by name: with `rows` or `list`, values a `where` entry reads; with `ast`, typed inputs the ast reads as `{{params.<name>}} |\n| `fields` | list of alias (at least one) | The fields each row returns, by alias: with `rows` or `list`. `ast` states its own |\n| `sort` | [Sort key](#sort-key) \\| list of [Sort key](#sort-key) (at least one) | The order the rows return in; absent, the order the entity\'s list reads in |\n| `limit` | integer | The most rows returned |\n| `key` | alias, required | The query\'s name, what `run_app_query` calls; unique in the app |\n| `rows` | alias | The table whose rows it reads, under the app\'s row rule of it and, where the table holds one one-row link to the App\'s `scope`, inside the folder the call states. A Query states `rows`, `list` or `ast`, one of the three |\n| `list` | alias | The key of a root List of the App: the rows read as that List reads them \u2014 its `where`, its folder and its order. A Query states `rows`, `list` or `ast`, one of the three |\n| `ast` | a query tree (`app_bindings`) | The whole read, where `rows` or `list` cannot state it: a join, a union, a group, a window or a computed column. Fields and tables by alias |\n| `templates` | map of text \u2192 a document template (`app_bindings`) | Document templates an export of this query\'s rows may fill, by the name the export asks for. An export names one of these or none; a template it does not declare is refused. |\n| `where` | map of alias \u2192 [condition](#query-node) | What narrows the rows, as a List\'s `where` does: a select\'s options, a yes/no\'s value, a number or date meeting its bounds (`gt`, `gte`, `lt`, `lte`), a field `{ "empty": true \\| false }`, `{ "me": true }` on a member field \u2014 or a value the call states (`{ "param": name }`), or a date or number range of params (`{ "from": \u2026, "to": \u2026 }`) |\n\n#### Query param\n\n| Key | Type | Meaning |\n|---|---|---|\n| `param` | text, required | A param of this query: the condition holds what the call states for it, and is left out where the call states none |\n\n#### Query range\n\n| Key | Type | Meaning |\n|---|---|---|\n| `from` | [Query param](#query-param) | The param the field is on or after \u2014 a date\'s first day, a number\'s least |\n| `to` | [Query param](#query-param) | The param the field is on or before \u2014 a date\'s last day, a number\'s most |\n\n<!-- generated:end node-query -->\n\n```json\n{\n "type": "Query",\n "key": "fees_unbilled",\n "description": "A customer\'s fees no invoice covers yet, oldest first.",\n "params": {\n "customer": { "type": "record_link", "entity": "customer", "description": "The customer whose fees are read." },\n "since": { "type": "date", "required": false, "description": "Only fees charged on or after this day." }\n },\n "rows": "fee",\n "fields": ["visit", "service", "amount", "charged_on"],\n "where": { "billed": false, "customer": { "param": "customer" }, "charged_on": { "from": { "param": "since" } } },\n "sort": { "field": "charged_on" },\n "limit": 200\n}\n```\n\nAn entry of `where` holds what a Reading\'s `where` holds, or a value the call states: `{ "param": "<name>" }`. A required\nparam is always stated; one stating `required: false` may be left out, and the condition reading it then narrows nothing.\nA query reads under its table\'s read scope, as every read of the app does. A caller counts, sums or averages its rows\nwith `run_app_query`\'s `aggregate`. `set_app` compiles a Query with the rest of the app: no code is set.\n\nEvery Reading of the app is a query too, returning its groups, called by its key. A Tab\'s `totals` read is called by\n`<table>_totals_<tab>` with the period\'s two days, `from` and `to`, both required.\n\nA query reads one table: on an app whose List reads `sources`, it names a source\'s own table, never the\nList\'s. A param compares a field holding one value \u2014 or, as a range, a date or a number \u2014 and never a number read in each\nrow\'s own unit or currency, nor a date holding a span.\n\n## Workflow node\n\nA Workflow is a verb for agents, never drawn: a job no press of the screen starts \u2014 an agent or a service handing the app a\nfile, or a list of rows to reconcile a table against. It states what it takes and what it hands back; a table is named by\nits alias in `tables` and a select by `<table>.<field>`. It is called through the app, by `run_app_workflow` or the app\'s\nAPI. On an app shared by a public link it runs only for someone who holds the app, and a visitor\'s call is refused as an\nalias the app does not have.\n\n<!-- generated:start node-workflow -->\n\n| Key | Type | Meaning |\n|---|---|---|\n| `description` | text, required | What the workflow does, read by whoever calls it by its alias \u2014 at most 300 characters |\n| `inputs` | map of text \u2192 [Workflow value](#workflow-value) | What a call hands it, by name \u2014 checked before its body runs |\n| `outputs` | map of text \u2192 [Workflow value](#workflow-value) | What its body returns as `data`, by name \u2014 checked as it returns; absent, read off the body |\n| `key` | alias, required | The workflow\'s name, what `run_app_workflow` calls; unique in the app |\n\n#### Workflow value\n\n| Key | Type | Meaning |\n|---|---|---|\n| `type` | `"text"` \\| `"number"` \\| `"boolean"` \\| `"date"` \\| `"datetime"` \\| `"email"` \\| `"json"` \\| `"record_link"` \\| `"select"` \\| `"member"` \\| `"file"` \\| `"object"` \\| `"array"`, required | What the value is |\n| `description` | text | What the value is for, read by whoever calls the workflow |\n| `required` | boolean | Lets a caller leave the value out: false; absent or true, it is always there |\n| `multi` | `true` | A `record_link`, `select`, `member` or `file` holding several |\n| `entity` | alias | The entity a `record_link` names a row of |\n| `field` | text | `<entity>.<field>`: the select field whose options a `select` takes, as the field holds them when the workflow runs |\n| `options` | list of (alias \\| [Select option](#select-option)) (at least one) | The values a `select` takes, where no field holds them: aliases, or the objects a field\'s `options` take |\n| `fields` | map of text \u2192 [Workflow value](#workflow-value) | An `object`\'s values, by name |\n| `items` | [Workflow value](#workflow-value) | What each item of an `array` is |\n\n<!-- generated:end node-workflow -->\n\n```json\n{\n "type": "Workflow",\n "key": "reconcile_fees",\n "description": "Reconciles a visit\'s fees against the lines of the carrier\'s statement.",\n "inputs": {\n "visit": { "type": "record_link", "entity": "visit" },\n "statement": { "type": "file", "required": false },\n "lines": { "type": "array", "items": { "type": "object", "fields": { "service": { "type": "select", "field": "fee.service" }, "amount": { "type": "number" } } } }\n },\n "outputs": { "added": { "type": "number" }, "changed": { "type": "number" } }\n}\n```\n\nIts code is set on the app, never stated in the tree: `set_workflow` with a `source` whose `on({ type: "app", app_id, alias })` header names the app and the key, leaving\n`inputs` and `outputs` out \u2014 the code is checked against what the node declares. Every `set_app` keeps that code and holds\nwhat it takes, what it hands back and its description to the node. `set_app` keeps the code where it still meets a change\nof what the workflow takes or hands back; a change it does not meet is refused unless the same `set_app` carries the new\ncode in `workflows`, each as `set_workflow` takes it. With no code yet it refuses every call, and each `set_app` says so. A\nWorkflow the tree stops declaring is archived with its key.\n\n## Tasks\n\nA table whose `records` states `"task": true` \u2014 its status a stored select with `closed` \u2014 is work someone finishes.\nEvery List of its rows draws it alike, each row led by a ring. Ticking the ring moves the row to a closed option by the\none write the app already has for that move: the Act of that table setting a closed option, offered on an open row and\nasking nothing, else its own save where people write the status \u2014 stamping what that act stamps and appending the\nstatus history. Unticking runs the Act moving a closed row back, else the save back to the status\'s default. A move no\nwrite reaches leaves the ring disabled and the check notes it. An Act with `on: "ticked"` completes several at once.\n\nA record listing task rows filed under it by a link holding one row says how much of that work is done \u2014 those at a\nclosed option of all \u2014 wherever its row is drawn: a meter on its head, a column of its register\'s rows, a card\'s foot, a\ncalendar entry, a gantt\'s or a lane\'s bar. No rollup is stated for it.\n\n```json\n{\n "tables": [\n {\n "ref": "project",\n "label": "Projects",\n "singular": "Project",\n "fields": {\n "name": { "label": "Name", "required": true, "type": "text" },\n "lead": { "label": "Lead", "type": "member" }\n },\n "title": "name",\n "records": {}\n },\n {\n "ref": "task",\n "label": "Tasks",\n "singular": "Task",\n "fields": {\n "title": { "label": "Title", "required": true, "type": "text" },\n "project": { "label": "Project", "required": true, "type": "link", "table": "project", "multi": false },\n "assignee": { "label": "Assignee", "type": "member" },\n "status": {\n "label": "Status",\n "required": true,\n "default": ["todo"],\n "type": "select",\n "options": [\n { "alias": "todo", "label": "To do", "color": "slate" },\n { "alias": "done", "label": "Done", "color": "green" }\n ]\n },\n "due": { "label": "Due", "type": "date", "format": "date" },\n "done_on": { "label": "Done on", "type": "date", "format": "date" }\n },\n "title": "title",\n "records": {\n "subtitle": ["assignee"],\n "due": ["due"],\n "task": true,\n "starts": { "assignee": "me" },\n "status": { "field": "status", "closed": ["done"] }\n }\n }\n ]\n}\n```\n\n```json\n{\n "body": {\n "type": "App",\n "key": "projects",\n "name": "Projects",\n "color": "blue",\n "tables": { "project": "<id of the project table>", "task": "<id of the task table>" },\n "templates": {},\n "children": [\n {\n "type": "List",\n "entity": "project"\n }\n ],\n "pages": [\n {\n "type": "Record",\n "entity": "project",\n "children": [\n {\n "type": "Section",\n "key": "work",\n "title": "Work",\n "children": [\n "lead",\n {\n "type": "List",\n "entity": "task",\n "columns": ["due"],\n "children": [\n { "type": "Act", "key": "complete_all", "label": "Complete", "on": "ticked", "when": { "status": ["todo"] }, "set": { "status": "done", "done_on": { "now": true } } }\n ]\n }\n ]\n }\n ]\n },\n {\n "type": "Record",\n "entity": "task",\n "children": [\n { "type": "Act", "key": "complete", "label": "Complete", "when": { "status": ["todo"] }, "set": { "status": "done", "done_on": { "now": true } } },\n { "type": "Act", "key": "reopen", "label": "Reopen", "when": { "status": ["done"] }, "set": { "status": "todo", "done_on": null } }\n ]\n }\n ]\n }\n}\n```\n\nThe tasks as a register of their own, for one person: a one-part Record holds its Fields and Acts directly.\n\n```json\n{\n "body": {\n "type": "App",\n "key": "my_tasks",\n "name": "My tasks",\n "color": "teal",\n "tables": { "project": "<id of the project table>", "task": "<id of the task table>" },\n "templates": {},\n "children": [\n {\n "type": "List",\n "entity": "task",\n "opens": { "assignee": { "me": true } },\n "children": [\n { "type": "Reading", "label": "Open", "where": { "status": ["todo"] } }\n ]\n }\n ],\n "pages": [\n {\n "type": "Record",\n "entity": "task",\n "door": "drawer",\n "children": [\n "project",\n "due",\n { "type": "Act", "key": "finish", "label": "Finish", "when": { "status": ["todo"] }, "set": { "status": "done", "done_on": { "now": true } } },\n { "type": "Act", "key": "undo", "label": "Undo", "when": { "status": ["done"] }, "set": { "status": "todo", "done_on": null } }\n ]\n }\n ]\n }\n}\n```\n\n## App rules\n\nEvery rule the check enforces over an app, one sentence each under an id; a finding names its rule\'s id\n(`[list.filter]`), and `reference/<rule id>` is that one rule\'s page. A sentence names the node and the prop an author writes (`List.create`, a `Section`);\neach area stands in the tree where this table says:\n\n| Area | Stands at |\n|---|---|\n| `app` | what every write meets (the tree\'s keys, the names it declares, the tables and rows it carries), the App, and the register List\'s props that belong to the app: `words` (labels), `color`, `scope`, sources, the root Views |\n| `template` | the document templates an Act makes and an Export fills |\n| `list` | a List: its columns, filters, search, group, sort, layout, tabs, period, export, and what a child List holds |\n| `reading` | a Reading |\n| `record` | a Record and its parts: Section, Side, Act placement |\n| `statement` | a Statement |\n| `act` | an Act |\n| `check` | a Check |\n\n<!-- generated:start rules-app -->\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `app.schema` | Every key is one its table lists, holding the type its row gives, and every required key is stated. |\n| `app.names-declared` | Every alias a key names is declared: a table of the App\'s `tables`, a field of the table the node reads, an option of the select it names, an Act `key` of the App, a template of its `templates`, or an app. |\n| `app.record-home` | A Record stands in the App\'s `pages`, never inside a List: one page per entity, opened from the Lists over it. |\n| `app.spec-claims` | Every workflow a tree\'s screens run is one the app binds, taking each input the screens send. |\n| `app.spec-sound` | The app a tree compiles to reads every column its screens draw and carries what each needs: a tree refused for it meets a fault of the platform\'s, which is reported, and no change to the tree is owed. |\n| `app.compile-lowers` | Every screen, read and write a tree states lowers to the app\'s spec: a tree the compiler cannot lower is refused at the App. |\n| `app.tables` | A call declares at least one table and at most 50; send the rest in a second call. |\n| `app.rows-cap` | Rows are a sample: at most 200 per entity, 2000 per call and 2000 documents attached \u2014 a real data set goes in with `create_records` once the tables exist. |\n| `app.alias-scope` | An alias is unique where it is named: tables and fields in their table, options in their select. |\n| `app.label-unique` | A label is unique where it is found by its label: fields in their table, options in their select. |\n| `app.filter` | A filter \u2014 a view\'s, a rollup\'s \u2014 tests fields of the entity it reads, through links as `entity.field` hops each standing on the entity the last lands on, by options its select declares. |\n| `app.input-once` | The fields the App\'s saves, adds and Acts of a table send are each sent under one input name: a files or many-link field is sent as `<alias>_added` (and `<alias>_removed` by a save or an Act), so no other field of the write is so named, and none takes an input the workflow names itself, such as `record_id`, the input naming the row. |\n| `app.alias-unique` | An App\'s `key` is unique among apps, and an Act\'s among the Acts of its App, every List\'s included. |\n| `app.icon` | An App\'s `icon` is a Lucide icon name in kebab-case, as `receipt` or `trending-up` are. |\n| `app.add-label` | A List\'s `add_label` stands only where it adds rows (`create`), in words that are not empty and hold no `{` or `}`. |\n| `app.labels` | An App\'s `words` name a table it reads and a field or option of it, in words that are not empty and hold no `{` or `}`; no two fields of a table, nor two options of a field, show the same words. |\n| `app.records-entry` | Every table an App draws a List over, opens or picks from \u2014 a root List\'s, a child List\'s, a linked row\'s, a documents List\'s \u2014 has a `records` entry. |\n| `app.scope` | The App\'s `scope` names the table whose one row the app works inside (the folder), a table whose row rule can bind; every List over a table linking to it is filed in the open folder (`list.scope`). Stated again on such a List as a `columns`, `filters` or `search` entry, `group`, `where`, `opens`, a Field of a part, a `create` question or a report\'s `where` or `per`, its folder link is left out and said: the App already narrows every read to it and files every add under it. |\n| `app.folders` | The App\'s `folders` names a root List over the table its `scope` names: that List draws the folders the app opens on, and a row pressed is the folder entered. |\n| `app.when` | A node\'s `when` holds single selects to options, yes/nos to `true` or `false` (stored, a formula of one \u2014 a formula with `options` is a select \u2014 or, offering a node, a lookup through a link to one row), numbers and dates to bounds (`gt`, `gte`, `lt`, `lte`; a date\'s bound is a day, a moment on a datetime, or `{ "now": true }`) and any field but a yes/no to `{ "empty": true \\| false }` \u2014 a number read in each row\'s own unit or currency takes only the bound 0, and a lookup takes none. |\n| `app.asked-written` | What a List\'s `create` asks, what an Act\'s `asks` asks and what `starts` fills is a field a person writes \u2014 never a formula, rollup, lookup, autonumber or a date the workspace stamps. |\n| `app.own-rows` | A many-link to rows that each belong to one row of this entity is never a `create` question or an Act\'s `asks`: those rows are the record\'s own, each written by its own write. |\n| `app.create-asks` | A List\'s `create` asks fields a person writes \u2014 never the link or the folder it files the row under, which the add sets itself. |\n| `app.create-required` | A List\'s `create` asks every field its entity requires that nothing else fills \u2014 a `default`, `starts`, the record or folder it files the row under, or a `default_from` over a link it fills \u2014 or the server refuses every add. |\n| `app.row` | A Record\'s `row` states only what differs from `records`: a `subtitle` that is not the title, a number for its `figure`, dates for its `due`, an `image` that is a files picture no Act makes documents into, or `false` for a figure, deadlines or picture the entity states and the App draws none of. `row` changes what the head draws, never what the App writes (`record.edit-declared`). |\n| `app.restates` | *Noted, never refused:* A key the tree states that the platform sets the same without it \u2014 a `label` the table\'s or field\'s own, a `row.subtitle` the table\'s, a `door`, an add or a layout end the default gives, a row rule a status history inherits \u2014 changes nothing: the write keeps it and says so. |\n| `app.tasks` | *Noted, never refused:* A task entity an App lists whose rows no write of the App moves to a closed option (its ring stands disabled), or that an Act ticks done and none moves back. |\n| `app.same-list` | *Noted, never refused:* A root List over a table another App of the workspace lists at its root. Unnarrowed, every reader sees the same list, and a row\'s rail shows only that app\'s parts, so no one sees the whole path. A different job narrows with `where` and `columns`; a shared job stays one app, `owner` on its Acts and stages deciding who presses. |\n| `app.views-jobs` | *Noted, never refused:* An App of more than two Views, or a Sheet of more than six Readings, asks whether each is a job someone does on its own: Views of one job read better as one List\'s filters, tabs or Readings, and a Sheet reads at a glance with few. |\n| `app.workflow-value` | A value a Workflow takes or hands back states what its type needs and nothing another type does: a `"record_link"` its `entity`, a `"select"` its `options` or the `field` holding them \u2014 never both \u2014 an `"object"` its `fields`, an `"array"` its `items`; `multi` stands on a `"record_link"`, `"select"`, `"member"` or `"file"`; an output is never a `"member"` or a `"file"`; and a value nests at most 8 deep. |\n| `app.query` | A Query reads `rows` of one table \u2014 under the App\'s row rule of it and inside the open folder where the table holds one one-row link to the App\'s `scope` (one holding several is read through `list`) \u2014 or a root List\'s rows as that List reads them (`list`: its `where`, folder and order; never a List reading `sources`), one of the two; it returns them as `fields`, ordered by `sort` and bounded by `limit`; each param is a number, a yes/no, a date, a select, a one-row link or a member holding one, read by an entry of `where` on a field of its type \u2014 a date by a range, a number by either, and never a number read in each row\'s own unit or currency or a date holding a span. |\n| `app.generated-name` | A name the App makes is taken by nothing the App states: no Query, Workflow, Reading or List `key` is the name of a read or a workflow the App makes, an Act\'s own `workflow` among them; where the App makes two reads spelled alike, the later takes the next free ordinal (`_2`, `_3`). |\n| `app.surface-described` | *Noted, never refused:* A value a Workflow takes, and a param a Query takes, that states no `description`: the one line a caller reads to fill it. |\n| `app.keys-unique` | No two children of one node share a key: an address names one node. |\n| `app.states-list` | An App states a List whose rows it lists, only Sheets of Readings, or only Queries and Workflows for a server to call. |\n| `app.period` | An App\'s `period` is the window every Sheet opens on, so it stands in an App that holds a Sheet: a List states its own `period`. |\n| `app.dashboard-words` | An App that holds Sheets and no List reads every table\'s rows whole and states no `words` or `scope`: those are an App with a List\'s. |\n| `app.entity-once` | The App\'s Lists and their sources work a table one way: its rows ticked as tasks by the same moves, and their work counted by the same kinds of task rows. |\n| `app.add-filed` | The Lists adding rows of one table file them by one link: where two Lists add them by different links, each is refused naming the other\'s \u2014 state `create: false` on every List but the one whose link files them. Wrong: a List adding `booking` rows filed by `freelancer` beside one filed by `production`. Right: one states `create: false`. |\n| `app.adds-field` | A picker\'s `add` names fields of its table a person writes, each once. |\n| `app.edits` | *Noted by the designer on a write, never refused:* The fields an app\'s saves may change are the fields its surfaces write \u2014 a record\'s save, a child row\'s, an in-place column, a lane, gantt or plan move \u2014 less what its own Acts change; the designer notes an app whose saves change none. |\n\n<!-- generated:end rules-app -->\n\n## Reading rules\n\n<!-- generated:start rules-reading -->\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `reading.value` | A Reading sums a number, never a percent \u2014 percents do not add up; a value of `{ avg }` reads one. |\n| `reading.average` | `{ avg }` averages a Reading\'s `value` over the rows holding one, read against a plain `target` \u2014 never a value `limits` bounds, whose bound is a sum. |\n| `reading.split` | `by` and `across` split by one value each row holds \u2014 a single select, a one-row link, one member or a yes/no, stored or a formula, a lookup through one-row links as the field it reads \u2014 or by the bands `tiers` cut a number read in one unit on every row; a date `by` splits them per period, as a trend, each period stacked by `across` where it states one; a grid crosses two different fields. Never by the select that sets the unit or currency of the number summed: its figure already reads once per unit. |\n| `reading.over` | `over` is a date: the row\'s own, stored or a formula, or its parent\'s through a lookup over a one-row link. |\n| `reading.where` | A reading\'s and a Query\'s `where` keep rows by a select\'s options, a yes/no\'s `true` or `false`, a number or date\'s bounds (`gt`, `gte`, `lt`, `lte`; a date\'s `{ "now": true }`), `{ "empty": true \\| false }`, or a member field, a lookup of one, or a member of the row a one-row link names (`<link>.<member>`), holding the reader (`{ "me": true }`); a List\'s `where` also keeps rows by `<link>.<field>`, a select or yes/no of the row a one-row link names; a Query\'s `where` also holds a field to what the call states (`param`, `from`, `to`). |\n| `reading.target` | `target` reads a value nothing bounds \u2014 a value `limits` bounds reads against the sum of its bound. |\n| `reading.better` | `better` needs `over`: a change is read over the periods its date places the rows in. |\n| `reading.progress` | A Reading stating `planned` and `done` (the work against its plan) reads dates of its rows for `planned` and `finished`, and a number for `done`. |\n| `reading.progress-alone` | A Reading stating `planned` or `done` is the work against its plan: it names its `entity` and states `planned` and `done`, with `finished`, `where`, `via`, `tab`, `when` and `label` beside them, and none of a figure\'s props (`value`, `by`, `across`, `over`, `ahead`, `steps`, `on_hand`, `target`, `better`). It stands in a List\'s band or a record, never on a Sheet. |\n| `reading.key` | A Reading\'s `key` is its query\'s name, and a List that only reads is called by its `key`, else its entity\'s alias: each its own among the App\'s Readings, Lists that only read and Queries. |\n| `reading.tabs` | A Sheet holds Readings and Lists, one at least; a Reading stands in a Sheet or in a List\'s band. |\n| `reading.restate` | *Noted, never refused:* A Sheet\'s count tile counting the rows a List beside it lists under the same `where` and tab, and a List\'s band counting its rows past a deadline, say what the List already draws: its head counts the first, its overdue chip the second. |\n| `reading.period` | An App\'s `period` is the one its Sheets open on \u2014 "month", "quarter", "year" or { "days": 30 } \u2014 and it stands only over a Reading placed in time by `over`. |\n| `reading.funnel-place` | A Reading with `steps` (a funnel) stands in a part of a Record: a band and a Sheet draw none. |\n| `reading.on-hand-split` | A Reading with `on_hand` compares what is owed with what is on hand per value of one field, or two: its `by` and `across` name fields, never bands. |\n| `reading.average-kind` | An average (`value: { avg }`) is a figure\'s, a trend\'s (`by` a date) or a breakdown\'s (`by` a select, one-row link, member, yes/no or tiered number): its Reading states no `on_hand` or `across`. |\n| `reading.via-path` | A Reading\'s `via` is a path (`<link>.<link>`, reaching the record through a row of the child\'s own) only on a Record\'s page, over a number, a split, a trend, a grid or a shortfall of the child\'s rows \u2014 never in a List\'s band or on a Sheet, nor on the record\'s own figure, a funnel or the work against its plan. |\n| `reading.grid-rows` | `across` splits a grid\'s columns, and stands only beside the `by` splitting its rows. |\n| `reading.band-off` | `readings: false` turns off the band a register leads with by default: a List stating it states no Readings, which are the band. |\n\n<!-- generated:end rules-reading -->\n\n## Statement rules\n\n<!-- generated:start rules-statement -->\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `statement.lines` | A Statement\'s `lines` are numbers of the record, each once \u2014 the first stating no `op`, every other one, the last an `"equals"` \u2014 each `"equals"` a formula, rollup or lookup, and a `rate` a number of the record. |\n| `statement.rows` | A line\'s `parts` read rows of an entity holding `same`, a one-link of the record\'s to the same entity; `at`, a moment of those rows, and `before`, a moment of the record (datetimes, never days), stated together; their `columns` and `figure` are those rows\' fields, the figure a number. |\n| `statement.parts-keyed` | A line\'s `parts` add up to its figure, so no person keys it: a formula, rollup or lookup, a value the server copies when the record is made (`default_from`) that no `create` asks and no save or Act writes, or a stored number the App\'s saves leave out \u2014 the line draws it read; each part\'s `figure` is frozen when its row was certified \u2014 a stored number an Act fills, the server copies or the App\'s saves leave out, never one a person keys or the server recomputes \u2014 and no person keys the moments `at` and `before` either. |\n\n<!-- generated:end rules-statement -->\n\n## Check rules\n\n<!-- generated:start rules-check -->\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `check.field` | A Check\'s `field` is an issue its entity\'s table declares in `records.issues` \u2014 a yes/no or text formula of the row, or the count of rows a link lists that hold one (`<link>_<issue>`). |\n| `check.of` | A Check stands in `pages/<entity>` and names an issue of that entity. |\n| `check.states-nothing` | A Check names an `on` or a `resolve`: a declared issue already stands wherever the row is drawn, so one that refuses and clears nothing adds nothing. |\n| `check.not-placed` | A Check\'s field is never also placed on the record as a Field \u2014 the line under the head says it. |\n| `check.on` | A Check\'s `on` names what it refuses: `"update"` (the saves), the `key` of an Act over the Check\'s entity \u2014 on one row or over a List\'s rows \u2014 or `"all"`. A record\'s Acts are refused by a Check of that record on the count its issues roll up from the rows it lists. It binds this App alone; a Delete is the table\'s checks\' to refuse. |\n| `check.resolve` | A Check\'s `resolve` names an Act of this App on one row of the Check\'s entity, not refused by the Check, and drawn as a button \u2014 never a correction. |\n| `check.restates-meter` | A warning reading a gated meter\'s figure against its bound or pass mark is refused \u2014 the meter draws it. |\n\n<!-- generated:end rules-check -->\n\n## List rules\n\nThe rules of a List\'s props and of what a child List holds. A layout\'s, a Tab\'s, an Export\'s and a desk\'s rules stand with their keys.\n\n<!-- generated:start rules-list -->\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `list.key-shape` | A List\'s key is not a record id\'s shape. |\n| `list.peers-read` | Root Lists over one table may state different `where`, unless one holds a `where` through a link, `sources` or a `plan` layout. |\n| `list.column-drawn` | A List\'s `columns` stand beside what the row draws itself: a column of its title, subtitle, picture, status, figure or meter\'s bound, of a child List\'s link back, or one named twice, stands once where the row seats it. |\n| `list.columns-budget` | *Noted, never refused:* A List\'s `columns`, each at the width of its kind, are told against the room a desk leaves beside its name and the row\'s own status, deadline and figure; what does not fit folds onto the name\'s line. |\n| `list.chips` | `chips: false` stops a register opening on status options. |\n| `list.filter` | A List\'s `filters` name a select, a member, a link, a date, a yes/no or a number of the List\'s own rows \u2014 a lookup through one-row links as the field it reads \u2014 never the status its chips draw, nor one `where` fixes; `values` only on a select, member or link. |\n| `list.filter-split` | *Noted, never refused:* A `filters` entry on a field a Reading of the List with `by` or `across` splits the rows by \u2014 a press on its part narrows by it too; a member\'s filter, which narrows to the reader\'s own rows, is never noted. |\n| `list.filter-unshown` | A `filters` entry of a List, a child List included, names a field its rows show: a `columns` entry, the row\'s title, line, picture, status, figure, deadline or meter\'s bound, the unit or currency a drawn figure is read in, a warning its line says, the group or lane it stands under, or a formula drawn where every field it reads is. A filter on a field no row shows is refused: make it a column or part of the row\'s line, or drop it. |\n| `list.narrow-unshown` | A narrowing the List `opens` on and a press in a Reading\'s band (a part, a grid cell, a figure\'s `where`) name a field its rows show, as a `filters` entry does (`list.filter-unshown`). A narrowing to the reader needs none. |\n| `list.tiers` | `tiers` band a number read in one unit on every row; a figure read in each row\'s own unit or currency is named bare. |\n| `list.search-undrawn` | *Noted, never refused:* A List\'s `search` matches all of a row\'s text, drawn or not: where a lookup, rollup, copy or link of its rows reads another entity under a row rule the List\'s readers are not all inside, it finds rows by text the List draws none of. |\n| `list.search` | A List\'s `search` names text, a code, or a link \u2014 matched by its row\'s title. |\n| `list.sort` | Each `sort` key of a List or a Tab names a field of the List\'s rows that holds an order \u2014 never files \u2014 and no field twice. |\n| `list.group` | A List\'s `group` names one value per row \u2014 a single select, a one-row link, one member, a date, a yes/no or a text, a lookup through one-row links as the field it reads \u2014 the status too, but never on a task list\'s block, whose chips narrow it; only a table or cards List groups, and a gantt into its lanes; grouping by the title needs a `row.subtitle` to lead each row. |\n| `list.readings-own` | A Reading in a List reads the List\'s own entity; another entity\'s stands on a Sheet. |\n| `list.readings-bands` | A Reading in a List that bands a number by `tiers` has that field with the same tiers among the List\'s `filters`, which a press on a band narrows by. |\n| `list.readings-restate` | A Reading with no `by` in a List never sums the row\'s figure, counts the rows, or counts one stage\'s rows, unless it is placed in time (`over`): the summary line and the status chips already do, but draw no change against the last period. Instead, for the summed figure: a mix `by` a field or a sum under a `where`; for the rows counted: a sum of the figure under a `where`, a mix `by` a field or a yes/no in `where`. |\n| `list.where-opens` | A List\'s `where` and `opens` hold a select\'s options, a yes/no\'s value, a number or date\'s bounds (`lte`, `gte`; a date\'s `{ "now": true }`; a number read in each row\'s own unit or currency takes only 0) and `{ "empty": true \\| false }`; `opens` alone names the reader \u2014 a member field or a lookup of one holding `{ "me": true }`, or, on a status whose `stages` have owners, the rows waiting on the reader \u2014 and takes fields only, on the status only options. A field `where` fixes to options is never a filter nor opened otherwise, and `opens` stays among the options `where` keeps. A List laid out as a `plan` keeps its items by options and yes/nos alone. |\n| `list.roster` | A `layout: "roster"` List holds the List of its cells: the cells\' entity has one single link to this one and a date on its line (its own field, or a lookup of its parent\'s date); a roster draws no `columns`, and an `expect` stands only on the cells List. |\n| `list.roster-covers` | `covers` is a whole number from 1, only on a roster\'s cells List over days, never beside an `expect`. |\n| `list.roster-expect` | A roster cells List\'s `expect` is a single select of its rows, and its `of` this entity\'s multi-select whose every option is one of `expect`\'s. |\n| `list.source-page` | A source\'s entity states a Record page in the App\'s `pages`. |\n| `list.band-pivot` | *Noted, never refused:* A Reading with `across` (a grid) among a List\'s Readings: its grid reads on a Sheet, and the band leads with a figure (a Reading with no `by`). |\n| `list.headline` | *Noted by the designer on a write, never refused:* A List over rows that fall due or carry money and have no status whose steps the chips count, laid out as a table, cards or a gantt, has Readings \u2014 they split the rows by a field they show. |\n| `list.figures-lead` | *Noted, never refused:* A root List over a table holding a status, or a money field beside a date, to count or total states a Reading, or a Tab with totals, above its rows: what a person watches, as a figure or a chart. |\n| `list.title-only` | *Noted, never refused:* A root List whose rows draw their title alone: a subtitle, a figure, a status, a deadline, a picture, a face or `columns` says what each row is. |\n| `list.people-undrawn` | *Noted, never refused:* A root List drawn in columns, stating fewer than two besides the figure, where a table whose rows are people links to its table: the paired link holding several of them is not a column of it, or the link is not paired. |\n| `list.layout-call` | *Noted, never refused:* A root List that states no layout, over rows a board layout\'s own resolver resolves (a calendar, a gantt, lanes, or a roster of rows a `cadence` owes), draws a table; the note names each layout and its key. A deadline or a stamped date is never a day rows stand on. |\n| `list.lanes-overlap` | *Noted, never refused:* Lanes of dated rows by a link with no `no_overlap`. |\n| `list.lanes-order` | *Noted, never refused:* Lanes giving rows at a day, whose first ascending `sort` is no stored number the app writes. |\n| `list.where-bound` | A bound read from the record (`{ "record": \u2026 }`) in `where` narrows only a List that reads its rows \u2014 `same`, or `edit: false`. |\n| `list.where-reader` | A root List\'s `opens` names the reader (`{ "me": true }`), never its `where`. Wrong: `where: { crew_lead: { me: true } }` on a child List. Right: a row rule bounds access, or a root List over the entity states `opens: { crew_lead: { me: true } }`. |\n| `list.where-reader-path` | A path reader `<link>.<field>` names a one-row link and a member field of the row it links. |\n| `list.props` | A node states only its place\'s props: a List those of a root List, a roster\'s cells, a rows, agenda, timeline or read-only List of a record (which take every prop of a View but `sources`), a document or a Sheet; the Record of a List that opens no row in place and a source\'s entity page `entity`, `edit` and its children; a Sheet its `key`, `label` and children. |\n| `list.holds` | A List holds what its place draws: a root List its Tabs, Readings, Exports, Acts over ticked rows or every row in view, sources and, under a roster, the List of its cells; a child List its Tabs, Readings, Exports, Acts over ticked rows and, with `under`, the List of its documents; a Sheet its Readings and Lists. An Act on one row and every Check stand in `pages/<entity>`. |\n| `list.layout-place` | The register lays out as a table, cards, a calendar, a roster, a gantt, lanes or a plan; a child List writing its rows as a table, checklist, desk or gantt; any child List as an agenda or timeline. |\n| `list.edit-column` | An edit column (`{ "field": \u2026, "edit": true }`) stands in a child List only: the register\'s rows are written where they open. |\n| `list.child-link` | A child List reads a child linked to the record; `via` names the link where the child links more than once. |\n| `list.row-blocks` | A List drawn as lines (`expect`, `under` or a desk) opens no row in place, so no List stands below its rows; a plain list of rows holds one. |\n| `list.title-back` | Where a child\'s title is its link back to the record, its first other `row.subtitle` names it there \u2014 a text, a code, a select, a link or a member, never a number or a date. |\n| `list.where` | A child List\'s `where` names single selects of the child by the options they hold (a row holding none stands in no such List; one held at a single option is never also a column), yes/nos by value, numbers and dates by bounds, and fields by `{ "empty": true \\| false }`. A yes/no, a bound or a blank is never held: a child List adds rows only at a stored yes/no\'s start, none under a bound or a blank, and never picks, expects or stands lines under documents. |\n| `list.under` | `under` names the child\'s one-row link to a document entity that pairs a many-link back and is read under this record by its one link; the lines\' columns never read the document (its heading does) nor hold long text. |\n| `list.under-once` | Documents drawn over their lines (`under`) are never listed again as a List of their own. |\n| `list.edits` | A child List\'s editable columns (`{ "field", "edit": true }`) name at most two of the child\'s columns or its figure that the App\'s saves write \u2014 a number, a date, a few words, one option or a one-row link, never a files or long-text field, the List\'s `via` nor a link it must name alike (a link\'s `same`) \u2014 never on an `expect` List. |\n| `list.remove-roster` | A roster cells List\'s `remove: true` offers the Delete of its rows, so it stands only over rows the App writes. |\n| `list.attention` | `attention: false` keeps a table\'s or cards\' rows in the List\'s own order; a calendar, lanes, a gantt and a roster stand their rows in time and lift none. |\n| `list.remove-documents` | The documents List inside a child List with `under` states `remove: true` only over documents the App writes. |\n| `list.compare` | A child List\'s `compare` names two different fields of the child, `before` and `after`: two files fields, or two values of one type (text but long text, a number, a date, a single select), never with `expect`. Over files on a checklist layout, `before` is the check\'s `photo`. Over values neither side is a column or something the row draws already, two numbers share a notation, no column is long text, and the layout is no checklist. |\n| `list.current` | A child List\'s `current` names a date or number of the child (stored, or a formula) that orders revisions: the latest row is current, the rest fold as superseded. Never with `group`, `under`, `expect`, `checklist`, `compare`, `desk` or `pick`, nor beside a column of long text. |\n| `list.pick` | A child List\'s `pick` links rows of the child through `via` \u2014 an optional one-row link a person writes, no Act writes, no other rule compares rows by and no `under` List stands lines under \u2014 paired with a many-link of the record its own save writes; the child\'s `read_scope` reads a row naming no record through `via`; never with `expect` or `under`, nor where the App\'s saves leave out the child or the many-link. |\n| `list.narrow` | A child List\'s `filters`, `search`, `group` and `sort` follow the register\'s rules over the child\'s rows, its status among them but on a task list (its chips); never on the link back or a select its `where` holds at one option, nor on an `expect` List; an `under` List is grouped by its documents. |\n| `list.expect` | `expect` names the child\'s title \u2014 a single select or a one-row link a person writes, never the link back \u2014 on a child added in the List; its `columns` name a field filled in place (not on a desk, whose lines are ticked) and its `create` takes the file where the child is pictured by one. |\n| `list.expect-fills` | An expected line is made from its key and its first filled column \u2014 a desk\'s from its key alone \u2014 so every other field the child requires has a default, a start or a `default_from`, or is read first. |\n| `list.expect-of` | An `expect` object\'s `of` or `only` needs a select: `of` names the record\'s multi-select of the title\'s options; `only` names options of a single select, never with `of` or a `where` on it, one List per option; an Act\'s `paper` is drawn in one. |\n| `list.post-option` | A desk\'s `text` formula names, as `{field:option}`, only options that select states. |\n| `list.funnel` | A Reading\'s `steps` (a funnel) are 2 to 8 numbers of its child, each named once \u2014 stored, a formula or a rollup \u2014 all in one notation, never a percent nor a unit read on each row. |\n| `list.list` | A read-only child List (`same`, or a Record that is `edit: false`) lists the rows of an entity that link to the record by its one link (`via` where it has several); with `same`, a one-row link of the record, it lists the rows sharing that link\'s row \u2014 the record left out \u2014 by the listed entity\'s one link to that row\'s entity (likewise `via`). `same` stands in a Record, never on a Sheet. Its Record\'s Fields \u2014 at least one, each a field of the listed entity named once, never its title nor a `columns` entry \u2014 are what an opened row shows, read-only. |\n| `list.figures` | A Record\'s own figures (Readings with no `entity` or `by`, whose `value` names the field) are 1 to 8 numbers of the record, each a tile. |\n| `list.create-boolean` | A document\'s and a roster\'s cells\' `create` is `true` or `false`: their add asks the table\'s defaults. |\n| `list.via-path` | A `<link>.<link>` `via` only reads rows, through a row of their own: a List writing its rows lists a child linked to the row it stands under. |\n| `list.beside` | `beside` opens a row beside a table: a root List drawn as a table states it, never a board, cards, a calendar or a List of a record. |\n| `list.create-empty` | A child List stating `create: true` asks the fields of its add (where the table\'s defaults ask none, state `create: false` or those fields); one stating no `create` adds none. |\n| `list.read-scope` | A child read under a record whose rows a `read_scope` narrows states its own \u2014 a row rule is not inherited, save the status history\'s, which takes its record\'s. |\n| `list.unworked-stage` | *Noted, never refused:* A register lists rows (every open one, else those its `where` keeps) at a stage no Act of the App is offered at and no Section stands at, though the App states the stages it works: keep them out with `where`, or leave them to the App working them. |\n| `list.under-note` | *Noted, never refused:* Rows holding a paper that cover another List\'s lines, listed apart with no add of their own stated: `under` draws them over the lines they cover. |\n| `list.expect-note` | *Noted, never refused:* Rows each a kind of paper, listed with no `expect` and no `where` on the kind, that no Act files a call into or `fills`: the missing lines read as what a record needs. |\n\n<!-- generated:end rules-list -->\n\n## Record rules\n\n<!-- generated:start rules-record -->\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `record.placed-once` | A child List, a Reading, a Statement and an Act each stand once in a Record; the same block stated in several Sections is that one placement, drawn in the first and said where repeated, and a repeat that differs from the first is refused; a set of papers stands where its Act does. A Field may be stated in several parts: parts that stack draw it once, parts a reader navigates each draw it. The head draws the title, line, picture, status, figure and the nearest open deadline, and a Field of a part standing there stands aside unless a person writes it in the part; what a Side states stands only in the Side. |\n| `record.check-lifted` | *Noted, never refused:* A Check stated inside a part guards the whole record, as one beside the parts does: it stands at the page, and is said. |\n| `record.foot-total` | A child List\'s foot totals the child\'s figure and each summed column over the rows it lists; the record\'s rollup summing that field over those rows (the same `where`) is that foot, never also a Field of a part. |\n| `record.section-holds` | A part without `at` (Section, Side) holds Fields, Fieldsets, child Lists, Readings, Statements or Acts. |\n| `record.linked` | A link drawn as a block (`block: true`) is a link to one row of a table the App states a Record page of: the row stands in place as that page draws it. |\n| `record.fieldset` | A Fieldset stands in a part, or in a one-part Record, and holds two or more Fields drawn as controls \u2014 never a gallery or prose Field (`block`) \u2014 each Field in one Fieldset. |\n| `record.parts` | *Noted by the designer on a write, never refused:* A List laid out as a table, cards or a gantt opens a Record whose Sections hold the fields people write, a files Field per paper and the Acts no stage places, a Section per stage the status states (in option order) with the moves offered there at its foot, and a child List per child, a table\'s own rows that belong to a row of it included. |\n| `record.lists` | *Noted by the designer on a write, never refused:* A table some App records, whose rows other rows each belong to (a one-row link to it, never its status history), draws some of them under its row \u2014 a child List in its Record, a List with `layout` roster or lanes by that link, or an App over them working inside one of its rows at a time (`scope`). |\n| `record.at` | A Section\'s `at` names options of the record\'s status; a record with no status has no steps. |\n| `record.edit-declared` | What an App writes of a row is what its Record declares: each Field its Sections state, the table\'s face (`records`: title, line, picture, figure, description) and, where the Record states no part, every field a person writes \u2014 each unless `edit: false` reads it \u2014 beside what an Act requires and a list of child rows its block writes. The head as `row` restates it (each part takes `edit: false`, read and never written), a column, an expected line, a `compare` and a layout\'s move draw a declared field with its control and never declare one: one naming a field no Section declares is refused. A tree stored before the rule rebuilds as it was. |\n| `record.edit-unseated` | *Noted, never refused:* A field of the table\'s face the `row` leaves out of the head, that no Section, column, layout or Act of the App writes, is written nowhere in this App: said, and a Section stating it makes it the App\'s to write. |\n| `record.beside-door` | A Record whose entity a root List opens `beside` its table states no `door`: the rows open beside the table. |\n| `record.key-clash` | A Record\'s List blocks, filed rows and links share one namespace of `key`s: none repeats but the same block stated again (`record.placed-once`), a List\'s default being its table, and a link\'s or a filed field\'s being its alias; a List and a link at one key, or one alias leading to two tables, is refused. Where unkeyed Lists over one entity stand in different Sections of a page, each takes its Section\'s key as its own, unless they are stated alike (one block stated again) or two stand in one Section, which nothing tells apart: those stay unkeyed. |\n| `record.side` | At most one Side stands in a Record, on a page `door`. |\n| `record.history` | No part of a Record reads the entity\'s status history (`status.history`): the rail reads each move. |\n| `record.section-acts` | An Act in a part works on the record itself; an Act over ticked rows or every row in view stands in a List. |\n| `record.move-home` | *Noted, never refused:* A status move offered at one step stands at that step\'s foot when it moves the work forward, to an exit, or back to a step the work passes \u2014 one a row starts at, or one an Act moves the work forward into or on from; one offered at several steps, or moving back into a step the work never passes, stands in the Section whose `at` holds the status it enters, as its way in. A move written in another Section, or in none, stands there and is said. |\n| `record.act-staged` | An Act at a staged Section\'s foot is offered only during that Section\'s steps: its `when` holds the status to options the Section\'s `at` names. A tree\'s Act with no `when` at the foot of a Section staged at one step is offered at that step and said; a correction stays offered at every step, and an exit is refused. |\n| `record.act-hidden` | An Act is never offered only while its part\'s `when` hides the part. |\n| `record.outside-place` | An Outside stands directly in a Record whose table states a stored status select, and its `key` is unique in the App: a link to a record names it. |\n| `record.outside-at` | An Outside\'s `at` names options of the record\'s status that no stage owns, and no two Outsides of a record open during the same option. |\n| `record.outside-field` | An Outside\'s Fields are read as values, each a field of the record shown once, never `edit`, `when` or a label of its own. |\n| `record.outside-list` | An Outside\'s Lists read the child rows under the record as they are: their `columns`, `label` and `where` only, never an add, a Delete, a pick, a filter, a search, a link that opens, or a bound read from the record. |\n| `record.outside-where` | An Outside List\'s `where` keeps the child rows by single selects held at options, yes/nos at values, numbers and dates between bounds, and fields by `{ "empty": \u2026 }`. |\n| `record.outside-act` | An Outside\'s Acts are its alone and each ends the visit: `when` holds the status to `at`, `set` moves it to an option outside `at`, `asks` are text, numbers, dates or listed options, `requires` names fields the Outside shows or the act asks, a `sign` is by a text field with no witness, and none states `on`, `workflow`, `templates`, `paper`, `intake`, `record`, `review`, `danger`, `recommends` or `me`. |\n| `record.holds` | A Record stands in the App\'s `pages`, once per entity some List of the app or of a Sheet is over, or whose rows a link the app draws names. Every Record holds the same: parts (Section, Side) or the Fields, Fieldsets, Lists, Readings and Statements of its one part, never both; beside either stand Outsides, Checks and Acts on one row; holding only those, the record\'s Sections are the platform\'s. The page of an entity whose rows a child List opens no row of in place (an agenda, a timeline, a read-only List) holds Fields alone. |\n| `record.remove` | A Record\'s `remove` deletes a row opened from a link; an entity a List lists is deleted as that List\'s `remove` says. |\n| `record.field-heading` | A Field drawn as a control states no `label` or `when`: only a gallery or prose Field (`block`) has a heading and a condition. |\n| `record.section-owners` | *Noted, never refused:* A Section holding acts offered at stages that different owners work \u2014 a role apiece, or a member field apiece \u2014 is two jobs in one: each owner\'s part is a Section of its own. |\n| `record.stage-field` | *Noted, never refused:* A field of a record with a status that only Acts offered at some of its stages write \u2014 no `create` asks it, no Field of the page draws it written \u2014 and that a Side or a Section shown at every stage draws, stands empty before those stages: it is stated in a Section `at` them, where it is the work then. |\n| `record.rows-repeated` | *Noted, never refused:* A Record that lists the same rows (a List of one table through one link) in two or more Sections lists them once, in the Section they belong to: a Section is one area of the record\'s data. |\n\n<!-- generated:end rules-record -->\n\n## Act rules\n\n<!-- generated:start rules-act -->\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `act.paper-note` | *Noted, never refused:* A made paper kept in a field of a record that lists its papers by kind: it is one of those lines. |\n| `act.moves` | *Noted by the designer on a write, never refused:* The rows of a root List of the App that a stored status stages towards `closed` options are moved by an Act of the App (on a page, a List or an Outside), or by its authored `workflow` \u2014 each open option moves to the next, the last to the first closed one. |\n| `act.set-not-asked` | A field an Act `set`s (an option, a value, `{ "now": true }`, `{ "me": true }`, an input) or `sign`s is the Act\'s outcome: the App\'s `create` never asks it, and a required one takes a `default`. A `formula` only starts a value, which a person may change after. |\n| `act.owner` | An Act\'s `owner` is a single member field of its row, a one-row link\'s member field (`link.field`), or `{ "group": <id> }` of a group the workspace holds: the press is that owner\'s, or the one standing in for them. An Act handed no row (`review`, `intake`, or over the list asking a person something) has no row to read a member field from, so its owner is a group. |\n| `act.owner-stage` | *Noted, never refused:* An Act that moves no status and is offered while the status holds a stage another member owns is pressed by that stage\'s owner: state its `owner` for someone else to press it. |\n| `act.owner-moves` | An Act stating `owner` moves no row off a stage another owner owns: the server refuses that move to anyone else, so the press would be refused. A move from an option no one owns is fine. |\n| `act.asks-set` | A field an Act `asks`, `set`s or `sign`s is stated by one of them: what the Act writes is its outcome, never also asked, and no field is written by two clauses of one Act. |\n| `act.starts` | `starts` (an ask `{ field, starts }`) starts a field the Act asks \u2014 `"today"` a date or a moment (never a span), `me` a member \u2014 for the reader pressing it, who changes it at will. |\n| `act.set-formula` | `set: { <field>: { formula } }` reads fields of the acted row and computes what the field holds \u2014 a number, a date, text, a yes/no or a single select\'s option (`{field:option}`), typed as the entity\'s own formulas are \u2014 never the status; a bound a write rule holds the field to is checked on the computed value as the Act runs. |\n| `act.set-formula-option` | A `{field:option}` token of a `set` formula names an option that select states. |\n| `act.of` | An Act in a child List works on that child: the one row pressed \u2014 or, with `on: "ticked"`, the rows ticked together where the record lists them as tasks \u2014 never the rows in view. |\n| `act.writes-line-key` | An Act never writes the link or the key naming an expected line under its record \u2014 a line\'s key is stated by filling it. |\n| `act.makes-or-runs` | An Act makes a document (`template`, `templates`) or runs an authored `workflow`, never both \u2014 the workflow makes what it needs. |\n| `act.does-nothing` | An Act does something: it `set`s a value, `asks` a field, runs a `workflow`, makes a document, takes an `intake`, a `record` or a `sign`, or `makes` the rows a cadence owes. |\n| `act.view` | An Act over every row in view (`on: "view"`) writes (`set`), makes a document, runs a workflow or reads papers into a new record, and states no `requires`. |\n| `act.requires-written` | A field an Act requires that only an Act writes is written by an Act offered together with it, or asked by the Act itself. |\n| `act.recommends` | A field an Act `recommends` is not also in its `requires`. |\n| `act.set` | `set` writes each field a value it holds \u2014 an option alias, a number, a yes/no, a text, `{ "now": true }` on a date, `{ "me": true }` on a member, `{ "input": "<name>" }` of an input the Act asks of the same kind \u2014 or clears an optional one with `null`. |\n| `act.into` | `into` is a files field of the one record the Act is pressed on, beside its `template` or `templates`. |\n| `act.paper-list` | A List a made paper names is one it can list: none keeps its rows by the reader, and no name is reached by a child List that writes its rows and one that only reads them, or by two of either, at once. |\n| `act.paper-list-field` | A List a made paper names is not also a field of the record, other than the link to those rows; an outline\'s rows are handed their depth as `level`, so they hold no field of that name. |\n| `act.paper-loop` | A loop of an html or Word paper that prints a field of each item runs over a link of the record or a table linking to it once (their rows are read under the app\'s row rules), or a List\'s rows \u2014 never over a link inside a child row, or one to rows the app cannot read, which a paper is handed as titles; over several rows an html paper holds the same one level inside `{{#each <alias>}}`, where each row is handed its own lists; a List\'s rows are looped for their fields, never printed whole; a loop runs over a name the paper is handed, never one it is not, which prints an empty table. |\n| `act.paper-cells` | A paper does not draw a cell for each title of a link inside the row of a List it loops over: the titles of a link line up with no column, so a cell packs left under the wrong date. Lay the rows out on a roster and export it, or draw a List. |\n| `act.paper` | `paper` is a kind the record lists its papers by, on one record \u2014 never beside `into` or `templates`; one maker per kind. |\n| `act.templates` | `templates` names each template once, kept in `into`, on one record pressed alone \u2014 never beside `template` or `asks`, in a child List, or with an `on` over several rows. |\n| `act.intake` | `intake` names a child the record lists in a child List with `expect` on its title \u2014 a single select, the paper\'s kind \u2014 and is narrowed by no `where`, holding exactly one files field and needing nothing an added line does not fill; the Act runs on one record (rows it finds by natural key need the link filing them under the record paired), or over the view (`on: "view"`) where the papers make a new record, states `fills`, and states nothing but its `label`, `when` and `requires` beside them \u2014 over the view no `when` or `requires`, the record has no row yet. |\n| `act.record` | `record` names a child the record draws in a timeline List or a child List with no `expect`, `under` or `where`, linking back by one single link, its row needing nothing the recording does not write: `audio` and `video` files fields, `transcript` text, `at` a date, `by` a member, each its own field; on one record, stating only `label`, `when`, `requires` and `fills` beside it. |\n| `act.sign` | `sign` runs on one record: `into` a files field, `by` a text field the signer types or a member field set to the person pressing, `at` a date, `witness` a member field \u2014 stated exactly beside a text `by` \u2014 each a field of its own that the Act does not also ask or set, and no other Act signs into `into`. |\n| `act.fills` | `fills` names each once, only beside `intake` or `record`. Beside `record`: a field of the recording\'s row the recording does not write, never a link. Beside `intake`: a field of the record, `<link>.<field>` on the row a required one-row link names (never beside that link), or a child the record adds rows of in a child List with no `expect`, `under` or `where`, filled in the fields its `create` asks \u2014 every one a new row needs among them. Each field filled is one a person writes \u2014 text, a number, a date, a yes/no, options or a single link\'s row \u2014 never a status, a field an Act writes or a link `same` narrows; a link\'s row is one the App reads of its entity. Over the view the papers make a new record, so `fills` names every field the record requires that nothing fills itself \u2014 the review asks the ones no paper states \u2014 and the row a required one-row link names is found on its entity\'s `natural_key` once `<link>.<field>` fills every field of it, left as it is, else added with the fields filled, so `fills` names each field that row requires too. |\n| `act.fills-drawn` | *Noted, never refused:* A field `fills` writes that the record draws nowhere: the review shows the change, the record does not. |\n| `act.fills-new` | *Noted, never refused:* A child `fills` adds rows of, whose natural key the papers cannot state: every row read is added, so the same papers read twice list them twice. Over the view, so is the row a required link names where the papers fill no natural key of it. |\n| `act.input` | An input has a name of its own \u2014 never another ask\'s, a field the act sends under that name (one it asks, one a `set` takes from an input, a typed `sign.by`, a `requires`), `sign.into`, or the record input its workflow takes (nor `approved` beside `review`) \u2014 `options` exactly when it is a select, `entity` exactly when it is a link, and a `default` field holding what it states. An input starts empty, or from its `default`, and never reads, shadows or overwrites a field of the row: an act that adds a subtask may ask `name`, though the row has a `name`. A `"file"` input is read by the Act\'s authored `workflow` alone, starts empty, and is never written into a field by `set`. |\n| `act.review` | `review: true` stands beside an authored `workflow` on an Act over the record, the ticked rows or every row in view (never on a List reading `sources`), never beside `set`, `template`, `templates`, `intake`, `record`, `sign` or `confirm`, nor in a child List, and it asks inputs only, none named `approved`. Its workflow is that Act\'s alone, run by no other Act. The workflow calls only steps that read \u2014 no agent \u2014 and returns a changeset of the entity\'s table in `data.review`, the same for the same inputs and rows; the platform writes the rows `approved` names, each only while the run proposes it as the caller read it. Over every row in view (`on: "view"`) it is handed no rows and states no `when`: its workflow reads the rows it may change, whatever the view is narrowed to, and no bound on a run\'s rows applies. |\n| `act.makes` | `makes` names a child that the Act\'s entity states a `cadence` for, in a Record or in a List with `on: "view"` or `"ticked"` that is not a child List; never beside `set`, `workflow`, `template`, `templates`, `intake`, `record`, `sign`, `review` or `of`. The app lists the child\'s rows in a List, and every field of the child that the cadence does not fill and that a row requires has a `default_from`, a `default` or an autonumber, since the app writes the child. The child states a `unique` of its link to the parent and the `planned` date (the day its cadence fills, where the cadence states no `planned`), so two presses at once make a day once, and the cadence states `start` where the child\'s first date holds a moment. |\n| `act.workflow` | An Act\'s authored `workflow` body parses once the guards the Act states are placed above it: the code is the author\'s, the guards above it the platform\'s. A declared Workflow an Act runs takes the row pressed as `record_id` (a required record_link to the act\'s rows), is run by that one Act, over one row, which asks only its inputs and states no `set`, papers, `intake`, `record` or `review`. An authored `workflow` is one Act\'s. Where a Check on the count its issues roll up refuses the Act, the workflow holds the record as one transaction and so cannot mail, notify, run an agent or wait. |\n| `act.set-tagged` | An Act\'s `set` states the moment as `{ "now": true }`, the person pressing as `{ "me": true }` and an input as `{ "input": \u2026 }` \u2014 never the strings `"now"`, `"me"` or `"input:\u2026"`. |\n\n<!-- generated:end rules-act -->\n\n## Template rules\n\nThe rules of the document templates an Act makes and an Export fills.\n\n<!-- generated:start rules-template -->\n\n#### Rules the check enforces\n\n| Rule | |\n|---|---|\n| `template.kind` | An Act\'s `template` is an html, excel or word document template and an Export\'s `template` an html or excel one, never an email or pdf-form one. |\n| `template.marker` | Every marker of a Word template an Act makes is filled by that Act: a field of its entity, or a list of the child rows its record lists (the entity\'s own alias over several rows). |\n| `template.act` | *Noted, never refused:* In an App none of whose Acts runs an authored `workflow`, every html, excel or word template is made by an Act (`template`, `templates`) or filled by an Export \u2014 the note names the app over the table whose fields it prints most, where the Act belongs. |\n\n<!-- generated:end rules-template -->\n\n## What the workspace remembers\n\nThe workspace holds every table, field and select option under an id that never changes, whatever its\nlabel or alias becomes. `set_tables` answers each table\'s id, and an\napp\'s body names tables and templates by those ids, so a relabel on either side is a rename and no body\npoints at another table by accident.\n\nA table `set_tables` refuses to write, or an id the workspace no longer holds, is a refusal by name. `set_tables` with `{ table_id, restore: true }` puts a deleted table back.\n\n## A complete workspace\n\nTwo main entities, so two apps: a sales desk over the orders, where an order is taken and shipped, and an account review\nover the customers, where an account manager reads each customer by tier. What belongs to a row is a child List on that\nrow\'s page, never another app or a Tab: a customer\'s orders are on the customer\'s page, and each order is also a row of\nthe sales desk, one record with one page (`app_architecture`).\n\nOne `set_tables` call makes both tables: each item carries a `ref`, and a link names the table it points\nat by the `ref` of the other item. Its answer carries each table\'s id. One `set_app` call then makes each\napp, `{ "body": \u2026 }`: the tree\'s root names the app by its `key` and `name`, and the tables it uses in `tables` by those ids,\nshown here as placeholders to replace.\n\n```json\n{\n "tables": [\n {\n "ref": "customer",\n "label": "Customers",\n "singular": "Customer",\n "fields": {\n "name": {"label": "Name", "required": true, "type": "text"},\n "logo": {"label": "Logo", "type": "files"},\n "tier": {\n "label": "Tier",\n "default": ["standard"],\n "type": "select",\n "options": [\n {"alias": "standard", "label": "Standard", "color": "slate"},\n {"alias": "gold", "label": "Gold", "color": "amber"}\n ]\n },\n "orders": {"label": "Orders", "type": "link", "pair": "customer", "table": "order", "multi": true},\n "total_ordered": {"label": "Total ordered", "type": "rollup", "via": "orders", "op": "sum", "field": "amount"}\n },\n "title": "name",\n "records": {"image": "logo", "party": "organization", "figure": "total_ordered"}\n },\n {\n "ref": "order",\n "label": "Orders",\n "singular": "Order",\n "fields": {\n "code": {"label": "Order no.", "type": "text", "unique": true},\n "placed_on": {"label": "Placed on", "type": "date", "format": "date"},\n "amount": {"label": "Amount", "type": "number", "notation": {"style": "currency", "currency": "VND"}},\n "total": {\n "label": "Total with VAT",\n "type": "formula",\n "expression": "{amount} * 1.1",\n "notation": {"style": "currency", "currency": "VND"}\n },\n "customer": {"label": "Customer", "type": "link", "pair": "orders", "table": "customer", "multi": false},\n "note": {"label": "Note", "type": "text"},\n "stage": {\n "label": "Stage",\n "default": ["draft"],\n "type": "select",\n "options": [\n {"alias": "draft", "label": "Draft", "color": "slate"},\n {"alias": "confirmed", "label": "Confirmed", "color": "blue"},\n {"alias": "shipped", "label": "Shipped", "color": "green"}\n ]\n }\n },\n "title": "customer",\n "records": {\n "subtitle": ["code", "placed_on"],\n "figure": "amount",\n "status": {"field": "stage", "closed": ["shipped"]},\n "starts": {"placed_on": "today"}\n }\n }\n ]\n}\n```\n\n```json\n{\n "body": {\n "type": "App",\n "key": "account_review",\n "name": "Account review",\n "color": "blue",\n "tables": {"customer": "<id of the customer table>", "order": "<id of the order table>"},\n "templates": {},\n "children": [\n {\n "type": "List",\n "entity": "customer",\n "columns": ["tier"],\n "children": [\n {"type": "Reading", "key": "ordered_by_tier", "by": "tier", "value": "total_ordered"}\n ]\n }\n ],\n "pages": [\n {\n "type": "Record",\n "entity": "customer",\n "children": [\n {"type": "Section", "key": "account", "title": "Account", "children": ["tier"]},\n {\n "type": "Section",\n "key": "orders",\n "title": "Orders",\n "children": [{"type": "List", "entity": "order", "columns": ["total"], "create": ["code", "amount"]}]\n }\n ]\n }\n ]\n }\n}\n```\n\n```json\n{\n "body": {\n "type": "App",\n "key": "sales_desk",\n "name": "Sales desk",\n "color": "violet",\n "tables": {"customer": "<id of the customer table>", "order": "<id of the order table>"},\n "templates": {},\n "children": [\n {\n "type": "List",\n "entity": "order",\n "filters": ["customer"],\n "create": ["code", "customer", "placed_on"],\n "children": [\n {"type": "Reading", "by": "placed_on", "value": "amount"}\n ]\n }\n ],\n "pages": [\n {\n "type": "Record",\n "entity": "order",\n "door": "drawer",\n "children": [\n {\n "type": "Section",\n "key": "order",\n "title": "Order",\n "children": [\n "note",\n {\n "type": "Act",\n "key": "confirm",\n "label": "Confirm",\n "when": {"stage": ["draft"]},\n "set": {"stage": "confirmed"}\n },\n {\n "type": "Act",\n "key": "ship",\n "label": "Ship",\n "when": {"stage": ["confirmed"]},\n "set": {"stage": "shipped"}\n }\n ]\n }\n ]\n }\n ]\n }\n}\n```\n\nThe account review leaves the door a record opens through and the rows it opens in to the system, each the default the\ntable\'s facts give; the sales desk states a drawer. Each List names what its add asks (`create`). The customer\'s orders are a block in its "Orders" section, never its own `Orders`\nlink as a field as well: one fact, one place. An order is titled by its customer and read by its number under it; the\nList names what its add asks, since a subtitle or a figure is never asked by default. `Total ordered` is a rollup, so it\nis read and never asked; the sales desk\'s record opens in a drawer, because its rows are worked one after another. An\norder\'s `stage` is its status (`records.status`), moved only by the app\'s acts: they set it, so the app\'s saves leave it\nout, each act names the stage it is offered at (`when`) and the one it sets, and the register opens on the orders not yet\nshipped (`closed`).\n';
1883
1883
 
1884
1884
  // docs/examples.md
1885
- var examples_default = '# Worked examples\n\nEach section is one treatment, cut from a complete workspace of an invented business: the job, the keys to\nread, where the treatment is wrong, and the excerpt \u2014 the app\'s tree, the App node `set_app` takes as `body`,\nwhich the check passes with no finding; the tables it draws as the items of a `set_tables` call, each with its\n`title` and `records`; those tables\' fields it names, by what each holds and how it is drawn; and the templates it makes.\nLeft out, for the page\'s size: a Section or page that carries nothing of the treatment, every `label` and `description` of a table or field, `required`, `min`, `unique`, `default` (a section keeps the ones its **Read** rests on), a link\'s\n`pair`, how a computed field computes, the `tables` and `templates` maps an App adds (ids from the\n`set_tables` answer), and template contents \u2014 a call states each table\'s and field\'s `label`. Choosing\namong them: the `design` reference. Every key: `reference`, at the pages each section names under\n**Keys**.\n\n## Calendar\n\n**The job.** Book visits on the days they happen, and see a week\'s work at a glance.\n\n**Read.** `layout: "calendar"` on the List; each visit stands from `scheduled_for` over its span to `ends_at`, the two `required` moments of its facts (`ends_at` is ordered after `scheduled_for` by its `min`); a keyed calendar names the date and the end itself.\n\n**Keys.** `reference/calendar`\n\n**Not when.** Rows booked on a resource that two may not share at once \u2014 that is `lanes`. Rows with a date nobody plans by (an invoice\'s date) stay a table.\n\n```json\n{\n "tables": [\n {\n "ref": "service_visit",\n "title": "customer",\n "fields": {\n "customer": {"required": true, "type": "link", "table": "customer", "multi": false},\n "scheduled_for": {"required": true, "type": "date", "format": "datetime"},\n "ends_at": {"required": true, "type": "date", "format": "datetime", "min": "scheduled_for"},\n "engineer": {"type": "link", "table": "engineer", "multi": false},\n "job": {\n "required": true,\n "type": "select",\n "options": [{"alias": "inspection", "color": "sky"}, {"alias": "repair", "color": "orange"}]\n },\n "stage": {\n "type": "select",\n "options": [\n {"alias": "booked_on", "color": "blue"},\n {"alias": "parts_ready_on", "color": "blue"},\n {"alias": "arrived_on", "color": "blue"},\n {"alias": "completed_on", "color": "green"}\n ]\n },\n "booked_on": {"type": "date"},\n "parts_ready_on": {"type": "date"},\n "arrived_on": {"type": "date"},\n "hours": {"type": "number", "notation": {"style": "unit", "unit": "h"}},\n "report": {"type": "text", "format": "markdown"},\n "completed_on": {"type": "date"}\n },\n "records": {\n "subtitle": ["scheduled_for", "ends_at"],\n "figure": "hours",\n "due": ["scheduled_for"],\n "status": {\n "field": "stage",\n "closed": ["completed_on"],\n "dates": {\n "booked_on": "booked_on",\n "parts_ready_on": "parts_ready_on",\n "arrived_on": "arrived_on",\n "completed_on": "completed_on"\n }\n }\n }\n }\n ],\n "body": {\n "type": "App",\n "key": "visits",\n "name": "Service visits",\n "icon": "calendar",\n "color": "emerald",\n "rows": {\n "customer": {"any": [{"member_of": "sales"}]},\n "order": {"any": [{"member_of": "sales"}, {"member_of": "stores"}]},\n "order_line": {"any": [{"member_of": "sales"}, {"member_of": "stores"}]},\n "payment": {"any": [{"member_of": "sales"}, {"member_of": "stores"}]},\n "service_visit": {"any": [{"member_of": "sales"}, {"member_of": "stores"}, {"member_of": "field"}]}\n },\n "children": [\n {\n "type": "List",\n "entity": "service_visit",\n "columns": ["engineer", "job"],\n "filters": ["customer"],\n "sort": {"field": "scheduled_for"},\n "layout": "calendar",\n "create": ["customer", "job", "scheduled_for", "ends_at", "engineer"],\n "children": [\n {"type": "Reading", "key": "register_reading_0", "label": "Repairs", "where": {"job": ["repair"]}},\n {"type": "Reading", "key": "register_reading_1", "value": "hours", "by": "engineer"}\n ]\n }\n ],\n "pages": [\n {\n "type": "Record",\n "entity": "service_visit",\n "children": [\n {\n "type": "Section",\n "key": "visit",\n "title": "Visit",\n "at": ["booked_on", "parts_ready_on"],\n "children": [\n "job",\n "booked_on",\n "parts_ready_on",\n {\n "type": "Act",\n "key": "reschedule",\n "label": "Reschedule",\n "asks": ["scheduled_for", "ends_at"],\n "when": {"stage": ["booked_on", "parts_ready_on"]}\n },\n {\n "type": "Act",\n "key": "to_booked_on",\n "label": "Booked",\n "when": {"stage": {"empty": true}},\n "asks": [{"field": "booked_on", "starts": "today"}],\n "set": {"stage": "booked_on"}\n },\n {\n "type": "Act",\n "key": "to_parts_ready_on",\n "label": "Parts ready",\n "when": {"stage": ["booked_on"], "job": ["repair"]},\n "asks": [{"field": "parts_ready_on", "starts": "today"}],\n "set": {"stage": "parts_ready_on"}\n },\n {\n "type": "Act",\n "key": "to_arrived_on",\n "label": "On site",\n "when": {"stage": ["booked_on"], "job": ["inspection"]},\n "asks": [{"field": "arrived_on", "starts": "today"}],\n "set": {"stage": "arrived_on"}\n },\n {\n "type": "Act",\n "key": "to_arrived_on_2",\n "label": "On site",\n "when": {"stage": ["parts_ready_on"]},\n "asks": [{"field": "arrived_on", "starts": "today"}],\n "set": {"stage": "arrived_on"}\n }\n ]\n },\n {\n "type": "Section",\n "key": "report",\n "title": "Report",\n "at": ["arrived_on"],\n "children": [\n "engineer",\n "arrived_on",\n {"field": "report", "block": false},\n {\n "type": "Act",\n "key": "complete",\n "label": "Complete visit",\n "requires": ["engineer"],\n "asks": [\n "hours",\n {"input": "summary", "label": "What was done", "type": "long_text", "required": true}\n ],\n "set": {"report": {"input": "summary"}, "stage": "completed_on"},\n "when": {"stage": ["arrived_on"]}\n },\n {\n "type": "Act",\n "key": "clear_visit_hours",\n "label": "Clear hours",\n "set": {"hours": null},\n "confirm": true\n }\n ]\n }\n ]\n },\n {"type": "Record", "entity": "warehouse", "add": ["name", "city"]},\n {"type": "Record", "entity": "engineer", "add": ["name", "base"]},\n {"type": "Record", "entity": "customer", "add": ["name", "credit_limit"]}\n ]\n }\n}\n```\n\n## Lanes\n\n**The job.** Put each service visit on an engineer\'s day by the hour, and see at once who is free between visits.\n\n**Read.** `layout` `lanes` with `by` naming the one-row link to the resource (the engineer); every engineer stands as a lane, empty or not.\n\n**Keys.** `reference/lanes`\n\n**Not when.** The resource is not a row of the model (a free-text room name), or rows never compete for one \u2014 a `calendar` reads them by day.\n\n```json\n{\n "tables": [\n {\n "ref": "service_visit",\n "title": "customer",\n "fields": {\n "customer": {"type": "link", "table": "customer", "multi": false},\n "scheduled_for": {"type": "date", "format": "datetime"},\n "ends_at": {"type": "date", "format": "datetime"},\n "engineer": {"type": "link", "table": "engineer", "multi": false},\n "job": {\n "type": "select",\n "options": [{"alias": "inspection", "color": "sky"}, {"alias": "repair", "color": "orange"}]\n },\n "stage": {\n "type": "select",\n "options": [\n {"alias": "booked_on", "color": "blue"},\n {"alias": "parts_ready_on", "color": "blue"},\n {"alias": "arrived_on", "color": "blue"},\n {"alias": "completed_on", "color": "green"}\n ]\n },\n "booked_on": {"type": "date"},\n "parts_ready_on": {"type": "date"},\n "arrived_on": {"type": "date"},\n "hours": {"type": "number", "notation": {"style": "unit", "unit": "h"}},\n "completed_on": {"type": "date"},\n "length": {"type": "formula", "notation": {"style": "unit", "unit": "h"}}\n },\n "records": {\n "subtitle": ["scheduled_for", "ends_at"],\n "figure": "hours",\n "due": ["scheduled_for"],\n "status": {\n "field": "stage",\n "closed": ["completed_on"],\n "dates": {\n "booked_on": "booked_on",\n "parts_ready_on": "parts_ready_on",\n "arrived_on": "arrived_on",\n "completed_on": "completed_on"\n }\n }\n }\n },\n {\n "ref": "engineer",\n "title": "name",\n "fields": {\n "name": {"type": "text"},\n "base": {"type": "link", "table": "warehouse", "multi": false},\n "day_hours": {"type": "number", "notation": {"style": "unit", "unit": "h"}}\n },\n "records": {"subtitle": ["base"], "party": "person"}\n }\n ],\n "body": {\n "type": "App",\n "key": "dispatch",\n "name": "Dispatch",\n "icon": "wrench",\n "color": "sky",\n "rows": {\n "customer": {"any": [{"member_of": "sales"}]},\n "order": {"any": [{"member_of": "sales"}, {"member_of": "stores"}]},\n "order_line": {"any": [{"member_of": "sales"}, {"member_of": "stores"}]},\n "payment": {"any": [{"member_of": "sales"}, {"member_of": "stores"}]},\n "service_visit": {"any": [{"member_of": "sales"}, {"member_of": "stores"}, {"member_of": "field"}]}\n },\n "children": [\n {\n "type": "List",\n "entity": "service_visit",\n "columns": ["job"],\n "search": ["customer"],\n "layout": {"lanes": {"by": "engineer", "loads": {"length": "day_hours"}}},\n "create": ["engineer", "scheduled_for", "ends_at", "customer", "job"]\n }\n ],\n "pages": [\n {\n "type": "Record",\n "entity": "service_visit",\n "children": [\n {\n "type": "Section",\n "key": "booking",\n "title": "Booking",\n "children": [\n "engineer",\n "job",\n "hours",\n {\n "type": "Act",\n "key": "to_booked_on",\n "label": "Booked",\n "when": {"stage": {"empty": true}},\n "asks": [{"field": "booked_on", "starts": "today"}],\n "set": {"stage": "booked_on"}\n },\n {\n "type": "Act",\n "key": "to_parts_ready_on",\n "label": "Parts ready",\n "when": {"stage": ["booked_on"], "job": ["repair"]},\n "asks": [{"field": "parts_ready_on", "starts": "today"}],\n "set": {"stage": "parts_ready_on"}\n },\n {\n "type": "Act",\n "key": "to_arrived_on",\n "label": "On site",\n "when": {"stage": ["booked_on"], "job": ["inspection"]},\n "asks": [{"field": "arrived_on", "starts": "today"}],\n "set": {"stage": "arrived_on"}\n },\n {\n "type": "Act",\n "key": "to_arrived_on_2",\n "label": "On site",\n "when": {"stage": ["parts_ready_on"]},\n "asks": [{"field": "arrived_on", "starts": "today"}],\n "set": {"stage": "arrived_on"}\n },\n {\n "type": "Act",\n "key": "to_completed_on",\n "label": "Completed",\n "when": {"stage": ["arrived_on"]},\n "asks": [{"field": "completed_on", "starts": "today"}],\n "set": {"stage": "completed_on"}\n }\n ]\n }\n ],\n "row": {\n "subtitle": [{"field": "scheduled_for", "edit": false}, {"field": "ends_at", "edit": false}],\n "figure": false\n }\n },\n {"type": "Record", "entity": "warehouse", "add": ["name", "city"]},\n {"type": "Record", "entity": "engineer", "add": ["name", "base"]},\n {"type": "Record", "entity": "customer", "add": ["name", "credit_limit"]}\n ]\n }\n}\n```\n\n## Gantt\n\n**The job.** Read every hire as a bar from the day the machine goes out to the day it is due back, against today.\n\n**Read.** `layout` `gantt` with its `start`; with no end stated, the bar ends at the entity\'s first `due`. The day a hire comes back (`ngay_tra`) is stamped by the status\'s `dates`, so no act sets it.\n\n**Keys.** `reference/gantt`\n\n**Not when.** Rows that last a day or less (a visit, a shift) \u2014 `calendar` or `lanes`; a plan with no dates set yet.\n\n```json\n{\n "tables": [\n {\n "ref": "phieu_thue",\n "title": "khach_hang",\n "fields": {\n "khach_hang": {"type": "link", "table": "khach_hang", "multi": false},\n "so_phieu": {"type": "text"},\n "trang_thai": {\n "type": "select",\n "options": [\n {"alias": "moi", "color": "slate"},\n {"alias": "dang_thue", "color": "blue"},\n {"alias": "da_tra", "color": "green"},\n {"alias": "huy", "color": "gray"}\n ]\n },\n "phu_trach": {"type": "member"},\n "ngay_giao": {"type": "date"},\n "han_tra": {"type": "date"},\n "ngay_tra": {"type": "date"},\n "tinh_trang_tra": {\n "type": "select",\n "options": [\n {"alias": "tot", "color": "green"},\n {"alias": "tray_xuoc", "color": "amber"},\n {"alias": "hu_hong", "color": "red"}\n ]\n },\n "so_ngay": {"type": "formula"},\n "tong_tien": {"type": "rollup"}\n },\n "records": {\n "subtitle": ["so_phieu"],\n "figure": "tong_tien",\n "due": ["han_tra"],\n "status": {"field": "trang_thai", "closed": ["da_tra", "huy"], "dates": {"da_tra": "ngay_tra"}}\n }\n }\n ],\n "body": {\n "type": "App",\n "key": "tien_do_thue",\n "name": "Ti\u1EBFn \u0111\u1ED9 cho thu\xEA",\n "icon": "calendar-range",\n "color": "teal",\n "children": [\n {\n "type": "List",\n "entity": "phieu_thue",\n "columns": ["phu_trach"],\n "filters": ["phu_trach", "khach_hang"],\n "layout": {"gantt": {"start": "ngay_giao"}},\n "create": false,\n "remove": false\n }\n ],\n "pages": [\n {\n "type": "Record",\n "entity": "phieu_thue",\n "children": [\n {\n "type": "Section",\n "key": "phieu_thue",\n "title": "Phi\u1EBFu thu\xEA",\n "children": ["ngay_giao", "han_tra"]\n },\n {\n "type": "Section",\n "key": "dang_thue",\n "title": "\u0110ang thu\xEA",\n "at": ["dang_thue"],\n "children": [\n "so_ngay",\n {"field": "ngay_tra", "edit": false},\n {\n "type": "Act",\n "key": "nhan_tra",\n "label": "Nh\u1EADn m\xE1y tr\u1EA3",\n "when": {"trang_thai": ["dang_thue"]},\n "asks": ["tinh_trang_tra"],\n "set": {"trang_thai": "da_tra"},\n "confirm": true\n },\n {\n "type": "Act",\n "key": "mo_lai",\n "label": "M\u1EDF l\u1EA1i",\n "when": {"trang_thai": ["da_tra"]},\n "set": {"trang_thai": "dang_thue"},\n "confirm": true\n }\n ]\n }\n ]\n }\n ]\n }\n}\n```\n\n## Roster\n\n**The job.** See who works which shift on each day of the week or the month.\n\n**Read.** `layout: "roster"` over the people; the child List (`lich_truc`) is the rows that fill the days \u2014 one link back and a date on its line.\n\n**Keys.** `reference/roster`\n\n**Not when.** Rows that are themselves the bookings (a stay over several days) \u2014 a `calendar` or `lanes` draws them; a roster\'s row is what the days are filled for.\n\n```json\n{\n "tables": [\n {\n "ref": "nha_si",\n "title": "ho_ten",\n "fields": {\n "ho_ten": {"type": "text"},\n "chuyen_mon": {\n "type": "select",\n "options": [\n {"alias": "tong_quat", "color": "blue"},\n {"alias": "chinh_nha", "color": "purple"},\n {"alias": "nha_chu", "color": "green"},\n {"alias": "phuc_hinh", "color": "orange"}\n ]\n },\n "dien_thoai": {"type": "text"},\n "ngay_lam": {\n "type": "select",\n "options": [\n {"alias": "mon", "color": "blue"},\n {"alias": "tue", "color": "blue"},\n {"alias": "wed", "color": "blue"},\n {"alias": "thu", "color": "blue"},\n {"alias": "fri", "color": "blue"},\n {"alias": "sat", "color": "blue"},\n {"alias": "sun", "color": "blue"}\n ],\n "multi": true\n },\n "tu_ngay": {"type": "date"}\n },\n "records": {\n "subtitle": ["chuyen_mon"],\n "party": "person",\n "cadence": [{"entity": "lich_truc", "on": "ngay_lam", "from": "tu_ngay", "planned": "ke_hoach"}]\n }\n },\n {\n "ref": "lich_truc",\n "title": "ca",\n "fields": {\n "nha_si": {"type": "link", "table": "nha_si", "multi": false},\n "ca": {\n "type": "select",\n "options": [\n {"alias": "sang", "color": "blue"},\n {"alias": "chieu", "color": "purple"},\n {"alias": "ca_ngay", "color": "green"},\n {"alias": "nghi", "color": "gray"}\n ]\n },\n "ngay": {"type": "date"},\n "ghe": {"type": "link", "table": "ghe", "multi": false},\n "ke_hoach": {"type": "date"}\n },\n "records": {"subtitle": ["ngay", "ghe"], "mark": "ca"}\n }\n ],\n "body": {\n "type": "App",\n "key": "lich_truc",\n "name": "L\u1ECBch tr\u1EF1c",\n "icon": "users",\n "color": "indigo",\n "children": [\n {\n "type": "List",\n "entity": "nha_si",\n "filters": ["chuyen_mon"],\n "layout": "roster",\n "create": ["ho_ten", "chuyen_mon", "dien_thoai"],\n "children": [\n {"type": "List", "entity": "lich_truc", "create": true, "remove": true},\n {"type": "Act", "key": "tao_ca_truc_ds", "label": "T\u1EA1o ca tr\u1EF1c", "on": "view", "makes": "lich_truc"},\n {\n "type": "Export",\n "key": "lich_truc_thang",\n "label": "L\u1ECBch tr\u1EF1c th\xE1ng",\n "template": "lich_truc_thang"\n }\n ]\n }\n ],\n "pages": [\n {\n "type": "Record",\n "entity": "nha_si",\n "children": [\n {\n "type": "Section",\n "key": "lich_tuan",\n "title": "L\u1ECBch tr\u1EF1c m\u1ED7i tu\u1EA7n",\n "children": [\n "ngay_lam",\n "tu_ngay",\n {"type": "Act", "key": "tao_ca_truc", "label": "T\u1EA1o ca tr\u1EF1c", "makes": "lich_truc"}\n ]\n }\n ]\n },\n {"type": "Record", "entity": "lich_truc"},\n {"type": "Record", "entity": "ghe", "add": ["ten", "phong"]}\n ]\n }\n}\n```\n\n## Cards\n\n**The job.** Find an item by its picture, and count what the shelf holds.\n\n**Read.** `layout: "cards"` over rows whose `records.image` is a photo; `scope` keeps the app inside one warehouse at a time.\n\n**Keys.** `reference/cards`, `reference/records`, `reference/app-node`\n\n**Not when.** Rows with no picture \u2014 cards of words are a table drawn worse.\n\n```json\n{\n "tables": [\n {\n "ref": "stock_item",\n "title": "name",\n "fields": {\n "name": {"type": "text"},\n "warehouse": {"type": "link", "table": "warehouse", "multi": false},\n "photo": {"type": "files"},\n "sku": {"type": "text"},\n "category": {\n "type": "select",\n "options": [\n {"alias": "pumps", "color": "blue"},\n {"alias": "valves", "color": "teal"},\n {"alias": "seals", "color": "amber"},\n {"alias": "motors", "color": "violet"}\n ]\n },\n "on_hand": {"type": "number"},\n "minimum": {"type": "number"},\n "price": {"type": "number", "notation": {"style": "currency", "currency": "USD"}},\n "supplier_page": {"type": "text", "format": "link"},\n "last_counted": {"type": "date"},\n "counted_by": {"type": "member"},\n "count_note": {"type": "text"}\n },\n "records": {\n "subtitle": ["sku", "category"],\n "image": "photo",\n "figure": "on_hand",\n "limits": {"on_hand": 400},\n "gates": {"on_hand": "minimum"}\n }\n },\n {\n "ref": "order_line",\n "title": "item",\n "fields": {\n "item": {"type": "link", "table": "stock_item", "multi": false},\n "order": {"type": "link", "table": "order", "multi": false},\n "quantity": {"type": "number"},\n "shipped": {"type": "number"},\n "picked": {"type": "number"},\n "unit_price": {"type": "number", "notation": {"style": "currency", "currency": "USD"}},\n "amount": {"type": "formula", "notation": {"style": "currency", "currency": "USD"}},\n "settled": {"type": "formula"},\n "category": {"type": "lookup"}\n },\n "records": {\n "subtitle": ["order", "unit_price"],\n "figure": "amount",\n "limits": {"shipped": "quantity", "picked": "quantity"}\n }\n }\n ],\n "body": {\n "type": "App",\n "key": "stock",\n "name": "Stock",\n "icon": "boxes",\n "color": "teal",\n "rows": {\n "customer": {"any": [{"member_of": "sales"}]},\n "order": {"any": [{"member_of": "sales"}, {"member_of": "stores"}]},\n "order_line": {"any": [{"member_of": "sales"}, {"member_of": "stores"}]},\n "payment": {"any": [{"member_of": "sales"}, {"member_of": "stores"}]}\n },\n "scope": "warehouse",\n "children": [\n {\n "type": "List",\n "entity": "stock_item",\n "filters": ["on_hand"],\n "search": ["name", "sku"],\n "layout": "cards",\n "children": [\n {"type": "Reading", "key": "register_reading_0", "value": "on_hand", "by": "category"},\n {"type": "Export", "key": "export"}\n ]\n }\n ],\n "pages": [\n {\n "type": "Record",\n "entity": "stock_item",\n "children": [\n {\n "type": "Section",\n "key": "item",\n "title": "Item",\n "children": ["price", "minimum", "supplier_page"]\n },\n {\n "type": "Section",\n "key": "last_count",\n "title": "Last count",\n "children": [\n "last_counted",\n "counted_by",\n "count_note",\n {\n "type": "Act",\n "key": "count",\n "label": "Count stock",\n "asks": [\n {"input": "counted", "label": "Units on the shelf", "type": "number", "required": true},\n {"input": "remark", "label": "Remark", "type": "long_text"}\n ],\n "set": {\n "on_hand": {"input": "counted"},\n "last_counted": {"now": true},\n "counted_by": {"me": true},\n "count_note": {"input": "remark"}\n }\n }\n ]\n },\n {\n "type": "Section",\n "key": "on_order",\n "title": "On order",\n "children": [{"type": "List", "entity": "order_line"}]\n }\n ]\n },\n {\n "type": "Record",\n "entity": "order_line",\n "children": ["quantity", "shipped", {"type": "Check", "field": "settled", "on": ["update"]}]\n },\n {"type": "Record", "entity": "customer", "add": ["name", "credit_limit"]}\n ]\n }\n}\n```\n\n## Party\n\n**The job.** Keep each customer account \u2014 who they are, what they ordered, what was said to them.\n\n**Read.** `records.customer.party: "organization"` and its `image` (the logo); a List with `layout: "timeline"` for the touches, a Reading `by` the day placed for its orders, and its papers `expect`ed by kind.\n\n**Keys.** `reference/records`, `reference/layouts`, `reference/list-node`, `reference/reading-node`\n\n**Not when.** A list of customers is not a job by itself: the customer is a link on the desk whose rows name it, unless the job is the account itself.\n\n```json\n{\n "tables": [\n {\n "ref": "customer",\n "title": "name",\n "fields": {\n "name": {"type": "text"},\n "logo": {"type": "files"},\n "code": {"type": "text"},\n "tier": {\n "type": "select",\n "options": [\n {"alias": "key", "color": "violet"},\n {"alias": "standard", "color": "sky"},\n {"alias": "lapsed", "color": "gray"}\n ]\n },\n "phone": {"type": "text"},\n "website": {"type": "text", "format": "link"},\n "account_manager": {"type": "member"},\n "credit_limit": {"type": "number", "notation": {"style": "currency", "currency": "USD"}},\n "orders": {"type": "link", "table": "order", "multi": true},\n "outstanding": {"type": "rollup"},\n "over_limit": {"type": "formula"},\n "papers_needed": {\n "type": "select",\n "options": [\n {"alias": "credit_application", "color": "blue"},\n {"alias": "trade_reference", "color": "violet"},\n {"alias": "vat_certificate", "color": "teal"}\n ],\n "multi": true\n },\n "notes": {"type": "text", "format": "markdown"}\n },\n "records": {\n "subtitle": ["tier"],\n "image": "logo",\n "party": "organization",\n "figure": "outstanding",\n "limits": {"outstanding": "credit_limit"}\n }\n },\n {\n "ref": "order",\n "title": "reference",\n "fields": {\n "customer": {"type": "link", "table": "customer", "multi": false},\n "reference": {"type": "text"},\n "stage": {\n "type": "select",\n "options": [\n {"alias": "draft", "color": "slate"},\n {"alias": "confirmed", "color": "blue"},\n {"alias": "picking", "color": "amber"},\n {"alias": "shipped", "color": "indigo"},\n {"alias": "received", "color": "green"},\n {"alias": "cancelled", "color": "rose"}\n ]\n },\n "placed": {"type": "date"},\n "due_date": {"type": "date"},\n "handler": {"type": "member"},\n "priority": {"type": "boolean"},\n "lines": {"type": "link", "table": "order_line", "multi": true},\n "payments": {"type": "link", "table": "payment", "multi": true},\n "total": {"type": "rollup"},\n "balance": {"type": "formula", "notation": {"style": "currency", "currency": "USD"}},\n "units_ordered": {"type": "rollup"},\n "units_shipped": {"type": "rollup"},\n "units_picked": {"type": "rollup"},\n "carrier": {"type": "text"},\n "tracking_no": {"type": "text"},\n "shipped_on": {"type": "date"},\n "cancellation_reason": {"type": "text"},\n "cancelled_by": {"type": "member"},\n "replaced_by": {"type": "link", "table": "order", "multi": false},\n "attachments": {"type": "files"},\n "delivery_note": {"type": "files"},\n "notes": {"type": "text", "format": "markdown"},\n "paid_in_full": {"type": "formula"},\n "has_payments": {"type": "formula"},\n "reminder_ref": {"type": "text"}\n },\n "records": {\n "subtitle": ["customer", "placed"],\n "figure": "total",\n "limits": {"units_shipped": "units_ordered", "units_picked": "units_ordered"},\n "due": ["due_date"],\n "status": {\n "field": "stage",\n "closed": ["received", "cancelled"],\n "dates": {"shipped": "shipped_on"},\n "history": "order_stage"\n }\n }\n },\n {\n "ref": "customer_paper",\n "title": "kind",\n "fields": {\n "kind": {\n "type": "select",\n "options": [\n {"alias": "credit_application", "color": "blue"},\n {"alias": "trade_reference", "color": "violet"},\n {"alias": "vat_certificate", "color": "teal"}\n ]\n },\n "customer": {"type": "link", "table": "customer", "multi": false},\n "received_on": {"type": "date"},\n "file": {"type": "files"}\n },\n "records": {"image": "file"}\n },\n {\n "ref": "touch",\n "title": "said",\n "fields": {\n "said": {"type": "text"},\n "customer": {"type": "link", "table": "customer", "multi": false},\n "on": {"type": "date"},\n "by": {"type": "member"}\n }\n }\n ],\n "body": {\n "type": "App",\n "key": "customers",\n "name": "Customers",\n "icon": "users",\n "color": "violet",\n "rows": {\n "customer": {"any": [{"member_of": "sales"}]},\n "order": {"any": [{"member_of": "sales"}, {"member_of": "stores"}]},\n "order_line": {"any": [{"member_of": "sales"}, {"member_of": "stores"}]},\n "payment": {"any": [{"member_of": "sales"}, {"member_of": "stores"}]},\n "touch": {"any": [{"member_of": "sales"}]},\n "customer_paper": {"any": [{"member_of": "sales"}]},\n "service_visit": {"any": [{"member_of": "sales"}, {"member_of": "stores"}, {"member_of": "field"}]}\n },\n "children": [\n {\n "type": "List",\n "entity": "customer",\n "columns": ["phone", "account_manager"],\n "filters": ["account_manager"],\n "sort": {"field": "name"},\n "opens": {"tier": ["key", "standard"]},\n "create": ["name", "code", "credit_limit"],\n "children": [{"type": "Reading", "key": "register_reading_1", "value": "outstanding", "by": "account_manager"}]\n }\n ],\n "pages": [\n {\n "type": "Record",\n "entity": "customer",\n "door": "drawer",\n "children": [\n {"type": "Section", "key": "contact", "title": "Contact", "children": ["phone", "website"]},\n {\n "type": "Section",\n "key": "account",\n "title": "Account",\n "children": [\n "code",\n "account_manager",\n "credit_limit",\n {\n "type": "Act",\n "key": "reassign",\n "label": "Reassign",\n "asks": [{"input": "to", "label": "Account manager", "type": "member", "required": true}],\n "set": {"account_manager": {"input": "to"}}\n },\n {\n "type": "Act",\n "key": "lapse",\n "label": "Mark lapsed",\n "when": {"tier": ["key", "standard"]},\n "set": {"tier": "lapsed"},\n "confirm": true\n },\n {\n "type": "Act",\n "key": "reinstate",\n "label": "Reinstate",\n "when": {"tier": ["lapsed"]},\n "asks": [\n {\n "input": "back_to",\n "label": "Back to",\n "type": "select",\n "options": [\n {\n "alias": "key",\n "label": "Key account",\n "color": "violet",\n "mark": {"kind": "icon", "name": "building-2"}\n },\n {"alias": "standard", "label": "Standard", "color": "sky"}\n ],\n "required": true\n }\n ],\n "set": {"tier": {"input": "back_to"}}\n }\n ]\n },\n {\n "type": "Section",\n "key": "orders",\n "title": "Orders",\n "children": [\n {\n "type": "Reading",\n "key": "block_reading_0",\n "label": "Order value",\n "entity": "order",\n "value": "total",\n "where": {"stage": ["confirmed", "picking", "shipped", "received"]},\n "by": "placed"\n },\n {\n "type": "List",\n "entity": "order",\n "where": {"stage": ["draft", "confirmed", "picking", "shipped"]},\n "label": "Open orders",\n "columns": ["due_date"],\n "create": false\n },\n {\n "type": "List",\n "key": "order_2",\n "entity": "order",\n "where": {"stage": ["shipped", "received"], "paid_in_full": false},\n "label": "Shipped, still owed",\n "columns": ["balance"],\n "create": false\n },\n {\n "type": "List",\n "key": "block_reading_3",\n "entity": "service_visit",\n "columns": ["engineer", "job"],\n "edit": false\n }\n ]\n },\n {\n "type": "Section",\n "key": "account_papers",\n "title": "Account papers",\n "children": [\n {\n "type": "List",\n "entity": "customer_paper",\n "expect": {"field": "kind", "of": "papers_needed"},\n "columns": ["received_on"]\n }\n ]\n },\n {\n "type": "Section",\n "key": "contact_log",\n "title": "Contact log",\n "children": [{"type": "List", "entity": "touch", "layout": "timeline"}]\n },\n {"type": "Section", "key": "notes", "title": "Notes", "children": ["notes"]},\n {"type": "Check", "field": "over_limit"}\n ]\n },\n {\n "type": "Record",\n "entity": "order",\n "children": [\n "due_date",\n "handler",\n {"field": "priority", "edit": false},\n "lines",\n "payments",\n {"field": "carrier", "edit": false},\n {"field": "tracking_no", "edit": false},\n {"field": "shipped_on", "edit": false},\n {"field": "cancellation_reason", "edit": false},\n {"field": "cancelled_by", "edit": false},\n {"field": "replaced_by", "edit": false},\n {"field": "attachments", "edit": false},\n "delivery_note",\n "notes",\n {"field": "reminder_ref", "edit": false},\n {"type": "Check", "field": "paid_in_full", "on": ["update"]},\n {"type": "Check", "field": "has_payments"}\n ]\n },\n {"type": "Record", "entity": "warehouse", "add": ["name", "city"]},\n {"type": "Record", "entity": "stock_item", "add": ["name", "warehouse", "sku", "category"]},\n {"type": "Record", "entity": "order_line", "add": ["item", "quantity"]}\n ]\n }\n}\n```\n\n## Case\n\n**The job.** Gather an applicant\'s papers into one case, make the forms it needs, and file it on time.\n\n**Read.** Lists with `expect` for the papers brought (one line per kind, the missing ones empty), an Act\'s `templates` for the forms made (ticked and made at once, kept in `into`), and `intake` reading the papers brought.\n\n**Keys.** `reference/list-node`, `reference/act-node`\n\n**Not when.** A record that needs no papers, or one paper made once \u2014 a single `template` act.\n\n```json\n{\n "tables": [\n {\n "ref": "ho_so",\n "title": "khach_hang",\n "fields": {\n "khach_hang": {"type": "link", "table": "khach_hang", "multi": false},\n "du_an": {"type": "link", "table": "du_an", "multi": false},\n "ma_ho_so": {"type": "autonumber"},\n "dich_vu": {\n "type": "select",\n "options": [{"alias": "tron_goi", "color": "blue"}, {"alias": "lam_ho_so", "color": "violet"}]\n },\n "doi_tuong": {\n "type": "select",\n "options": [\n {"alias": "thu_nhap_thap", "color": "sky"},\n {"alias": "cong_nhan", "color": "teal"},\n {"alias": "can_bo", "color": "indigo"},\n {"alias": "luc_luong", "color": "green"},\n {"alias": "ho_ngheo", "color": "amber"},\n {"alias": "nguoi_co_cong", "color": "rose"}\n ]\n },\n "tinh_trang_nha_o": {\n "type": "select",\n "options": [{"alias": "chua_co_nha", "color": "gray"}, {"alias": "nha_chat", "color": "orange"}]\n },\n "giay_chung_nhan_so": {"type": "text"},\n "dien_tich_nha": {"type": "number"},\n "sale": {"type": "member"},\n "xu_ly": {"type": "member"},\n "can_bo_sung": {"type": "boolean"},\n "phi_dich_vu": {"type": "number", "notation": {"style": "currency", "currency": "VND"}},\n "loai_can": {\n "type": "select",\n "options": [\n {"alias": "studio", "color": "sky"},\n {"alias": "mot_pn", "color": "blue"},\n {"alias": "hai_pn", "color": "indigo"},\n {"alias": "ba_pn", "color": "violet"}\n ]\n },\n "giai_doan": {\n "type": "select",\n "options": [\n {"alias": "ngay_thu_phi", "color": "blue"},\n {"alias": "ngay_nhan_giay_to", "color": "blue"},\n {"alias": "ngay_lap_ho_so", "color": "blue"},\n {"alias": "ngay_nop_cdt", "color": "blue"},\n {"alias": "ngay_cdt_duyet", "color": "blue"},\n {"alias": "ngay_so_xd_duyet", "color": "blue"},\n {"alias": "ngay_boc_tham", "color": "blue"},\n {"alias": "ngay_ky_hdmb", "color": "green"},\n {"alias": "ngay_ban_giao", "color": "green"}\n ]\n },\n "ngay_thu_phi": {"type": "date"},\n "ngay_nhan_giay_to": {"type": "date"},\n "ngay_lap_ho_so": {"type": "date"},\n "ngay_nop_cdt": {"type": "date"},\n "ngay_cdt_duyet": {"type": "date"},\n "ngay_so_xd_duyet": {"type": "date"},\n "ngay_boc_tham": {"type": "date"},\n "ngay_ky_hdmb": {"type": "date"},\n "ngay_ban_giao": {"type": "date"},\n "bo_ho_so": {"type": "files"},\n "giay_to": {"type": "link", "table": "giay_to", "multi": true},\n "thanh_vien": {"type": "link", "table": "thanh_vien", "multi": true},\n "phieu_thu": {"type": "link", "table": "phieu_thu", "multi": true},\n "dien_thoai": {"type": "lookup"},\n "cccd": {"type": "lookup"},\n "ngay_sinh": {"type": "lookup"},\n "da_thu": {"type": "rollup"},\n "chua_thu_phi": {"type": "formula"},\n "con_no_phi": {"type": "formula"},\n "vuot_thu_nhap": {"type": "formula"},\n "da_hoan_tat": {"type": "formula"}\n },\n "records": {\n "subtitle": ["dich_vu"],\n "figure": "phi_dich_vu",\n "status": {\n "field": "giai_doan",\n "closed": ["ngay_ky_hdmb", "ngay_ban_giao"],\n "dates": {\n "ngay_thu_phi": "ngay_thu_phi",\n "ngay_nhan_giay_to": "ngay_nhan_giay_to",\n "ngay_lap_ho_so": "ngay_lap_ho_so",\n "ngay_nop_cdt": "ngay_nop_cdt",\n "ngay_cdt_duyet": "ngay_cdt_duyet",\n "ngay_so_xd_duyet": "ngay_so_xd_duyet",\n "ngay_boc_tham": "ngay_boc_tham",\n "ngay_ky_hdmb": "ngay_ky_hdmb",\n "ngay_ban_giao": "ngay_ban_giao"\n }\n }\n }\n },\n {\n "ref": "thanh_vien",\n "title": "ho_ten",\n "fields": {\n "ho_ten": {"type": "text"},\n "ho_so": {"type": "link", "table": "ho_so", "multi": false},\n "quan_he": {\n "type": "select",\n "options": [\n {"alias": "nguoi_dung_don", "color": "blue"},\n {"alias": "vo_chong", "color": "violet"},\n {"alias": "con", "color": "teal"},\n {"alias": "bo_me", "color": "amber"},\n {"alias": "khac", "color": "gray"}\n ]\n },\n "ngay_sinh": {"type": "date"},\n "cccd": {"type": "text"},\n "thu_nhap": {"type": "number", "notation": {"style": "currency", "currency": "VND"}}\n },\n "records": {"subtitle": ["quan_he", "cccd"], "party": "person", "figure": "thu_nhap"}\n },\n {\n "ref": "giay_to",\n "title": "loai",\n "fields": {\n "loai": {\n "type": "select",\n "options": [\n {"alias": "don_dang_ky", "color": "blue"},\n {"alias": "can_cuoc", "color": "sky"},\n {"alias": "giay_doi_tuong", "color": "violet"},\n {"alias": "xac_nhan_nha_o", "color": "teal"},\n {"alias": "xac_nhan_thu_nhap", "color": "amber"},\n {"alias": "hon_nhan", "color": "indigo"}\n ]\n },\n "ho_so": {"type": "link", "table": "ho_so", "multi": false},\n "ngay_nhan": {"type": "date"},\n "tep": {"type": "files"}\n },\n "records": {"image": "tep", "starts": {"ngay_nhan": "today"}}\n },\n {\n "ref": "phieu_thu",\n "title": "khoan",\n "fields": {\n "khoan": {\n "type": "select",\n "options": [\n {"alias": "dat_coc", "color": "blue"},\n {"alias": "tat_toan", "color": "indigo"},\n {"alias": "phi_ho_so", "color": "violet"}\n ]\n },\n "ho_so": {"type": "link", "table": "ho_so", "multi": false},\n "so_tien": {"type": "number", "notation": {"style": "currency", "currency": "VND"}},\n "hinh_thuc": {\n "type": "select",\n "options": [\n {"alias": "tien_mat", "color": "green", "mark": {"kind": "icon", "name": "banknote"}},\n {"alias": "chuyen_khoan", "color": "blue", "mark": {"kind": "icon", "name": "arrow-right-left"}}\n ]\n },\n "trang_thai": {\n "type": "select",\n "options": [\n {"alias": "cho_thu", "color": "amber"},\n {"alias": "da_thu", "color": "green"},\n {"alias": "huy", "color": "gray"}\n ]\n },\n "ngay_thu": {"type": "date"}\n },\n "records": {\n "subtitle": ["hinh_thuc", "ngay_thu"],\n "figure": "so_tien",\n "status": {"field": "trang_thai", "closed": ["da_thu", "huy"]}\n }\n }\n ],\n "templates": [\n {"alias": "don_dang_ky", "type": "html", "label": "\u0110\u01A1n \u0111\u0103ng k\xFD mua nh\xE0 \u1EDF x\xE3 h\u1ED9i"},\n {"alias": "mau_02_chua_co_nha", "type": "html", "label": "M\u1EABu 02 \u2014 X\xE1c nh\u1EADn ch\u01B0a c\xF3 nh\xE0 \u1EDF"},\n {"alias": "mau_03_nha_chat", "type": "html", "label": "M\u1EABu 03 \u2014 X\xE1c nh\u1EADn nh\xE0 \u1EDF d\u01B0\u1EDBi 15 m\xB2/ng\u01B0\u1EDDi"},\n {"alias": "mau_05_thu_nhap", "type": "html", "label": "M\u1EABu 05 \u2014 X\xE1c nh\u1EADn thu nh\u1EADp"},\n {"alias": "danh_sach_nop", "type": "html", "label": "Danh s\xE1ch h\u1ED3 s\u01A1 n\u1ED9p ch\u1EE7 \u0111\u1EA7u t\u01B0"}\n ],\n "body": {\n "type": "App",\n "key": "ho_so",\n "name": "H\u1ED3 s\u01A1 nh\xE0 \u1EDF x\xE3 h\u1ED9i",\n "icon": "folder-open",\n "color": "blue",\n "scope": "du_an",\n "folders": "cac_du_an",\n "children": [\n {\n "type": "List",\n "entity": "ho_so",\n "columns": ["can_bo_sung", "doi_tuong", "xu_ly"],\n "filters": ["xu_ly", "can_bo_sung"],\n "search": ["khach_hang", "ma_ho_so", "dien_thoai"],\n "create": ["khach_hang", "dich_vu", "doi_tuong", "tinh_trang_nha_o", "loai_can", "phi_dich_vu", "sale"],\n "children": [\n {\n "type": "Reading",\n "key": "register_reading_0",\n "label": "Ch\u1EDD kh\xE1ch b\u1ED5 sung",\n "where": {"can_bo_sung": true}\n },\n {\n "type": "Reading",\n "key": "register_reading_1",\n "label": "Ph\xED \u0111\xE3 thu",\n "value": "da_thu",\n "over": "ngay_nhan_giay_to"\n },\n {"type": "Reading", "key": "register_reading_2", "by": "doi_tuong"},\n {"type": "Export", "key": "export"},\n {\n "type": "Act",\n "key": "in_danh_sach",\n "label": "In danh s\xE1ch n\u1ED9p ch\u1EE7 \u0111\u1EA7u t\u01B0",\n "on": "view",\n "template": "danh_sach_nop"\n }\n ]\n },\n {\n "type": "List",\n "entity": "du_an",\n "key": "cac_du_an",\n "columns": ["han_nop"],\n "create": false,\n "sort": {"field": "han_nop"},\n "children": [{"type": "Reading", "key": "du_an_theo_trang_thai", "by": "trang_thai"}]\n }\n ],\n "pages": [\n {\n "type": "Record",\n "entity": "ho_so",\n "children": [\n {\n "type": "Section",\n "key": "nguoi_dung_don",\n "title": "Ng\u01B0\u1EDDi \u0111\u1EE9ng \u0111\u01A1n",\n "children": [\n "ma_ho_so",\n {"field": "khach_hang", "block": true, "label": "Th\xF4ng tin c\xE1 nh\xE2n"},\n {\n "type": "Fieldset",\n "key": "dieu_kien",\n "label": "\u0110i\u1EC1u ki\u1EC7n mua",\n "children": ["doi_tuong", "tinh_trang_nha_o"]\n },\n {\n "type": "Fieldset",\n "key": "phu_trach",\n "label": "Ph\u1EE5 tr\xE1ch",\n "children": ["sale", "xu_ly", "can_bo_sung", "phi_dich_vu"]\n },\n {\n "type": "List",\n "entity": "thanh_vien",\n "label": "H\u1ED9 gia \u0111\xECnh",\n "columns": ["ngay_sinh"],\n "create": ["ho_ten", "quan_he", "ngay_sinh", "cccd", "thu_nhap"]\n },\n {\n "type": "List",\n "entity": "giay_to",\n "expect": {"field": "loai", "only": ["can_cuoc", "hon_nhan"]},\n "label": "Gi\u1EA5y t\u1EDD c\xE1 nh\xE2n",\n "columns": ["ngay_nhan"]\n },\n {\n "type": "Act",\n "key": "doc_giay_to",\n "label": "\u0110\u1ECDc gi\u1EA5y t\u1EDD",\n "intake": "giay_to",\n "fills": [\n "doi_tuong",\n "tinh_trang_nha_o",\n "giay_chung_nhan_so",\n "dien_tich_nha",\n "khach_hang.ho_ten",\n "khach_hang.cccd",\n "khach_hang.ngay_sinh",\n "khach_hang.dia_chi",\n "thanh_vien"\n ]\n },\n {\n "type": "Act",\n "key": "giao_xu_ly",\n "label": "Giao ng\u01B0\u1EDDi x\u1EED l\xFD",\n "asks": [{"input": "nguoi", "label": "Ng\u01B0\u1EDDi x\u1EED l\xFD", "type": "member", "required": true}],\n "set": {"xu_ly": {"input": "nguoi"}}\n },\n {\n "type": "Act",\n "key": "chuyen_du_an",\n "label": "Chuy\u1EC3n d\u1EF1 \xE1n",\n "asks": [\n {\n "input": "du_an_moi",\n "label": "Sang d\u1EF1 \xE1n",\n "type": "link",\n "entity": "du_an",\n "required": true\n }\n ],\n "set": {"du_an": {"input": "du_an_moi"}},\n "confirm": true\n }\n ]\n },\n {\n "type": "Section",\n "key": "bo_ho_so",\n "title": "B\u1ED9 h\u1ED3 s\u01A1",\n "at": ["ngay_nhan_giay_to", "ngay_lap_ho_so"],\n "children": [\n "ngay_nhan_giay_to",\n "ngay_lap_ho_so",\n {\n "type": "Act",\n "key": "tao_giay_to",\n "label": "T\u1EA1o gi\u1EA5y t\u1EDD",\n "templates": [\n {"template": "don_dang_ky"},\n {"template": "mau_02_chua_co_nha", "when": {"tinh_trang_nha_o": ["chua_co_nha"]}},\n {"template": "mau_03_nha_chat", "when": {"tinh_trang_nha_o": ["nha_chat"]}}\n ],\n "into": "bo_ho_so",\n "when": {"giai_doan": ["ngay_nhan_giay_to", "ngay_lap_ho_so"]}\n },\n {\n "type": "Act",\n "key": "nop_cdt",\n "label": "N\u1ED9p ch\u1EE7 \u0111\u1EA7u t\u01B0",\n "when": {"dich_vu": ["tron_goi"], "giai_doan": ["ngay_lap_ho_so"]},\n "requires": ["bo_ho_so", "loai_can"],\n "asks": ["loai_can"],\n "set": {"giai_doan": "ngay_nop_cdt"},\n "confirm": true\n },\n {\n "type": "Act",\n "key": "to_ngay_nhan_giay_to",\n "label": "\u0110\xE3 nh\u1EADn gi\u1EA5y t\u1EDD",\n "when": {"giai_doan": {"empty": true}, "dich_vu": ["tron_goi"]},\n "asks": [{"field": "ngay_nhan_giay_to", "starts": "today"}],\n "set": {"giai_doan": "ngay_nhan_giay_to"}\n },\n {\n "type": "Act",\n "key": "to_ngay_lap_ho_so",\n "label": "\u0110\xE3 l\u1EADp h\u1ED3 s\u01A1",\n "when": {"giai_doan": ["ngay_nhan_giay_to"], "dich_vu": ["tron_goi"]},\n "asks": [{"field": "ngay_lap_ho_so", "starts": "today"}],\n "set": {"giai_doan": "ngay_lap_ho_so"}\n },\n {\n "type": "Act",\n "key": "to_ngay_ban_giao",\n "label": "\u0110\xE3 b\xE0n giao h\u1ED3 s\u01A1",\n "when": {"giai_doan": ["ngay_nhan_giay_to"], "dich_vu": ["lam_ho_so"]},\n "asks": [{"field": "ngay_ban_giao", "starts": "today"}],\n "set": {"giai_doan": "ngay_ban_giao"}\n }\n ]\n },\n {\n "type": "Act",\n "key": "lap_mau_05",\n "label": "L\u1EADp m\u1EABu 05",\n "when": {"doi_tuong": ["thu_nhap_thap"]},\n "template": "mau_05_thu_nhap",\n "paper": "giay_to.xac_nhan_thu_nhap"\n },\n {"type": "Check", "field": "chua_thu_phi", "on": ["nop_cdt"]},\n {"type": "Check", "field": "con_no_phi"},\n {"type": "Check", "field": "vuot_thu_nhap"},\n {"type": "Check", "field": "da_hoan_tat", "on": ["doc_giay_to"]}\n ],\n "row": {"figure": false}\n },\n {"type": "Record", "entity": "du_an", "add": ["ten_du_an", "chu_dau_tu", "so_can"]}\n ]\n }\n}\n```\n\n## Calls\n\n**The job.** Call a lead from their record, and keep what was said as a touch on its timeline.\n\n**Read.** An Act\'s `record` (into the `timeline` child: audio, transcript, when and who) and `fills` (the touch\'s fields an agent fills from the transcript).\n\n**Keys.** `reference/act-node`, `reference/layouts`\n\n**Not when.** Calls made and logged elsewhere \u2014 a `timeline` with its own add keeps the note.\n\n```json\n{\n "tables": [\n {\n "ref": "khach_tiem_nang",\n "title": "ho_ten",\n "fields": {\n "ho_ten": {"type": "text"},\n "ten_cong_ty": {"type": "text"},\n "vai_tro": {\n "type": "select",\n "options": [\n {"alias": "chu_doanh_nghiep", "color": "emerald"},\n {"alias": "ke_toan_truong", "color": "blue"},\n {"alias": "quan_ly", "color": "teal"},\n {"alias": "nhan_vien", "color": "sky"},\n {"alias": "chua_ro", "color": "zinc"}\n ]\n },\n "loai_hinh": {\n "type": "select",\n "options": [\n {"alias": "thuong_mai", "color": "blue"},\n {"alias": "san_xuat", "color": "amber"},\n {"alias": "dich_vu", "color": "violet"},\n {"alias": "xay_dung", "color": "orange"},\n {"alias": "ho_kinh_doanh", "color": "teal"},\n {"alias": "chua_ro", "color": "zinc"}\n ]\n },\n "quy_mo": {\n "type": "select",\n "options": [\n {"alias": "q_1_10", "color": "sky"},\n {"alias": "q_11_50", "color": "blue"},\n {"alias": "q_51_200", "color": "indigo"},\n {"alias": "q_200", "color": "violet"},\n {"alias": "chua_ro", "color": "zinc"}\n ]\n },\n "so_dien_thoai": {"type": "text"},\n "zalo": {"type": "text"},\n "email": {"type": "text"},\n "trang_ca_nhan": {"type": "text", "format": "link"},\n "anh": {"type": "files"},\n "trang_thai": {\n "type": "select",\n "options": [\n {"alias": "moi", "color": "gray"},\n {"alias": "du_dieu_kien", "color": "blue"},\n {"alias": "da_lien_he", "color": "amber"},\n {"alias": "da_chuyen_doi", "color": "emerald"},\n {"alias": "loai", "color": "red"}\n ]\n },\n "ly_do_loai": {\n "type": "select",\n "options": [\n {"alias": "khong_phu_hop", "color": "orange"},\n {"alias": "qua_nho", "color": "amber"},\n {"alias": "chua_co_ngan_sach", "color": "yellow"},\n {"alias": "sai_nguoi", "color": "blue"},\n {"alias": "yeu_cau_dung", "color": "red"},\n {"alias": "trung", "color": "zinc"}\n ]\n },\n "vi_sao_du_dieu_kien": {"type": "text"},\n "phu_trach": {"type": "member"},\n "nguon": {"type": "link", "table": "kenh", "multi": false},\n "lien_he": {"type": "link", "table": "lien_he", "multi": false},\n "cong_ty": {"type": "link", "table": "cong_ty", "multi": false},\n "ngay_chuyen_doi": {"type": "date", "format": "datetime", "timezone": "Asia/Ho_Chi_Minh"},\n "ghi_chu": {"type": "text", "format": "markdown"},\n "tin_hieu": {"type": "link", "table": "tin_hieu", "multi": true},\n "buoc_tiep": {"type": "link", "table": "buoc_tiep", "multi": true},\n "tuong_tac": {"type": "link", "table": "tuong_tac", "multi": true},\n "do_nong": {\n "type": "formula",\n "options": [\n {"alias": "nong", "label": "N\xF3ng", "color": "orange"},\n {"alias": "nguoi", "label": "Ngu\u1ED9i", "color": "sky"}\n ]\n },\n "han_buoc_tiep": {"type": "rollup"},\n "khong_lien_he": {"type": "formula"}\n },\n "records": {\n "subtitle": ["ten_cong_ty"],\n "image": "anh",\n "party": "person",\n "due": ["han_buoc_tiep"],\n "status": {\n "field": "trang_thai",\n "closed": ["da_chuyen_doi", "loai"],\n "dates": {"da_chuyen_doi": "ngay_chuyen_doi"}\n }\n }\n },\n {\n "ref": "tin_hieu",\n "title": "tom_tat",\n "fields": {\n "tom_tat": {"type": "text"},\n "noi_dung": {"type": "text", "format": "markdown"},\n "anh_chup": {"type": "files"},\n "lien_ket": {"type": "text", "format": "link"},\n "kenh": {"type": "link", "table": "kenh", "multi": false},\n "loai": {\n "type": "select",\n "options": [\n {"alias": "hoi_dich_vu", "color": "emerald"},\n {"alias": "than_phien", "color": "blue"},\n {"alias": "tuyen_ke_toan", "color": "amber"},\n {"alias": "moi_thanh_lap", "color": "violet"},\n {"alias": "gioi_thieu", "color": "teal"},\n {"alias": "danh_ba", "color": "zinc"},\n {"alias": "nhieu", "color": "stone"}\n ]\n },\n "ngay_dang": {"type": "date", "timezone": "Asia/Ho_Chi_Minh"},\n "ngay_xay_ra": {"type": "formula"}\n },\n "records": {"subtitle": ["kenh", "ngay_xay_ra"], "image": "anh_chup"}\n },\n {\n "ref": "buoc_tiep",\n "title": "vi_sao_luc_nay",\n "fields": {\n "vi_sao_luc_nay": {"type": "text"},\n "viec": {\n "type": "select",\n "options": [\n {"alias": "binh_luan", "color": "blue", "mark": {"kind": "icon", "name": "message-square"}},\n {"alias": "nhan_facebook", "color": "violet", "mark": {"kind": "brand", "name": "facebook"}},\n {"alias": "nhan_zalo", "color": "sky", "mark": {"kind": "brand", "name": "zalo"}},\n {"alias": "goi_dien", "color": "teal", "mark": {"kind": "icon", "name": "phone"}},\n {"alias": "gui_email", "color": "indigo", "mark": {"kind": "icon", "name": "mail"}},\n {"alias": "gui_bang_gia", "color": "amber", "mark": {"kind": "icon", "name": "receipt"}}\n ]\n },\n "ban_nhap": {"type": "text", "format": "markdown"},\n "han": {"type": "date", "format": "datetime", "timezone": "Asia/Ho_Chi_Minh"},\n "tinh_trang": {\n "type": "select",\n "options": [\n {"alias": "cho", "color": "blue"},\n {"alias": "xong", "color": "emerald"},\n {"alias": "bo_qua", "color": "zinc"}\n ]\n }\n },\n "records": {\n "subtitle": ["viec"],\n "mark": "viec",\n "due": ["han"],\n "status": {"field": "tinh_trang", "closed": ["xong", "bo_qua"]}\n }\n },\n {\n "ref": "tuong_tac",\n "title": "tom_tat",\n "fields": {\n "tom_tat": {"type": "text"},\n "thoi_diem": {"type": "date", "format": "datetime", "timezone": "Asia/Ho_Chi_Minh"},\n "qua": {\n "type": "select",\n "options": [\n {"alias": "goi_dien", "color": "teal", "mark": {"kind": "icon", "name": "phone"}},\n {"alias": "zalo", "color": "sky", "mark": {"kind": "brand", "name": "zalo"}},\n {"alias": "facebook", "color": "blue", "mark": {"kind": "brand", "name": "facebook"}},\n {"alias": "email", "color": "indigo", "mark": {"kind": "icon", "name": "mail"}},\n {"alias": "gap_truc_tiep", "color": "emerald", "mark": {"kind": "icon", "name": "users"}},\n {"alias": "khac", "color": "zinc", "mark": {"kind": "icon", "name": "ellipsis"}}\n ]\n },\n "phan_hoi": {\n "type": "select",\n "options": [\n {"alias": "dang_cho", "color": "blue"},\n {"alias": "da_tra_loi", "color": "green"},\n {"alias": "quan_tam", "color": "amber"},\n {"alias": "khong_phu_hop", "color": "red"},\n {"alias": "khong_phan_hoi", "color": "zinc"},\n {"alias": "sai_so", "color": "stone"}\n ]\n },\n "ghi_am": {"type": "files"},\n "man_hinh": {"type": "files"},\n "nguyen_van": {"type": "text", "format": "markdown"},\n "hen_lai": {"type": "date", "timezone": "Asia/Ho_Chi_Minh"},\n "nguoi_thuc_hien": {"type": "member"}\n },\n "records": {"subtitle": ["qua", "phan_hoi"]}\n }\n ],\n "body": {\n "type": "App",\n "key": "khach_tiem_nang",\n "name": "Kh\xE1ch ti\u1EC1m n\u0103ng",\n "icon": "radar",\n "color": "violet",\n "children": [\n {\n "type": "List",\n "entity": "khach_tiem_nang",\n "columns": ["phu_trach", "han_buoc_tiep"],\n "filters": ["phu_trach"],\n "create": ["ho_ten", "trang_ca_nhan", "so_dien_thoai", "ten_cong_ty", "nguon"],\n "children": [\n {"type": "Reading", "key": "register_reading_0", "by": "phu_trach"},\n {\n "type": "Reading",\n "key": "register_reading_1",\n "label": "Kh\xE1ch chuy\u1EC3n \u0111\u1ED5i",\n "by": "ngay_chuyen_doi"\n }\n ]\n }\n ],\n "pages": [\n {\n "type": "Record",\n "entity": "khach_tiem_nang",\n "children": [\n {\n "type": "Section",\n "key": "danh_gia",\n "title": "\u0110\xE1nh gi\xE1",\n "at": ["moi"],\n "children": [\n "vai_tro",\n "loai_hinh",\n "quy_mo",\n "vi_sao_du_dieu_kien",\n "do_nong",\n {\n "type": "List",\n "entity": "tin_hieu",\n "columns": ["loai", "noi_dung"],\n "create": ["tom_tat", "anh_chup", "loai", "noi_dung", "kenh", "lien_ket", "ngay_dang"]\n },\n {\n "type": "Act",\n "key": "danh_gia_dat",\n "label": "\u0110\u1EE7 \u0111i\u1EC1u ki\u1EC7n",\n "when": {"trang_thai": ["moi"]},\n "requires": ["vi_sao_du_dieu_kien"],\n "set": {"trang_thai": "du_dieu_kien"}\n }\n ]\n },\n {\n "type": "Section",\n "key": "lien_he",\n "title": "Li\xEAn h\u1EC7",\n "at": ["du_dieu_kien"],\n "children": [\n "so_dien_thoai",\n "phu_trach",\n "trang_ca_nhan",\n "zalo",\n "email",\n {"field": "ghi_chu", "block": false},\n {\n "type": "List",\n "entity": "buoc_tiep",\n "columns": ["ban_nhap"],\n "create": ["vi_sao_luc_nay", "viec", "han", "ban_nhap"]\n },\n {\n "type": "List",\n "entity": "tuong_tac",\n "layout": "timeline",\n "create": ["tom_tat", "qua", "phan_hoi", "thoi_diem", "hen_lai"]\n },\n {\n "type": "Act",\n "key": "ghi_cuoc_goi",\n "label": "Ghi \xE2m cu\u1ED9c g\u1ECDi",\n "when": {"trang_thai": ["du_dieu_kien"]},\n "fills": ["tom_tat", "phan_hoi"],\n "record": {\n "into": "tuong_tac",\n "audio": "ghi_am",\n "transcript": "nguyen_van",\n "at": "thoi_diem",\n "by": "nguoi_thuc_hien",\n "video": "man_hinh"\n }\n },\n {\n "type": "Act",\n "key": "da_lien_he",\n "label": "\u0110\xE1nh d\u1EA5u \u0111\xE3 li\xEAn h\u1EC7",\n "when": {"trang_thai": ["du_dieu_kien"]},\n "set": {"trang_thai": "da_lien_he"}\n }\n ]\n },\n {\n "type": "Section",\n "key": "chuyen_doi",\n "title": "Chuy\u1EC3n \u0111\u1ED5i",\n "at": ["da_lien_he"],\n "children": [\n "nguon",\n {"field": "lien_he", "edit": false},\n {"field": "cong_ty", "edit": false},\n {\n "type": "Act",\n "key": "chuyen_doi",\n "label": "Chuy\u1EC3n \u0111\u1ED5i",\n "when": {"trang_thai": ["da_lien_he"]},\n "workflow": "chuyen_doi_khach",\n "confirm": true\n }\n ]\n },\n {\n "type": "Section",\n "key": "loai",\n "title": "Lo\u1EA1i",\n "at": ["loai"],\n "children": [\n "ly_do_loai",\n {\n "type": "Act",\n "key": "loai",\n "label": "Lo\u1EA1i",\n "when": {"trang_thai": ["moi", "du_dieu_kien", "da_lien_he"]},\n "asks": ["ly_do_loai"],\n "set": {"trang_thai": "loai"},\n "danger": true\n },\n {\n "type": "Act",\n "key": "mo_lai",\n "label": "M\u1EDF l\u1EA1i",\n "when": {"trang_thai": ["loai"]},\n "set": {"trang_thai": "moi"}\n }\n ]\n },\n {"type": "Check", "field": "khong_lien_he", "resolve": "da_lien_he"}\n ]\n },\n {"type": "Record", "entity": "kenh", "add": ["ten", "loai"]},\n {\n "type": "Record",\n "entity": "buoc_tiep",\n "children": [\n {\n "type": "Act",\n "key": "lam_xong",\n "label": "\u0110\xE3 l\xE0m",\n "when": {"tinh_trang": ["cho"]},\n "set": {"tinh_trang": "xong"}\n }\n ]\n }\n ]\n }\n}\n```\n\n## Approval\n\n**The job.** Raise a payment request, see it through approval, and read what is waiting at the top of the list.\n\n**Read.** `records.de_nghi.status` with its `history` (each move: when and who), Sections staged by `at`, and the List\'s Readings leading with the headline number. The history stays because the business reads who signed each move; where only the day a stage was reached matters, the status stamps a date on the row instead (the Gantt above).\n\n**Keys.** `reference/status`, `reference/section-node`, `reference/reading-node`\n\n**Not when.** Rows that never move \u2014 a reference list (a price list, a catalog) has no status and no headline number.\n\n```json\n{\n "tables": [\n {\n "ref": "de_nghi",\n "title": "noi_dung",\n "fields": {\n "noi_dung": {"type": "text"},\n "so_de_nghi": {"type": "text"},\n "loai": {\n "type": "select",\n "options": [\n {"alias": "thanh_toan_ncc", "color": "violet"},\n {"alias": "nhan_cong", "color": "indigo"},\n {"alias": "chi_phi_cong_truong", "color": "sky"},\n {"alias": "tam_ung", "color": "amber"},\n {"alias": "hoan_ung", "color": "teal"}\n ]\n },\n "du_an": {"type": "link", "table": "du_an", "multi": false},\n "nha_cung_cap": {"type": "link", "table": "nha_cung_cap", "multi": false},\n "so_tien": {"type": "number", "notation": {"style": "currency", "currency": "VND"}},\n "han_thanh_toan": {"type": "date"},\n "trang_thai": {\n "type": "select",\n "options": [\n {"alias": "nhap", "color": "slate"},\n {"alias": "cho_duyet", "color": "amber"},\n {"alias": "cho_chu_tich", "color": "violet"},\n {"alias": "da_duyet", "color": "blue"},\n {"alias": "da_chi", "color": "green"},\n {"alias": "tu_choi", "color": "rose"}\n ]\n },\n "nguoi_de_nghi": {"type": "member"},\n "chung_tu": {"type": "files"},\n "nguoi_duyet": {"type": "member"},\n "duyet_luc": {"type": "date", "format": "datetime"},\n "ly_do_tu_choi": {"type": "text"},\n "phieu_chi": {"type": "files"},\n "ngan_sach_du_an": {"type": "lookup"},\n "da_duyet_du_an": {"type": "lookup"},\n "vuot_ngan_sach": {"type": "formula"},\n "sat_ngan_sach": {"type": "formula"},\n "da_gui": {"type": "formula"},\n "nhap_at": {"type": "date", "format": "datetime"},\n "cho_duyet_at": {"type": "date", "format": "datetime"},\n "cho_chu_tich_at": {"type": "date", "format": "datetime"},\n "da_duyet_at": {"type": "date", "format": "datetime"}\n },\n "records": {\n "subtitle": ["du_an"],\n "figure": "so_tien",\n "limits": {"da_duyet_du_an": "ngan_sach_du_an"},\n "due": ["han_thanh_toan"],\n "starts": {"nguoi_de_nghi": "me"},\n "status": {\n "field": "trang_thai",\n "closed": ["da_chi", "tu_choi"],\n "dropped": ["tu_choi"],\n "dates": {\n "nhap": "nhap_at",\n "cho_duyet": "cho_duyet_at",\n "cho_chu_tich": "cho_chu_tich_at",\n "da_duyet": "da_duyet_at"\n },\n "history": "lich_su_duyet",\n "stages": {\n "nhap": {"owner": "nguoi_de_nghi"},\n "cho_duyet": {"owner": {"group": "<id of the giam_doc group>"}, "within": 1},\n "cho_chu_tich": {\n "owner": {"group": "<id of the chu_tich group>"},\n "within": 2,\n "when": {"so_tien": {"gt": 200000000}}\n },\n "da_duyet": {"owner": {"group": "<id of the ke_toan group>"}, "within": 2}\n }\n }\n }\n }\n ],\n "body": {\n "type": "App",\n "key": "de_nghi_chi",\n "name": "\u0110\u1EC1 ngh\u1ECB thanh to\xE1n",\n "icon": "hand-coins",\n "color": "amber",\n "children": [\n {\n "type": "List",\n "entity": "de_nghi",\n "filters": ["du_an"],\n "group": "du_an",\n "create": ["noi_dung", "loai", "du_an", "nha_cung_cap", "so_tien", "han_thanh_toan", "nguoi_de_nghi"],\n "children": [\n {\n "type": "Reading",\n "key": "register_reading_0",\n "label": "\u0110\xE3 duy\u1EC7t, ch\u1EDD chi",\n "value": "so_tien",\n "where": {"trang_thai": ["da_duyet"]}\n },\n {"type": "Reading", "key": "register_reading_1", "value": "so_tien", "by": "han_thanh_toan"}\n ]\n }\n ],\n "pages": [\n {\n "type": "Record",\n "entity": "de_nghi",\n "door": "drawer",\n "children": [\n {\n "type": "Section",\n "key": "de_nghi",\n "title": "\u0110\u1EC1 ngh\u1ECB",\n "at": ["nhap"],\n "children": [\n "so_de_nghi",\n "loai",\n "nha_cung_cap",\n "han_thanh_toan",\n "nguoi_de_nghi",\n {"field": "chung_tu"},\n {\n "type": "Act",\n "key": "gui_duyet",\n "label": "G\u1EEDi duy\u1EC7t",\n "when": {"trang_thai": ["nhap"]},\n "requires": ["chung_tu", "nguoi_de_nghi"],\n "set": {"trang_thai": "cho_duyet"}\n }\n ]\n },\n {\n "type": "Section",\n "key": "duyet",\n "title": "Duy\u1EC7t",\n "at": ["cho_duyet", "cho_chu_tich"],\n "children": [\n {"field": "nguoi_duyet", "edit": false},\n {"field": "duyet_luc", "edit": false},\n {"field": "ly_do_tu_choi", "edit": false},\n {\n "type": "Act",\n "key": "rut_lai",\n "label": "R\xFAt l\u1EA1i",\n "when": {"trang_thai": ["cho_duyet", "cho_chu_tich"]},\n "set": {"trang_thai": "nhap"},\n "confirm": true\n }\n ]\n },\n {\n "type": "Section",\n "key": "da_chi",\n "title": "\u0110\xE3 chi",\n "at": ["da_chi"],\n "children": [{"field": "phieu_chi", "edit": false}]\n },\n {"type": "Check", "field": "da_gui", "on": ["update"]},\n {"type": "Check", "field": "vuot_ngan_sach"},\n {"type": "Check", "field": "sat_ngan_sach"}\n ]\n },\n {"type": "Record", "entity": "du_an", "add": ["ten", "ma_du_an", "chu_dau_tu", "ngan_sach"]}\n ]\n }\n}\n```\n\n## Dashboard\n\n**The job.** The owner\'s question \u2014 what came in, what went out, where it went, and what is still unmatched \u2014 answered over one period.\n\n**Read.** An App of Readings and no List: Readings with `over` (the period windows them), a Reading `by` the day, Readings `by` a field, and a List of rows to act on.\n\n**Keys.** `reference/app-node`, `reference/reading-node`\n\n**Not when.** One job\'s headline numbers \u2014 those lead that job\'s List as its Readings.\n\n```json\n{\n "tables": [\n {\n "ref": "giao_dich",\n "title": "noi_dung",\n "fields": {\n "noi_dung": {"type": "text"},\n "ngay": {"type": "date"},\n "loai": {"type": "select", "options": [{"alias": "thu", "color": "green"}, {"alias": "chi", "color": "rose"}]},\n "so_tien": {"type": "number", "notation": {"style": "currency", "currency": "VND"}},\n "bien_dong": {"type": "formula", "notation": {"style": "currency", "currency": "VND"}},\n "doi_tuong": {"type": "link", "table": "doi_tuong", "multi": false},\n "danh_muc": {\n "type": "select",\n "options": [\n {"alias": "doanh_thu", "color": "green"},\n {"alias": "hang_hoa", "color": "blue"},\n {"alias": "van_chuyen", "color": "indigo"},\n {"alias": "nhan_su", "color": "violet"},\n {"alias": "van_phong", "color": "sky"},\n {"alias": "thue_phi", "color": "slate"},\n {"alias": "ngan_hang", "color": "teal"},\n {"alias": "khac", "color": "gray"}\n ]\n },\n "sao_ke": {"type": "link", "table": "sao_ke", "multi": false},\n "hoa_don": {"type": "link", "table": "hoa_don", "multi": true},\n "trang_thai": {\n "type": "select",\n "options": [\n {"alias": "chua_khop", "color": "amber"},\n {"alias": "da_khop", "color": "green"},\n {"alias": "khong_can_hd", "color": "slate"}\n ]\n },\n "khop_luc": {"type": "date", "format": "datetime"}\n },\n "records": {\n "subtitle": ["ngay"],\n "figure": "bien_dong",\n "status": {"field": "trang_thai", "closed": ["da_khop", "khong_can_hd"], "dates": {"da_khop": "khop_luc"}}\n }\n },\n {\n "ref": "hoa_don",\n "title": "doi_tuong",\n "fields": {\n "doi_tuong": {"type": "link", "table": "doi_tuong", "multi": false},\n "so_hoa_don": {"type": "text"},\n "ngay_hoa_don": {"type": "date"},\n "so_ngay_qua_han": {"type": "formula", "notation": {"style": "unit", "unit": "day"}},\n "chieu": {\n "type": "select",\n "options": [{"alias": "ban_ra", "color": "green"}, {"alias": "mua_vao", "color": "violet"}]\n },\n "tong_cong": {"type": "formula", "notation": {"style": "currency", "currency": "VND"}},\n "tep": {"type": "files"},\n "giao_dich": {"type": "link", "table": "giao_dich", "multi": true}\n },\n "records": {"subtitle": ["so_hoa_don", "ngay_hoa_don"], "image": "tep", "figure": "tong_cong"}\n }\n ],\n "body": {\n "type": "App",\n "key": "dong_tien",\n "name": "D\xF2ng ti\u1EC1n",\n "icon": "chart-line",\n "color": "emerald",\n "children": [\n {\n "type": "Sheet",\n "key": "dong_tien",\n "label": "D\xF2ng ti\u1EC1n",\n "children": [\n {\n "type": "Reading",\n "key": "dashboard_reading_0",\n "label": "Ti\u1EC1n v\xE0o",\n "entity": "giao_dich",\n "value": "so_tien",\n "where": {"loai": ["thu"]},\n "over": "ngay"\n },\n {\n "type": "Reading",\n "key": "dashboard_reading_1",\n "label": "Ti\u1EC1n ra",\n "entity": "giao_dich",\n "value": "so_tien",\n "where": {"loai": ["chi"]},\n "over": "ngay",\n "better": "down"\n },\n {\n "type": "Reading",\n "key": "dashboard_reading_2",\n "label": "D\xF2ng ti\u1EC1n r\xF2ng",\n "entity": "giao_dich",\n "value": "bien_dong",\n "by": "ngay"\n },\n {\n "type": "Reading",\n "key": "dashboard_reading_3",\n "label": "Chi theo danh m\u1EE5c",\n "entity": "giao_dich",\n "value": "so_tien",\n "where": {"loai": ["chi"]},\n "by": "danh_muc",\n "over": "ngay"\n },\n {\n "type": "Reading",\n "key": "dashboard_reading_4",\n "label": "Thu theo kh\xE1ch h\xE0ng",\n "entity": "giao_dich",\n "value": "so_tien",\n "where": {"loai": ["thu"]},\n "by": "doi_tuong",\n "over": "ngay"\n },\n {\n "type": "Reading",\n "key": "dashboard_reading_5",\n "label": "C\xF4ng n\u1EE3 b\xE1n ra theo tu\u1ED5i n\u1EE3",\n "entity": "hoa_don",\n "value": "tong_cong",\n "where": {"chieu": ["ban_ra"]},\n "by": "doi_tuong",\n "across": {"field": "so_ngay_qua_han", "tiers": [1, 8, 16, 31]}\n },\n {\n "type": "List",\n "key": "dashboard_reading_8",\n "entity": "giao_dich",\n "where": {"trang_thai": ["chua_khop"]},\n "label": "D\xF2ng ch\u01B0a kh\u1EDBp",\n "columns": ["sao_ke"]\n }\n ]\n }\n ]\n }\n}\n```\n';
1885
+ var examples_default = '# Worked examples\n\nEach section is one treatment, cut from a complete workspace of an invented business: the job, the keys to\nread, where the treatment is wrong, and the excerpt \u2014 the app\'s tree, the App node `set_app` takes as `body`,\nwhich the check passes with no finding; the tables it draws as the items of a `set_tables` call, each with its\n`title` and `records`; those tables\' fields it names, by what each holds and how it is drawn; and the templates it makes.\nLeft out, for the page\'s size: a Section or page that carries nothing of the treatment, every `label` and `description` of a table or field, `required`, `min`, `unique`, `default` (a section keeps the ones its **Read** rests on), a link\'s\n`pair`, how a computed field computes, the `tables` and `templates` maps an App adds (ids from the\n`set_tables` answer), and template contents \u2014 a call states each table\'s and field\'s `label`. Choosing\namong them: the `design` reference. Every key: `reference`, at the pages each section names under\n**Keys**.\n\n## Calendar\n\n**The job.** Book visits on the days they happen, and see a week\'s work at a glance.\n\n**Read.** `layout: "calendar"` on the List; each visit stands from `scheduled_for` over its span to `ends_at`, the two `required` moments of its facts (`ends_at` is ordered after `scheduled_for` by its `min`); a keyed calendar names the date and the end itself.\n\n**Keys.** `reference/calendar`\n\n**Not when.** Rows booked on a resource that two may not share at once \u2014 that is `lanes`. Rows with a date nobody plans by (an invoice\'s date) stay a table.\n\n```json\n{\n "tables": [\n {\n "ref": "service_visit",\n "title": "customer",\n "fields": {\n "customer": {"required": true, "type": "link", "table": "customer", "multi": false},\n "scheduled_for": {"required": true, "type": "date", "format": "datetime"},\n "ends_at": {"required": true, "type": "date", "format": "datetime", "min": "scheduled_for"},\n "engineer": {"type": "link", "table": "engineer", "multi": false},\n "job": {\n "required": true,\n "type": "select",\n "options": [{"alias": "inspection", "color": "sky"}, {"alias": "repair", "color": "orange"}]\n },\n "stage": {\n "type": "select",\n "options": [\n {"alias": "booked_on", "color": "blue"},\n {"alias": "parts_ready_on", "color": "blue"},\n {"alias": "arrived_on", "color": "blue"},\n {"alias": "completed_on", "color": "green"}\n ]\n },\n "booked_on": {"type": "date"},\n "parts_ready_on": {"type": "date"},\n "arrived_on": {"type": "date"},\n "hours": {"type": "number", "notation": {"style": "unit", "unit": "h"}},\n "report": {"type": "text", "format": "markdown"},\n "completed_on": {"type": "date"}\n },\n "records": {\n "subtitle": ["scheduled_for", "ends_at"],\n "figure": "hours",\n "due": ["scheduled_for"],\n "status": {\n "field": "stage",\n "closed": ["completed_on"],\n "dates": {\n "booked_on": "booked_on",\n "parts_ready_on": "parts_ready_on",\n "arrived_on": "arrived_on",\n "completed_on": "completed_on"\n }\n }\n }\n }\n ],\n "body": {\n "type": "App",\n "key": "visits",\n "name": "Service visits",\n "icon": "calendar",\n "color": "emerald",\n "rows": {\n "customer": {"any": [{"member_of": "sales"}]},\n "order": {"any": [{"member_of": "sales"}, {"member_of": "stores"}]},\n "order_line": {"any": [{"member_of": "sales"}, {"member_of": "stores"}]},\n "payment": {"any": [{"member_of": "sales"}, {"member_of": "stores"}]},\n "service_visit": {"any": [{"member_of": "sales"}, {"member_of": "stores"}, {"member_of": "field"}]}\n },\n "children": [\n {\n "type": "List",\n "entity": "service_visit",\n "columns": ["engineer", "job"],\n "filters": ["customer"],\n "sort": {"field": "scheduled_for"},\n "layout": "calendar",\n "create": ["customer", "job", "scheduled_for", "ends_at", "engineer"],\n "children": [\n {"type": "Reading", "key": "register_reading_0", "label": "Repairs", "where": {"job": ["repair"]}},\n {"type": "Reading", "key": "register_reading_1", "value": "hours", "by": "engineer"}\n ]\n }\n ],\n "pages": [\n {\n "type": "Record",\n "entity": "service_visit",\n "children": [\n {\n "type": "Section",\n "key": "visit",\n "title": "Visit",\n "at": ["booked_on", "parts_ready_on"],\n "children": [\n "job",\n "booked_on",\n "parts_ready_on",\n {\n "type": "Act",\n "key": "reschedule",\n "label": "Reschedule",\n "asks": ["scheduled_for", "ends_at"],\n "when": {"stage": ["booked_on", "parts_ready_on"]}\n },\n {\n "type": "Act",\n "key": "to_booked_on",\n "label": "Booked",\n "when": {"stage": {"empty": true}},\n "asks": [{"field": "booked_on", "starts": "today"}],\n "set": {"stage": "booked_on"}\n },\n {\n "type": "Act",\n "key": "to_parts_ready_on",\n "label": "Parts ready",\n "when": {"stage": ["booked_on"], "job": ["repair"]},\n "asks": [{"field": "parts_ready_on", "starts": "today"}],\n "set": {"stage": "parts_ready_on"}\n },\n {\n "type": "Act",\n "key": "to_arrived_on",\n "label": "On site",\n "when": {"stage": ["booked_on"], "job": ["inspection"]},\n "asks": [{"field": "arrived_on", "starts": "today"}],\n "set": {"stage": "arrived_on"}\n },\n {\n "type": "Act",\n "key": "to_arrived_on_2",\n "label": "On site",\n "when": {"stage": ["parts_ready_on"]},\n "asks": [{"field": "arrived_on", "starts": "today"}],\n "set": {"stage": "arrived_on"}\n }\n ]\n },\n {\n "type": "Section",\n "key": "report",\n "title": "Report",\n "at": ["arrived_on"],\n "children": [\n "engineer",\n "arrived_on",\n {"field": "report", "block": false},\n {\n "type": "Act",\n "key": "complete",\n "label": "Complete visit",\n "requires": ["engineer"],\n "asks": [\n "hours",\n {"input": "summary", "label": "What was done", "type": "long_text", "required": true}\n ],\n "set": {"report": {"input": "summary"}, "stage": "completed_on"},\n "when": {"stage": ["arrived_on"]}\n },\n {\n "type": "Act",\n "key": "clear_visit_hours",\n "label": "Clear hours",\n "set": {"hours": null},\n "confirm": true\n }\n ]\n }\n ]\n },\n {"type": "Record", "entity": "warehouse", "add": ["name", "city"]},\n {"type": "Record", "entity": "engineer", "add": ["name", "base"]},\n {"type": "Record", "entity": "customer", "add": ["name", "credit_limit"]}\n ]\n }\n}\n```\n\n## Lanes\n\n**The job.** Put each service visit on an engineer\'s day by the hour, and see at once who is free between visits.\n\n**Read.** `layout` `lanes` with `by` naming the one-row link to the resource (the engineer); every engineer stands as a lane, empty or not.\n\n**Keys.** `reference/lanes`\n\n**Not when.** The resource is not a row of the model (a free-text room name), or rows never compete for one \u2014 a `calendar` reads them by day.\n\n```json\n{\n "tables": [\n {\n "ref": "service_visit",\n "title": "customer",\n "fields": {\n "customer": {"type": "link", "table": "customer", "multi": false},\n "scheduled_for": {"type": "date", "format": "datetime"},\n "ends_at": {"type": "date", "format": "datetime"},\n "engineer": {"type": "link", "table": "engineer", "multi": false},\n "job": {\n "type": "select",\n "options": [{"alias": "inspection", "color": "sky"}, {"alias": "repair", "color": "orange"}]\n },\n "stage": {\n "type": "select",\n "options": [\n {"alias": "booked_on", "color": "blue"},\n {"alias": "parts_ready_on", "color": "blue"},\n {"alias": "arrived_on", "color": "blue"},\n {"alias": "completed_on", "color": "green"}\n ]\n },\n "booked_on": {"type": "date"},\n "parts_ready_on": {"type": "date"},\n "arrived_on": {"type": "date"},\n "hours": {"type": "number", "notation": {"style": "unit", "unit": "h"}},\n "completed_on": {"type": "date"},\n "length": {"type": "formula", "notation": {"style": "unit", "unit": "h"}}\n },\n "records": {\n "subtitle": ["scheduled_for", "ends_at"],\n "figure": "hours",\n "due": ["scheduled_for"],\n "status": {\n "field": "stage",\n "closed": ["completed_on"],\n "dates": {\n "booked_on": "booked_on",\n "parts_ready_on": "parts_ready_on",\n "arrived_on": "arrived_on",\n "completed_on": "completed_on"\n }\n }\n }\n },\n {\n "ref": "engineer",\n "title": "name",\n "fields": {\n "name": {"type": "text"},\n "base": {"type": "link", "table": "warehouse", "multi": false},\n "day_hours": {"type": "number", "notation": {"style": "unit", "unit": "h"}}\n },\n "records": {"subtitle": ["base"], "party": "person"}\n }\n ],\n "body": {\n "type": "App",\n "key": "dispatch",\n "name": "Dispatch",\n "icon": "wrench",\n "color": "sky",\n "rows": {\n "customer": {"any": [{"member_of": "sales"}]},\n "order": {"any": [{"member_of": "sales"}, {"member_of": "stores"}]},\n "order_line": {"any": [{"member_of": "sales"}, {"member_of": "stores"}]},\n "payment": {"any": [{"member_of": "sales"}, {"member_of": "stores"}]},\n "service_visit": {"any": [{"member_of": "sales"}, {"member_of": "stores"}, {"member_of": "field"}]}\n },\n "children": [\n {\n "type": "List",\n "entity": "service_visit",\n "columns": ["job"],\n "search": ["customer"],\n "layout": {"lanes": {"by": "engineer", "loads": {"length": "day_hours"}}},\n "create": ["engineer", "scheduled_for", "ends_at", "customer", "job"]\n }\n ],\n "pages": [\n {\n "type": "Record",\n "entity": "service_visit",\n "children": [\n {\n "type": "Section",\n "key": "booking",\n "title": "Booking",\n "children": [\n "engineer",\n "job",\n "hours",\n {\n "type": "Act",\n "key": "to_booked_on",\n "label": "Booked",\n "when": {"stage": {"empty": true}},\n "asks": [{"field": "booked_on", "starts": "today"}],\n "set": {"stage": "booked_on"}\n },\n {\n "type": "Act",\n "key": "to_parts_ready_on",\n "label": "Parts ready",\n "when": {"stage": ["booked_on"], "job": ["repair"]},\n "asks": [{"field": "parts_ready_on", "starts": "today"}],\n "set": {"stage": "parts_ready_on"}\n },\n {\n "type": "Act",\n "key": "to_arrived_on",\n "label": "On site",\n "when": {"stage": ["booked_on"], "job": ["inspection"]},\n "asks": [{"field": "arrived_on", "starts": "today"}],\n "set": {"stage": "arrived_on"}\n },\n {\n "type": "Act",\n "key": "to_arrived_on_2",\n "label": "On site",\n "when": {"stage": ["parts_ready_on"]},\n "asks": [{"field": "arrived_on", "starts": "today"}],\n "set": {"stage": "arrived_on"}\n },\n {\n "type": "Act",\n "key": "to_completed_on",\n "label": "Completed",\n "when": {"stage": ["arrived_on"]},\n "asks": [{"field": "completed_on", "starts": "today"}],\n "set": {"stage": "completed_on"}\n }\n ]\n }\n ],\n "row": {\n "subtitle": [{"field": "scheduled_for", "edit": false}, {"field": "ends_at", "edit": false}],\n "figure": false\n }\n },\n {"type": "Record", "entity": "warehouse", "add": ["name", "city"]},\n {"type": "Record", "entity": "engineer", "add": ["name", "base"]},\n {"type": "Record", "entity": "customer", "add": ["name", "credit_limit"]}\n ]\n }\n}\n```\n\n## Gantt\n\n**The job.** Read every hire as a bar from the day the machine goes out to the day it is due back, against today.\n\n**Read.** `layout` `gantt` with its `start`; with no end stated, the bar ends at the entity\'s first `due`. The day a hire comes back (`ngay_tra`) is stamped by the status\'s `dates`, so no act sets it.\n\n**Keys.** `reference/gantt`\n\n**Not when.** Rows that last a day or less (a visit, a shift) \u2014 `calendar` or `lanes`; a plan with no dates set yet.\n\n```json\n{\n "tables": [\n {\n "ref": "phieu_thue",\n "title": "khach_hang",\n "fields": {\n "khach_hang": {"type": "link", "table": "khach_hang", "multi": false},\n "so_phieu": {"type": "text"},\n "trang_thai": {\n "type": "select",\n "options": [\n {"alias": "moi", "color": "slate"},\n {"alias": "dang_thue", "color": "blue"},\n {"alias": "da_tra", "color": "green"},\n {"alias": "huy", "color": "gray"}\n ]\n },\n "phu_trach": {"type": "member"},\n "ngay_giao": {"type": "date"},\n "han_tra": {"type": "date"},\n "ngay_tra": {"type": "date"},\n "tinh_trang_tra": {\n "type": "select",\n "options": [\n {"alias": "tot", "color": "green"},\n {"alias": "tray_xuoc", "color": "amber"},\n {"alias": "hu_hong", "color": "red"}\n ]\n },\n "so_ngay": {"type": "formula"},\n "tong_tien": {"type": "rollup"}\n },\n "records": {\n "subtitle": ["so_phieu"],\n "figure": "tong_tien",\n "due": ["han_tra"],\n "status": {"field": "trang_thai", "closed": ["da_tra", "huy"], "dates": {"da_tra": "ngay_tra"}}\n }\n }\n ],\n "body": {\n "type": "App",\n "key": "tien_do_thue",\n "name": "Ti\u1EBFn \u0111\u1ED9 cho thu\xEA",\n "icon": "calendar-range",\n "color": "teal",\n "children": [\n {\n "type": "List",\n "entity": "phieu_thue",\n "columns": ["phu_trach"],\n "filters": ["phu_trach", "khach_hang"],\n "layout": {"gantt": {"start": "ngay_giao"}},\n "create": false,\n "remove": false\n }\n ],\n "pages": [\n {\n "type": "Record",\n "entity": "phieu_thue",\n "children": [\n {\n "type": "Section",\n "key": "phieu_thue",\n "title": "Phi\u1EBFu thu\xEA",\n "children": ["ngay_giao", "han_tra"]\n },\n {\n "type": "Section",\n "key": "dang_thue",\n "title": "\u0110ang thu\xEA",\n "at": ["dang_thue"],\n "children": [\n "so_ngay",\n {"field": "ngay_tra", "edit": false},\n {\n "type": "Act",\n "key": "nhan_tra",\n "label": "Nh\u1EADn m\xE1y tr\u1EA3",\n "when": {"trang_thai": ["dang_thue"]},\n "asks": ["tinh_trang_tra"],\n "set": {"trang_thai": "da_tra"},\n "confirm": true\n },\n {\n "type": "Act",\n "key": "mo_lai",\n "label": "M\u1EDF l\u1EA1i",\n "when": {"trang_thai": ["da_tra"]},\n "set": {"trang_thai": "dang_thue"},\n "confirm": true\n }\n ]\n }\n ]\n }\n ]\n }\n}\n```\n\n## Roster\n\n**The job.** See who works which shift on each day of the week or the month.\n\n**Read.** `layout: "roster"` over the people; the child List (`lich_truc`) is the rows that fill the days \u2014 one link back and a date on its line.\n\n**Keys.** `reference/roster`\n\n**Not when.** Rows that are themselves the bookings (a stay over several days) \u2014 a `calendar` or `lanes` draws them; a roster\'s row is what the days are filled for.\n\n```json\n{\n "tables": [\n {\n "ref": "nha_si",\n "title": "ho_ten",\n "fields": {\n "ho_ten": {"type": "text"},\n "chuyen_mon": {\n "type": "select",\n "options": [\n {"alias": "tong_quat", "color": "blue"},\n {"alias": "chinh_nha", "color": "purple"},\n {"alias": "nha_chu", "color": "green"},\n {"alias": "phuc_hinh", "color": "orange"}\n ]\n },\n "dien_thoai": {"type": "text"},\n "ngay_lam": {\n "type": "select",\n "options": [\n {"alias": "mon", "color": "blue"},\n {"alias": "tue", "color": "blue"},\n {"alias": "wed", "color": "blue"},\n {"alias": "thu", "color": "blue"},\n {"alias": "fri", "color": "blue"},\n {"alias": "sat", "color": "blue"},\n {"alias": "sun", "color": "blue"}\n ],\n "multi": true\n },\n "tu_ngay": {"type": "date"}\n },\n "records": {\n "subtitle": ["chuyen_mon"],\n "party": "person",\n "cadence": [{"entity": "lich_truc", "on": "ngay_lam", "from": "tu_ngay", "planned": "ke_hoach"}]\n }\n },\n {\n "ref": "lich_truc",\n "title": "ca",\n "fields": {\n "nha_si": {"type": "link", "table": "nha_si", "multi": false},\n "ca": {\n "type": "select",\n "options": [\n {"alias": "sang", "color": "blue"},\n {"alias": "chieu", "color": "purple"},\n {"alias": "ca_ngay", "color": "green"},\n {"alias": "nghi", "color": "gray"}\n ]\n },\n "ngay": {"type": "date"},\n "ghe": {"type": "link", "table": "ghe", "multi": false},\n "ke_hoach": {"type": "date"}\n },\n "records": {"subtitle": ["ngay", "ghe"], "mark": "ca"}\n }\n ],\n "body": {\n "type": "App",\n "key": "lich_truc",\n "name": "L\u1ECBch tr\u1EF1c",\n "icon": "users",\n "color": "indigo",\n "children": [\n {\n "type": "List",\n "entity": "nha_si",\n "filters": ["chuyen_mon"],\n "layout": "roster",\n "create": ["ho_ten", "chuyen_mon", "dien_thoai"],\n "children": [\n {"type": "List", "entity": "lich_truc", "create": true, "remove": true},\n {"type": "Act", "key": "tao_ca_truc_ds", "label": "T\u1EA1o ca tr\u1EF1c", "on": "view", "makes": "lich_truc"},\n {\n "type": "Export",\n "key": "lich_truc_thang",\n "label": "L\u1ECBch tr\u1EF1c th\xE1ng",\n "template": "lich_truc_thang"\n }\n ]\n }\n ],\n "pages": [\n {\n "type": "Record",\n "entity": "nha_si",\n "children": [\n {\n "type": "Section",\n "key": "lich_tuan",\n "title": "L\u1ECBch tr\u1EF1c m\u1ED7i tu\u1EA7n",\n "children": [\n "ngay_lam",\n "tu_ngay",\n {"type": "Act", "key": "tao_ca_truc", "label": "T\u1EA1o ca tr\u1EF1c", "makes": "lich_truc"}\n ]\n }\n ]\n },\n {"type": "Record", "entity": "lich_truc"},\n {"type": "Record", "entity": "ghe", "add": ["ten", "phong"]}\n ]\n }\n}\n```\n\n## Cards\n\n**The job.** Find an item by its picture, and count what the shelf holds.\n\n**Read.** `layout: "cards"` over rows whose `records.image` is a photo; `scope` keeps the app inside one warehouse at a time.\n\n**Keys.** `reference/cards`, `reference/records`, `reference/app-node`\n\n**Not when.** Rows with no picture \u2014 cards of words are a table drawn worse.\n\n```json\n{\n "tables": [\n {\n "ref": "stock_item",\n "title": "name",\n "fields": {\n "name": {"type": "text"},\n "warehouse": {"type": "link", "table": "warehouse", "multi": false},\n "photo": {"type": "files"},\n "sku": {"type": "text"},\n "category": {\n "type": "select",\n "options": [\n {"alias": "pumps", "color": "blue"},\n {"alias": "valves", "color": "teal"},\n {"alias": "seals", "color": "amber"},\n {"alias": "motors", "color": "violet"}\n ]\n },\n "on_hand": {"type": "number"},\n "minimum": {"type": "number"},\n "price": {"type": "number", "notation": {"style": "currency", "currency": "USD"}},\n "supplier_page": {"type": "text", "format": "link"},\n "last_counted": {"type": "date"},\n "counted_by": {"type": "member"},\n "count_note": {"type": "text"}\n },\n "records": {\n "subtitle": ["sku", "category"],\n "image": "photo",\n "figure": "on_hand",\n "limits": {"on_hand": 400},\n "gates": {"on_hand": "minimum"}\n }\n },\n {\n "ref": "order_line",\n "title": "item",\n "fields": {\n "item": {"type": "link", "table": "stock_item", "multi": false},\n "order": {"type": "link", "table": "order", "multi": false},\n "quantity": {"type": "number"},\n "shipped": {"type": "number"},\n "picked": {"type": "number"},\n "unit_price": {"type": "number", "notation": {"style": "currency", "currency": "USD"}},\n "amount": {"type": "formula", "notation": {"style": "currency", "currency": "USD"}},\n "settled": {"type": "formula"},\n "category": {"type": "lookup"}\n },\n "records": {\n "subtitle": ["order", "unit_price"],\n "figure": "amount",\n "limits": {"shipped": "quantity", "picked": "quantity"}\n }\n }\n ],\n "body": {\n "type": "App",\n "key": "stock",\n "name": "Stock",\n "icon": "boxes",\n "color": "teal",\n "rows": {\n "customer": {"any": [{"member_of": "sales"}]},\n "order": {"any": [{"member_of": "sales"}, {"member_of": "stores"}]},\n "order_line": {"any": [{"member_of": "sales"}, {"member_of": "stores"}]},\n "payment": {"any": [{"member_of": "sales"}, {"member_of": "stores"}]}\n },\n "scope": "warehouse",\n "children": [\n {\n "type": "List",\n "entity": "stock_item",\n "filters": ["on_hand"],\n "search": ["name", "sku"],\n "layout": "cards",\n "children": [\n {"type": "Reading", "key": "register_reading_0", "value": "on_hand", "by": "category"},\n {"type": "Export", "key": "export"}\n ]\n }\n ],\n "pages": [\n {\n "type": "Record",\n "entity": "stock_item",\n "children": [\n {\n "type": "Section",\n "key": "item",\n "title": "Item",\n "children": ["price", "minimum", "supplier_page"]\n },\n {\n "type": "Section",\n "key": "last_count",\n "title": "Last count",\n "children": [\n "last_counted",\n "counted_by",\n "count_note",\n {\n "type": "Act",\n "key": "count",\n "label": "Count stock",\n "asks": [\n {"input": "counted", "label": "Units on the shelf", "type": "number", "required": true},\n {"input": "remark", "label": "Remark", "type": "long_text"}\n ],\n "set": {\n "on_hand": {"input": "counted"},\n "last_counted": {"now": true},\n "counted_by": {"me": true},\n "count_note": {"input": "remark"}\n }\n }\n ]\n },\n {\n "type": "Section",\n "key": "on_order",\n "title": "On order",\n "children": [{"type": "List", "entity": "order_line"}]\n }\n ]\n },\n {\n "type": "Record",\n "entity": "order_line",\n "children": ["quantity", "shipped", {"type": "Check", "field": "settled", "on": ["update"]}]\n },\n {"type": "Record", "entity": "customer", "add": ["name", "credit_limit"]}\n ]\n }\n}\n```\n\n## Party\n\n**The job.** Keep each customer account \u2014 who they are, what they ordered, what was said to them.\n\n**Read.** `records.customer.party: "organization"` and its `image` (the logo); a List with `layout: "timeline"` for the touches, a Reading `by` the day placed for its orders, and its papers `expect`ed by kind.\n\n**Keys.** `reference/records`, `reference/layouts`, `reference/list-node`, `reference/reading-node`\n\n**Not when.** A list of customers is not a job by itself: the customer is a link on the desk whose rows name it, unless the job is the account itself.\n\n```json\n{\n "tables": [\n {\n "ref": "customer",\n "title": "name",\n "fields": {\n "name": {"type": "text"},\n "logo": {"type": "files"},\n "code": {"type": "text"},\n "tier": {\n "type": "select",\n "options": [\n {"alias": "key", "color": "violet"},\n {"alias": "standard", "color": "sky"},\n {"alias": "lapsed", "color": "gray"}\n ]\n },\n "phone": {"type": "text"},\n "website": {"type": "text", "format": "link"},\n "account_manager": {"type": "member"},\n "credit_limit": {"type": "number", "notation": {"style": "currency", "currency": "USD"}},\n "orders": {"type": "link", "table": "order", "multi": true},\n "outstanding": {"type": "rollup"},\n "papers_needed": {\n "type": "select",\n "options": [\n {"alias": "credit_application", "color": "blue"},\n {"alias": "trade_reference", "color": "violet"},\n {"alias": "vat_certificate", "color": "teal"}\n ],\n "multi": true\n },\n "notes": {"type": "text", "format": "markdown"}\n },\n "records": {\n "subtitle": ["tier"],\n "image": "logo",\n "party": "organization",\n "figure": "outstanding",\n "limits": {"outstanding": "credit_limit"}\n }\n },\n {\n "ref": "order",\n "title": "reference",\n "fields": {\n "customer": {"type": "link", "table": "customer", "multi": false},\n "reference": {"type": "text"},\n "stage": {\n "type": "select",\n "options": [\n {"alias": "draft", "color": "slate"},\n {"alias": "confirmed", "color": "blue"},\n {"alias": "picking", "color": "amber"},\n {"alias": "shipped", "color": "indigo"},\n {"alias": "received", "color": "green"},\n {"alias": "cancelled", "color": "rose"}\n ]\n },\n "placed": {"type": "date"},\n "due_date": {"type": "date"},\n "handler": {"type": "member"},\n "priority": {"type": "boolean"},\n "lines": {"type": "link", "table": "order_line", "multi": true},\n "payments": {"type": "link", "table": "payment", "multi": true},\n "total": {"type": "rollup"},\n "balance": {"type": "formula", "notation": {"style": "currency", "currency": "USD"}},\n "units_ordered": {"type": "rollup"},\n "units_shipped": {"type": "rollup"},\n "units_picked": {"type": "rollup"},\n "carrier": {"type": "text"},\n "tracking_no": {"type": "text"},\n "shipped_on": {"type": "date"},\n "cancellation_reason": {"type": "text"},\n "cancelled_by": {"type": "member"},\n "replaced_by": {"type": "link", "table": "order", "multi": false},\n "attachments": {"type": "files"},\n "delivery_note": {"type": "files"},\n "notes": {"type": "text", "format": "markdown"},\n "paid_in_full": {"type": "formula"},\n "reminder_ref": {"type": "text"}\n },\n "records": {\n "subtitle": ["customer", "placed"],\n "figure": "total",\n "limits": {"units_shipped": "units_ordered", "units_picked": "units_ordered"},\n "due": ["due_date"],\n "status": {\n "field": "stage",\n "closed": ["received", "cancelled"],\n "dates": {"shipped": "shipped_on"},\n "history": "order_stage"\n }\n }\n },\n {\n "ref": "customer_paper",\n "title": "kind",\n "fields": {\n "kind": {\n "type": "select",\n "options": [\n {"alias": "credit_application", "color": "blue"},\n {"alias": "trade_reference", "color": "violet"},\n {"alias": "vat_certificate", "color": "teal"}\n ]\n },\n "customer": {"type": "link", "table": "customer", "multi": false},\n "received_on": {"type": "date"},\n "file": {"type": "files"}\n },\n "records": {"image": "file"}\n },\n {\n "ref": "touch",\n "title": "said",\n "fields": {\n "said": {"type": "text"},\n "customer": {"type": "link", "table": "customer", "multi": false},\n "on": {"type": "date"},\n "by": {"type": "member"}\n }\n }\n ],\n "body": {\n "type": "App",\n "key": "customers",\n "name": "Customers",\n "icon": "users",\n "color": "violet",\n "rows": {\n "customer": {"any": [{"member_of": "sales"}]},\n "order": {"any": [{"member_of": "sales"}, {"member_of": "stores"}]},\n "order_line": {"any": [{"member_of": "sales"}, {"member_of": "stores"}]},\n "payment": {"any": [{"member_of": "sales"}, {"member_of": "stores"}]},\n "touch": {"any": [{"member_of": "sales"}]},\n "customer_paper": {"any": [{"member_of": "sales"}]},\n "service_visit": {"any": [{"member_of": "sales"}, {"member_of": "stores"}, {"member_of": "field"}]}\n },\n "children": [\n {\n "type": "List",\n "entity": "customer",\n "columns": ["phone", "account_manager"],\n "filters": ["account_manager"],\n "sort": {"field": "name"},\n "opens": {"tier": ["key", "standard"]},\n "create": ["name", "code", "credit_limit"],\n "children": [{"type": "Reading", "key": "register_reading_1", "value": "outstanding", "by": "account_manager"}]\n }\n ],\n "pages": [\n {\n "type": "Record",\n "entity": "customer",\n "door": "drawer",\n "children": [\n {"type": "Section", "key": "contact", "title": "Contact", "children": ["phone", "website"]},\n {\n "type": "Section",\n "key": "account",\n "title": "Account",\n "children": [\n "code",\n "account_manager",\n "credit_limit",\n {\n "type": "Act",\n "key": "reassign",\n "label": "Reassign",\n "asks": [{"input": "to", "label": "Account manager", "type": "member", "required": true}],\n "set": {"account_manager": {"input": "to"}}\n },\n {\n "type": "Act",\n "key": "lapse",\n "label": "Mark lapsed",\n "when": {"tier": ["key", "standard"]},\n "set": {"tier": "lapsed"},\n "confirm": true\n },\n {\n "type": "Act",\n "key": "reinstate",\n "label": "Reinstate",\n "when": {"tier": ["lapsed"]},\n "asks": [\n {\n "input": "back_to",\n "label": "Back to",\n "type": "select",\n "options": [\n {\n "alias": "key",\n "label": "Key account",\n "color": "violet",\n "mark": {"kind": "icon", "name": "building-2"}\n },\n {"alias": "standard", "label": "Standard", "color": "sky"}\n ],\n "required": true\n }\n ],\n "set": {"tier": {"input": "back_to"}}\n }\n ]\n },\n {\n "type": "Section",\n "key": "orders",\n "title": "Orders",\n "children": [\n {\n "type": "Reading",\n "key": "block_reading_0",\n "label": "Order value",\n "entity": "order",\n "value": "total",\n "where": {"stage": ["confirmed", "picking", "shipped", "received"]},\n "by": "placed"\n },\n {\n "type": "List",\n "entity": "order",\n "where": {"stage": ["draft", "confirmed", "picking", "shipped"]},\n "label": "Open orders",\n "columns": ["due_date"],\n "create": false\n },\n {\n "type": "List",\n "key": "order_2",\n "entity": "order",\n "where": {"stage": ["shipped", "received"], "paid_in_full": false},\n "label": "Shipped, still owed",\n "columns": ["balance"],\n "create": false\n },\n {\n "type": "List",\n "key": "block_reading_3",\n "entity": "service_visit",\n "columns": ["engineer", "job"],\n "edit": false\n }\n ]\n },\n {\n "type": "Section",\n "key": "account_papers",\n "title": "Account papers",\n "children": [\n {\n "type": "List",\n "entity": "customer_paper",\n "expect": {"field": "kind", "of": "papers_needed"},\n "columns": ["received_on"]\n }\n ]\n },\n {\n "type": "Section",\n "key": "contact_log",\n "title": "Contact log",\n "children": [{"type": "List", "entity": "touch", "layout": "timeline"}]\n },\n {"type": "Section", "key": "notes", "title": "Notes", "children": ["notes"]}\n ]\n },\n {\n "type": "Record",\n "entity": "order",\n "children": [\n "due_date",\n "handler",\n {"field": "priority", "edit": false},\n "lines",\n "payments",\n {"field": "carrier", "edit": false},\n {"field": "tracking_no", "edit": false},\n {"field": "shipped_on", "edit": false},\n {"field": "cancellation_reason", "edit": false},\n {"field": "cancelled_by", "edit": false},\n {"field": "replaced_by", "edit": false},\n {"field": "attachments", "edit": false},\n "delivery_note",\n "notes",\n {"field": "reminder_ref", "edit": false},\n {"type": "Check", "field": "paid_in_full", "on": ["update"]}\n ]\n },\n {"type": "Record", "entity": "warehouse", "add": ["name", "city"]},\n {"type": "Record", "entity": "stock_item", "add": ["name", "warehouse", "sku", "category"]},\n {"type": "Record", "entity": "order_line", "add": ["item", "quantity"]}\n ]\n }\n}\n```\n\n## Case\n\n**The job.** Gather an applicant\'s papers into one case, make the forms it needs, and file it on time.\n\n**Read.** Lists with `expect` for the papers brought (one line per kind, the missing ones empty), an Act\'s `templates` for the forms made (ticked and made at once, kept in `into`), and `intake` reading the papers brought.\n\n**Keys.** `reference/list-node`, `reference/act-node`\n\n**Not when.** A record that needs no papers, or one paper made once \u2014 a single `template` act.\n\n```json\n{\n "tables": [\n {\n "ref": "ho_so",\n "title": "khach_hang",\n "fields": {\n "khach_hang": {"type": "link", "table": "khach_hang", "multi": false},\n "du_an": {"type": "link", "table": "du_an", "multi": false},\n "ma_ho_so": {"type": "autonumber"},\n "dich_vu": {\n "type": "select",\n "options": [{"alias": "tron_goi", "color": "blue"}, {"alias": "lam_ho_so", "color": "violet"}]\n },\n "doi_tuong": {\n "type": "select",\n "options": [\n {"alias": "thu_nhap_thap", "color": "sky"},\n {"alias": "cong_nhan", "color": "teal"},\n {"alias": "can_bo", "color": "indigo"},\n {"alias": "luc_luong", "color": "green"},\n {"alias": "ho_ngheo", "color": "amber"},\n {"alias": "nguoi_co_cong", "color": "rose"}\n ]\n },\n "tinh_trang_nha_o": {\n "type": "select",\n "options": [{"alias": "chua_co_nha", "color": "gray"}, {"alias": "nha_chat", "color": "orange"}]\n },\n "giay_chung_nhan_so": {"type": "text"},\n "dien_tich_nha": {"type": "number"},\n "sale": {"type": "member"},\n "xu_ly": {"type": "member"},\n "can_bo_sung": {"type": "boolean"},\n "phi_dich_vu": {"type": "number", "notation": {"style": "currency", "currency": "VND"}},\n "loai_can": {\n "type": "select",\n "options": [\n {"alias": "studio", "color": "sky"},\n {"alias": "mot_pn", "color": "blue"},\n {"alias": "hai_pn", "color": "indigo"},\n {"alias": "ba_pn", "color": "violet"}\n ]\n },\n "giai_doan": {\n "type": "select",\n "options": [\n {"alias": "ngay_thu_phi", "color": "blue"},\n {"alias": "ngay_nhan_giay_to", "color": "blue"},\n {"alias": "ngay_lap_ho_so", "color": "blue"},\n {"alias": "ngay_nop_cdt", "color": "blue"},\n {"alias": "ngay_cdt_duyet", "color": "blue"},\n {"alias": "ngay_so_xd_duyet", "color": "blue"},\n {"alias": "ngay_boc_tham", "color": "blue"},\n {"alias": "ngay_ky_hdmb", "color": "green"},\n {"alias": "ngay_ban_giao", "color": "green"}\n ]\n },\n "ngay_thu_phi": {"type": "date"},\n "ngay_nhan_giay_to": {"type": "date"},\n "ngay_lap_ho_so": {"type": "date"},\n "ngay_nop_cdt": {"type": "date"},\n "ngay_cdt_duyet": {"type": "date"},\n "ngay_so_xd_duyet": {"type": "date"},\n "ngay_boc_tham": {"type": "date"},\n "ngay_ky_hdmb": {"type": "date"},\n "ngay_ban_giao": {"type": "date"},\n "bo_ho_so": {"type": "files"},\n "giay_to": {"type": "link", "table": "giay_to", "multi": true},\n "thanh_vien": {"type": "link", "table": "thanh_vien", "multi": true},\n "phieu_thu": {"type": "link", "table": "phieu_thu", "multi": true},\n "dien_thoai": {"type": "lookup"},\n "cccd": {"type": "lookup"},\n "ngay_sinh": {"type": "lookup"},\n "da_thu": {"type": "rollup"},\n "chua_thu_phi": {"type": "formula"},\n "da_hoan_tat": {"type": "formula"}\n },\n "records": {\n "subtitle": ["dich_vu"],\n "figure": "phi_dich_vu",\n "status": {\n "field": "giai_doan",\n "closed": ["ngay_ky_hdmb", "ngay_ban_giao"],\n "dates": {\n "ngay_thu_phi": "ngay_thu_phi",\n "ngay_nhan_giay_to": "ngay_nhan_giay_to",\n "ngay_lap_ho_so": "ngay_lap_ho_so",\n "ngay_nop_cdt": "ngay_nop_cdt",\n "ngay_cdt_duyet": "ngay_cdt_duyet",\n "ngay_so_xd_duyet": "ngay_so_xd_duyet",\n "ngay_boc_tham": "ngay_boc_tham",\n "ngay_ky_hdmb": "ngay_ky_hdmb",\n "ngay_ban_giao": "ngay_ban_giao"\n }\n }\n }\n },\n {\n "ref": "thanh_vien",\n "title": "ho_ten",\n "fields": {\n "ho_ten": {"type": "text"},\n "ho_so": {"type": "link", "table": "ho_so", "multi": false},\n "quan_he": {\n "type": "select",\n "options": [\n {"alias": "nguoi_dung_don", "color": "blue"},\n {"alias": "vo_chong", "color": "violet"},\n {"alias": "con", "color": "teal"},\n {"alias": "bo_me", "color": "amber"},\n {"alias": "khac", "color": "gray"}\n ]\n },\n "ngay_sinh": {"type": "date"},\n "cccd": {"type": "text"},\n "thu_nhap": {"type": "number", "notation": {"style": "currency", "currency": "VND"}}\n },\n "records": {"subtitle": ["quan_he", "cccd"], "party": "person", "figure": "thu_nhap"}\n },\n {\n "ref": "giay_to",\n "title": "loai",\n "fields": {\n "loai": {\n "type": "select",\n "options": [\n {"alias": "don_dang_ky", "color": "blue"},\n {"alias": "can_cuoc", "color": "sky"},\n {"alias": "giay_doi_tuong", "color": "violet"},\n {"alias": "xac_nhan_nha_o", "color": "teal"},\n {"alias": "xac_nhan_thu_nhap", "color": "amber"},\n {"alias": "hon_nhan", "color": "indigo"}\n ]\n },\n "ho_so": {"type": "link", "table": "ho_so", "multi": false},\n "ngay_nhan": {"type": "date"},\n "tep": {"type": "files"}\n },\n "records": {"image": "tep", "starts": {"ngay_nhan": "today"}}\n },\n {\n "ref": "phieu_thu",\n "title": "khoan",\n "fields": {\n "khoan": {\n "type": "select",\n "options": [\n {"alias": "dat_coc", "color": "blue"},\n {"alias": "tat_toan", "color": "indigo"},\n {"alias": "phi_ho_so", "color": "violet"}\n ]\n },\n "ho_so": {"type": "link", "table": "ho_so", "multi": false},\n "so_tien": {"type": "number", "notation": {"style": "currency", "currency": "VND"}},\n "hinh_thuc": {\n "type": "select",\n "options": [\n {"alias": "tien_mat", "color": "green", "mark": {"kind": "icon", "name": "banknote"}},\n {"alias": "chuyen_khoan", "color": "blue", "mark": {"kind": "icon", "name": "arrow-right-left"}}\n ]\n },\n "trang_thai": {\n "type": "select",\n "options": [\n {"alias": "cho_thu", "color": "amber"},\n {"alias": "da_thu", "color": "green"},\n {"alias": "huy", "color": "gray"}\n ]\n },\n "ngay_thu": {"type": "date"}\n },\n "records": {\n "subtitle": ["hinh_thuc", "ngay_thu"],\n "figure": "so_tien",\n "status": {"field": "trang_thai", "closed": ["da_thu", "huy"]}\n }\n }\n ],\n "templates": [\n {"alias": "don_dang_ky", "type": "html", "label": "\u0110\u01A1n \u0111\u0103ng k\xFD mua nh\xE0 \u1EDF x\xE3 h\u1ED9i"},\n {"alias": "mau_02_chua_co_nha", "type": "html", "label": "M\u1EABu 02 \u2014 X\xE1c nh\u1EADn ch\u01B0a c\xF3 nh\xE0 \u1EDF"},\n {"alias": "mau_03_nha_chat", "type": "html", "label": "M\u1EABu 03 \u2014 X\xE1c nh\u1EADn nh\xE0 \u1EDF d\u01B0\u1EDBi 15 m\xB2/ng\u01B0\u1EDDi"},\n {"alias": "mau_05_thu_nhap", "type": "html", "label": "M\u1EABu 05 \u2014 X\xE1c nh\u1EADn thu nh\u1EADp"},\n {"alias": "danh_sach_nop", "type": "html", "label": "Danh s\xE1ch h\u1ED3 s\u01A1 n\u1ED9p ch\u1EE7 \u0111\u1EA7u t\u01B0"}\n ],\n "body": {\n "type": "App",\n "key": "ho_so",\n "name": "H\u1ED3 s\u01A1 nh\xE0 \u1EDF x\xE3 h\u1ED9i",\n "icon": "folder-open",\n "color": "blue",\n "scope": "du_an",\n "folders": "cac_du_an",\n "children": [\n {\n "type": "List",\n "entity": "ho_so",\n "columns": ["can_bo_sung", "doi_tuong", "xu_ly"],\n "filters": ["xu_ly", "can_bo_sung"],\n "search": ["khach_hang", "ma_ho_so", "dien_thoai"],\n "create": ["khach_hang", "dich_vu", "doi_tuong", "tinh_trang_nha_o", "loai_can", "phi_dich_vu", "sale"],\n "children": [\n {\n "type": "Reading",\n "key": "register_reading_0",\n "label": "Ch\u1EDD kh\xE1ch b\u1ED5 sung",\n "where": {"can_bo_sung": true}\n },\n {\n "type": "Reading",\n "key": "register_reading_1",\n "label": "Ph\xED \u0111\xE3 thu",\n "value": "da_thu",\n "over": "ngay_nhan_giay_to"\n },\n {"type": "Reading", "key": "register_reading_2", "by": "doi_tuong"},\n {"type": "Export", "key": "export"},\n {\n "type": "Act",\n "key": "in_danh_sach",\n "label": "In danh s\xE1ch n\u1ED9p ch\u1EE7 \u0111\u1EA7u t\u01B0",\n "on": "view",\n "template": "danh_sach_nop"\n }\n ]\n },\n {\n "type": "List",\n "entity": "du_an",\n "key": "cac_du_an",\n "columns": ["han_nop"],\n "create": false,\n "sort": {"field": "han_nop"},\n "children": [{"type": "Reading", "key": "du_an_theo_trang_thai", "by": "trang_thai"}]\n }\n ],\n "pages": [\n {\n "type": "Record",\n "entity": "ho_so",\n "children": [\n {\n "type": "Section",\n "key": "nguoi_dung_don",\n "title": "Ng\u01B0\u1EDDi \u0111\u1EE9ng \u0111\u01A1n",\n "children": [\n "ma_ho_so",\n {"field": "khach_hang", "block": true, "label": "Th\xF4ng tin c\xE1 nh\xE2n"},\n {\n "type": "Fieldset",\n "key": "dieu_kien",\n "label": "\u0110i\u1EC1u ki\u1EC7n mua",\n "children": ["doi_tuong", "tinh_trang_nha_o"]\n },\n {\n "type": "Fieldset",\n "key": "phu_trach",\n "label": "Ph\u1EE5 tr\xE1ch",\n "children": ["sale", "xu_ly", "can_bo_sung", "phi_dich_vu"]\n },\n {\n "type": "List",\n "entity": "thanh_vien",\n "label": "H\u1ED9 gia \u0111\xECnh",\n "columns": ["ngay_sinh"],\n "create": ["ho_ten", "quan_he", "ngay_sinh", "cccd", "thu_nhap"]\n },\n {\n "type": "List",\n "entity": "giay_to",\n "expect": {"field": "loai", "only": ["can_cuoc", "hon_nhan"]},\n "label": "Gi\u1EA5y t\u1EDD c\xE1 nh\xE2n",\n "columns": ["ngay_nhan"]\n },\n {\n "type": "Act",\n "key": "doc_giay_to",\n "label": "\u0110\u1ECDc gi\u1EA5y t\u1EDD",\n "intake": "giay_to",\n "fills": [\n "doi_tuong",\n "tinh_trang_nha_o",\n "giay_chung_nhan_so",\n "dien_tich_nha",\n "khach_hang.ho_ten",\n "khach_hang.cccd",\n "khach_hang.ngay_sinh",\n "khach_hang.dia_chi",\n "thanh_vien"\n ]\n },\n {\n "type": "Act",\n "key": "giao_xu_ly",\n "label": "Giao ng\u01B0\u1EDDi x\u1EED l\xFD",\n "asks": [{"input": "nguoi", "label": "Ng\u01B0\u1EDDi x\u1EED l\xFD", "type": "member", "required": true}],\n "set": {"xu_ly": {"input": "nguoi"}}\n },\n {\n "type": "Act",\n "key": "chuyen_du_an",\n "label": "Chuy\u1EC3n d\u1EF1 \xE1n",\n "asks": [\n {\n "input": "du_an_moi",\n "label": "Sang d\u1EF1 \xE1n",\n "type": "link",\n "entity": "du_an",\n "required": true\n }\n ],\n "set": {"du_an": {"input": "du_an_moi"}},\n "confirm": true\n }\n ]\n },\n {\n "type": "Section",\n "key": "bo_ho_so",\n "title": "B\u1ED9 h\u1ED3 s\u01A1",\n "at": ["ngay_nhan_giay_to", "ngay_lap_ho_so"],\n "children": [\n "ngay_nhan_giay_to",\n "ngay_lap_ho_so",\n {\n "type": "Act",\n "key": "tao_giay_to",\n "label": "T\u1EA1o gi\u1EA5y t\u1EDD",\n "templates": [\n {"template": "don_dang_ky"},\n {"template": "mau_02_chua_co_nha", "when": {"tinh_trang_nha_o": ["chua_co_nha"]}},\n {"template": "mau_03_nha_chat", "when": {"tinh_trang_nha_o": ["nha_chat"]}}\n ],\n "into": "bo_ho_so",\n "when": {"giai_doan": ["ngay_nhan_giay_to", "ngay_lap_ho_so"]}\n },\n {\n "type": "Act",\n "key": "nop_cdt",\n "label": "N\u1ED9p ch\u1EE7 \u0111\u1EA7u t\u01B0",\n "when": {"dich_vu": ["tron_goi"], "giai_doan": ["ngay_lap_ho_so"]},\n "requires": ["bo_ho_so", "loai_can"],\n "asks": ["loai_can"],\n "set": {"giai_doan": "ngay_nop_cdt"},\n "confirm": true\n },\n {\n "type": "Act",\n "key": "to_ngay_nhan_giay_to",\n "label": "\u0110\xE3 nh\u1EADn gi\u1EA5y t\u1EDD",\n "when": {"giai_doan": {"empty": true}, "dich_vu": ["tron_goi"]},\n "asks": [{"field": "ngay_nhan_giay_to", "starts": "today"}],\n "set": {"giai_doan": "ngay_nhan_giay_to"}\n },\n {\n "type": "Act",\n "key": "to_ngay_lap_ho_so",\n "label": "\u0110\xE3 l\u1EADp h\u1ED3 s\u01A1",\n "when": {"giai_doan": ["ngay_nhan_giay_to"], "dich_vu": ["tron_goi"]},\n "asks": [{"field": "ngay_lap_ho_so", "starts": "today"}],\n "set": {"giai_doan": "ngay_lap_ho_so"}\n },\n {\n "type": "Act",\n "key": "to_ngay_ban_giao",\n "label": "\u0110\xE3 b\xE0n giao h\u1ED3 s\u01A1",\n "when": {"giai_doan": ["ngay_nhan_giay_to"], "dich_vu": ["lam_ho_so"]},\n "asks": [{"field": "ngay_ban_giao", "starts": "today"}],\n "set": {"giai_doan": "ngay_ban_giao"}\n }\n ]\n },\n {\n "type": "Act",\n "key": "lap_mau_05",\n "label": "L\u1EADp m\u1EABu 05",\n "when": {"doi_tuong": ["thu_nhap_thap"]},\n "template": "mau_05_thu_nhap",\n "paper": "giay_to.xac_nhan_thu_nhap"\n },\n {"type": "Check", "field": "chua_thu_phi", "on": ["nop_cdt"]},\n {"type": "Check", "field": "da_hoan_tat", "on": ["doc_giay_to"]}\n ],\n "row": {"figure": false}\n },\n {"type": "Record", "entity": "du_an", "add": ["ten_du_an", "chu_dau_tu", "so_can"]}\n ]\n }\n}\n```\n\n## Calls\n\n**The job.** Call a lead from their record, and keep what was said as a touch on its timeline.\n\n**Read.** An Act\'s `record` (into the `timeline` child: audio, transcript, when and who) and `fills` (the touch\'s fields an agent fills from the transcript).\n\n**Keys.** `reference/act-node`, `reference/layouts`\n\n**Not when.** Calls made and logged elsewhere \u2014 a `timeline` with its own add keeps the note.\n\n```json\n{\n "tables": [\n {\n "ref": "khach_tiem_nang",\n "title": "ho_ten",\n "fields": {\n "ho_ten": {"type": "text"},\n "ten_cong_ty": {"type": "text"},\n "vai_tro": {\n "type": "select",\n "options": [\n {"alias": "chu_doanh_nghiep", "color": "emerald"},\n {"alias": "ke_toan_truong", "color": "blue"},\n {"alias": "quan_ly", "color": "teal"},\n {"alias": "nhan_vien", "color": "sky"},\n {"alias": "chua_ro", "color": "zinc"}\n ]\n },\n "loai_hinh": {\n "type": "select",\n "options": [\n {"alias": "thuong_mai", "color": "blue"},\n {"alias": "san_xuat", "color": "amber"},\n {"alias": "dich_vu", "color": "violet"},\n {"alias": "xay_dung", "color": "orange"},\n {"alias": "ho_kinh_doanh", "color": "teal"},\n {"alias": "chua_ro", "color": "zinc"}\n ]\n },\n "quy_mo": {\n "type": "select",\n "options": [\n {"alias": "q_1_10", "color": "sky"},\n {"alias": "q_11_50", "color": "blue"},\n {"alias": "q_51_200", "color": "indigo"},\n {"alias": "q_200", "color": "violet"},\n {"alias": "chua_ro", "color": "zinc"}\n ]\n },\n "so_dien_thoai": {"type": "text"},\n "zalo": {"type": "text"},\n "email": {"type": "text"},\n "trang_ca_nhan": {"type": "text", "format": "link"},\n "anh": {"type": "files"},\n "trang_thai": {\n "type": "select",\n "options": [\n {"alias": "moi", "color": "gray"},\n {"alias": "du_dieu_kien", "color": "blue"},\n {"alias": "da_lien_he", "color": "amber"},\n {"alias": "da_chuyen_doi", "color": "emerald"},\n {"alias": "loai", "color": "red"}\n ]\n },\n "ly_do_loai": {\n "type": "select",\n "options": [\n {"alias": "khong_phu_hop", "color": "orange"},\n {"alias": "qua_nho", "color": "amber"},\n {"alias": "chua_co_ngan_sach", "color": "yellow"},\n {"alias": "sai_nguoi", "color": "blue"},\n {"alias": "yeu_cau_dung", "color": "red"},\n {"alias": "trung", "color": "zinc"}\n ]\n },\n "vi_sao_du_dieu_kien": {"type": "text"},\n "phu_trach": {"type": "member"},\n "nguon": {"type": "link", "table": "kenh", "multi": false},\n "lien_he": {"type": "link", "table": "lien_he", "multi": false},\n "cong_ty": {"type": "link", "table": "cong_ty", "multi": false},\n "ngay_chuyen_doi": {"type": "date", "format": "datetime", "timezone": "Asia/Ho_Chi_Minh"},\n "ghi_chu": {"type": "text", "format": "markdown"},\n "tin_hieu": {"type": "link", "table": "tin_hieu", "multi": true},\n "buoc_tiep": {"type": "link", "table": "buoc_tiep", "multi": true},\n "tuong_tac": {"type": "link", "table": "tuong_tac", "multi": true},\n "do_nong": {\n "type": "formula",\n "options": [\n {"alias": "nong", "label": "N\xF3ng", "color": "orange"},\n {"alias": "nguoi", "label": "Ngu\u1ED9i", "color": "sky"}\n ]\n },\n "han_buoc_tiep": {"type": "rollup"},\n "khong_lien_he": {"type": "formula"}\n },\n "records": {\n "subtitle": ["ten_cong_ty"],\n "image": "anh",\n "party": "person",\n "due": ["han_buoc_tiep"],\n "status": {\n "field": "trang_thai",\n "closed": ["da_chuyen_doi", "loai"],\n "dates": {"da_chuyen_doi": "ngay_chuyen_doi"}\n }\n }\n },\n {\n "ref": "tin_hieu",\n "title": "tom_tat",\n "fields": {\n "tom_tat": {"type": "text"},\n "noi_dung": {"type": "text", "format": "markdown"},\n "anh_chup": {"type": "files"},\n "lien_ket": {"type": "text", "format": "link"},\n "kenh": {"type": "link", "table": "kenh", "multi": false},\n "loai": {\n "type": "select",\n "options": [\n {"alias": "hoi_dich_vu", "color": "emerald"},\n {"alias": "than_phien", "color": "blue"},\n {"alias": "tuyen_ke_toan", "color": "amber"},\n {"alias": "moi_thanh_lap", "color": "violet"},\n {"alias": "gioi_thieu", "color": "teal"},\n {"alias": "danh_ba", "color": "zinc"},\n {"alias": "nhieu", "color": "stone"}\n ]\n },\n "ngay_dang": {"type": "date", "timezone": "Asia/Ho_Chi_Minh"},\n "ngay_xay_ra": {"type": "formula"}\n },\n "records": {"subtitle": ["kenh", "ngay_xay_ra"], "image": "anh_chup"}\n },\n {\n "ref": "buoc_tiep",\n "title": "vi_sao_luc_nay",\n "fields": {\n "vi_sao_luc_nay": {"type": "text"},\n "viec": {\n "type": "select",\n "options": [\n {"alias": "binh_luan", "color": "blue", "mark": {"kind": "icon", "name": "message-square"}},\n {"alias": "nhan_facebook", "color": "violet", "mark": {"kind": "brand", "name": "facebook"}},\n {"alias": "nhan_zalo", "color": "sky", "mark": {"kind": "brand", "name": "zalo"}},\n {"alias": "goi_dien", "color": "teal", "mark": {"kind": "icon", "name": "phone"}},\n {"alias": "gui_email", "color": "indigo", "mark": {"kind": "icon", "name": "mail"}},\n {"alias": "gui_bang_gia", "color": "amber", "mark": {"kind": "icon", "name": "receipt"}}\n ]\n },\n "ban_nhap": {"type": "text", "format": "markdown"},\n "han": {"type": "date", "format": "datetime", "timezone": "Asia/Ho_Chi_Minh"},\n "tinh_trang": {\n "type": "select",\n "options": [\n {"alias": "cho", "color": "blue"},\n {"alias": "xong", "color": "emerald"},\n {"alias": "bo_qua", "color": "zinc"}\n ]\n }\n },\n "records": {\n "subtitle": ["viec"],\n "mark": "viec",\n "due": ["han"],\n "status": {"field": "tinh_trang", "closed": ["xong", "bo_qua"]}\n }\n },\n {\n "ref": "tuong_tac",\n "title": "tom_tat",\n "fields": {\n "tom_tat": {"type": "text"},\n "thoi_diem": {"type": "date", "format": "datetime", "timezone": "Asia/Ho_Chi_Minh"},\n "qua": {\n "type": "select",\n "options": [\n {"alias": "goi_dien", "color": "teal", "mark": {"kind": "icon", "name": "phone"}},\n {"alias": "zalo", "color": "sky", "mark": {"kind": "brand", "name": "zalo"}},\n {"alias": "facebook", "color": "blue", "mark": {"kind": "brand", "name": "facebook"}},\n {"alias": "email", "color": "indigo", "mark": {"kind": "icon", "name": "mail"}},\n {"alias": "gap_truc_tiep", "color": "emerald", "mark": {"kind": "icon", "name": "users"}},\n {"alias": "khac", "color": "zinc", "mark": {"kind": "icon", "name": "ellipsis"}}\n ]\n },\n "phan_hoi": {\n "type": "select",\n "options": [\n {"alias": "dang_cho", "color": "blue"},\n {"alias": "da_tra_loi", "color": "green"},\n {"alias": "quan_tam", "color": "amber"},\n {"alias": "khong_phu_hop", "color": "red"},\n {"alias": "khong_phan_hoi", "color": "zinc"},\n {"alias": "sai_so", "color": "stone"}\n ]\n },\n "ghi_am": {"type": "files"},\n "man_hinh": {"type": "files"},\n "nguyen_van": {"type": "text", "format": "markdown"},\n "hen_lai": {"type": "date", "timezone": "Asia/Ho_Chi_Minh"},\n "nguoi_thuc_hien": {"type": "member"}\n },\n "records": {"subtitle": ["qua", "phan_hoi"]}\n }\n ],\n "body": {\n "type": "App",\n "key": "khach_tiem_nang",\n "name": "Kh\xE1ch ti\u1EC1m n\u0103ng",\n "icon": "radar",\n "color": "violet",\n "children": [\n {\n "type": "List",\n "entity": "khach_tiem_nang",\n "columns": ["phu_trach", "han_buoc_tiep"],\n "filters": ["phu_trach"],\n "create": ["ho_ten", "trang_ca_nhan", "so_dien_thoai", "ten_cong_ty", "nguon"],\n "children": [\n {"type": "Reading", "key": "register_reading_0", "by": "phu_trach"},\n {\n "type": "Reading",\n "key": "register_reading_1",\n "label": "Kh\xE1ch chuy\u1EC3n \u0111\u1ED5i",\n "by": "ngay_chuyen_doi"\n }\n ]\n }\n ],\n "pages": [\n {\n "type": "Record",\n "entity": "khach_tiem_nang",\n "children": [\n {\n "type": "Section",\n "key": "danh_gia",\n "title": "\u0110\xE1nh gi\xE1",\n "at": ["moi"],\n "children": [\n "vai_tro",\n "loai_hinh",\n "quy_mo",\n "vi_sao_du_dieu_kien",\n "do_nong",\n {\n "type": "List",\n "entity": "tin_hieu",\n "columns": ["loai", "noi_dung"],\n "create": ["tom_tat", "anh_chup", "loai", "noi_dung", "kenh", "lien_ket", "ngay_dang"]\n },\n {\n "type": "Act",\n "key": "danh_gia_dat",\n "label": "\u0110\u1EE7 \u0111i\u1EC1u ki\u1EC7n",\n "when": {"trang_thai": ["moi"]},\n "requires": ["vi_sao_du_dieu_kien"],\n "set": {"trang_thai": "du_dieu_kien"}\n }\n ]\n },\n {\n "type": "Section",\n "key": "lien_he",\n "title": "Li\xEAn h\u1EC7",\n "at": ["du_dieu_kien"],\n "children": [\n "so_dien_thoai",\n "phu_trach",\n "trang_ca_nhan",\n "zalo",\n "email",\n {"field": "ghi_chu", "block": false},\n {\n "type": "List",\n "entity": "buoc_tiep",\n "columns": ["ban_nhap"],\n "create": ["vi_sao_luc_nay", "viec", "han", "ban_nhap"]\n },\n {\n "type": "List",\n "entity": "tuong_tac",\n "layout": "timeline",\n "create": ["tom_tat", "qua", "phan_hoi", "thoi_diem", "hen_lai"]\n },\n {\n "type": "Act",\n "key": "ghi_cuoc_goi",\n "label": "Ghi \xE2m cu\u1ED9c g\u1ECDi",\n "when": {"trang_thai": ["du_dieu_kien"]},\n "fills": ["tom_tat", "phan_hoi"],\n "record": {\n "into": "tuong_tac",\n "audio": "ghi_am",\n "transcript": "nguyen_van",\n "at": "thoi_diem",\n "by": "nguoi_thuc_hien",\n "video": "man_hinh"\n }\n },\n {\n "type": "Act",\n "key": "da_lien_he",\n "label": "\u0110\xE1nh d\u1EA5u \u0111\xE3 li\xEAn h\u1EC7",\n "when": {"trang_thai": ["du_dieu_kien"]},\n "set": {"trang_thai": "da_lien_he"}\n }\n ]\n },\n {\n "type": "Section",\n "key": "chuyen_doi",\n "title": "Chuy\u1EC3n \u0111\u1ED5i",\n "at": ["da_lien_he"],\n "children": [\n "nguon",\n {"field": "lien_he", "edit": false},\n {"field": "cong_ty", "edit": false},\n {\n "type": "Act",\n "key": "chuyen_doi",\n "label": "Chuy\u1EC3n \u0111\u1ED5i",\n "when": {"trang_thai": ["da_lien_he"]},\n "workflow": "chuyen_doi_khach",\n "confirm": true\n }\n ]\n },\n {\n "type": "Section",\n "key": "loai",\n "title": "Lo\u1EA1i",\n "at": ["loai"],\n "children": [\n "ly_do_loai",\n {\n "type": "Act",\n "key": "loai",\n "label": "Lo\u1EA1i",\n "when": {"trang_thai": ["moi", "du_dieu_kien", "da_lien_he"]},\n "asks": ["ly_do_loai"],\n "set": {"trang_thai": "loai"},\n "danger": true\n },\n {\n "type": "Act",\n "key": "mo_lai",\n "label": "M\u1EDF l\u1EA1i",\n "when": {"trang_thai": ["loai"]},\n "set": {"trang_thai": "moi"}\n }\n ]\n },\n {"type": "Check", "field": "khong_lien_he", "resolve": "da_lien_he"}\n ]\n },\n {"type": "Record", "entity": "kenh", "add": ["ten", "loai"]},\n {\n "type": "Record",\n "entity": "buoc_tiep",\n "children": [\n {\n "type": "Act",\n "key": "lam_xong",\n "label": "\u0110\xE3 l\xE0m",\n "when": {"tinh_trang": ["cho"]},\n "set": {"tinh_trang": "xong"}\n }\n ]\n }\n ]\n }\n}\n```\n\n## Approval\n\n**The job.** Raise a payment request, see it through approval, and read what is waiting at the top of the list.\n\n**Read.** `records.de_nghi.status` with its `history` (each move: when and who), Sections staged by `at`, and the List\'s Readings leading with the headline number. The history stays because the business reads who signed each move; where only the day a stage was reached matters, the status stamps a date on the row instead (the Gantt above).\n\n**Keys.** `reference/status`, `reference/section-node`, `reference/reading-node`\n\n**Not when.** Rows that never move \u2014 a reference list (a price list, a catalog) has no status and no headline number.\n\n```json\n{\n "tables": [\n {\n "ref": "de_nghi",\n "title": "noi_dung",\n "fields": {\n "noi_dung": {"type": "text"},\n "so_de_nghi": {"type": "text"},\n "loai": {\n "type": "select",\n "options": [\n {"alias": "thanh_toan_ncc", "color": "violet"},\n {"alias": "nhan_cong", "color": "indigo"},\n {"alias": "chi_phi_cong_truong", "color": "sky"},\n {"alias": "tam_ung", "color": "amber"},\n {"alias": "hoan_ung", "color": "teal"}\n ]\n },\n "du_an": {"type": "link", "table": "du_an", "multi": false},\n "nha_cung_cap": {"type": "link", "table": "nha_cung_cap", "multi": false},\n "so_tien": {"type": "number", "notation": {"style": "currency", "currency": "VND"}},\n "han_thanh_toan": {"type": "date"},\n "trang_thai": {\n "type": "select",\n "options": [\n {"alias": "nhap", "color": "slate"},\n {"alias": "cho_duyet", "color": "amber"},\n {"alias": "cho_chu_tich", "color": "violet"},\n {"alias": "da_duyet", "color": "blue"},\n {"alias": "da_chi", "color": "green"},\n {"alias": "tu_choi", "color": "rose"}\n ]\n },\n "nguoi_de_nghi": {"type": "member"},\n "chung_tu": {"type": "files"},\n "nguoi_duyet": {"type": "member"},\n "duyet_luc": {"type": "date", "format": "datetime"},\n "ly_do_tu_choi": {"type": "text"},\n "phieu_chi": {"type": "files"},\n "ngan_sach_du_an": {"type": "lookup"},\n "da_duyet_du_an": {"type": "lookup"},\n "da_gui": {"type": "formula"},\n "nhap_at": {"type": "date", "format": "datetime"},\n "cho_duyet_at": {"type": "date", "format": "datetime"},\n "cho_chu_tich_at": {"type": "date", "format": "datetime"},\n "da_duyet_at": {"type": "date", "format": "datetime"}\n },\n "records": {\n "subtitle": ["du_an"],\n "figure": "so_tien",\n "limits": {"da_duyet_du_an": "ngan_sach_du_an"},\n "due": ["han_thanh_toan"],\n "starts": {"nguoi_de_nghi": "me"},\n "status": {\n "field": "trang_thai",\n "closed": ["da_chi", "tu_choi"],\n "dropped": ["tu_choi"],\n "dates": {\n "nhap": "nhap_at",\n "cho_duyet": "cho_duyet_at",\n "cho_chu_tich": "cho_chu_tich_at",\n "da_duyet": "da_duyet_at"\n },\n "history": "lich_su_duyet",\n "stages": {\n "nhap": {"owner": "nguoi_de_nghi"},\n "cho_duyet": {"owner": {"group": "<id of the giam_doc group>"}, "within": 1},\n "cho_chu_tich": {\n "owner": {"group": "<id of the chu_tich group>"},\n "within": 2,\n "when": {"so_tien": {"gt": 200000000}}\n },\n "da_duyet": {"owner": {"group": "<id of the ke_toan group>"}, "within": 2}\n }\n }\n }\n }\n ],\n "body": {\n "type": "App",\n "key": "de_nghi_chi",\n "name": "\u0110\u1EC1 ngh\u1ECB thanh to\xE1n",\n "icon": "hand-coins",\n "color": "amber",\n "children": [\n {\n "type": "List",\n "entity": "de_nghi",\n "filters": ["du_an"],\n "group": "du_an",\n "create": ["noi_dung", "loai", "du_an", "nha_cung_cap", "so_tien", "han_thanh_toan", "nguoi_de_nghi"],\n "children": [\n {\n "type": "Reading",\n "key": "register_reading_0",\n "label": "\u0110\xE3 duy\u1EC7t, ch\u1EDD chi",\n "value": "so_tien",\n "where": {"trang_thai": ["da_duyet"]}\n },\n {"type": "Reading", "key": "register_reading_1", "value": "so_tien", "by": "han_thanh_toan"}\n ]\n }\n ],\n "pages": [\n {\n "type": "Record",\n "entity": "de_nghi",\n "door": "drawer",\n "children": [\n {\n "type": "Section",\n "key": "de_nghi",\n "title": "\u0110\u1EC1 ngh\u1ECB",\n "at": ["nhap"],\n "children": [\n "so_de_nghi",\n "loai",\n "nha_cung_cap",\n "han_thanh_toan",\n "nguoi_de_nghi",\n {"field": "chung_tu"},\n {\n "type": "Act",\n "key": "gui_duyet",\n "label": "G\u1EEDi duy\u1EC7t",\n "when": {"trang_thai": ["nhap"]},\n "requires": ["chung_tu", "nguoi_de_nghi"],\n "set": {"trang_thai": "cho_duyet"}\n }\n ]\n },\n {\n "type": "Section",\n "key": "duyet",\n "title": "Duy\u1EC7t",\n "at": ["cho_duyet", "cho_chu_tich"],\n "children": [\n {"field": "nguoi_duyet", "edit": false},\n {"field": "duyet_luc", "edit": false},\n {"field": "ly_do_tu_choi", "edit": false},\n {\n "type": "Act",\n "key": "rut_lai",\n "label": "R\xFAt l\u1EA1i",\n "when": {"trang_thai": ["cho_duyet", "cho_chu_tich"]},\n "set": {"trang_thai": "nhap"},\n "confirm": true\n }\n ]\n },\n {\n "type": "Section",\n "key": "da_chi",\n "title": "\u0110\xE3 chi",\n "at": ["da_chi"],\n "children": [{"field": "phieu_chi", "edit": false}]\n },\n {"type": "Check", "field": "da_gui", "on": ["update"]}\n ]\n },\n {"type": "Record", "entity": "du_an", "add": ["ten", "ma_du_an", "chu_dau_tu", "ngan_sach"]}\n ]\n }\n}\n```\n\n## Dashboard\n\n**The job.** The owner\'s question \u2014 what came in, what went out, where it went, and what is still unmatched \u2014 answered over one period.\n\n**Read.** An App of Readings and no List: Readings with `over` (the period windows them), a Reading `by` the day, Readings `by` a field, and a List of rows to act on.\n\n**Keys.** `reference/app-node`, `reference/reading-node`\n\n**Not when.** One job\'s headline numbers \u2014 those lead that job\'s List as its Readings.\n\n```json\n{\n "tables": [\n {\n "ref": "giao_dich",\n "title": "noi_dung",\n "fields": {\n "noi_dung": {"type": "text"},\n "ngay": {"type": "date"},\n "loai": {"type": "select", "options": [{"alias": "thu", "color": "green"}, {"alias": "chi", "color": "rose"}]},\n "so_tien": {"type": "number", "notation": {"style": "currency", "currency": "VND"}},\n "bien_dong": {"type": "formula", "notation": {"style": "currency", "currency": "VND"}},\n "doi_tuong": {"type": "link", "table": "doi_tuong", "multi": false},\n "danh_muc": {\n "type": "select",\n "options": [\n {"alias": "doanh_thu", "color": "green"},\n {"alias": "hang_hoa", "color": "blue"},\n {"alias": "van_chuyen", "color": "indigo"},\n {"alias": "nhan_su", "color": "violet"},\n {"alias": "van_phong", "color": "sky"},\n {"alias": "thue_phi", "color": "slate"},\n {"alias": "ngan_hang", "color": "teal"},\n {"alias": "khac", "color": "gray"}\n ]\n },\n "sao_ke": {"type": "link", "table": "sao_ke", "multi": false},\n "hoa_don": {"type": "link", "table": "hoa_don", "multi": true},\n "trang_thai": {\n "type": "select",\n "options": [\n {"alias": "chua_khop", "color": "amber"},\n {"alias": "da_khop", "color": "green"},\n {"alias": "khong_can_hd", "color": "slate"}\n ]\n },\n "khop_luc": {"type": "date", "format": "datetime"}\n },\n "records": {\n "subtitle": ["ngay"],\n "figure": "bien_dong",\n "status": {"field": "trang_thai", "closed": ["da_khop", "khong_can_hd"], "dates": {"da_khop": "khop_luc"}}\n }\n },\n {\n "ref": "hoa_don",\n "title": "doi_tuong",\n "fields": {\n "doi_tuong": {"type": "link", "table": "doi_tuong", "multi": false},\n "so_hoa_don": {"type": "text"},\n "ngay_hoa_don": {"type": "date"},\n "so_ngay_qua_han": {"type": "formula", "notation": {"style": "unit", "unit": "day"}},\n "chieu": {\n "type": "select",\n "options": [{"alias": "ban_ra", "color": "green"}, {"alias": "mua_vao", "color": "violet"}]\n },\n "tong_cong": {"type": "formula", "notation": {"style": "currency", "currency": "VND"}},\n "tep": {"type": "files"},\n "giao_dich": {"type": "link", "table": "giao_dich", "multi": true}\n },\n "records": {"subtitle": ["so_hoa_don", "ngay_hoa_don"], "image": "tep", "figure": "tong_cong"}\n }\n ],\n "body": {\n "type": "App",\n "key": "dong_tien",\n "name": "D\xF2ng ti\u1EC1n",\n "icon": "chart-line",\n "color": "emerald",\n "children": [\n {\n "type": "Sheet",\n "key": "dong_tien",\n "label": "D\xF2ng ti\u1EC1n",\n "children": [\n {\n "type": "Reading",\n "key": "dashboard_reading_0",\n "label": "Ti\u1EC1n v\xE0o",\n "entity": "giao_dich",\n "value": "so_tien",\n "where": {"loai": ["thu"]},\n "over": "ngay"\n },\n {\n "type": "Reading",\n "key": "dashboard_reading_1",\n "label": "Ti\u1EC1n ra",\n "entity": "giao_dich",\n "value": "so_tien",\n "where": {"loai": ["chi"]},\n "over": "ngay",\n "better": "down"\n },\n {\n "type": "Reading",\n "key": "dashboard_reading_2",\n "label": "D\xF2ng ti\u1EC1n r\xF2ng",\n "entity": "giao_dich",\n "value": "bien_dong",\n "by": "ngay"\n },\n {\n "type": "Reading",\n "key": "dashboard_reading_3",\n "label": "Chi theo danh m\u1EE5c",\n "entity": "giao_dich",\n "value": "so_tien",\n "where": {"loai": ["chi"]},\n "by": "danh_muc",\n "over": "ngay"\n },\n {\n "type": "Reading",\n "key": "dashboard_reading_4",\n "label": "Thu theo kh\xE1ch h\xE0ng",\n "entity": "giao_dich",\n "value": "so_tien",\n "where": {"loai": ["thu"]},\n "by": "doi_tuong",\n "over": "ngay"\n },\n {\n "type": "Reading",\n "key": "dashboard_reading_5",\n "label": "C\xF4ng n\u1EE3 b\xE1n ra theo tu\u1ED5i n\u1EE3",\n "entity": "hoa_don",\n "value": "tong_cong",\n "where": {"chieu": ["ban_ra"]},\n "by": "doi_tuong",\n "across": {"field": "so_ngay_qua_han", "tiers": [1, 8, 16, 31]}\n },\n {\n "type": "List",\n "key": "dashboard_reading_8",\n "entity": "giao_dich",\n "where": {"trang_thai": ["chua_khop"]},\n "label": "D\xF2ng ch\u01B0a kh\u1EDBp",\n "columns": ["sao_ke"]\n }\n ]\n }\n ]\n }\n}\n```\n';
1886
1886
 
1887
1887
  // docs/agent_surface.md
1888
1888
  var agent_surface_default = '# An app\'s agent surface\n\nEverything a person reads or does in an app, an agent reads or does through that app\'s **queries** and\n**workflows** \u2014 the same ones its screen runs, under the same permissions and the same rules. Three tools\nreach them, over MCP and as `lotics run <tool>`:\n\n| Tool | Answers |\n|---|---|\n| `get_app` | The app\'s `catalog`: its queries and workflows by alias, each one\'s description, its params or inputs with their types and legal values, and under a query\'s line its output columns (`returns`) \u2014 beside what each table they name holds, in its owner\'s words \u2014 and, for the app\'s author, `notes`: what its stored tree compiles with, each at its address under its rule id (`list.layout-call`, a root List drawing a table over rows a board layout would draw, with the layouts to state; `list.filter-unshown`, a filter no row draws, which the app leaves out) |\n| `run_app_query` | The rows, a count or the groups of one query \u2014 or of several in one call |\n| `run_app_workflow` | One write \u2014 or several in order \u2014 or a dry run of it that writes nothing |\n\nAn app generates this surface from its tree; Query and Workflow nodes declare what the screen never\nasks (`agent_surface/declaring-more`). Every root List of an app (a change may add one at any time) is part of it: each List\'s list, its rows by id, its page\'s\nLists and its Acts are queries and workflows of the same app, named by that List\'s table \u2014 `get_app` lists them in the\none roster, and nothing of a root List is another app\'s. Every caller the app is shared with is answered them, its rows narrowed by the app\'s row rules. A custom-code app\'s surface is the queries and workflows bound on it\n(`app_bindings`).\n\n## Finding what an app offers\n\n`get_workspace` maps the workspace. Its `search` matches the keys and descriptions of the Query and Workflow nodes an app declares, and the app\'s line names the matching keys; it never matches the generated `act_`, `create_` or `update_` aliases. `get_app` then gives the contracts. An agent runs a declared node before it falls back to `query_records`.\n\n## What every app generates\n\nA name in angle brackets is the app\'s alias for that thing; an `<entity>` is the alias of a table the app reads. `get_app` lists the ones a given\napp has.\n\n### Queries\n\n<!-- generated:start queries -->\n\n| Called | What it says of itself | Takes | Generated for |\n|---|---|---|---|\n| `<entity>_list` | Every row of <entity> the reader may see. | `search`?; `<scope entity>_id` where the app states `scope`; `<filter>_is`? per List `filters` field holding one value \u2014 a select, a one-row link, a member, a yes/no; `<filter>_from`? / `<filter>_to`? per date filter \u2014 none for a date holding a span; `<filter>_min`? / `<filter>_max`? per number filter \u2014 none over sources, none for a looked-up link or member, none for a number read in each row\'s own unit or currency | every entity the app draws; the filter params on the app\'s own entity alone; a root List after the first over an entity, whose chips differ from the first\'s, adds one of its own, called by its key |\n| `<entity>_list_<tab>` | The <entity> rows of the tab "<tab>". | the list\'s; `from`? / `to`? on a tab dated `in` a period; `to` on a tab of rows `open` on a day | each Tab of the register, and of each later root List over an entity, called by its key; none over sources, none for a Tab whose period reads a date holding a span |\n| `<entity>_totals_<tab>` | The <child> rows added per <entity> row, by "<link>", over the period from `from` to `to`, dated by "<date>": . | `from`; `to` | each Tab of the register stating `totals`, and of each later root List over an entity, called by its key |\n| `<entity>_record` | One row of <entity> by its id. | `<entity>_id` | every entity the app draws |\n| `<child>_by_<link>` | The <child> rows under one <entity>, through "<link>". | `<entity>_id` | each List of child rows on the record; one narrowed by `where` or ordered by `sort` adds `_<field>_<option>` and `_sorted_<field>` to its name |\n| `outside_<key>_one` | One row of <entity> by its id. | `record` | each Outside: the record a link opens, projected to the fields the Outside states |\n| `outside_<key>_<child>` | The <child> rows under one <entity>, through "<link>". | `record` | each List of an Outside: the rows under the record a link opens, projected to the List\'s columns |\n| `<child>_by_<link>_days` | The <child> rows of the <entity> rows handed in whose "<day>" falls from one day to another. | `<entity>_ids`; `from`; `to` | a roster List: the List of its cells |\n| `<entity>_<link>_pick` | The <target> rows "<link>" may point at, narrowed by what the reader typed. | `search`?; `same_<link>` per `same` link | a written link a write rule narrows (`options_where`, `same`) |\n| `<child>_by_<link>_picks` | The <child> rows no <entity> holds through "<link>" yet, that one <entity> may pick, narrowed by what the reader typed. | `search`?; `same_<link>` per `same` link | a List with `pick`: it picks existing rows into the record |\n| `<key>` | <label>: how many <entity> rows there are. Each row carries `__count`. | the list\'s; `from`? / `to`? where the reading states `over`, or its `tab` is dated `in` a period; `to` where its `tab` is of rows `open` on a day | each Reading of a List\'s band, called by its `key` \u2014 but the work against its plan (a Reading stating `planned` and `done`), which reads the List\'s own rows; none over sources |\n| `<key>` | <label>: how many <entity> rows there are. Each row carries `__count`. | `from`? / `to`? where the reading states `over` | each Reading and List of a Sheet, called by its `key` |\n| `<key>` | <label>: how many <child> rows there are. Each row carries `__count`. | `<entity>_id`; `same_<field>` where it is a List stating `same`; `record_<field>` per `where` bound to a field of the record | each Reading of a Record page, each List that only reads on it (its `key`, else its entity\'s alias) and each funnel, called by its `key` |\n| `<reading>_bound` | <label> / <bound>: the sum of "<bound>" over the <entity> rows. Each row carries `__count`, `__sum`. | its reading\'s | a Reading whose value `records.limits` bounds: the bound\'s sum, beside the Reading\'s own |\n| `<reading>_on_hand` | <label> / <on-hand entity>: how many <on-hand entity> rows there are, per "<field>". Each row carries `<field>`, `__count`. | none: every row of its entity its `where` keeps, whatever the place | a Reading with `on_hand` (a shortfall): the on-hand rows\' groups, beside the Reading\'s own |\n| `<entity>_export_rows` | Every row of <entity> the reader may see, with every field "<template>" may print. | the list\'s | an Export of the register that fills a template |\n| `<entity>_export_rows_of_<source>` | Every row of <entity> the reader may see, with every field "<template>" may print. | the list\'s | an Export over some of a List\'s sources: their rows alone, each source named in turn |\n| `<entity>_moves` | Each move in <history> of the <entity> rows handed in: the status it went to, when and by whom, earliest first. | `<entity>_ids` | an entity whose status keeps a history (`records.status.history`) |\n| `<entity>_plan_load` | How many <entity> rows each <place> holds, over every table the register reads \u2014 the rows with no <place> counted apart. | | a register laid out as a `plan`: its places\' counts of present rows |\n\n<!-- generated:end queries -->\n\nA reading\'s query returns groups, never the rows it read: one row for all of them, or one per value it\nsplits by, or per day. Each row carries the alias of each field it splits by, `__day` where it splits by\nday, `__count`, and `__sum` where it sums a number; its description states which. An average is `__sum`\nover `__count`, both over the rows holding a value.\n\nA Reading is called by its `key` (`reference/reading-node`), and a List that only reads by its `key`, else its entity\'s alias \u2014 wherever its List stands in the app, so a move in the tree changes no name. Each is its own among the app\'s Readings, Lists that only read and Queries.\n\nA register reading\'s query reads the rows it names, whatever a screen has open: the rows of its `tab` where\nit states one, every tab\'s where it states none \u2014 its description says which. One placed in time (`over`)\nreads every day unless the call states `from` or `to`.\n\n### Queries the screen runs for itself\n\nThey run like any other, and `get_app` leaves them out: each feeds one control, and takes ids\nthe screen already holds.\n\n<!-- generated:start screen-queries -->\n\n| Called | What it says of itself | Takes | Generated for |\n|---|---|---|---|\n| `<child>_<link>_target` | One <entity> row by its id, where a <child> row\'s "<link>" may point at it. | `<entity>_id` | a List with `pick` whose link a write rule narrows |\n| `<entity>_<field>_values` | Each "<field>" the <entity> rows hold, once, most held first, narrowed by what the reader typed. | `search`? | a text field a write rule offers values to (`suggest`) |\n| `<entity>_pictures` | The picture and name of each <entity> row among the ids handed in. | `<entity>_ids` | a link to several pictured rows |\n| `<entity>_count_by_<scope>` | How many <entity> rows each <scope entity> holds. | | an app stating `scope` |\n| `<task>_progress_by_<link>` | How many <task> rows each <entity> row handed in holds, at each status. | `<entity>_ids` | rows whose task rows are counted done |\n| `<entity>_sub_counts_by_<link>` | How many <entity> rows stand under each <entity> row handed in, through <link>, at each status. | `<entity>_ids` | a record\'s rows block over a hierarchy (`nests`), for the rows it draws |\n| `<entity>_plan_places` | Every <place> the <entity> rows stand at, with what the plan draws of each. | | a register laid out as a `plan`: the places its rows stand at |\n| `<lane>_lanes` | The <lane> rows of one <scope entity>, each a lane of the board. | `<scope entity>_id` | a lanes board inside an app stating `scope` |\n| `<entity>_same_<link>` | The <entity> rows naming one "<link>". | `same`; `before` where its line reads rows before a moment | a statement line that carries rows (`parts`) |\n\n<!-- generated:end screen-queries -->\n\n### Workflows\n\n<!-- generated:start workflows -->\n\n| Called | What it says of itself | Takes | Generated for |\n|---|---|---|---|\n| `create_<entity>` | Opens one row of <entity>. | every field the add asks, and the link it files the row under | an entity the app adds rows of |\n| `update_<entity>` | Changes one row of <entity>; every input but the row is optional, and one left out is left as it is. | `record_id`, and each field a person edits \u2014 a files field or a link to several rows as `<field>_added` / `<field>_removed` | an entity the app edits |\n| `move_<list>` | Gives rows of <entity> to a <lane> together: every row is judged before any is written, so a refusal leaves them all as they were. `lane` left out leaves the <lane> as it is, `lane` empty clears it; `day` dates only the rows holding none; `order` places each by its number. | `record_ids`, `lane` (left out, the lane stays; empty, none), `day` for the rows holding none, and `order`: each row\'s id and number | a lanes board of days with no hour whose app writes its lane |\n| `remove_<entity>` | Removes one row of <entity>. | `record_id` | an entity the app removes rows of |\n| `restore_<entity>` | Brings back one deleted row of <entity>. | `record_id` | an entity the app removes rows of |\n| `act_<act>` | <label> \u2014 on one row of <entity>, refused where its conditions do not hold. | `record_id` \u2014 `record_ids` on an act over several rows \u2014 and what the act asks | each Act that names no workflow of its own |\n| `archive_<act>` | Hands back every file of <label> on one row of <entity> as one archive. | `record_id` | an Act making a set of papers (`templates`) |\n\n<!-- generated:end workflows -->\n\nA Workflow node is called by its `key`, and every Act by `act_<key>`; an Act that names its own `workflow` is also called by that workflow\'s alias.\n\n## Calling a query\n\n```\nget_app {"app_id":"app_\u2026"}\nrun_app_query {"app_id":"app_\u2026","alias":"order_list","params":{"status_is":"open","due_on_to":"2031-03-14"}}\n```\n\n| Argument | Does |\n|---|---|\n| `params` | The query\'s declared params. A required one is always sent; an optional one left out narrows nothing. A select takes the option\'s alias as `get_app` lists it in `select(label=alias|\u2026)` \u2014 a link a record id, a member a member id, a date `yyyy-mm-dd` |\n| `filters` | Narrows the result further, by the query\'s output columns (`filters`) |\n| `fields` | The output columns to return, in place of all of them; each row then holds them and the id of the record it is |\n| `sort` | An order in place of the query\'s own: `[{ "field_key": "<column>", "order": "asc" }]`, `asc` or `desc`, each `field_key` an output column\'s name |\n| `count` | `true`: `total`, the number of rows, in place of the rows; with `count_by`, `counts` per value of one column, keyed by an option\'s label, a member\'s name or a linked row\'s display; with `count_where` \u2014 a map of name \u2192 filter, never beside `count_by` \u2014 `counts` per name. Never with `fields`, `sort`, `limit` or `cursor` |\n| `aggregate` | Groups of the result in place of its rows, one row per group: `by` (up to 3 columns), `bands` (a number column of `by` grouped by its breakpoints), or `day` (a date column, answered as `__day`), `sum` (a number column, answered as `__sum`) and `avg` (a number column averaged over the group\'s rows that hold one, answered as `__avg`), each group with its `__count`. Sent with `params` and `filters` alone. Buckets are by day only: a period\'s total is one call per period, with `from` and `to` or a date filter |\n| `limit`, `cursor` | A page \u2014 200 rows at most, 50 where no `limit` is stated \u2014 and the `next_cursor` of the page before it; `truncated` says more rows matched than `rows` holds |\n| `runs` | Several reads in one call, 20 at most, each with its own `alias` and arguments, answered in order under `runs`. Never beside an `alias` of the call\'s own |\n\nA query that states its own `limit` lists at most that many rows: `truncated` is `true` where more match, and `total` is\nthe rows the filtered query matches without it. A `count`, `count_by`, `count_where` and an `aggregate` are over every row\nthe query matches, never over the rows its `limit` lists.\n\nThe rows of one call, across its reads, total at most 262,144 bytes: a read past that is refused, naming\n`fields` and `limit` as what narrows it. The names `filters`, `fields`, `sort`, `count_by` and `aggregate`\ntake are the ones on the query\'s `returns` line.\n\nA list\'s params are how a person narrows that register: `search`, the row\'s id on an app that works inside\none row (`scope`), and a param for each filter the register states that one value or a range narrows. A\nfilter with no param \u2014 on a looked-up link or member, on a number read in each row\'s own unit or currency,\non a date holding a span, or on a List of several tables (`sources`) \u2014 is narrowed by `filters`, where a\nnumber condition names the unit its value is in as `unit_option`, an option of the figure\'s select by label\nor key. Each tab of a register is a query of its own, taking the list\'s params and the period its rows are\nread over; a tab\'s totals take the folder\'s id too, in an app that works inside one row.\n\n## Exporting a file\n\n```\nrun_app_query {"app_id":"app_\u2026","export":{"key":"by_carrier","per":"\u2026","tab":"in_yard","status":["\u2026"]}}\n```\n\n`export` makes the file the register\'s Export button makes, from what the caller reads, and answers it under `files` as a workspace\nfile like any other a tool makes: `file_id`, `url`, `filename`, `mime_type`. `key` is the\nkey of an Export of a List in `get_app`\'s tree, at the root or below a row\'s page; it is sent without `alias` or any other argument of a\nread. An option is named by its name or its id, as a read\'s filters name it; a member by its id or its name, for a member\nof the app\'s organization; a row, by its id. The other keys\nnarrow the file as the register\'s own controls do, each absent one leaving the register\'s opening view:\n\n| Key | Takes |\n|---|---|\n| `per` | The option, row id or member id the report is made for \u2014 required by an Export that states `per`, refused by one that does not; a member, here and in a member chip, is an id or a name, found as a filter on a member column finds one |\n| `tab`, `period`, `window` | A Tab\'s key (the first when absent); `{ "from", "to" }` days `yyyy-MM-dd` (`yyyy-MM-ddTHH:mm` on a date-and-time field) the tabs read over; a calendar\'s or board\'s days |\n| `status` | Options of the register\'s status that are kept |\n| `filters` | `{ "<field>": <value> }` by the field\'s alias, a value `null` clearing the register\'s opening chip; a value is one of the shapes below |\n| `search`, `overdue`, `waiting` | Words searched, one line each of a pasted list; `true`: only the rows past a deadline; `true`: only the rows waiting on the caller |\n| `sort`, `group`, `folder` | `{ "field", "dir" }`; a field alias; a folder id |\n| `row` | The id of the row whose rows a List below a row\'s page exports: required there and refused on a root View, and the reader must be able to open that row |\n\n| A `filters` value | For a field that is |\n|---|---|\n| `{ "kind": "ids", "ids": [...], "unset"?: true }` | a select (options) or a link to rows (row ids); `unset` also keeps rows holding none |\n| `{ "kind": "members", "mine": false, "ids": [...], "unset"?: true }` | a member; `mine` is the caller |\n| `{ "kind": "dates", "from": "yyyy-MM-dd" \\| null, "to": \u2026 \\| null, "unset"?: true }` | a date; `null` leaves an end open; `unset` also keeps rows holding none |\n| `{ "kind": "yes_no", "value": true }` | a yes/no |\n| `{ "kind": "number", "min": 1 \\| null, "max": \u2026 \\| null, "unit"?: "\u2026" }` | a number; `unit` the option of a unit or currency field |\n| `{ "kind": "bands", "bands": [{ "min", "max" }] }` | a number the register cuts into tiers |\n\nA key the register lacks, a tab it does not hold or a value its field cannot take is refused, naming it.\n\n## Calling a workflow\n\n```\nrun_app_workflow {"app_id":"app_\u2026","alias":"act_hand_over","inputs":{"record_id":"rec_\u2026"},"dry_run":true}\nrun_app_workflow {"app_id":"app_\u2026","alias":"act_hand_over","inputs":{"record_id":"rec_\u2026"}}\n```\n\n| Argument | Does |\n|---|---|\n| `inputs` | The workflow\'s declared inputs. An update takes the record and only the fields that change |\n| `dry_run` | `true`: the run is made and taken back, so nothing is kept, and the answer is what the run would return, with the calls it would make \u2014 or `status: "not_previewed"` where the workflow cannot be dry-run (`agent_surface/a-dry-run`) |\n| `as_member` | For a workspace admin: the run is a dry run, judged as that member would press it \u2014 their stage owners, row rules and app access \u2014 and writes nothing. Anyone else is refused; a record tool takes it the same way, and so do `query_records` and `run_app_query`, which answer what that member would read, and `screenshot_app`, which draws the app as that member sees it |\n| `runs` | Several runs in one call, 50 at most, in order, each its own write, answered under `runs`. The first one refused, failed or not dry-run ends the call. An input `{"from_run": 0, "path": "data.record_id"}` is an earlier run\'s answer at that path. A run states its own `dry_run`, or takes the call\'s. Dry runs one after another share their rows, taken back together, so a run reads what the one before it made; a run reads a dry run\'s answer only from a run dry-run in that stretch |\n\n```\nrun_app_workflow {"app_id":"app_\u2026","runs":[\n {"alias":"create_order","inputs":{"customer":"rec_\u2026","item":"rec_\u2026","due_on":"2031-03-14"}},\n {"alias":"act_hand_over","inputs":{"record_id":{"from_run":0,"path":"data.record_id"}}}\n]}\n```\n\nAn act that reads papers (`intake`) is read by the caller: no platform agent reads for it. Its save `act_<alias>` takes `fields` (what the papers state), `rows` (the child rows listed) and `papers` (`[{"file":"fil_\u2026","kind":"<option>"}]`), and `dry_run` shows the record and rows it would make.\n\n## A dry run\n\nA dry run is the run itself on the real inputs, taken back: it is made in a transaction that is rolled back, so a read after a write reads that write, a branch or a loop walks the values the run would hold, and a call fed by an earlier call\'s answer gets it. No row, number, event, audit entry or table workflow outlives it. A write of the workspace\'s rows is made by its table \u2014 checks, write rules, stage owners \u2014 and the first refusal is the dry run\'s answer. A connected service\'s read-only call is made; a service write, a send, a notification or a button that runs another workflow is not, and is answered as a "would" with its payload. A guard (`when`, `requires`, a check, a lock) refuses it with the press\'s own sentence. A paper it makes is rendered for the answer and its file is removed with the dry run; an act that makes a paper is dry-run like any other, never refused for it. A body that sets the record\'s status also answers `moves`. Its answer carries `status`,\n`message`, `field_errors` and `data` as the run would return them, and under `dry_run`:\n\n| Key | Holds |\n|---|---|\n| `available` | `true` |\n| `writes` | The calls the run would make that are not reads, in order. The app\'s owner and an admin, who may read the workflow\'s body, read each call\'s `step_id`, `tool_name` and `input`. Another member reads each step that would write once: its `step_id` and `tool_name`, and where the step states them outright, the `table_id` it names and how many `records` it lists |\n| `reads` | The reads made for real, in order, each with its `input` and what it `returned` (cut at 2,000 characters, `truncated`), for the app\'s owner and an admin |\n| `papers` | Each paper rendered: its `step_id` and `filename`. The file is not kept |\n| `unpredicted` | The parts of the answer left out \u2014 `message`, `field_errors`, `data` \u2014 because each reads what a call the dry run did not make would answer |\n\nWhat a write sets off once it commits \u2014 a table\'s own workflows, its events \u2014 does not happen in a dry run.\n\nA workflow is not dry-run where its body reads the answer of a call that leaves the workspace, to branch,\nloop, check or feed another call, where it reads or writes rows after such a call (the run would find them as\nthat call left them), where it runs an agent, where it waits, where a step cannot be evaluated, fails\nfor a reason that is no table\'s refusal, or sends its call an input the call refuses, and where the run is past\nwhat one dry run walks \u2014 its steps, the passes of a loop, 50 reads, 50 writes or 20 seconds, which the runs of\none call share and the database holds it to: a lock wait that outlasts them ends the dry run. The\nanswer is then `status: "not_previewed"` with\n`dry_run: { "available": false, "reason" }`, and nothing ran \u2014 within `runs`, it ends the call. The same\nanswers a caller outside the app\'s organization.\n\n## A reviewed act\n\nAn act that states `review` runs a workflow that only proposes: call it with the inputs the act asks and it answers,\nwriting nothing, the changeset its body proposes in `data.review` \u2014 `table_id`, `creates` (each with its `key`) and\n`updates` (each with its `record_id`), each row\'s `data` holding only the fields that change, by field alias, with an\noptional `note` and `ticked` (`false` where the body leaves it for a person to choose), and `unplaced`, what was read\nand matched nothing; the platform adds a `sha` to every row. Call it again with the same inputs and `approved`,\n`{ "updates": [{ "record_id", "sha" }], "creates": [{ "key", "sha" }] }`, listing the rows to write with the `sha` each\ncarries in the proposal, copied as it came \u2014 never computed \u2014 and the platform writes those rows as that second call\nproposes them, each only where it proposes the values read:\n\n```\nrun_app_workflow {"app_id":"app_\u2026","alias":"match_statement","inputs":{"record_ids":["rec_\u2026"],"statement":"fil_\u2026"}}\nrun_app_workflow {"app_id":"app_\u2026","alias":"match_statement","inputs":{"record_ids":["rec_\u2026"],"statement":"fil_\u2026","approved":{"updates":[{"record_id":"rec_\u2026","sha":"9f2c\u2026"}],"creates":[{"key":"line-4","sha":"41d0\u2026"}]}}}\n```\n\nThe answer\'s `data.applied` names the run (`execution_id`), the records `updated`, what each held before (`previous`), each `created` record by its key,\nand each approved row `left` with its `reason`: `not_proposed` (the second call no longer proposes it), `not_acted`\n(an update of a record the act was not run on), `changed` (the second call proposes other values than were read \u2014 read\nthe proposal again), `empty` (an update changing no field), `missing`, `locked` or `conflict`. Every approved row is\nchecked before any is written, and all are written in one transaction or none; the status history of each row written\nthat moved is recorded by the same run. `applied.previous` holds, for each record in `updated`, what the fields the call wrote held before (null for an empty one): `update_records` with it as `set` puts them back, and `delete_records` of a `created` record takes that row away. An act over every\nrow in view takes no `record_ids`. A `file` input takes the id of a file uploaded to the workspace.\n\nAn Act that `makes` a cadence\'s rows proposes the same way with no body: `creates` are the child rows still owed, each\n`key` `<parent id>|<day>`, a row its write would refuse unticked with the refusal as its `note`, and `unplaced` says what\nstays off the pattern and how many closed days were skipped.\n\n## A refusal\n\nA workflow re-checks on the server what the screen shows of its own act or save: what an act requires, a\nduplicate, whose step it is, a row the caller may not see. Each write it makes also meets the table\'s own\nrules (a bound, a span, a stage\'s owner, its lock), which hold on every path a record is written by. A row its table\nlocked is refused in every app\'s act and save, naming who can change it; an app\'s own Check only makes a row read-only\nin that app. An unlock in an app\'s run is judged as the member it runs for, never the app\'s owner. A run refused\nbefore it writes writes nothing; one whose later write a table\'s rule refuses keeps the writes before it.\nEither answers `status: "error"` with the sentence a person would read as `message`, and under `field_errors`\nthe sentence for each input it was refused over. A value of the wrong type, a missing required input and an unknown\nalias are refused before the body runs: the call itself fails with the sentence, and `field_errors` where\nan input is at fault \u2014 within `runs`, a run refused for its inputs answers `status: "error"` in its place,\nand the runs before it stand. A refused read fails the same way, naming the param or the column; within\n`runs`, it answers its `error` and the other reads are still answered.\n\n## Declaring more\n\nWhat the business asks an agent in the app again and again, and no screen draws, is stated in the app\'s tree as Query and Workflow nodes, beside its\nActs: every figure or list whose definition is the business\'s own (open orders, what a customer owes, low stock) and every recurring operation (close the month, send to the accounting service, chase overdue invoices), each with a `description` written for an agent. A question asked once stays on `query_records` with `aggregate`. A Workflow gets an Act only where a person presses it; work only an agent does has no button. Both are checked and compiled when the tree is written (`set_app`; `reference/query-node`, `reference/workflow-node`).\n\n**What the data decides, the system decides.** Whatever follows from the rows and the rules is stated where it holds for every writer, never left to a caller: a fact of one row in its table (`required`, `unique`, `min` and `max`, `options_where`, a check); a value that follows from others as a formula, a lookup or `default_from`; a step of the work in the status\'s `stages` and its Acts (`when`, `requires`); who reads which rows in the table\'s `read_scope` and the app\'s `rows`; what a write sets off in a table\'s workflow; and a decision over many rows or papers (which papers a household\'s facts call for) in a Workflow that computes it and refuses what breaks it, every call the same. A caller\'s inputs are what only it knows: the facts it read, a judgement it made. An override of what the system computes is an optional input, never the way the work is done. A Workflow refuses only what would leave a row invalid or put a false statement on a paper, naming the fact that fixes it; what leaves room for error but is not wrong (a blank printed for handwriting, an unusual choice) it does and reports as a warning in what it returns.\n\n**A query** \u2014 the rows of one table, or one figure of them, in the app\'s own aliases:\n\n```jsonc\n{\n "type": "Query",\n "key": "orders_overdue",\n "description": "A customer\'s orders still open past the day they were due, longest overdue first.",\n "params": {\n "customer": { "type": "record_link", "entity": "customer", "required": false, "description": "Only this customer\'s orders." },\n "as_of": { "type": "date", "description": "The day an order is overdue on: due before it." }\n },\n "rows": "order",\n "fields": ["customer", "item", "due_on", "price"],\n "where": { "status": ["baking"], "customer": { "param": "customer" }, "due_on": { "to": { "param": "as_of" } } },\n "sort": { "field": "due_on" }\n}\n```\n\nIt reads under the app\'s `rows` (every row, where the app states none of the table) and, on the app\'s own table, exactly the rows its list reads \u2014\nso never the table of an app whose List reads `sources`, several tables. A condition reading an\noptional param narrows nothing when the call leaves it out; no param compares a number read in each row\'s\nown unit or currency, or a date holding a span. A Query returns its `fields`; a caller counts, sums or\naverages them with `run_app_query`\'s `aggregate`. A Query, a Workflow and\na Reading\'s `key` take no name the app generates (`reference/app.generated-name`).\n\n**A workflow** \u2014 a write no Act of the record makes, typed in the app\'s tree and its code set on the app:\n\n```jsonc\n{\n "type": "Workflow",\n "key": "import_bookings",\n "description": "Books every order a sheet lists, reusing an order the sheet already booked.",\n "inputs": {\n "sheet": { "type": "file", "description": "The order sheet, one order per row." },\n "booked_by": { "type": "member", "required": false, "description": "Who the orders are taken by; absent, the caller." }\n },\n "outputs": { "added": { "type": "number" }, "reused": { "type": "number" } }\n}\n```\n\n`set_workflow` sets its code (`workflows`). A query the app holds that\nthe tree does not declare is listed by `get_app` as `unstated_queries` and removed by the next write,\nwhose answer notes it; declared as a Query node, it is the tree\'s. A caller sees the description and\neach input\'s `description` and nothing else, so each says what the value is and what leaving it out means;\nthe check notes one that says nothing.\n\n**Shape each for a caller that is not looking at a screen.** One job a person hands an agent \u2014 a paper read,\na message answered, a sheet brought in \u2014 is one declared workflow named for the job, never a chain of the\ngenerated per-row workflows. Take a list where the job covers many rows, a record\'s lines among them. A workflow\'s code\nthat writes more than one row makes them in one `save_record` workflow step, all or nothing, and recognises\nwhat exists by the identity the input itself carries, declared unique on its table, so the same input sent\ntwice updates instead of adding. Return the ids under `outputs`, so the next run can read them. Gate what\ncannot be undone behind an approval step.\n\n## Prove an app as an agent\n\nRun on one of the owner\'s own rows, moved only as far as its stage; a record made for the run takes a number and a stage move nobody asked for.\n\n1. `get_app` \u2014 every job the app\'s `description` names has an alias that does it or reads it.\n2. `run_app_query` the list with no param, then with each param a person would narrow by; `count: true`\n answers how many without the rows.\n3. `run_app_query` `<entity>_record` with one row\'s id, and each `<child>_by_<link>` under it.\n4. `run_app_workflow` an act with `dry_run: true`, then without.\n5. `run_app_workflow` an act its record is not ready for: the answer is `status: "error"` with the sentence\n the screen would show.\n6. `run_app_workflow` the app\'s job workflow with the input a person would hand it \u2014 the paper read, the row:\n it completes in one call. Call it again with the same input: nothing is added.\n';
@@ -1903,10 +1903,10 @@ var filters_default = '# Filters \u2014 choosing records by their fields\n\nOne
1903
1903
  var field_values_default = '# Field values \u2014 what a write takes for each field type\n\nThe value `create_records` and `update_records` take for a field. A field is named by its alias, as `get_table` shows it, and a select option the same way. `dry_run: true` on `create_records`, `update_records` and `delete_records` runs the write in a transaction that is rolled back: every check, rule and stage owner is judged, no number is consumed, and the answer says what would be written or why it is refused. Every write meets the table\'s rules (`reference/write-rules`): a refusal lists every broken rule at once, and a locked record answers under `blocked` in `update_records`\' result.\n\n## Values by type\n\n| Type | Value |\n|---|---|\n| `text` | `"hello"` |\n| `time` | a `text` of this format: `"16:00"`, stored `HH:mm` on a 24-hour clock; `"8:00"` and `"08:00:00"` are stored `"08:00"`, any other text is refused |\n| `number` | `42` |\n| `boolean` | `true` |\n| `date` | `"2025-03-14"`, or a month `"2025-03"` or a year `"2025"`, stored as written and compared as its first day |\n| `month` | `"2025-03"`; a full date written to it keeps its month, a bare year is refused |\n| `datetime` | a `date` of this format: `"2025-03-14T09:00"`, never a month or a year |\n| `date_range` | a `date` of this format: `"2025-03-01/2025-03-15"`, both halves full dates |\n| `datetime_range` | a `date` of this format: `"2025-03-01T09:00/2025-03-15T17:00"`, both halves full |\n| `select` | `["open"]`, the option\'s alias |\n| `member` | `["mbr_\u2026"]` |\n| `link` | `["rec_\u2026"]` |\n| `files` | `["fil_\u2026"]`, ids of uploaded files |\n| `formula`, `rollup`, `lookup`, `autonumber`, a `date` with `derive_from` | none \u2014 the platform writes them, and a write naming one is refused |\n\n## Lists\n\n`select`, `member`, `link` and `files` store an ARRAY, even where the field holds\none value.\n\n- A single-select is a ONE-element array; a bare `"open"` is accepted and wrapped. A single\n `member` takes a bare `"mbr_\u2026"` the same way.\n- A single `link` takes a bare `"rec_\u2026"` the same way; a multi `link` and `files` take an array only.\n- A `files` id the write adds must name a live file of this workspace, or the whole write is refused;\n an id that cell already holds stays, though its file was archived since.\n- A file previews by its kind: an image zooms; a PDF scrolls, zooms sharp and turns by page, its text selectable; a DXF\n drawing shows read-only in 2D with a toggle per layer. A DWG stays a stored file with no preview; attach its plotted\n PDF beside it.\n- Two options on a single-select, two members on a single `member`, or two records on a single `link`, are refused.\n- `update_records`\' `add_to`, `remove_from` and `replace` take arrays of the same items: option aliases\n for a select, member ids for a `member`, record ids for a `link`, file ids for\n `files`.\n';
1904
1904
 
1905
1905
  // docs/workflows.md
1906
- var workflows_default = '# Workflows \u2014 the steps a workflow runs\n\nA workflow is written as a strict subset of JavaScript. The source is never run as JavaScript: a\nsave parses it into steps, type-checks it against what its trigger supplies, and stores the steps.\nOnly the forms below are accepted; anything else is refused at save with the line, the column and\nwhat to write instead. A save that succeeds may still return `warnings` \u2014 advisory hints such as a\nloop that may never end. Read them.\n\nA workflow changes records, calls integrations, notifies and makes papers. A tool for anything else \u2014 views, history,\ntables and apps, members, knowledge, skills, editing a file \u2014 is an agent\'s, and a body that\ncalls one is refused at save with that reason. One saved before is refused at run, before its first step.\n\nThe same grammar serves a table\'s workflow, an automation and an app\'s workflow, which `set_workflow` saves, and the\nexpressions of a table check.\n\n## Triggers\n\nEvery workflow\'s source opens with `on({ ... })`, which states what starts it. `set_workflow` saves the source, and\n`get_workflow` reads it back with whether it is on and how its latest runs ended. `get_workflow` without a\n`workflow_id` lists the workflows you may read, a page at a time (`limit` 1 to 100, `offset`, `total`), each with its\n`kind`, its trigger in a line, whether it is on and its failed runs of the last 7 days; `table_id` and `app_id` keep the\nones that follow or name them.\n\n| kind | header |\n|---|---|\n| table | `on({ type: "create" \\| "update" \\| "delete", table: "<alias>", changed?: ["<alias>", ...], when?: "<expression>" })` |\n| automation | `on({ type: "recurring_schedule", cron_expression })`, `receive_webhook`, `receive_gmail_email` or `receive_outlook_email` \u2014 see **Automations** |\n| app | `on({ type: "app", app_id, alias, inputs?, outputs? })` \u2014 `inputs` and `outputs` only for a custom-code app |\n| notification | `on({ type: "notification", inputs: { ... } })` \u2014 what a card\'s action hands the body |\n\nWhat starts a workflow is fixed once it is made: its kind, a table workflow\'s trigger type and table, an automation\'s\ntrigger type, an app workflow\'s app and alias. To change either, delete the workflow and make another. A replace states the whole trigger, so a key the\nheader leaves out is removed (an app workflow keeps the inputs it leaves out, and derives the outputs it leaves out from\nwhat the body returns). `expected_version` refuses a replace when the workflow has moved since the `version` you read.\n`dry_run` checks the source and stores nothing; given the trial inputs its trigger supplies, it also walks the steps once\nand returns the calls planned, the return value, the failures and the papers rendered. A table trigger takes `record_id`,\n`prev_data` and `changes`; a webhook or email trigger `trigger_payload`; an app trigger `record_id` and `preview_inputs`; a\ntable or automation trigger also `live_reads` (an app\'s rehearsal always reads real data). A trial input its trigger does\nnot supply is refused, naming the ones it takes. A rehearsal needs write scope: a key that reads data alone cannot make one.\n\n`delete: true` with a `workflow_id` removes a workflow, and is the one call that asks for approval; a replace asks for none,\na step it drops included. `even_if_invoked` and `acknowledge_breaking_api_change` belong to an app workflow and are\nrefused for another kind.\n\nA notification workflow is run by the action of a notification card under its owner\'s access; the press only triggers it. It declares `inputs` as an app workflow does, reads them as `inputs.<name>` (or `trigger.notification_action.inputs.<name>`), cannot `wait` or `wait_for_event`, and is bound to no table, automation, button or app. Its owner or an admin reads, replaces and deletes it and puts it on a card, and it still runs as its owner; it has one owner for life and is archived with them when they leave (its open cards close), never handed on. Its writes are judged and attributed as its owner. Its runs are read by its owner and admins, and are never retried: pressing the card again is the retry. A step that sends a card names each action\'s `workflow_id` as a literal. Only a workflow sends a card; an `agent` step writes the title and body it sends.\n\nAn app workflow reads its call as `trigger.app_workflow.inputs.<name>`, or `inputs.<name>`, which is the same read. A Workflow node receives the inputs it declares;\nan Act\'s `workflow` receives `record_id` (`record_ids` on an act over several rows) and what the Act asks.\n\n### Automations\n\nAn automation answers an event outside the records: a schedule, a webhook, an inbound email. `set_workflow` saves one\nfrom its source \u2014 the `on({...})` declaration, then its steps \u2014 and, given its `workflow_id`, replaces it: the\ntrigger config is the one the header states, a key it leaves out removed, and steps left as it runs them are checked again\nonly when the call turns it on (`enabled`), so one a later rule refuses can still be switched off. An admin names the owner at creation with\n`owner_member_id`. It runs with its owner\'s current permissions, a connected service it names is its owner\'s account, and only its\nowner or an admin reads, changes or deletes it.\n\n```\non({ type: "recurring_schedule", cron_expression: "0 9 * * MON" });\n```\n\nEvery source below is typed, so a misspelled member is refused at save rather than read as nothing.\nAll three carry `trigger.trigger_id`.\n\n| trigger | required config | what the body reads |\n|---|---|---|\n| `recurring_schedule` | `cron_expression` | `runtime.timezone`; the current time is `now()` |\n| `receive_webhook` | `secret`? | `trigger.method`, `trigger.headers[...]`, `trigger.query[...]`, `trigger.body` (any JSON, or raw text when the request is not JSON), `trigger.received_at` |\n| `receive_gmail_email` / `receive_outlook_email` | `connected_account_id`, `filter` | `trigger.email_id`, `trigger.from`, `trigger.to`, `trigger.cc`, `trigger.bcc`, `trigger.subject`, `trigger.date`, `trigger.body` (plain text), `trigger.reply_to`, `trigger.in_reply_to`, `trigger.attachments` (file refs \u2014 assign them straight to a files field). One type serves both providers, so `labels`, `thread_id`, `importance` and `conversation_id` are not readable. |\n\n## Steps\n\n| step | syntax |\n|---|---|\n| tool call, kept | `const <id> = await <tool>({ ...inputs });` \u2014 also `let x = await \u2026` and `x = await \u2026` |\n| tool call | `await <tool>({ ...inputs });` \u2014 the platform\'s own steps (`send_notification`, `generate_document`, \u2026) and a connection\'s tools, each a workflow step (`bkav_submit_invoices`, `kiotviet_create_order`, \u2026); a step that fails ends the run with its reason unless a `try`/`catch` around it handles it |\n| agent | `const <id> = await agent({ instructions, input, model, output });` \u2014 see **An agent step** |\n| app agent | `const <id> = await app_agent({ alias: "<agent alias>", input: { ... } });` \u2014 runs one of the app\'s declared agents, in an app workflow only, and resolves to its declared outputs or its final text. `wait: false` only starts the run and resolves to `{ run_id }`; the run\'s failure is then its own, not the workflow\'s. Refused in a run an agent started. |\n| bind | `const <id> = <expression>;` \u2014 evaluated once; later steps read `<id>`. Bind any expression used twice. |\n| if / else | `if (<expr>) { ... } else { ... }` \u2014 `else` optional, `else if` chains allowed |\n| switch | `switch (<expr>) { case "X": { ... } default: { ... } }` \u2014 string cases only, no fallthrough |\n| for | `for (const <name> of <expr>) { ... }` |\n| wait | `await wait({ duration_in_minutes: 5 });` |\n| wait for an event | `await wait_for_event({ event_type: "webhook", event_ref: <expr>, timeout_in_minutes: 60 });` |\n| return | `return({ status: "success" \\| "error", message: <expr>, field_errors: { ... }?, data: { ... }? });` \u2014 `data` holds the outputs a Workflow node declares \u2014 a body whose steps only read and write the workspace\'s rows and make papers runs as one transaction: a return of `error`, a failed `validate`, a table\'s refusal or a failure takes back every write of the run, and a run too long to hold one starts again step by step; a body that also calls out (a send, a connected service, an import of rows, another workflow), waits or runs an agent runs step by step: each step\'s writes stand as they land and a return of `error` undoes none, so its refusals stand before its first write; an Act\'s own write (`set`, asks, signature) and its papers land after the body, before each `success` return and where the body ends, so a refusal leaves the row as it stood, and the body\'s `row` and any read of the row in the body see it as the press found it |\n| validate | `validate({ checks: [{ fail_when: <expr>, field_key: "...", message: <expr> }, ...] });` |\n\nA delayed run is never cancelled from a workflow: after a `wait`, it reads the row\'s state and acts only if it still holds.\n\nA tool\'s inputs and answer are in its own description; the steps only a body runs \u2014 a connection\'s, a mail\'s \u2014 are each\nan entry of `workflow_steps`. An admin connects a service in Lotics under Settings \u2192 Connections; a step names that\nconnection by its `connected_account_id`, which `get_workspace` with `kind: "connection"` lists for the connections the\ncaller can use. The app\'s owner must be able to use that connection, so a\n`connected_account_id` is a literal, a constant bound to one, or a choice among them: every possible value is judged at\nsave, and one read from an input, a record or a call is refused. A template may come from data; a run refuses one its\nowner cannot use.\n\nIn a workflow, email reaches a member of the workspace through the step `send_notification`: Lotics shows it to them and\nmails it to their own address, with no connection. Its recipients are members by `member_id` (`get_workspace` with\n`kind: "member"` lists them), member groups or the whole organization. Mail to anyone else goes from a\nconnected Gmail or Outlook (`gmail_send_email`, `outlook_send_email`), which leaves an unsent draft unless `draft` is\n`false`.\n\n`return` is a call, not a JavaScript `return` statement. `validate` ends the workflow with an error\nwhen a check\'s `fail_when` is truthy; the check\'s `field_key` names the control its message lands on \u2014\nin an app workflow a declared input, or the alias of a field on a table the body names; in an\nautomation it is not checked.\n\nThe name in `const x = await tool({...})` is the step\'s id; later expressions read its output as\n`x.records`, `x.id` and so on. A `// id: my_step` comment directly above a statement sets an explicit\nid; any other `//` comment there becomes the step\'s description.\n\n**`await` inside a statement** runs the call as its own step first, then reads its output where it is\nwritten: `size((await query_records({...})).records)`, an `if` test, a `return` value, a `for-of`\niterable, a tool input. `const x = c ? await t({...}) : null;` is stored as the `if` it means. An\n`await` that would run on some paths only \u2014 inside `&&`, `||`, `??`, `?.`, a nested ternary, a loop\ntest, a `validate` check \u2014 is refused; write the `if`.\n\n**Names are block-scoped, as in JavaScript** \u2014 `const`, `let`, loop items and `catch (e)`: sibling\nblocks may reuse a name and an inner block may shadow an outer one. A local may take a helper\'s name\n(`const size = 3;`), but calling `size(...)` while it is in scope is refused. The names of the tools a\nworkflow calls, the reserved roots, `linked` and `_s` followed by digits cannot be bound.\n\n### An agent step\n\n`const x = await agent({ instructions, input, model, output });` runs a model as one step \u2014 read a paper, classify,\ndraft text. It calls no tool: the workflow\'s own steps write, send and notify with what it returns, and a step that\nstates `tools` is refused.\n\n- `instructions` \u2014 a fixed string.\n- `input` \u2014 an object literal; its fields are expressions, evaluated and handed to the model (`{}` for\n none). It is the ONLY workflow data the agent sees: read the trigger, prior steps, `runtime` or the loop\n item here, never inside `instructions`, which is a fixed literal and reads no binding. A field holding a file, or a\n list of files (a files field, a mail\'s attachments), hands the agent the files themselves: a picture or a PDF it\n sees, any other paper read into text.\n- `model` \u2014 optional; omit it to follow the platform\'s default model.\n- `output` \u2014 `{ mode: "text" }` resolves to a string; `{ mode: "object", schema }` to a typed object.\n\nOnly `x` comes back: in text mode `x` is the string itself, in object mode `x.field` reads a field the\n`schema` declares.\n\n## Naming tables and templates\n\nA body names a table or document template by its alias (`query_records({ table_id: "orders" })`); ids still work. `get_workflow` shows aliases. An app\'s workflow reaches only the tables the app uses.\n\n## Fields and options\n\n1. **A body names a table\'s fields and select options by alias**, the names the table\'s document states: a field reads\n as `record["status"]`, an option as `"done"`, a linked field as `linked(record["customer"])[0]["name"]`, in the\n body of a Workflow node, of an Act\'s own `workflow`, of an automation and of a table\'s workflow (`set_workflow`). It is stored by key and `get_workflow` shows it by alias\n again. A field\'s key is accepted where its alias is and is kept as written; an option\'s key is read as that option\'s\n alias, and one that two tables\' options share with different aliases is refused where it is read, naming both. A\n display name is refused with the aliases there are, and a row that names one field by both its alias and its key is refused. A row written to a table is\n stored by field key wherever the save can follow it to the record tool that writes it: a row or list written in the call,\n a conditional of them, a name holding them, pushed to a `let`, and through `map`, `flatMap`, `concat`, `filter`, `sortBy`,\n `slice` and `reverse`. A field of such rows is read by alias as well (`picks.toSorted((a, b) => a.quantity - b.quantity)`,\n `sortBy(picks, "quantity")`, `rows[0].note`) and stored by key. A body that cannot be stored by key is refused at save,\n naming the statement.\n2. **An Act\'s own `workflow`** has the app\'s guards placed at the top of the body, between `<lotics:guards>` tags,\n replaced on every save: a save that leaves them out or edits them gets the app\'s again, at the top wherever the tags\n sat, so the act\'s row rule, `when`, `requires`, checks and locks always run first.\n3. **A value is read as the record tools store it.** A single select reads as its option\'s alias and a member as its id;\n an option is written by its alias wherever it meets a select \u2014 compared, listed, switched on, written \u2014 also beside a\n name set from the field (`const s = record.status; s == "done"`) or in a list that search runs over\n (`includes(filter(record.tags, \u2026), "hot")`). A select value handed on whole (returned for a declared select, written to a\n select field or a filter) is resolved to the option\'s key where it leaves the body; one handed to a text, a message or a\n template carries the alias. A link reads as the list of its row ids, a\n one-row link too: `first(record.customer)` is the one id, and `record.customer` used as one id is refused at save,\n naming `first(record.customer)`. A one-row link is written with its one id or a list of one; a many-row link with a list. A lookup reads as one flat list of the values it looks up: `includes(record.owner,\n me)`; a looked-up link, as the ids of its rows, which `query_records` takes as `record_ids`. A select\'s value is one of another select\'s options where the two state the same alias for it; two selects that\n state no alias in common never hold one value, and a save that compares them or copies one into the other is refused.\n A row that takes its parent\'s option gets it from `default_from`, and a lookup shows it.\n A grouped aggregate\'s `key` reads as the option\'s alias, and `get(row.data, "<field>")` as `row.data.<field>` (an empty cell takes the default).\n4. **What an app sends takes an option by alias or key.** An input or output drawn from a field (`field`, written\n `<table id>.<alias>`) compares and returns by alias in the body, and the run hands it on as the option\'s key. A\n refusal\'s `field_errors` and a `validate` check\'s `field_key` name a declared input or a field\'s alias.\n5. **`==` against a multi-select means "includes".** `record["tags"] == "urgent"` on a multi-select is stored as\n `includes(record["tags"], "urgent")`; either spelling works.\n6. **`option("<field>", "<option>")` names an option where no select is beside it** (a name set once and compared later,\n a list of options, a value handed to a tool). It reads as the option, typed as that select\'s, and is stored as its alias.\n The field is looked up among the tables the body reaches; a field or option that does not exist is refused naming both, and\n a field alias that two tables state with different keys for that option is refused naming each table. An option\n key written out reads as its alias, but write `option()`: a key is a value no one can read.\n7. **Text renders labels.** Inside a template or a text tool input, a select, member or link value renders its display\n text: `` `${record["status"]}` `` writes "Done", not `done`, and `` `${record["status"] ?? ""}` `` writes it too. A\n formula stating `options` (a computed category) is read as the single select it is drawn as: compared by option,\n rendered by label.\n\n## What an expression reads\n\n- `record`, `prev_record`, `changes` \u2014 in a table check, the write it checks (see **Table checks**).\n `changes` is a PARTIAL map: `changes["x"]?.next_value` and `?.prev_value`, the `?.` required.\n- `trigger` \u2014 what the trigger carries (see **Triggers**).\n- a loop\'s item name, and `index`, the iteration\'s 0-based index.\n- `<step id>` \u2014 an earlier step\'s output (`dup.records`).\n- `runtime.timezone`, `runtime.workflow_id`, `runtime.execution_id`, `runtime.workspace_id`,\n `runtime.organization_id`, `runtime.change_origin`, `runtime.triggered_by_member_id`. The current\n time is `now()`.\n\n## Paths\n\n- `record.x` and `record["x"]` read a field; `[n]` reads a list\'s n-th item.\n- A path may start at any expression: an awaited call `(await query_records({ table_id: "orders", record_ids: [id] })).records[0].data["x"]`, a helper\'s\n result `first(found.records).id`, a filter `rows.filter((r) => r.ok)[0].n`, a `(a ?? b).c`. `?.` reads\n through a null as usual, except on a value drawn at random (`sample(xs)?.id` is refused: bind it first).\n- A record reads in its declared shape wherever it comes from \u2014 the trigger, a tool result, a `let`, a\n callback parameter: a single select as its option alias or null, a member as its id, a link as its ids. A property read\n by alias (`x.order.quantity`, `xs[0]["quantity"]`, `y.quantity`) also names the record\'s field when the record is held in an\n object, a list or a spread (`{ order: record }`, `[record]`, `{ ...record }`); a helper\'s field-path text reads the\n rows of a records tool and a loop over them only. (The record tools called outside a workflow return the stored arrays instead.)\n- `linked(record["link"])[n]["x"]` fetches the n-th linked row and reads a field of it; bare\n `linked(record["link"])` is every linked row, one fetch per row. Its argument is a path ending on\n a link field and carries the guard: `linked(record?.["link"])[0]`.\n- `changes["link"]?.next_value` is the same list of ids; `linked()` over a change is refused \u2014\n read `linked(record["link"])` or `linked(prev_record["link"])`.\n\n## Operators and statements\n\nOperators in JavaScript precedence: `? :`, `||`, `??`, `&&`, `== != === !==`, `< <= > >=`, `+ -`, `* / %`,\nprefix `! -`.\n\n- Arithmetic is exact decimal (`0.1 + 0.2` is `0.3`). A result computed from a division that does not end\n is the short decimal it reads as (`1 / 3 * 3` is `1`), and stands as computed where it reads long\n (`1 / 3 * 100` is `33.33333333333333`). A comparison between two numbers reads both at 15 significant\n digits. `round` and `formatNumber` round the decimal, a half away from zero: `round(-2.5)` is `-3`. A\n table filter compares stored values exactly.\n- `??` is `coalesce(left, right)`; `?.` reads through a null (`a?.b`, `a?.[0]`, and `s?.trim()` for the\n method names listed under **Helpers**). `x?.()` is refused: helpers and tools are not values.\n- Templates use backticks and `${...}`. `get_workflow` shows a template as `text(\u2026)`, which writes its parts in order as the template does: `text("Missing: ", join(names, ", "), ".")`. A request whose body holds a template\'s `${\u2026}` can be refused before it reaches Lotics, a 403 page rather than an answer; write that text with `text(\u2026)`.\n- Destructuring \u2014 `const { status, name } = record;` binds each name. Renames\n (`{ status: s }`), quoted keys (`{ "ref": ref }`), array patterns with holes\n (`const [first, , third] = xs;`) and defaults (`{ note = "" }`, which apply on null too) work on\n `const`, `let` and `for (const { id } of rows)`. A tool result destructures directly:\n `const { records } = await query_records({...});`. `const a = 1, b = 2;` declares both. Nested\n patterns and rest are refused.\n- Spread \u2014 `[...a, b]` and `{ ...a, b: 1 }` (later keys win). Refused inside a tool input: bind the\n merged value first and pass the binding.\n- Shorthand \u2014 `{ table_id }` is `{ table_id: table_id }`.\n- `xs.push(a, b);` appends, also on a key (`o.items.push(v)`); `o.a.b = v;` sets a nested key;\n `x ??= v`, `x ||= v` and `x &&= v` assign. A `const` may be pushed to or have a key set, as in\n JavaScript; a loop item is read-only.\n- `undefined` reads as `null`, so `x === undefined` is `isNull(x)` and `x !== undefined` is `isNotNull(x)`;\n a key set to null and a key never sent are not told apart (`"k" in o` tells a key that is there). A write\n tells them apart: a field given `undefined` is left as it is (Writing a field: null and undefined).\n- `typeof x` answers JavaScript\'s words, and a null (a missing value too) is `"object"`. `k in o` tests an\n object\'s own keys, or a list\'s indexes and `length`.\n- A filter node may leave out `node_type` when its keys say which it is: `field_key` / `operator` /\n `value` a condition, `logic` / `children` a group, `path` / `condition` a traversal.\n- `function name(p = <default>) { return <expr>; }` \u2014 top level only, expanded at every call (a call\n may come before it). Every parameter needs a default, which gives it its type; the body is one\n `return <expr>;` reading only its parameters, helpers and the reserved roots \u2014 never the caller\'s\n names, nor `index`. No recursion; a function never called is refused. A body read back shows the\n expression at each call, not the `function`.\n\n**try / catch.** `try { ... } catch (e) { ... }` catches a tool error or an expression error inside the\nbody; `e` is `{ message, type, step_id?, detail? }`. A failed `validate` and a `return` are not\nerrors \u2014 they end the workflow \u2014 and a step that runs after a wait inside the `try` is outside it.\n`finally` is refused: put always-run steps after the `try`.\n\n**Loops.** `for-of`, `while (cond) { ... }`, `do { ... } while (cond);` and\n`for (let i = 0; i < n; i++) { ... }`, each capped at 10,000 iterations. `break;` and `continue;` act\non the innermost loop; labels and `for-in` are refused.\n\n**`let`.** `let x = <expr>;` declares a block-scoped variable; the initializer is required\n(`let x = null;`). Reassign with `=`, `+=`, `-=`, `*=`, `/=`, `%=`, `??=`, `++` and `--`. Re-declaring in\nthe same block is refused; shadowing in a nested block is allowed. A `let` keeps its value across a\n`wait` or `wait_for_event`.\n\n**Refused, each because a save must know what runs and a run must give the same answer twice:** regex\n(unbounded matching: use the string methods), `Math.random`, `Date.now()` and `new Date()` (use `now()` and\n`parseDate`), a tool or helper as a value or a computed callee (callees are named), `new` of anything,\n`instanceof`, `delete`, `void`, rest elements, computed keys, classes, `throw`, `finally`, `import`,\n`export`, `eval`, labels, and a function as a value (`const f = (x) => ...`: pass the arrow to the helper\nthat takes it). `xs.sort(...)` on a name or path is refused too, since a value is never changed in place:\nwrite `xs.toSorted(...)` or `[...xs].sort(...)`.\n\n## Typing\n\n- The body is type-checked as TypeScript before it is read: annotations, `as`, `satisfies` and a non-null `!`\n are accepted and erased, and the checker is strict about null. The stored body keeps none of them and is checked again as\n stored, by field key, as every later change to its app or tables checks it: a body that types only through one of them is\n refused at save.\n- Narrow what is not typed (a connector\'s JSON is `unknown`) with `typeof`, `in`, `Array.isArray` and `isNull`.\n- `first(xs)` may be undefined; `requireFirst(xs)` is the list\'s first item or an error. A test of `first(xs)` covers no second `first(xs)`: bind it once (`const id = first(xs)`), then test `id`.\n- `obj[key]` needs `key` to be a key of `obj`, or `obj` to be a record with a string index.\n\n## Helpers\n\nOrdinary JavaScript works \u2014 the standard library below, the array and string methods, `Math`, `JSON`,\n`Object`, `Array`, `Number`, `parseInt` \u2014 and means what it means in JavaScript, with the differences\nlisted here. Where JavaScript answers NaN, Infinity or undefined, a workflow has none of them and the\nanswer is `null`.\n\n- Standard library: `Math.abs/ceil/floor/trunc/sign/min/max/pow/sqrt`, `Number(x)`, `String(x)`,\n `Boolean(x)`, `parseInt(s, radix?)`, `parseFloat(s)`, `Number.isFinite/isInteger`,\n `Object.keys/values/entries/fromEntries`, `Array.isArray/from` (a list, text, or `{ length: n }`),\n `JSON.parse/stringify`.\n- Arrays: `length, map, filter, find, findIndex, findLast, some, every, reduce, includes, indexOf, join,\n slice, concat, flat, flatMap, at, reverse, toReversed, toSorted` and `[...xs].sort(compare?)`.\n- Strings: `length, toLowerCase, toUpperCase, trim, trimStart, trimEnd, startsWith, endsWith, includes,\n indexOf, slice, substring, split, replace, replaceAll, padStart, padEnd, repeat, charAt, at,\n localeCompare` (en-US order, wherever it runs). Numbers: `toFixed, toString`.\n- Differences from JavaScript: `Math.round` is the engine\'s `round` (a half goes away from zero:\n `Math.round(-2.5)` is `-3`); `Number(x)` and `parseFloat(x)` are `toNumber`, which refuses text that is no\n number; `String(null)` is `""`; `join` writes a null item as `null`; `concat` skips a null; `toFixed`\n rounds the decimal, not the binary double; `replaceAll` writes the replacement as text\n (`$&` stays as typed), while `replace` expands `$&`, `$$`, `` $` `` and `$\'` in it as JavaScript does; `split` takes no limit; `sort` without a comparator orders by text, as JavaScript does. `==`, `!=`, `===` and `!==` between two list values (files, a multi-select, a link of any cardinality, a lookup) are refused at save, since a list compares by identity, not by its items: `!isNull(changes.<field>)` asks whether one changed.\n\nThe same work can be written with the helpers below, which are additions to JavaScript. They are called as\n`size(arr)`; the method form works only where the name is also a JavaScript method \u2014\n`x.trim()`, `arr.includes(v)`, `arr.at(-1)`, `arr.map(fn)`, `s.split(",")`; `arr.size()` is refused.\n\n- **Null and type**: `isNull`, `isNotNull`, `isEmpty`, `isString`, `isNumber`, `isBoolean`, `isArray`,\n `isObject`, `coalesce`, `get`, `toNumber`, `toFigure`, `toString` (a text, number, yes/no or date; a record, file or list is refused at save, an object at run), `typeOf`, `parseJson`, `toJson`. `isNull` is strict (`null` and `undefined` only), but on a list field of the record (a link, files, a multi-select) it asks whether the list holds nothing, since a cleared list is `[]`: `!isNull(record.vehicle)` reads as `!isEmpty(record.vehicle)`. `isNull(changes.<field>)` stays strict: null there means unchanged\n- **Lists**: `size`, `first`, `requireFirst` (the first item, refusing an empty list \u2014 after a\n `validate` on the size it saves an `if`), `last`, `nth`, `at` (`at(arr, -1)` counts from the end),\n `includes`, `filter`, `find`, `some`, `every`, `pluck`, `sortBy`, `groupBy`, `countBy`, `unique`,\n `uniqueBy`, `compact` (drops falsy items), `flatten`, `reverse`, `slice`, `concat`, `difference`,\n `differenceBy`, `intersection`, `intersectionBy`, `list`, `reduce(arr, (acc, x) => ..., initial)`,\n `range(end)` / `range(start, end)`\n- **Math**: `sum`, `sumBy`, `mean`, `meanBy`, `minBy`, `maxBy`, `round`, `ceil`, `floor`, `min`, `max`,\n `abs`, `mod`, `pow`, `sqrt`, `clamp`, `percentage`\n- **Text**: `upper`, `lower`, `capitalize`, `trim`, `contains`, `startsWith`, `endsWith`, `replace`,\n `replaceAll`, `removeChars(str, chars)` (without every character that occurs in `chars`),\n `removeSpaces(str)` (without any whitespace; a Word template command calls both too), `substring`, `length`, `split`, `join`, `padStart(str, length, char)`,\n `padEnd(str, length, char)`, `formatNumber(x, decimals)` (ungrouped; rounds the decimal, a half away\n from zero: `formatNumber(1.005, 2)` is `1.01`),\n `formatDecimal(x, decimals, locale)` (grouped: `formatDecimal(151000, 0, "vi-VN")` is `151.000`),\n `numberToWords(x, lang?)` (an integer in words: Vietnamese, or English with `"en"`),\n `uuidFrom(text)` (the same UUID for the same text, refusing null and empty text: `uuidFrom(record.id)`)\n- **Objects**: `keys`, `values`, `entries`, `nonNullKeys`, `pick`, `omit`, `merge`\n- **Dates**, in the workspace\'s timezone: `now`, `formatDate`, `parseDate`, `addDays`, `subDays`,\n `addHours`, `subHours`, `addMinutes`, `subMinutes`, `startOfDay`, `endOfDay`, `startOfMonth`, `endOfMonth`,\n `addMonths` (a day past the target month\'s end lands on its last day), `differenceInCalendarDays`, `differenceInHours`, `differenceInMinutes`, `isBefore`, `isAfter`,\n `isSameDay`, `isToday`, `isWithinRange`, `datesOn(from, until, days)` (the days from `from` to `until`, both included, falling on weekdays named `mon` to `sun`), `meetsBounds`. A date beside a moment compares by day, so `<=` means\n through that day; `startOfMonth` and `endOfMonth` of a date answer a day\n- **Other**: `formatCurrency(amount, locale, currency)`, `randomNumber(len)`,\n `randomAlphaNumeric(len)`, `sample(items)` (a random item)\n\nOver a null or empty list `mean`, `meanBy`, `min`, `max`, `minBy` and `maxBy` answer null, while `sum`\nand `sumBy` answer 0: `maxBy(pieces, "reach")?.Name` prints a blank for a month with no pieces.\n\nA date helper given a null or empty date returns null, so guard its result before comparing or\nwriting it: `differenceInCalendarDays(a, b) ?? 0`.\n\n`filter`, `find`, `some`, `every`, `sortBy`, `pluck`, `sumBy`, `meanBy`, `minBy`, `maxBy`, `groupBy`,\n`countBy`, `uniqueBy`, `differenceBy` and `intersectionBy` take a path string\n(`filter(record.items, "Status", "open")`) or a callback\n(`filter(record.items, x => x.Status == "open" && x.Amount > 100)`); `reduce` takes a callback and an\ninitial value. A callback gets `(item, idx)` (`reduce`: `(acc, item, idx)`) and reads `record`,\n`runtime`, the names in scope, loop items and an enclosing callback\'s parameters. Its body is one\nexpression \u2014 `(x) => <expr>`, `(x) => { return <expr>; }` or `function (x) { return <expr>; }`;\nseveral statements, `async` and named function expressions are refused.\n\nLook a row up by key rather than filtering for it: a `filter` inside a callback walks its whole list again\nfor every item, so a thousand items against a few hundred rows is hundreds of thousands of calls. Group the\nrows once, then read each group by its key. `groupBy` answers an object of lists, and `byCode[code] ?? []`\nis the group a code names, or an empty list:\n\n```\nconst parties = await query_records({ table_id: "parties" });\nconst lines = await query_records({ table_id: "sheet_lines" });\nconst byCode = groupBy(parties.records, (p) => p.data["code"] ?? "");\nconst holders = lines.records.map((line) => ({\n line: line.id,\n parties: (byCode[line.data["code"] ?? ""] ?? []).map((p) => p.id),\n}));\n```\n\nA key is read exactly: a code holding a dot, a slash or a bracket reads its own group, and a name every\nobject inherits (`constructor`) reads nothing unless a row made a group of that name. `get(o, "a.b")`\nfollows a dotted path instead, so a key that holds a dot is read with `o[key]`.\n\n## Writing a field: null and undefined\n\nIn `update_records`\' `set`, `create_records`\' `records` and the workflow step `save_record`\'s `set` and line rows:\n\n- `null` clears the field.\n- `undefined`, or leaving the key out, leaves the field as it is.\n\nSo passing a read that may be null (`record["x"]`) keeps a value when there is one and clears the\nfield when there is none. Use `coalesce(x, fallback)` only for a real fallback value.\n\n## Examples\n\nCompare a link by id. Display text is not unique, and a link reads as a list of ids \u2014 `==` against a\nstring is a type error:\n\n```\nconst found = await query_records({\n table_id: "customers",\n filters: { node_type: "condition", field_key: "name", operator: "equals", value: "ACME Corp" },\n});\nconst customer = first(found.records);\nconst order = (await query_records({ table_id: "orders", record_ids: [trigger.app_workflow.inputs.order_id] })).records[0];\n\nif (customer && includes(order.data["customer"], customer.id)) {\n // \u2026\n}\n```\n\nRead an uploaded sheet and add the rows a table lacks. `excel_get_rows`, a workflow step, answers every\nrow of an `.xlsx`, `.xls` or `.csv` sheet in one call, each an object keyed by the header row\'s text. A cell is a number,\n`true` or `false`, text, a date as ISO text, or null when blank, so `row["Header"]` is typed\n`string | number | boolean | null` and a helper narrows it: `toString` for text, `toNumber` for a number,\n`isString` before a date. Every cell of a `.csv` is text. `columns` keeps only the ones the body reads.\nA sheet past what one call reads is refused with its size, never cut short: the step\'s entry in\n`workflow_steps` states the bounds.\n\nA sheet\'s rows are written with `save_record`, a workflow step, once per row. `match` is the row\'s identity,\n`{ code: <the row\'s code> }`, and must be a uniqueness its table declares: the field is `unique`. A live row carrying\nthe key is found and only the cells of `set` that differ are written; none is found and the row is added. Run the same\nfile twice and the second run writes nothing new. A cell the row has no value for is left out of `set`, and `null` is an\nempty cell, which differs from a filled one as any other value does. A row the body should not write is skipped and\ncounted in what the workflow returns, so the person who ran it is told; the step holds nothing back on its own, and a\nrow a table check or a lock refuses fails the call, naming the row.\n\nA link cell takes the record id of the row it links. To find that row by the text a sheet holds, `query_records` the\nlinked table once, `groupBy` its key, and read the id from the group. A body that does not find the row skips the\nsheet\'s row and counts it.\n\n```\nconst sheet = await excel_get_rows({ // a workflow step\n file_id: trigger.app_workflow.inputs.file,\n columns: ["Code", "Name", "Price"],\n});\n\nconst kept = await create_records({\n table_id: "price_sheets",\n records: [{ file: [trigger.app_workflow.inputs.file], run: runtime.execution_id }],\n});\nconst sheet_id = kept.record_ids[0];\n\nlet added = 0;\nlet changed = 0;\nlet skipped = 0;\nfor (let at = 0; at < size(sheet.rows); at += 1) {\n const row = sheet.rows[at];\n if (isNull(row["Price"])) {\n skipped += 1;\n await create_records({\n table_id: "sheet_lines",\n records: [{ sheet: [sheet_id], line: at + 2, outcome: "skipped", why: "The sheet states no price", code: toString(row["Code"]) }],\n });\n } else {\n const saved = await save_record({ // a workflow step\n table_id: "plants",\n match: { code: toString(row["Code"]) },\n set: { name: toString(row["Name"]), price: toNumber(row["Price"]) },\n });\n added += saved.created ? 1 : 0;\n changed += !saved.created && size(saved.updated_field_keys) > 0 ? 1 : 0;\n }\n}\n\nreturn({ status: "success", message: `${added} added, ${changed} changed, ${skipped} skipped` });\n```\n\nOne `save_record`, a workflow step, per row writes about a hundred rows a second on a table of thirty fields with a link, a lookup and a\nformula: a thousand rows took ten seconds. A run whose writes finish within twenty seconds lands all or nothing; a\nlonger one starts again, each row written as it is reached, and three thousand rows took seventy of the ninety seconds\nan awaited call gives a run. A sheet of up to about a thousand rows loops; a larger one is written in batches.\n\nThe batched form reads the table\'s keys once and writes in calls of up to a thousand rows. `query_records` the table\nin pages, `groupBy` the key, split the sheet\'s rows into those with no row yet and those whose cells differ, then\n`create_records` the first and `update_records` the second in its per-record form (`field_keys` and one `rows` entry per\n`record_ids` entry). Ten thousand rows took about seven seconds, a repeat with nothing changed under three, and the\nwhole of it is one transaction at that size. The body does the comparison, so it writes only what differs:\n\n```\nconst inputs = trigger.app_workflow.inputs;\n\nconst sheet = await excel_get_rows({ // a workflow step\n file_id: inputs.file,\n columns: ["Code", "Name", "Price"],\n});\nconst rows = sheet.rows.map((row) => ({ code: toString(row["Code"]), name: toString(row["Name"]), price: toNumber(row["Price"]) }));\n\nlet held = (await query_records({ table_id: "plants", field_keys: ["code", "name", "price"], pagination: { offset: 0, limit: 1000 } })).records\n .map((one) => ({ id: one.id, code: toString(one.data["code"]), name: toString(one.data["name"]), price: toNumber(one.data["price"]) }));\nfor (let start = 1000; start < inputs.row_count; start += 1000) {\n const page = await query_records({ table_id: "plants", field_keys: ["code", "name", "price"], pagination: { offset: start, limit: 1000 } });\n held = concat(held, page.records.map((one) => ({ id: one.id, code: toString(one.data["code"]), name: toString(one.data["name"]), price: toNumber(one.data["price"]) })));\n}\nconst byCode = groupBy(held, (one) => one.code);\n\nconst fresh = filter(rows, (row) => size(byCode[row.code] ?? []) == 0);\nconst changed = filter(rows, (row) =>\n size(byCode[row.code] ?? []) > 0 &&\n (requireFirst(byCode[row.code] ?? []).name != row.name || requireFirst(byCode[row.code] ?? []).price != row.price));\n\nfor (let at = 0; at < size(fresh); at += 1000) {\n await create_records({ table_id: "plants", records: slice(fresh, at, at + 1000) });\n}\nfor (let at = 0; at < size(changed); at += 1000) {\n const part = slice(changed, at, at + 1000);\n await update_records({\n table_id: "plants",\n record_ids: part.map((row) => requireFirst(byCode[row.code] ?? []).id),\n field_keys: ["name", "price"],\n rows: part.map((row) => [row.name, row.price]),\n });\n}\n\nreturn({ status: "success", message: `${size(fresh)} added, ${size(changed)} changed` });\n```\n\n`inputs.row_count` is a number the act asks beside the file. A key the table keeps `unique` refuses a second row with\nit, so a sheet that carries one key twice fails the `create_records` call, naming it, before any row of that call is\nwritten.\n\nA workflow does not put a run\'s writes back: that reads the history of what the run wrote, which a member\'s agent reads\nunder the member\'s own access to the table and no workflow does. A member\'s agent puts them back with\n`update_records`: `query_audit_logs` on the table shows what the run wrote \u2014 the run is what `runtime.execution_id` held in\nit, which a body keeps on a row of its own \u2014 and each field\'s value before it, `update_records` writes that value back as\nthe member\'s own write, `update_records` with `restore: true` brings back a row the run moved to the trash, and\n`delete_records` removes a row the run created. Write a field back only where the row still holds what the run wrote.\n\nWhat a business keeps of a sheet \u2014 the file, its counts, the lines waiting for a person \u2014 is rows of its own tables,\nwritten by the workflow that ran. A garden centre brings its grower\'s price sheet into its plants, and keeps each sheet\nand the lines it skipped. These tables are shown beside the plants, in the same app: the sheets as a List beside the\nplants\' (a second List at the root, `reference/app-node`), a sheet\'s lines on the page it opens. A line keeping what a\ncell held and what it holds now in two fields reads one against the other (`compare`, `reference/list-node`).\n\nA skipped line is applied by the act on it, whose workflow reads the line and saves the plant from it. A cell the line\nholds none of is left out, so a skipped line never empties a cell of the plant:\n\n```\nconst line = (await query_records({ table_id: "sheet_lines", record_ids: [trigger.app_workflow.inputs.record_id] })).records[0];\nconst values = {\n ...(isEmpty(line.data["name"]) ? {} : { name: line.data["name"] }),\n ...(isNull(line.data["price"]) ? {} : { price: line.data["price"] }),\n};\n\nawait save_record({ // a workflow step\n table_id: "plants",\n match: { code: line.data["code"] },\n set: values,\n});\n\nawait update_records({ table_id: "sheet_lines", record_ids: [line.id], set: { outcome: "applied" } });\nreturn({ status: "success", message: "Applied." });\n```\n\n### A reviewed act\n\nA shop matches a bank statement to the notes it is owed by an act that states `review`. That act\'s workflow only\nproposes: its body calls steps that read and no other, and runs no agent \u2014 either is refused when the body is saved \u2014\nand returns in `data.review` one changeset of the act\'s table, which the platform writes the approved rows of. Called\nwith what the act asks, it answers the proposal and nothing is written; called again with\n`approved: { creates: [{ key, sha }], updates?: [{ record_id, sha }] }` (absent `updates` means none), the body runs again and the platform writes\nthose rows as this second run proposes them, so the body never reads `approved`. The platform adds a `sha` to every row\nof the proposal it answers \u2014 the body states none, and one it states is dropped \u2014 and the caller echoes the `sha` of\neach row it approves. A row the second run proposes with other values than the `sha` was read from is left unwritten\n(`changed`), so the body must propose the same for the same inputs and the rows it reads.\nAn update is of a record the act is run over (`record_id`, or one of `record_ids`): one of any other record is left\nunwritten. An act over every row in view is handed no rows: its body reads the rows it may change, and any of them may\nbe proposed. A create carries a `key`, a text of the body\'s own that names the same line on every run\n(`key: toString(line["Reference"])`), unique among the creates; where a confirm repeated must not add a second row,\nthe body also writes the key into a field the table keeps unique, so the repeat\'s create is left as a `conflict`.\nEach row\'s `data` holds only stored fields that change \u2014 never one the platform computes or stamps, nor a file \u2014 with\na `note` and a `ticked` the reader starts from, and `unplaced` lists what was read and matched nothing. Every approved\nrow is checked against its fields before any is written, and they are written in one transaction, so a flawed one\nwrites none. The status history of every row written that moved, or was made holding a status, is recorded in the\nsame run. The answer\'s `applied.previous` holds what each updated record\'s written fields held before, so one `update_records` of it puts the values back, and `delete_records` of a `created` record takes that row away. A body that stops proposing a row once it is\nwritten \u2014 it matches against what the rows hold now \u2014 makes approving twice write once.\n\n```\nconst inputs = trigger.app_workflow.inputs;\n\nconst sheet = await excel_get_rows({ // a workflow step\n file_id: inputs.statement,\n columns: ["Reference", "Amount", "Paid on"],\n});\nconst unpaid = await query_records({\n table_id: "notes",\n filters: { field_key: "paid_on", operator: "is_empty" },\n pagination: { offset: 0, limit: 500 },\n});\nconst acted = groupBy(inputs.record_ids, (id) => toString(id));\nconst owed = filter(unpaid.records, (one) => size(acted[toString(one.id)] ?? []) > 0);\nconst byRef = groupBy(owed, (one) => toString(one.data["ref"]));\n\nconst lines = sheet.rows.map((line) => ({\n line,\n note: first(byRef[toString(line["Reference"])] ?? []),\n}));\nconst updates = filter(lines, (one) => !isNull(one.note)).map((one) => ({\n record_id: toString(one.note?.id),\n note: `Transfer of ${toString(one.line["Amount"])}`,\n ticked: toNumber(one.line["Amount"]) == sumBy(filter(owed, (owing) => owing.id == one.note?.id), (owing) => coalesce(owing.data["amount"], 0)),\n data: { paid_on: toString(one.line["Paid on"]) },\n}));\nconst unplaced = filter(lines, (one) => isNull(one.note)).map((one) => ({\n title: `${toString(one.line["Reference"])}: ${toString(one.line["Amount"])}`,\n note: "Matches no unpaid note",\n}));\n\nreturn({\n status: "success",\n message: `${size(updates)} of ${size(lines)} transfers match a note`,\n data: { review: { version: 1, table_id: "notes", creates: [], updates, unplaced } },\n});\n```\n\n### Saving a record with its lines\n\n`save_record`, a workflow step, saves one record and the rows of other tables that hang off it, all or\nnothing, and recognises what exists by the identity the input carries \u2014 so a call sent twice updates and\nadds nothing. `match` is the record\'s identity, `{ field_key: value }`, and must be exactly a uniqueness\nits table declares: one field marked `unique`, or the fields of one of the table\'s `unique` sets together\n(text, number, date, single select and one-row link fields). A `match` that is no declared uniqueness is\nrefused, naming what the table does declare. A live record carrying the match is found and only the cells\nof `set` that differ are written; none is found and it is added with `match` and `set`. `add_to` appends\nto a files, multi-select or many-link field and keeps what it holds.\n\n`lines` saves rows of other tables that link the record. Each entry names the child `table_id`, its\n`link` \u2014 a field of the child holding one row of this table, which the step fills and no row states \u2014\nthe child fields that, with `link`, are one uniqueness of the child table (`match`), and `rows`, each\nstating every `match` field. A line found by its match changes only the cells that differ, one not found\nis added, and a line the call does not list is left as it is: the step deletes nothing. Two rows of one\nentry cannot share a match.\n\nEverything is checked before the first write, and everything is written in one transaction: a table check\nthat refuses one line, a locked record or line the call would change, a value a field does not take, or a\ntable the run may not write refuses the call and saves nothing, naming the row. Two calls of one identity\ntake turns, so the second finds what the first saved. The answer is `record_id`, `created`,\n`updated_field_keys` (the cells changed on a record that existed) and, per entry of `lines`, the ids it\nadded, changed and left unchanged; these ids are typed for their tables, so a declared `record_link`\noutput or a follow-up write links straight to them.\n\n```\nconst inputs = trigger.app_workflow.inputs;\n\nconst sheet = await excel_get_rows({ // a workflow step\n file_id: inputs.release_order,\n columns: ["Size", "Quantity"],\n});\n\nconst saved = await save_record({ // a workflow step\n table_id: "release_orders",\n match: { number: inputs.number },\n set: { note: "Read from the paper" },\n lines: [{\n table_id: "release_lines",\n link: "order",\n match: ["size"],\n rows: sheet.rows.map((row) => ({\n size: toString(row["Size"]),\n quantity: toNumber(row["Quantity"]),\n })),\n }],\n});\n\nreturn({\n status: "success",\n message: `${size(saved.lines[0].created_ids)} lines added`,\n data: { record_id: saved.record_id },\n});\n```\n\n### Numbering a row at a moment\n\nA number given when a row is signed or issued is an editable number field the workflow fills with the table\'s highest plus one,\nonly while the row has none, so a second press keeps its number. The field carries a one-field `unique` set on its table, so two\nruns that read the same highest are refused, not doubled; the refused run reads the highest again, for three attempts in all, and\na run still refused after the third fails with that refusal. The last attempt stands outside the `try`, since a `catch` takes any\ntool error, not the unique refusal alone. A sequence per series or year filters the query on it and states a two-field `unique`.\n\n```\nif (isNull(record.no)) {\n let numbered = false;\n for (let attempt = 0; attempt < 2 && !numbered; attempt++) {\n const top = await query_records({ table_id: "contracts", sort: [{ field_key: "no", order: "desc" }], limit: 1 });\n try {\n await update_records({ table_id: "contracts", record_ids: [record.id], set: { no: coalesce(first(top.records)?.data["no"], 0) + 1 } });\n numbered = true;\n } catch (e) {\n numbered = false;\n }\n }\n if (!numbered) {\n const last = await query_records({ table_id: "contracts", sort: [{ field_key: "no", order: "desc" }], limit: 1 });\n await update_records({ table_id: "contracts", record_ids: [record.id], set: { no: coalesce(first(last.records)?.data["no"], 0) + 1 } });\n }\n}\n```\n\n## Schedules\n\nA weekly pattern made into dated rows is a parent\'s `records.cadence` and an Act `makes` it\n(`reference/record-places-pins-and-cadence`), no body; pressed again it also moves the rows the pattern now makes otherwise that no one has touched. The rest of a timetable is a rule or a short body.\n\n**A student in two places.** An enrolment reads its span and its days off its course, so one meeting at the same\ntime on a shared weekday as the student\'s other course is refused at save:\n\n```json\n"no_overlap": { "from": "course.starts", "to": "course.ends", "by": ["student", "course.days"], "while": { "state": ["active"] } }\n```\n\n**A swap.** One Act on a shift runs a `workflow` asking the other shift (an input `other` of `type: "link"`, `entity` the shifts) and writes both people in one call:\n\n```\nconst inputs = trigger.app_workflow.inputs;\nconst both = (await query_records({ table_id: "shifts", record_ids: [inputs.record_id, inputs.other] })).records;\nconst mine = requireFirst(filter(both, (one) => one.id == inputs.record_id));\nconst theirs = requireFirst(filter(both, (one) => one.id == inputs.other));\nawait update_records({\n table_id: "shifts",\n record_ids: [mine.id, theirs.id],\n field_keys: ["person"],\n rows: [[theirs.data["person"]], [mine.data["person"]]],\n});\nreturn({ status: "success", message: "Swapped." });\n```\n\n**A rotation.** A pattern that turns over the days (teams taking nights in turn) is a body: `datesOn(from, until,\ndays)` lists the days of a range falling on the weekdays named.\n\n```\nconst inputs = trigger.app_workflow.inputs;\nconst days = datesOn(inputs.from, inputs.until, ["mon", "tue", "wed", "thu", "fri"]);\nconst teams = (await query_records({ table_id: "teams", record_ids: inputs.record_ids })).records;\nconst rows = days.flatMap((day, at) => teams.map((team, place) => ({ team: [team.id], day, kind: (at + place) % 2 == 0 ? "day" : "night" })));\nfor (let at = 0; at < size(rows); at += 1000) {\n await create_records({ table_id: "shifts", records: slice(rows, at, at + 1000) });\n}\nreturn({ status: "success", message: `${size(rows)} shifts` });\n```\n\n**Pay at the rate taught, and a month closed.** A lesson copies its teacher\'s rate when it is made (`"default_from":\n"teacher.rate"`), so a rise later leaves the lessons already made alone; a formula multiplies it by the lesson\'s hours,\nand a Tab\'s `totals` sums each teacher\'s month. A pay period is a row with its first and last day and a status; a check\non the lessons refuses every write inside a closed one:\n\n```json\n"checks": { "month_closed": {\n "on": ["create", "update", "delete"],\n "lookups": { "period": { "table": "pay_periods", "limit": 1, "filter": { "node_type": "group", "logic": "and", "children": [\n { "node_type": "condition", "field_key": "first_day", "operator": "on_or_before", "value": { "$expr": "record.starts_at" } },\n { "node_type": "condition", "field_key": "last_day", "operator": "on_or_after", "value": { "$expr": "record.starts_at" } },\n { "node_type": "condition", "field_key": "status", "operator": "has_any_of", "value": ["closed"] } ] } } },\n "fail_when": "size(lookups.period) > 0",\n "message": "\\"This month\'s pay is closed.\\""\n} }\n```\n\n## Reaching a connected service\n\nA service is reached only by a workflow step, and a step is called inside an app\'s workflow or an automation. From\nnothing to an app\'s run:\n\n1. `get_workspace` with `kind: "connection"` lists each `connected_account_id`.\n2. `set_app` declares a Workflow node that states what a call takes and hands back:\n\n```json\n{\n "type": "Workflow",\n "key": "invoice_order",\n "description": "Issues the KiotViet invoice for a confirmed order and hands back its code.",\n "inputs": { "order": { "type": "record_link", "entity": "order" } },\n "outputs": { "invoice_code": { "type": "text" } }\n}\n```\n\n3. `set_workflow` with a `source` that opens with `on({ type: "app", app_id: "app_\u2026", alias: "invoice_order" });` and this body (the step\'s entry is in `workflow_steps`):\n\n```\nconst order = (await query_records({ table_id: "orders", record_ids: [trigger.app_workflow.inputs.order] })).records[0];\nconst made = await kiotviet_create_invoice({ // a workflow step\n connected_account_id: "cac_\u2026",\n branch_id: 1,\n sold_by_id: 7,\n lines: [{ product_id: 42, quantity: toNumber(order.data["quantity"]), price: toNumber(order.data["price"]) }],\n});\nreturn({ status: "success", message: "Invoiced", data: { invoice_code: made.invoice.code } });\n```\n\n4. `run_app_workflow` with `dry_run: true`, then the same call without it.\n\nTo change later what it takes or hands back, send the node\'s change and the new body in one `set_app`, the body under\n`workflows`.\n\nA step wants the provider\'s own ids (`branch_id`, `sold_by_id`, `product_id`) and no tool lists them: declare a Workflow\nwhose body calls the provider\'s `list_*` workflow step (`kiotviet_list_branches`), run it, and read the ids from its answer.\nNo step lists KiotViet\'s users: read `sold_by_id` off a row `kiotviet_list_invoices` returns (KiotViet\'s `soldById`), or ask the owner.\n\n## Table checks\n\nA table check is one condition its table\'s record writes must not meet, declared beside the table\'s\n`unique`. It is not a workflow: it reads the write and a few lookups and answers yes or no, so it\ncannot change data. It runs inside the write, on every create, update or delete it is `on`, whichever\nsurface makes it \u2014 a person, the API, the CLI, an agent, a workflow. A refusal writes nothing and\nanswers with the check\'s message, under its field when the check names one, and names the check.\n\nA check is stated in its table\'s document, under `checks`, each under an alias of its own, and\n`set_tables` writes it with the rest of the table: a merge patch edits one, `null` removes it, and a\ncall that makes a table can state its checks, a lookup naming another table of the call by its `ref`.\n`get_table` states a table\'s checks in its document.\n\n| part | what it holds |\n|---|---|\n| `on` | the writes it checks: any of `create`, `update`, `delete` |\n| `when` | optional expression; the check runs only on a write where it is truthy. It cannot read lookups. |\n| `lookups` | optional, by name, the rows to read: `{ table, filter, limit }`, `table` an id or the `ref` of a table of the call, the filter as `query_records` takes it with fields and select options named by alias (`id` matches a row by its own record id), `limit` from 1 to 50 (50 when left out). A filter value that reads the record is `{ "$expr": "record.code" }`. |\n| `fail_when` | expression; truthy refuses the write |\n| `message` | expression for the refusal\'s text \u2014 a fixed text is a quoted string |\n| `field` | optional; the alias of the field the refusal is shown under |\n| `enabled` | `false` keeps the check without deciding writes; absent, it decides |\n\nEvery expression is written in the grammar above, names a table\'s fields and select options by\nalias (`record.status == "closed"`), and reads:\n\n- `record` \u2014 the record as it will be stored; on a delete, the record being deleted.\n- `prev_record` \u2014 on an update or a delete, the record before.\n- `changes` \u2014 on an update, the fields it changes. `!isNull(changes.photos)` asks whether a field changed.\n- `lookups.<name>` \u2014 in `fail_when` and `message`, the rows that lookup read. A row reads as `record` does: its fields by alias beside `id` (`row.start_on`), and a lookup field as the flat list of what it looks up (`first(row.booking_start)` through a one-row link). A lookup over the written table never returns the row being checked, and finds its other rows as the write leaves them, this call\'s other rows included. A field given to a helper as text names it by alias too (`sumBy(lookups.paid, "amount")`); text that names no field of the rows\' table is refused when the check is saved.\n- `runtime.timezone`, `runtime.workspace_id`, `runtime.organization_id`, `runtime.change_origin` (the\n write\'s origin), `runtime.triggered_by_member_id` (the member writing; null for a write no member\n made), `now()`, and `member_of("grp_\u2026")` \u2014 true when the member writing belongs to the group.\n\nIn a check a select reads as its one value (`record.kind == "retail"`), and a link (a one-row link too) and a lookup read as lists (`first(record.customer)`).\n\nA check on several operations reads only what all of them carry, so one on creates and updates reads\nneither `prev_record` nor `changes`.\n\nA write that recomputes another table\'s rows (a rollup over lines, a lookup or a formula over a parent) judges each recomputed row as an update, by the checks `on` `update` that read a field the recompute changed; `changes` is what the recompute changed. A check that refuses on `changes` or on a status the row holds can therefore refuse the write that moved the parent, so it is gated on the field it means (`!isNull(changes.status)`).\n\nA lookup reads with the access of the member who last saved the check, so saving one requires reading\nevery table its lookups read. A check\'s reads wait on the writes they depend on: the rows its links name are locked before it reads, and any other lookup takes a lock per check, so two writes at the same moment can\'t both pass a check the other would fail. Values no two rows may share are the table\'s `unique`.\n\nA `when`, a lookup or a `fail_when` that cannot decide \u2014 it fails, or the write\'s time runs out \u2014\nrefuses the write, naming the part it was reading and, for an expression or a filter, what it met\n(`lookups.clash: Filter on "start_on": date \'before\' value \u2026 is not a date`). A draft is checked when it is submitted, as a create; its edits before that are\nnot. A restored record is checked as a create. Cloning a table copies its checks to the member who\nclones it, and is refused when that member cannot read a table a check\'s lookup reads.\n\nOne open order per reference, a row never counting against itself:\n\n```json\n{\n "tables": [\n {\n "ref": "orders",\n "label": "Orders",\n "fields": {\n "reference": { "type": "text", "label": "Reference" },\n "closed_at": { "type": "date", "label": "Closed at" }\n },\n "checks": {\n "one_open_order_per_reference": {\n "on": ["create", "update"],\n "when": "isNull(record.closed_at)",\n "lookups": {\n "same_ref": {\n "table": "orders",\n "filter": {\n "node_type": "group",\n "logic": "and",\n "children": [\n { "node_type": "condition", "field_key": "reference", "operator": "equals", "value": { "$expr": "record.reference" } },\n { "node_type": "condition", "field_key": "closed_at", "operator": "is_empty" }\n ]\n },\n "limit": 2\n }\n },\n "fail_when": "some(lookups.same_ref, (r) => r.id != record.id)",\n "message": "\\"An open order already has this reference.\\"",\n "field": "reference"\n }\n }\n }\n ]\n}\n```\n\n## Table workflows\n\nA table workflow is what follows every committed write of a table\'s rows, whoever makes it: the grid, an import, an agent or\nany app. An effect that must hold for all of them belongs to the table. A button on one screen is that app\'s act, a value fixed\nwhen a row is made is `default_from`, and a rule that refuses a write is a check; a table workflow runs after the write has\ncommitted and cannot refuse it.\n\n`set_workflow` writes it: the `source` opens with `on({ type, table, ... })` and carries the steps, and `enabled: false`\nkeeps the workflow without running it (absent, it runs). `get_table` lists a table\'s workflows to whoever manages the\ntable \u2014 `workflow_id`, name, trigger, whether it is on and its failed runs of the last 7 days \u2014 and `get_workflow` reads one\nback. The table and the trigger type (`create`, `update` or `delete`) are fixed once the workflow is made: to change\neither, delete it and make another. A replace that changes only the gate, the trigger config or `enabled` moves the\nworkflow\'s version. `dry_run` with a `record_id` (and `prev_data` and `changes` for an update) says what the workflow would\nwrite on that row; reads are real and nothing is written.\n\n| part of the header | what it holds |\n|---|---|\n| `type` | the write it follows: `create`, `update` or `delete` |\n| `table` | the table\'s alias |\n| `when` | optional expression over `record`, `prev_record` and `changes`; the workflow runs only after a write where it is truthy |\n| `changed` | optional, with `type: "update"`: field aliases; the workflow runs only after an update that changes any one of them |\n\n```\non({ type: "update", table: "repairs", changed: ["status"], when: "record.status == \\"fixed\\"" });\n\nawait update_records({ table_id: "repairs", record_ids: [trigger.record_id], set: { fixed_on: formatDate(now(), "yyyy-MM-dd") } });\n```\n\nThe body names the table\'s fields, select options and other tables by alias, and reads the write as `record`,\n`prev_record` and `changes` and the row\'s id as `trigger.record_id`. It operates on records and integrations: a body\nthat calls a tool changing a table, an app or any other structure is refused when it is saved. It runs as the table\'s owner, so\nit reaches the tables the owner reaches, and its writes meet the table\'s checks like any other write; a write refused by a\ncheck fails that run and leaves the row as it was. A body names a field by alias where it can tell which table\'s field it is: a\nread of `record`, `prev_record` or `changes`, a row from `query_records` called with a literal `table_id`, and a\nloop over such rows, each also when held in an object, a list or a spread. A name it cannot tie to a table, and an option compared to a value of unknown type (not a read of a field, and\nnot a text, number or other value the type proves holds no option), are refused with what to change. A link reads as the list of the row ids it holds, a one-row link too: compare `first(record.customer) == id`. A lookup reads as one flat list of what it looks up: `record.x != prev_record.x` on one is refused, so compare `first(record.x)` with `first(prev_record.x)`. A single member, a single select, a number or a text reads as the value itself: `first(record.technician)` is refused at save, naming the read.\n\nA write the workflow itself makes sets off the workflows of its table in turn, and a chain of them stops after five. A workflow\nthat writes the row it follows is gated by a `changed` or a `when` that its own write does not satisfy. One run is queued for a\nrow and a workflow at a time, so a burst of writes to one row runs it once more after the run in flight. A field a workflow\nreads cannot be deleted or retyped until the workflow is changed or deleted with `set_workflow` before. Cloning a table copies its\nworkflows for whoever manages it (`include_workflows: false` leaves them), each with a body of its own, and is refused when a\nbody names a table the cloner cannot reach. A workflow runs as the table\'s owner, so whoever saves or rehearses one must manage the\ntable and read every table it reads in full: the body\'s, the gate\'s links\', the written table. An option is written where\nit is compared to, listed against or set on its field; a constant holding one is refused.\n\nA lock is the table\'s: a table workflow locks a row with `update_records` and `locked: true` (an app\'s act may too), and every door then refuses\nthe row\'s writes until whoever manages the table unlocks it with `update_records` and `locked: false` \u2014 in an app\'s run, judged as the member who pressed.\nA locked row reads locked in every app. An app\'s own Check or `edit: false` only makes a row read-only in that app.\n\n## Runs\n\nEach start of a workflow is a run: an app\'s workflow or act, a table workflow, a button, an automation. A call through an\napp\'s API to a workflow that only reads is kept as a run only when it fails or returns an error, unless its body reads\n`runtime.execution_id` or `runtime.change_origin`. An agent finds, reads, retries and stops runs. A run is read by whoever manages what its workflow belongs to: its\nautomation or its table, and for an app\'s workflow the app\'s owner or an admin, never a manager of the app.\n\n- **Find.** `query_workflow_executions` lists one workflow\'s runs (`workflow_id`), every run started for one row\n (`record_id`) \u2014 a table workflow\'s written row, a pressed button\'s row, an app run\'s `record_id` input \u2014 or both, newest\n first, a page at a time (`next_cursor`). Each run names its workflow and kind, what started it, its row and how it ended:\n for a failure, the step that threw, its tool and the error; for a waiting run, when it wakes, or the payment. A run started before runs recorded their row carries no `record_id`.\n- **Read.** `get_workflow_execution` gives one run\'s steps in order with each one\'s tool, input, output and error, what it\n returned, how many rows it wrote (a row\'s own history is in `query_audit_logs`) and the runs its writes started. Ninety days\n after a run starts, its trigger and its steps\' input and output are pruned; the read says so and gives the rest.\n `run_app_workflow` answers each run it makes with its `execution_id`.\n- **Retry.** `set_workflow_execution` with `action: "retry"` runs a failed, refused or cancelled run again as a new run linked to the first\n (`retry_of`): the first run\'s trigger and row, the workflow\'s current steps and its owner\'s current access, with the\n member who retries it as the one who started it. A run is retried once; a retry that fails is retried in turn. It asks\n first when the run, or a run it retried, already wrote rows or called a service no delete reverses. An automation\'s or a\n table workflow\'s retry runs in the background, as its runs do, and answers `queued`; a button\'s and an app\'s run while\n the call waits. An app\'s call is checked again against the workflow\'s current inputs. A pruned run, a run of a workflow\n that is off, a reviewed act\'s run (call the act again) and a recording\'s filing (the recording retries its delivery)\n are not run again.\n- **Stop.** `set_workflow_execution` with `action: "cancel"` stops a waiting run. Both answer\n `execution_id`, `action`, `status`, `retry_of`, `error` and, for a retry, `original_wrote`: the rows and the irreversible\n calls the first run wrote, which the retry makes again.\n\nOff means off: a waiting run whose workflow was turned off, deleted, or taken off its automation, table, button or app ends\n`cancelled` when it would resume, saying why, and runs no further step.\n\nA waiting run keeps its version: when it resumes, it runs the steps of the version it started with, so an edit saved while it\nwaited changes later runs only. When that version is gone, the run ends failed and says why.\n';
1906
+ var workflows_default = '# Workflows \u2014 the steps a workflow runs\n\nA workflow is written as a strict subset of JavaScript. The source is never run as JavaScript: a\nsave parses it into steps, type-checks it against what its trigger supplies, and stores the steps.\nOnly the forms below are accepted; anything else is refused at save with the line, the column and\nwhat to write instead. A save that succeeds may still return `warnings` \u2014 advisory hints such as a\nloop that may never end. Read them.\n\nA workflow changes records, calls integrations, notifies and makes papers. A tool for anything else \u2014 views, history,\ntables and apps, members, knowledge, skills, editing a file \u2014 is an agent\'s, and a body that\ncalls one is refused at save with that reason. One saved before is refused at run, before its first step.\n\nThe same grammar serves a table\'s workflow, an automation and an app\'s workflow, which `set_workflow` saves, and the\nexpressions of a table check.\n\n## Triggers\n\nEvery workflow\'s source opens with `on({ ... })`, which states what starts it. `set_workflow` saves the source, and\n`get_workflow` reads it back with whether it is on and how its latest runs ended. `get_workflow` without a\n`workflow_id` lists the workflows you may read, a page at a time (`limit` 1 to 100, `offset`, `total`), each with its\n`kind`, its trigger in a line, whether it is on and its failed runs of the last 7 days; `table_id` and `app_id` keep the\nones that follow or name them.\n\n| kind | header |\n|---|---|\n| table | `on({ type: "create" \\| "update" \\| "delete", table: "<alias>", changed?: ["<alias>", ...], when?: "<expression>" })` |\n| automation | `on({ type: "recurring_schedule", cron_expression })`, `receive_webhook`, `receive_gmail_email` or `receive_outlook_email` \u2014 see **Automations** |\n| app | `on({ type: "app", app_id, alias, inputs?, outputs? })` \u2014 `inputs` and `outputs` only for a custom-code app |\n| notification | `on({ type: "notification", inputs: { ... } })` \u2014 what a card\'s action hands the body |\n\nWhat starts a workflow is fixed once it is made: its kind, a table workflow\'s trigger type and table, an automation\'s\ntrigger type, an app workflow\'s app and alias. To change either, delete the workflow and make another. A replace states the whole trigger, so a key the\nheader leaves out is removed (an app workflow keeps the inputs it leaves out, and derives the outputs it leaves out from\nwhat the body returns). `expected_version` refuses a replace when the workflow has moved since the `version` you read.\n`dry_run` checks the source and stores nothing; given the trial inputs its trigger supplies, it also walks the steps once\nand returns the calls planned, the return value, the failures and the papers rendered. A table trigger takes `record_id`,\n`prev_data` and `changes`; a webhook or email trigger `trigger_payload`; an app trigger `record_id` and `preview_inputs`; a\ntable or automation trigger also `live_reads` (an app\'s rehearsal always reads real data). A trial input its trigger does\nnot supply is refused, naming the ones it takes. A rehearsal needs write scope: a key that reads data alone cannot make one.\n\n`delete: true` with a `workflow_id` removes a workflow, and is the one call that asks for approval; a replace asks for none,\na step it drops included. `even_if_invoked` and `acknowledge_breaking_api_change` belong to an app workflow and are\nrefused for another kind.\n\nA notification workflow is run by the action of a notification card under its owner\'s access; the press only triggers it. It declares `inputs` as an app workflow does, reads them as `inputs.<name>` (or `trigger.notification_action.inputs.<name>`), cannot `wait` or `wait_for_event`, and is bound to no table, automation, button or app. Its owner or an admin reads, replaces and deletes it and puts it on a card, and it still runs as its owner; it has one owner for life and is archived with them when they leave (its open cards close), never handed on. Its writes are judged and attributed as its owner. Its runs are read by its owner and admins, and are never retried: pressing the card again is the retry. A step that sends a card names each action\'s `workflow_id` as a literal. Only a workflow sends a card; an `agent` step writes the title and body it sends.\n\nAn app workflow reads its call as `trigger.app_workflow.inputs.<name>`, or `inputs.<name>`, which is the same read. A Workflow node receives the inputs it declares;\nan Act\'s `workflow` receives `record_id` (`record_ids` on an act over several rows) and what the Act asks.\n\n### Automations\n\nAn automation answers an event outside the records: a schedule, a webhook, an inbound email. `set_workflow` saves one\nfrom its source \u2014 the `on({...})` declaration, then its steps \u2014 and, given its `workflow_id`, replaces it: the\ntrigger config is the one the header states, a key it leaves out removed, and steps left as it runs them are checked again\nonly when the call turns it on (`enabled`), so one a later rule refuses can still be switched off. An admin names the owner at creation with\n`owner_member_id`. It runs with its owner\'s current permissions, a connected service it names is its owner\'s account, and only its\nowner or an admin reads, changes or deletes it.\n\n```\non({ type: "recurring_schedule", cron_expression: "0 9 * * MON" });\n```\n\nEvery source below is typed, so a misspelled member is refused at save rather than read as nothing.\nAll three carry `trigger.trigger_id`.\n\n| trigger | required config | what the body reads |\n|---|---|---|\n| `recurring_schedule` | `cron_expression` | `runtime.timezone`; the current time is `now()` |\n| `receive_webhook` | `secret`? | `trigger.method`, `trigger.headers[...]`, `trigger.query[...]`, `trigger.body` (any JSON, or raw text when the request is not JSON), `trigger.received_at` |\n| `receive_gmail_email` / `receive_outlook_email` | `connected_account_id`, `filter` | `trigger.email_id`, `trigger.from`, `trigger.to`, `trigger.cc`, `trigger.bcc`, `trigger.subject`, `trigger.date`, `trigger.body` (plain text), `trigger.reply_to`, `trigger.in_reply_to`, `trigger.attachments` (file refs \u2014 assign them straight to a files field). One type serves both providers, so `labels`, `thread_id`, `importance` and `conversation_id` are not readable. |\n\n## Steps\n\n| step | syntax |\n|---|---|\n| tool call, kept | `const <id> = await <tool>({ ...inputs });` \u2014 also `let x = await \u2026` and `x = await \u2026` |\n| tool call | `await <tool>({ ...inputs });` \u2014 the platform\'s own steps (`send_notification`, `generate_document`, \u2026) and a connection\'s tools, each a workflow step (`bkav_submit_invoices`, `kiotviet_create_order`, \u2026); a step that fails ends the run with its reason unless a `try`/`catch` around it handles it |\n| agent | `const <id> = await agent({ instructions, input, model, output });` \u2014 see **An agent step** |\n| app agent | `const <id> = await app_agent({ alias: "<agent alias>", input: { ... } });` \u2014 runs one of the app\'s declared agents, in an app workflow only, and resolves to its declared outputs or its final text. `wait: false` only starts the run and resolves to `{ run_id }`; the run\'s failure is then its own, not the workflow\'s. Refused in a run an agent started. |\n| bind | `const <id> = <expression>;` \u2014 evaluated once; later steps read `<id>`. Bind any expression used twice. |\n| if / else | `if (<expr>) { ... } else { ... }` \u2014 `else` optional, `else if` chains allowed |\n| switch | `switch (<expr>) { case "X": { ... } default: { ... } }` \u2014 string cases only, no fallthrough |\n| for | `for (const <name> of <expr>) { ... }` |\n| wait | `await wait({ duration_in_minutes: 5 });` |\n| wait for an event | `await wait_for_event({ event_type: "webhook", event_ref: <expr>, timeout_in_minutes: 60 });` |\n| return | `return({ status: "success" \\| "error", message: <expr>, field_errors: { ... }?, data: { ... }? });` \u2014 `data` holds the outputs a Workflow node declares \u2014 a body whose steps only read and write the workspace\'s rows and make papers runs as one transaction: a return of `error`, a failed `validate`, a table\'s refusal or a failure takes back every write of the run, and a run too long to hold one starts again step by step; a body that also calls out (a send, a connected service, an import of rows, another workflow), waits or runs an agent runs step by step: each step\'s writes stand as they land and a return of `error` undoes none, so its refusals stand before its first write; an Act\'s own write (`set`, asks, signature) and its papers land after the body, before each `success` return and where the body ends, so a refusal leaves the row as it stood, and the body\'s `row` and any read of the row in the body see it as the press found it |\n| validate | `validate({ checks: [{ fail_when: <expr>, field_key: "...", message: <expr> }, ...] });` |\n\nA delayed run is never cancelled from a workflow: after a `wait`, it reads the row\'s state and acts only if it still holds.\n\nA tool\'s inputs and answer are in its own description; the steps only a body runs \u2014 a connection\'s, a mail\'s \u2014 are each\nan entry of `workflow_steps`. An admin connects a service in Lotics under Settings \u2192 Connections; a step names that\nconnection by its `connected_account_id`, which `get_workspace` with `kind: "connection"` lists for the connections the\ncaller can use. The app\'s owner must be able to use that connection, so a\n`connected_account_id` is a literal, a constant bound to one, or a choice among them: every possible value is judged at\nsave, and one read from an input, a record or a call is refused. A template may come from data; a run refuses one its\nowner cannot use.\n\nIn a workflow, email reaches a member of the workspace through the step `send_notification`: Lotics shows it to them and\nmails it to their own address, with no connection. Its recipients are members by `member_id` (`get_workspace` with\n`kind: "member"` lists them), member groups or the whole organization. Mail to anyone else goes from a\nconnected Gmail or Outlook (`gmail_send_email`, `outlook_send_email`), which leaves an unsent draft unless `draft` is\n`false`.\n\n`return` is a call, not a JavaScript `return` statement. `validate` ends the workflow with an error\nwhen a check\'s `fail_when` is truthy; the check\'s `field_key` names the control its message lands on \u2014\nin an app workflow a declared input, or the alias of a field on a table the body names; in an\nautomation it is not checked.\n\nThe name in `const x = await tool({...})` is the step\'s id; later expressions read its output as\n`x.records`, `x.id` and so on. A `// id: my_step` comment directly above a statement sets an explicit\nid; any other `//` comment there becomes the step\'s description.\n\nA run reads a repeated identical record read once, until the run writes; a loop that waits for a row to change needs a `wait` step, or each pass sees the same rows.\n\n**`await` inside a statement** runs the call as its own step first, then reads its output where it is\nwritten: `size((await query_records({...})).records)`, an `if` test, a `return` value, a `for-of`\niterable, a tool input. `const x = c ? await t({...}) : null;` is stored as the `if` it means. An\n`await` that would run on some paths only \u2014 inside `&&`, `||`, `??`, `?.`, a nested ternary, a loop\ntest, a `validate` check \u2014 is refused; write the `if`.\n\n**Names are block-scoped, as in JavaScript** \u2014 `const`, `let`, loop items and `catch (e)`: sibling\nblocks may reuse a name and an inner block may shadow an outer one. A local may take a helper\'s name\n(`const size = 3;`), but calling `size(...)` while it is in scope is refused. The names of the tools a\nworkflow calls, the reserved roots, `linked` and `_s` followed by digits cannot be bound.\n\n### An agent step\n\n`const x = await agent({ instructions, input, model, output });` runs a model as one step \u2014 read a paper, classify,\ndraft text. It calls no tool: the workflow\'s own steps write, send and notify with what it returns, and a step that\nstates `tools` is refused.\n\n- `instructions` \u2014 a fixed string.\n- `input` \u2014 an object literal; its fields are expressions, evaluated and handed to the model (`{}` for\n none). It is the ONLY workflow data the agent sees: read the trigger, prior steps, `runtime` or the loop\n item here, never inside `instructions`, which is a fixed literal and reads no binding. A field holding a file, or a\n list of files (a files field, a mail\'s attachments), hands the agent the files themselves: a picture or a PDF it\n sees, any other paper read into text.\n- `model` \u2014 optional; omit it to follow the platform\'s default model.\n- `output` \u2014 `{ mode: "text" }` resolves to a string; `{ mode: "object", schema }` to a typed object.\n\nOnly `x` comes back: in text mode `x` is the string itself, in object mode `x.field` reads a field the\n`schema` declares.\n\n## Naming tables and templates\n\nA body names a table or document template by its alias (`query_records({ table_id: "orders" })`); ids still work. `get_workflow` shows aliases. An app\'s workflow reaches only the tables the app uses.\n\n## Fields and options\n\n1. **A body names a table\'s fields and select options by alias**, the names the table\'s document states: a field reads\n as `record["status"]`, an option as `"done"`, a linked field as `linked(record["customer"])[0]["name"]`, in the\n body of a Workflow node, of an Act\'s own `workflow`, of an automation and of a table\'s workflow (`set_workflow`). It is stored by key and `get_workflow` shows it by alias\n again. A field\'s key is accepted where its alias is and is kept as written; an option\'s key is read as that option\'s\n alias, and one that two tables\' options share with different aliases is refused where it is read, naming both. A\n display name is refused with the aliases there are, and a row that names one field by both its alias and its key is refused. A row written to a table is\n stored by field key wherever the save can follow it to the record tool that writes it: a row or list written in the call,\n a conditional of them, a name holding them, pushed to a `let`, and through `map`, `flatMap`, `concat`, `filter`, `sortBy`,\n `slice` and `reverse`. A field of such rows is read by alias as well (`picks.toSorted((a, b) => a.quantity - b.quantity)`,\n `sortBy(picks, "quantity")`, `rows[0].note`) and stored by key. A body that cannot be stored by key is refused at save,\n naming the statement.\n2. **An Act\'s own `workflow`** has the app\'s guards placed at the top of the body, between `<lotics:guards>` tags,\n replaced on every save: a save that leaves them out or edits them gets the app\'s again, at the top wherever the tags\n sat, so the act\'s row rule, `when`, `requires`, checks and locks always run first.\n3. **A value is read as the record tools store it.** A single select reads as its option\'s alias and a member as its id;\n an option is written by its alias wherever it meets a select \u2014 compared, listed, switched on, written \u2014 also beside a\n name set from the field (`const s = record.status; s == "done"`) or in a list that search runs over\n (`includes(filter(record.tags, \u2026), "hot")`). A select value handed on whole (returned for a declared select, written to a\n select field or a filter) is resolved to the option\'s key where it leaves the body; one handed to a text, a message or a\n template carries the alias. A link reads as the list of its row ids, a\n one-row link too: `first(record.customer)` is the one id, and `record.customer` used as one id is refused at save,\n naming `first(record.customer)`. A one-row link is written with its one id or a list of one; a many-row link with a list. A lookup reads as one flat list of the values it looks up: `includes(record.owner,\n me)`; a looked-up link, as the ids of its rows, which `query_records` takes as `record_ids`. A select\'s value is one of another select\'s options where the two state the same alias for it; two selects that\n state no alias in common never hold one value, and a save that compares them or copies one into the other is refused.\n A row that takes its parent\'s option gets it from `default_from`, and a lookup shows it.\n A grouped aggregate\'s `key` reads as the option\'s alias, and `get(row.data, "<field>")` as `row.data.<field>` (an empty cell takes the default).\n4. **What an app sends takes an option by alias or key.** An input or output drawn from a field (`field`, written\n `<table id>.<alias>`) compares and returns by alias in the body, and the run hands it on as the option\'s key. A\n refusal\'s `field_errors` and a `validate` check\'s `field_key` name a declared input or a field\'s alias.\n5. **`==` against a multi-select means "includes".** `record["tags"] == "urgent"` on a multi-select is stored as\n `includes(record["tags"], "urgent")`; either spelling works.\n6. **`option("<field>", "<option>")` names an option where no select is beside it** (a name set once and compared later,\n a list of options, a value handed to a tool). It reads as the option, typed as that select\'s, and is stored as its alias.\n The field is looked up among the tables the body reaches; a field or option that does not exist is refused naming both, and\n a field alias that two tables state with different keys for that option is refused naming each table. An option\n key written out reads as its alias, but write `option()`: a key is a value no one can read.\n7. **Text renders labels.** Inside a template or a text tool input, a select, member or link value renders its display\n text: `` `${record["status"]}` `` writes "Done", not `done`, and `` `${record["status"] ?? ""}` `` writes it too. A\n formula stating `options` (a computed category) is read as the single select it is drawn as: compared by option,\n rendered by label.\n\n## What an expression reads\n\n- `record`, `prev_record`, `changes` \u2014 in a table check, the write it checks (see **Table checks**).\n `changes` is a PARTIAL map: `changes["x"]?.next_value` and `?.prev_value`, the `?.` required.\n- `trigger` \u2014 what the trigger carries (see **Triggers**).\n- a loop\'s item name, and `index`, the iteration\'s 0-based index.\n- `<step id>` \u2014 an earlier step\'s output (`dup.records`).\n- `runtime.timezone`, `runtime.workflow_id`, `runtime.execution_id`, `runtime.workspace_id`,\n `runtime.organization_id`, `runtime.change_origin`, `runtime.triggered_by_member_id`. The current\n time is `now()`.\n\n## Paths\n\n- `record.x` and `record["x"]` read a field; `[n]` reads a list\'s n-th item.\n- A path may start at any expression: an awaited call `(await query_records({ table_id: "orders", record_ids: [id] })).records[0].data["x"]`, a helper\'s\n result `first(found.records).id`, a filter `rows.filter((r) => r.ok)[0].n`, a `(a ?? b).c`. `?.` reads\n through a null as usual, except on a value drawn at random (`sample(xs)?.id` is refused: bind it first).\n- A record reads in its declared shape wherever it comes from \u2014 the trigger, a tool result, a `let`, a\n callback parameter: a single select as its option alias or null, a member as its id, a link as its ids. A property read\n by alias (`x.order.quantity`, `xs[0]["quantity"]`, `y.quantity`) also names the record\'s field when the record is held in an\n object, a list or a spread (`{ order: record }`, `[record]`, `{ ...record }`); a helper\'s field-path text reads the\n rows of a records tool and a loop over them only. (The record tools called outside a workflow return the stored arrays instead.)\n- `linked(record["link"])[n]["x"]` fetches the n-th linked row and reads a field of it; bare\n `linked(record["link"])` is every linked row, one fetch per row. Its argument is a path ending on\n a link field and carries the guard: `linked(record?.["link"])[0]`.\n- `changes["link"]?.next_value` is the same list of ids; `linked()` over a change is refused \u2014\n read `linked(record["link"])` or `linked(prev_record["link"])`.\n\n## Operators and statements\n\nOperators in JavaScript precedence: `? :`, `||`, `??`, `&&`, `== != === !==`, `< <= > >=`, `+ -`, `* / %`,\nprefix `! -`.\n\n- Arithmetic is exact decimal (`0.1 + 0.2` is `0.3`). A result computed from a division that does not end\n is the short decimal it reads as (`1 / 3 * 3` is `1`), and stands as computed where it reads long\n (`1 / 3 * 100` is `33.33333333333333`). A comparison between two numbers reads both at 15 significant\n digits. `round` and `formatNumber` round the decimal, a half away from zero: `round(-2.5)` is `-3`. A\n table filter compares stored values exactly.\n- `??` is `coalesce(left, right)`; `?.` reads through a null (`a?.b`, `a?.[0]`, and `s?.trim()` for the\n method names listed under **Helpers**). `x?.()` is refused: helpers and tools are not values.\n- Templates use backticks and `${...}`. `get_workflow` shows a template as `text(\u2026)`, which writes its parts in order as the template does: `text("Missing: ", join(names, ", "), ".")`. A request whose body holds a template\'s `${\u2026}` can be refused before it reaches Lotics, a 403 page rather than an answer; write that text with `text(\u2026)`.\n- Destructuring \u2014 `const { status, name } = record;` binds each name. Renames\n (`{ status: s }`), quoted keys (`{ "ref": ref }`), array patterns with holes\n (`const [first, , third] = xs;`) and defaults (`{ note = "" }`, which apply on null too) work on\n `const`, `let` and `for (const { id } of rows)`. A tool result destructures directly:\n `const { records } = await query_records({...});`. `const a = 1, b = 2;` declares both. Nested\n patterns and rest are refused.\n- Spread \u2014 `[...a, b]` and `{ ...a, b: 1 }` (later keys win). Refused inside a tool input: bind the\n merged value first and pass the binding.\n- Shorthand \u2014 `{ table_id }` is `{ table_id: table_id }`.\n- `xs.push(a, b);` appends, also on a key (`o.items.push(v)`); `o.a.b = v;` sets a nested key;\n `x ??= v`, `x ||= v` and `x &&= v` assign. A `const` may be pushed to or have a key set, as in\n JavaScript; a loop item is read-only.\n- `undefined` reads as `null`, so `x === undefined` is `isNull(x)` and `x !== undefined` is `isNotNull(x)`;\n a key set to null and a key never sent are not told apart (`"k" in o` tells a key that is there). A write\n tells them apart: a field given `undefined` is left as it is (Writing a field: null and undefined).\n- `typeof x` answers JavaScript\'s words, and a null (a missing value too) is `"object"`. `k in o` tests an\n object\'s own keys, or a list\'s indexes and `length`.\n- A filter node may leave out `node_type` when its keys say which it is: `field_key` / `operator` /\n `value` a condition, `logic` / `children` a group, `path` / `condition` a traversal.\n- `function name(p = <default>) { return <expr>; }` \u2014 top level only, expanded at every call (a call\n may come before it). Every parameter needs a default, which gives it its type; the body is one\n `return <expr>;` reading only its parameters, helpers and the reserved roots \u2014 never the caller\'s\n names, nor `index`. No recursion; a function never called is refused. A body read back shows the\n expression at each call, not the `function`.\n\n**try / catch.** `try { ... } catch (e) { ... }` catches a tool error or an expression error inside the\nbody; `e` is `{ message, type, step_id?, detail? }`. A failed `validate` and a `return` are not\nerrors \u2014 they end the workflow \u2014 and a step that runs after a wait inside the `try` is outside it.\n`finally` is refused: put always-run steps after the `try`.\n\n**Loops.** `for-of`, `while (cond) { ... }`, `do { ... } while (cond);` and\n`for (let i = 0; i < n; i++) { ... }`, each capped at 10,000 iterations. `break;` and `continue;` act\non the innermost loop; labels and `for-in` are refused.\n\n**`let`.** `let x = <expr>;` declares a block-scoped variable; the initializer is required\n(`let x = null;`). Reassign with `=`, `+=`, `-=`, `*=`, `/=`, `%=`, `??=`, `++` and `--`. Re-declaring in\nthe same block is refused; shadowing in a nested block is allowed. A `let` keeps its value across a\n`wait` or `wait_for_event`.\n\n**Refused, each because a save must know what runs and a run must give the same answer twice:** regex\n(unbounded matching: use the string methods), `Math.random`, `Date.now()` and `new Date()` (use `now()` and\n`parseDate`), a tool or helper as a value or a computed callee (callees are named), `new` of anything,\n`instanceof`, `delete`, `void`, rest elements, computed keys, classes, `throw`, `finally`, `import`,\n`export`, `eval`, labels, and a function as a value (`const f = (x) => ...`: pass the arrow to the helper\nthat takes it). `xs.sort(...)` on a name or path is refused too, since a value is never changed in place:\nwrite `xs.toSorted(...)` or `[...xs].sort(...)`.\n\n## Typing\n\n- The body is type-checked as TypeScript before it is read: annotations, `as`, `satisfies` and a non-null `!`\n are accepted and erased, and the checker is strict about null. The stored body keeps none of them and is checked again as\n stored, by field key, as every later change to its app or tables checks it: a body that types only through one of them is\n refused at save.\n- Narrow what is not typed (a connector\'s JSON is `unknown`) with `typeof`, `in`, `Array.isArray` and `isNull`.\n- `first(xs)` may be undefined; `requireFirst(xs)` is the list\'s first item or an error. A test of `first(xs)` covers no second `first(xs)`: bind it once (`const id = first(xs)`), then test `id`.\n- `obj[key]` needs `key` to be a key of `obj`, or `obj` to be a record with a string index.\n\n## Helpers\n\nOrdinary JavaScript works \u2014 the standard library below, the array and string methods, `Math`, `JSON`,\n`Object`, `Array`, `Number`, `parseInt` \u2014 and means what it means in JavaScript, with the differences\nlisted here. Where JavaScript answers NaN, Infinity or undefined, a workflow has none of them and the\nanswer is `null`.\n\n- Standard library: `Math.abs/ceil/floor/trunc/sign/min/max/pow/sqrt`, `Number(x)`, `String(x)`,\n `Boolean(x)`, `parseInt(s, radix?)`, `parseFloat(s)`, `Number.isFinite/isInteger`,\n `Object.keys/values/entries/fromEntries`, `Array.isArray/from` (a list, text, or `{ length: n }`),\n `JSON.parse/stringify`.\n- Arrays: `length, map, filter, find, findIndex, findLast, some, every, reduce, includes, indexOf, join,\n slice, concat, flat, flatMap, at, reverse, toReversed, toSorted` and `[...xs].sort(compare?)`.\n- Strings: `length, toLowerCase, toUpperCase, trim, trimStart, trimEnd, startsWith, endsWith, includes,\n indexOf, slice, substring, split, replace, replaceAll, padStart, padEnd, repeat, charAt, at,\n localeCompare` (en-US order, wherever it runs). Numbers: `toFixed, toString`.\n- Differences from JavaScript: `Math.round` is the engine\'s `round` (a half goes away from zero:\n `Math.round(-2.5)` is `-3`); `Number(x)` and `parseFloat(x)` are `toNumber`, which refuses text that is no\n number; `String(null)` is `""`; `join` writes a null item as `null`; `concat` skips a null; `toFixed`\n rounds the decimal, not the binary double; `replaceAll` writes the replacement as text\n (`$&` stays as typed), while `replace` expands `$&`, `$$`, `` $` `` and `$\'` in it as JavaScript does; `split` takes no limit; `sort` without a comparator orders by text, as JavaScript does. `==`, `!=`, `===` and `!==` between two list values (files, a multi-select, a link of any cardinality, a lookup) are refused at save, since a list compares by identity, not by its items: `!isNull(changes.<field>)` asks whether one changed.\n\nThe same work can be written with the helpers below, which are additions to JavaScript. They are called as\n`size(arr)`; the method form works only where the name is also a JavaScript method \u2014\n`x.trim()`, `arr.includes(v)`, `arr.at(-1)`, `arr.map(fn)`, `s.split(",")`; `arr.size()` is refused.\n\n- **Null and type**: `isNull`, `isNotNull`, `isEmpty`, `isString`, `isNumber`, `isBoolean`, `isArray`,\n `isObject`, `coalesce`, `get`, `toNumber`, `toFigure`, `toString` (a text, number, yes/no or date; a record, file or list is refused at save, an object at run), `typeOf`, `parseJson`, `toJson`. `isNull` is strict (`null` and `undefined` only), but on a list field of the record (a link, files, a multi-select) it asks whether the list holds nothing, since a cleared list is `[]`: `!isNull(record.vehicle)` reads as `!isEmpty(record.vehicle)`. `isNull(changes.<field>)` stays strict: null there means unchanged\n- **Lists**: `size`, `first`, `requireFirst` (the first item, refusing an empty list \u2014 after a\n `validate` on the size it saves an `if`), `last`, `nth`, `at` (`at(arr, -1)` counts from the end),\n `includes`, `filter`, `find`, `some`, `every`, `pluck`, `sortBy`, `groupBy`, `countBy`, `unique`,\n `uniqueBy`, `compact` (drops falsy items), `flatten`, `reverse`, `slice`, `concat`, `difference`,\n `differenceBy`, `intersection`, `intersectionBy`, `list`, `reduce(arr, (acc, x) => ..., initial)`,\n `range(end)` / `range(start, end)`\n- **Math**: `sum`, `sumBy`, `mean`, `meanBy`, `minBy`, `maxBy`, `round`, `ceil`, `floor`, `min`, `max`,\n `abs`, `mod`, `pow`, `sqrt`, `clamp`, `percentage`\n- **Text**: `upper`, `lower`, `capitalize`, `trim`, `contains`, `startsWith`, `endsWith`, `replace`,\n `replaceAll`, `removeChars(str, chars)` (without every character that occurs in `chars`),\n `removeSpaces(str)` (without any whitespace; a Word template command calls both too), `substring`, `length`, `split`, `join`, `padStart(str, length, char)`,\n `padEnd(str, length, char)`, `formatNumber(x, decimals)` (ungrouped; rounds the decimal, a half away\n from zero: `formatNumber(1.005, 2)` is `1.01`),\n `formatDecimal(x, decimals, locale)` (grouped: `formatDecimal(151000, 0, "vi-VN")` is `151.000`),\n `numberToWords(x, lang?)` (an integer in words: Vietnamese, or English with `"en"`),\n `uuidFrom(text)` (the same UUID for the same text, refusing null and empty text: `uuidFrom(record.id)`)\n- **Objects**: `keys`, `values`, `entries`, `nonNullKeys`, `pick`, `omit`, `merge`\n- **Dates**, in the workspace\'s timezone: `now`, `formatDate`, `parseDate`, `addDays`, `subDays`,\n `addHours`, `subHours`, `addMinutes`, `subMinutes`, `startOfDay`, `endOfDay`, `startOfMonth`, `endOfMonth`,\n `addMonths` (a day past the target month\'s end lands on its last day), `differenceInCalendarDays`, `differenceInHours`, `differenceInMinutes`, `isBefore`, `isAfter`,\n `isSameDay`, `isToday`, `isWithinRange`, `datesOn(from, until, days)` (the days from `from` to `until`, both included, falling on weekdays named `mon` to `sun`), `meetsBounds`. A date beside a moment compares by day, so `<=` means\n through that day; `startOfMonth` and `endOfMonth` of a date answer a day\n- **Other**: `formatCurrency(amount, locale, currency)`, `randomNumber(len)`,\n `randomAlphaNumeric(len)`, `sample(items)` (a random item)\n\nOver a null or empty list `mean`, `meanBy`, `min`, `max`, `minBy` and `maxBy` answer null, while `sum`\nand `sumBy` answer 0: `maxBy(pieces, "reach")?.Name` prints a blank for a month with no pieces.\n\nA date helper given a null or empty date returns null, so guard its result before comparing or\nwriting it: `differenceInCalendarDays(a, b) ?? 0`.\n\n`filter`, `find`, `some`, `every`, `sortBy`, `pluck`, `sumBy`, `meanBy`, `minBy`, `maxBy`, `groupBy`,\n`countBy`, `uniqueBy`, `differenceBy` and `intersectionBy` take a path string\n(`filter(record.items, "Status", "open")`) or a callback\n(`filter(record.items, x => x.Status == "open" && x.Amount > 100)`); `reduce` takes a callback and an\ninitial value. A callback gets `(item, idx)` (`reduce`: `(acc, item, idx)`) and reads `record`,\n`runtime`, the names in scope, loop items and an enclosing callback\'s parameters. Its body is one\nexpression \u2014 `(x) => <expr>`, `(x) => { return <expr>; }` or `function (x) { return <expr>; }`;\nseveral statements, `async` and named function expressions are refused.\n\nLook a row up by key rather than filtering for it: a `filter` inside a callback walks its whole list again\nfor every item, so a thousand items against a few hundred rows is hundreds of thousands of calls. Group the\nrows once, then read each group by its key. `groupBy` answers an object of lists, and `byCode[code] ?? []`\nis the group a code names, or an empty list:\n\n```\nconst parties = await query_records({ table_id: "parties" });\nconst lines = await query_records({ table_id: "sheet_lines" });\nconst byCode = groupBy(parties.records, (p) => p.data["code"] ?? "");\nconst holders = lines.records.map((line) => ({\n line: line.id,\n parties: (byCode[line.data["code"] ?? ""] ?? []).map((p) => p.id),\n}));\n```\n\nA key is read exactly: a code holding a dot, a slash or a bracket reads its own group, and a name every\nobject inherits (`constructor`) reads nothing unless a row made a group of that name. `get(o, "a.b")`\nfollows a dotted path instead, so a key that holds a dot is read with `o[key]`.\n\n## Writing a field: null and undefined\n\nIn `update_records`\' `set`, `create_records`\' `records` and the workflow step `save_record`\'s `set` and line rows:\n\n- `null` clears the field.\n- `undefined`, or leaving the key out, leaves the field as it is.\n\nSo passing a read that may be null (`record["x"]`) keeps a value when there is one and clears the\nfield when there is none. Use `coalesce(x, fallback)` only for a real fallback value.\n\n## Examples\n\nCompare a link by id. Display text is not unique, and a link reads as a list of ids \u2014 `==` against a\nstring is a type error:\n\n```\nconst found = await query_records({\n table_id: "customers",\n filters: { node_type: "condition", field_key: "name", operator: "equals", value: "ACME Corp" },\n});\nconst customer = first(found.records);\nconst order = (await query_records({ table_id: "orders", record_ids: [trigger.app_workflow.inputs.order_id] })).records[0];\n\nif (customer && includes(order.data["customer"], customer.id)) {\n // \u2026\n}\n```\n\nRead an uploaded sheet and add the rows a table lacks. `excel_get_rows`, a workflow step, answers every\nrow of an `.xlsx`, `.xls` or `.csv` sheet in one call, each an object keyed by the header row\'s text. A cell is a number,\n`true` or `false`, text, a date as ISO text, or null when blank, so `row["Header"]` is typed\n`string | number | boolean | null` and a helper narrows it: `toString` for text, `toNumber` for a number,\n`isString` before a date. Every cell of a `.csv` is text. `columns` keeps only the ones the body reads.\nA sheet past what one call reads is refused with its size, never cut short: the step\'s entry in\n`workflow_steps` states the bounds.\n\nA sheet\'s rows are written with `save_record`, a workflow step, once per row. `match` is the row\'s identity,\n`{ code: <the row\'s code> }`, and must be a uniqueness its table declares: the field is `unique`. A live row carrying\nthe key is found and only the cells of `set` that differ are written; none is found and the row is added. Run the same\nfile twice and the second run writes nothing new. A cell the row has no value for is left out of `set`, and `null` is an\nempty cell, which differs from a filled one as any other value does. A row the body should not write is skipped and\ncounted in what the workflow returns, so the person who ran it is told; the step holds nothing back on its own, and a\nrow a table check or a lock refuses fails the call, naming the row.\n\nA link cell takes the record id of the row it links. To find that row by the text a sheet holds, `query_records` the\nlinked table once, `groupBy` its key, and read the id from the group. A body that does not find the row skips the\nsheet\'s row and counts it.\n\n```\nconst sheet = await excel_get_rows({ // a workflow step\n file_id: trigger.app_workflow.inputs.file,\n columns: ["Code", "Name", "Price"],\n});\n\nconst kept = await create_records({\n table_id: "price_sheets",\n records: [{ file: [trigger.app_workflow.inputs.file], run: runtime.execution_id }],\n});\nconst sheet_id = kept.record_ids[0];\n\nlet added = 0;\nlet changed = 0;\nlet skipped = 0;\nfor (let at = 0; at < size(sheet.rows); at += 1) {\n const row = sheet.rows[at];\n if (isNull(row["Price"])) {\n skipped += 1;\n await create_records({\n table_id: "sheet_lines",\n records: [{ sheet: [sheet_id], line: at + 2, outcome: "skipped", why: "The sheet states no price", code: toString(row["Code"]) }],\n });\n } else {\n const saved = await save_record({ // a workflow step\n table_id: "plants",\n match: { code: toString(row["Code"]) },\n set: { name: toString(row["Name"]), price: toNumber(row["Price"]) },\n });\n added += saved.created ? 1 : 0;\n changed += !saved.created && size(saved.updated_field_keys) > 0 ? 1 : 0;\n }\n}\n\nreturn({ status: "success", message: `${added} added, ${changed} changed, ${skipped} skipped` });\n```\n\nOne `save_record`, a workflow step, per row writes about a hundred rows a second on a table of thirty fields with a link, a lookup and a\nformula: a thousand rows took ten seconds. A run whose writes finish within twenty seconds lands all or nothing; a\nlonger one starts again, each row written as it is reached, and three thousand rows took seventy of the ninety seconds\nan awaited call gives a run. A sheet of up to about a thousand rows loops; a larger one is written in batches.\n\nThe batched form reads the table\'s keys once and writes in calls of up to a thousand rows. `query_records` the table\nin pages, `groupBy` the key, split the sheet\'s rows into those with no row yet and those whose cells differ, then\n`create_records` the first and `update_records` the second in its per-record form (`field_keys` and one `rows` entry per\n`record_ids` entry). Ten thousand rows took about seven seconds, a repeat with nothing changed under three, and the\nwhole of it is one transaction at that size. The body does the comparison, so it writes only what differs:\n\n```\nconst inputs = trigger.app_workflow.inputs;\n\nconst sheet = await excel_get_rows({ // a workflow step\n file_id: inputs.file,\n columns: ["Code", "Name", "Price"],\n});\nconst rows = sheet.rows.map((row) => ({ code: toString(row["Code"]), name: toString(row["Name"]), price: toNumber(row["Price"]) }));\n\nlet held = (await query_records({ table_id: "plants", field_keys: ["code", "name", "price"], pagination: { offset: 0, limit: 1000 } })).records\n .map((one) => ({ id: one.id, code: toString(one.data["code"]), name: toString(one.data["name"]), price: toNumber(one.data["price"]) }));\nfor (let start = 1000; start < inputs.row_count; start += 1000) {\n const page = await query_records({ table_id: "plants", field_keys: ["code", "name", "price"], pagination: { offset: start, limit: 1000 } });\n held = concat(held, page.records.map((one) => ({ id: one.id, code: toString(one.data["code"]), name: toString(one.data["name"]), price: toNumber(one.data["price"]) })));\n}\nconst byCode = groupBy(held, (one) => one.code);\n\nconst fresh = filter(rows, (row) => size(byCode[row.code] ?? []) == 0);\nconst changed = filter(rows, (row) =>\n size(byCode[row.code] ?? []) > 0 &&\n (requireFirst(byCode[row.code] ?? []).name != row.name || requireFirst(byCode[row.code] ?? []).price != row.price));\n\nfor (let at = 0; at < size(fresh); at += 1000) {\n await create_records({ table_id: "plants", records: slice(fresh, at, at + 1000) });\n}\nfor (let at = 0; at < size(changed); at += 1000) {\n const part = slice(changed, at, at + 1000);\n await update_records({\n table_id: "plants",\n record_ids: part.map((row) => requireFirst(byCode[row.code] ?? []).id),\n field_keys: ["name", "price"],\n rows: part.map((row) => [row.name, row.price]),\n });\n}\n\nreturn({ status: "success", message: `${size(fresh)} added, ${size(changed)} changed` });\n```\n\n`inputs.row_count` is a number the act asks beside the file. A key the table keeps `unique` refuses a second row with\nit, so a sheet that carries one key twice fails the `create_records` call, naming it, before any row of that call is\nwritten.\n\nA workflow does not put a run\'s writes back: that reads the history of what the run wrote, which a member\'s agent reads\nunder the member\'s own access to the table and no workflow does. A member\'s agent puts them back with\n`update_records`: `query_audit_logs` on the table shows what the run wrote \u2014 the run is what `runtime.execution_id` held in\nit, which a body keeps on a row of its own \u2014 and each field\'s value before it, `update_records` writes that value back as\nthe member\'s own write, `update_records` with `restore: true` brings back a row the run moved to the trash, and\n`delete_records` removes a row the run created. Write a field back only where the row still holds what the run wrote.\n\nWhat a business keeps of a sheet \u2014 the file, its counts, the lines waiting for a person \u2014 is rows of its own tables,\nwritten by the workflow that ran. A garden centre brings its grower\'s price sheet into its plants, and keeps each sheet\nand the lines it skipped. These tables are shown beside the plants, in the same app: the sheets as a List beside the\nplants\' (a second List at the root, `reference/app-node`), a sheet\'s lines on the page it opens. A line keeping what a\ncell held and what it holds now in two fields reads one against the other (`compare`, `reference/list-node`).\n\nA skipped line is applied by the act on it, whose workflow reads the line and saves the plant from it. A cell the line\nholds none of is left out, so a skipped line never empties a cell of the plant:\n\n```\nconst line = (await query_records({ table_id: "sheet_lines", record_ids: [trigger.app_workflow.inputs.record_id] })).records[0];\nconst values = {\n ...(isEmpty(line.data["name"]) ? {} : { name: line.data["name"] }),\n ...(isNull(line.data["price"]) ? {} : { price: line.data["price"] }),\n};\n\nawait save_record({ // a workflow step\n table_id: "plants",\n match: { code: line.data["code"] },\n set: values,\n});\n\nawait update_records({ table_id: "sheet_lines", record_ids: [line.id], set: { outcome: "applied" } });\nreturn({ status: "success", message: "Applied." });\n```\n\n### A reviewed act\n\nA shop matches a bank statement to the notes it is owed by an act that states `review`. That act\'s workflow only\nproposes: its body calls steps that read and no other, and runs no agent \u2014 either is refused when the body is saved \u2014\nand returns in `data.review` one changeset of the act\'s table, which the platform writes the approved rows of. Called\nwith what the act asks, it answers the proposal and nothing is written; called again with\n`approved: { creates: [{ key, sha }], updates?: [{ record_id, sha }] }` (absent `updates` means none), the body runs again and the platform writes\nthose rows as this second run proposes them, so the body never reads `approved`. The platform adds a `sha` to every row\nof the proposal it answers \u2014 the body states none, and one it states is dropped \u2014 and the caller echoes the `sha` of\neach row it approves. A row the second run proposes with other values than the `sha` was read from is left unwritten\n(`changed`), so the body must propose the same for the same inputs and the rows it reads.\nAn update is of a record the act is run over (`record_id`, or one of `record_ids`): one of any other record is left\nunwritten. An act over every row in view is handed no rows: its body reads the rows it may change, and any of them may\nbe proposed. A create carries a `key`, a text of the body\'s own that names the same line on every run\n(`key: toString(line["Reference"])`), unique among the creates; where a confirm repeated must not add a second row,\nthe body also writes the key into a field the table keeps unique, so the repeat\'s create is left as a `conflict`.\nEach row\'s `data` holds only stored fields that change \u2014 never one the platform computes or stamps, nor a file \u2014 with\na `note` and a `ticked` the reader starts from, and `unplaced` lists what was read and matched nothing. Every approved\nrow is checked against its fields before any is written, and they are written in one transaction, so a flawed one\nwrites none. The status history of every row written that moved, or was made holding a status, is recorded in the\nsame run. The answer\'s `applied.previous` holds what each updated record\'s written fields held before, so one `update_records` of it puts the values back, and `delete_records` of a `created` record takes that row away. A body that stops proposing a row once it is\nwritten \u2014 it matches against what the rows hold now \u2014 makes approving twice write once.\n\n```\nconst inputs = trigger.app_workflow.inputs;\n\nconst sheet = await excel_get_rows({ // a workflow step\n file_id: inputs.statement,\n columns: ["Reference", "Amount", "Paid on"],\n});\nconst unpaid = await query_records({\n table_id: "notes",\n filters: { field_key: "paid_on", operator: "is_empty" },\n pagination: { offset: 0, limit: 500 },\n});\nconst acted = groupBy(inputs.record_ids, (id) => toString(id));\nconst owed = filter(unpaid.records, (one) => size(acted[toString(one.id)] ?? []) > 0);\nconst byRef = groupBy(owed, (one) => toString(one.data["ref"]));\n\nconst lines = sheet.rows.map((line) => ({\n line,\n note: first(byRef[toString(line["Reference"])] ?? []),\n}));\nconst updates = filter(lines, (one) => !isNull(one.note)).map((one) => ({\n record_id: toString(one.note?.id),\n note: `Transfer of ${toString(one.line["Amount"])}`,\n ticked: toNumber(one.line["Amount"]) == sumBy(filter(owed, (owing) => owing.id == one.note?.id), (owing) => coalesce(owing.data["amount"], 0)),\n data: { paid_on: toString(one.line["Paid on"]) },\n}));\nconst unplaced = filter(lines, (one) => isNull(one.note)).map((one) => ({\n title: `${toString(one.line["Reference"])}: ${toString(one.line["Amount"])}`,\n note: "Matches no unpaid note",\n}));\n\nreturn({\n status: "success",\n message: `${size(updates)} of ${size(lines)} transfers match a note`,\n data: { review: { version: 1, table_id: "notes", creates: [], updates, unplaced } },\n});\n```\n\n### Saving a record with its lines\n\n`save_record`, a workflow step, saves one record and the rows of other tables that hang off it, all or\nnothing, and recognises what exists by the identity the input carries \u2014 so a call sent twice updates and\nadds nothing. `match` is the record\'s identity, `{ field_key: value }`, and must be exactly a uniqueness\nits table declares: one field marked `unique`, or the fields of one of the table\'s `unique` sets together\n(text, number, date, single select and one-row link fields). A `match` that is no declared uniqueness is\nrefused, naming what the table does declare. A live record carrying the match is found and only the cells\nof `set` that differ are written; none is found and it is added with `match` and `set`. `add_to` appends\nto a files, multi-select or many-link field and keeps what it holds.\n\n`lines` saves rows of other tables that link the record. Each entry names the child `table_id`, its\n`link` \u2014 a field of the child holding one row of this table, which the step fills and no row states \u2014\nthe child fields that, with `link`, are one uniqueness of the child table (`match`), and `rows`, each\nstating every `match` field. A line found by its match changes only the cells that differ, one not found\nis added, and a line the call does not list is left as it is: the step deletes nothing. Two rows of one\nentry cannot share a match.\n\nEverything is checked before the first write, and everything is written in one transaction: a table check\nthat refuses one line, a locked record or line the call would change, a value a field does not take, or a\ntable the run may not write refuses the call and saves nothing, naming the row. Two calls of one identity\ntake turns, so the second finds what the first saved. The answer is `record_id`, `created`,\n`updated_field_keys` (the cells changed on a record that existed) and, per entry of `lines`, the ids it\nadded, changed and left unchanged; these ids are typed for their tables, so a declared `record_link`\noutput or a follow-up write links straight to them.\n\n```\nconst inputs = trigger.app_workflow.inputs;\n\nconst sheet = await excel_get_rows({ // a workflow step\n file_id: inputs.release_order,\n columns: ["Size", "Quantity"],\n});\n\nconst saved = await save_record({ // a workflow step\n table_id: "release_orders",\n match: { number: inputs.number },\n set: { note: "Read from the paper" },\n lines: [{\n table_id: "release_lines",\n link: "order",\n match: ["size"],\n rows: sheet.rows.map((row) => ({\n size: toString(row["Size"]),\n quantity: toNumber(row["Quantity"]),\n })),\n }],\n});\n\nreturn({\n status: "success",\n message: `${size(saved.lines[0].created_ids)} lines added`,\n data: { record_id: saved.record_id },\n});\n```\n\n### Numbering a row at a moment\n\nA number given when a row is signed or issued is an editable number field the workflow fills with the table\'s highest plus one,\nonly while the row has none, so a second press keeps its number. The field carries a one-field `unique` set on its table, so two\nruns that read the same highest are refused, not doubled; the refused run reads the highest again, for three attempts in all, and\na run still refused after the third fails with that refusal. The last attempt stands outside the `try`, since a `catch` takes any\ntool error, not the unique refusal alone. A sequence per series or year filters the query on it and states a two-field `unique`.\n\n```\nif (isNull(record.no)) {\n let numbered = false;\n for (let attempt = 0; attempt < 2 && !numbered; attempt++) {\n const top = await query_records({ table_id: "contracts", sort: [{ field_key: "no", order: "desc" }], limit: 1 });\n try {\n await update_records({ table_id: "contracts", record_ids: [record.id], set: { no: coalesce(first(top.records)?.data["no"], 0) + 1 } });\n numbered = true;\n } catch (e) {\n numbered = false;\n }\n }\n if (!numbered) {\n const last = await query_records({ table_id: "contracts", sort: [{ field_key: "no", order: "desc" }], limit: 1 });\n await update_records({ table_id: "contracts", record_ids: [record.id], set: { no: coalesce(first(last.records)?.data["no"], 0) + 1 } });\n }\n}\n```\n\n## Schedules\n\nA weekly pattern made into dated rows is a parent\'s `records.cadence` and an Act `makes` it\n(`reference/record-places-pins-and-cadence`), no body; pressed again it also moves the rows the pattern now makes otherwise that no one has touched. The rest of a timetable is a rule or a short body.\n\n**A student in two places.** An enrolment reads its span and its days off its course, so one meeting at the same\ntime on a shared weekday as the student\'s other course is refused at save:\n\n```json\n"no_overlap": { "from": "course.starts", "to": "course.ends", "by": ["student", "course.days"], "while": { "state": ["active"] } }\n```\n\n**A swap.** One Act on a shift runs a `workflow` asking the other shift (an input `other` of `type: "link"`, `entity` the shifts) and writes both people in one call:\n\n```\nconst inputs = trigger.app_workflow.inputs;\nconst both = (await query_records({ table_id: "shifts", record_ids: [inputs.record_id, inputs.other] })).records;\nconst mine = requireFirst(filter(both, (one) => one.id == inputs.record_id));\nconst theirs = requireFirst(filter(both, (one) => one.id == inputs.other));\nawait update_records({\n table_id: "shifts",\n record_ids: [mine.id, theirs.id],\n field_keys: ["person"],\n rows: [[theirs.data["person"]], [mine.data["person"]]],\n});\nreturn({ status: "success", message: "Swapped." });\n```\n\n**A rotation.** A pattern that turns over the days (teams taking nights in turn) is a body: `datesOn(from, until,\ndays)` lists the days of a range falling on the weekdays named.\n\n```\nconst inputs = trigger.app_workflow.inputs;\nconst days = datesOn(inputs.from, inputs.until, ["mon", "tue", "wed", "thu", "fri"]);\nconst teams = (await query_records({ table_id: "teams", record_ids: inputs.record_ids })).records;\nconst rows = days.flatMap((day, at) => teams.map((team, place) => ({ team: [team.id], day, kind: (at + place) % 2 == 0 ? "day" : "night" })));\nfor (let at = 0; at < size(rows); at += 1000) {\n await create_records({ table_id: "shifts", records: slice(rows, at, at + 1000) });\n}\nreturn({ status: "success", message: `${size(rows)} shifts` });\n```\n\n**Pay at the rate taught, and a month closed.** A lesson copies its teacher\'s rate when it is made (`"default_from":\n"teacher.rate"`), so a rise later leaves the lessons already made alone; a formula multiplies it by the lesson\'s hours,\nand a Tab\'s `totals` sums each teacher\'s month. A pay period is a row with its first and last day and a status; a check\non the lessons refuses every write inside a closed one:\n\n```json\n"checks": { "month_closed": {\n "on": ["create", "update", "delete"],\n "lookups": { "period": { "table": "pay_periods", "limit": 1, "filter": { "node_type": "group", "logic": "and", "children": [\n { "node_type": "condition", "field_key": "first_day", "operator": "on_or_before", "value": { "$expr": "record.starts_at" } },\n { "node_type": "condition", "field_key": "last_day", "operator": "on_or_after", "value": { "$expr": "record.starts_at" } },\n { "node_type": "condition", "field_key": "status", "operator": "has_any_of", "value": ["closed"] } ] } } },\n "fail_when": "size(lookups.period) > 0",\n "message": "\\"This month\'s pay is closed.\\""\n} }\n```\n\n## Reaching a connected service\n\nA service is reached only by a workflow step, and a step is called inside an app\'s workflow or an automation. From\nnothing to an app\'s run:\n\n1. `get_workspace` with `kind: "connection"` lists each `connected_account_id`.\n2. `set_app` declares a Workflow node that states what a call takes and hands back:\n\n```json\n{\n "type": "Workflow",\n "key": "invoice_order",\n "description": "Issues the KiotViet invoice for a confirmed order and hands back its code.",\n "inputs": { "order": { "type": "record_link", "entity": "order" } },\n "outputs": { "invoice_code": { "type": "text" } }\n}\n```\n\n3. `set_workflow` with a `source` that opens with `on({ type: "app", app_id: "app_\u2026", alias: "invoice_order" });` and this body (the step\'s entry is in `workflow_steps`):\n\n```\nconst order = (await query_records({ table_id: "orders", record_ids: [trigger.app_workflow.inputs.order] })).records[0];\nconst made = await kiotviet_create_invoice({ // a workflow step\n connected_account_id: "cac_\u2026",\n branch_id: 1,\n sold_by_id: 7,\n lines: [{ product_id: 42, quantity: toNumber(order.data["quantity"]), price: toNumber(order.data["price"]) }],\n});\nreturn({ status: "success", message: "Invoiced", data: { invoice_code: made.invoice.code } });\n```\n\n4. `run_app_workflow` with `dry_run: true`, then the same call without it.\n\nTo change later what it takes or hands back, send the node\'s change and the new body in one `set_app`, the body under\n`workflows`.\n\nA step wants the provider\'s own ids (`branch_id`, `sold_by_id`, `product_id`) and no tool lists them: declare a Workflow\nwhose body calls the provider\'s `list_*` workflow step (`kiotviet_list_branches`), run it, and read the ids from its answer.\nNo step lists KiotViet\'s users: read `sold_by_id` off a row `kiotviet_list_invoices` returns (KiotViet\'s `soldById`), or ask the owner.\n\n## Table checks\n\nA table check is one condition its table\'s record writes must not meet, declared beside the table\'s\n`unique`. It is not a workflow: it reads the write and a few lookups and answers yes or no, so it\ncannot change data. It runs inside the write, on every create, update or delete it is `on`, whichever\nsurface makes it \u2014 a person, the API, the CLI, an agent, a workflow. A refusal writes nothing and\nanswers with the check\'s message, under its field when the check names one, and names the check.\n\nA check is stated in its table\'s document, under `checks`, each under an alias of its own, and\n`set_tables` writes it with the rest of the table: a merge patch edits one, `null` removes it, and a\ncall that makes a table can state its checks, a lookup naming another table of the call by its `ref`.\n`get_table` states a table\'s checks in its document.\n\n| part | what it holds |\n|---|---|\n| `on` | the writes it checks: any of `create`, `update`, `delete` |\n| `when` | optional expression; the check runs only on a write where it is truthy. It cannot read lookups. |\n| `lookups` | optional, by name, the rows to read: `{ table, filter, limit }`, `table` an id or the `ref` of a table of the call, the filter as `query_records` takes it with fields and select options named by alias (`id` matches a row by its own record id), `limit` from 1 to 50 (50 when left out). A filter value that reads the record is `{ "$expr": "record.code" }`. |\n| `fail_when` | expression; truthy refuses the write |\n| `message` | expression for the refusal\'s text \u2014 a fixed text is a quoted string |\n| `field` | optional; the alias of the field the refusal is shown under |\n| `enabled` | `false` keeps the check without deciding writes; absent, it decides |\n\nEvery expression is written in the grammar above, names a table\'s fields and select options by\nalias (`record.status == "closed"`), and reads:\n\n- `record` \u2014 the record as it will be stored; on a delete, the record being deleted.\n- `prev_record` \u2014 on an update or a delete, the record before.\n- `changes` \u2014 on an update, the fields it changes. `!isNull(changes.photos)` asks whether a field changed.\n- `lookups.<name>` \u2014 in `fail_when` and `message`, the rows that lookup read. A row reads as `record` does: its fields by alias beside `id` (`row.start_on`), and a lookup field as the flat list of what it looks up (`first(row.booking_start)` through a one-row link). A lookup over the written table never returns the row being checked, and finds its other rows as the write leaves them, this call\'s other rows included. A field given to a helper as text names it by alias too (`sumBy(lookups.paid, "amount")`); text that names no field of the rows\' table is refused when the check is saved.\n- `runtime.timezone`, `runtime.workspace_id`, `runtime.organization_id`, `runtime.change_origin` (the\n write\'s origin), `runtime.triggered_by_member_id` (the member writing; null for a write no member\n made), `now()`, and `member_of("grp_\u2026")` \u2014 true when the member writing belongs to the group.\n\nIn a check a select reads as its one value (`record.kind == "retail"`), and a link (a one-row link too) and a lookup read as lists (`first(record.customer)`).\n\nA check on several operations reads only what all of them carry, so one on creates and updates reads\nneither `prev_record` nor `changes`.\n\nA write that recomputes another table\'s rows (a rollup over lines, a lookup or a formula over a parent) judges each recomputed row as an update, by the checks `on` `update` that read a field the recompute changed; `changes` is what the recompute changed. A check that refuses on `changes` or on a status the row holds can therefore refuse the write that moved the parent, so it is gated on the field it means (`!isNull(changes.status)`).\n\nA lookup reads with the access of the member who last saved the check, so saving one requires reading\nevery table its lookups read. A check\'s reads wait on the writes they depend on: the rows its links name are locked before it reads, and any other lookup takes a lock per check, so two writes at the same moment can\'t both pass a check the other would fail. Values no two rows may share are the table\'s `unique`.\n\nA `when`, a lookup or a `fail_when` that cannot decide \u2014 it fails, or the write\'s time runs out \u2014\nrefuses the write, naming the part it was reading and, for an expression or a filter, what it met\n(`lookups.clash: Filter on "start_on": date \'before\' value \u2026 is not a date`). A draft is checked when it is submitted, as a create; its edits before that are\nnot. A restored record is checked as a create. Cloning a table copies its checks to the member who\nclones it, and is refused when that member cannot read a table a check\'s lookup reads.\n\nOne open order per reference, a row never counting against itself:\n\n```json\n{\n "tables": [\n {\n "ref": "orders",\n "label": "Orders",\n "fields": {\n "reference": { "type": "text", "label": "Reference" },\n "closed_at": { "type": "date", "label": "Closed at" }\n },\n "checks": {\n "one_open_order_per_reference": {\n "on": ["create", "update"],\n "when": "isNull(record.closed_at)",\n "lookups": {\n "same_ref": {\n "table": "orders",\n "filter": {\n "node_type": "group",\n "logic": "and",\n "children": [\n { "node_type": "condition", "field_key": "reference", "operator": "equals", "value": { "$expr": "record.reference" } },\n { "node_type": "condition", "field_key": "closed_at", "operator": "is_empty" }\n ]\n },\n "limit": 2\n }\n },\n "fail_when": "some(lookups.same_ref, (r) => r.id != record.id)",\n "message": "\\"An open order already has this reference.\\"",\n "field": "reference"\n }\n }\n }\n ]\n}\n```\n\n## Table workflows\n\nA table workflow is what follows every committed write of a table\'s rows, whoever makes it: the grid, an import, an agent or\nany app. An effect that must hold for all of them belongs to the table. A button on one screen is that app\'s act, a value fixed\nwhen a row is made is `default_from`, and a rule that refuses a write is a check; a table workflow runs after the write has\ncommitted and cannot refuse it.\n\n`set_workflow` writes it: the `source` opens with `on({ type, table, ... })` and carries the steps, and `enabled: false`\nkeeps the workflow without running it (absent, it runs). `get_table` lists a table\'s workflows to whoever manages the\ntable \u2014 `workflow_id`, name, trigger, whether it is on and its failed runs of the last 7 days \u2014 and `get_workflow` reads one\nback. The table and the trigger type (`create`, `update` or `delete`) are fixed once the workflow is made: to change\neither, delete it and make another. A replace that changes only the gate, the trigger config or `enabled` moves the\nworkflow\'s version. `dry_run` with a `record_id` (and `prev_data` and `changes` for an update) says what the workflow would\nwrite on that row; reads are real and nothing is written.\n\n| part of the header | what it holds |\n|---|---|\n| `type` | the write it follows: `create`, `update` or `delete` |\n| `table` | the table\'s alias |\n| `when` | optional expression over `record`, `prev_record` and `changes`; the workflow runs only after a write where it is truthy |\n| `changed` | optional, with `type: "update"`: field aliases; the workflow runs only after an update that changes any one of them |\n\n```\non({ type: "update", table: "repairs", changed: ["status"], when: "record.status == \\"fixed\\"" });\n\nawait update_records({ table_id: "repairs", record_ids: [trigger.record_id], set: { fixed_on: formatDate(now(), "yyyy-MM-dd") } });\n```\n\nThe body names the table\'s fields, select options and other tables by alias, and reads the write as `record`,\n`prev_record` and `changes` and the row\'s id as `trigger.record_id`. It operates on records and integrations: a body\nthat calls a tool changing a table, an app or any other structure is refused when it is saved. It runs as the table\'s owner, so\nit reaches the tables the owner reaches, and its writes meet the table\'s checks like any other write; a write refused by a\ncheck fails that run and leaves the row as it was. A body names a field by alias where it can tell which table\'s field it is: a\nread of `record`, `prev_record` or `changes`, a row from `query_records` called with a literal `table_id`, and a\nloop over such rows, each also when held in an object, a list or a spread. A name it cannot tie to a table, and an option compared to a value of unknown type (not a read of a field, and\nnot a text, number or other value the type proves holds no option), are refused with what to change. A link reads as the list of the row ids it holds, a one-row link too: compare `first(record.customer) == id`. A lookup reads as one flat list of what it looks up: `record.x != prev_record.x` on one is refused, so compare `first(record.x)` with `first(prev_record.x)`. A single member, a single select, a number or a text reads as the value itself: `first(record.technician)` is refused at save, naming the read.\n\nA write the workflow itself makes sets off the workflows of its table in turn, and a chain of them stops after five. A workflow\nthat writes the row it follows is gated by a `changed` or a `when` that its own write does not satisfy. One run is queued for a\nrow and a workflow at a time, so a burst of writes to one row runs it once more after the run in flight. A field a workflow\nreads cannot be deleted or retyped until the workflow is changed or deleted with `set_workflow` before. Cloning a table copies its\nworkflows for whoever manages it (`include_workflows: false` leaves them), each with a body of its own, and is refused when a\nbody names a table the cloner cannot reach. A workflow runs as the table\'s owner, so whoever saves or rehearses one must manage the\ntable and read every table it reads in full: the body\'s, the gate\'s links\', the written table. An option is written where\nit is compared to, listed against or set on its field; a constant holding one is refused.\n\nA lock is the table\'s: a table workflow locks a row with `update_records` and `locked: true` (an app\'s act may too), and every door then refuses\nthe row\'s writes until whoever manages the table unlocks it with `update_records` and `locked: false` \u2014 in an app\'s run, judged as the member who pressed.\nA locked row reads locked in every app. An app\'s own Check or `edit: false` only makes a row read-only in that app.\n\n## Runs\n\nEach start of a workflow is a run: an app\'s workflow or act, a table workflow, a button, an automation. A call through an\napp\'s API to a workflow that only reads is kept as a run only when it fails or returns an error, unless its body reads\n`runtime.execution_id` or `runtime.change_origin`. An agent finds, reads, retries and stops runs. A run is read by whoever manages what its workflow belongs to: its\nautomation or its table, and for an app\'s workflow the app\'s owner or an admin, never a manager of the app.\n\n- **Find.** `query_workflow_executions` lists one workflow\'s runs (`workflow_id`), every run started for one row\n (`record_id`) \u2014 a table workflow\'s written row, a pressed button\'s row, an app run\'s `record_id` input \u2014 or both, newest\n first, a page at a time (`next_cursor`). Each run names its workflow and kind, what started it, its row and how it ended:\n for a failure, the step that threw, its tool and the error; for a waiting run, when it wakes, or the payment. A run started before runs recorded their row carries no `record_id`.\n- **Read.** `get_workflow_execution` gives one run\'s steps in order with each one\'s tool, input, output and error, what it\n returned, how many rows it wrote (a row\'s own history is in `query_audit_logs`) and the runs its writes started. Ninety days\n after a run starts, its trigger and its steps\' input and output are pruned; the read says so and gives the rest.\n `run_app_workflow` answers each run it makes with its `execution_id`.\n- **Retry.** `set_workflow_execution` with `action: "retry"` runs a failed, refused or cancelled run again as a new run linked to the first\n (`retry_of`): the first run\'s trigger and row, the workflow\'s current steps and its owner\'s current access, with the\n member who retries it as the one who started it. A run is retried once; a retry that fails is retried in turn. It asks\n first when the run, or a run it retried, already wrote rows or called a service no delete reverses. An automation\'s or a\n table workflow\'s retry runs in the background, as its runs do, and answers `queued`; a button\'s and an app\'s run while\n the call waits. An app\'s call is checked again against the workflow\'s current inputs. A pruned run, a run of a workflow\n that is off, a reviewed act\'s run (call the act again) and a recording\'s filing (the recording retries its delivery)\n are not run again.\n- **Stop.** `set_workflow_execution` with `action: "cancel"` stops a waiting run. Both answer\n `execution_id`, `action`, `status`, `retry_of`, `error` and, for a retry, `original_wrote`: the rows and the irreversible\n calls the first run wrote, which the retry makes again.\n\nOff means off: a waiting run whose workflow was turned off, deleted, or taken off its automation, table, button or app ends\n`cancelled` when it would resume, saying why, and runs no further step.\n\nA waiting run keeps its version: when it resumes, it runs the steps of the version it started with, so an edit saved while it\nwaited changes later runs only. When that version is gone, the run ends failed and says why.\n';
1907
1907
 
1908
1908
  // docs/workflow_steps.md
1909
- var workflow_steps_default = '<!-- Generated by backend/scripts/generate_workflow_steps_doc.ts from each step\'s schemas \u2014 never edit by hand. -->\n\n# Workflow steps\n\nThe steps only a workflow body runs: a connection\'s (an invoice issuer, a mailbox, \u2026) and the platform\'s own. Each is\ncalled as `await <step>({ ...inputs })` (see `workflows`); a step\'s inputs and answer are its entry here. A connection\nstep takes the `connected_account_id` that `get_workspace` lists under kind `connection`, and the app\'s owner must be\nable to use that connection. A step\'s `connected_account_id` is a literal, a\nconstant bound to one, or a choice among them: every possible value is judged at save, and one read from an input, a\nrecord or a call is refused. A template may come from data; a run refuses one its owner cannot use.\n\n**How a step fails.** A step that is refused \u2014 an input the schema rejects, a connection the workspace lacks, an\nanswer the provider refuses \u2014 ends the run, and the run\'s error reads `[<step>] <reason>`. Inside `try { \u2026 } catch\n(e) { \u2026 }` the body handles it instead: `e` is `{ message, type, step_id?, detail? }`, `message` the reason as\nabove. A provider\'s refusal carries the provider\'s own words.\n\n## aggregate\n\n### aggregate_records (workflow step)\n\n- Compute aggregate statistics over records.\n- Fields and select options are named by their alias, as get_table shows them. (chat, MCP, CLI)\n- A workspace admin\'s `as_member` computes over what that member would see.\n- Pass either `aggregate_option` for a single statistic, or `aggregations` to compute several in one call.\n- Example: { "table_id": "...", "aggregate_option": { "operation": "sum", "field_key": "amount" } } Operations by field type: No field: count \u2014 the rows matching `filters`.\n- `filled` counts populated CELLS, which is a different number the moment any are empty.\n- All fields: empty, filled, percent_empty, percent_filled, unique, percent_unique Number: sum, avg, median, min, max, range Date: earliest, latest, date_range Boolean: checked, unchecked, percent_checked, percent_unchecked `group_by` breaks every requested statistic down per distinct value of one field, computed over the same filters \u2014 one call in place of a call per bucket.\n- Example: { "table_id": "...", "group_by": "status", "filters": {...}, "aggregations": [{ "operation": "filled", "field_key": "created_on" }, { "operation": "sum", "field_key": "amount" }] } Restrict the period through `filters` on a date field rather than grouping by that date \u2014 a raw date/datetime groups per distinct stored value.\n- Filters: Operators: `is`, `is_not` on a field holding one value; `is_any_of`, `is_none_of` on text, number, date, select, member and link fields; `lt`, `lte`, `gt`, `gte` on number and date; `is_empty`, `is_not_empty` on every field but yes/no.\n- A date is "YYYY-MM-DD" for that whole day.\n- On text, `contains`, `starts_with` and `ends_with` ignore case and keep accents: `c\xE1` finds `C\xE1 h\u1ED3i`, not `C\xE0 chua`.\n- `ignore_accents: true` makes `ca` and `c\xE1` find both.\n- `equals` and `is_any_of` keep accents.\n- `docs path="filters"`. (chat, MCP, CLI)\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `table_id` | string | yes | |\n| `as_member` | string | | For a workspace admin: reads as this member would \u2014 their row rules and access. Anyone else is refused. |\n| `filters` | any | | |\n| `aggregate_option` | any | | |\n| `aggregations` | any[] | | At most 25 entries. |\n| `group_by` | string | | Field alias to break the statistics down by. Rows with no value in it are reported separately, not folded into a group. |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `result` | number \\\\| string | | Result of a single `aggregate_option` call \u2014 a number, or a string for dates. |\n| `_units` | object[] | | One answer per unit or currency the rows hold, most rows first; unit null for rows naming none. `result` is the first. |\n| `_units[].unit` | string \\\\| null | yes | |\n| `_units[].value` | number | yes | |\n| `results` | object[] | | One entry per aggregation when `aggregations` is used. |\n| `results[].operation` | string | yes | |\n| `results[].field_key` | string | yes | |\n| `results[].field_name` | string | yes | |\n| `results[].result` | number \\\\| string | yes | |\n| `results[].units` | object[] | | One answer per unit or currency the rows hold, most rows first; unit null for rows naming none. `result` is the first. |\n| `results[].units[].unit` | string \\\\| null | yes | |\n| `results[].units[].value` | number | yes | |\n| `groups` | object[] | | One entry per distinct value of `group_by`, each carrying every requested statistic. |\n| `groups[].key` | string | yes | The group\'s identity. `label` is a spelling of it, and two rows can spell one identity differently. |\n| `groups[].label` | string | | Readable name for `key` where one is known: an option\'s name, a linked record\'s display text, a filename. Absent means no name was available, never that the group is empty. |\n| `groups[].results` | object[] | yes | |\n| `groups[].results[].operation` | string | yes | |\n| `groups[].results[].field_key` | string | yes | |\n| `groups[].results[].field_name` | string | yes | |\n| `groups[].results[].result` | number \\\\| string | yes | |\n| `groups[].results[].units` | object[] | | One answer per unit or currency the rows hold, most rows first; unit null for rows naming none. `result` is the first. |\n| `groups[].results[].units[].unit` | string \\\\| null | yes | |\n| `groups[].results[].units[].value` | number | yes | |\n| `_ungrouped_rows` | number | | Matching rows with no value in the `group_by` field \u2014 counted in no group. |\n| `_group_field_name` | string | | |\n| `_operation` | string | | |\n| `_field_key` | string | | |\n| `_field_name` | string | | |\n| `_value_coverage` | object | | |\n| `_value_coverage.requested` | number | yes | |\n| `_value_coverage.field_name` | string | yes | |\n| `_value_coverage.composite` | boolean | | |\n| `_value_coverage.per_value` | object | | |\n| `_value_coverage.per_value.matched` | number | yes | |\n| `_value_coverage.per_value.missing` | string[] | yes | |\n| `_narrowed_hops` | string[] | | The tables a filter looked through whose rows this reader\'s access limits. |\n\n## bkav\n\n### bkav_attach_files (workflow step)\n\n- Attach workspace files (a bi\xEAn b\u1EA3n, a b\u1EA3ng k\xEA) to an invoice on Bkav.\n- Bkav accepts PDF and Excel, at most 1 MB each.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | Bkav connected account |\n| `invoice_guid` | string | | |\n| `partner_invoice_id` | string | | Your PartnerInvoiceStringID, when invoice_guid is not set |\n| `file_ids` | string[] | yes | |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `results` | object[] | yes | |\n| `results[].PartnerInvoiceID` | number | yes | |\n| `results[].PartnerInvoiceStringID` | string \\\\| null | yes | Null on a delete\'s answer |\n| `results[].InvoiceGUID` | string | yes | |\n| `results[].InvoiceForm` | string \\\\| null | yes | Null on a draft\'s link answer |\n| `results[].InvoiceSerial` | string \\\\| null | yes | Null on a draft\'s link answer |\n| `results[].InvoiceNo` | number | yes | Assigned by a numbered kind; 0 on a draft |\n| `results[].MTC` | string \\\\| null | yes | M\xE3 tra c\u1EE9u the buyer looks the invoice up with; null on a draft\'s link answer |\n| `results[].MaCuaCQT` | string \\\\| null | | |\n| `results[].Status` | number | yes | 0 succeeded; otherwise MessLog says why |\n| `results[].MessLog` | string | yes | |\n| `failed` | number | yes | Invoices whose own Status is not 0 |\n\n### bkav_cancel_invoices (workflow step)\n\n- Cancel issued invoices.\n- A cancelled invoice still reports to the tax authority; correcting one instead is a replacement or adjustment through bkav_submit_invoices. (workflow step, chat)\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | Bkav connected account |\n| `invoice_guids` | string[] | | InvoiceGUIDs Bkav returned |\n| `partner_invoice_ids` | string[] | | Your PartnerInvoiceStringIDs |\n| `reason` | string | yes | |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `results` | object[] | yes | |\n| `results[].PartnerInvoiceID` | number | yes | |\n| `results[].PartnerInvoiceStringID` | string \\\\| null | yes | Null on a delete\'s answer |\n| `results[].InvoiceGUID` | string | yes | |\n| `results[].InvoiceForm` | string \\\\| null | yes | Null on a draft\'s link answer |\n| `results[].InvoiceSerial` | string \\\\| null | yes | Null on a draft\'s link answer |\n| `results[].InvoiceNo` | number | yes | Assigned by a numbered kind; 0 on a draft |\n| `results[].MTC` | string \\\\| null | yes | M\xE3 tra c\u1EE9u the buyer looks the invoice up with; null on a draft\'s link answer |\n| `results[].MaCuaCQT` | string \\\\| null | | |\n| `results[].Status` | number | yes | 0 succeeded; otherwise MessLog says why |\n| `results[].MessLog` | string | yes | |\n| `failed` | number | yes | Invoices whose own Status is not 0 |\n\n### bkav_create_bill (workflow step)\n\n- Record a cash-register bill on Bkav.\n- Field names are Bkav\'s.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | Bkav connected account |\n| `bill` | object | yes | |\n| `bill.Bill` | object | yes | |\n| `bill.Bill.BillCode` | number | yes | |\n| `bill.Bill.OriginalBillCode` | number | | |\n| `bill.Bill.BillDate` | string | yes | |\n| `bill.Bill.BillStatusID` | number | yes | |\n| `bill.Bill.PayMethod` | string | | |\n| `bill.Bill.Note` | string | | |\n| `bill.ListBillDetails` | object[] | yes | |\n| `bill.ListBillDetails[].ItemTypeID` | number | | 0 goods, 4 description line, 15 promotional goods, \u2026 |\n| `bill.ListBillDetails[].IsDiscount` | boolean | | |\n| `bill.ListBillDetails[].ItemCode` | string | | |\n| `bill.ListBillDetails[].ItemName` | string | yes | |\n| `bill.ListBillDetails[].UnitName` | string | | |\n| `bill.ListBillDetails[].Qty` | number | | |\n| `bill.ListBillDetails[].Price` | number | | |\n| `bill.ListBillDetails[].Amount` | number | | |\n| `bill.ListBillDetails[].TaxRateID` | number | | 1 0%, 2 5%, 3 10%, 4 kh\xF4ng ch\u1ECBu thu\u1EBF, 9 8%, \u2026 |\n| `bill.ListBillDetails[].TaxRate` | number | | |\n| `bill.ListBillDetails[].TaxAmount` | number | | |\n| `bill.ListBillDetails[].OtherAmount` | number | | |\n| `bill.ListBillDetails[].DiscountRate` | number | | |\n| `bill.ListBillDetails[].DiscountAmount` | number | | |\n| `bill.ListBillDetails[].UserDefineDetails` | string | | |\n| `bill.ListBillDetails[].IsIncrease` | boolean \\\\| null | | On an adjustment: true raises the amount, false lowers it, absent adjusts information |\n| `bill.ListBillDetails[].SpecialtyItems` | string | | |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `created` | true | yes | |\n\n### bkav_create_invoice_from_bills (workflow step)\n\n- Raise one invoice from cash-register bills, by their BillGUIDs.\n- Field names are Bkav\'s.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | Bkav connected account |\n| `input` | object | yes | |\n| `input.Invoice` | object | yes | |\n| `input.Invoice.InvoiceTypeID` | number | yes | 1 GTGT, 2 b\xE1n h\xE0ng, 5 PXK ki\xEAm VCNB, 6 PXK g\u1EEDi b\xE1n \u0111\u1EA1i l\xFD |\n| `input.Invoice.InvoiceDate` | string | yes | ISO date |\n| `input.Invoice.BuyerCode` | string | | |\n| `input.Invoice.BuyerName` | string | | |\n| `input.Invoice.BuyerTaxCode` | string | | |\n| `input.Invoice.BuyerUnitName` | string | | |\n| `input.Invoice.BuyerAddress` | string | | |\n| `input.Invoice.BuyerBankAccount` | string | | Sent empty when absent: Bkav refuses it missing |\n| `input.Invoice.PayMethodID` | number | | 1 TM, 2 CK, 3 TM/CK, \u2026 |\n| `input.Invoice.ReceiveTypeID` | number | | 1 email, 2 SMS, 3 both, 4 courier |\n| `input.Invoice.ReceiverEmail` | string | | |\n| `input.Invoice.ReceiverMobile` | string | | |\n| `input.Invoice.ReceiverAddress` | string | | Sent empty when absent: Bkav refuses it missing |\n| `input.Invoice.ReceiverName` | string | | Sent empty when absent: Bkav refuses it missing |\n| `input.Invoice.Note` | string | | |\n| `input.Invoice.BillCode` | string | | Sent empty when absent: Bkav refuses it missing |\n| `input.Invoice.CurrencyID` | string | | |\n| `input.Invoice.ExchangeRate` | number | | |\n| `input.Invoice.InvoiceForm` | string | | M\u1EABu s\u1ED1 |\n| `input.Invoice.InvoiceSerial` | string | | K\xFD hi\u1EC7u |\n| `input.Invoice.InvoiceNo` | number | | S\u1ED1; 0 when Bkav assigns it |\n| `input.Invoice.MaCuaCQT` | string | | Set only by a cash-register flow that already holds the authority\'s code |\n| `input.Invoice.UserDefine` | string | | JSON-encoded template fields agreed with Bkav |\n| `input.Invoice.UIDefine` | string | | JSON-encoded delivery-note fields (InvoiceTypeID 5 and 6) |\n| `input.Invoice.isBTH` | boolean | | |\n| `input.Invoice.CCCD` | string | | |\n| `input.Invoice.PassportNumber` | string | | |\n| `input.Invoice.FiscalCodes` | string | | |\n| `input.Invoice.Reason` | string | | Why \u2014 required on a replacement or adjustment |\n| `input.Invoice.OriginalInvoiceIdentify` | string | | `[m\u1EABu s\u1ED1]_[k\xFD hi\u1EC7u]_[s\u1ED1]` of the invoice a replacement or adjustment corrects |\n| `input.Invoice.InvoiceGUID` | string | | Addresses the invoice for an update by guid |\n| `input.BillGUIDs` | string[] | yes | |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `results` | object[] | yes | |\n| `results[].PartnerInvoiceID` | number | yes | |\n| `results[].PartnerInvoiceStringID` | string \\\\| null | yes | Null on a delete\'s answer |\n| `results[].InvoiceGUID` | string | yes | |\n| `results[].InvoiceForm` | string \\\\| null | yes | Null on a draft\'s link answer |\n| `results[].InvoiceSerial` | string \\\\| null | yes | Null on a draft\'s link answer |\n| `results[].InvoiceNo` | number | yes | Assigned by a numbered kind; 0 on a draft |\n| `results[].MTC` | string \\\\| null | yes | M\xE3 tra c\u1EE9u the buyer looks the invoice up with; null on a draft\'s link answer |\n| `results[].MaCuaCQT` | string \\\\| null | | |\n| `results[].Status` | number | yes | 0 succeeded; otherwise MessLog says why |\n| `results[].MessLog` | string | yes | |\n| `failed` | number | yes | Invoices whose own Status is not 0 |\n\n### bkav_delete_invoices (workflow step)\n\n- Delete invoices that were never issued.\n- A numbered one can be deleted only if its number is the highest in its range.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | Bkav connected account |\n| `invoice_guids` | string[] | | InvoiceGUIDs Bkav returned |\n| `partner_invoice_ids` | string[] | | Your PartnerInvoiceStringIDs |\n| `reason` | string | | |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `results` | object[] | yes | |\n| `results[].PartnerInvoiceID` | number | yes | |\n| `results[].PartnerInvoiceStringID` | string \\\\| null | yes | Null on a delete\'s answer |\n| `results[].InvoiceGUID` | string | yes | |\n| `results[].InvoiceForm` | string \\\\| null | yes | Null on a draft\'s link answer |\n| `results[].InvoiceSerial` | string \\\\| null | yes | Null on a draft\'s link answer |\n| `results[].InvoiceNo` | number | yes | Assigned by a numbered kind; 0 on a draft |\n| `results[].MTC` | string \\\\| null | yes | M\xE3 tra c\u1EE9u the buyer looks the invoice up with; null on a draft\'s link answer |\n| `results[].MaCuaCQT` | string \\\\| null | | |\n| `results[].Status` | number | yes | 0 succeeded; otherwise MessLog says why |\n| `results[].MessLog` | string | yes | |\n| `failed` | number | yes | Invoices whose own Status is not 0 |\n\n### bkav_explain_invoice_error (workflow step)\n\n- Explain an erroneous invoice to the tax authority without replacing or adjusting it, optionally answering one of its notices.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | Bkav connected account |\n| `invoice_guid` | string | yes | |\n| `reason` | string | yes | |\n| `notice_number` | string | | S\u1ED1 of the authority\'s notice being answered |\n| `notice_date` | string | | yyyy-mm-dd; with notice_number |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `results` | object[] | yes | |\n| `results[].InvoiceGUID` | string | yes | |\n| `results[].Status` | number | yes | 0 succeeded; otherwise Msg says why |\n| `results[].Msg` | string | yes | |\n| `failed` | number | yes | Invoices whose own Status is not 0 |\n\n### bkav_explain_replaced_invoice (workflow step)\n\n- Explain to the tax authority an invoice that was replaced or adjusted.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | Bkav connected account |\n| `invoice_guid` | string | yes | |\n| `reason` | string | yes | |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `results` | object[] | yes | |\n| `results[].InvoiceGUID` | string | yes | |\n| `results[].Status` | number | yes | 0 succeeded; otherwise Msg says why |\n| `results[].Msg` | string | yes | |\n| `failed` | number | yes | Invoices whose own Status is not 0 |\n\n### bkav_get_bill (workflow step)\n\n- Read a cash-register bill.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | Bkav connected account |\n| `seller_tax_code` | string | yes | |\n| `organization_code` | string | yes | |\n| `bill_code` | number | yes | |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `bill` | object | yes | |\n\n### bkav_get_error_notice_pdf (workflow step)\n\n- Save the PDF of an invoice\'s 04/SS error notice as a workspace file.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | Bkav connected account |\n| `partner_invoice_id` | string | yes | Your PartnerInvoiceStringID |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `file_id` | string | yes | The ID of the generated file. |\n| `url` | string | yes | The download URL of the generated file. |\n| `filename` | string | yes | The filename of the generated file, including extension. |\n| `mime_type` | string | yes | The MIME type of the generated file. |\n\n### bkav_get_file_by_lookup_code (workflow step)\n\n- Save an invoice\'s display copy, conversion copy or XML as a workspace file, found by the m\xE3 tra c\u1EE9u the buyer was sent.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | Bkav connected account |\n| `lookup_code` | string | yes | M\xE3 tra c\u1EE9u |\n| `kind` | "display" \\\\| "converted" \\\\| "xml" | yes | |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `file_id` | string | yes | The ID of the generated file. |\n| `url` | string | yes | The download URL of the generated file. |\n| `filename` | string | yes | The filename of the generated file, including extension. |\n| `mime_type` | string | yes | The MIME type of the generated file. |\n\n### bkav_get_invoice (workflow step)\n\n- Read one invoice as Bkav holds it \u2014 header, lines, status and m\xE3 tra c\u1EE9u.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | Bkav connected account |\n| `id` | string | yes | Your PartnerInvoiceStringID or Bkav\'s InvoiceGUID |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `invoice` | object | yes | |\n\n### bkav_get_invoice_file (workflow step)\n\n- Save an invoice\'s PDF or signed XML as a workspace file.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | Bkav connected account |\n| `partner_invoice_id` | string | yes | Your PartnerInvoiceStringID |\n| `format` | "pdf" \\\\| "xml" | yes | |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `file_id` | string | yes | The ID of the generated file. |\n| `url` | string | yes | The download URL of the generated file. |\n| `filename` | string | yes | The filename of the generated file, including extension. |\n| `mime_type` | string | yes | The MIME type of the generated file. |\n\n### bkav_get_invoice_history (workflow step)\n\n- Read everything that happened to an invoice on Bkav, oldest first.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | Bkav connected account |\n| `invoice_guid` | string | yes | |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `entries` | object[] | yes | |\n\n### bkav_get_invoice_link (workflow step)\n\n- Get a download link for an invoice\'s display copy, conversion copy, or its 04/SS error notice.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | Bkav connected account |\n| `partner_invoice_id` | string | yes | Your PartnerInvoiceStringID |\n| `kind` | "display" \\\\| "converted" \\\\| "notice_04ss" | yes | |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `url` | string | yes | |\n\n### bkav_get_invoice_status (workflow step)\n\n- Read an invoice\'s status on Bkav.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | Bkav connected account |\n| `invoice_guid` | string | yes | |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `invoice_status_id` | number | yes | 1 m\u1EDBi t\u1EA1o, 2 \u0111\xE3 ph\xE1t h\xE0nh, 3 \u0111\xE3 hu\u1EF7, 5\u20138 ch\u1EDD/\u0111\xE3 thay th\u1EBF\u2013\u0111i\u1EC1u ch\u1EC9nh, 11 \u0111\xE3 c\u1EA5p s\u1ED1 ch\u1EDD k\xFD |\n\n### bkav_get_listing (workflow step)\n\n- Save the b\u1EA3ng k\xEA of one invoice type over a window as a workspace spreadsheet.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | Bkav connected account |\n| `invoice_type_id` | number | yes | 1 GTGT, 2 b\xE1n h\xE0ng, \u2026 |\n| `from_date` | string | yes | yyyy-mm-dd |\n| `to_date` | string | yes | yyyy-mm-dd |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `file_id` | string | yes | The ID of the generated file. |\n| `url` | string | yes | The download URL of the generated file. |\n| `filename` | string | yes | The filename of the generated file, including extension. |\n| `mime_type` | string | yes | The MIME type of the generated file. |\n\n### bkav_get_report_bc26 (workflow step)\n\n- Save the BC26/AC invoice usage report for a window as a workspace XML file.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | Bkav connected account |\n| `from_date` | string | yes | yyyy-mm-dd |\n| `to_date` | string | yes | yyyy-mm-dd |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `file_id` | string | yes | The ID of the generated file. |\n| `url` | string | yes | The download URL of the generated file. |\n| `filename` | string | yes | The filename of the generated file, including extension. |\n| `mime_type` | string | yes | The MIME type of the generated file. |\n\n### bkav_get_tax_status (workflow step)\n\n- Read the tax authority\'s status for an invoice and its m\xE3 c\u1EE7a CQT once granted.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | Bkav connected account |\n| `invoice_guid` | string | yes | |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `statuses` | object[] | yes | |\n| `statuses[].BkavStatus` | number | yes | InvoiceStatusID: 1 m\u1EDBi t\u1EA1o, 2 \u0111\xE3 ph\xE1t h\xE0nh, 3 \u0111\xE3 hu\u1EF7, \u2026 |\n| `statuses[].TaxStatus` | number | yes | 32 waiting, 33 accepted, 34\u201339 returned or failed |\n| `statuses[].TaxAuthorityCode` | string \\\\| null | yes | M\xE3 c\u1EE7a C\u01A1 quan thu\u1EBF, once granted |\n| `statuses[].ErrorContent` | string \\\\| null | yes | |\n\n### bkav_list_invoices_by_date (workflow step)\n\n- List invoices dated within a window, one page at a time.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | Bkav connected account |\n| `from_date` | string | yes | yyyy-mm-dd |\n| `to_date` | string | yes | yyyy-mm-dd |\n| `page` | number | | 1-based |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `invoices` | object[] | yes | |\n\n### bkav_list_invoices_by_number (workflow step)\n\n- List invoices of one m\u1EABu s\u1ED1 and k\xFD hi\u1EC7u by number range.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | Bkav connected account |\n| `form` | string | yes | M\u1EABu s\u1ED1 |\n| `serial` | string | yes | K\xFD hi\u1EC7u |\n| `from_number` | number | yes | |\n| `to_number` | number | yes | |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `invoices` | object[] | yes | |\n\n### bkav_lookup_company (workflow step)\n\n- Look up a company in the tax registry by M\xE3 s\u1ED1 thu\u1EBF, through the Bkav account.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | Bkav connected account |\n| `tax_code` | string | yes | |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `company` | object | yes | |\n| `company.MaSoThue` | string | yes | |\n| `company.TenChinhThuc` | string | yes | |\n| `company.DiaChiGiaoDichChinh` | string | yes | |\n| `company.DiaChiGiaoDichPhu` | string | yes | |\n| `company.TrangThaiHoatDong` | string | yes | |\n| `company.ChuDoanhNghiep` | string | | |\n| `company.SoDienThoai` | string \\\\| null | | |\n| `company.LastUpdate` | string | | |\n\n### bkav_send_lookup_email (workflow step)\n\n- Send an invoice\'s lookup email to the buyer again, or to another email or phone.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | Bkav connected account |\n| `invoice_guid` | string | yes | |\n| `email` | string | | |\n| `mobile` | string | | |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `sent` | true | yes | |\n\n### bkav_sign_invoices (workflow step)\n\n- Sign \u2014 issue \u2014 invoices with the account\'s HSM signature, making them tax-registered documents.\n- An account that signs with a USB token cannot sign this way.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | Bkav connected account |\n| `invoice_guids` | string[] | yes | |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `signed` | string[] | yes | |\n\n### bkav_submit_invoices (workflow step)\n\n- Create, replace or adjust invoices on Bkav, in Bkav\'s field names.\n- Each carries PartnerInvoiceStringID, your own id for it, which Bkav uses to refuse a duplicate.\n- Attachments are not accepted here.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | Bkav connected account |\n| `kind` | "create_draft" \\\\| "create" \\\\| "create_draft_own_serial" \\\\| "create_own_number" \\\\| "create_own_serial" \\\\| "replace_draft" \\\\| "adjust_draft" \\\\| "adjust_discount_draft" \\\\| "replace" \\\\| "adjust" \\\\| "adjust_external_draft" \\\\| "adjust_discount" \\\\| "adjust_external" \\\\| "replace_external" \\\\| "replace_external_draft" | yes | create_draft: no number, deletable. create: Bkav numbers it. *_own_*: your form/serial. replace_* / adjust_*: each invoice names its original in Invoice.OriginalInvoiceIdentify and gives Invoice.Reason. *_external*: corrects an invoice issued outside Bkav; its first line is an ItemTypeID 4 description of it. *_draft kinds stay unnumbered. |\n| `invoices` | object[] | yes | |\n| `invoices[].Invoice` | object | yes | |\n| `invoices[].Invoice.InvoiceTypeID` | number | yes | 1 GTGT, 2 b\xE1n h\xE0ng, 5 PXK ki\xEAm VCNB, 6 PXK g\u1EEDi b\xE1n \u0111\u1EA1i l\xFD |\n| `invoices[].Invoice.InvoiceDate` | string | yes | ISO date |\n| `invoices[].Invoice.BuyerCode` | string | | |\n| `invoices[].Invoice.BuyerName` | string | | |\n| `invoices[].Invoice.BuyerTaxCode` | string | | |\n| `invoices[].Invoice.BuyerUnitName` | string | | |\n| `invoices[].Invoice.BuyerAddress` | string | | |\n| `invoices[].Invoice.BuyerBankAccount` | string | | Sent empty when absent: Bkav refuses it missing |\n| `invoices[].Invoice.PayMethodID` | number | | 1 TM, 2 CK, 3 TM/CK, \u2026 |\n| `invoices[].Invoice.ReceiveTypeID` | number | | 1 email, 2 SMS, 3 both, 4 courier |\n| `invoices[].Invoice.ReceiverEmail` | string | | |\n| `invoices[].Invoice.ReceiverMobile` | string | | |\n| `invoices[].Invoice.ReceiverAddress` | string | | Sent empty when absent: Bkav refuses it missing |\n| `invoices[].Invoice.ReceiverName` | string | | Sent empty when absent: Bkav refuses it missing |\n| `invoices[].Invoice.Note` | string | | |\n| `invoices[].Invoice.BillCode` | string | | Sent empty when absent: Bkav refuses it missing |\n| `invoices[].Invoice.CurrencyID` | string | | |\n| `invoices[].Invoice.ExchangeRate` | number | | |\n| `invoices[].Invoice.InvoiceForm` | string | | M\u1EABu s\u1ED1 |\n| `invoices[].Invoice.InvoiceSerial` | string | | K\xFD hi\u1EC7u |\n| `invoices[].Invoice.InvoiceNo` | number | | S\u1ED1; 0 when Bkav assigns it |\n| `invoices[].Invoice.MaCuaCQT` | string | | Set only by a cash-register flow that already holds the authority\'s code |\n| `invoices[].Invoice.UserDefine` | string | | JSON-encoded template fields agreed with Bkav |\n| `invoices[].Invoice.UIDefine` | string | | JSON-encoded delivery-note fields (InvoiceTypeID 5 and 6) |\n| `invoices[].Invoice.isBTH` | boolean | | |\n| `invoices[].Invoice.CCCD` | string | | |\n| `invoices[].Invoice.PassportNumber` | string | | |\n| `invoices[].Invoice.FiscalCodes` | string | | |\n| `invoices[].Invoice.Reason` | string | | Why \u2014 required on a replacement or adjustment |\n| `invoices[].Invoice.OriginalInvoiceIdentify` | string | | `[m\u1EABu s\u1ED1]_[k\xFD hi\u1EC7u]_[s\u1ED1]` of the invoice a replacement or adjustment corrects |\n| `invoices[].Invoice.InvoiceGUID` | string | | Addresses the invoice for an update by guid |\n| `invoices[].ListInvoiceDetailsWS` | object[] | yes | |\n| `invoices[].ListInvoiceDetailsWS[].ItemTypeID` | number | | 0 goods, 4 description line, 15 promotional goods, \u2026 |\n| `invoices[].ListInvoiceDetailsWS[].IsDiscount` | boolean | | |\n| `invoices[].ListInvoiceDetailsWS[].ItemCode` | string | | |\n| `invoices[].ListInvoiceDetailsWS[].ItemName` | string | yes | |\n| `invoices[].ListInvoiceDetailsWS[].UnitName` | string | | |\n| `invoices[].ListInvoiceDetailsWS[].Qty` | number | | |\n| `invoices[].ListInvoiceDetailsWS[].Price` | number | | |\n| `invoices[].ListInvoiceDetailsWS[].Amount` | number | | |\n| `invoices[].ListInvoiceDetailsWS[].TaxRateID` | number | | 1 0%, 2 5%, 3 10%, 4 kh\xF4ng ch\u1ECBu thu\u1EBF, 9 8%, \u2026 |\n| `invoices[].ListInvoiceDetailsWS[].TaxRate` | number | | |\n| `invoices[].ListInvoiceDetailsWS[].TaxAmount` | number | | |\n| `invoices[].ListInvoiceDetailsWS[].OtherAmount` | number | | |\n| `invoices[].ListInvoiceDetailsWS[].DiscountRate` | number | | |\n| `invoices[].ListInvoiceDetailsWS[].DiscountAmount` | number | | |\n| `invoices[].ListInvoiceDetailsWS[].UserDefineDetails` | string | | |\n| `invoices[].ListInvoiceDetailsWS[].IsIncrease` | boolean \\\\| null | | On an adjustment: true raises the amount, false lowers it, absent adjusts information |\n| `invoices[].ListInvoiceDetailsWS[].SpecialtyItems` | string | | |\n| `invoices[].PartnerInvoiceStringID` | string | yes | |\n| `invoices[].AttachListNumber` | string | | S\u1ED1 of a b\u1EA3ng k\xEA the invoice refers to |\n| `invoices[].AttachListDate` | string | | |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `results` | object[] | yes | |\n| `results[].PartnerInvoiceID` | number | yes | |\n| `results[].PartnerInvoiceStringID` | string \\\\| null | yes | Null on a delete\'s answer |\n| `results[].InvoiceGUID` | string | yes | |\n| `results[].InvoiceForm` | string \\\\| null | yes | Null on a draft\'s link answer |\n| `results[].InvoiceSerial` | string \\\\| null | yes | Null on a draft\'s link answer |\n| `results[].InvoiceNo` | number | yes | Assigned by a numbered kind; 0 on a draft |\n| `results[].MTC` | string \\\\| null | yes | M\xE3 tra c\u1EE9u the buyer looks the invoice up with; null on a draft\'s link answer |\n| `results[].MaCuaCQT` | string \\\\| null | | |\n| `results[].Status` | number | yes | 0 succeeded; otherwise MessLog says why |\n| `results[].MessLog` | string | yes | |\n| `failed` | number | yes | Invoices whose own Status is not 0 |\n\n### bkav_update_invoices (workflow step)\n\n- Change invoices not yet issued. by names how each invoice is found: partner (its partner id), number (Invoice.InvoiceForm + InvoiceSerial + InvoiceNo) or guid (Invoice.InvoiceGUID).\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | Bkav connected account |\n| `by` | "partner" \\\\| "number" \\\\| "guid" | yes | |\n| `invoices` | object[] | yes | |\n| `invoices[].Invoice` | object | yes | |\n| `invoices[].Invoice.InvoiceTypeID` | number | yes | 1 GTGT, 2 b\xE1n h\xE0ng, 5 PXK ki\xEAm VCNB, 6 PXK g\u1EEDi b\xE1n \u0111\u1EA1i l\xFD |\n| `invoices[].Invoice.InvoiceDate` | string | yes | ISO date |\n| `invoices[].Invoice.BuyerCode` | string | | |\n| `invoices[].Invoice.BuyerName` | string | | |\n| `invoices[].Invoice.BuyerTaxCode` | string | | |\n| `invoices[].Invoice.BuyerUnitName` | string | | |\n| `invoices[].Invoice.BuyerAddress` | string | | |\n| `invoices[].Invoice.BuyerBankAccount` | string | | Sent empty when absent: Bkav refuses it missing |\n| `invoices[].Invoice.PayMethodID` | number | | 1 TM, 2 CK, 3 TM/CK, \u2026 |\n| `invoices[].Invoice.ReceiveTypeID` | number | | 1 email, 2 SMS, 3 both, 4 courier |\n| `invoices[].Invoice.ReceiverEmail` | string | | |\n| `invoices[].Invoice.ReceiverMobile` | string | | |\n| `invoices[].Invoice.ReceiverAddress` | string | | Sent empty when absent: Bkav refuses it missing |\n| `invoices[].Invoice.ReceiverName` | string | | Sent empty when absent: Bkav refuses it missing |\n| `invoices[].Invoice.Note` | string | | |\n| `invoices[].Invoice.BillCode` | string | | Sent empty when absent: Bkav refuses it missing |\n| `invoices[].Invoice.CurrencyID` | string | | |\n| `invoices[].Invoice.ExchangeRate` | number | | |\n| `invoices[].Invoice.InvoiceForm` | string | | M\u1EABu s\u1ED1 |\n| `invoices[].Invoice.InvoiceSerial` | string | | K\xFD hi\u1EC7u |\n| `invoices[].Invoice.InvoiceNo` | number | | S\u1ED1; 0 when Bkav assigns it |\n| `invoices[].Invoice.MaCuaCQT` | string | | Set only by a cash-register flow that already holds the authority\'s code |\n| `invoices[].Invoice.UserDefine` | string | | JSON-encoded template fields agreed with Bkav |\n| `invoices[].Invoice.UIDefine` | string | | JSON-encoded delivery-note fields (InvoiceTypeID 5 and 6) |\n| `invoices[].Invoice.isBTH` | boolean | | |\n| `invoices[].Invoice.CCCD` | string | | |\n| `invoices[].Invoice.PassportNumber` | string | | |\n| `invoices[].Invoice.FiscalCodes` | string | | |\n| `invoices[].Invoice.Reason` | string | | Why \u2014 required on a replacement or adjustment |\n| `invoices[].Invoice.OriginalInvoiceIdentify` | string | | `[m\u1EABu s\u1ED1]_[k\xFD hi\u1EC7u]_[s\u1ED1]` of the invoice a replacement or adjustment corrects |\n| `invoices[].Invoice.InvoiceGUID` | string | | Addresses the invoice for an update by guid |\n| `invoices[].ListInvoiceDetailsWS` | object[] | yes | |\n| `invoices[].ListInvoiceDetailsWS[].ItemTypeID` | number | | 0 goods, 4 description line, 15 promotional goods, \u2026 |\n| `invoices[].ListInvoiceDetailsWS[].IsDiscount` | boolean | | |\n| `invoices[].ListInvoiceDetailsWS[].ItemCode` | string | | |\n| `invoices[].ListInvoiceDetailsWS[].ItemName` | string | yes | |\n| `invoices[].ListInvoiceDetailsWS[].UnitName` | string | | |\n| `invoices[].ListInvoiceDetailsWS[].Qty` | number | | |\n| `invoices[].ListInvoiceDetailsWS[].Price` | number | | |\n| `invoices[].ListInvoiceDetailsWS[].Amount` | number | | |\n| `invoices[].ListInvoiceDetailsWS[].TaxRateID` | number | | 1 0%, 2 5%, 3 10%, 4 kh\xF4ng ch\u1ECBu thu\u1EBF, 9 8%, \u2026 |\n| `invoices[].ListInvoiceDetailsWS[].TaxRate` | number | | |\n| `invoices[].ListInvoiceDetailsWS[].TaxAmount` | number | | |\n| `invoices[].ListInvoiceDetailsWS[].OtherAmount` | number | | |\n| `invoices[].ListInvoiceDetailsWS[].DiscountRate` | number | | |\n| `invoices[].ListInvoiceDetailsWS[].DiscountAmount` | number | | |\n| `invoices[].ListInvoiceDetailsWS[].UserDefineDetails` | string | | |\n| `invoices[].ListInvoiceDetailsWS[].IsIncrease` | boolean \\\\| null | | On an adjustment: true raises the amount, false lowers it, absent adjusts information |\n| `invoices[].ListInvoiceDetailsWS[].SpecialtyItems` | string | | |\n| `invoices[].PartnerInvoiceStringID` | string | yes | |\n| `invoices[].AttachListNumber` | string | | S\u1ED1 of a b\u1EA3ng k\xEA the invoice refers to |\n| `invoices[].AttachListDate` | string | | |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `results` | object[] | yes | |\n| `results[].PartnerInvoiceID` | number | yes | |\n| `results[].PartnerInvoiceStringID` | string \\\\| null | yes | Null on a delete\'s answer |\n| `results[].InvoiceGUID` | string | yes | |\n| `results[].InvoiceForm` | string \\\\| null | yes | Null on a draft\'s link answer |\n| `results[].InvoiceSerial` | string \\\\| null | yes | Null on a draft\'s link answer |\n| `results[].InvoiceNo` | number | yes | Assigned by a numbered kind; 0 on a draft |\n| `results[].MTC` | string \\\\| null | yes | M\xE3 tra c\u1EE9u the buyer looks the invoice up with; null on a draft\'s link answer |\n| `results[].MaCuaCQT` | string \\\\| null | | |\n| `results[].Status` | number | yes | 0 succeeded; otherwise MessLog says why |\n| `results[].MessLog` | string | yes | |\n| `failed` | number | yes | Invoices whose own Status is not 0 |\n\n## delete\n\n### delete_file (workflow step)\n\n- Soft-delete a file by its file_id \u2014 archives it (never a hard delete).\n- Deleting an original file deletes every version of it; a file\'s current version cannot be deleted on its own.\n- Refuses while the file or a version it takes along is still referenced by a record, comment, knowledge doc, document template, voice session, or pending change request, and names the referents so you can detach them first.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `file_id` | string | yes | |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `id` | string | yes | |\n| `filename` | string | yes | |\n| `archived` | boolean | yes | |\n\n## drive\n\n### drive_export_file (workflow step)\n\n- Upload a Lotics file to the member\'s Google Drive.\n- The file is uploaded as-is \u2014 a .docx stays a .docx, a .xlsx stays a .xlsx.\n- It is deliberately NOT converted into a Google Doc or Sheet: conversion re-flows the layout of a generated document, and a native Google file is live, so its figures would drift away from the record they came from.\n- Use this to archive a finished document, the way you would attach it to an email.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | The ID of the connected Google Drive account to use |\n| `file_id` | string | yes | Lotics file ID to upload |\n| `folder_id` | string | | Drive folder ID to place the file in; omit for the member\'s Drive root |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `drive_file_id` | string | yes | Drive file ID of the uploaded copy |\n| `web_view_link` | string \\\\| null | yes | URL to open the uploaded file in Drive |\n\n### drive_import_file (workflow step)\n\n- Import a Google Drive file into the workspace as a Lotics file, and return its file id.\n- Google Docs arrive as .docx, Sheets as .xlsx, Slides as .pptx; everything else transfers unchanged. **This is also how you READ a Drive file.** There is no separate Drive read tool: import the file, then use `view_files` on the returned id. (chat, MCP, CLI)\n- That path handles scanned documents \u2014 a photographed B/L or a stamped invoice inside a .docx reaches the model as a picture.\n- Exporting Drive content as plain text would return an empty document for exactly those files.\n- Folders, Forms, shortcuts and other Drive items with no file form cannot be imported.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | The ID of the connected Google Drive account to use |\n| `file_id` | string | yes | Drive file ID, from drive_query_files (workflow step, chat) |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `id` | string | yes | Lotics file ID \u2014 pass this to view_files to read the contents (chat, MCP, CLI) |\n| `filename` | string | yes | |\n| `mime_type` | string | yes | |\n| `url` | string | yes | |\n\n### drive_query_files (workflow step)\n\n- Search the member\'s Google Drive using Drive query syntax. ## Query syntax Terms are `field operator value`; combine with `and` / `or` / `not`.\n- String values are single-quoted. - Name: `name = \'Rate card\'`, `name contains \'invoice\'` - Full text (body + title): `fullText contains \'CMA CGM\'` - Type: `mimeType = \'application/vnd.google-apps.spreadsheet\'`, `mimeType contains \'pdf\'` - Folder: `\'<folder_id>\' in parents` - Time (RFC 3339): `modifiedTime > \'2026-01-01T00:00:00\'` - Exclude deleted: `trashed = false` (always worth adding) - Starred / shared: `starred = true`, `sharedWithMe = true` Google-native types: `application/vnd.google-apps.document` (Docs), `.spreadsheet` (Sheets), `.presentation` (Slides), `.folder`.\n- Examples: - `name contains \'packing list\' and trashed = false` - `\'1a2b3c\' in parents and modifiedTime > \'2026-08-01T00:00:00\'` - `fullText contains \'demurrage\' and mimeType = \'application/vnd.google-apps.document\'` Results carry enough metadata (name, type, modified time, size, owner) to pick a file WITHOUT importing it.\n- Import only the one you actually need \u2014 `drive_import_file` persists a copy in the workspace. (workflow step, chat)\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | The ID of the connected Google Drive account to use |\n| `query` | string | yes | Drive query syntax expression |\n| `max_result` | number | yes | Maximum number of files to retrieve (1-50) |\n| `order_by` | string | | Sort order, e.g. \'modifiedTime desc\', \'name\' |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `files` | object[] | yes | List of matching Drive files |\n| `files[].id` | string | yes | Drive file ID \u2014 pass this to drive_import_file (workflow step, chat) |\n| `files[].name` | string | yes | File name as it appears in Drive |\n| `files[].mime_type` | string | yes | Drive MIME type; \'application/vnd.google-apps.*\' means Google-native |\n| `files[].modified_time` | string \\\\| null | yes | RFC 3339 timestamp of the last modification |\n| `files[].size_bytes` | number \\\\| null | yes | Size in bytes; null for Google-native files, which have no stored size until exported |\n| `files[].owner` | string \\\\| null | yes | Email address of the file\'s owner |\n| `files[].web_view_link` | string \\\\| null | yes | URL to open the file in Drive |\n\n## easyinvoice\n\n### easyinvoice_attach_ikey (workflow step)\n\n- Give an invoice numbered on EasyInvoice\'s own site an ikey, so the other EasyInvoice tools can name it.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | EasyInvoice connected account |\n| `pattern` | string | | The invoice symbol, e.g. 1C26TAA (Th\xF4ng t\u01B0 78 puts the whole symbol here and leaves serial empty); needed when the account issues under more than one |\n| `serial` | string | | K\xFD hi\u1EC7u of a Th\xF4ng t\u01B0 32 range |\n| `no` | string | yes | The invoice\'s number |\n| `ikey` | string | yes | A new key of your own, at most 50 characters |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `ikey` | string | yes | |\n| `no` | string | yes | |\n\n### easyinvoice_cancel_invoice (workflow step)\n\n- Cancel an issued invoice.\n- Under Ngh\u1ECB \u0111\u1ECBnh 70 EasyInvoice may refuse, or issue a 0-\u0111\u1ED3ng replacement in its place and return it in Invoices.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | EasyInvoice connected account |\n| `pattern` | string | | The invoice symbol, e.g. 1C26TAA (Th\xF4ng t\u01B0 78 puts the whole symbol here and leaves serial empty); needed when the account issues under more than one |\n| `serial` | string | | K\xFD hi\u1EC7u of a Th\xF4ng t\u01B0 32 range |\n| `ikey` | string | yes | |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `Pattern` | string \\\\| null | yes | |\n| `Serial` | string \\\\| null | yes | |\n| `Invoices` | object[] | yes | |\n| `Invoices[].Ikey` | string \\\\| null | yes | |\n| `Invoices[].Pattern` | string \\\\| null | yes | |\n| `Invoices[].Serial` | string \\\\| null | yes | |\n| `Invoices[].No` | string \\\\| null | yes | The invoice number; empty until issued |\n| `Invoices[].InvoiceStatus` | number \\\\| null | yes | -1 reserved, 0 unsigned, 1 signed, 2 tax-declared, 3 replaced, 4 adjusted, 5 cancelled, 6 approved |\n| `Invoices[].TCTCheckStatus` | number \\\\| null | yes | Tax authority: null not sent, 0 not processed, -1 checking, 1 valid, -2 invalid |\n| `Invoices[].TCTErrorMessage` | string \\\\| null | yes | |\n| `Invoices[].TaxAuthorityCode` | string \\\\| null | yes | M\xE3 c\u1EE7a c\u01A1 quan thu\u1EBF, a few minutes after issuing |\n| `Invoices[].LookupCode` | string \\\\| null | yes | M\xE3 tra c\u1EE9u, which the buyer looks the invoice up by |\n| `Invoices[].LinkView` | string \\\\| null | yes | |\n| `Invoices[].ArisingDate` | string \\\\| null | yes | dd/MM/yyyy |\n| `Invoices[].IssueDate` | string \\\\| null | yes | dd/MM/yyyy |\n| `Invoices[].Buyer` | string \\\\| null | yes | |\n| `Invoices[].CustomerName` | string \\\\| null | yes | |\n| `Invoices[].CustomerCode` | string \\\\| null | yes | |\n| `Invoices[].CustomerTaxCode` | string \\\\| null | yes | |\n| `Invoices[].Total` | number \\\\| null | yes | |\n| `Invoices[].TaxAmount` | number \\\\| null | yes | |\n| `Invoices[].Amount` | number \\\\| null | yes | |\n\n### easyinvoice_convert_invoice (workflow step)\n\n- Convert an issued invoice to paper (b\u1EA3n chuy\u1EC3n \u0111\u1ED5i), to prove where goods came from or to archive, and save the PDF as a workspace file.\n- The invoice is named by ikey or by its lookup code.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | EasyInvoice connected account |\n| `purpose` | "proof_of_origin" \\\\| "archive" | yes | |\n| `ikey` | string | | |\n| `lookup_code` | string | | M\xE3 tra c\u1EE9u |\n| `pattern` | string | | The invoice symbol, e.g. 1C26TAA |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `file_id` | string | yes | The ID of the generated file. |\n| `url` | string | yes | The download URL of the generated file. |\n| `filename` | string | yes | The filename of the generated file, including extension. |\n| `mime_type` | string | yes | The MIME type of the generated file. |\n\n### easyinvoice_correct_invoice (workflow step)\n\n- Adjust or replace one issued invoice with a new invoice, in EasyInvoice\'s field names.\n- The new invoice\'s totals and amount in words are summed from its lines.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | EasyInvoice connected account |\n| `kind` | "adjust" \\\\| "replace" \\\\| "adjust_draft" \\\\| "replace_draft" | yes | adjust, replace: created and signed at once. adjust_draft, replace_draft: created unsigned, issued later by easyinvoice_issue_invoices. (workflow step, chat) |\n| `pattern` | string | | The invoice symbol, e.g. 1C26TAA (Th\xF4ng t\u01B0 78 puts the whole symbol here and leaves serial empty); needed when the account issues under more than one |\n| `serial` | string | | K\xFD hi\u1EC7u of a Th\xF4ng t\u01B0 32 range |\n| `original_ikey` | string | | Ikey of the invoice corrected |\n| `related_invoice` | object | | An original issued outside EasyInvoice, in place of original_ikey (adjust and replace only) |\n| `related_invoice.Pattern` | string | yes | |\n| `related_invoice.Serial` | string | yes | |\n| `related_invoice.No` | string | yes | |\n| `related_invoice.ArisingDate` | string | yes | The original\'s date, YYYY-MM-DD |\n| `related_invoice.RelatedType` | number | yes | 1 a Th\xF4ng t\u01B0 78 e-invoice; 3 a Th\xF4ng t\u01B0 32 or paper invoice |\n| `invoice` | object | yes | The new invoice; its Ikey is a new key of your own |\n| `invoice.Ikey` | string | yes | Your own key for this invoice, at most 50 characters; every later call names the invoice by it |\n| `invoice.ArisingDate` | string | yes | Invoice date, YYYY-MM-DD |\n| `invoice.PaymentMethod` | string | yes | Ti\u1EC1n m\u1EB7t, Chuy\u1EC3n kho\u1EA3n, Ti\u1EC1n m\u1EB7t/Chuy\u1EC3n kho\u1EA3n, \u0110\u1ED1i tr\u1EEB c\xF4ng n\u1EE3, Kh\xF4ng thu ti\u1EC1n, or other words printed as given |\n| `invoice.CurrencyUnit` | string | yes | VND, USD, EUR, \u2026 |\n| `invoice.ExchangeRate` | number | | Required unless VND |\n| `invoice.VATRate` | number | yes | 0, 5, 8, 10; -1 not taxable; -2 not declared; -3 another rate, stated in VATRateOther; -5 financial leasing; -6 outside the VAT law; -7 not in the taxable price |\n| `invoice.VATRateOther` | number | | |\n| `invoice.Products` | object[] | yes | |\n| `invoice.Products[].No` | number | | Printed line number; 0 prints none |\n| `invoice.Products[].Feature` | number | yes | 1 goods/service, 2 promotion, 3 commercial discount (positive, subtracted from the invoice), 4 note line, 5 special goods |\n| `invoice.Products[].Code` | string | | |\n| `invoice.Products[].ProdName` | string | yes | |\n| `invoice.Products[].BusinessProdGroupCode` | string | | Business group, e.g. 01_2 |\n| `invoice.Products[].ProdUnit` | string | | |\n| `invoice.Products[].ProdQuantity` | number | | |\n| `invoice.Products[].ProdPrice` | number | | |\n| `invoice.Products[].Discount` | number | | Line discount rate, % |\n| `invoice.Products[].DiscountAmount` | number | | |\n| `invoice.Products[].Total` | number | yes | Before VAT, after the line\'s own discount; 0 on a note line |\n| `invoice.Products[].VATRate` | number | | The invoice\'s VATRate when absent |\n| `invoice.Products[].VATRateOther` | number | | The rate when VATRate is -3 |\n| `invoice.Products[].VATAmount` | number | | Absent only on a note line |\n| `invoice.Products[].Extra` | string | | A JSON object: {"Pos":""} on a note line, the special-goods attributes on Feature 5 |\n| `invoice.CusCode` | string | | EasyInvoice files the buyer under this code, creating or updating it |\n| `invoice.Buyer` | string | | The buyer\'s personal name; this or CusName is required |\n| `invoice.CusName` | string | | The buyer company\'s name; required with CusTaxCode |\n| `invoice.CusTaxCode` | string | | |\n| `invoice.CusAddress` | string | | Required with CusTaxCode |\n| `invoice.CusEmails` | string | | Comma-separated; where the issuance notice goes |\n| `invoice.Email` | string | | |\n| `invoice.EmailCC` | string | | |\n| `invoice.CusBankName` | string | | |\n| `invoice.CusBankNo` | string | | |\n| `invoice.CusPhone` | string | | |\n| `invoice.CusIdentification` | string | | Buyer\'s citizen ID, 9 or 12 characters |\n| `invoice.PassportNo` | string | | |\n| `invoice.BudgetaryRelationshipCode` | string | | |\n| `invoice.ProvinceCode` | string | | |\n| `invoice.ProvinceName` | string | | |\n| `invoice.CommuneCode` | string | | |\n| `invoice.CommuneName` | string | | |\n| `invoice.LocationCode` | string | | Required for a household or individual business, with LocationName and LocationAddress |\n| `invoice.LocationName` | string | | |\n| `invoice.LocationAddress` | string | | |\n| `invoice.StoreCode` | string | | |\n| `invoice.StoreName` | string | | |\n| `invoice.Note` | string | | |\n| `invoice.ListAttachNum` | string | | Number of the b\u1EA3ng k\xEA the invoice carries |\n| `invoice.ListAttachDate` | string | | Its date, YYYY-MM-DD |\n| `invoice.IdentityCardNumber` | string | | National-reserve sale: the buyer\'s ID when they have no tax code |\n| `invoice.TaxAuthorityCode` | string | | An invoice made from a cash register: the code it already holds |\n| `invoice.ComRelateCode` | string | | Public-asset sale: the seller\'s budget unit code |\n| `invoice.CusRelateCode` | string | | Public-asset sale: the buyer\'s budget unit code |\n| `invoice.DecisionCode` | string | | |\n| `invoice.DecisionDate` | string | | YYYY-MM-DD |\n| `invoice.DecisionAgent` | string | | |\n| `invoice.SellMethod` | string | | |\n| `invoice.TransportAddress` | string | | |\n| `invoice.TransportDateFrom` | string | | YYYY-MM-DD |\n| `invoice.TransportDateTo` | string | | YYYY-MM-DD |\n| `invoice.Extra` | string | | A JSON object of fields agreed with EasyInvoice |\n| `invoice.AdjustReplaceReasonCode` | number | yes | 1\u201314 (Th\xF4ng t\u01B0 91 \u0110i\u1EC1u 10); 13 corrects an invoice issued wrong |\n| `invoice.Type` | number | | Required on an adjustment, absent on a replacement: 2 increase, 3 decrease, 4 information only |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `Pattern` | string \\\\| null | yes | |\n| `Serial` | string \\\\| null | yes | |\n| `Invoices` | object[] | yes | |\n| `Invoices[].Ikey` | string \\\\| null | yes | |\n| `Invoices[].Pattern` | string \\\\| null | yes | |\n| `Invoices[].Serial` | string \\\\| null | yes | |\n| `Invoices[].No` | string \\\\| null | yes | The invoice number; empty until issued |\n| `Invoices[].InvoiceStatus` | number \\\\| null | yes | -1 reserved, 0 unsigned, 1 signed, 2 tax-declared, 3 replaced, 4 adjusted, 5 cancelled, 6 approved |\n| `Invoices[].TCTCheckStatus` | number \\\\| null | yes | Tax authority: null not sent, 0 not processed, -1 checking, 1 valid, -2 invalid |\n| `Invoices[].TCTErrorMessage` | string \\\\| null | yes | |\n| `Invoices[].TaxAuthorityCode` | string \\\\| null | yes | M\xE3 c\u1EE7a c\u01A1 quan thu\u1EBF, a few minutes after issuing |\n| `Invoices[].LookupCode` | string \\\\| null | yes | M\xE3 tra c\u1EE9u, which the buyer looks the invoice up by |\n| `Invoices[].LinkView` | string \\\\| null | yes | |\n| `Invoices[].ArisingDate` | string \\\\| null | yes | dd/MM/yyyy |\n| `Invoices[].IssueDate` | string \\\\| null | yes | dd/MM/yyyy |\n| `Invoices[].Buyer` | string \\\\| null | yes | |\n| `Invoices[].CustomerName` | string \\\\| null | yes | |\n| `Invoices[].CustomerCode` | string \\\\| null | yes | |\n| `Invoices[].CustomerTaxCode` | string \\\\| null | yes | |\n| `Invoices[].Total` | number \\\\| null | yes | |\n| `Invoices[].TaxAmount` | number \\\\| null | yes | |\n| `Invoices[].Amount` | number \\\\| null | yes | |\n\n### easyinvoice_create_invoices (workflow step)\n\n- Create invoices on EasyInvoice, in its own field names.\n- An Ikey that already holds a draft updates that draft.\n- Each invoice\'s totals and amount in words are summed from its lines.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | EasyInvoice connected account |\n| `kind` | "draft" \\\\| "reserved" \\\\| "issue" | yes | draft: unsigned and unnumbered, deletable, issued later by easyinvoice_issue_invoices. reserved: numbered by its InvNo from a reserved range, awaiting signature. issue: created and signed at once. (workflow step, chat) |\n| `pattern` | string | | The invoice symbol, e.g. 1C26TAA (Th\xF4ng t\u01B0 78 puts the whole symbol here and leaves serial empty); needed when the account issues under more than one |\n| `serial` | string | | K\xFD hi\u1EC7u of a Th\xF4ng t\u01B0 32 range |\n| `invoices` | object[] | yes | |\n| `invoices[].Ikey` | string | yes | Your own key for this invoice, at most 50 characters; every later call names the invoice by it |\n| `invoices[].ArisingDate` | string | yes | Invoice date, YYYY-MM-DD |\n| `invoices[].PaymentMethod` | string | yes | Ti\u1EC1n m\u1EB7t, Chuy\u1EC3n kho\u1EA3n, Ti\u1EC1n m\u1EB7t/Chuy\u1EC3n kho\u1EA3n, \u0110\u1ED1i tr\u1EEB c\xF4ng n\u1EE3, Kh\xF4ng thu ti\u1EC1n, or other words printed as given |\n| `invoices[].CurrencyUnit` | string | yes | VND, USD, EUR, \u2026 |\n| `invoices[].ExchangeRate` | number | | Required unless VND |\n| `invoices[].VATRate` | number | yes | 0, 5, 8, 10; -1 not taxable; -2 not declared; -3 another rate, stated in VATRateOther; -5 financial leasing; -6 outside the VAT law; -7 not in the taxable price |\n| `invoices[].VATRateOther` | number | | |\n| `invoices[].Products` | object[] | yes | |\n| `invoices[].Products[].No` | number | | Printed line number; 0 prints none |\n| `invoices[].Products[].Feature` | number | yes | 1 goods/service, 2 promotion, 3 commercial discount (positive, subtracted from the invoice), 4 note line, 5 special goods |\n| `invoices[].Products[].Code` | string | | |\n| `invoices[].Products[].ProdName` | string | yes | |\n| `invoices[].Products[].BusinessProdGroupCode` | string | | Business group, e.g. 01_2 |\n| `invoices[].Products[].ProdUnit` | string | | |\n| `invoices[].Products[].ProdQuantity` | number | | |\n| `invoices[].Products[].ProdPrice` | number | | |\n| `invoices[].Products[].Discount` | number | | Line discount rate, % |\n| `invoices[].Products[].DiscountAmount` | number | | |\n| `invoices[].Products[].Total` | number | yes | Before VAT, after the line\'s own discount; 0 on a note line |\n| `invoices[].Products[].VATRate` | number | | The invoice\'s VATRate when absent |\n| `invoices[].Products[].VATRateOther` | number | | The rate when VATRate is -3 |\n| `invoices[].Products[].VATAmount` | number | | Absent only on a note line |\n| `invoices[].Products[].Extra` | string | | A JSON object: {"Pos":""} on a note line, the special-goods attributes on Feature 5 |\n| `invoices[].CusCode` | string | | EasyInvoice files the buyer under this code, creating or updating it |\n| `invoices[].Buyer` | string | | The buyer\'s personal name; this or CusName is required |\n| `invoices[].CusName` | string | | The buyer company\'s name; required with CusTaxCode |\n| `invoices[].CusTaxCode` | string | | |\n| `invoices[].CusAddress` | string | | Required with CusTaxCode |\n| `invoices[].CusEmails` | string | | Comma-separated; where the issuance notice goes |\n| `invoices[].Email` | string | | |\n| `invoices[].EmailCC` | string | | |\n| `invoices[].CusBankName` | string | | |\n| `invoices[].CusBankNo` | string | | |\n| `invoices[].CusPhone` | string | | |\n| `invoices[].CusIdentification` | string | | Buyer\'s citizen ID, 9 or 12 characters |\n| `invoices[].PassportNo` | string | | |\n| `invoices[].BudgetaryRelationshipCode` | string | | |\n| `invoices[].ProvinceCode` | string | | |\n| `invoices[].ProvinceName` | string | | |\n| `invoices[].CommuneCode` | string | | |\n| `invoices[].CommuneName` | string | | |\n| `invoices[].LocationCode` | string | | Required for a household or individual business, with LocationName and LocationAddress |\n| `invoices[].LocationName` | string | | |\n| `invoices[].LocationAddress` | string | | |\n| `invoices[].StoreCode` | string | | |\n| `invoices[].StoreName` | string | | |\n| `invoices[].Note` | string | | |\n| `invoices[].ListAttachNum` | string | | Number of the b\u1EA3ng k\xEA the invoice carries |\n| `invoices[].ListAttachDate` | string | | Its date, YYYY-MM-DD |\n| `invoices[].IdentityCardNumber` | string | | National-reserve sale: the buyer\'s ID when they have no tax code |\n| `invoices[].TaxAuthorityCode` | string | | An invoice made from a cash register: the code it already holds |\n| `invoices[].ComRelateCode` | string | | Public-asset sale: the seller\'s budget unit code |\n| `invoices[].CusRelateCode` | string | | Public-asset sale: the buyer\'s budget unit code |\n| `invoices[].DecisionCode` | string | | |\n| `invoices[].DecisionDate` | string | | YYYY-MM-DD |\n| `invoices[].DecisionAgent` | string | | |\n| `invoices[].SellMethod` | string | | |\n| `invoices[].TransportAddress` | string | | |\n| `invoices[].TransportDateFrom` | string | | YYYY-MM-DD |\n| `invoices[].TransportDateTo` | string | | YYYY-MM-DD |\n| `invoices[].Extra` | string | | A JSON object of fields agreed with EasyInvoice |\n| `invoices[].InvNo` | number | | The number, from a reserved range; only on reserved invoices |\n| `invoices[].StoreAddress` | string | | |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `Pattern` | string \\\\| null | yes | |\n| `Serial` | string \\\\| null | yes | |\n| `Invoices` | object[] | yes | |\n| `Invoices[].Ikey` | string \\\\| null | yes | |\n| `Invoices[].Pattern` | string \\\\| null | yes | |\n| `Invoices[].Serial` | string \\\\| null | yes | |\n| `Invoices[].No` | string \\\\| null | yes | The invoice number; empty until issued |\n| `Invoices[].InvoiceStatus` | number \\\\| null | yes | -1 reserved, 0 unsigned, 1 signed, 2 tax-declared, 3 replaced, 4 adjusted, 5 cancelled, 6 approved |\n| `Invoices[].TCTCheckStatus` | number \\\\| null | yes | Tax authority: null not sent, 0 not processed, -1 checking, 1 valid, -2 invalid |\n| `Invoices[].TCTErrorMessage` | string \\\\| null | yes | |\n| `Invoices[].TaxAuthorityCode` | string \\\\| null | yes | M\xE3 c\u1EE7a c\u01A1 quan thu\u1EBF, a few minutes after issuing |\n| `Invoices[].LookupCode` | string \\\\| null | yes | M\xE3 tra c\u1EE9u, which the buyer looks the invoice up by |\n| `Invoices[].LinkView` | string \\\\| null | yes | |\n| `Invoices[].ArisingDate` | string \\\\| null | yes | dd/MM/yyyy |\n| `Invoices[].IssueDate` | string \\\\| null | yes | dd/MM/yyyy |\n| `Invoices[].Buyer` | string \\\\| null | yes | |\n| `Invoices[].CustomerName` | string \\\\| null | yes | |\n| `Invoices[].CustomerCode` | string \\\\| null | yes | |\n| `Invoices[].CustomerTaxCode` | string \\\\| null | yes | |\n| `Invoices[].Total` | number \\\\| null | yes | |\n| `Invoices[].TaxAmount` | number \\\\| null | yes | |\n| `Invoices[].Amount` | number \\\\| null | yes | |\n\n### easyinvoice_delete_draft (workflow step)\n\n- Delete an invoice that was never signed.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | EasyInvoice connected account |\n| `pattern` | string | | The invoice symbol, e.g. 1C26TAA (Th\xF4ng t\u01B0 78 puts the whole symbol here and leaves serial empty); needed when the account issues under more than one |\n| `serial` | string | | K\xFD hi\u1EC7u of a Th\xF4ng t\u01B0 32 range |\n| `ikey` | string | yes | |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `deleted_ikey` | string | yes | |\n\n### easyinvoice_get_invoice_file (workflow step)\n\n- Save an invoice\'s PDF or XML as a workspace file, the invoice named by ikey or by its lookup code.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | EasyInvoice connected account |\n| `format` | "xml" \\\\| "pdf" | yes | |\n| `ikey` | string | | |\n| `lookup_code` | string | | M\xE3 tra c\u1EE9u |\n| `pattern` | string | | The invoice symbol, e.g. 1C26TAA |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `file_id` | string | yes | The ID of the generated file. |\n| `url` | string | yes | The download URL of the generated file. |\n| `filename` | string | yes | The filename of the generated file, including extension. |\n| `mime_type` | string | yes | The MIME type of the generated file. |\n\n### easyinvoice_get_invoices (workflow step)\n\n- Read invoices by their ikeys: status, number, lookup code and the tax authority\'s verdict and code.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | EasyInvoice connected account |\n| `ikeys` | string[] | yes | |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `invoices` | object[] | yes | |\n| `invoices[].Ikey` | string \\\\| null | yes | |\n| `invoices[].Pattern` | string \\\\| null | yes | |\n| `invoices[].Serial` | string \\\\| null | yes | |\n| `invoices[].No` | string \\\\| null | yes | The invoice number; empty until issued |\n| `invoices[].InvoiceStatus` | number \\\\| null | yes | -1 reserved, 0 unsigned, 1 signed, 2 tax-declared, 3 replaced, 4 adjusted, 5 cancelled, 6 approved |\n| `invoices[].TCTCheckStatus` | number \\\\| null | yes | Tax authority: null not sent, 0 not processed, -1 checking, 1 valid, -2 invalid |\n| `invoices[].TCTErrorMessage` | string \\\\| null | yes | |\n| `invoices[].TaxAuthorityCode` | string \\\\| null | yes | M\xE3 c\u1EE7a c\u01A1 quan thu\u1EBF, a few minutes after issuing |\n| `invoices[].LookupCode` | string \\\\| null | yes | M\xE3 tra c\u1EE9u, which the buyer looks the invoice up by |\n| `invoices[].LinkView` | string \\\\| null | yes | |\n| `invoices[].ArisingDate` | string \\\\| null | yes | dd/MM/yyyy |\n| `invoices[].IssueDate` | string \\\\| null | yes | dd/MM/yyyy |\n| `invoices[].Buyer` | string \\\\| null | yes | |\n| `invoices[].CustomerName` | string \\\\| null | yes | |\n| `invoices[].CustomerCode` | string \\\\| null | yes | |\n| `invoices[].CustomerTaxCode` | string \\\\| null | yes | |\n| `invoices[].Total` | number \\\\| null | yes | |\n| `invoices[].TaxAmount` | number \\\\| null | yes | |\n| `invoices[].Amount` | number \\\\| null | yes | |\n\n### easyinvoice_get_report (workflow step)\n\n- Save a period\'s invoice-usage report (BC26/AC) or listing of sales documents (b\u1EA3ng k\xEA) as a workspace file.\n- The htkk kinds are for import into HTKK.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | EasyInvoice connected account |\n| `kind` | "usage_excel" \\\\| "usage_htkk_excel" \\\\| "usage_htkk_xml" \\\\| "sales_listing_html" \\\\| "sales_listing_excel" | yes | |\n| `from_date` | string | yes | YYYY-MM-DD |\n| `to_date` | string | yes | YYYY-MM-DD |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `file_id` | string | yes | The ID of the generated file. |\n| `url` | string | yes | The download URL of the generated file. |\n| `filename` | string | yes | The filename of the generated file, including extension. |\n| `mime_type` | string | yes | The MIME type of the generated file. |\n\n### easyinvoice_issue_invoices (workflow step)\n\n- Sign and issue drafts and reserved invoices, all under one symbol.\n- An issued invoice goes to the tax authority and is corrected only by adjustment or replacement.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | EasyInvoice connected account |\n| `pattern` | string | yes | The invoice symbol they share, e.g. 1C26TAA |\n| `serial` | string | | K\xFD hi\u1EC7u of a Th\xF4ng t\u01B0 32 range |\n| `ikeys` | string[] | yes | |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `Pattern` | string \\\\| null | yes | |\n| `Serial` | string \\\\| null | yes | |\n| `Invoices` | object[] | yes | |\n| `Invoices[].Ikey` | string \\\\| null | yes | |\n| `Invoices[].Pattern` | string \\\\| null | yes | |\n| `Invoices[].Serial` | string \\\\| null | yes | |\n| `Invoices[].No` | string \\\\| null | yes | The invoice number; empty until issued |\n| `Invoices[].InvoiceStatus` | number \\\\| null | yes | -1 reserved, 0 unsigned, 1 signed, 2 tax-declared, 3 replaced, 4 adjusted, 5 cancelled, 6 approved |\n| `Invoices[].TCTCheckStatus` | number \\\\| null | yes | Tax authority: null not sent, 0 not processed, -1 checking, 1 valid, -2 invalid |\n| `Invoices[].TCTErrorMessage` | string \\\\| null | yes | |\n| `Invoices[].TaxAuthorityCode` | string \\\\| null | yes | M\xE3 c\u1EE7a c\u01A1 quan thu\u1EBF, a few minutes after issuing |\n| `Invoices[].LookupCode` | string \\\\| null | yes | M\xE3 tra c\u1EE9u, which the buyer looks the invoice up by |\n| `Invoices[].LinkView` | string \\\\| null | yes | |\n| `Invoices[].ArisingDate` | string \\\\| null | yes | dd/MM/yyyy |\n| `Invoices[].IssueDate` | string \\\\| null | yes | dd/MM/yyyy |\n| `Invoices[].Buyer` | string \\\\| null | yes | |\n| `Invoices[].CustomerName` | string \\\\| null | yes | |\n| `Invoices[].CustomerCode` | string \\\\| null | yes | |\n| `Invoices[].CustomerTaxCode` | string \\\\| null | yes | |\n| `Invoices[].Total` | number \\\\| null | yes | |\n| `Invoices[].TaxAmount` | number \\\\| null | yes | |\n| `Invoices[].Amount` | number \\\\| null | yes | |\n\n### easyinvoice_list_invoices (workflow step)\n\n- List invoices dated within a window, a page at a time.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | EasyInvoice connected account |\n| `from_date` | string | yes | YYYY-MM-DD |\n| `to_date` | string | yes | YYYY-MM-DD |\n| `page` | number | | 1-based |\n| `page_size` | number | | At most 100 |\n| `pattern` | string | | Only invoices under this symbol |\n| `include_web_invoices` | boolean | | Also invoices made on EasyInvoice\'s own site, not only through this connection\'s API |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `page` | number \\\\| null | yes | |\n| `page_size` | number \\\\| null | yes | |\n| `total_records` | number \\\\| null | yes | |\n| `total_pages` | number \\\\| null | yes | |\n| `invoices` | object[] | yes | |\n| `invoices[].Ikey` | string \\\\| null | yes | |\n| `invoices[].Pattern` | string \\\\| null | yes | |\n| `invoices[].Serial` | string \\\\| null | yes | |\n| `invoices[].No` | string \\\\| null | yes | The invoice number; empty until issued |\n| `invoices[].InvoiceStatus` | number \\\\| null | yes | -1 reserved, 0 unsigned, 1 signed, 2 tax-declared, 3 replaced, 4 adjusted, 5 cancelled, 6 approved |\n| `invoices[].TCTCheckStatus` | number \\\\| null | yes | Tax authority: null not sent, 0 not processed, -1 checking, 1 valid, -2 invalid |\n| `invoices[].TCTErrorMessage` | string \\\\| null | yes | |\n| `invoices[].TaxAuthorityCode` | string \\\\| null | yes | M\xE3 c\u1EE7a c\u01A1 quan thu\u1EBF, a few minutes after issuing |\n| `invoices[].LookupCode` | string \\\\| null | yes | M\xE3 tra c\u1EE9u, which the buyer looks the invoice up by |\n| `invoices[].LinkView` | string \\\\| null | yes | |\n| `invoices[].ArisingDate` | string \\\\| null | yes | dd/MM/yyyy |\n| `invoices[].IssueDate` | string \\\\| null | yes | dd/MM/yyyy |\n| `invoices[].Buyer` | string \\\\| null | yes | |\n| `invoices[].CustomerName` | string \\\\| null | yes | |\n| `invoices[].CustomerCode` | string \\\\| null | yes | |\n| `invoices[].CustomerTaxCode` | string \\\\| null | yes | |\n| `invoices[].Total` | number \\\\| null | yes | |\n| `invoices[].TaxAmount` | number \\\\| null | yes | |\n| `invoices[].Amount` | number \\\\| null | yes | |\n\n### easyinvoice_list_reserved_numbers (workflow step)\n\n- List the numbers of a reserved range still waiting to be signed.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | EasyInvoice connected account |\n| `pattern` | string | yes | The invoice symbol, e.g. 1C26TAA |\n| `serial` | string | yes | Empty under Th\xF4ng t\u01B0 78 |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `numbers` | string[] | yes | |\n\n### easyinvoice_preview_invoice (workflow step)\n\n- Save how an invoice would print, as a PDF or HTML workspace file, before it is created.\n- Nothing is created on EasyInvoice.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | EasyInvoice connected account |\n| `kind` | "invoice" \\\\| "replacement" \\\\| "adjustment_increase" \\\\| "adjustment_decrease" \\\\| "adjustment_information" | yes | invoice: a new one. The others: a replacement or adjustment, whose invoice states its AdjustReplaceReasonCode |\n| `format` | "pdf" \\\\| "html" | yes | |\n| `pattern` | string | | The invoice symbol, e.g. 1C26TAA (Th\xF4ng t\u01B0 78 puts the whole symbol here and leaves serial empty); needed when the account issues under more than one |\n| `serial` | string | | K\xFD hi\u1EC7u of a Th\xF4ng t\u01B0 32 range |\n| `invoice` | object | yes | |\n| `invoice.Ikey` | string | yes | Your own key for this invoice, at most 50 characters; every later call names the invoice by it |\n| `invoice.ArisingDate` | string | yes | Invoice date, YYYY-MM-DD |\n| `invoice.PaymentMethod` | string | yes | Ti\u1EC1n m\u1EB7t, Chuy\u1EC3n kho\u1EA3n, Ti\u1EC1n m\u1EB7t/Chuy\u1EC3n kho\u1EA3n, \u0110\u1ED1i tr\u1EEB c\xF4ng n\u1EE3, Kh\xF4ng thu ti\u1EC1n, or other words printed as given |\n| `invoice.CurrencyUnit` | string | yes | VND, USD, EUR, \u2026 |\n| `invoice.ExchangeRate` | number | | Required unless VND |\n| `invoice.VATRate` | number | yes | 0, 5, 8, 10; -1 not taxable; -2 not declared; -3 another rate, stated in VATRateOther; -5 financial leasing; -6 outside the VAT law; -7 not in the taxable price |\n| `invoice.VATRateOther` | number | | |\n| `invoice.Products` | object[] | yes | |\n| `invoice.Products[].No` | number | | Printed line number; 0 prints none |\n| `invoice.Products[].Feature` | number | yes | 1 goods/service, 2 promotion, 3 commercial discount (positive, subtracted from the invoice), 4 note line, 5 special goods |\n| `invoice.Products[].Code` | string | | |\n| `invoice.Products[].ProdName` | string | yes | |\n| `invoice.Products[].BusinessProdGroupCode` | string | | Business group, e.g. 01_2 |\n| `invoice.Products[].ProdUnit` | string | | |\n| `invoice.Products[].ProdQuantity` | number | | |\n| `invoice.Products[].ProdPrice` | number | | |\n| `invoice.Products[].Discount` | number | | Line discount rate, % |\n| `invoice.Products[].DiscountAmount` | number | | |\n| `invoice.Products[].Total` | number | yes | Before VAT, after the line\'s own discount; 0 on a note line |\n| `invoice.Products[].VATRate` | number | | The invoice\'s VATRate when absent |\n| `invoice.Products[].VATRateOther` | number | | The rate when VATRate is -3 |\n| `invoice.Products[].VATAmount` | number | | Absent only on a note line |\n| `invoice.Products[].Extra` | string | | A JSON object: {"Pos":""} on a note line, the special-goods attributes on Feature 5 |\n| `invoice.CusCode` | string | | EasyInvoice files the buyer under this code, creating or updating it |\n| `invoice.Buyer` | string | | The buyer\'s personal name; this or CusName is required |\n| `invoice.CusName` | string | | The buyer company\'s name; required with CusTaxCode |\n| `invoice.CusTaxCode` | string | | |\n| `invoice.CusAddress` | string | | Required with CusTaxCode |\n| `invoice.CusEmails` | string | | Comma-separated; where the issuance notice goes |\n| `invoice.Email` | string | | |\n| `invoice.EmailCC` | string | | |\n| `invoice.CusBankName` | string | | |\n| `invoice.CusBankNo` | string | | |\n| `invoice.CusPhone` | string | | |\n| `invoice.CusIdentification` | string | | Buyer\'s citizen ID, 9 or 12 characters |\n| `invoice.PassportNo` | string | | |\n| `invoice.BudgetaryRelationshipCode` | string | | |\n| `invoice.ProvinceCode` | string | | |\n| `invoice.ProvinceName` | string | | |\n| `invoice.CommuneCode` | string | | |\n| `invoice.CommuneName` | string | | |\n| `invoice.LocationCode` | string | | Required for a household or individual business, with LocationName and LocationAddress |\n| `invoice.LocationName` | string | | |\n| `invoice.LocationAddress` | string | | |\n| `invoice.StoreCode` | string | | |\n| `invoice.StoreName` | string | | |\n| `invoice.Note` | string | | |\n| `invoice.ListAttachNum` | string | | Number of the b\u1EA3ng k\xEA the invoice carries |\n| `invoice.ListAttachDate` | string | | Its date, YYYY-MM-DD |\n| `invoice.IdentityCardNumber` | string | | National-reserve sale: the buyer\'s ID when they have no tax code |\n| `invoice.TaxAuthorityCode` | string | | An invoice made from a cash register: the code it already holds |\n| `invoice.ComRelateCode` | string | | Public-asset sale: the seller\'s budget unit code |\n| `invoice.CusRelateCode` | string | | Public-asset sale: the buyer\'s budget unit code |\n| `invoice.DecisionCode` | string | | |\n| `invoice.DecisionDate` | string | | YYYY-MM-DD |\n| `invoice.DecisionAgent` | string | | |\n| `invoice.SellMethod` | string | | |\n| `invoice.TransportAddress` | string | | |\n| `invoice.TransportDateFrom` | string | | YYYY-MM-DD |\n| `invoice.TransportDateTo` | string | | YYYY-MM-DD |\n| `invoice.Extra` | string | | A JSON object of fields agreed with EasyInvoice |\n| `invoice.AdjustReplaceReasonCode` | number | | 1\u201314 (Th\xF4ng t\u01B0 91 \u0110i\u1EC1u 10); 13 corrects an invoice issued wrong |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `file_id` | string | yes | The ID of the generated file. |\n| `url` | string | yes | The download URL of the generated file. |\n| `filename` | string | yes | The filename of the generated file, including extension. |\n| `mime_type` | string | yes | The MIME type of the generated file. |\n\n### easyinvoice_reserve_numbers (workflow step)\n\n- Reserve invoice numbers in a range, for invoices created later with kind reserved.\n- Give quantity or ikey_dates.\n- EasyInvoice must have granted the account reserved ranges.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | EasyInvoice connected account |\n| `pattern` | string | yes | The invoice symbol, e.g. 1C26TAA |\n| `serial` | string | yes | Empty under Th\xF4ng t\u01B0 78 |\n| `quantity` | number | | |\n| `ikey_dates` | object | | Ikey \u2192 invoice date (YYYY-MM-DD): one number each |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `Pattern` | string \\\\| null | yes | |\n| `Serial` | string \\\\| null | yes | |\n| `numbers` | string[] | yes | Reserved by quantity |\n| `by_ikey` | object | yes | Reserved by ikey: ikey \u2192 number |\n\n### easyinvoice_save_customers (workflow step)\n\n- Create or update customers in EasyInvoice\'s customer list, in its own field names.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | EasyInvoice connected account |\n| `customers` | object[] | yes | |\n| `customers[].Code` | string | yes | Fixed once created |\n| `customers[].AccountName` | string | yes | The buyer\'s lookup account; fixed once created |\n| `customers[].Name` | string | yes | |\n| `customers[].Buyer` | string | | |\n| `customers[].Address` | string | | |\n| `customers[].TaxCode` | string | | Required for a company |\n| `customers[].BankName` | string | | |\n| `customers[].BankAccountName` | string | | |\n| `customers[].BankNumber` | string | | |\n| `customers[].Email` | string | | |\n| `customers[].EmailCC` | string | | Comma-separated |\n| `customers[].Fax` | string | | |\n| `customers[].Phone` | string | | |\n| `customers[].ContactPerson` | string | | |\n| `customers[].RepresentPerson` | string | | |\n| `customers[].CusType` | number | | 1 the customer keeps accounts, 0 not |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `saved` | number | yes | |\n\n### easyinvoice_save_products (workflow step)\n\n- Create or update products and services in EasyInvoice\'s product list, in its own field names.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | EasyInvoice connected account |\n| `products` | object[] | yes | |\n| `products[].Code` | string | yes | |\n| `products[].Name` | string | yes | |\n| `products[].Price` | number | | |\n| `products[].Unit` | string | | |\n| `products[].Des` | string | | |\n| `products[].VATRate` | number | yes | As on an invoice line |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `saved` | number | yes | |\n\n### easyinvoice_send_error_notice (workflow step)\n\n- File an error notice (04/SS-H\u0110\u0110T) with the tax authority for erroneous invoices, through EasyInvoice.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | EasyInvoice connected account |\n| `notice_type` | number | yes | 1 the seller\'s own notice; 2 answering a notice from the tax authority |\n| `created_date` | string | yes | YYYY-MM-DD |\n| `tax_authority_notice_no` | string | | Type 2: the tax authority\'s notice number |\n| `tax_authority_notice_date` | string | | Type 2: its date, YYYY-MM-DD |\n| `invoices` | object[] | yes | |\n| `invoices[].Pattern` | string | yes | |\n| `invoices[].Serial` | string | | |\n| `invoices[].No` | number | yes | |\n| `invoices[].ArisingDate` | string | yes | YYYY-MM-DD |\n| `invoices[].TaxAuthorityCode` | string | | Required unless the invoice carries none |\n| `invoices[].InvType` | number | yes | 1 N\u0110 123/2020 e-invoice; 2 authenticated under Q\u0110 1209/2660; 3 under N\u0110 51/2010 or 04/2014; 4 printed to order under N\u0110 123/2020 |\n| `invoices[].Note` | string | yes | The reason |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `sent` | number | yes | Invoices the notice names |\n\n### easyinvoice_send_issuance_notice (workflow step)\n\n- Send invoices\' issuance notices again, each to the address given for it.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | EasyInvoice connected account |\n| `emails` | object | yes | Ikey \u2192 email address |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `results` | object | yes | Ikey \u2192 EasyInvoice\'s answer for it, sent or refused |\n\n## evaluate\n\n### evaluate_formula (workflow step)\n\n- Compute a formula over one record as its table\'s own formula fields compute: fields referenced as `{alias}`, lookups and rollups read as the row holds them.\n- Writes nothing.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `table_id` | string | yes | |\n| `record_id` | string | yes | |\n| `expression` | string | yes | |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `value` | number \\\\| string \\\\| boolean \\\\| null | yes | |\n\n## excel\n\n### excel_get_rows (workflow step)\n\n- Read every row of a sheet in an .xlsx, .xls or .csv file as a list of objects keyed by the header row\'s text.\n- A cell is its typed value: a number, true or false, text, a date as ISO text ("2026-03-02", "2026-03-02T09:30:00", or "09:30:00" for a time alone), null when blank.\n- A formula cell is the value the file last computed; an error cell is its code as text ("#N/A").\n- Every CSV cell is text or null.\n- A header cell inside a merge takes the merge\'s text; a blank header is keyed by its column letter ("C"), and a header text that repeats gets its column letter added ("Amount (F)"). headers lists the keys in sheet order.\n- Rows above header_row and rows blank in every column are left out.\n- One call reads a sheet of at most 10000 rows, its header counted, and returns at most 250000 cells (rows \xD7 kept columns); a sheet past either is refused with its row count, never cut short.\n- Read-only.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `file_id` | string | yes | A stored file\'s id. A files field read in a workflow holds file objects: first(record.file).id |\n| `worksheet` | string \\\\| number | | Sheet name, or 0-based index. |\n| `header_row` | number | | 1-based row holding the headers. |\n| `columns` | string[] | | Keys to keep, as headers lists them. |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `file_id` | string | yes | |\n| `worksheet_name` | string | yes | |\n| `header_row` | number | yes | |\n| `headers` | string[] | yes | The key of each returned column, in sheet order |\n| `row_count` | number | yes | |\n| `rows` | object[] | yes | |\n\n## facebook\n\n### facebook_create_post (workflow step)\n\n- Publish a post to a Facebook Page feed.\n- Requires a Facebook connected account whose page allows content management.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | |\n| `page_id` | string | yes | Facebook Page to post to \u2014 one of the connected account\'s managed pages. |\n| `message` | string | yes | |\n| `link` | string | | A post carries either a link or media. |\n| `media_file_ids` | string[] | | Photos, or one video on its own. |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `post_id` | string | yes | |\n| `url` | string | yes | |\n\n### facebook_list_comments (workflow step)\n\n- Read the most recent comments left on a Facebook Page\'s posts.\n- Reply with facebook_reply_to_comment, passing the comment_id. (workflow step, chat)\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | |\n| `page_id` | string | yes | One of the connected account\'s managed pages. |\n| `limit` | integer | | |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `comments` | object[] | yes | |\n| `comments[].comment_id` | string | yes | |\n| `comments[].post_id` | string | yes | |\n| `comments[].author_id` | string | yes | |\n| `comments[].author_name` | string | yes | |\n| `comments[].message` | string | yes | |\n| `comments[].created_time` | string | yes | |\n\n### facebook_list_conversations (workflow step)\n\n- Read a Facebook Page\'s Messenger conversations with their recent messages.\n- Answer someone with facebook_send_message, passing the person_id. (workflow step, chat)\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | |\n| `page_id` | string | yes | One of the connected account\'s managed pages. |\n| `limit` | integer | | |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `conversations` | object[] | yes | |\n| `conversations[].conversation_id` | string | yes | |\n| `conversations[].person_id` | string \\\\| null | yes | |\n| `conversations[].person_name` | string \\\\| null | yes | |\n| `conversations[].messages` | object[] | yes | |\n| `conversations[].messages[].from_id` | string | yes | |\n| `conversations[].messages[].from_name` | string | yes | |\n| `conversations[].messages[].message` | string | yes | |\n| `conversations[].messages[].created_time` | string | yes | |\n\n### facebook_reply_to_comment (workflow step)\n\n- Reply publicly to a comment on a Facebook Page post, as the page.\n- The reply is visible to everyone who can see the comment.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | |\n| `page_id` | string | yes | The page that owns the post the comment is on. |\n| `comment_id` | string | yes | From facebook_list_comments. (workflow step, chat) |\n| `message` | string | yes | |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `comment_id` | string | yes | The reply\'s own id. |\n\n### facebook_send_message (workflow step)\n\n- Answer someone who messaged a Facebook Page, as the page.\n- Meta accepts a reply only within 24 hours of that person\'s last message.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | |\n| `page_id` | string | yes | The page the person wrote to. |\n| `person_id` | string | yes | From facebook_list_conversations. Page-scoped to this page. (workflow step, chat) |\n| `message` | string | yes | |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `message_id` | string | yes | |\n\n## fedex\n\n### fedex_cancel_draft (workflow step)\n\n- Cancel (delete) an unconfirmed FedEx draft (Open Ship) booking by its reference.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | FedEx connected account |\n| `reference` | string | yes | The draft\'s reference (Open Ship index) |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `cancelled` | boolean | yes | |\n\n### fedex_confirm_shipment (workflow step)\n\n- Confirm a FedEx draft (Open Ship) booking by its reference, generating the label / AWB.\n- Returns the master tracking number and any piece tracking numbers + label URLs.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | FedEx connected account |\n| `reference` | string | yes | The draft\'s reference (Open Ship index) from fedex_create_draft_shipment (workflow step, chat) |\n| `master_tracking_number` | string | | The master_tracking_number returned by fedex_create_draft_shipment \u2014 required to finalize the label (workflow step, chat) |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `master_tracking_number` | string | | |\n| `tracking_numbers` | string[] | yes | |\n| `label_urls` | string[] | yes | |\n\n### fedex_create_draft_shipment (workflow step)\n\n- Create a FedEx draft (Open Ship) booking \u2014 no label yet.\n- Confirm later with fedex_confirm_shipment. reference is a unique key you choose (e.g. the shipment order number) used to confirm or cancel. (workflow step, chat)\n- Supports multiple packages, special services, and (international) customs commodities.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | FedEx connected account |\n| `reference` | string | yes | Unique key for this draft (the Open Ship index) |\n| `shipper` | object | yes | |\n| `shipper.contact` | object | | |\n| `shipper.contact.person_name` | string | | |\n| `shipper.contact.company_name` | string | | |\n| `shipper.contact.phone_number` | string | | |\n| `shipper.address` | object | yes | |\n| `shipper.address.postal_code` | string | yes | |\n| `shipper.address.country_code` | string | yes | ISO 3166-1 alpha-2 country code, e.g. VN, US, SG |\n| `shipper.address.city` | string | | |\n| `shipper.address.state_or_province_code` | string | | |\n| `shipper.address.street_lines` | string[] | | |\n| `shipper.address.residential` | boolean | | |\n| `recipient` | object | yes | |\n| `recipient.contact` | object | | |\n| `recipient.contact.person_name` | string | | |\n| `recipient.contact.company_name` | string | | |\n| `recipient.contact.phone_number` | string | | |\n| `recipient.address` | object | yes | |\n| `recipient.address.postal_code` | string | yes | |\n| `recipient.address.country_code` | string | yes | ISO 3166-1 alpha-2 country code, e.g. VN, US, SG |\n| `recipient.address.city` | string | | |\n| `recipient.address.state_or_province_code` | string | | |\n| `recipient.address.street_lines` | string[] | | |\n| `recipient.address.residential` | boolean | | |\n| `service_type` | string | yes | FedEx service type e.g. INTERNATIONAL_PRIORITY |\n| `packaging_type` | string | | FedEx packaging type e.g. YOUR_PACKAGING |\n| `packages` | object[] | yes | One entry per package; weight in kg |\n| `packages[].weight` | number | yes | |\n| `packages[].weight_units` | "KG" \\\\| "LB" | | Weight units; FedEx requires LB for US domestic express |\n| `packages[].length` | number | | |\n| `packages[].width` | number | | |\n| `packages[].height` | number | | |\n| `packages[].dimension_units` | "CM" \\\\| "IN" | | |\n| `ship_datestamp` | string | | Ship date YYYY-MM-DD |\n| `pickup_type` | string | | FedEx pickup type e.g. USE_SCHEDULED_PICKUP |\n| `special_services` | string[] | | FedEx special service types e.g. SATURDAY_DELIVERY, FEDEX_ONE_RATE |\n| `commodities` | object[] | | Customs commodities for international shipments |\n| `commodities[].description` | string | yes | |\n| `commodities[].quantity` | number | yes | |\n| `commodities[].customs_value` | number | yes | |\n| `commodities[].currency` | string | yes | |\n| `commodities[].weight` | number | yes | |\n| `commodities[].weight_units` | "KG" \\\\| "LB" | | |\n| `commodities[].country_of_manufacture` | string | | ISO 3166-1 alpha-2 |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `reference` | string | yes | |\n| `status` | "draft" | yes | |\n| `master_tracking_number` | string | | Pass this to fedex_confirm_shipment to finalize the draft (workflow step, chat) |\n\n### fedex_create_shipment (workflow step)\n\n- Create a FedEx shipment and generate the label / AWB in one call.\n- Returns the master tracking number, piece tracking numbers, and label URLs.\n- Use the Open Ship draft flow instead when you need to stage a booking before committing.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | FedEx connected account |\n| `shipper` | object | yes | |\n| `shipper.contact` | object | | |\n| `shipper.contact.person_name` | string | | |\n| `shipper.contact.company_name` | string | | |\n| `shipper.contact.phone_number` | string | | |\n| `shipper.address` | object | yes | |\n| `shipper.address.postal_code` | string | yes | |\n| `shipper.address.country_code` | string | yes | ISO 3166-1 alpha-2 country code, e.g. VN, US, SG |\n| `shipper.address.city` | string | | |\n| `shipper.address.state_or_province_code` | string | | |\n| `shipper.address.street_lines` | string[] | | |\n| `shipper.address.residential` | boolean | | |\n| `recipient` | object | yes | |\n| `recipient.contact` | object | | |\n| `recipient.contact.person_name` | string | | |\n| `recipient.contact.company_name` | string | | |\n| `recipient.contact.phone_number` | string | | |\n| `recipient.address` | object | yes | |\n| `recipient.address.postal_code` | string | yes | |\n| `recipient.address.country_code` | string | yes | ISO 3166-1 alpha-2 country code, e.g. VN, US, SG |\n| `recipient.address.city` | string | | |\n| `recipient.address.state_or_province_code` | string | | |\n| `recipient.address.street_lines` | string[] | | |\n| `recipient.address.residential` | boolean | | |\n| `service_type` | string | yes | FedEx service type e.g. INTERNATIONAL_PRIORITY |\n| `packaging_type` | string | | FedEx packaging type e.g. YOUR_PACKAGING |\n| `packages` | object[] | yes | One entry per package; weight in kg |\n| `packages[].weight` | number | yes | |\n| `packages[].weight_units` | "KG" \\\\| "LB" | | Weight units; FedEx requires LB for US domestic express |\n| `packages[].length` | number | | |\n| `packages[].width` | number | | |\n| `packages[].height` | number | | |\n| `packages[].dimension_units` | "CM" \\\\| "IN" | | |\n| `ship_datestamp` | string | | Ship date YYYY-MM-DD |\n| `pickup_type` | string | | FedEx pickup type e.g. USE_SCHEDULED_PICKUP |\n| `special_services` | string[] | | FedEx special service types |\n| `commodities` | object[] | | Customs commodities for international shipments |\n| `commodities[].description` | string | yes | |\n| `commodities[].quantity` | number | yes | |\n| `commodities[].customs_value` | number | yes | |\n| `commodities[].currency` | string | yes | |\n| `commodities[].weight` | number | yes | |\n| `commodities[].weight_units` | "KG" \\\\| "LB" | | |\n| `commodities[].country_of_manufacture` | string | | ISO 3166-1 alpha-2 |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `master_tracking_number` | string | | |\n| `tracking_numbers` | string[] | yes | |\n| `label_urls` | string[] | yes | |\n\n### fedex_rate (workflow step)\n\n- Get FedEx rate quotes for a shipment.\n- Returns one priced row per available service (or just the requested service_type).\n- Use before booking to compare costs.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | FedEx connected account |\n| `shipper` | object | yes | |\n| `shipper.postal_code` | string | yes | |\n| `shipper.country_code` | string | yes | ISO 3166-1 alpha-2 country code, e.g. VN, US, SG |\n| `shipper.city` | string | | |\n| `shipper.state_or_province_code` | string | | |\n| `shipper.street_lines` | string[] | | |\n| `shipper.residential` | boolean | | |\n| `recipient` | object | yes | |\n| `recipient.postal_code` | string | yes | |\n| `recipient.country_code` | string | yes | ISO 3166-1 alpha-2 country code, e.g. VN, US, SG |\n| `recipient.city` | string | | |\n| `recipient.state_or_province_code` | string | | |\n| `recipient.street_lines` | string[] | | |\n| `recipient.residential` | boolean | | |\n| `packages` | object[] | yes | One entry per package; weight in kg |\n| `packages[].weight` | number | yes | |\n| `packages[].weight_units` | "KG" \\\\| "LB" | | Weight units; FedEx requires LB for US domestic express |\n| `packages[].length` | number | | |\n| `packages[].width` | number | | |\n| `packages[].height` | number | | |\n| `packages[].dimension_units` | "CM" \\\\| "IN" | | |\n| `service_type` | string | | FedEx service type e.g. INTERNATIONAL_PRIORITY. Omit to rate all available services. |\n| `packaging_type` | string | | FedEx packaging type e.g. YOUR_PACKAGING |\n| `pickup_type` | string | | FedEx pickup type e.g. USE_SCHEDULED_PICKUP |\n| `ship_datestamp` | string | | Ship date YYYY-MM-DD |\n| `special_services` | string[] | | FedEx special service types e.g. SATURDAY_DELIVERY |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `services` | object[] | yes | |\n| `services[].service_type` | string | yes | |\n| `services[].service_name` | string | | |\n| `services[].total_charge` | number | | |\n| `services[].currency` | string | | |\n\n### fedex_service_availability (workflow step)\n\n- Check what FedEx services serve a lane. query "transit_times" returns delivery commitments per service; "package_and_service_options" returns valid service/packaging combinations; "special_service_options" returns available special services.\n- Use before rating/booking to learn the valid service types for an origin \u2192 destination.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | FedEx connected account |\n| `query` | "transit_times" \\\\| "special_service_options" \\\\| "package_and_service_options" | yes | |\n| `shipper` | object | yes | |\n| `shipper.postal_code` | string | yes | |\n| `shipper.country_code` | string | yes | ISO 3166-1 alpha-2 country code, e.g. VN, US, SG |\n| `shipper.city` | string | | |\n| `shipper.state_or_province_code` | string | | |\n| `shipper.street_lines` | string[] | | |\n| `shipper.residential` | boolean | | |\n| `recipient` | object | yes | |\n| `recipient.postal_code` | string | yes | |\n| `recipient.country_code` | string | yes | ISO 3166-1 alpha-2 country code, e.g. VN, US, SG |\n| `recipient.city` | string | | |\n| `recipient.state_or_province_code` | string | | |\n| `recipient.street_lines` | string[] | | |\n| `recipient.residential` | boolean | | |\n| `packages` | object[] | yes | One entry per package; weight in kg unless weight_units set |\n| `packages[].weight` | number | yes | |\n| `packages[].weight_units` | "KG" \\\\| "LB" | | Weight units; FedEx requires LB for US domestic express |\n| `packages[].length` | number | | |\n| `packages[].width` | number | | |\n| `packages[].height` | number | | |\n| `packages[].dimension_units` | "CM" \\\\| "IN" | | |\n| `ship_datestamp` | string | | Ship date YYYY-MM-DD |\n| `carrier_codes` | string[] | yes | FedEx carrier codes \u2014 at least one, e.g. FDXE (Express), FDXG (Ground) |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `result` | object | yes | |\n\n### fedex_validate_address (workflow step)\n\n- Validate one or more addresses with FedEx.\n- Returns each resolved address plus its classification (e.g.\n- BUSINESS / RESIDENTIAL) and deliverability attributes.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | FedEx connected account |\n| `addresses` | object[] | yes | At most 100 per call. |\n| `addresses[].postal_code` | string | yes | |\n| `addresses[].country_code` | string | yes | ISO 3166-1 alpha-2 country code, e.g. VN, US, SG |\n| `addresses[].city` | string | | |\n| `addresses[].state_or_province_code` | string | | |\n| `addresses[].street_lines` | string[] | | |\n| `addresses[].residential` | boolean | | |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `resolved_addresses` | object[] | yes | |\n| `resolved_addresses[].city` | string | | |\n| `resolved_addresses[].state_or_province_code` | string | | |\n| `resolved_addresses[].postal_code` | string | | |\n| `resolved_addresses[].country_code` | string | | |\n| `resolved_addresses[].classification` | string | | |\n| `resolved_addresses[].attributes` | object | | |\n\n## generate\n\n### generate_bank_qr_code (workflow step)\n\n- Generate a bank-payment QR code (VietQR for Vietnam) and save it as a PNG to the workspace.\n- The QR encodes the recipient bank, account number, and optional amount/description so any banking app can scan and pre-fill the transfer.\n- Call list_banks first to discover valid bank codes. (workflow step, chat)\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `country` | "VN" | yes | Country whose bank-payment QR standard to use. Currently only \'VN\' (Vietnam / VietQR) is supported. |\n| `bank_code` | "ICB" \\\\| "VCB" \\\\| "BIDV" \\\\| "VBA" \\\\| "OCB" \\\\| "MB" \\\\| "TCB" \\\\| "ACB" \\\\| "VPB" \\\\| "TPB" \\\\| "STB" \\\\| "HDB" \\\\| "VCCB" \\\\| "SCB" \\\\| "VIB" \\\\| "SHB" \\\\| "EIB" \\\\| "MSB" \\\\| "CAKE" \\\\| "Ubank" \\\\| "TIMO" \\\\| "SGICB" \\\\| "BAB" \\\\| "momo" \\\\| "PVDB" \\\\| "PVCB" \\\\| "MBV" \\\\| "NCB" \\\\| "SHBVN" \\\\| "ABB" \\\\| "VAB" \\\\| "NAB" \\\\| "PGB" \\\\| "VIETBANK" \\\\| "BVB" \\\\| "SEAB" \\\\| "COOPBANK" \\\\| "LPB" \\\\| "KLB" \\\\| "KBank" \\\\| "CIMB" \\\\| "WVN" | yes | Bank code from list_banks. Must belong to the specified country. (workflow step, chat) |\n| `account_number` | string | yes | Beneficiary account number at the bank. |\n| `amount` | number | | Payment amount in the local currency (VND for Vietnam). Omit for a static QR with no fixed amount. |\n| `description` | string | | Transfer description / memo. Max 50 bytes; Vietnamese diacritics use 2\u20133 bytes per character. |\n| `account_name` | string | | Beneficiary name shown on the payer\'s banking app confirmation screen. Max 25 bytes \u2014 banks normalize Vietnamese names to ASCII uppercase, pass the normalized form (e.g. \'NGUYEN VAN A\'). |\n| `filename` | string | | Output filename. Defaults to \'bank_qr_<bank_code>.png\'. |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `id` | string | yes | |\n| `filename` | string | yes | |\n| `mime_type` | string | yes | |\n| `url` | string | yes | |\n| `bank` | object | yes | |\n| `bank.country` | string | yes | |\n| `bank.code` | string | yes | |\n| `bank.short_name` | string | yes | |\n| `bank.full_name` | string | yes | |\n\n### generate_qr_code (workflow step)\n\n- Generate a QR code PNG from text or a URL and save it to the workspace.\n- For bank payment QR codes, use generate_bank_qr_code instead \u2014 it builds the correct EMVCo payload from a bank code and account number. (workflow step, chat)\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `data` | string | yes | Text or URL to encode into the QR code. |\n| `filename` | string | | Output filename. Defaults to \'qr_code.png\'. |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `id` | string | yes | |\n| `filename` | string | yes | |\n| `mime_type` | string | yes | |\n| `url` | string | yes | |\n\n## get\n\n### get_record (workflow step)\n\n- Fetch a single record with all field values.\n- Returns data (raw values) and display (human-readable labels).\n- A workspace admin\'s `as_member` fetches it as that member would see it.\n- Cell shapes in `data`, keyed by field alias: select / member / link, and a formula with options, read back as arrays \u2014 a single-select as ["open"], the option\'s alias; one member as ["mbr_x"].\n- A workflow body reads the same single-select, single-member or option-formula cell as the bare value, and a files cell as a list of file objects, each with id, filename and mime_type: `first(record.file).id` is the id a file tool takes.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `record_id` | string | yes | |\n| `table_id` | string | | |\n| `as_member` | string | | For a workspace admin: reads as this member would \u2014 their row rules and access. Anyone else is refused. |\n| `field_keys` | string[] | | Field aliases to return. Omit to return all fields. |\n| `comments` | boolean | | Return the record\'s newest comments, 20 at most; `comment_count` is the whole thread. |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `id` | string | yes | |\n| `data` | object | yes | |\n| `display` | object | yes | Human-readable display values for select, member, and record link fields. |\n| `links` | object | | Each link field\'s linked rows with the title the cell carries, by field alias; `data` holds their ids. |\n| `locked` | boolean | | |\n| `comment_count` | number | yes | How many comments the record holds. |\n| `comments` | object[] | | With `comments: true`: the newest first. |\n| `comments[].id` | string | yes | Unique identifier for the comment |\n| `comments[].member_id` | string | yes | ID of the member who created this comment |\n| `comments[].content` | string | yes | Comment text content (0-10,000 characters) |\n| `comments[].files` | object[] \\\\| null | | Array of files attached to this comment |\n| `comments[].created_at` | string | yes | Timestamp when comment was created |\n| `comments[].updated_at` | string | yes | Timestamp of last update |\n| `archived_at` | string \\\\| null | | |\n| `created_at` | string | | |\n| `updated_at` | string | | |\n| `_field_names` | object | | |\n| `units` | object | | The unit or currency this row reads a figure in, by the figure\'s field alias, where each row states its own. |\n\n## gmail\n\n### gmail_get_thread (workflow step)\n\n- Retrieve all messages in a Gmail thread.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | The ID of the connected Gmail account to use |\n| `thread_id` | string | yes | Gmail thread ID |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `messages` | object[] | yes | |\n| `messages[].id` | string | yes | Gmail message ID |\n| `messages[].threadId` | string | yes | Gmail thread ID |\n| `messages[].labelIds` | string[] | yes | Gmail label IDs (e.g. INBOX, UNREAD) |\n| `messages[].subject` | string | yes | Email subject |\n| `messages[].from` | string | yes | Sender email address |\n| `messages[].to` | string | yes | Recipient email address |\n| `messages[].date` | string | yes | Email date in the workspace timezone, with its offset |\n| `messages[].snippet` | string | yes | Short plain-text preview of the email body |\n| `messages[].cc` | string \\\\| null | | CC recipients |\n| `messages[].bcc` | string \\\\| null | | BCC recipients |\n\n### gmail_query_emails (workflow step)\n\n- Search Gmail messages using Gmail search syntax. ## Query syntax Operators (no space after colon): - People: from:, to:, cc:, bcc:, deliveredto: - Content: subject:, "exact phrase", +exact_word, AROUND N (proximity) - Status: is:unread, is:read, is:starred, is:important, is:muted - Labels: label:name, in:inbox, in:sent, in:drafts, in:spam, in:trash, in:anywhere - Category: category:primary, category:social, category:promotions, category:updates, category:forums - Attachments: has:attachment, has:drive, filename:pdf, filename:report.xlsx (has:attachment matches non-inline attachments only \u2014 it misses inline-embedded PDFs, common in receipts/invoices; open the message with gmail_read_email to detect those) - Size: larger:5M, smaller:2M, size:1000000 - Dates (YYYY/MM/DD): after:2024/01/01, before:2024/12/31 - Relative dates: newer_than:7d, older_than:3m, newer_than:1y (d=days, m=months, y=years) Combining: space = AND, OR (uppercase), - (exclude), () for grouping, {} alternative OR syntax. (workflow step, chat)\n- Examples: - from:alice is:unread has:attachment - subject:"quarterly review" newer_than:2d - {from:alice from:bob} subject:project -in:drafts - larger:5M filename:pdf older_than:6m - in:anywhere deliveredto:billing@company.com\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | The ID of the connected Gmail account to use |\n| `query` | string | yes | Gmail search syntax expression |\n| `max_result` | number | yes | Maximum number of emails to retrieve (1-50) |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `messages` | object[] | yes | List of matching Gmail messages |\n| `messages[].id` | string | yes | Gmail message ID |\n| `messages[].threadId` | string | yes | Gmail thread ID |\n| `messages[].labelIds` | string[] | yes | Gmail label IDs (e.g. INBOX, UNREAD) |\n| `messages[].subject` | string | yes | Email subject |\n| `messages[].from` | string | yes | Sender email address |\n| `messages[].to` | string | yes | Recipient email address |\n| `messages[].date` | string | yes | Email date in the workspace timezone, with its offset |\n| `messages[].snippet` | string | yes | Short plain-text preview of the email body |\n| `messages[].cc` | string \\\\| null | | CC recipients |\n| `messages[].bcc` | string \\\\| null | | BCC recipients |\n\n### gmail_query_labels (workflow step)\n\n- List Gmail labels with message and thread counts.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | The ID of the connected Gmail account to use |\n| `name` | string | | Match labels by name prefix. |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `labels` | object[] | yes | |\n| `labels[].id` | string | yes | |\n| `labels[].name` | string | yes | |\n| `labels[].type` | string | yes | system or user |\n| `labels[].messagesTotal` | number | yes | |\n| `labels[].messagesUnread` | number | yes | |\n| `labels[].threadsTotal` | number | yes | |\n| `labels[].threadsUnread` | number | yes | |\n\n### gmail_read_email (workflow step)\n\n- Fetch a Gmail message\'s body and the list of its attachments.\n- Attachments are stored as workspace files \u2014 the result names each one\'s file_id; read one with view_files, attach one to a record with update_records. (chat, MCP, CLI)\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | The ID of the connected account |\n| `message_id` | string | yes | The ID of the Gmail message to retrieve |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `message` | object | yes | The full Gmail message |\n| `message.id` | string | | Gmail message ID |\n| `message.threadId` | string | | Gmail thread ID |\n| `message.historyId` | string | | Gmail history ID |\n| `message.labelIds` | string[] | | Gmail label IDs |\n| `message.subject` | string | yes | Email subject |\n| `message.from` | string | yes | Sender email address |\n| `message.to` | string | yes | Recipient email address |\n| `message.date` | string | yes | Email date in the workspace timezone, with its offset |\n| `message.body` | object | yes | Email body |\n| `message.body.type` | "text" \\\\| "html" | yes | Body content type |\n| `message.body.content` | string | yes | Body content |\n| `message.cc` | string \\\\| null | | CC recipients |\n| `message.bcc` | string \\\\| null | | BCC recipients |\n| `message.inReplyTo` | string \\\\| null | | In-Reply-To header |\n| `message.replyTo` | string \\\\| null | | Reply-To header |\n| `message.references` | string[] \\\\| null | | References header |\n| `message.attachments` | object[] | yes | Email attachments |\n| `message.attachments[].partId` | string | yes | MIME part ID |\n| `message.attachments[].filename` | string | yes | Attachment filename as stored, which may differ from the sender\'s |\n| `message.attachments[].mimeType` | string | yes | MIME type as stored, recovered from the filename when the sender declared a generic one |\n| `message.attachments[].attachmentId` | string | yes | Gmail attachment ID |\n| `message.attachments[].file_id` | string | | Stored file ID \u2014 pass to view_files to read it, or to update_records to attach it (chat, MCP, CLI) |\n| `message.attachments[].size` | number | | Stored size in bytes |\n\n### gmail_reply_email (workflow step)\n\n- Draft or send a reply to a Gmail message.\n- Use reply_body (markdown) or template_id + template_data \u2014 not both.\n- Attach stored files by passing their file_ids.\n- Leaves an unsent draft unless draft is false.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | |\n| `original_message_id` | string | yes | |\n| `reply_body` | string | | Reply body (markdown). Mutually exclusive with template_id. |\n| `template_id` | string | | |\n| `template_data` | object | | |\n| `cc` | string | | CC recipients, comma-separated |\n| `bcc` | string | | BCC recipients, comma-separated |\n| `draft` | boolean | | Leave true to save an unsent draft the member reviews. Pass false only to deliver the message now \u2014 delivery is irreversible. |\n| `file_ids` | string[] | yes | |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `message_id` | string | yes | The ID of the sent message or saved draft |\n| `subject` | string | yes | The subject as sent |\n| `html` | string | yes | The body as sent, rendered to HTML |\n| `markdown` | string | | The body as written in markdown; absent when a template rendered it |\n| `to` | string | yes | The original sender the reply went to |\n\n### gmail_send_email (workflow step)\n\n- Draft or send a Gmail email.\n- Use content (markdown) or template_id + template_data \u2014 not both.\n- Attach stored files by passing their file_ids.\n- Leaves an unsent draft unless draft is false.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | |\n| `to` | string | | Recipient email(s), comma-separated. Required unless using a template. |\n| `subject` | string | | |\n| `cc` | string | | CC recipients, comma-separated |\n| `bcc` | string | | BCC recipients, comma-separated |\n| `content` | string | | Email body (markdown). Mutually exclusive with template_id. |\n| `template_id` | string | | |\n| `template_data` | object | | |\n| `draft` | boolean | | Leave true to save an unsent draft the member reviews. Pass false only to deliver the message now \u2014 delivery is irreversible. |\n| `file_ids` | string[] | yes | |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `message_id` | string | yes | The ID of the sent message or saved draft |\n| `subject` | string | yes | The subject as sent |\n| `html` | string | yes | The body as sent, rendered to HTML |\n| `markdown` | string | | The body as written in markdown; absent when a template rendered it |\n| `to` | string | yes | The recipients as sent, comma-separated |\n\n## instagram\n\n### instagram_create_post (workflow step)\n\n- Publish to the connected Instagram account.\n- Instagram has no text-only posts.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | |\n| `caption` | string | yes | |\n| `media_file_ids` | string[] | yes | One image, one video (published as a reel), or 2\u201310 images and videos as a carousel. |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `post_id` | string | yes | |\n| `url` | string | yes | |\n\n## kiotviet\n\n### kiotviet_cancel_invoice (workflow step)\n\n- Cancel a KiotViet sales invoice by id, returning its stock.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | KiotViet connected account |\n| `id` | number | yes | |\n| `void_payment` | boolean | | Also void payments recorded on the invoice |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `cancelled` | true | yes | |\n\n### kiotviet_cancel_order (workflow step)\n\n- Cancel a KiotViet sales order by id, releasing the stock it reserved.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | KiotViet connected account |\n| `id` | number | yes | |\n| `void_payment` | boolean | | Also void payments recorded on the order |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `cancelled` | true | yes | |\n\n### kiotviet_create_category (workflow step)\n\n- Create a KiotViet product group (nh\xF3m h\xE0ng), optionally under a parent group.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | KiotViet connected account |\n| `name` | string | yes | |\n| `parent_id` | number | | |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `category` | object | yes | |\n\n### kiotviet_create_customer (workflow step)\n\n- Create a KiotViet customer (kh\xE1ch h\xE0ng).\n- Returns the customer as KiotViet stores it, with its id and code.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | KiotViet connected account |\n| `name` | string | yes | |\n| `code` | string | | Customer code (m\xE3 kh\xE1ch h\xE0ng) |\n| `contact_number` | string | | |\n| `email` | string | | |\n| `address` | string | | |\n| `location_name` | string | | Province/district as KiotViet names it |\n| `ward_name` | string | | |\n| `gender` | boolean | | true for male, false for female |\n| `birth_date` | string | | yyyy-mm-dd |\n| `group_ids` | number[] | | Customer group ids |\n| `comments` | string | | |\n| `branch_id` | number | | |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `customer` | object | yes | |\n\n### kiotviet_create_invoice (workflow step)\n\n- Create a KiotViet sales invoice (h\xF3a \u0111\u01A1n), which deducts stock.\n- Pass order_id to invoice an existing order.\n- Returns the invoice as KiotViet stores it, with its id and code.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | KiotViet connected account |\n| `branch_id` | number | yes | |\n| `customer_id` | number | | |\n| `sold_by_id` | number | yes | KiotViet user id of the seller |\n| `purchase_date` | string | | ISO datetime |\n| `description` | string | | |\n| `discount` | number | | Discount amount on the whole document |\n| `lines` | object[] | yes | |\n| `lines[].product_id` | number | yes | |\n| `lines[].quantity` | number | yes | |\n| `lines[].price` | number | | Unit price |\n| `lines[].discount` | number | | Discount amount on the line |\n| `lines[].note` | string | | |\n| `order_id` | number | | The sales order this invoice settles |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `invoice` | object | yes | |\n\n### kiotviet_create_order (workflow step)\n\n- Create a KiotViet sales order (\u0111\u1EB7t h\xE0ng) \u2014 the pre-invoice stage, which reserves stock.\n- Returns the order as KiotViet stores it, with its id and code.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | KiotViet connected account |\n| `branch_id` | number | yes | |\n| `customer_id` | number | | |\n| `sold_by_id` | number | | KiotViet user id of the seller |\n| `purchase_date` | string | | ISO datetime |\n| `description` | string | | |\n| `discount` | number | | Discount amount on the whole document |\n| `lines` | object[] | yes | |\n| `lines[].product_id` | number | yes | |\n| `lines[].quantity` | number | yes | |\n| `lines[].price` | number | | Unit price |\n| `lines[].discount` | number | | Discount amount on the line |\n| `lines[].note` | string | | |\n| `make_invoice` | boolean | | Also issue the invoice at once |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `order` | object | yes | |\n\n### kiotviet_create_product (workflow step)\n\n- Create a KiotViet product (h\xE0ng h\xF3a), optionally with opening stock per branch.\n- Returns the product as KiotViet stores it, with its id and code.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | KiotViet connected account |\n| `name` | string | yes | |\n| `code` | string | | Product code (m\xE3 h\xE0ng) |\n| `category_id` | number | yes | Product group id |\n| `base_price` | number | | Selling price |\n| `unit` | string | | |\n| `allows_sale` | boolean | | |\n| `is_active` | boolean | | |\n| `description` | string | | |\n| `weight` | number | | Grams |\n| `inventories` | object[] | | Stock per branch |\n| `inventories[].branch_id` | number | yes | |\n| `inventories[].on_hand` | number | yes | |\n| `inventories[].cost` | number | | Unit cost at this branch |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `product` | object | yes | |\n\n### kiotviet_delete_product (workflow step)\n\n- Delete a KiotViet product by id.\n- KiotViet refuses one that already appears on invoices.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | KiotViet connected account |\n| `id` | number | yes | |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `deleted` | true | yes | |\n\n### kiotviet_get_customer (workflow step)\n\n- Get one KiotViet customer by id or by customer code (m\xE3 kh\xE1ch h\xE0ng).\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | KiotViet connected account |\n| `id` | number | | |\n| `code` | string | | Customer code (m\xE3 kh\xE1ch h\xE0ng), e.g. KH000123 |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `customer` | object | yes | |\n\n### kiotviet_get_invoice (workflow step)\n\n- Get one KiotViet sales invoice by id or by invoice code (m\xE3 h\xF3a \u0111\u01A1n), with its line items and payments.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | KiotViet connected account |\n| `id` | number | | |\n| `code` | string | | Invoice code (m\xE3 h\xF3a \u0111\u01A1n), e.g. HD000123 |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `invoice` | object | yes | |\n\n### kiotviet_get_product (workflow step)\n\n- Get one KiotViet product by id or by product code (m\xE3 h\xE0ng), with stock per branch in inventories[].\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | KiotViet connected account |\n| `id` | number | | |\n| `code` | string | | Product code (m\xE3 h\xE0ng), e.g. SP000123 |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `product` | object | yes | |\n\n### kiotviet_list_branches (workflow step)\n\n- List the store\'s KiotViet branches (chi nh\xE1nh).\n- Branch ids scope inventory, invoices and orders.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | KiotViet connected account |\n| `page_size` | number | | Rows per page, up to 100 |\n| `current_item` | number | | Zero-based offset of the first row |\n| `last_modified_from` | string | | ISO datetime; only rows modified at or after it |\n| `include_removed_ids` | boolean | | Also return removed_ids \u2014 rows deleted since last_modified_from |\n| `order_by` | string | | KiotViet field name to sort by |\n| `order_direction` | "Asc" \\\\| "Desc" | | |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `total` | number | | Rows matching the query across all pages |\n| `page_size` | number | | |\n| `items` | object[] | yes | Rows as KiotViet returns them |\n| `removed_ids` | number[] | | |\n\n### kiotviet_list_categories (workflow step)\n\n- List KiotViet product groups (nh\xF3m h\xE0ng).\n- Each row carries its parentId, so the tree can be rebuilt from the flat list.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | KiotViet connected account |\n| `page_size` | number | | Rows per page, up to 100 |\n| `current_item` | number | | Zero-based offset of the first row |\n| `last_modified_from` | string | | ISO datetime; only rows modified at or after it |\n| `include_removed_ids` | boolean | | Also return removed_ids \u2014 rows deleted since last_modified_from |\n| `order_by` | string | | KiotViet field name to sort by |\n| `order_direction` | "Asc" \\\\| "Desc" | | |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `total` | number | | Rows matching the query across all pages |\n| `page_size` | number | | |\n| `items` | object[] | yes | Rows as KiotViet returns them |\n| `removed_ids` | number[] | | |\n\n### kiotviet_list_customers (workflow step)\n\n- List KiotViet customers (kh\xE1ch h\xE0ng) with their lifetime totals \u2014 totalInvoiced, totalRevenue, debt, totalPoint.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | KiotViet connected account |\n| `page_size` | number | | Rows per page, up to 100 |\n| `current_item` | number | | Zero-based offset of the first row |\n| `last_modified_from` | string | | ISO datetime; only rows modified at or after it |\n| `include_removed_ids` | boolean | | Also return removed_ids \u2014 rows deleted since last_modified_from |\n| `order_by` | string | | KiotViet field name to sort by |\n| `order_direction` | "Asc" \\\\| "Desc" | | |\n| `code` | string | | Customer code (m\xE3 kh\xE1ch h\xE0ng) |\n| `name` | string | | Name search |\n| `contact_number` | string | | Phone number |\n| `group_id` | number | | Only customers in this customer group |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `total` | number | | Rows matching the query across all pages |\n| `page_size` | number | | |\n| `items` | object[] | yes | Rows as KiotViet returns them |\n| `removed_ids` | number[] | | |\n\n### kiotviet_list_invoices (workflow step)\n\n- List KiotViet sales invoices (h\xF3a \u0111\u01A1n) with their line items in invoiceDetails[] \u2014 productCode, productName, quantity, price, discount, subTotal.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | KiotViet connected account |\n| `page_size` | number | | Rows per page, up to 100 |\n| `current_item` | number | | Zero-based offset of the first row |\n| `last_modified_from` | string | | ISO datetime; only rows modified at or after it |\n| `include_removed_ids` | boolean | | Also return removed_ids \u2014 rows deleted since last_modified_from |\n| `order_by` | string | | KiotViet field name to sort by |\n| `order_direction` | "Asc" \\\\| "Desc" | | |\n| `branch_ids` | number[] | | |\n| `customer_ids` | number[] | | |\n| `customer_code` | string | | Customer code (m\xE3 kh\xE1ch h\xE0ng) |\n| `status` | number[] | | KiotViet status codes; each row carries statusValue with the label |\n| `from_purchase_date` | string | | Date, yyyy-mm-dd |\n| `to_purchase_date` | string | | Date, yyyy-mm-dd |\n| `include_payment` | boolean | | Include payments[] on each row |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `total` | number | | Rows matching the query across all pages |\n| `page_size` | number | | |\n| `items` | object[] | yes | Rows as KiotViet returns them |\n| `removed_ids` | number[] | | |\n\n### kiotviet_list_orders (workflow step)\n\n- List KiotViet sales orders (\u0111\u1EB7t h\xE0ng) \u2014 the pre-invoice stage \u2014 with line items in orderDetails[].\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | KiotViet connected account |\n| `page_size` | number | | Rows per page, up to 100 |\n| `current_item` | number | | Zero-based offset of the first row |\n| `last_modified_from` | string | | ISO datetime; only rows modified at or after it |\n| `include_removed_ids` | boolean | | Also return removed_ids \u2014 rows deleted since last_modified_from |\n| `order_by` | string | | KiotViet field name to sort by |\n| `order_direction` | "Asc" \\\\| "Desc" | | |\n| `branch_ids` | number[] | | |\n| `customer_ids` | number[] | | |\n| `customer_code` | string | | Customer code (m\xE3 kh\xE1ch h\xE0ng) |\n| `status` | number[] | | KiotViet status codes; each row carries statusValue with the label |\n| `from_purchase_date` | string | | Date, yyyy-mm-dd |\n| `to_purchase_date` | string | | Date, yyyy-mm-dd |\n| `include_payment` | boolean | | Include payments[] on each row |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `total` | number | | Rows matching the query across all pages |\n| `page_size` | number | | |\n| `items` | object[] | yes | Rows as KiotViet returns them |\n| `removed_ids` | number[] | | |\n\n### kiotviet_list_products (workflow step)\n\n- List KiotViet products (h\xE0ng h\xF3a) with stock per branch.\n- Each row\'s inventories[] carries branchId, onHand (t\u1ED3n kho), reserved (\u0111\u1EB7t h\xE0ng) and cost.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | KiotViet connected account |\n| `page_size` | number | | Rows per page, up to 100 |\n| `current_item` | number | | Zero-based offset of the first row |\n| `last_modified_from` | string | | ISO datetime; only rows modified at or after it |\n| `include_removed_ids` | boolean | | Also return removed_ids \u2014 rows deleted since last_modified_from |\n| `order_by` | string | | KiotViet field name to sort by |\n| `order_direction` | "Asc" \\\\| "Desc" | | |\n| `category_id` | number | | Only products in this product group |\n| `is_active` | boolean | | Only products still on sale (true) or discontinued (false) |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `total` | number | | Rows matching the query across all pages |\n| `page_size` | number | | |\n| `items` | object[] | yes | Rows as KiotViet returns them |\n| `removed_ids` | number[] | | |\n\n### kiotviet_list_purchase_orders (workflow step)\n\n- List KiotViet purchase orders (phi\u1EBFu nh\u1EADp h\xE0ng) \u2014 goods received from suppliers \u2014 with line items in purchaseOrderDetails[].\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | KiotViet connected account |\n| `page_size` | number | | Rows per page, up to 100 |\n| `current_item` | number | | Zero-based offset of the first row |\n| `last_modified_from` | string | | ISO datetime; only rows modified at or after it |\n| `include_removed_ids` | boolean | | Also return removed_ids \u2014 rows deleted since last_modified_from |\n| `order_by` | string | | KiotViet field name to sort by |\n| `order_direction` | "Asc" \\\\| "Desc" | | |\n| `branch_ids` | number[] | | |\n| `status` | number[] | | KiotViet status codes; each row carries statusValue with the label |\n| `from_purchase_date` | string | | Date, yyyy-mm-dd |\n| `to_purchase_date` | string | | Date, yyyy-mm-dd |\n| `include_payment` | boolean | | Include payments[] on each row |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `total` | number | | Rows matching the query across all pages |\n| `page_size` | number | | |\n| `items` | object[] | yes | Rows as KiotViet returns them |\n| `removed_ids` | number[] | | |\n\n### kiotviet_update_category (workflow step)\n\n- Rename a KiotViet product group or move it under another parent.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | KiotViet connected account |\n| `id` | number | yes | |\n| `name` | string | | |\n| `parent_id` | number | | |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `category` | object | yes | |\n\n### kiotviet_update_customer (workflow step)\n\n- Update a KiotViet customer by id.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | KiotViet connected account |\n| `id` | number | yes | |\n| `name` | string | | |\n| `code` | string | | Customer code (m\xE3 kh\xE1ch h\xE0ng) |\n| `contact_number` | string | | |\n| `email` | string | | |\n| `address` | string | | |\n| `location_name` | string | | Province/district as KiotViet names it |\n| `ward_name` | string | | |\n| `gender` | boolean | | true for male, false for female |\n| `birth_date` | string | | yyyy-mm-dd |\n| `group_ids` | number[] | | Customer group ids |\n| `comments` | string | | |\n| `branch_id` | number | | |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `customer` | object | yes | |\n\n### kiotviet_update_invoice (workflow step)\n\n- Update a KiotViet sales invoice by id.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | KiotViet connected account |\n| `id` | number | yes | |\n| `branch_id` | number | | |\n| `customer_id` | number | | |\n| `sold_by_id` | number | | KiotViet user id of the seller |\n| `purchase_date` | string | | ISO datetime |\n| `description` | string | | |\n| `discount` | number | | Discount amount on the whole document |\n| `lines` | object[] | | |\n| `lines[].product_id` | number | yes | |\n| `lines[].quantity` | number | yes | |\n| `lines[].price` | number | | Unit price |\n| `lines[].discount` | number | | Discount amount on the line |\n| `lines[].note` | string | | |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `invoice` | object | yes | |\n\n### kiotviet_update_order (workflow step)\n\n- Update a KiotViet sales order by id.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | KiotViet connected account |\n| `id` | number | yes | |\n| `branch_id` | number | | |\n| `customer_id` | number | | |\n| `sold_by_id` | number | | KiotViet user id of the seller |\n| `purchase_date` | string | | ISO datetime |\n| `description` | string | | |\n| `discount` | number | | Discount amount on the whole document |\n| `lines` | object[] | | |\n| `lines[].product_id` | number | yes | |\n| `lines[].quantity` | number | yes | |\n| `lines[].price` | number | | Unit price |\n| `lines[].discount` | number | | Discount amount on the line |\n| `lines[].note` | string | | |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `order` | object | yes | |\n\n### kiotviet_update_product (workflow step)\n\n- Update a KiotViet product by id; inventories set the stock level per branch.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | KiotViet connected account |\n| `id` | number | yes | |\n| `name` | string | | |\n| `code` | string | | Product code (m\xE3 h\xE0ng) |\n| `category_id` | number | | Product group id |\n| `base_price` | number | | Selling price |\n| `unit` | string | | |\n| `allows_sale` | boolean | | |\n| `is_active` | boolean | | |\n| `description` | string | | |\n| `weight` | number | | Grams |\n| `inventories` | object[] | | Stock per branch |\n| `inventories[].branch_id` | number | yes | |\n| `inventories[].on_hand` | number | yes | |\n| `inventories[].cost` | number | | Unit cost at this branch |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `product` | object | yes | |\n\n## lark\n\n### lark_create_records (workflow step)\n\n- Create one or many records in a Lark Base (Bitable) table (max 500 per call). fields are keyed by Lark field name.\n- Returns the new record ids.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | Lark connected account |\n| `app_token` | string | yes | Lark Base app_token (the Base id) |\n| `table_id` | string | yes | Lark Bitable table id |\n| `records` | object[] | yes | |\n| `records[].fields` | object | yes | |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `created` | number | yes | |\n| `records` | object[] | yes | |\n| `records[].record_id` | string | yes | |\n| `records[].fields` | object | yes | |\n\n### lark_delete_records (workflow step)\n\n- Delete one or many records from a Lark Base (Bitable) table by record_id (max 500 per call).\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | Lark connected account |\n| `app_token` | string | yes | Lark Base app_token (the Base id) |\n| `table_id` | string | yes | Lark Bitable table id |\n| `record_ids` | string[] | yes | |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `deleted` | number | yes | |\n| `record_ids` | string[] | yes | |\n\n### lark_get_record (workflow step)\n\n- Get one record from a Lark Base (Bitable) table by its record_id.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | Lark connected account |\n| `app_token` | string | yes | Lark Base app_token (the Base id) |\n| `table_id` | string | yes | Lark Bitable table id |\n| `record_id` | string | yes | |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `record_id` | string | yes | |\n| `fields` | object | yes | |\n\n### lark_list_fields (workflow step)\n\n- List the fields (columns) of a Lark Base (Bitable) table \u2014 name, id, and type.\n- Use to discover the schema before reading or writing records.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | Lark connected account |\n| `app_token` | string | yes | Lark Base app_token (the Base id) |\n| `table_id` | string | yes | Lark Bitable table id |\n| `page_size` | number | | |\n| `page_token` | string | | |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `fields` | object[] | yes | |\n| `fields[].field_id` | string | | |\n| `fields[].field_name` | string | | |\n| `fields[].type` | number | | |\n| `fields[].ui_type` | string | | |\n| `fields[].is_primary` | boolean | | |\n| `has_more` | boolean | yes | |\n| `page_token` | string | | |\n\n### lark_list_records (workflow step)\n\n- List records from a Lark Base (Bitable) table.\n- Returns each record\'s id and fields (keyed by Lark field name).\n- Optionally narrow with filter / sort / field_names / view_id; paginate with page_token.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | Lark connected account |\n| `app_token` | string | yes | Lark Base app_token (the Base id) |\n| `table_id` | string | yes | Lark Bitable table id |\n| `filter` | object | | |\n| `filter.conjunction` | "and" \\\\| "or" | yes | |\n| `filter.conditions` | object[] | yes | |\n| `filter.conditions[].field_name` | string | yes | |\n| `filter.conditions[].operator` | string | yes | e.g. is, isNot, contains, isGreater, isEmpty |\n| `filter.conditions[].value` | string[] | | |\n| `sort` | object[] | | |\n| `sort[].field_name` | string | yes | |\n| `sort[].desc` | boolean | | |\n| `field_names` | string[] | | Restrict returned fields by name |\n| `view_id` | string | | |\n| `page_size` | number | | |\n| `page_token` | string | | |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `records` | object[] | yes | |\n| `records[].record_id` | string | yes | |\n| `records[].fields` | object | yes | |\n| `has_more` | boolean | yes | |\n| `page_token` | string | | |\n| `total` | number | | |\n\n### lark_list_tables (workflow step)\n\n- List the tables in a Lark Base (Bitable) \u2014 id and name.\n- Use to discover which table_id to read or write.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | Lark connected account |\n| `app_token` | string | yes | Lark Base app_token (the Base id) |\n| `page_size` | number | | |\n| `page_token` | string | | |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `tables` | object[] | yes | |\n| `tables[].table_id` | string | | |\n| `tables[].name` | string | | |\n| `has_more` | boolean | yes | |\n| `page_token` | string | | |\n\n### lark_update_records (workflow step)\n\n- Update one or many existing records in a Lark Base (Bitable) table by record_id (max 500 per call). fields are keyed by Lark field name; only provided fields change.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | Lark connected account |\n| `app_token` | string | yes | Lark Base app_token (the Base id) |\n| `table_id` | string | yes | Lark Bitable table id |\n| `records` | object[] | yes | |\n| `records[].record_id` | string | yes | |\n| `records[].fields` | object | yes | |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `updated` | number | yes | |\n| `records` | object[] | yes | |\n| `records[].record_id` | string | yes | |\n| `records[].fields` | object | yes | |\n\n## linkedin\n\n### linkedin_create_post (workflow step)\n\n- Publish a post to the connected LinkedIn member\'s profile.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | |\n| `text` | string | yes | |\n| `link` | string | | Shown as an article card; needs link_title. A post carries either a link or media. |\n| `link_title` | string | | |\n| `media_file_ids` | string[] | | Up to 20 images, or one video. |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `post_id` | string | yes | |\n| `url` | string | yes | |\n\n## list\n\n### list_banks (workflow step)\n\n- List banks supported by generate_bank_qr_code. (workflow step, chat)\n- Returns the bank code (used as input to the generator), display name, and country.\n- Call this before generate_bank_qr_code to discover valid codes. (workflow step, chat)\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `country` | "VN" | | Filter to banks from a specific country. Omit to list all supported banks. |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `banks` | object[] | yes | |\n| `banks[].country` | string | yes | |\n| `banks[].code` | string | yes | |\n| `banks[].bin` | string | yes | |\n| `banks[].short_name` | string | yes | |\n| `banks[].full_name` | string | yes | |\n\n## lock\n\n### lock_records (workflow step)\n\n- Lock records to prevent editing.\n- Returns `{ locked, record_ids }`.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `table_id` | string | yes | |\n| `record_ids` | string[] | | |\n| `filters` | any | | |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `locked` | number | yes | |\n| `record_ids` | string[] | yes | |\n\n## lookup\n\n### lookup_business (workflow step)\n\n- Look up business registration info by tax / registration code.\n- Defaults to Vietnam (country=\'VN\').\n- A VN registered name ending in "(NTNN)" marks a code for paying a foreign contractor\'s tax on the company\'s behalf, not the company\'s own code.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `tax_code` | string | yes | Business tax / registration code. Format varies by country; for VN this is a 10\u201313 digit m\xE3 s\u1ED1 thu\u1EBF. |\n| `country` | string | | ISO country code. Defaults to \'VN\' (Vietnam). Only \'VN\' is supported today. |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `country` | string | yes | |\n| `tax_code` | string | yes | |\n| `name` | string | yes | |\n| `address` | string | yes | |\n| `representative` | string \\\\| null | yes | |\n| `status` | string \\\\| null | yes | |\n| `international_name` | string \\\\| null | yes | |\n| `short_name` | string \\\\| null | yes | |\n| `operating_since` | string \\\\| null | yes | |\n| `managed_by` | string \\\\| null | yes | |\n| `company_type` | string \\\\| null | yes | |\n| `primary_industry` | string \\\\| null | yes | |\n\n## misa\n\n### misa_get_dictionary (workflow step)\n\n- Read master-data records from MISA AMIS to look up codes (customer code, item code, warehouse code, etc.) before pushing a voucher.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | MISA connected account to read from |\n| `data_type` | 1 \\\\| 2 \\\\| 3 \\\\| 4 \\\\| 5 \\\\| 6 \\\\| 8 \\\\| 9 \\\\| 10 \\\\| 11 \\\\| 12 | yes | 1 objects (customers/suppliers/employees), 2 inventory items, 3 stocks, 4 units, 5 chart of accounts, 6 organization units, 8 bank accounts, 9 projects, 10 cost objects, 11 payment terms, 12 banks |\n| `skip` | integer | | |\n| `take` | integer | | Max 100 per page |\n| `last_sync_time` | string | | ISO timestamp \u2014 only return records changed since this time |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `success` | boolean | yes | |\n| `data` | object[] | yes | The dictionary records, each as MISA names its fields |\n| `last_sync_time` | string | | Cursor \u2014 pass as last_sync_time on the next call to fetch only newer changes |\n| `error_code` | string | | |\n| `error_message` | string | | |\n\n### misa_save_bank_voucher (workflow step)\n\n- Push a bank voucher (deposit / withdrawal / transfer) into MISA AMIS. voucher_type: 1 deposit (b\xE1o c\xF3), 3 withdrawal/debit-advice (b\xE1o n\u1EE3), 2 internal transfer. bank_account_id is the company-side bank account GUID \u2014 look it up with misa_get_dictionary (data_type 8). (workflow step, chat)\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `voucher_type` | 1 \\\\| 2 \\\\| 3 | yes | |\n| `reftype` | integer | | |\n| `org_refid` | string | yes | a UUID that stays the same for the document \u2014 `uuidFrom(record.id)` |\n| `org_refno` | string | | Source-system document number |\n| `refdate` | string | yes | Document date, ISO 8601 |\n| `posted_date` | string | yes | Accounting posting date, ISO 8601 |\n| `branch_id` | string | | MISA branch GUID, optional for single-branch tenants |\n| `currency_id` | string | | Currency code, default VND |\n| `exchange_rate` | number | | FX rate, default 1.0 |\n| `journal_memo` | string | | Voucher memo/notes |\n| `custom_field1` | string | | |\n| `custom_field2` | string | | |\n| `custom_field3` | string | | |\n| `custom_field4` | string | | |\n| `custom_field5` | string | | |\n| `bank_account_id` | string | yes | Bank account GUID in MISA \u2014 look up via misa_get_dictionary (workflow step, chat) |\n| `account_object_code` | string | | |\n| `account_object_name` | string | | |\n| `total_amount_oc` | number | yes | |\n| `total_amount` | number | yes | |\n| `detail` | object[] | yes | |\n| `detail[].description` | string | yes | |\n| `detail[].amount_oc` | number | yes | |\n| `detail[].amount` | number | yes | |\n| `detail[].debit_account` | string | yes | |\n| `detail[].credit_account` | string | yes | |\n| `detail[].sort_order` | integer | | |\n| `connected_account_id` | string | yes | MISA connected account to push to |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `queued` | boolean | yes | |\n| `org_refid` | string | yes | |\n| `error_code` | string | | |\n| `error_message` | string | | |\n\n### misa_save_cash_voucher (workflow step)\n\n- Push a cash voucher (cash receipt or cash payment) into MISA AMIS. voucher_type: 5 receipt (thu ti\u1EC1n), 4 payment (chi ti\u1EC1n). detail array carries the journal lines with debit_account/credit_account per Vietnamese chart-of-accounts.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `voucher_type` | 4 \\\\| 5 | yes | |\n| `reftype` | integer | | |\n| `org_refid` | string | yes | a UUID that stays the same for the document \u2014 `uuidFrom(record.id)` |\n| `org_refno` | string | | Source-system document number |\n| `refdate` | string | yes | Document date, ISO 8601 |\n| `posted_date` | string | yes | Accounting posting date, ISO 8601 |\n| `branch_id` | string | | MISA branch GUID, optional for single-branch tenants |\n| `currency_id` | string | | Currency code, default VND |\n| `exchange_rate` | number | | FX rate, default 1.0 |\n| `journal_memo` | string | | Voucher memo/notes |\n| `custom_field1` | string | | |\n| `custom_field2` | string | | |\n| `custom_field3` | string | | |\n| `custom_field4` | string | | |\n| `custom_field5` | string | | |\n| `account_object_code` | string | | Counterparty code (customer/supplier/employee) |\n| `account_object_name` | string | | |\n| `total_amount_oc` | number | yes | |\n| `total_amount` | number | yes | |\n| `detail` | object[] | yes | |\n| `detail[].description` | string | yes | |\n| `detail[].amount_oc` | number | yes | |\n| `detail[].amount` | number | yes | |\n| `detail[].debit_account` | string | yes | |\n| `detail[].credit_account` | string | yes | |\n| `detail[].sort_order` | integer | | |\n| `connected_account_id` | string | yes | MISA connected account to push to |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `queued` | boolean | yes | |\n| `org_refid` | string | yes | |\n| `error_code` | string | | |\n| `error_message` | string | | |\n\n### misa_save_dictionary (workflow step)\n\n- Create or update master-data records in MISA AMIS (customers, suppliers, items, warehouses, etc.).\n- Use this before pushing a voucher that references a code MISA doesn\'t yet know about.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | MISA connected account to push to |\n| `dictionary_type` | 1 \\\\| 2 \\\\| 3 \\\\| 4 \\\\| 5 \\\\| 6 \\\\| 7 \\\\| 8 \\\\| 9 \\\\| 10 \\\\| 12 | yes | 1 customers/suppliers/employees, 2 object groups, 3 inventory items, 4 item categories, 5 warehouses, 6 units, 7 bank accounts, 8 banks, 9 expense items, 10 revenue/expense categories, 12 cost allocation |\n| `items` | object[] | yes | Master-data records to create or update. 1\u2013200 per call. Each item\'s required fields depend on dictionary_type \u2014 see MISA Open API docs (chat, MCP, CLI) |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `queued` | boolean | yes | |\n| `count` | integer | yes | |\n| `error_code` | string | | |\n| `error_message` | string | | |\n\n### misa_save_purchase_voucher (workflow step)\n\n- Push a purchase voucher (purchase invoice / return / discount-debit-note-to-supplier / service / general purchase / purchase order) into MISA AMIS. voucher_type: 15 invoice, 18 voucher, 17 service, 16 return, 14 discount (debit note to supplier), 21 purchase order. account_object_code identifies the supplier in MISA \u2014 must already exist.\n- MISA sync ack only confirms queueing; final accept/reject arrives async.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `voucher_type` | 14 \\\\| 15 \\\\| 16 \\\\| 17 \\\\| 18 \\\\| 21 | yes | |\n| `reftype` | integer | | |\n| `org_refid` | string | yes | a UUID that stays the same for the document \u2014 `uuidFrom(record.id)` |\n| `org_refno` | string | | Source-system document number |\n| `refdate` | string | yes | Document date, ISO 8601 |\n| `posted_date` | string | yes | Accounting posting date, ISO 8601 |\n| `branch_id` | string | | MISA branch GUID, optional for single-branch tenants |\n| `currency_id` | string | | Currency code, default VND |\n| `exchange_rate` | number | | FX rate, default 1.0 |\n| `journal_memo` | string | | Voucher memo/notes |\n| `custom_field1` | string | | |\n| `custom_field2` | string | | |\n| `custom_field3` | string | | |\n| `custom_field4` | string | | |\n| `custom_field5` | string | | |\n| `account_object_code` | string | yes | Supplier code in MISA |\n| `account_object_name` | string | | |\n| `account_object_tax_code` | string | | |\n| `account_object_address` | string | | |\n| `total_amount_oc` | number | yes | |\n| `total_amount` | number | yes | |\n| `total_vat_amount_oc` | number | yes | |\n| `total_vat_amount` | number | yes | |\n| `detail` | object[] | yes | |\n| `detail[].inventory_item_code` | string | | Item/product code in MISA. Skip when is_description=true |\n| `detail[].inventory_item_name` | string | yes | Item/product display name |\n| `detail[].inventory_item_type` | 0 \\\\| 1 \\\\| 2 \\\\| 3 | | Item type \u2014 0 goods, 1 finished, 2 service, 3 raw material |\n| `detail[].description` | string | | Line description |\n| `detail[].is_description` | boolean | | Description-only line \u2014 when true, only `description` is required |\n| `detail[].stock_code` | string | | Warehouse code in MISA |\n| `detail[].unit_name` | string | | Unit of measure name |\n| `detail[].quantity` | number | yes | Line quantity |\n| `detail[].unit_price` | number | yes | Unit price (in currency_id of voucher) |\n| `detail[].amount_oc` | number | yes | Line total in original currency |\n| `detail[].amount` | number | yes | Line total in accounting currency (= amount_oc when VND) |\n| `detail[].discount_rate` | number | | Line discount percent |\n| `detail[].discount_amount_oc` | number | | Discount amount, original currency |\n| `detail[].discount_amount` | number | | Discount amount, accounting currency |\n| `detail[].vat_rate` | number | yes | VAT percent. 0/5/8/10 for standard, -1 exempt, -2 not creditable, -3 other (set other_vat_rate) |\n| `detail[].other_vat_rate` | number | | Custom VAT percent \u2014 required when vat_rate=-3 |\n| `detail[].vat_amount_oc` | number | yes | VAT amount, original currency |\n| `detail[].vat_amount` | number | yes | VAT amount, accounting currency |\n| `detail[].debit_account` | string | yes | Chart-of-accounts code on debit side, e.g. 131 |\n| `detail[].credit_account` | string | yes | Chart-of-accounts code on credit side, e.g. 511 |\n| `detail[].sale_account` | string | | |\n| `detail[].vat_account` | string | | |\n| `detail[].inventory_account` | string | | |\n| `detail[].sort_order` | integer | | |\n| `detail[].lot_no` | string | | |\n| `detail[].expiry_date` | string | | ISO date |\n| `detail[].organization_unit_code` | string | | Department/branch code |\n| `connected_account_id` | string | yes | MISA connected account to push to |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `queued` | boolean | yes | |\n| `org_refid` | string | yes | |\n| `error_code` | string | | |\n| `error_message` | string | | |\n\n### misa_save_sales_voucher (workflow step)\n\n- Push a sales voucher (invoice / sales return / discount-credit-note / sales order) into MISA AMIS. voucher_type: 11 invoice, 13 sales voucher, 12 return, 10 discount/credit note, 20 sales order. reftype refines the sub-type (e.g. 3530 unpaid sale, 3560 sales invoice, 3571 service cash). account_object_code identifies the customer in MISA \u2014 must already exist (use misa_save_dictionary first if not). (workflow step, chat)\n- MISA sync ack only confirms queueing; final accept/reject arrives async on the registered callback URL.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `voucher_type` | 10 \\\\| 11 \\\\| 12 \\\\| 13 \\\\| 20 | yes | |\n| `reftype` | integer | | Voucher sub-type code \u2014 MISA assigns a default when omitted |\n| `org_refid` | string | yes | a UUID that stays the same for the document \u2014 `uuidFrom(record.id)` |\n| `org_refno` | string | | Source-system document number |\n| `refdate` | string | yes | Document date, ISO 8601 |\n| `posted_date` | string | yes | Accounting posting date, ISO 8601 |\n| `branch_id` | string | | MISA branch GUID, optional for single-branch tenants |\n| `currency_id` | string | | Currency code, default VND |\n| `exchange_rate` | number | | FX rate, default 1.0 |\n| `journal_memo` | string | | Voucher memo/notes |\n| `custom_field1` | string | | |\n| `custom_field2` | string | | |\n| `custom_field3` | string | | |\n| `custom_field4` | string | | |\n| `custom_field5` | string | | |\n| `account_object_code` | string | yes | Customer code in MISA |\n| `account_object_name` | string | | |\n| `account_object_tax_code` | string | | |\n| `account_object_address` | string | | |\n| `employee_code` | string | | Salesperson code |\n| `employee_name` | string | | |\n| `total_sale_amount_oc` | number | yes | |\n| `total_sale_amount` | number | yes | |\n| `total_discount_amount_oc` | number | | |\n| `total_discount_amount` | number | | |\n| `total_vat_amount_oc` | number | yes | |\n| `total_vat_amount` | number | yes | |\n| `total_amount_oc` | number | yes | |\n| `total_amount` | number | yes | |\n| `is_sale_with_outward` | boolean | | Auto-generate stock-out slip |\n| `detail` | object[] | yes | |\n| `detail[].inventory_item_code` | string | | Item/product code in MISA. Skip when is_description=true |\n| `detail[].inventory_item_name` | string | yes | Item/product display name |\n| `detail[].inventory_item_type` | 0 \\\\| 1 \\\\| 2 \\\\| 3 | | Item type \u2014 0 goods, 1 finished, 2 service, 3 raw material |\n| `detail[].description` | string | | Line description |\n| `detail[].is_description` | boolean | | Description-only line \u2014 when true, only `description` is required |\n| `detail[].stock_code` | string | | Warehouse code in MISA |\n| `detail[].unit_name` | string | | Unit of measure name |\n| `detail[].quantity` | number | yes | Line quantity |\n| `detail[].unit_price` | number | yes | Unit price (in currency_id of voucher) |\n| `detail[].amount_oc` | number | yes | Line total in original currency |\n| `detail[].amount` | number | yes | Line total in accounting currency (= amount_oc when VND) |\n| `detail[].discount_rate` | number | | Line discount percent |\n| `detail[].discount_amount_oc` | number | | Discount amount, original currency |\n| `detail[].discount_amount` | number | | Discount amount, accounting currency |\n| `detail[].vat_rate` | number | yes | VAT percent. 0/5/8/10 for standard, -1 exempt, -2 not creditable, -3 other (set other_vat_rate) |\n| `detail[].other_vat_rate` | number | | Custom VAT percent \u2014 required when vat_rate=-3 |\n| `detail[].vat_amount_oc` | number | yes | VAT amount, original currency |\n| `detail[].vat_amount` | number | yes | VAT amount, accounting currency |\n| `detail[].debit_account` | string | yes | Chart-of-accounts code on debit side, e.g. 131 |\n| `detail[].credit_account` | string | yes | Chart-of-accounts code on credit side, e.g. 511 |\n| `detail[].sale_account` | string | | |\n| `detail[].vat_account` | string | | |\n| `detail[].inventory_account` | string | | |\n| `detail[].sort_order` | integer | | |\n| `detail[].lot_no` | string | | |\n| `detail[].expiry_date` | string | | ISO date |\n| `detail[].organization_unit_code` | string | | Department/branch code |\n| `connected_account_id` | string | yes | MISA connected account to push to |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `queued` | boolean | yes | |\n| `org_refid` | string | yes | |\n| `error_code` | string | | |\n| `error_message` | string | | |\n\n## outlook\n\n### outlook_count_emails (workflow step)\n\n- Count Outlook emails matching a filter or search query.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | The Lotics connected account ID (cac_xxx), not the Microsoft user ID |\n| `search` | string | | KQL expression |\n| `filter` | string | | OData expression |\n| `folder` | string | | Mail folder: well-known name or folder ID |\n| `user_id` | string | | Mailbox owner user ID. |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `count` | number | yes | Number of matching emails |\n\n### outlook_query_emails (workflow step)\n\n- Search and filter Outlook emails.\n- Two modes: search (KQL keywords) or structured filters (from, to, subject, dates, etc.).\n- When search is provided, structured filters are ignored. ## KQL search syntax (for the search field) Bare keywords search across from, subject, and body.\n- Property restrictions (no space after colon): - People: from:, to:, cc:, bcc:, participants: (all people fields), recipients: (to+cc+bcc) - Content: subject:, body:, "exact phrase" - Attachments: hasAttachments:true, attachment:filename* - Dates: received:2024-01-01, received:2024-01-01..2024-01-31, received>=2024-01-01, received:today, received:"this week", sent:2024-06-01 - Size (bytes): size>1048576, size:1..10485760 - Status: importance:high, isRead:false, kind:email Combining (UPPERCASE required): AND, OR, NOT, - (exclude), () for grouping.\n- Prefix wildcard: subject:set* (end of word only, no *prefix or *mid*dle).\n- Examples: - from:john@contoso.com AND subject:"quarterly report" - participants:alice importance:high hasAttachments:true - body:contract AND received>=2024-01-01 AND received<=2024-06-30 - (from:legal OR from:compliance) AND subject:contract - attachment:annual* received:"this month"\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | The Lotics connected account ID (cac_xxx), not the Microsoft user ID |\n| `search` | string | | KQL search query \u2014 overrides all structured filter fields when provided |\n| `from` | string | | Sender email address exact match |\n| `to` | string | | Recipient email address exact match |\n| `subject` | string | | Subject starts with this text |\n| `after` | string | | ISO date \u2014 received on or after |\n| `before` | string | | ISO date \u2014 received before |\n| `is_read` | boolean | | |\n| `is_draft` | boolean | | |\n| `has_attachments` | boolean | | |\n| `importance` | "low" \\\\| "normal" \\\\| "high" | | |\n| `is_flagged` | boolean | | Whether the email is flagged for follow-up |\n| `classification` | "focused" \\\\| "other" | | Focused Inbox classification |\n| `category` | string | | Color category name |\n| `conversation_id` | string | | Outlook conversation ID \u2014 retrieves all messages in a thread |\n| `folder` | string | | Mail folder: well-known name (inbox, sentitems, drafts, deleteditems, junkemail, archive) or folder ID |\n| `skip` | number | | Number of results to skip for pagination. |\n| `max_result` | number | yes | Maximum number of emails to retrieve (1-50) |\n| `user_id` | string | | The ID of the user whose mailbox the email belongs to. If not provided, the connected account\'s user ID (me) will be used. |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `messages` | object[] | yes | List of matching Outlook messages |\n| `messages[].id` | string | yes | Outlook message ID |\n| `messages[].date` | string | yes | Email date in the workspace timezone, with its offset |\n| `messages[].from` | string | yes | Sender email address |\n| `messages[].subject` | string | yes | Email subject |\n| `messages[].to` | string | yes | Recipient email address |\n| `messages[].cc` | string \\\\| null | yes | CC recipients |\n| `messages[].bcc` | string \\\\| null | yes | BCC recipients |\n| `messages[].snippet` | string | yes | Short plain-text preview of the email body (first ~255 chars) |\n| `messages[].conversationId` | string | | Outlook conversation ID |\n| `messages[].receivedDateTime` | string | | Received date-time in ISO format |\n| `messages[].hasAttachments` | boolean | | Whether the email has attachments |\n| `messages[].importance` | string | | Email importance level |\n| `messages[].isRead` | boolean | | Whether the email has been read |\n| `messages[].isDraft` | boolean | | Whether the email is a draft |\n| `messages[].flagStatus` | string | | Flag status: notFlagged, complete, or flagged |\n| `messages[].classification` | string | | Focused Inbox classification: focused or other |\n| `messages[].categories` | string[] | | Color categories assigned to the email |\n\n### outlook_query_folders (workflow step)\n\n- List mail folders in an Outlook mailbox.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | The Lotics connected account ID (cac_xxx), not the Microsoft user ID |\n| `parent_folder_id` | string | | Parent folder ID to list child folders. Omit for top-level folders. |\n| `name` | string | | Match folders by display name prefix. |\n| `include_hidden` | boolean | | Include hidden system folders |\n| `max_result` | number | | Maximum number of folders to return (1-100) |\n| `skip` | number | | Number of results to skip for pagination |\n| `user_id` | string | | The ID of the user whose mailbox to query. Defaults to the connected account owner. |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `folders` | object[] | yes | List of mail folders |\n| `folders[].id` | string | yes | Folder ID |\n| `folders[].displayName` | string | yes | Folder display name |\n| `folders[].parentFolderId` | string | | Parent folder ID |\n| `folders[].childFolderCount` | number | yes | Number of child folders |\n| `folders[].totalItemCount` | number | yes | Total number of items in the folder |\n| `folders[].unreadItemCount` | number | yes | Number of unread items |\n| `folders[].isHidden` | boolean | yes | Whether the folder is hidden |\n\n### outlook_read_email (workflow step)\n\n- Fetch an Outlook email\'s body and the list of its attachments.\n- Attachments are stored as workspace files \u2014 the result names each one\'s file_id; read one with view_files, attach one to a record with update_records. (chat, MCP, CLI)\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | The Lotics connected account ID (cac_xxx), not the Microsoft user ID |\n| `message_id` | string | yes | The ID of the Outlook message to retrieve |\n| `user_id` | string | | The ID of the user whose mailbox the email belongs to. If not provided, the connected account\'s user ID (me) will be used. |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `message` | object | yes | The full Outlook message |\n| `message.id` | string | | Outlook message ID |\n| `message.date` | string | yes | Email date in the workspace timezone, with its offset |\n| `message.from` | string | yes | Sender email address |\n| `message.subject` | string | yes | Email subject |\n| `message.to` | string | yes | Recipient email address |\n| `message.cc` | string \\\\| null | yes | CC recipients |\n| `message.bcc` | string \\\\| null | yes | BCC recipients |\n| `message.inReplyTo` | string \\\\| null | yes | In-Reply-To header |\n| `message.replyTo` | string \\\\| null | yes | Reply-To header |\n| `message.references` | string[] \\\\| null | yes | References header |\n| `message.conversationId` | string | | Outlook conversation ID |\n| `message.receivedDateTime` | string | | Received date-time in ISO format |\n| `message.hasAttachments` | boolean | | Whether the email has attachments |\n| `message.importance` | string | | Email importance level |\n| `message.isRead` | boolean | | Whether the email has been read |\n| `message.body` | object | yes | Email body |\n| `message.body.content` | string | yes | Body content |\n| `message.body.contentType` | "text" \\\\| "html" | yes | Body content type |\n| `message.attachments` | object[] | | Email attachments |\n| `message.attachments[].id` | string | yes | Outlook attachment ID |\n| `message.attachments[].fileName` | string | | Attachment filename as stored, which may differ from the sender\'s |\n| `message.attachments[].contentType` | string | | MIME type as stored, recovered from the filename when Graph declared a generic one |\n| `message.attachments[].size` | number | | Stored size in bytes |\n| `message.attachments[].file_id` | string | | Stored file ID \u2014 pass to view_files to read it, or to update_records to attach it (chat, MCP, CLI) |\n\n### outlook_reply_email (workflow step)\n\n- Draft or send a reply to an Outlook email.\n- Use reply_body (markdown) or template_id + template_data \u2014 not both.\n- Attach stored files by passing their file_ids.\n- Leaves an unsent draft unless draft is false.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | The Lotics connected account ID (cac_xxx), not the Microsoft user ID |\n| `original_message_id` | string | yes | |\n| `reply_body` | string | | Reply body (markdown). Mutually exclusive with template_id. |\n| `template_id` | string | | |\n| `template_data` | object | | |\n| `cc` | string | | CC recipients, comma-separated |\n| `bcc` | string | | BCC recipients, comma-separated |\n| `draft` | boolean | | Leave true to save an unsent draft the member reviews. Pass false only to deliver the message now \u2014 delivery is irreversible. |\n| `file_ids` | string[] | yes | |\n| `user_id` | string | | Mailbox user ID |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `message_id` | string | yes | The ID of the sent message or saved draft |\n| `subject` | string | yes | The subject as sent |\n| `html` | string | yes | The body as sent, rendered to HTML |\n| `markdown` | string | | The body as written in markdown; absent when a template rendered it |\n| `to` | string | yes | The original sender the reply went to |\n\n### outlook_send_email (workflow step)\n\n- Draft or send an Outlook email.\n- Use content (markdown) or template_id + template_data \u2014 not both.\n- Attach stored files by passing their file_ids.\n- Leaves an unsent draft unless draft is false, and while drafting \'to\' may be omitted to leave the recipient line for the member to fill in.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | The Lotics connected account ID (cac_xxx), not the Microsoft user ID |\n| `to` | string | | Recipient email(s), comma-separated. Required unless using a template. |\n| `subject` | string | | |\n| `cc` | string | | CC recipients, comma-separated |\n| `bcc` | string | | BCC recipients, comma-separated |\n| `content` | string | | Email body (markdown). Mutually exclusive with template_id. |\n| `template_id` | string | | |\n| `template_data` | object | | |\n| `draft` | boolean | | Leave true to save an unsent draft the member reviews. Pass false only to deliver the message now \u2014 delivery is irreversible. |\n| `file_ids` | string[] | yes | |\n| `user_id` | string | | Mailbox user ID |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `message_id` | string | yes | The ID of the sent message or saved draft |\n| `subject` | string | yes | The subject as sent |\n| `html` | string | yes | The body as sent, rendered to HTML |\n| `markdown` | string | | The body as written in markdown; absent when a template rendered it |\n| `to` | string \\\\| null | yes | The recipients as sent, comma-separated; null on a draft saved without recipients |\n\n## press\n\n### press_button (workflow step)\n\n- Run a button field\'s action against a record \u2014 equivalent to a user clicking the button in the UI.\n- Buttons are a legacy field type; the action must already be wired.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `table_id` | string | yes | |\n| `record_id` | string | yes | |\n| `field_key` | string | yes | |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `execution_id` | string | | |\n| `status` | "success" \\\\| "error" | | |\n| `message` | string | | |\n\n## rename\n\n### rename_file (workflow step)\n\n- Get a file under another name: a new file over the same bytes.\n- Write its file_id into the files field in place of the old one; every other place holding the old file keeps its name.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `file_id` | string | yes | |\n| `filename` | string | yes | The whole new name, keeping the file\'s extension exactly. |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `file_id` | string | yes | The ID of the generated file. |\n| `url` | string | yes | The download URL of the generated file. |\n| `filename` | string | yes | The filename of the generated file, including extension. |\n| `mime_type` | string | yes | The MIME type of the generated file. |\n\n## request\n\n### request_locked_record_change (workflow step)\n\n- Submit one change request to change locked field values on a record.\n- Include every blocked field in the same call \u2014 the approver accepts or rejects the change set as a whole.\n- Values are NOT changed immediately; an approver must accept the request first.\n- Returns `{ request_id, status }`.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `table_id` | string | yes | |\n| `record_id` | string | yes | |\n| `changes` | object | yes | Map of field_key to proposed new value. Every key must be locked on this record. |\n| `reason` | string | yes | |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `request_id` | string | yes | |\n| `status` | "pending" | yes | |\n\n## save\n\n### save_file (workflow step)\n\n- Save a file from a URL to the workspace.\n- Max 20MB.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `url` | string | yes | Public URL to download the file from (https:// or http://). |\n| `filename` | string | | Filename with extension, e.g. \'report.pdf\'. Derived from URL if omitted. |\n| `mime_type` | string | | MIME type, e.g. \'application/pdf\'. Derived from URL response if omitted. |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `id` | string | yes | File ID. |\n| `filename` | string | yes | |\n| `mime_type` | string | yes | |\n| `url` | string | yes | |\n\n### save_record (workflow step)\n\n- Save a record found by its identity, with its lines, all or nothing.\n- A call whose match is carried by no live record adds it; one carried by a record changes the cells of set that differ and appends add_to, so sending the same call twice writes nothing the second time. match holds the record\'s identity: field keys with their values, exactly the fields of one uniqueness its table declares (a unique field, or fields unique together). set holds its other cells. add_to lists items to append to a files, multi-select or many-link field, keeping what it holds. lines saves rows of other tables that link the record.\n- Each entry names the child table_id, its one-row link field to this table, match (the child fields that with link are one uniqueness of the child table) and rows, each stating every match field. link is set by the step and no row states it.\n- A line found by its match changes the cells that differ; one not found is added; a line not listed is left as it is.\n- Any refusal \u2014 a table check, a locked record, a value a field does not take, no write access to a table \u2014 saves nothing.\n- Returns { record_id, created, updated_field_keys, lines }: the cells changed on a record that existed, and per entry of lines the ids it added, changed and left unchanged.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `table_id` | string | yes | |\n| `match` | object | yes | |\n| `set` | object \\\\| null | | |\n| `add_to` | object \\\\| null | | |\n| `lines` | object[] \\\\| null | | |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `record_id` | string | yes | |\n| `created` | boolean | yes | |\n| `updated_field_keys` | string[] | yes | |\n| `lines` | object[] | yes | |\n| `lines[].table_id` | string | yes | |\n| `lines[].created_ids` | string[] | yes | |\n| `lines[].updated_ids` | string[] | yes | |\n| `lines[].unchanged_ids` | string[] | yes | |\n\n## send\n\n### send_notification (workflow step)\n\n- Notify workspace members.\n- Lotics shows it to each recipient and emails it to their own address, through no connection; a member who signs in with an identifier an admin issued has no mailbox and sees it in Lotics alone.\n- A member is named by the member_id get_workspace kind member lists. (chat, MCP, CLI)\n- In a workflow body, every member is { type: "organization", id: runtime.organization_id } and the member who started the run { type: "member", id: runtime.triggered_by_member_id }; a run a schedule, a webhook or an email starts was started by no member. blocks draw under the message: text, stat, chart, fields, link, and record (table_id and record_id; the card shows the record\'s own title, read as the sender can read it). actions are buttons: each runs workflow_id under its owner\'s access when pressed, and its owner or an admin may name it.\n- A workflow a card can run declares notification inputs. inputs are the values the sender fixes; asks are the values the presser answers, each ask key an input of the workflow that inputs does not fix; every required input of the workflow is fixed or asked as required. decision is "any" (one decision for all recipients: the first press decides it) or "each" (every recipient decides alone); it is required with actions and refused without.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `recipients` | any[] | yes | List of recipients. Each entry is a principal: { type: \'member\', id } \\| { type: \'member_group\', id } \\| { type: \'organization\', id } |\n| `title` | string | yes | |\n| `body` | string | yes | |\n| `blocks` | any[] | | |\n| `actions` | object[] | | |\n| `actions[].key` | string | yes | |\n| `actions[].label` | string | yes | |\n| `actions[].confirm` | string | | |\n| `actions[].outcome` | "negative" | | Pressing it declines what the card asks: the button is drawn after the others, and the decided card ends with a cross rather than a check |\n| `actions[].asks` | any[] | | |\n| `actions[].workflow_id` | string | yes | |\n| `actions[].inputs` | object | yes | |\n| `decision` | "any" \\\\| "each" | | |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `message` | string | yes | |\n| `recipients_count` | number | yes | |\n\n## telegram\n\n### telegram_list_chats (workflow step)\n\n- List the chats that messaged a Telegram bot, or added it, in the last 24 hours \u2014 where a chat id comes from.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | Telegram connected account |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `chats` | object[] | yes | |\n| `chats[].chat_id` | string | yes | |\n| `chats[].type` | string | yes | private, group, supergroup or channel |\n| `chats[].name` | string | yes | |\n| `chats[].username` | string | | |\n| `chats[].last_seen_at` | string | yes | ISO timestamp of the chat\'s latest update |\n\n### telegram_send_document (workflow step)\n\n- Send a stored file from a Telegram bot to a chat, as a document with an optional caption.\n- The chat must have messaged the bot first.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | Telegram connected account |\n| `chat_id` | string | yes | Numeric chat id, or the @username of a public channel or group |\n| `file_id` | string | yes | |\n| `caption` | string | | |\n| `parse_mode` | "HTML" \\\\| "MarkdownV2" | | How the text is formatted: Telegram\'s HTML tags or its MarkdownV2 syntax |\n| `disable_notification` | boolean | | Deliver without a notification sound |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `message_id` | number | yes | |\n| `chat_id` | string | yes | |\n| `sent_at` | string | yes | ISO timestamp |\n\n### telegram_send_message (workflow step)\n\n- Send a text message from a Telegram bot to a chat.\n- The chat must have messaged the bot first.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | Telegram connected account |\n| `chat_id` | string | yes | Numeric chat id, or the @username of a public channel or group |\n| `text` | string | yes | |\n| `parse_mode` | "HTML" \\\\| "MarkdownV2" | | How the text is formatted: Telegram\'s HTML tags or its MarkdownV2 syntax |\n| `disable_notification` | boolean | | Deliver without a notification sound |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `message_id` | number | yes | |\n| `chat_id` | string | yes | |\n| `sent_at` | string | yes | ISO timestamp |\n\n## threads\n\n### threads_create_post (workflow step)\n\n- Publish a post to the connected Threads account.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | |\n| `text` | string | yes | |\n| `link` | string | | Shown as a link card. A post carries either a link or media. |\n| `media_file_ids` | string[] | | One image or video, or 2\u201320 images and videos as a carousel. |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `post_id` | string | yes | |\n| `url` | string | yes | |\n\n## vietcombank\n\n### vietcombank_convert_currency (workflow step)\n\n- Convert between currencies using live Vietcombank exchange rates.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `from_currency` | string | yes | Source currency code (e.g., \'USD\', \'EUR\', \'JPY\') |\n| `to_currency` | string | yes | Target currency code (e.g., \'USD\', \'EUR\', \'JPY\') |\n| `amount` | number | yes | The amount to convert (must be positive) |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `converted_amount` | number | yes | The converted amount |\n| `exchange_rate` | number | yes | The exchange rate |\n\n## wininvoice\n\n### wininvoice_create_or_update_invoice (workflow step)\n\n- Create or update a Vietnamese e-invoice in WinInvoice. invRef identifies the invoice: a value that already has one resolves to that invoice rather than issuing a new one, and isExisting: 1 means it came back unchanged with nothing issued.\n- Derive invRef from what is being billed rather than from a record that may later describe something else.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `invName` | string | yes | Invoice sample name, ex: 1,2,6 |\n| `invSerial` | string | yes | Invoice sign, ex: C24TAA, K24TXX |\n| `invNumber` | string | yes | Invoice number |\n| `invDate` | string | yes | Invoice date (format: yyyy/mm/dd) |\n| `invCustomer` | 0 \\\\| 1 | | Customer is not company? Value 1\\|0 |\n| `invRef` | string | yes | 3rd party Bill-ID. Identifies the invoice: a value that already has an invoice resolves to that invoice instead of issuing a new one |\n| `invRefDate` | string | | Bill date (format: yyyy/mm/dd) |\n| `billNumber` | string | | Bill number - extend |\n| `buyerTax` | string | | Buyer tax-number |\n| `buyerCode` | string | | Buyer-id |\n| `buyerName` | string | yes | Buyer full name |\n| `buyerCompany` | string | | Buyer company/ organization name |\n| `buyerAddress` | string | | Buyer full address |\n| `buyerAcc` | string | | Buyer bank account number |\n| `buyerBank` | string | | Buyer bank name |\n| `buyerEmail` | string | | Buyer email |\n| `buyerPhone` | string | | Buyer phone number |\n| `buyerFax` | string | | Buyer fax number |\n| `buyerCitizenIDNumber` | string | | Citizen Identification Number |\n| `buyerPassportNumber` | string | | Passport Number |\n| `govUnitCode` | string | | Budget-related Unit Code |\n| `invSubTotal` | number | yes | Invoice Subtotal (not include VAT, not include discount) |\n| `invVatRate` | number | yes | VAT Rate: 0,5,8,10 (0%,5%,8%,10%), -1 (Not taxable), -2 (Not declare and pay taxes) |\n| `invVatAmount` | number | yes | VAT Amount |\n| `invTotalAmount` | number | yes | Invoice Total |\n| `invPayment` | string | | Payment method |\n| `invExchangeRate` | number | | Exchange rate (to VietNam \u0111\u1ED3ng) |\n| `invCurrency` | string | | Payment currency |\n| `note` | string | | Note for discount |\n| `invAutoSign` | 0 \\\\| 1 | | Request sign invoice immediately after create successful? Value 1\\|0 |\n| `privateCode` | string | | The UID string (10-12 chars), the buyer will use this code to lookup invoice (after invoice signed). If blank, WinInvoice will generate automatically |\n| `option` | 0 \\\\| 1 \\\\| 2 \\\\| 3 \\\\| 4 | | Invoice type: 0 (Normal invoice), 1 (Information-adjustment invoice), 2 (Increases-adjustment invoice), 3 (Decreases-adjustment invoice), 4 (Replacement invoice - original will be marked as deleted when signed) |\n| `invCodeOld` | string | | Original invoice number (required for adjustment/replacement invoices) |\n| `invNameOld` | string | | Original invoice sample name (required for adjustment/replacement invoices) |\n| `invSignOld` | string | | Original invoice sign (required for adjustment/replacement invoices) |\n| `create04SSHDDT` | 0 \\\\| 1 | | Auto create 04/SS-H\u0110\u0110T? Value 1\\|0 (default 1) |\n| `reason04SSHDDT` | string | | 04/SS-H\u0110\u0110T Reason |\n| `isDscnForSaleInv` | 0 \\\\| 1 | | Apply an 8% tax reduction to the sales invoice? Value 1\\|0 (default 0) |\n| `saleInvVATRate` | number | | Tax rate based on revenue (Only applicable when isDscnForSaleInv = 1) |\n| `saleInvDscnAmnt` | number | | The reduction amount determined based on revenue and corresponding tax rate (Only applicable when isDscnForSaleInv = 1) |\n| `privateNote` | string | | Used for internal notes |\n| `items` | object[] | yes | Array of item/product in this bill |\n| `items[].itemNo` | string | | Item number |\n| `items[].itemCode` | string | | Product/Item code |\n| `items[].itemName` | string | yes | Name of product |\n| `items[].itemPromo` | 0 \\\\| 1 | | Is promotional product (gift)? Value 1\\|0 (default 0) |\n| `items[].isDscnItem` | 0 \\\\| 1 | | Is the discount line? Value 1\\|0 (default 0) |\n| `items[].itemUnit` | string | | Product Unit |\n| `items[].itemQuantity` | number | yes | Product quantity |\n| `items[].itemPrice` | number | yes | Product unit price (not include VAT) |\n| `items[].itemVatRate` | number | | Product VAT rate |\n| `items[].itemVatAmnt` | number | | Product VAT Amount |\n| `items[].itemDscnAmnt` | number | | Product Discount Amount |\n| `items[].itemAmountNoVat` | number | | Product Amount (not include VAT)(not include item discount) |\n| `items[].adjustType` | "PRICE" \\\\| "QTTY" | | Type of adjustment: PRICE (Adjust unit price of item in original invoice), QTTY (Adjust quantity of item in original invoice). This field has effect when value of option field is 2 or 3 |\n| `items[].itemPack` | string | | Product Lot |\n| `items[].itemDate` | string | | Product expiration date |\n| `items[].itemNote` | string | | Product note |\n| `items[].specialGoodsType` | 0 \\\\| 1 \\\\| 2 \\\\| 3 | | Special category of goods: 0 (Normal item/good), 1 (Cars or motorcycles), 2 (Transportation service), 3 (Transportation services on digital and e-commerce platforms) |\n| `items[].specialGoodsInfo` | object | | Data requirements for specialized goods based on specialGoodsType |\n| `items[].specialGoodsInfo.chassisNumb` | string | | Chassis Number (for cars/motorcycles - specialGoodsType = 1) |\n| `items[].specialGoodsInfo.engineNumb` | string | | Engine Number (for cars/motorcycles - specialGoodsType = 1) |\n| `items[].specialGoodsInfo.licensePlate` | string | | License plate of the transport vehicle (for transportation service - specialGoodsType = 2) |\n| `items[].specialGoodsInfo.senderName` | string | | Sender\'s Name (for shipping service - specialGoodsType = 3) |\n| `items[].specialGoodsInfo.senderAddress` | string | | Sender\'s Address (for shipping service - specialGoodsType = 3) |\n| `items[].specialGoodsInfo.senderTaxCode` | string | | Sender\'s Tax Code (for shipping service - specialGoodsType = 3) |\n| `items[].specialGoodsInfo.senderCitizenIDNumber` | string | | Sender\'s Citizen Identification Number (for shipping service - specialGoodsType = 3) |\n| `items[].isNoteItem` | 0 \\\\| 1 | | Is the note line? Value 1\\|0 (default 0) |\n| `connected_account_id` | string | yes | The ID of the connected account |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `oid` | string | yes | WinInvoice\'s UID |\n| `invCode` | string | yes | Invoice number (is \'0000000\' if has not signed) |\n| `invRef` | string | yes | 3rd party Bill-ID |\n| `invSign` | string | yes | Invoice sign, (as invSerial) |\n| `invDate` | string | yes | Invoice date, format yyyy-mm-dd |\n| `invName` | string | yes | Full invoice sample (invName + invSign) |\n| `privateCode` | string | yes | Private lookup code for buyer |\n| `itemTotal` | number | | Count of products in invoice |\n| `itemError` | number | | Count of error-products in invoice |\n| `govTranfer` | number | yes | Invoice has transferred to GOV? 1\\|0 |\n| `govTranID` | string | yes | Transaction ID used to transfer invoice to GOV |\n| `govTranferErr` | number | yes | ansferred to GOV has FAIL? 1\\|0 |\n| `govTranText` | string | yes | Error message if transfer to GOV has FAIL |\n| `govCode` | string | yes | The UID string issue by GOV for this invoice |\n| `autoSign` | number | | Has request sign immediately ? 1\\|0 |\n| `isExisting` | 0 \\\\| 1 | | 1 when invRef already had an invoice and this call returned it unchanged \u2014 no invoice was issued |\n| `link` | string | yes | Link to view the invoice |\n\n## x\n\n### x_create_post (workflow step)\n\n- Publish a post to the connected X account.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | |\n| `text` | string | yes | |\n| `media_file_ids` | string[] | | Up to 4 images, or one GIF, or one video. |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `post_id` | string | yes | |\n| `url` | string | yes | |\n\n## zip\n\n### zip_files (workflow step)\n\n- Bundle multiple files into a zip archive.\n- Max 100 files.\n- An item in file_ids is a file id \u2014 or `{ id, name }` to name that entry in the archive: a file name, never a path, carrying the stored extension.\n- A bare id keeps the stored filename.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `file_ids` | string \\\\| object[] | yes | |\n| `filename` | string | | Name for the zip file, without the .zip extension. |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `file_id` | string | yes | The ID of the generated file. |\n| `url` | string | yes | The download URL of the generated file. |\n| `filename` | string | yes | The filename of the generated file, including extension. |\n| `mime_type` | string | yes | The MIME type of the generated file. |\n';
1909
+ var workflow_steps_default = '<!-- Generated by backend/scripts/generate_workflow_steps_doc.ts from each step\'s schemas \u2014 never edit by hand. -->\n\n# Workflow steps\n\nThe steps only a workflow body runs: a connection\'s (an invoice issuer, a mailbox, \u2026) and the platform\'s own. Each is\ncalled as `await <step>({ ...inputs })` (see `workflows`); a step\'s inputs and answer are its entry here. A connection\nstep takes the `connected_account_id` that `get_workspace` lists under kind `connection`, and the app\'s owner must be\nable to use that connection. A step\'s `connected_account_id` is a literal, a\nconstant bound to one, or a choice among them: every possible value is judged at save, and one read from an input, a\nrecord or a call is refused. A template may come from data; a run refuses one its owner cannot use.\n\n**How a step fails.** A step that is refused \u2014 an input the schema rejects, a connection the workspace lacks, an\nanswer the provider refuses \u2014 ends the run, and the run\'s error reads `[<step>] <reason>`. Inside `try { \u2026 } catch\n(e) { \u2026 }` the body handles it instead: `e` is `{ message, type, step_id?, detail? }`, `message` the reason as\nabove. A provider\'s refusal carries the provider\'s own words.\n\n## aggregate\n\n### aggregate_records (workflow step)\n\n- Compute aggregate statistics over records.\n- Fields and select options are named by their alias, as get_table shows them. (chat, MCP, CLI)\n- A workspace admin\'s `as_member` computes over what that member would see.\n- Pass either `aggregate_option` for a single statistic, or `aggregations` to compute several in one call.\n- Example: { "table_id": "...", "aggregate_option": { "operation": "sum", "field_key": "amount" } } Operations by field type: No field: count \u2014 the rows matching `filters`.\n- `filled` counts populated CELLS, which is a different number the moment any are empty.\n- All fields: empty, filled, percent_empty, percent_filled, unique, percent_unique Number: sum, avg, median, min, max, range Date: earliest, latest, date_range Boolean: checked, unchecked, percent_checked, percent_unchecked `group_by` breaks every requested statistic down per distinct value of one field, computed over the same filters \u2014 one call in place of a call per bucket.\n- Example: { "table_id": "...", "group_by": "status", "filters": {...}, "aggregations": [{ "operation": "filled", "field_key": "created_on" }, { "operation": "sum", "field_key": "amount" }] } Restrict the period through `filters` on a date field rather than grouping by that date \u2014 a raw date/datetime groups per distinct stored value.\n- Filters: Operators: `is`, `is_not` on a field holding one value; `is_any_of`, `is_none_of` on text, number, date, select, member and link fields; `lt`, `lte`, `gt`, `gte` on number and date; `is_empty`, `is_not_empty` on every field but yes/no.\n- A date is "YYYY-MM-DD" for that whole day.\n- On text, `contains`, `starts_with` and `ends_with` ignore case and keep accents: `c\xE1` finds `C\xE1 h\u1ED3i`, not `C\xE0 chua`.\n- `ignore_accents: true` makes `ca` and `c\xE1` find both.\n- `equals` and `is_any_of` keep accents.\n- `docs path="filters"`. (chat, MCP, CLI)\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `table_id` | string | yes | |\n| `as_member` | string | | For a workspace admin: reads as this member would \u2014 their row rules and access. Anyone else is refused. |\n| `filters` | any | | |\n| `aggregate_option` | any | | |\n| `aggregations` | any[] | | At most 25 entries. |\n| `group_by` | string | | Field alias to break the statistics down by. Rows with no value in it are reported separately, not folded into a group. |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `result` | number \\\\| string | | Result of a single `aggregate_option` call \u2014 a number, or a string for dates. |\n| `_units` | object[] | | One answer per unit or currency the rows hold, most rows first; unit null for rows naming none. `result` is the first. |\n| `_units[].unit` | string \\\\| null | yes | |\n| `_units[].value` | number | yes | |\n| `results` | object[] | | One entry per aggregation when `aggregations` is used. |\n| `results[].operation` | string | yes | |\n| `results[].field_key` | string | yes | |\n| `results[].field_name` | string | yes | |\n| `results[].result` | number \\\\| string | yes | |\n| `results[].units` | object[] | | One answer per unit or currency the rows hold, most rows first; unit null for rows naming none. `result` is the first. |\n| `results[].units[].unit` | string \\\\| null | yes | |\n| `results[].units[].value` | number | yes | |\n| `groups` | object[] | | One entry per distinct value of `group_by`, each carrying every requested statistic. |\n| `groups[].key` | string | yes | The group\'s identity. `label` is a spelling of it, and two rows can spell one identity differently. |\n| `groups[].label` | string | | Readable name for `key` where one is known: an option\'s name, a linked record\'s display text, a filename. Absent means no name was available, never that the group is empty. |\n| `groups[].results` | object[] | yes | |\n| `groups[].results[].operation` | string | yes | |\n| `groups[].results[].field_key` | string | yes | |\n| `groups[].results[].field_name` | string | yes | |\n| `groups[].results[].result` | number \\\\| string | yes | |\n| `groups[].results[].units` | object[] | | One answer per unit or currency the rows hold, most rows first; unit null for rows naming none. `result` is the first. |\n| `groups[].results[].units[].unit` | string \\\\| null | yes | |\n| `groups[].results[].units[].value` | number | yes | |\n| `_ungrouped_rows` | number | | Matching rows with no value in the `group_by` field \u2014 counted in no group. |\n| `_group_field_name` | string | | |\n| `_operation` | string | | |\n| `_field_key` | string | | |\n| `_field_name` | string | | |\n| `_value_coverage` | object | | |\n| `_value_coverage.requested` | number | yes | |\n| `_value_coverage.field_name` | string | yes | |\n| `_value_coverage.composite` | boolean | | |\n| `_value_coverage.per_value` | object | | |\n| `_value_coverage.per_value.matched` | number | yes | |\n| `_value_coverage.per_value.missing` | string[] | yes | |\n| `_narrowed_hops` | string[] | | The tables a filter looked through whose rows this reader\'s access limits. |\n\n## bkav\n\n### bkav_attach_files (workflow step)\n\n- Attach workspace files (a bi\xEAn b\u1EA3n, a b\u1EA3ng k\xEA) to an invoice on Bkav.\n- Bkav accepts PDF and Excel, at most 1 MB each.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | Bkav connected account |\n| `invoice_guid` | string | | |\n| `partner_invoice_id` | string | | Your PartnerInvoiceStringID, when invoice_guid is not set |\n| `file_ids` | string[] | yes | |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `results` | object[] | yes | |\n| `results[].PartnerInvoiceID` | number | yes | |\n| `results[].PartnerInvoiceStringID` | string \\\\| null | yes | Null on a delete\'s answer |\n| `results[].InvoiceGUID` | string | yes | |\n| `results[].InvoiceForm` | string \\\\| null | yes | Null on a draft\'s link answer |\n| `results[].InvoiceSerial` | string \\\\| null | yes | Null on a draft\'s link answer |\n| `results[].InvoiceNo` | number | yes | Assigned by a numbered kind; 0 on a draft |\n| `results[].MTC` | string \\\\| null | yes | M\xE3 tra c\u1EE9u the buyer looks the invoice up with; null on a draft\'s link answer |\n| `results[].MaCuaCQT` | string \\\\| null | | |\n| `results[].Status` | number | yes | 0 succeeded; otherwise MessLog says why |\n| `results[].MessLog` | string | yes | |\n| `failed` | number | yes | Invoices whose own Status is not 0 |\n\n### bkav_cancel_invoices (workflow step)\n\n- Cancel issued invoices.\n- A cancelled invoice still reports to the tax authority; correcting one instead is a replacement or adjustment through bkav_submit_invoices. (workflow step, chat)\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | Bkav connected account |\n| `invoice_guids` | string[] | | InvoiceGUIDs Bkav returned |\n| `partner_invoice_ids` | string[] | | Your PartnerInvoiceStringIDs |\n| `reason` | string | yes | |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `results` | object[] | yes | |\n| `results[].PartnerInvoiceID` | number | yes | |\n| `results[].PartnerInvoiceStringID` | string \\\\| null | yes | Null on a delete\'s answer |\n| `results[].InvoiceGUID` | string | yes | |\n| `results[].InvoiceForm` | string \\\\| null | yes | Null on a draft\'s link answer |\n| `results[].InvoiceSerial` | string \\\\| null | yes | Null on a draft\'s link answer |\n| `results[].InvoiceNo` | number | yes | Assigned by a numbered kind; 0 on a draft |\n| `results[].MTC` | string \\\\| null | yes | M\xE3 tra c\u1EE9u the buyer looks the invoice up with; null on a draft\'s link answer |\n| `results[].MaCuaCQT` | string \\\\| null | | |\n| `results[].Status` | number | yes | 0 succeeded; otherwise MessLog says why |\n| `results[].MessLog` | string | yes | |\n| `failed` | number | yes | Invoices whose own Status is not 0 |\n\n### bkav_create_bill (workflow step)\n\n- Record a cash-register bill on Bkav.\n- Field names are Bkav\'s.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | Bkav connected account |\n| `bill` | object | yes | |\n| `bill.Bill` | object | yes | |\n| `bill.Bill.BillCode` | number | yes | |\n| `bill.Bill.OriginalBillCode` | number | | |\n| `bill.Bill.BillDate` | string | yes | |\n| `bill.Bill.BillStatusID` | number | yes | |\n| `bill.Bill.PayMethod` | string | | |\n| `bill.Bill.Note` | string | | |\n| `bill.ListBillDetails` | object[] | yes | |\n| `bill.ListBillDetails[].ItemTypeID` | number | | 0 goods, 4 description line, 15 promotional goods, \u2026 |\n| `bill.ListBillDetails[].IsDiscount` | boolean | | |\n| `bill.ListBillDetails[].ItemCode` | string | | |\n| `bill.ListBillDetails[].ItemName` | string | yes | |\n| `bill.ListBillDetails[].UnitName` | string | | |\n| `bill.ListBillDetails[].Qty` | number | | |\n| `bill.ListBillDetails[].Price` | number | | |\n| `bill.ListBillDetails[].Amount` | number | | |\n| `bill.ListBillDetails[].TaxRateID` | number | | 1 0%, 2 5%, 3 10%, 4 kh\xF4ng ch\u1ECBu thu\u1EBF, 9 8%, \u2026 |\n| `bill.ListBillDetails[].TaxRate` | number | | |\n| `bill.ListBillDetails[].TaxAmount` | number | | |\n| `bill.ListBillDetails[].OtherAmount` | number | | |\n| `bill.ListBillDetails[].DiscountRate` | number | | |\n| `bill.ListBillDetails[].DiscountAmount` | number | | |\n| `bill.ListBillDetails[].UserDefineDetails` | string | | |\n| `bill.ListBillDetails[].IsIncrease` | boolean \\\\| null | | On an adjustment: true raises the amount, false lowers it, absent adjusts information |\n| `bill.ListBillDetails[].SpecialtyItems` | string | | |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `created` | true | yes | |\n\n### bkav_create_invoice_from_bills (workflow step)\n\n- Raise one invoice from cash-register bills, by their BillGUIDs.\n- Field names are Bkav\'s.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | Bkav connected account |\n| `input` | object | yes | |\n| `input.Invoice` | object | yes | |\n| `input.Invoice.InvoiceTypeID` | number | yes | 1 GTGT, 2 b\xE1n h\xE0ng, 5 PXK ki\xEAm VCNB, 6 PXK g\u1EEDi b\xE1n \u0111\u1EA1i l\xFD |\n| `input.Invoice.InvoiceDate` | string | yes | ISO date |\n| `input.Invoice.BuyerCode` | string | | |\n| `input.Invoice.BuyerName` | string | | |\n| `input.Invoice.BuyerTaxCode` | string | | |\n| `input.Invoice.BuyerUnitName` | string | | |\n| `input.Invoice.BuyerAddress` | string | | |\n| `input.Invoice.BuyerBankAccount` | string | | Sent empty when absent: Bkav refuses it missing |\n| `input.Invoice.PayMethodID` | number | | 1 TM, 2 CK, 3 TM/CK, \u2026 |\n| `input.Invoice.ReceiveTypeID` | number | | 1 email, 2 SMS, 3 both, 4 courier |\n| `input.Invoice.ReceiverEmail` | string | | |\n| `input.Invoice.ReceiverMobile` | string | | |\n| `input.Invoice.ReceiverAddress` | string | | Sent empty when absent: Bkav refuses it missing |\n| `input.Invoice.ReceiverName` | string | | Sent empty when absent: Bkav refuses it missing |\n| `input.Invoice.Note` | string | | |\n| `input.Invoice.BillCode` | string | | Sent empty when absent: Bkav refuses it missing |\n| `input.Invoice.CurrencyID` | string | | |\n| `input.Invoice.ExchangeRate` | number | | |\n| `input.Invoice.InvoiceForm` | string | | M\u1EABu s\u1ED1 |\n| `input.Invoice.InvoiceSerial` | string | | K\xFD hi\u1EC7u |\n| `input.Invoice.InvoiceNo` | number | | S\u1ED1; 0 when Bkav assigns it |\n| `input.Invoice.MaCuaCQT` | string | | Set only by a cash-register flow that already holds the authority\'s code |\n| `input.Invoice.UserDefine` | string | | JSON-encoded template fields agreed with Bkav |\n| `input.Invoice.UIDefine` | string | | JSON-encoded delivery-note fields (InvoiceTypeID 5 and 6) |\n| `input.Invoice.isBTH` | boolean | | |\n| `input.Invoice.CCCD` | string | | |\n| `input.Invoice.PassportNumber` | string | | |\n| `input.Invoice.FiscalCodes` | string | | |\n| `input.Invoice.Reason` | string | | Why \u2014 required on a replacement or adjustment |\n| `input.Invoice.OriginalInvoiceIdentify` | string | | `[m\u1EABu s\u1ED1]_[k\xFD hi\u1EC7u]_[s\u1ED1]` of the invoice a replacement or adjustment corrects |\n| `input.Invoice.InvoiceGUID` | string | | Addresses the invoice for an update by guid |\n| `input.BillGUIDs` | string[] | yes | |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `results` | object[] | yes | |\n| `results[].PartnerInvoiceID` | number | yes | |\n| `results[].PartnerInvoiceStringID` | string \\\\| null | yes | Null on a delete\'s answer |\n| `results[].InvoiceGUID` | string | yes | |\n| `results[].InvoiceForm` | string \\\\| null | yes | Null on a draft\'s link answer |\n| `results[].InvoiceSerial` | string \\\\| null | yes | Null on a draft\'s link answer |\n| `results[].InvoiceNo` | number | yes | Assigned by a numbered kind; 0 on a draft |\n| `results[].MTC` | string \\\\| null | yes | M\xE3 tra c\u1EE9u the buyer looks the invoice up with; null on a draft\'s link answer |\n| `results[].MaCuaCQT` | string \\\\| null | | |\n| `results[].Status` | number | yes | 0 succeeded; otherwise MessLog says why |\n| `results[].MessLog` | string | yes | |\n| `failed` | number | yes | Invoices whose own Status is not 0 |\n\n### bkav_delete_invoices (workflow step)\n\n- Delete invoices that were never issued.\n- A numbered one can be deleted only if its number is the highest in its range.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | Bkav connected account |\n| `invoice_guids` | string[] | | InvoiceGUIDs Bkav returned |\n| `partner_invoice_ids` | string[] | | Your PartnerInvoiceStringIDs |\n| `reason` | string | | |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `results` | object[] | yes | |\n| `results[].PartnerInvoiceID` | number | yes | |\n| `results[].PartnerInvoiceStringID` | string \\\\| null | yes | Null on a delete\'s answer |\n| `results[].InvoiceGUID` | string | yes | |\n| `results[].InvoiceForm` | string \\\\| null | yes | Null on a draft\'s link answer |\n| `results[].InvoiceSerial` | string \\\\| null | yes | Null on a draft\'s link answer |\n| `results[].InvoiceNo` | number | yes | Assigned by a numbered kind; 0 on a draft |\n| `results[].MTC` | string \\\\| null | yes | M\xE3 tra c\u1EE9u the buyer looks the invoice up with; null on a draft\'s link answer |\n| `results[].MaCuaCQT` | string \\\\| null | | |\n| `results[].Status` | number | yes | 0 succeeded; otherwise MessLog says why |\n| `results[].MessLog` | string | yes | |\n| `failed` | number | yes | Invoices whose own Status is not 0 |\n\n### bkav_explain_invoice_error (workflow step)\n\n- Explain an erroneous invoice to the tax authority without replacing or adjusting it, optionally answering one of its notices.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | Bkav connected account |\n| `invoice_guid` | string | yes | |\n| `reason` | string | yes | |\n| `notice_number` | string | | S\u1ED1 of the authority\'s notice being answered |\n| `notice_date` | string | | yyyy-mm-dd; with notice_number |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `results` | object[] | yes | |\n| `results[].InvoiceGUID` | string | yes | |\n| `results[].Status` | number | yes | 0 succeeded; otherwise Msg says why |\n| `results[].Msg` | string | yes | |\n| `failed` | number | yes | Invoices whose own Status is not 0 |\n\n### bkav_explain_replaced_invoice (workflow step)\n\n- Explain to the tax authority an invoice that was replaced or adjusted.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | Bkav connected account |\n| `invoice_guid` | string | yes | |\n| `reason` | string | yes | |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `results` | object[] | yes | |\n| `results[].InvoiceGUID` | string | yes | |\n| `results[].Status` | number | yes | 0 succeeded; otherwise Msg says why |\n| `results[].Msg` | string | yes | |\n| `failed` | number | yes | Invoices whose own Status is not 0 |\n\n### bkav_get_bill (workflow step)\n\n- Read a cash-register bill.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | Bkav connected account |\n| `seller_tax_code` | string | yes | |\n| `organization_code` | string | yes | |\n| `bill_code` | number | yes | |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `bill` | object | yes | |\n\n### bkav_get_error_notice_pdf (workflow step)\n\n- Save the PDF of an invoice\'s 04/SS error notice as a workspace file.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | Bkav connected account |\n| `partner_invoice_id` | string | yes | Your PartnerInvoiceStringID |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `file_id` | string | yes | The ID of the generated file. |\n| `url` | string | yes | The download URL of the generated file. |\n| `filename` | string | yes | The filename of the generated file, including extension. |\n| `mime_type` | string | yes | The MIME type of the generated file. |\n\n### bkav_get_file_by_lookup_code (workflow step)\n\n- Save an invoice\'s display copy, conversion copy or XML as a workspace file, found by the m\xE3 tra c\u1EE9u the buyer was sent.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | Bkav connected account |\n| `lookup_code` | string | yes | M\xE3 tra c\u1EE9u |\n| `kind` | "display" \\\\| "converted" \\\\| "xml" | yes | |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `file_id` | string | yes | The ID of the generated file. |\n| `url` | string | yes | The download URL of the generated file. |\n| `filename` | string | yes | The filename of the generated file, including extension. |\n| `mime_type` | string | yes | The MIME type of the generated file. |\n\n### bkav_get_invoice (workflow step)\n\n- Read one invoice as Bkav holds it \u2014 header, lines, status and m\xE3 tra c\u1EE9u.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | Bkav connected account |\n| `id` | string | yes | Your PartnerInvoiceStringID or Bkav\'s InvoiceGUID |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `invoice` | object | yes | |\n\n### bkav_get_invoice_file (workflow step)\n\n- Save an invoice\'s PDF or signed XML as a workspace file.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | Bkav connected account |\n| `partner_invoice_id` | string | yes | Your PartnerInvoiceStringID |\n| `format` | "pdf" \\\\| "xml" | yes | |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `file_id` | string | yes | The ID of the generated file. |\n| `url` | string | yes | The download URL of the generated file. |\n| `filename` | string | yes | The filename of the generated file, including extension. |\n| `mime_type` | string | yes | The MIME type of the generated file. |\n\n### bkav_get_invoice_history (workflow step)\n\n- Read everything that happened to an invoice on Bkav, oldest first.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | Bkav connected account |\n| `invoice_guid` | string | yes | |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `entries` | object[] | yes | |\n\n### bkav_get_invoice_link (workflow step)\n\n- Get a download link for an invoice\'s display copy, conversion copy, or its 04/SS error notice.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | Bkav connected account |\n| `partner_invoice_id` | string | yes | Your PartnerInvoiceStringID |\n| `kind` | "display" \\\\| "converted" \\\\| "notice_04ss" | yes | |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `url` | string | yes | |\n\n### bkav_get_invoice_status (workflow step)\n\n- Read an invoice\'s status on Bkav.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | Bkav connected account |\n| `invoice_guid` | string | yes | |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `invoice_status_id` | number | yes | 1 m\u1EDBi t\u1EA1o, 2 \u0111\xE3 ph\xE1t h\xE0nh, 3 \u0111\xE3 hu\u1EF7, 5\u20138 ch\u1EDD/\u0111\xE3 thay th\u1EBF\u2013\u0111i\u1EC1u ch\u1EC9nh, 11 \u0111\xE3 c\u1EA5p s\u1ED1 ch\u1EDD k\xFD |\n\n### bkav_get_listing (workflow step)\n\n- Save the b\u1EA3ng k\xEA of one invoice type over a window as a workspace spreadsheet.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | Bkav connected account |\n| `invoice_type_id` | number | yes | 1 GTGT, 2 b\xE1n h\xE0ng, \u2026 |\n| `from_date` | string | yes | yyyy-mm-dd |\n| `to_date` | string | yes | yyyy-mm-dd |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `file_id` | string | yes | The ID of the generated file. |\n| `url` | string | yes | The download URL of the generated file. |\n| `filename` | string | yes | The filename of the generated file, including extension. |\n| `mime_type` | string | yes | The MIME type of the generated file. |\n\n### bkav_get_report_bc26 (workflow step)\n\n- Save the BC26/AC invoice usage report for a window as a workspace XML file.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | Bkav connected account |\n| `from_date` | string | yes | yyyy-mm-dd |\n| `to_date` | string | yes | yyyy-mm-dd |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `file_id` | string | yes | The ID of the generated file. |\n| `url` | string | yes | The download URL of the generated file. |\n| `filename` | string | yes | The filename of the generated file, including extension. |\n| `mime_type` | string | yes | The MIME type of the generated file. |\n\n### bkav_get_tax_status (workflow step)\n\n- Read the tax authority\'s status for an invoice and its m\xE3 c\u1EE7a CQT once granted.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | Bkav connected account |\n| `invoice_guid` | string | yes | |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `statuses` | object[] | yes | |\n| `statuses[].BkavStatus` | number | yes | InvoiceStatusID: 1 m\u1EDBi t\u1EA1o, 2 \u0111\xE3 ph\xE1t h\xE0nh, 3 \u0111\xE3 hu\u1EF7, \u2026 |\n| `statuses[].TaxStatus` | number | yes | 32 waiting, 33 accepted, 34\u201339 returned or failed |\n| `statuses[].TaxAuthorityCode` | string \\\\| null | yes | M\xE3 c\u1EE7a C\u01A1 quan thu\u1EBF, once granted |\n| `statuses[].ErrorContent` | string \\\\| null | yes | |\n\n### bkav_list_invoices_by_date (workflow step)\n\n- List invoices dated within a window, one page at a time.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | Bkav connected account |\n| `from_date` | string | yes | yyyy-mm-dd |\n| `to_date` | string | yes | yyyy-mm-dd |\n| `page` | number | | 1-based |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `invoices` | object[] | yes | |\n\n### bkav_list_invoices_by_number (workflow step)\n\n- List invoices of one m\u1EABu s\u1ED1 and k\xFD hi\u1EC7u by number range.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | Bkav connected account |\n| `form` | string | yes | M\u1EABu s\u1ED1 |\n| `serial` | string | yes | K\xFD hi\u1EC7u |\n| `from_number` | number | yes | |\n| `to_number` | number | yes | |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `invoices` | object[] | yes | |\n\n### bkav_lookup_company (workflow step)\n\n- Look up a company in the tax registry by M\xE3 s\u1ED1 thu\u1EBF, through the Bkav account.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | Bkav connected account |\n| `tax_code` | string | yes | |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `company` | object | yes | |\n| `company.MaSoThue` | string | yes | |\n| `company.TenChinhThuc` | string | yes | |\n| `company.DiaChiGiaoDichChinh` | string | yes | |\n| `company.DiaChiGiaoDichPhu` | string | yes | |\n| `company.TrangThaiHoatDong` | string | yes | |\n| `company.ChuDoanhNghiep` | string | | |\n| `company.SoDienThoai` | string \\\\| null | | |\n| `company.LastUpdate` | string | | |\n\n### bkav_send_lookup_email (workflow step)\n\n- Send an invoice\'s lookup email to the buyer again, or to another email or phone.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | Bkav connected account |\n| `invoice_guid` | string | yes | |\n| `email` | string | | |\n| `mobile` | string | | |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `sent` | true | yes | |\n\n### bkav_sign_invoices (workflow step)\n\n- Sign \u2014 issue \u2014 invoices with the account\'s HSM signature, making them tax-registered documents.\n- An account that signs with a USB token cannot sign this way.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | Bkav connected account |\n| `invoice_guids` | string[] | yes | |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `signed` | string[] | yes | |\n\n### bkav_submit_invoices (workflow step)\n\n- Create, replace or adjust invoices on Bkav, in Bkav\'s field names.\n- Each carries PartnerInvoiceStringID, your own id for it, which Bkav uses to refuse a duplicate.\n- Attachments are not accepted here.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | Bkav connected account |\n| `kind` | "create_draft" \\\\| "create" \\\\| "create_draft_own_serial" \\\\| "create_own_number" \\\\| "create_own_serial" \\\\| "replace_draft" \\\\| "adjust_draft" \\\\| "adjust_discount_draft" \\\\| "replace" \\\\| "adjust" \\\\| "adjust_external_draft" \\\\| "adjust_discount" \\\\| "adjust_external" \\\\| "replace_external" \\\\| "replace_external_draft" | yes | create_draft: no number, deletable. create: Bkav numbers it. *_own_*: your form/serial. replace_* / adjust_*: each invoice names its original in Invoice.OriginalInvoiceIdentify and gives Invoice.Reason. *_external*: corrects an invoice issued outside Bkav; its first line is an ItemTypeID 4 description of it. *_draft kinds stay unnumbered. |\n| `invoices` | object[] | yes | |\n| `invoices[].Invoice` | object | yes | |\n| `invoices[].Invoice.InvoiceTypeID` | number | yes | 1 GTGT, 2 b\xE1n h\xE0ng, 5 PXK ki\xEAm VCNB, 6 PXK g\u1EEDi b\xE1n \u0111\u1EA1i l\xFD |\n| `invoices[].Invoice.InvoiceDate` | string | yes | ISO date |\n| `invoices[].Invoice.BuyerCode` | string | | |\n| `invoices[].Invoice.BuyerName` | string | | |\n| `invoices[].Invoice.BuyerTaxCode` | string | | |\n| `invoices[].Invoice.BuyerUnitName` | string | | |\n| `invoices[].Invoice.BuyerAddress` | string | | |\n| `invoices[].Invoice.BuyerBankAccount` | string | | Sent empty when absent: Bkav refuses it missing |\n| `invoices[].Invoice.PayMethodID` | number | | 1 TM, 2 CK, 3 TM/CK, \u2026 |\n| `invoices[].Invoice.ReceiveTypeID` | number | | 1 email, 2 SMS, 3 both, 4 courier |\n| `invoices[].Invoice.ReceiverEmail` | string | | |\n| `invoices[].Invoice.ReceiverMobile` | string | | |\n| `invoices[].Invoice.ReceiverAddress` | string | | Sent empty when absent: Bkav refuses it missing |\n| `invoices[].Invoice.ReceiverName` | string | | Sent empty when absent: Bkav refuses it missing |\n| `invoices[].Invoice.Note` | string | | |\n| `invoices[].Invoice.BillCode` | string | | Sent empty when absent: Bkav refuses it missing |\n| `invoices[].Invoice.CurrencyID` | string | | |\n| `invoices[].Invoice.ExchangeRate` | number | | |\n| `invoices[].Invoice.InvoiceForm` | string | | M\u1EABu s\u1ED1 |\n| `invoices[].Invoice.InvoiceSerial` | string | | K\xFD hi\u1EC7u |\n| `invoices[].Invoice.InvoiceNo` | number | | S\u1ED1; 0 when Bkav assigns it |\n| `invoices[].Invoice.MaCuaCQT` | string | | Set only by a cash-register flow that already holds the authority\'s code |\n| `invoices[].Invoice.UserDefine` | string | | JSON-encoded template fields agreed with Bkav |\n| `invoices[].Invoice.UIDefine` | string | | JSON-encoded delivery-note fields (InvoiceTypeID 5 and 6) |\n| `invoices[].Invoice.isBTH` | boolean | | |\n| `invoices[].Invoice.CCCD` | string | | |\n| `invoices[].Invoice.PassportNumber` | string | | |\n| `invoices[].Invoice.FiscalCodes` | string | | |\n| `invoices[].Invoice.Reason` | string | | Why \u2014 required on a replacement or adjustment |\n| `invoices[].Invoice.OriginalInvoiceIdentify` | string | | `[m\u1EABu s\u1ED1]_[k\xFD hi\u1EC7u]_[s\u1ED1]` of the invoice a replacement or adjustment corrects |\n| `invoices[].Invoice.InvoiceGUID` | string | | Addresses the invoice for an update by guid |\n| `invoices[].ListInvoiceDetailsWS` | object[] | yes | |\n| `invoices[].ListInvoiceDetailsWS[].ItemTypeID` | number | | 0 goods, 4 description line, 15 promotional goods, \u2026 |\n| `invoices[].ListInvoiceDetailsWS[].IsDiscount` | boolean | | |\n| `invoices[].ListInvoiceDetailsWS[].ItemCode` | string | | |\n| `invoices[].ListInvoiceDetailsWS[].ItemName` | string | yes | |\n| `invoices[].ListInvoiceDetailsWS[].UnitName` | string | | |\n| `invoices[].ListInvoiceDetailsWS[].Qty` | number | | |\n| `invoices[].ListInvoiceDetailsWS[].Price` | number | | |\n| `invoices[].ListInvoiceDetailsWS[].Amount` | number | | |\n| `invoices[].ListInvoiceDetailsWS[].TaxRateID` | number | | 1 0%, 2 5%, 3 10%, 4 kh\xF4ng ch\u1ECBu thu\u1EBF, 9 8%, \u2026 |\n| `invoices[].ListInvoiceDetailsWS[].TaxRate` | number | | |\n| `invoices[].ListInvoiceDetailsWS[].TaxAmount` | number | | |\n| `invoices[].ListInvoiceDetailsWS[].OtherAmount` | number | | |\n| `invoices[].ListInvoiceDetailsWS[].DiscountRate` | number | | |\n| `invoices[].ListInvoiceDetailsWS[].DiscountAmount` | number | | |\n| `invoices[].ListInvoiceDetailsWS[].UserDefineDetails` | string | | |\n| `invoices[].ListInvoiceDetailsWS[].IsIncrease` | boolean \\\\| null | | On an adjustment: true raises the amount, false lowers it, absent adjusts information |\n| `invoices[].ListInvoiceDetailsWS[].SpecialtyItems` | string | | |\n| `invoices[].PartnerInvoiceStringID` | string | yes | |\n| `invoices[].AttachListNumber` | string | | S\u1ED1 of a b\u1EA3ng k\xEA the invoice refers to |\n| `invoices[].AttachListDate` | string | | |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `results` | object[] | yes | |\n| `results[].PartnerInvoiceID` | number | yes | |\n| `results[].PartnerInvoiceStringID` | string \\\\| null | yes | Null on a delete\'s answer |\n| `results[].InvoiceGUID` | string | yes | |\n| `results[].InvoiceForm` | string \\\\| null | yes | Null on a draft\'s link answer |\n| `results[].InvoiceSerial` | string \\\\| null | yes | Null on a draft\'s link answer |\n| `results[].InvoiceNo` | number | yes | Assigned by a numbered kind; 0 on a draft |\n| `results[].MTC` | string \\\\| null | yes | M\xE3 tra c\u1EE9u the buyer looks the invoice up with; null on a draft\'s link answer |\n| `results[].MaCuaCQT` | string \\\\| null | | |\n| `results[].Status` | number | yes | 0 succeeded; otherwise MessLog says why |\n| `results[].MessLog` | string | yes | |\n| `failed` | number | yes | Invoices whose own Status is not 0 |\n\n### bkav_update_invoices (workflow step)\n\n- Change invoices not yet issued. by names how each invoice is found: partner (its partner id), number (Invoice.InvoiceForm + InvoiceSerial + InvoiceNo) or guid (Invoice.InvoiceGUID).\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | Bkav connected account |\n| `by` | "partner" \\\\| "number" \\\\| "guid" | yes | |\n| `invoices` | object[] | yes | |\n| `invoices[].Invoice` | object | yes | |\n| `invoices[].Invoice.InvoiceTypeID` | number | yes | 1 GTGT, 2 b\xE1n h\xE0ng, 5 PXK ki\xEAm VCNB, 6 PXK g\u1EEDi b\xE1n \u0111\u1EA1i l\xFD |\n| `invoices[].Invoice.InvoiceDate` | string | yes | ISO date |\n| `invoices[].Invoice.BuyerCode` | string | | |\n| `invoices[].Invoice.BuyerName` | string | | |\n| `invoices[].Invoice.BuyerTaxCode` | string | | |\n| `invoices[].Invoice.BuyerUnitName` | string | | |\n| `invoices[].Invoice.BuyerAddress` | string | | |\n| `invoices[].Invoice.BuyerBankAccount` | string | | Sent empty when absent: Bkav refuses it missing |\n| `invoices[].Invoice.PayMethodID` | number | | 1 TM, 2 CK, 3 TM/CK, \u2026 |\n| `invoices[].Invoice.ReceiveTypeID` | number | | 1 email, 2 SMS, 3 both, 4 courier |\n| `invoices[].Invoice.ReceiverEmail` | string | | |\n| `invoices[].Invoice.ReceiverMobile` | string | | |\n| `invoices[].Invoice.ReceiverAddress` | string | | Sent empty when absent: Bkav refuses it missing |\n| `invoices[].Invoice.ReceiverName` | string | | Sent empty when absent: Bkav refuses it missing |\n| `invoices[].Invoice.Note` | string | | |\n| `invoices[].Invoice.BillCode` | string | | Sent empty when absent: Bkav refuses it missing |\n| `invoices[].Invoice.CurrencyID` | string | | |\n| `invoices[].Invoice.ExchangeRate` | number | | |\n| `invoices[].Invoice.InvoiceForm` | string | | M\u1EABu s\u1ED1 |\n| `invoices[].Invoice.InvoiceSerial` | string | | K\xFD hi\u1EC7u |\n| `invoices[].Invoice.InvoiceNo` | number | | S\u1ED1; 0 when Bkav assigns it |\n| `invoices[].Invoice.MaCuaCQT` | string | | Set only by a cash-register flow that already holds the authority\'s code |\n| `invoices[].Invoice.UserDefine` | string | | JSON-encoded template fields agreed with Bkav |\n| `invoices[].Invoice.UIDefine` | string | | JSON-encoded delivery-note fields (InvoiceTypeID 5 and 6) |\n| `invoices[].Invoice.isBTH` | boolean | | |\n| `invoices[].Invoice.CCCD` | string | | |\n| `invoices[].Invoice.PassportNumber` | string | | |\n| `invoices[].Invoice.FiscalCodes` | string | | |\n| `invoices[].Invoice.Reason` | string | | Why \u2014 required on a replacement or adjustment |\n| `invoices[].Invoice.OriginalInvoiceIdentify` | string | | `[m\u1EABu s\u1ED1]_[k\xFD hi\u1EC7u]_[s\u1ED1]` of the invoice a replacement or adjustment corrects |\n| `invoices[].Invoice.InvoiceGUID` | string | | Addresses the invoice for an update by guid |\n| `invoices[].ListInvoiceDetailsWS` | object[] | yes | |\n| `invoices[].ListInvoiceDetailsWS[].ItemTypeID` | number | | 0 goods, 4 description line, 15 promotional goods, \u2026 |\n| `invoices[].ListInvoiceDetailsWS[].IsDiscount` | boolean | | |\n| `invoices[].ListInvoiceDetailsWS[].ItemCode` | string | | |\n| `invoices[].ListInvoiceDetailsWS[].ItemName` | string | yes | |\n| `invoices[].ListInvoiceDetailsWS[].UnitName` | string | | |\n| `invoices[].ListInvoiceDetailsWS[].Qty` | number | | |\n| `invoices[].ListInvoiceDetailsWS[].Price` | number | | |\n| `invoices[].ListInvoiceDetailsWS[].Amount` | number | | |\n| `invoices[].ListInvoiceDetailsWS[].TaxRateID` | number | | 1 0%, 2 5%, 3 10%, 4 kh\xF4ng ch\u1ECBu thu\u1EBF, 9 8%, \u2026 |\n| `invoices[].ListInvoiceDetailsWS[].TaxRate` | number | | |\n| `invoices[].ListInvoiceDetailsWS[].TaxAmount` | number | | |\n| `invoices[].ListInvoiceDetailsWS[].OtherAmount` | number | | |\n| `invoices[].ListInvoiceDetailsWS[].DiscountRate` | number | | |\n| `invoices[].ListInvoiceDetailsWS[].DiscountAmount` | number | | |\n| `invoices[].ListInvoiceDetailsWS[].UserDefineDetails` | string | | |\n| `invoices[].ListInvoiceDetailsWS[].IsIncrease` | boolean \\\\| null | | On an adjustment: true raises the amount, false lowers it, absent adjusts information |\n| `invoices[].ListInvoiceDetailsWS[].SpecialtyItems` | string | | |\n| `invoices[].PartnerInvoiceStringID` | string | yes | |\n| `invoices[].AttachListNumber` | string | | S\u1ED1 of a b\u1EA3ng k\xEA the invoice refers to |\n| `invoices[].AttachListDate` | string | | |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `results` | object[] | yes | |\n| `results[].PartnerInvoiceID` | number | yes | |\n| `results[].PartnerInvoiceStringID` | string \\\\| null | yes | Null on a delete\'s answer |\n| `results[].InvoiceGUID` | string | yes | |\n| `results[].InvoiceForm` | string \\\\| null | yes | Null on a draft\'s link answer |\n| `results[].InvoiceSerial` | string \\\\| null | yes | Null on a draft\'s link answer |\n| `results[].InvoiceNo` | number | yes | Assigned by a numbered kind; 0 on a draft |\n| `results[].MTC` | string \\\\| null | yes | M\xE3 tra c\u1EE9u the buyer looks the invoice up with; null on a draft\'s link answer |\n| `results[].MaCuaCQT` | string \\\\| null | | |\n| `results[].Status` | number | yes | 0 succeeded; otherwise MessLog says why |\n| `results[].MessLog` | string | yes | |\n| `failed` | number | yes | Invoices whose own Status is not 0 |\n\n## delete\n\n### delete_file (workflow step)\n\n- Soft-delete a file by its file_id \u2014 archives it (never a hard delete).\n- Deleting an original file deletes every version of it; a file\'s current version cannot be deleted on its own.\n- Refuses while the file or a version it takes along is still referenced by a record, comment, knowledge doc, document template, voice session, or pending change request, and names the referents so you can detach them first.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `file_id` | string | yes | |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `id` | string | yes | |\n| `filename` | string | yes | |\n| `archived` | boolean | yes | |\n\n## drive\n\n### drive_export_file (workflow step)\n\n- Upload a Lotics file to the member\'s Google Drive.\n- The file is uploaded as-is \u2014 a .docx stays a .docx, a .xlsx stays a .xlsx.\n- It is deliberately NOT converted into a Google Doc or Sheet: conversion re-flows the layout of a generated document, and a native Google file is live, so its figures would drift away from the record they came from.\n- Use this to archive a finished document, the way you would attach it to an email.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | The ID of the connected Google Drive account to use |\n| `file_id` | string | yes | Lotics file ID to upload |\n| `folder_id` | string | | Drive folder ID to place the file in; omit for the member\'s Drive root |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `drive_file_id` | string | yes | Drive file ID of the uploaded copy |\n| `web_view_link` | string \\\\| null | yes | URL to open the uploaded file in Drive |\n\n### drive_import_file (workflow step)\n\n- Import a Google Drive file into the workspace as a Lotics file, and return its file id.\n- Google Docs arrive as .docx, Sheets as .xlsx, Slides as .pptx; everything else transfers unchanged. **This is also how you READ a Drive file.** There is no separate Drive read tool: import the file, then use `view_files` on the returned id. (chat, MCP, CLI)\n- That path handles scanned documents \u2014 a photographed B/L or a stamped invoice inside a .docx reaches the model as a picture.\n- Exporting Drive content as plain text would return an empty document for exactly those files.\n- Folders, Forms, shortcuts and other Drive items with no file form cannot be imported.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | The ID of the connected Google Drive account to use |\n| `file_id` | string | yes | Drive file ID, from drive_query_files (workflow step, chat) |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `id` | string | yes | Lotics file ID \u2014 pass this to view_files to read the contents (chat, MCP, CLI) |\n| `filename` | string | yes | |\n| `mime_type` | string | yes | |\n| `url` | string | yes | |\n\n### drive_query_files (workflow step)\n\n- Search the member\'s Google Drive using Drive query syntax. ## Query syntax Terms are `field operator value`; combine with `and` / `or` / `not`.\n- String values are single-quoted. - Name: `name = \'Rate card\'`, `name contains \'invoice\'` - Full text (body + title): `fullText contains \'CMA CGM\'` - Type: `mimeType = \'application/vnd.google-apps.spreadsheet\'`, `mimeType contains \'pdf\'` - Folder: `\'<folder_id>\' in parents` - Time (RFC 3339): `modifiedTime > \'2026-01-01T00:00:00\'` - Exclude deleted: `trashed = false` (always worth adding) - Starred / shared: `starred = true`, `sharedWithMe = true` Google-native types: `application/vnd.google-apps.document` (Docs), `.spreadsheet` (Sheets), `.presentation` (Slides), `.folder`.\n- Examples: - `name contains \'packing list\' and trashed = false` - `\'1a2b3c\' in parents and modifiedTime > \'2026-08-01T00:00:00\'` - `fullText contains \'demurrage\' and mimeType = \'application/vnd.google-apps.document\'` Results carry enough metadata (name, type, modified time, size, owner) to pick a file WITHOUT importing it.\n- Import only the one you actually need \u2014 `drive_import_file` persists a copy in the workspace. (workflow step, chat)\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | The ID of the connected Google Drive account to use |\n| `query` | string | yes | Drive query syntax expression |\n| `max_result` | number | yes | Maximum number of files to retrieve (1-50) |\n| `order_by` | string | | Sort order, e.g. \'modifiedTime desc\', \'name\' |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `files` | object[] | yes | List of matching Drive files |\n| `files[].id` | string | yes | Drive file ID \u2014 pass this to drive_import_file (workflow step, chat) |\n| `files[].name` | string | yes | File name as it appears in Drive |\n| `files[].mime_type` | string | yes | Drive MIME type; \'application/vnd.google-apps.*\' means Google-native |\n| `files[].modified_time` | string \\\\| null | yes | RFC 3339 timestamp of the last modification |\n| `files[].size_bytes` | number \\\\| null | yes | Size in bytes; null for Google-native files, which have no stored size until exported |\n| `files[].owner` | string \\\\| null | yes | Email address of the file\'s owner |\n| `files[].web_view_link` | string \\\\| null | yes | URL to open the file in Drive |\n\n## easyinvoice\n\n### easyinvoice_attach_ikey (workflow step)\n\n- Give an invoice numbered on EasyInvoice\'s own site an ikey, so the other EasyInvoice tools can name it.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | EasyInvoice connected account |\n| `pattern` | string | | The invoice symbol, e.g. 1C26TAA (Th\xF4ng t\u01B0 78 puts the whole symbol here and leaves serial empty); needed when the account issues under more than one |\n| `serial` | string | | K\xFD hi\u1EC7u of a Th\xF4ng t\u01B0 32 range |\n| `no` | string | yes | The invoice\'s number |\n| `ikey` | string | yes | A new key of your own, at most 50 characters |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `ikey` | string | yes | |\n| `no` | string | yes | |\n\n### easyinvoice_cancel_invoice (workflow step)\n\n- Cancel an issued invoice.\n- Under Ngh\u1ECB \u0111\u1ECBnh 70 EasyInvoice may refuse, or issue a 0-\u0111\u1ED3ng replacement in its place and return it in Invoices.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | EasyInvoice connected account |\n| `pattern` | string | | The invoice symbol, e.g. 1C26TAA (Th\xF4ng t\u01B0 78 puts the whole symbol here and leaves serial empty); needed when the account issues under more than one |\n| `serial` | string | | K\xFD hi\u1EC7u of a Th\xF4ng t\u01B0 32 range |\n| `ikey` | string | yes | |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `Pattern` | string \\\\| null | yes | |\n| `Serial` | string \\\\| null | yes | |\n| `Invoices` | object[] | yes | |\n| `Invoices[].Ikey` | string \\\\| null | yes | |\n| `Invoices[].Pattern` | string \\\\| null | yes | |\n| `Invoices[].Serial` | string \\\\| null | yes | |\n| `Invoices[].No` | string \\\\| null | yes | The invoice number; empty until issued |\n| `Invoices[].InvoiceStatus` | number \\\\| null | yes | -1 reserved, 0 unsigned, 1 signed, 2 tax-declared, 3 replaced, 4 adjusted, 5 cancelled, 6 approved |\n| `Invoices[].TCTCheckStatus` | number \\\\| null | yes | Tax authority: null not sent, 0 not processed, -1 checking, 1 valid, -2 invalid |\n| `Invoices[].TCTErrorMessage` | string \\\\| null | yes | |\n| `Invoices[].TaxAuthorityCode` | string \\\\| null | yes | M\xE3 c\u1EE7a c\u01A1 quan thu\u1EBF, a few minutes after issuing |\n| `Invoices[].LookupCode` | string \\\\| null | yes | M\xE3 tra c\u1EE9u, which the buyer looks the invoice up by |\n| `Invoices[].LinkView` | string \\\\| null | yes | |\n| `Invoices[].ArisingDate` | string \\\\| null | yes | dd/MM/yyyy |\n| `Invoices[].IssueDate` | string \\\\| null | yes | dd/MM/yyyy |\n| `Invoices[].Buyer` | string \\\\| null | yes | |\n| `Invoices[].CustomerName` | string \\\\| null | yes | |\n| `Invoices[].CustomerCode` | string \\\\| null | yes | |\n| `Invoices[].CustomerTaxCode` | string \\\\| null | yes | |\n| `Invoices[].Total` | number \\\\| null | yes | |\n| `Invoices[].TaxAmount` | number \\\\| null | yes | |\n| `Invoices[].Amount` | number \\\\| null | yes | |\n\n### easyinvoice_convert_invoice (workflow step)\n\n- Convert an issued invoice to paper (b\u1EA3n chuy\u1EC3n \u0111\u1ED5i), to prove where goods came from or to archive, and save the PDF as a workspace file.\n- The invoice is named by ikey or by its lookup code.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | EasyInvoice connected account |\n| `purpose` | "proof_of_origin" \\\\| "archive" | yes | |\n| `ikey` | string | | |\n| `lookup_code` | string | | M\xE3 tra c\u1EE9u |\n| `pattern` | string | | The invoice symbol, e.g. 1C26TAA |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `file_id` | string | yes | The ID of the generated file. |\n| `url` | string | yes | The download URL of the generated file. |\n| `filename` | string | yes | The filename of the generated file, including extension. |\n| `mime_type` | string | yes | The MIME type of the generated file. |\n\n### easyinvoice_correct_invoice (workflow step)\n\n- Adjust or replace one issued invoice with a new invoice, in EasyInvoice\'s field names.\n- The new invoice\'s totals and amount in words are summed from its lines.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | EasyInvoice connected account |\n| `kind` | "adjust" \\\\| "replace" \\\\| "adjust_draft" \\\\| "replace_draft" | yes | adjust, replace: created and signed at once. adjust_draft, replace_draft: created unsigned, issued later by easyinvoice_issue_invoices. (workflow step, chat) |\n| `pattern` | string | | The invoice symbol, e.g. 1C26TAA (Th\xF4ng t\u01B0 78 puts the whole symbol here and leaves serial empty); needed when the account issues under more than one |\n| `serial` | string | | K\xFD hi\u1EC7u of a Th\xF4ng t\u01B0 32 range |\n| `original_ikey` | string | | Ikey of the invoice corrected |\n| `related_invoice` | object | | An original issued outside EasyInvoice, in place of original_ikey (adjust and replace only) |\n| `related_invoice.Pattern` | string | yes | |\n| `related_invoice.Serial` | string | yes | |\n| `related_invoice.No` | string | yes | |\n| `related_invoice.ArisingDate` | string | yes | The original\'s date, YYYY-MM-DD |\n| `related_invoice.RelatedType` | number | yes | 1 a Th\xF4ng t\u01B0 78 e-invoice; 3 a Th\xF4ng t\u01B0 32 or paper invoice |\n| `invoice` | object | yes | The new invoice; its Ikey is a new key of your own |\n| `invoice.Ikey` | string | yes | Your own key for this invoice, at most 50 characters; every later call names the invoice by it |\n| `invoice.ArisingDate` | string | yes | Invoice date, YYYY-MM-DD |\n| `invoice.PaymentMethod` | string | yes | Ti\u1EC1n m\u1EB7t, Chuy\u1EC3n kho\u1EA3n, Ti\u1EC1n m\u1EB7t/Chuy\u1EC3n kho\u1EA3n, \u0110\u1ED1i tr\u1EEB c\xF4ng n\u1EE3, Kh\xF4ng thu ti\u1EC1n, or other words printed as given |\n| `invoice.CurrencyUnit` | string | yes | VND, USD, EUR, \u2026 |\n| `invoice.ExchangeRate` | number | | Required unless VND |\n| `invoice.VATRate` | number | yes | 0, 5, 8, 10; -1 not taxable; -2 not declared; -3 another rate, stated in VATRateOther; -5 financial leasing; -6 outside the VAT law; -7 not in the taxable price |\n| `invoice.VATRateOther` | number | | |\n| `invoice.Products` | object[] | yes | |\n| `invoice.Products[].No` | number | | Printed line number; 0 prints none |\n| `invoice.Products[].Feature` | number | yes | 1 goods/service, 2 promotion, 3 commercial discount (positive, subtracted from the invoice), 4 note line, 5 special goods |\n| `invoice.Products[].Code` | string | | |\n| `invoice.Products[].ProdName` | string | yes | |\n| `invoice.Products[].BusinessProdGroupCode` | string | | Business group, e.g. 01_2 |\n| `invoice.Products[].ProdUnit` | string | | |\n| `invoice.Products[].ProdQuantity` | number | | |\n| `invoice.Products[].ProdPrice` | number | | |\n| `invoice.Products[].Discount` | number | | Line discount rate, % |\n| `invoice.Products[].DiscountAmount` | number | | |\n| `invoice.Products[].Total` | number | yes | Before VAT, after the line\'s own discount; 0 on a note line |\n| `invoice.Products[].VATRate` | number | | The invoice\'s VATRate when absent |\n| `invoice.Products[].VATRateOther` | number | | The rate when VATRate is -3 |\n| `invoice.Products[].VATAmount` | number | | Absent only on a note line |\n| `invoice.Products[].Extra` | string | | A JSON object: {"Pos":""} on a note line, the special-goods attributes on Feature 5 |\n| `invoice.CusCode` | string | | EasyInvoice files the buyer under this code, creating or updating it |\n| `invoice.Buyer` | string | | The buyer\'s personal name; this or CusName is required |\n| `invoice.CusName` | string | | The buyer company\'s name; required with CusTaxCode |\n| `invoice.CusTaxCode` | string | | |\n| `invoice.CusAddress` | string | | Required with CusTaxCode |\n| `invoice.CusEmails` | string | | Comma-separated; where the issuance notice goes |\n| `invoice.Email` | string | | |\n| `invoice.EmailCC` | string | | |\n| `invoice.CusBankName` | string | | |\n| `invoice.CusBankNo` | string | | |\n| `invoice.CusPhone` | string | | |\n| `invoice.CusIdentification` | string | | Buyer\'s citizen ID, 9 or 12 characters |\n| `invoice.PassportNo` | string | | |\n| `invoice.BudgetaryRelationshipCode` | string | | |\n| `invoice.ProvinceCode` | string | | |\n| `invoice.ProvinceName` | string | | |\n| `invoice.CommuneCode` | string | | |\n| `invoice.CommuneName` | string | | |\n| `invoice.LocationCode` | string | | Required for a household or individual business, with LocationName and LocationAddress |\n| `invoice.LocationName` | string | | |\n| `invoice.LocationAddress` | string | | |\n| `invoice.StoreCode` | string | | |\n| `invoice.StoreName` | string | | |\n| `invoice.Note` | string | | |\n| `invoice.ListAttachNum` | string | | Number of the b\u1EA3ng k\xEA the invoice carries |\n| `invoice.ListAttachDate` | string | | Its date, YYYY-MM-DD |\n| `invoice.IdentityCardNumber` | string | | National-reserve sale: the buyer\'s ID when they have no tax code |\n| `invoice.TaxAuthorityCode` | string | | An invoice made from a cash register: the code it already holds |\n| `invoice.ComRelateCode` | string | | Public-asset sale: the seller\'s budget unit code |\n| `invoice.CusRelateCode` | string | | Public-asset sale: the buyer\'s budget unit code |\n| `invoice.DecisionCode` | string | | |\n| `invoice.DecisionDate` | string | | YYYY-MM-DD |\n| `invoice.DecisionAgent` | string | | |\n| `invoice.SellMethod` | string | | |\n| `invoice.TransportAddress` | string | | |\n| `invoice.TransportDateFrom` | string | | YYYY-MM-DD |\n| `invoice.TransportDateTo` | string | | YYYY-MM-DD |\n| `invoice.Extra` | string | | A JSON object of fields agreed with EasyInvoice |\n| `invoice.AdjustReplaceReasonCode` | number | yes | 1\u201314 (Th\xF4ng t\u01B0 91 \u0110i\u1EC1u 10); 13 corrects an invoice issued wrong |\n| `invoice.Type` | number | | Required on an adjustment, absent on a replacement: 2 increase, 3 decrease, 4 information only |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `Pattern` | string \\\\| null | yes | |\n| `Serial` | string \\\\| null | yes | |\n| `Invoices` | object[] | yes | |\n| `Invoices[].Ikey` | string \\\\| null | yes | |\n| `Invoices[].Pattern` | string \\\\| null | yes | |\n| `Invoices[].Serial` | string \\\\| null | yes | |\n| `Invoices[].No` | string \\\\| null | yes | The invoice number; empty until issued |\n| `Invoices[].InvoiceStatus` | number \\\\| null | yes | -1 reserved, 0 unsigned, 1 signed, 2 tax-declared, 3 replaced, 4 adjusted, 5 cancelled, 6 approved |\n| `Invoices[].TCTCheckStatus` | number \\\\| null | yes | Tax authority: null not sent, 0 not processed, -1 checking, 1 valid, -2 invalid |\n| `Invoices[].TCTErrorMessage` | string \\\\| null | yes | |\n| `Invoices[].TaxAuthorityCode` | string \\\\| null | yes | M\xE3 c\u1EE7a c\u01A1 quan thu\u1EBF, a few minutes after issuing |\n| `Invoices[].LookupCode` | string \\\\| null | yes | M\xE3 tra c\u1EE9u, which the buyer looks the invoice up by |\n| `Invoices[].LinkView` | string \\\\| null | yes | |\n| `Invoices[].ArisingDate` | string \\\\| null | yes | dd/MM/yyyy |\n| `Invoices[].IssueDate` | string \\\\| null | yes | dd/MM/yyyy |\n| `Invoices[].Buyer` | string \\\\| null | yes | |\n| `Invoices[].CustomerName` | string \\\\| null | yes | |\n| `Invoices[].CustomerCode` | string \\\\| null | yes | |\n| `Invoices[].CustomerTaxCode` | string \\\\| null | yes | |\n| `Invoices[].Total` | number \\\\| null | yes | |\n| `Invoices[].TaxAmount` | number \\\\| null | yes | |\n| `Invoices[].Amount` | number \\\\| null | yes | |\n\n### easyinvoice_create_invoices (workflow step)\n\n- Create invoices on EasyInvoice, in its own field names.\n- An Ikey that already holds a draft updates that draft.\n- Each invoice\'s totals and amount in words are summed from its lines.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | EasyInvoice connected account |\n| `kind` | "draft" \\\\| "reserved" \\\\| "issue" | yes | draft: unsigned and unnumbered, deletable, issued later by easyinvoice_issue_invoices. reserved: numbered by its InvNo from a reserved range, awaiting signature. issue: created and signed at once. (workflow step, chat) |\n| `pattern` | string | | The invoice symbol, e.g. 1C26TAA (Th\xF4ng t\u01B0 78 puts the whole symbol here and leaves serial empty); needed when the account issues under more than one |\n| `serial` | string | | K\xFD hi\u1EC7u of a Th\xF4ng t\u01B0 32 range |\n| `invoices` | object[] | yes | |\n| `invoices[].Ikey` | string | yes | Your own key for this invoice, at most 50 characters; every later call names the invoice by it |\n| `invoices[].ArisingDate` | string | yes | Invoice date, YYYY-MM-DD |\n| `invoices[].PaymentMethod` | string | yes | Ti\u1EC1n m\u1EB7t, Chuy\u1EC3n kho\u1EA3n, Ti\u1EC1n m\u1EB7t/Chuy\u1EC3n kho\u1EA3n, \u0110\u1ED1i tr\u1EEB c\xF4ng n\u1EE3, Kh\xF4ng thu ti\u1EC1n, or other words printed as given |\n| `invoices[].CurrencyUnit` | string | yes | VND, USD, EUR, \u2026 |\n| `invoices[].ExchangeRate` | number | | Required unless VND |\n| `invoices[].VATRate` | number | yes | 0, 5, 8, 10; -1 not taxable; -2 not declared; -3 another rate, stated in VATRateOther; -5 financial leasing; -6 outside the VAT law; -7 not in the taxable price |\n| `invoices[].VATRateOther` | number | | |\n| `invoices[].Products` | object[] | yes | |\n| `invoices[].Products[].No` | number | | Printed line number; 0 prints none |\n| `invoices[].Products[].Feature` | number | yes | 1 goods/service, 2 promotion, 3 commercial discount (positive, subtracted from the invoice), 4 note line, 5 special goods |\n| `invoices[].Products[].Code` | string | | |\n| `invoices[].Products[].ProdName` | string | yes | |\n| `invoices[].Products[].BusinessProdGroupCode` | string | | Business group, e.g. 01_2 |\n| `invoices[].Products[].ProdUnit` | string | | |\n| `invoices[].Products[].ProdQuantity` | number | | |\n| `invoices[].Products[].ProdPrice` | number | | |\n| `invoices[].Products[].Discount` | number | | Line discount rate, % |\n| `invoices[].Products[].DiscountAmount` | number | | |\n| `invoices[].Products[].Total` | number | yes | Before VAT, after the line\'s own discount; 0 on a note line |\n| `invoices[].Products[].VATRate` | number | | The invoice\'s VATRate when absent |\n| `invoices[].Products[].VATRateOther` | number | | The rate when VATRate is -3 |\n| `invoices[].Products[].VATAmount` | number | | Absent only on a note line |\n| `invoices[].Products[].Extra` | string | | A JSON object: {"Pos":""} on a note line, the special-goods attributes on Feature 5 |\n| `invoices[].CusCode` | string | | EasyInvoice files the buyer under this code, creating or updating it |\n| `invoices[].Buyer` | string | | The buyer\'s personal name; this or CusName is required |\n| `invoices[].CusName` | string | | The buyer company\'s name; required with CusTaxCode |\n| `invoices[].CusTaxCode` | string | | |\n| `invoices[].CusAddress` | string | | Required with CusTaxCode |\n| `invoices[].CusEmails` | string | | Comma-separated; where the issuance notice goes |\n| `invoices[].Email` | string | | |\n| `invoices[].EmailCC` | string | | |\n| `invoices[].CusBankName` | string | | |\n| `invoices[].CusBankNo` | string | | |\n| `invoices[].CusPhone` | string | | |\n| `invoices[].CusIdentification` | string | | Buyer\'s citizen ID, 9 or 12 characters |\n| `invoices[].PassportNo` | string | | |\n| `invoices[].BudgetaryRelationshipCode` | string | | |\n| `invoices[].ProvinceCode` | string | | |\n| `invoices[].ProvinceName` | string | | |\n| `invoices[].CommuneCode` | string | | |\n| `invoices[].CommuneName` | string | | |\n| `invoices[].LocationCode` | string | | Required for a household or individual business, with LocationName and LocationAddress |\n| `invoices[].LocationName` | string | | |\n| `invoices[].LocationAddress` | string | | |\n| `invoices[].StoreCode` | string | | |\n| `invoices[].StoreName` | string | | |\n| `invoices[].Note` | string | | |\n| `invoices[].ListAttachNum` | string | | Number of the b\u1EA3ng k\xEA the invoice carries |\n| `invoices[].ListAttachDate` | string | | Its date, YYYY-MM-DD |\n| `invoices[].IdentityCardNumber` | string | | National-reserve sale: the buyer\'s ID when they have no tax code |\n| `invoices[].TaxAuthorityCode` | string | | An invoice made from a cash register: the code it already holds |\n| `invoices[].ComRelateCode` | string | | Public-asset sale: the seller\'s budget unit code |\n| `invoices[].CusRelateCode` | string | | Public-asset sale: the buyer\'s budget unit code |\n| `invoices[].DecisionCode` | string | | |\n| `invoices[].DecisionDate` | string | | YYYY-MM-DD |\n| `invoices[].DecisionAgent` | string | | |\n| `invoices[].SellMethod` | string | | |\n| `invoices[].TransportAddress` | string | | |\n| `invoices[].TransportDateFrom` | string | | YYYY-MM-DD |\n| `invoices[].TransportDateTo` | string | | YYYY-MM-DD |\n| `invoices[].Extra` | string | | A JSON object of fields agreed with EasyInvoice |\n| `invoices[].InvNo` | number | | The number, from a reserved range; only on reserved invoices |\n| `invoices[].StoreAddress` | string | | |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `Pattern` | string \\\\| null | yes | |\n| `Serial` | string \\\\| null | yes | |\n| `Invoices` | object[] | yes | |\n| `Invoices[].Ikey` | string \\\\| null | yes | |\n| `Invoices[].Pattern` | string \\\\| null | yes | |\n| `Invoices[].Serial` | string \\\\| null | yes | |\n| `Invoices[].No` | string \\\\| null | yes | The invoice number; empty until issued |\n| `Invoices[].InvoiceStatus` | number \\\\| null | yes | -1 reserved, 0 unsigned, 1 signed, 2 tax-declared, 3 replaced, 4 adjusted, 5 cancelled, 6 approved |\n| `Invoices[].TCTCheckStatus` | number \\\\| null | yes | Tax authority: null not sent, 0 not processed, -1 checking, 1 valid, -2 invalid |\n| `Invoices[].TCTErrorMessage` | string \\\\| null | yes | |\n| `Invoices[].TaxAuthorityCode` | string \\\\| null | yes | M\xE3 c\u1EE7a c\u01A1 quan thu\u1EBF, a few minutes after issuing |\n| `Invoices[].LookupCode` | string \\\\| null | yes | M\xE3 tra c\u1EE9u, which the buyer looks the invoice up by |\n| `Invoices[].LinkView` | string \\\\| null | yes | |\n| `Invoices[].ArisingDate` | string \\\\| null | yes | dd/MM/yyyy |\n| `Invoices[].IssueDate` | string \\\\| null | yes | dd/MM/yyyy |\n| `Invoices[].Buyer` | string \\\\| null | yes | |\n| `Invoices[].CustomerName` | string \\\\| null | yes | |\n| `Invoices[].CustomerCode` | string \\\\| null | yes | |\n| `Invoices[].CustomerTaxCode` | string \\\\| null | yes | |\n| `Invoices[].Total` | number \\\\| null | yes | |\n| `Invoices[].TaxAmount` | number \\\\| null | yes | |\n| `Invoices[].Amount` | number \\\\| null | yes | |\n\n### easyinvoice_delete_draft (workflow step)\n\n- Delete an invoice that was never signed.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | EasyInvoice connected account |\n| `pattern` | string | | The invoice symbol, e.g. 1C26TAA (Th\xF4ng t\u01B0 78 puts the whole symbol here and leaves serial empty); needed when the account issues under more than one |\n| `serial` | string | | K\xFD hi\u1EC7u of a Th\xF4ng t\u01B0 32 range |\n| `ikey` | string | yes | |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `deleted_ikey` | string | yes | |\n\n### easyinvoice_get_invoice_file (workflow step)\n\n- Save an invoice\'s PDF or XML as a workspace file, the invoice named by ikey or by its lookup code.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | EasyInvoice connected account |\n| `format` | "xml" \\\\| "pdf" | yes | |\n| `ikey` | string | | |\n| `lookup_code` | string | | M\xE3 tra c\u1EE9u |\n| `pattern` | string | | The invoice symbol, e.g. 1C26TAA |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `file_id` | string | yes | The ID of the generated file. |\n| `url` | string | yes | The download URL of the generated file. |\n| `filename` | string | yes | The filename of the generated file, including extension. |\n| `mime_type` | string | yes | The MIME type of the generated file. |\n\n### easyinvoice_get_invoices (workflow step)\n\n- Read invoices by their ikeys: status, number, lookup code and the tax authority\'s verdict and code.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | EasyInvoice connected account |\n| `ikeys` | string[] | yes | |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `invoices` | object[] | yes | |\n| `invoices[].Ikey` | string \\\\| null | yes | |\n| `invoices[].Pattern` | string \\\\| null | yes | |\n| `invoices[].Serial` | string \\\\| null | yes | |\n| `invoices[].No` | string \\\\| null | yes | The invoice number; empty until issued |\n| `invoices[].InvoiceStatus` | number \\\\| null | yes | -1 reserved, 0 unsigned, 1 signed, 2 tax-declared, 3 replaced, 4 adjusted, 5 cancelled, 6 approved |\n| `invoices[].TCTCheckStatus` | number \\\\| null | yes | Tax authority: null not sent, 0 not processed, -1 checking, 1 valid, -2 invalid |\n| `invoices[].TCTErrorMessage` | string \\\\| null | yes | |\n| `invoices[].TaxAuthorityCode` | string \\\\| null | yes | M\xE3 c\u1EE7a c\u01A1 quan thu\u1EBF, a few minutes after issuing |\n| `invoices[].LookupCode` | string \\\\| null | yes | M\xE3 tra c\u1EE9u, which the buyer looks the invoice up by |\n| `invoices[].LinkView` | string \\\\| null | yes | |\n| `invoices[].ArisingDate` | string \\\\| null | yes | dd/MM/yyyy |\n| `invoices[].IssueDate` | string \\\\| null | yes | dd/MM/yyyy |\n| `invoices[].Buyer` | string \\\\| null | yes | |\n| `invoices[].CustomerName` | string \\\\| null | yes | |\n| `invoices[].CustomerCode` | string \\\\| null | yes | |\n| `invoices[].CustomerTaxCode` | string \\\\| null | yes | |\n| `invoices[].Total` | number \\\\| null | yes | |\n| `invoices[].TaxAmount` | number \\\\| null | yes | |\n| `invoices[].Amount` | number \\\\| null | yes | |\n\n### easyinvoice_get_report (workflow step)\n\n- Save a period\'s invoice-usage report (BC26/AC) or listing of sales documents (b\u1EA3ng k\xEA) as a workspace file.\n- The htkk kinds are for import into HTKK.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | EasyInvoice connected account |\n| `kind` | "usage_excel" \\\\| "usage_htkk_excel" \\\\| "usage_htkk_xml" \\\\| "sales_listing_html" \\\\| "sales_listing_excel" | yes | |\n| `from_date` | string | yes | YYYY-MM-DD |\n| `to_date` | string | yes | YYYY-MM-DD |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `file_id` | string | yes | The ID of the generated file. |\n| `url` | string | yes | The download URL of the generated file. |\n| `filename` | string | yes | The filename of the generated file, including extension. |\n| `mime_type` | string | yes | The MIME type of the generated file. |\n\n### easyinvoice_issue_invoices (workflow step)\n\n- Sign and issue drafts and reserved invoices, all under one symbol.\n- An issued invoice goes to the tax authority and is corrected only by adjustment or replacement.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | EasyInvoice connected account |\n| `pattern` | string | yes | The invoice symbol they share, e.g. 1C26TAA |\n| `serial` | string | | K\xFD hi\u1EC7u of a Th\xF4ng t\u01B0 32 range |\n| `ikeys` | string[] | yes | |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `Pattern` | string \\\\| null | yes | |\n| `Serial` | string \\\\| null | yes | |\n| `Invoices` | object[] | yes | |\n| `Invoices[].Ikey` | string \\\\| null | yes | |\n| `Invoices[].Pattern` | string \\\\| null | yes | |\n| `Invoices[].Serial` | string \\\\| null | yes | |\n| `Invoices[].No` | string \\\\| null | yes | The invoice number; empty until issued |\n| `Invoices[].InvoiceStatus` | number \\\\| null | yes | -1 reserved, 0 unsigned, 1 signed, 2 tax-declared, 3 replaced, 4 adjusted, 5 cancelled, 6 approved |\n| `Invoices[].TCTCheckStatus` | number \\\\| null | yes | Tax authority: null not sent, 0 not processed, -1 checking, 1 valid, -2 invalid |\n| `Invoices[].TCTErrorMessage` | string \\\\| null | yes | |\n| `Invoices[].TaxAuthorityCode` | string \\\\| null | yes | M\xE3 c\u1EE7a c\u01A1 quan thu\u1EBF, a few minutes after issuing |\n| `Invoices[].LookupCode` | string \\\\| null | yes | M\xE3 tra c\u1EE9u, which the buyer looks the invoice up by |\n| `Invoices[].LinkView` | string \\\\| null | yes | |\n| `Invoices[].ArisingDate` | string \\\\| null | yes | dd/MM/yyyy |\n| `Invoices[].IssueDate` | string \\\\| null | yes | dd/MM/yyyy |\n| `Invoices[].Buyer` | string \\\\| null | yes | |\n| `Invoices[].CustomerName` | string \\\\| null | yes | |\n| `Invoices[].CustomerCode` | string \\\\| null | yes | |\n| `Invoices[].CustomerTaxCode` | string \\\\| null | yes | |\n| `Invoices[].Total` | number \\\\| null | yes | |\n| `Invoices[].TaxAmount` | number \\\\| null | yes | |\n| `Invoices[].Amount` | number \\\\| null | yes | |\n\n### easyinvoice_list_invoices (workflow step)\n\n- List invoices dated within a window, a page at a time.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | EasyInvoice connected account |\n| `from_date` | string | yes | YYYY-MM-DD |\n| `to_date` | string | yes | YYYY-MM-DD |\n| `page` | number | | 1-based |\n| `page_size` | number | | At most 100 |\n| `pattern` | string | | Only invoices under this symbol |\n| `include_web_invoices` | boolean | | Also invoices made on EasyInvoice\'s own site, not only through this connection\'s API |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `page` | number \\\\| null | yes | |\n| `page_size` | number \\\\| null | yes | |\n| `total_records` | number \\\\| null | yes | |\n| `total_pages` | number \\\\| null | yes | |\n| `invoices` | object[] | yes | |\n| `invoices[].Ikey` | string \\\\| null | yes | |\n| `invoices[].Pattern` | string \\\\| null | yes | |\n| `invoices[].Serial` | string \\\\| null | yes | |\n| `invoices[].No` | string \\\\| null | yes | The invoice number; empty until issued |\n| `invoices[].InvoiceStatus` | number \\\\| null | yes | -1 reserved, 0 unsigned, 1 signed, 2 tax-declared, 3 replaced, 4 adjusted, 5 cancelled, 6 approved |\n| `invoices[].TCTCheckStatus` | number \\\\| null | yes | Tax authority: null not sent, 0 not processed, -1 checking, 1 valid, -2 invalid |\n| `invoices[].TCTErrorMessage` | string \\\\| null | yes | |\n| `invoices[].TaxAuthorityCode` | string \\\\| null | yes | M\xE3 c\u1EE7a c\u01A1 quan thu\u1EBF, a few minutes after issuing |\n| `invoices[].LookupCode` | string \\\\| null | yes | M\xE3 tra c\u1EE9u, which the buyer looks the invoice up by |\n| `invoices[].LinkView` | string \\\\| null | yes | |\n| `invoices[].ArisingDate` | string \\\\| null | yes | dd/MM/yyyy |\n| `invoices[].IssueDate` | string \\\\| null | yes | dd/MM/yyyy |\n| `invoices[].Buyer` | string \\\\| null | yes | |\n| `invoices[].CustomerName` | string \\\\| null | yes | |\n| `invoices[].CustomerCode` | string \\\\| null | yes | |\n| `invoices[].CustomerTaxCode` | string \\\\| null | yes | |\n| `invoices[].Total` | number \\\\| null | yes | |\n| `invoices[].TaxAmount` | number \\\\| null | yes | |\n| `invoices[].Amount` | number \\\\| null | yes | |\n\n### easyinvoice_list_reserved_numbers (workflow step)\n\n- List the numbers of a reserved range still waiting to be signed.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | EasyInvoice connected account |\n| `pattern` | string | yes | The invoice symbol, e.g. 1C26TAA |\n| `serial` | string | yes | Empty under Th\xF4ng t\u01B0 78 |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `numbers` | string[] | yes | |\n\n### easyinvoice_preview_invoice (workflow step)\n\n- Save how an invoice would print, as a PDF or HTML workspace file, before it is created.\n- Nothing is created on EasyInvoice.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | EasyInvoice connected account |\n| `kind` | "invoice" \\\\| "replacement" \\\\| "adjustment_increase" \\\\| "adjustment_decrease" \\\\| "adjustment_information" | yes | invoice: a new one. The others: a replacement or adjustment, whose invoice states its AdjustReplaceReasonCode |\n| `format` | "pdf" \\\\| "html" | yes | |\n| `pattern` | string | | The invoice symbol, e.g. 1C26TAA (Th\xF4ng t\u01B0 78 puts the whole symbol here and leaves serial empty); needed when the account issues under more than one |\n| `serial` | string | | K\xFD hi\u1EC7u of a Th\xF4ng t\u01B0 32 range |\n| `invoice` | object | yes | |\n| `invoice.Ikey` | string | yes | Your own key for this invoice, at most 50 characters; every later call names the invoice by it |\n| `invoice.ArisingDate` | string | yes | Invoice date, YYYY-MM-DD |\n| `invoice.PaymentMethod` | string | yes | Ti\u1EC1n m\u1EB7t, Chuy\u1EC3n kho\u1EA3n, Ti\u1EC1n m\u1EB7t/Chuy\u1EC3n kho\u1EA3n, \u0110\u1ED1i tr\u1EEB c\xF4ng n\u1EE3, Kh\xF4ng thu ti\u1EC1n, or other words printed as given |\n| `invoice.CurrencyUnit` | string | yes | VND, USD, EUR, \u2026 |\n| `invoice.ExchangeRate` | number | | Required unless VND |\n| `invoice.VATRate` | number | yes | 0, 5, 8, 10; -1 not taxable; -2 not declared; -3 another rate, stated in VATRateOther; -5 financial leasing; -6 outside the VAT law; -7 not in the taxable price |\n| `invoice.VATRateOther` | number | | |\n| `invoice.Products` | object[] | yes | |\n| `invoice.Products[].No` | number | | Printed line number; 0 prints none |\n| `invoice.Products[].Feature` | number | yes | 1 goods/service, 2 promotion, 3 commercial discount (positive, subtracted from the invoice), 4 note line, 5 special goods |\n| `invoice.Products[].Code` | string | | |\n| `invoice.Products[].ProdName` | string | yes | |\n| `invoice.Products[].BusinessProdGroupCode` | string | | Business group, e.g. 01_2 |\n| `invoice.Products[].ProdUnit` | string | | |\n| `invoice.Products[].ProdQuantity` | number | | |\n| `invoice.Products[].ProdPrice` | number | | |\n| `invoice.Products[].Discount` | number | | Line discount rate, % |\n| `invoice.Products[].DiscountAmount` | number | | |\n| `invoice.Products[].Total` | number | yes | Before VAT, after the line\'s own discount; 0 on a note line |\n| `invoice.Products[].VATRate` | number | | The invoice\'s VATRate when absent |\n| `invoice.Products[].VATRateOther` | number | | The rate when VATRate is -3 |\n| `invoice.Products[].VATAmount` | number | | Absent only on a note line |\n| `invoice.Products[].Extra` | string | | A JSON object: {"Pos":""} on a note line, the special-goods attributes on Feature 5 |\n| `invoice.CusCode` | string | | EasyInvoice files the buyer under this code, creating or updating it |\n| `invoice.Buyer` | string | | The buyer\'s personal name; this or CusName is required |\n| `invoice.CusName` | string | | The buyer company\'s name; required with CusTaxCode |\n| `invoice.CusTaxCode` | string | | |\n| `invoice.CusAddress` | string | | Required with CusTaxCode |\n| `invoice.CusEmails` | string | | Comma-separated; where the issuance notice goes |\n| `invoice.Email` | string | | |\n| `invoice.EmailCC` | string | | |\n| `invoice.CusBankName` | string | | |\n| `invoice.CusBankNo` | string | | |\n| `invoice.CusPhone` | string | | |\n| `invoice.CusIdentification` | string | | Buyer\'s citizen ID, 9 or 12 characters |\n| `invoice.PassportNo` | string | | |\n| `invoice.BudgetaryRelationshipCode` | string | | |\n| `invoice.ProvinceCode` | string | | |\n| `invoice.ProvinceName` | string | | |\n| `invoice.CommuneCode` | string | | |\n| `invoice.CommuneName` | string | | |\n| `invoice.LocationCode` | string | | Required for a household or individual business, with LocationName and LocationAddress |\n| `invoice.LocationName` | string | | |\n| `invoice.LocationAddress` | string | | |\n| `invoice.StoreCode` | string | | |\n| `invoice.StoreName` | string | | |\n| `invoice.Note` | string | | |\n| `invoice.ListAttachNum` | string | | Number of the b\u1EA3ng k\xEA the invoice carries |\n| `invoice.ListAttachDate` | string | | Its date, YYYY-MM-DD |\n| `invoice.IdentityCardNumber` | string | | National-reserve sale: the buyer\'s ID when they have no tax code |\n| `invoice.TaxAuthorityCode` | string | | An invoice made from a cash register: the code it already holds |\n| `invoice.ComRelateCode` | string | | Public-asset sale: the seller\'s budget unit code |\n| `invoice.CusRelateCode` | string | | Public-asset sale: the buyer\'s budget unit code |\n| `invoice.DecisionCode` | string | | |\n| `invoice.DecisionDate` | string | | YYYY-MM-DD |\n| `invoice.DecisionAgent` | string | | |\n| `invoice.SellMethod` | string | | |\n| `invoice.TransportAddress` | string | | |\n| `invoice.TransportDateFrom` | string | | YYYY-MM-DD |\n| `invoice.TransportDateTo` | string | | YYYY-MM-DD |\n| `invoice.Extra` | string | | A JSON object of fields agreed with EasyInvoice |\n| `invoice.AdjustReplaceReasonCode` | number | | 1\u201314 (Th\xF4ng t\u01B0 91 \u0110i\u1EC1u 10); 13 corrects an invoice issued wrong |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `file_id` | string | yes | The ID of the generated file. |\n| `url` | string | yes | The download URL of the generated file. |\n| `filename` | string | yes | The filename of the generated file, including extension. |\n| `mime_type` | string | yes | The MIME type of the generated file. |\n\n### easyinvoice_reserve_numbers (workflow step)\n\n- Reserve invoice numbers in a range, for invoices created later with kind reserved.\n- Give quantity or ikey_dates.\n- EasyInvoice must have granted the account reserved ranges.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | EasyInvoice connected account |\n| `pattern` | string | yes | The invoice symbol, e.g. 1C26TAA |\n| `serial` | string | yes | Empty under Th\xF4ng t\u01B0 78 |\n| `quantity` | number | | |\n| `ikey_dates` | object | | Ikey \u2192 invoice date (YYYY-MM-DD): one number each |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `Pattern` | string \\\\| null | yes | |\n| `Serial` | string \\\\| null | yes | |\n| `numbers` | string[] | yes | Reserved by quantity |\n| `by_ikey` | object | yes | Reserved by ikey: ikey \u2192 number |\n\n### easyinvoice_save_customers (workflow step)\n\n- Create or update customers in EasyInvoice\'s customer list, in its own field names.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | EasyInvoice connected account |\n| `customers` | object[] | yes | |\n| `customers[].Code` | string | yes | Fixed once created |\n| `customers[].AccountName` | string | yes | The buyer\'s lookup account; fixed once created |\n| `customers[].Name` | string | yes | |\n| `customers[].Buyer` | string | | |\n| `customers[].Address` | string | | |\n| `customers[].TaxCode` | string | | Required for a company |\n| `customers[].BankName` | string | | |\n| `customers[].BankAccountName` | string | | |\n| `customers[].BankNumber` | string | | |\n| `customers[].Email` | string | | |\n| `customers[].EmailCC` | string | | Comma-separated |\n| `customers[].Fax` | string | | |\n| `customers[].Phone` | string | | |\n| `customers[].ContactPerson` | string | | |\n| `customers[].RepresentPerson` | string | | |\n| `customers[].CusType` | number | | 1 the customer keeps accounts, 0 not |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `saved` | number | yes | |\n\n### easyinvoice_save_products (workflow step)\n\n- Create or update products and services in EasyInvoice\'s product list, in its own field names.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | EasyInvoice connected account |\n| `products` | object[] | yes | |\n| `products[].Code` | string | yes | |\n| `products[].Name` | string | yes | |\n| `products[].Price` | number | | |\n| `products[].Unit` | string | | |\n| `products[].Des` | string | | |\n| `products[].VATRate` | number | yes | As on an invoice line |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `saved` | number | yes | |\n\n### easyinvoice_send_error_notice (workflow step)\n\n- File an error notice (04/SS-H\u0110\u0110T) with the tax authority for erroneous invoices, through EasyInvoice.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | EasyInvoice connected account |\n| `notice_type` | number | yes | 1 the seller\'s own notice; 2 answering a notice from the tax authority |\n| `created_date` | string | yes | YYYY-MM-DD |\n| `tax_authority_notice_no` | string | | Type 2: the tax authority\'s notice number |\n| `tax_authority_notice_date` | string | | Type 2: its date, YYYY-MM-DD |\n| `invoices` | object[] | yes | |\n| `invoices[].Pattern` | string | yes | |\n| `invoices[].Serial` | string | | |\n| `invoices[].No` | number | yes | |\n| `invoices[].ArisingDate` | string | yes | YYYY-MM-DD |\n| `invoices[].TaxAuthorityCode` | string | | Required unless the invoice carries none |\n| `invoices[].InvType` | number | yes | 1 N\u0110 123/2020 e-invoice; 2 authenticated under Q\u0110 1209/2660; 3 under N\u0110 51/2010 or 04/2014; 4 printed to order under N\u0110 123/2020 |\n| `invoices[].Note` | string | yes | The reason |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `sent` | number | yes | Invoices the notice names |\n\n### easyinvoice_send_issuance_notice (workflow step)\n\n- Send invoices\' issuance notices again, each to the address given for it.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | EasyInvoice connected account |\n| `emails` | object | yes | Ikey \u2192 email address |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `results` | object | yes | Ikey \u2192 EasyInvoice\'s answer for it, sent or refused |\n\n## evaluate\n\n### evaluate_formula (workflow step)\n\n- Compute a formula over one record as its table\'s own formula fields compute: fields referenced as `{alias}`, lookups and rollups read as the row holds them.\n- Writes nothing.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `table_id` | string | yes | |\n| `record_id` | string | yes | |\n| `expression` | string | yes | |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `value` | number \\\\| string \\\\| boolean \\\\| null | yes | |\n\n## excel\n\n### excel_get_rows (workflow step)\n\n- Read every row of a sheet in an .xlsx, .xls or .csv file as a list of objects keyed by the header row\'s text.\n- A cell is its typed value: a number, true or false, text, a date as ISO text ("2026-03-02", "2026-03-02T09:30:00", or "09:30:00" for a time alone), null when blank.\n- A formula cell is the value the file last computed; an error cell is its code as text ("#N/A").\n- Every CSV cell is text or null.\n- A header cell inside a merge takes the merge\'s text; a blank header is keyed by its column letter ("C"), and a header text that repeats gets its column letter added ("Amount (F)"). headers lists the keys in sheet order.\n- Rows above header_row and rows blank in every column are left out.\n- One call reads a sheet of at most 10000 rows, its header counted, and returns at most 250000 cells (rows \xD7 kept columns); a sheet past either is refused with its row count, never cut short.\n- Read-only.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `file_id` | string | yes | A stored file\'s id. A files field read in a workflow holds file objects: first(record.file).id |\n| `worksheet` | string \\\\| number | | Sheet name, or 0-based index. |\n| `header_row` | number | | 1-based row holding the headers. |\n| `columns` | string[] | | Keys to keep, as headers lists them. |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `file_id` | string | yes | |\n| `worksheet_name` | string | yes | |\n| `header_row` | number | yes | |\n| `headers` | string[] | yes | The key of each returned column, in sheet order |\n| `row_count` | number | yes | |\n| `rows` | object[] | yes | |\n\n## facebook\n\n### facebook_create_post (workflow step)\n\n- Publish a post to a Facebook Page feed.\n- Requires a Facebook connected account whose page allows content management.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | |\n| `page_id` | string | yes | Facebook Page to post to \u2014 one of the connected account\'s managed pages. |\n| `message` | string | yes | |\n| `link` | string | | A post carries either a link or media. |\n| `media_file_ids` | string[] | | Photos, or one video on its own. |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `post_id` | string | yes | |\n| `url` | string | yes | |\n\n### facebook_list_comments (workflow step)\n\n- Read the most recent comments left on a Facebook Page\'s posts.\n- Reply with facebook_reply_to_comment, passing the comment_id. (workflow step, chat)\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | |\n| `page_id` | string | yes | One of the connected account\'s managed pages. |\n| `limit` | integer | | |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `comments` | object[] | yes | |\n| `comments[].comment_id` | string | yes | |\n| `comments[].post_id` | string | yes | |\n| `comments[].author_id` | string | yes | |\n| `comments[].author_name` | string | yes | |\n| `comments[].message` | string | yes | |\n| `comments[].created_time` | string | yes | |\n\n### facebook_list_conversations (workflow step)\n\n- Read a Facebook Page\'s Messenger conversations with their recent messages.\n- Answer someone with facebook_send_message, passing the person_id. (workflow step, chat)\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | |\n| `page_id` | string | yes | One of the connected account\'s managed pages. |\n| `limit` | integer | | |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `conversations` | object[] | yes | |\n| `conversations[].conversation_id` | string | yes | |\n| `conversations[].person_id` | string \\\\| null | yes | |\n| `conversations[].person_name` | string \\\\| null | yes | |\n| `conversations[].messages` | object[] | yes | |\n| `conversations[].messages[].from_id` | string | yes | |\n| `conversations[].messages[].from_name` | string | yes | |\n| `conversations[].messages[].message` | string | yes | |\n| `conversations[].messages[].created_time` | string | yes | |\n\n### facebook_reply_to_comment (workflow step)\n\n- Reply publicly to a comment on a Facebook Page post, as the page.\n- The reply is visible to everyone who can see the comment.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | |\n| `page_id` | string | yes | The page that owns the post the comment is on. |\n| `comment_id` | string | yes | From facebook_list_comments. (workflow step, chat) |\n| `message` | string | yes | |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `comment_id` | string | yes | The reply\'s own id. |\n\n### facebook_send_message (workflow step)\n\n- Answer someone who messaged a Facebook Page, as the page.\n- Meta accepts a reply only within 24 hours of that person\'s last message.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | |\n| `page_id` | string | yes | The page the person wrote to. |\n| `person_id` | string | yes | From facebook_list_conversations. Page-scoped to this page. (workflow step, chat) |\n| `message` | string | yes | |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `message_id` | string | yes | |\n\n## fedex\n\n### fedex_cancel_draft (workflow step)\n\n- Cancel (delete) an unconfirmed FedEx draft (Open Ship) booking by its reference.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | FedEx connected account |\n| `reference` | string | yes | The draft\'s reference (Open Ship index) |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `cancelled` | boolean | yes | |\n\n### fedex_confirm_shipment (workflow step)\n\n- Confirm a FedEx draft (Open Ship) booking by its reference, generating the label / AWB.\n- Returns the master tracking number and any piece tracking numbers + label URLs.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | FedEx connected account |\n| `reference` | string | yes | The draft\'s reference (Open Ship index) from fedex_create_draft_shipment (workflow step, chat) |\n| `master_tracking_number` | string | | The master_tracking_number returned by fedex_create_draft_shipment \u2014 required to finalize the label (workflow step, chat) |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `master_tracking_number` | string | | |\n| `tracking_numbers` | string[] | yes | |\n| `label_urls` | string[] | yes | |\n\n### fedex_create_draft_shipment (workflow step)\n\n- Create a FedEx draft (Open Ship) booking \u2014 no label yet.\n- Confirm later with fedex_confirm_shipment. reference is a unique key you choose (e.g. the shipment order number) used to confirm or cancel. (workflow step, chat)\n- Supports multiple packages, special services, and (international) customs commodities.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | FedEx connected account |\n| `reference` | string | yes | Unique key for this draft (the Open Ship index) |\n| `shipper` | object | yes | |\n| `shipper.contact` | object | | |\n| `shipper.contact.person_name` | string | | |\n| `shipper.contact.company_name` | string | | |\n| `shipper.contact.phone_number` | string | | |\n| `shipper.address` | object | yes | |\n| `shipper.address.postal_code` | string | yes | |\n| `shipper.address.country_code` | string | yes | ISO 3166-1 alpha-2 country code, e.g. VN, US, SG |\n| `shipper.address.city` | string | | |\n| `shipper.address.state_or_province_code` | string | | |\n| `shipper.address.street_lines` | string[] | | |\n| `shipper.address.residential` | boolean | | |\n| `recipient` | object | yes | |\n| `recipient.contact` | object | | |\n| `recipient.contact.person_name` | string | | |\n| `recipient.contact.company_name` | string | | |\n| `recipient.contact.phone_number` | string | | |\n| `recipient.address` | object | yes | |\n| `recipient.address.postal_code` | string | yes | |\n| `recipient.address.country_code` | string | yes | ISO 3166-1 alpha-2 country code, e.g. VN, US, SG |\n| `recipient.address.city` | string | | |\n| `recipient.address.state_or_province_code` | string | | |\n| `recipient.address.street_lines` | string[] | | |\n| `recipient.address.residential` | boolean | | |\n| `service_type` | string | yes | FedEx service type e.g. INTERNATIONAL_PRIORITY |\n| `packaging_type` | string | | FedEx packaging type e.g. YOUR_PACKAGING |\n| `packages` | object[] | yes | One entry per package; weight in kg |\n| `packages[].weight` | number | yes | |\n| `packages[].weight_units` | "KG" \\\\| "LB" | | Weight units; FedEx requires LB for US domestic express |\n| `packages[].length` | number | | |\n| `packages[].width` | number | | |\n| `packages[].height` | number | | |\n| `packages[].dimension_units` | "CM" \\\\| "IN" | | |\n| `ship_datestamp` | string | | Ship date YYYY-MM-DD |\n| `pickup_type` | string | | FedEx pickup type e.g. USE_SCHEDULED_PICKUP |\n| `special_services` | string[] | | FedEx special service types e.g. SATURDAY_DELIVERY, FEDEX_ONE_RATE |\n| `commodities` | object[] | | Customs commodities for international shipments |\n| `commodities[].description` | string | yes | |\n| `commodities[].quantity` | number | yes | |\n| `commodities[].customs_value` | number | yes | |\n| `commodities[].currency` | string | yes | |\n| `commodities[].weight` | number | yes | |\n| `commodities[].weight_units` | "KG" \\\\| "LB" | | |\n| `commodities[].country_of_manufacture` | string | | ISO 3166-1 alpha-2 |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `reference` | string | yes | |\n| `status` | "draft" | yes | |\n| `master_tracking_number` | string | | Pass this to fedex_confirm_shipment to finalize the draft (workflow step, chat) |\n\n### fedex_create_shipment (workflow step)\n\n- Create a FedEx shipment and generate the label / AWB in one call.\n- Returns the master tracking number, piece tracking numbers, and label URLs.\n- Use the Open Ship draft flow instead when you need to stage a booking before committing.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | FedEx connected account |\n| `shipper` | object | yes | |\n| `shipper.contact` | object | | |\n| `shipper.contact.person_name` | string | | |\n| `shipper.contact.company_name` | string | | |\n| `shipper.contact.phone_number` | string | | |\n| `shipper.address` | object | yes | |\n| `shipper.address.postal_code` | string | yes | |\n| `shipper.address.country_code` | string | yes | ISO 3166-1 alpha-2 country code, e.g. VN, US, SG |\n| `shipper.address.city` | string | | |\n| `shipper.address.state_or_province_code` | string | | |\n| `shipper.address.street_lines` | string[] | | |\n| `shipper.address.residential` | boolean | | |\n| `recipient` | object | yes | |\n| `recipient.contact` | object | | |\n| `recipient.contact.person_name` | string | | |\n| `recipient.contact.company_name` | string | | |\n| `recipient.contact.phone_number` | string | | |\n| `recipient.address` | object | yes | |\n| `recipient.address.postal_code` | string | yes | |\n| `recipient.address.country_code` | string | yes | ISO 3166-1 alpha-2 country code, e.g. VN, US, SG |\n| `recipient.address.city` | string | | |\n| `recipient.address.state_or_province_code` | string | | |\n| `recipient.address.street_lines` | string[] | | |\n| `recipient.address.residential` | boolean | | |\n| `service_type` | string | yes | FedEx service type e.g. INTERNATIONAL_PRIORITY |\n| `packaging_type` | string | | FedEx packaging type e.g. YOUR_PACKAGING |\n| `packages` | object[] | yes | One entry per package; weight in kg |\n| `packages[].weight` | number | yes | |\n| `packages[].weight_units` | "KG" \\\\| "LB" | | Weight units; FedEx requires LB for US domestic express |\n| `packages[].length` | number | | |\n| `packages[].width` | number | | |\n| `packages[].height` | number | | |\n| `packages[].dimension_units` | "CM" \\\\| "IN" | | |\n| `ship_datestamp` | string | | Ship date YYYY-MM-DD |\n| `pickup_type` | string | | FedEx pickup type e.g. USE_SCHEDULED_PICKUP |\n| `special_services` | string[] | | FedEx special service types |\n| `commodities` | object[] | | Customs commodities for international shipments |\n| `commodities[].description` | string | yes | |\n| `commodities[].quantity` | number | yes | |\n| `commodities[].customs_value` | number | yes | |\n| `commodities[].currency` | string | yes | |\n| `commodities[].weight` | number | yes | |\n| `commodities[].weight_units` | "KG" \\\\| "LB" | | |\n| `commodities[].country_of_manufacture` | string | | ISO 3166-1 alpha-2 |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `master_tracking_number` | string | | |\n| `tracking_numbers` | string[] | yes | |\n| `label_urls` | string[] | yes | |\n\n### fedex_rate (workflow step)\n\n- Get FedEx rate quotes for a shipment.\n- Returns one priced row per available service (or just the requested service_type).\n- Use before booking to compare costs.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | FedEx connected account |\n| `shipper` | object | yes | |\n| `shipper.postal_code` | string | yes | |\n| `shipper.country_code` | string | yes | ISO 3166-1 alpha-2 country code, e.g. VN, US, SG |\n| `shipper.city` | string | | |\n| `shipper.state_or_province_code` | string | | |\n| `shipper.street_lines` | string[] | | |\n| `shipper.residential` | boolean | | |\n| `recipient` | object | yes | |\n| `recipient.postal_code` | string | yes | |\n| `recipient.country_code` | string | yes | ISO 3166-1 alpha-2 country code, e.g. VN, US, SG |\n| `recipient.city` | string | | |\n| `recipient.state_or_province_code` | string | | |\n| `recipient.street_lines` | string[] | | |\n| `recipient.residential` | boolean | | |\n| `packages` | object[] | yes | One entry per package; weight in kg |\n| `packages[].weight` | number | yes | |\n| `packages[].weight_units` | "KG" \\\\| "LB" | | Weight units; FedEx requires LB for US domestic express |\n| `packages[].length` | number | | |\n| `packages[].width` | number | | |\n| `packages[].height` | number | | |\n| `packages[].dimension_units` | "CM" \\\\| "IN" | | |\n| `service_type` | string | | FedEx service type e.g. INTERNATIONAL_PRIORITY. Omit to rate all available services. |\n| `packaging_type` | string | | FedEx packaging type e.g. YOUR_PACKAGING |\n| `pickup_type` | string | | FedEx pickup type e.g. USE_SCHEDULED_PICKUP |\n| `ship_datestamp` | string | | Ship date YYYY-MM-DD |\n| `special_services` | string[] | | FedEx special service types e.g. SATURDAY_DELIVERY |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `services` | object[] | yes | |\n| `services[].service_type` | string | yes | |\n| `services[].service_name` | string | | |\n| `services[].total_charge` | number | | |\n| `services[].currency` | string | | |\n\n### fedex_service_availability (workflow step)\n\n- Check what FedEx services serve a lane. query "transit_times" returns delivery commitments per service; "package_and_service_options" returns valid service/packaging combinations; "special_service_options" returns available special services.\n- Use before rating/booking to learn the valid service types for an origin \u2192 destination.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | FedEx connected account |\n| `query` | "transit_times" \\\\| "special_service_options" \\\\| "package_and_service_options" | yes | |\n| `shipper` | object | yes | |\n| `shipper.postal_code` | string | yes | |\n| `shipper.country_code` | string | yes | ISO 3166-1 alpha-2 country code, e.g. VN, US, SG |\n| `shipper.city` | string | | |\n| `shipper.state_or_province_code` | string | | |\n| `shipper.street_lines` | string[] | | |\n| `shipper.residential` | boolean | | |\n| `recipient` | object | yes | |\n| `recipient.postal_code` | string | yes | |\n| `recipient.country_code` | string | yes | ISO 3166-1 alpha-2 country code, e.g. VN, US, SG |\n| `recipient.city` | string | | |\n| `recipient.state_or_province_code` | string | | |\n| `recipient.street_lines` | string[] | | |\n| `recipient.residential` | boolean | | |\n| `packages` | object[] | yes | One entry per package; weight in kg unless weight_units set |\n| `packages[].weight` | number | yes | |\n| `packages[].weight_units` | "KG" \\\\| "LB" | | Weight units; FedEx requires LB for US domestic express |\n| `packages[].length` | number | | |\n| `packages[].width` | number | | |\n| `packages[].height` | number | | |\n| `packages[].dimension_units` | "CM" \\\\| "IN" | | |\n| `ship_datestamp` | string | | Ship date YYYY-MM-DD |\n| `carrier_codes` | string[] | yes | FedEx carrier codes \u2014 at least one, e.g. FDXE (Express), FDXG (Ground) |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `result` | object | yes | |\n\n### fedex_validate_address (workflow step)\n\n- Validate one or more addresses with FedEx.\n- Returns each resolved address plus its classification (e.g.\n- BUSINESS / RESIDENTIAL) and deliverability attributes.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | FedEx connected account |\n| `addresses` | object[] | yes | At most 100 per call. |\n| `addresses[].postal_code` | string | yes | |\n| `addresses[].country_code` | string | yes | ISO 3166-1 alpha-2 country code, e.g. VN, US, SG |\n| `addresses[].city` | string | | |\n| `addresses[].state_or_province_code` | string | | |\n| `addresses[].street_lines` | string[] | | |\n| `addresses[].residential` | boolean | | |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `resolved_addresses` | object[] | yes | |\n| `resolved_addresses[].city` | string | | |\n| `resolved_addresses[].state_or_province_code` | string | | |\n| `resolved_addresses[].postal_code` | string | | |\n| `resolved_addresses[].country_code` | string | | |\n| `resolved_addresses[].classification` | string | | |\n| `resolved_addresses[].attributes` | object | | |\n\n## generate\n\n### generate_bank_qr_code (workflow step)\n\n- Generate a bank-payment QR code (VietQR for Vietnam) and save it as a PNG to the workspace.\n- The QR encodes the recipient bank, account number, and optional amount/description so any banking app can scan and pre-fill the transfer.\n- Call list_banks first to discover valid bank codes. (workflow step, chat)\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `country` | "VN" | yes | Country whose bank-payment QR standard to use. Currently only \'VN\' (Vietnam / VietQR) is supported. |\n| `bank_code` | "ICB" \\\\| "VCB" \\\\| "BIDV" \\\\| "VBA" \\\\| "OCB" \\\\| "MB" \\\\| "TCB" \\\\| "ACB" \\\\| "VPB" \\\\| "TPB" \\\\| "STB" \\\\| "HDB" \\\\| "VCCB" \\\\| "SCB" \\\\| "VIB" \\\\| "SHB" \\\\| "EIB" \\\\| "MSB" \\\\| "CAKE" \\\\| "Ubank" \\\\| "TIMO" \\\\| "SGICB" \\\\| "BAB" \\\\| "momo" \\\\| "PVDB" \\\\| "PVCB" \\\\| "MBV" \\\\| "NCB" \\\\| "SHBVN" \\\\| "ABB" \\\\| "VAB" \\\\| "NAB" \\\\| "PGB" \\\\| "VIETBANK" \\\\| "BVB" \\\\| "SEAB" \\\\| "COOPBANK" \\\\| "LPB" \\\\| "KLB" \\\\| "KBank" \\\\| "CIMB" \\\\| "WVN" | yes | Bank code from list_banks. Must belong to the specified country. (workflow step, chat) |\n| `account_number` | string | yes | Beneficiary account number at the bank. |\n| `amount` | number | | Payment amount in the local currency (VND for Vietnam). Omit for a static QR with no fixed amount. |\n| `description` | string | | Transfer description / memo. Max 50 bytes; Vietnamese diacritics use 2\u20133 bytes per character. |\n| `account_name` | string | | Beneficiary name shown on the payer\'s banking app confirmation screen. Max 25 bytes \u2014 banks normalize Vietnamese names to ASCII uppercase, pass the normalized form (e.g. \'NGUYEN VAN A\'). |\n| `filename` | string | | Output filename. Defaults to \'bank_qr_<bank_code>.png\'. |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `id` | string | yes | |\n| `filename` | string | yes | |\n| `mime_type` | string | yes | |\n| `url` | string | yes | |\n| `bank` | object | yes | |\n| `bank.country` | string | yes | |\n| `bank.code` | string | yes | |\n| `bank.short_name` | string | yes | |\n| `bank.full_name` | string | yes | |\n\n### generate_qr_code (workflow step)\n\n- Generate a QR code PNG from text or a URL and save it to the workspace.\n- For bank payment QR codes, use generate_bank_qr_code instead \u2014 it builds the correct EMVCo payload from a bank code and account number. (workflow step, chat)\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `data` | string | yes | Text or URL to encode into the QR code. |\n| `filename` | string | | Output filename. Defaults to \'qr_code.png\'. |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `id` | string | yes | |\n| `filename` | string | yes | |\n| `mime_type` | string | yes | |\n| `url` | string | yes | |\n\n## get\n\n### get_record (workflow step)\n\n- Fetch a single record with all field values.\n- Returns data (raw values) and display (human-readable labels); a workflow body\'s read carries `display`, `links`, `comment_count` and `units` only when the body reads them.\n- A workspace admin\'s `as_member` fetches it as that member would see it.\n- Cell shapes in `data`, keyed by field alias: select / member / link, and a formula with options, read back as arrays \u2014 a single-select as ["open"], the option\'s alias; one member as ["mbr_x"].\n- A workflow body reads the same single-select, single-member or option-formula cell as the bare value, and a files cell as a list of file objects, each with id, filename and mime_type: `first(record.file).id` is the id a file tool takes.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `record_id` | string | yes | |\n| `table_id` | string | | |\n| `as_member` | string | | For a workspace admin: reads as this member would \u2014 their row rules and access. Anyone else is refused. |\n| `field_keys` | string[] | | Field aliases to return. Omit to return all fields. |\n| `comments` | boolean | | Return the record\'s newest comments, 20 at most; `comment_count` is the whole thread. |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `id` | string | yes | |\n| `table_id` | string | yes | |\n| `data` | object | yes | |\n| `display` | object | | Human-readable display values for select, member, and record link fields. Omitted from a workflow read whose body never looks at it. |\n| `links` | object | | Each link field\'s linked rows with the title the cell carries, by field alias; `data` holds their ids. |\n| `locked` | boolean | | |\n| `comment_count` | number | | How many comments the record holds. Omitted from a workflow read whose body never looks at it. |\n| `comments` | object[] | | With `comments: true`: the newest first. |\n| `comments[].id` | string | yes | Unique identifier for the comment |\n| `comments[].member_id` | string | yes | ID of the member who created this comment |\n| `comments[].content` | string | yes | Comment text content (0-10,000 characters) |\n| `comments[].files` | object[] \\\\| null | | Array of files attached to this comment |\n| `comments[].created_at` | string | yes | Timestamp when comment was created |\n| `comments[].updated_at` | string | yes | Timestamp of last update |\n| `archived_at` | string \\\\| null | | |\n| `created_at` | string | | |\n| `updated_at` | string | | |\n| `_field_names` | object | | |\n| `units` | object | | The unit or currency this row reads a figure in, by the figure\'s field alias, where each row states its own. |\n\n## gmail\n\n### gmail_get_thread (workflow step)\n\n- Retrieve all messages in a Gmail thread.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | The ID of the connected Gmail account to use |\n| `thread_id` | string | yes | Gmail thread ID |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `messages` | object[] | yes | |\n| `messages[].id` | string | yes | Gmail message ID |\n| `messages[].threadId` | string | yes | Gmail thread ID |\n| `messages[].labelIds` | string[] | yes | Gmail label IDs (e.g. INBOX, UNREAD) |\n| `messages[].subject` | string | yes | Email subject |\n| `messages[].from` | string | yes | Sender email address |\n| `messages[].to` | string | yes | Recipient email address |\n| `messages[].date` | string | yes | Email date in the workspace timezone, with its offset |\n| `messages[].snippet` | string | yes | Short plain-text preview of the email body |\n| `messages[].cc` | string \\\\| null | | CC recipients |\n| `messages[].bcc` | string \\\\| null | | BCC recipients |\n\n### gmail_query_emails (workflow step)\n\n- Search Gmail messages using Gmail search syntax. ## Query syntax Operators (no space after colon): - People: from:, to:, cc:, bcc:, deliveredto: - Content: subject:, "exact phrase", +exact_word, AROUND N (proximity) - Status: is:unread, is:read, is:starred, is:important, is:muted - Labels: label:name, in:inbox, in:sent, in:drafts, in:spam, in:trash, in:anywhere - Category: category:primary, category:social, category:promotions, category:updates, category:forums - Attachments: has:attachment, has:drive, filename:pdf, filename:report.xlsx (has:attachment matches non-inline attachments only \u2014 it misses inline-embedded PDFs, common in receipts/invoices; open the message with gmail_read_email to detect those) - Size: larger:5M, smaller:2M, size:1000000 - Dates (YYYY/MM/DD): after:2024/01/01, before:2024/12/31 - Relative dates: newer_than:7d, older_than:3m, newer_than:1y (d=days, m=months, y=years) Combining: space = AND, OR (uppercase), - (exclude), () for grouping, {} alternative OR syntax. (workflow step, chat)\n- Examples: - from:alice is:unread has:attachment - subject:"quarterly review" newer_than:2d - {from:alice from:bob} subject:project -in:drafts - larger:5M filename:pdf older_than:6m - in:anywhere deliveredto:billing@company.com\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | The ID of the connected Gmail account to use |\n| `query` | string | yes | Gmail search syntax expression |\n| `max_result` | number | yes | Maximum number of emails to retrieve (1-50) |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `messages` | object[] | yes | List of matching Gmail messages |\n| `messages[].id` | string | yes | Gmail message ID |\n| `messages[].threadId` | string | yes | Gmail thread ID |\n| `messages[].labelIds` | string[] | yes | Gmail label IDs (e.g. INBOX, UNREAD) |\n| `messages[].subject` | string | yes | Email subject |\n| `messages[].from` | string | yes | Sender email address |\n| `messages[].to` | string | yes | Recipient email address |\n| `messages[].date` | string | yes | Email date in the workspace timezone, with its offset |\n| `messages[].snippet` | string | yes | Short plain-text preview of the email body |\n| `messages[].cc` | string \\\\| null | | CC recipients |\n| `messages[].bcc` | string \\\\| null | | BCC recipients |\n\n### gmail_query_labels (workflow step)\n\n- List Gmail labels with message and thread counts.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | The ID of the connected Gmail account to use |\n| `name` | string | | Match labels by name prefix. |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `labels` | object[] | yes | |\n| `labels[].id` | string | yes | |\n| `labels[].name` | string | yes | |\n| `labels[].type` | string | yes | system or user |\n| `labels[].messagesTotal` | number | yes | |\n| `labels[].messagesUnread` | number | yes | |\n| `labels[].threadsTotal` | number | yes | |\n| `labels[].threadsUnread` | number | yes | |\n\n### gmail_read_email (workflow step)\n\n- Fetch a Gmail message\'s body and the list of its attachments.\n- Attachments are stored as workspace files \u2014 the result names each one\'s file_id; read one with view_files, attach one to a record with update_records. (chat, MCP, CLI)\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | The ID of the connected account |\n| `message_id` | string | yes | The ID of the Gmail message to retrieve |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `message` | object | yes | The full Gmail message |\n| `message.id` | string | | Gmail message ID |\n| `message.threadId` | string | | Gmail thread ID |\n| `message.historyId` | string | | Gmail history ID |\n| `message.labelIds` | string[] | | Gmail label IDs |\n| `message.subject` | string | yes | Email subject |\n| `message.from` | string | yes | Sender email address |\n| `message.to` | string | yes | Recipient email address |\n| `message.date` | string | yes | Email date in the workspace timezone, with its offset |\n| `message.body` | object | yes | Email body |\n| `message.body.type` | "text" \\\\| "html" | yes | Body content type |\n| `message.body.content` | string | yes | Body content |\n| `message.cc` | string \\\\| null | | CC recipients |\n| `message.bcc` | string \\\\| null | | BCC recipients |\n| `message.inReplyTo` | string \\\\| null | | In-Reply-To header |\n| `message.replyTo` | string \\\\| null | | Reply-To header |\n| `message.references` | string[] \\\\| null | | References header |\n| `message.attachments` | object[] | yes | Email attachments |\n| `message.attachments[].partId` | string | yes | MIME part ID |\n| `message.attachments[].filename` | string | yes | Attachment filename as stored, which may differ from the sender\'s |\n| `message.attachments[].mimeType` | string | yes | MIME type as stored, recovered from the filename when the sender declared a generic one |\n| `message.attachments[].attachmentId` | string | yes | Gmail attachment ID |\n| `message.attachments[].file_id` | string | | Stored file ID \u2014 pass to view_files to read it, or to update_records to attach it (chat, MCP, CLI) |\n| `message.attachments[].size` | number | | Stored size in bytes |\n\n### gmail_reply_email (workflow step)\n\n- Draft or send a reply to a Gmail message.\n- Use reply_body (markdown) or template_id + template_data \u2014 not both.\n- Attach stored files by passing their file_ids.\n- Leaves an unsent draft unless draft is false.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | |\n| `original_message_id` | string | yes | |\n| `reply_body` | string | | Reply body (markdown). Mutually exclusive with template_id. |\n| `template_id` | string | | |\n| `template_data` | object | | |\n| `cc` | string | | CC recipients, comma-separated |\n| `bcc` | string | | BCC recipients, comma-separated |\n| `draft` | boolean | | Leave true to save an unsent draft the member reviews. Pass false only to deliver the message now \u2014 delivery is irreversible. |\n| `file_ids` | string[] | yes | |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `message_id` | string | yes | The ID of the sent message or saved draft |\n| `subject` | string | yes | The subject as sent |\n| `html` | string | yes | The body as sent, rendered to HTML |\n| `markdown` | string | | The body as written in markdown; absent when a template rendered it |\n| `to` | string | yes | The original sender the reply went to |\n\n### gmail_send_email (workflow step)\n\n- Draft or send a Gmail email.\n- Use content (markdown) or template_id + template_data \u2014 not both.\n- Attach stored files by passing their file_ids.\n- Leaves an unsent draft unless draft is false.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | |\n| `to` | string | | Recipient email(s), comma-separated. Required unless using a template. |\n| `subject` | string | | |\n| `cc` | string | | CC recipients, comma-separated |\n| `bcc` | string | | BCC recipients, comma-separated |\n| `content` | string | | Email body (markdown). Mutually exclusive with template_id. |\n| `template_id` | string | | |\n| `template_data` | object | | |\n| `draft` | boolean | | Leave true to save an unsent draft the member reviews. Pass false only to deliver the message now \u2014 delivery is irreversible. |\n| `file_ids` | string[] | yes | |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `message_id` | string | yes | The ID of the sent message or saved draft |\n| `subject` | string | yes | The subject as sent |\n| `html` | string | yes | The body as sent, rendered to HTML |\n| `markdown` | string | | The body as written in markdown; absent when a template rendered it |\n| `to` | string | yes | The recipients as sent, comma-separated |\n\n## instagram\n\n### instagram_create_post (workflow step)\n\n- Publish to the connected Instagram account.\n- Instagram has no text-only posts.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | |\n| `caption` | string | yes | |\n| `media_file_ids` | string[] | yes | One image, one video (published as a reel), or 2\u201310 images and videos as a carousel. |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `post_id` | string | yes | |\n| `url` | string | yes | |\n\n## kiotviet\n\n### kiotviet_cancel_invoice (workflow step)\n\n- Cancel a KiotViet sales invoice by id, returning its stock.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | KiotViet connected account |\n| `id` | number | yes | |\n| `void_payment` | boolean | | Also void payments recorded on the invoice |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `cancelled` | true | yes | |\n\n### kiotviet_cancel_order (workflow step)\n\n- Cancel a KiotViet sales order by id, releasing the stock it reserved.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | KiotViet connected account |\n| `id` | number | yes | |\n| `void_payment` | boolean | | Also void payments recorded on the order |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `cancelled` | true | yes | |\n\n### kiotviet_create_category (workflow step)\n\n- Create a KiotViet product group (nh\xF3m h\xE0ng), optionally under a parent group.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | KiotViet connected account |\n| `name` | string | yes | |\n| `parent_id` | number | | |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `category` | object | yes | |\n\n### kiotviet_create_customer (workflow step)\n\n- Create a KiotViet customer (kh\xE1ch h\xE0ng).\n- Returns the customer as KiotViet stores it, with its id and code.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | KiotViet connected account |\n| `name` | string | yes | |\n| `code` | string | | Customer code (m\xE3 kh\xE1ch h\xE0ng) |\n| `contact_number` | string | | |\n| `email` | string | | |\n| `address` | string | | |\n| `location_name` | string | | Province/district as KiotViet names it |\n| `ward_name` | string | | |\n| `gender` | boolean | | true for male, false for female |\n| `birth_date` | string | | yyyy-mm-dd |\n| `group_ids` | number[] | | Customer group ids |\n| `comments` | string | | |\n| `branch_id` | number | | |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `customer` | object | yes | |\n\n### kiotviet_create_invoice (workflow step)\n\n- Create a KiotViet sales invoice (h\xF3a \u0111\u01A1n), which deducts stock.\n- Pass order_id to invoice an existing order.\n- Returns the invoice as KiotViet stores it, with its id and code.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | KiotViet connected account |\n| `branch_id` | number | yes | |\n| `customer_id` | number | | |\n| `sold_by_id` | number | yes | KiotViet user id of the seller |\n| `purchase_date` | string | | ISO datetime |\n| `description` | string | | |\n| `discount` | number | | Discount amount on the whole document |\n| `lines` | object[] | yes | |\n| `lines[].product_id` | number | yes | |\n| `lines[].quantity` | number | yes | |\n| `lines[].price` | number | | Unit price |\n| `lines[].discount` | number | | Discount amount on the line |\n| `lines[].note` | string | | |\n| `order_id` | number | | The sales order this invoice settles |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `invoice` | object | yes | |\n\n### kiotviet_create_order (workflow step)\n\n- Create a KiotViet sales order (\u0111\u1EB7t h\xE0ng) \u2014 the pre-invoice stage, which reserves stock.\n- Returns the order as KiotViet stores it, with its id and code.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | KiotViet connected account |\n| `branch_id` | number | yes | |\n| `customer_id` | number | | |\n| `sold_by_id` | number | | KiotViet user id of the seller |\n| `purchase_date` | string | | ISO datetime |\n| `description` | string | | |\n| `discount` | number | | Discount amount on the whole document |\n| `lines` | object[] | yes | |\n| `lines[].product_id` | number | yes | |\n| `lines[].quantity` | number | yes | |\n| `lines[].price` | number | | Unit price |\n| `lines[].discount` | number | | Discount amount on the line |\n| `lines[].note` | string | | |\n| `make_invoice` | boolean | | Also issue the invoice at once |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `order` | object | yes | |\n\n### kiotviet_create_product (workflow step)\n\n- Create a KiotViet product (h\xE0ng h\xF3a), optionally with opening stock per branch.\n- Returns the product as KiotViet stores it, with its id and code.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | KiotViet connected account |\n| `name` | string | yes | |\n| `code` | string | | Product code (m\xE3 h\xE0ng) |\n| `category_id` | number | yes | Product group id |\n| `base_price` | number | | Selling price |\n| `unit` | string | | |\n| `allows_sale` | boolean | | |\n| `is_active` | boolean | | |\n| `description` | string | | |\n| `weight` | number | | Grams |\n| `inventories` | object[] | | Stock per branch |\n| `inventories[].branch_id` | number | yes | |\n| `inventories[].on_hand` | number | yes | |\n| `inventories[].cost` | number | | Unit cost at this branch |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `product` | object | yes | |\n\n### kiotviet_delete_product (workflow step)\n\n- Delete a KiotViet product by id.\n- KiotViet refuses one that already appears on invoices.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | KiotViet connected account |\n| `id` | number | yes | |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `deleted` | true | yes | |\n\n### kiotviet_get_customer (workflow step)\n\n- Get one KiotViet customer by id or by customer code (m\xE3 kh\xE1ch h\xE0ng).\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | KiotViet connected account |\n| `id` | number | | |\n| `code` | string | | Customer code (m\xE3 kh\xE1ch h\xE0ng), e.g. KH000123 |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `customer` | object | yes | |\n\n### kiotviet_get_invoice (workflow step)\n\n- Get one KiotViet sales invoice by id or by invoice code (m\xE3 h\xF3a \u0111\u01A1n), with its line items and payments.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | KiotViet connected account |\n| `id` | number | | |\n| `code` | string | | Invoice code (m\xE3 h\xF3a \u0111\u01A1n), e.g. HD000123 |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `invoice` | object | yes | |\n\n### kiotviet_get_product (workflow step)\n\n- Get one KiotViet product by id or by product code (m\xE3 h\xE0ng), with stock per branch in inventories[].\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | KiotViet connected account |\n| `id` | number | | |\n| `code` | string | | Product code (m\xE3 h\xE0ng), e.g. SP000123 |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `product` | object | yes | |\n\n### kiotviet_list_branches (workflow step)\n\n- List the store\'s KiotViet branches (chi nh\xE1nh).\n- Branch ids scope inventory, invoices and orders.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | KiotViet connected account |\n| `page_size` | number | | Rows per page, up to 100 |\n| `current_item` | number | | Zero-based offset of the first row |\n| `last_modified_from` | string | | ISO datetime; only rows modified at or after it |\n| `include_removed_ids` | boolean | | Also return removed_ids \u2014 rows deleted since last_modified_from |\n| `order_by` | string | | KiotViet field name to sort by |\n| `order_direction` | "Asc" \\\\| "Desc" | | |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `total` | number | | Rows matching the query across all pages |\n| `page_size` | number | | |\n| `items` | object[] | yes | Rows as KiotViet returns them |\n| `removed_ids` | number[] | | |\n\n### kiotviet_list_categories (workflow step)\n\n- List KiotViet product groups (nh\xF3m h\xE0ng).\n- Each row carries its parentId, so the tree can be rebuilt from the flat list.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | KiotViet connected account |\n| `page_size` | number | | Rows per page, up to 100 |\n| `current_item` | number | | Zero-based offset of the first row |\n| `last_modified_from` | string | | ISO datetime; only rows modified at or after it |\n| `include_removed_ids` | boolean | | Also return removed_ids \u2014 rows deleted since last_modified_from |\n| `order_by` | string | | KiotViet field name to sort by |\n| `order_direction` | "Asc" \\\\| "Desc" | | |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `total` | number | | Rows matching the query across all pages |\n| `page_size` | number | | |\n| `items` | object[] | yes | Rows as KiotViet returns them |\n| `removed_ids` | number[] | | |\n\n### kiotviet_list_customers (workflow step)\n\n- List KiotViet customers (kh\xE1ch h\xE0ng) with their lifetime totals \u2014 totalInvoiced, totalRevenue, debt, totalPoint.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | KiotViet connected account |\n| `page_size` | number | | Rows per page, up to 100 |\n| `current_item` | number | | Zero-based offset of the first row |\n| `last_modified_from` | string | | ISO datetime; only rows modified at or after it |\n| `include_removed_ids` | boolean | | Also return removed_ids \u2014 rows deleted since last_modified_from |\n| `order_by` | string | | KiotViet field name to sort by |\n| `order_direction` | "Asc" \\\\| "Desc" | | |\n| `code` | string | | Customer code (m\xE3 kh\xE1ch h\xE0ng) |\n| `name` | string | | Name search |\n| `contact_number` | string | | Phone number |\n| `group_id` | number | | Only customers in this customer group |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `total` | number | | Rows matching the query across all pages |\n| `page_size` | number | | |\n| `items` | object[] | yes | Rows as KiotViet returns them |\n| `removed_ids` | number[] | | |\n\n### kiotviet_list_invoices (workflow step)\n\n- List KiotViet sales invoices (h\xF3a \u0111\u01A1n) with their line items in invoiceDetails[] \u2014 productCode, productName, quantity, price, discount, subTotal.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | KiotViet connected account |\n| `page_size` | number | | Rows per page, up to 100 |\n| `current_item` | number | | Zero-based offset of the first row |\n| `last_modified_from` | string | | ISO datetime; only rows modified at or after it |\n| `include_removed_ids` | boolean | | Also return removed_ids \u2014 rows deleted since last_modified_from |\n| `order_by` | string | | KiotViet field name to sort by |\n| `order_direction` | "Asc" \\\\| "Desc" | | |\n| `branch_ids` | number[] | | |\n| `customer_ids` | number[] | | |\n| `customer_code` | string | | Customer code (m\xE3 kh\xE1ch h\xE0ng) |\n| `status` | number[] | | KiotViet status codes; each row carries statusValue with the label |\n| `from_purchase_date` | string | | Date, yyyy-mm-dd |\n| `to_purchase_date` | string | | Date, yyyy-mm-dd |\n| `include_payment` | boolean | | Include payments[] on each row |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `total` | number | | Rows matching the query across all pages |\n| `page_size` | number | | |\n| `items` | object[] | yes | Rows as KiotViet returns them |\n| `removed_ids` | number[] | | |\n\n### kiotviet_list_orders (workflow step)\n\n- List KiotViet sales orders (\u0111\u1EB7t h\xE0ng) \u2014 the pre-invoice stage \u2014 with line items in orderDetails[].\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | KiotViet connected account |\n| `page_size` | number | | Rows per page, up to 100 |\n| `current_item` | number | | Zero-based offset of the first row |\n| `last_modified_from` | string | | ISO datetime; only rows modified at or after it |\n| `include_removed_ids` | boolean | | Also return removed_ids \u2014 rows deleted since last_modified_from |\n| `order_by` | string | | KiotViet field name to sort by |\n| `order_direction` | "Asc" \\\\| "Desc" | | |\n| `branch_ids` | number[] | | |\n| `customer_ids` | number[] | | |\n| `customer_code` | string | | Customer code (m\xE3 kh\xE1ch h\xE0ng) |\n| `status` | number[] | | KiotViet status codes; each row carries statusValue with the label |\n| `from_purchase_date` | string | | Date, yyyy-mm-dd |\n| `to_purchase_date` | string | | Date, yyyy-mm-dd |\n| `include_payment` | boolean | | Include payments[] on each row |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `total` | number | | Rows matching the query across all pages |\n| `page_size` | number | | |\n| `items` | object[] | yes | Rows as KiotViet returns them |\n| `removed_ids` | number[] | | |\n\n### kiotviet_list_products (workflow step)\n\n- List KiotViet products (h\xE0ng h\xF3a) with stock per branch.\n- Each row\'s inventories[] carries branchId, onHand (t\u1ED3n kho), reserved (\u0111\u1EB7t h\xE0ng) and cost.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | KiotViet connected account |\n| `page_size` | number | | Rows per page, up to 100 |\n| `current_item` | number | | Zero-based offset of the first row |\n| `last_modified_from` | string | | ISO datetime; only rows modified at or after it |\n| `include_removed_ids` | boolean | | Also return removed_ids \u2014 rows deleted since last_modified_from |\n| `order_by` | string | | KiotViet field name to sort by |\n| `order_direction` | "Asc" \\\\| "Desc" | | |\n| `category_id` | number | | Only products in this product group |\n| `is_active` | boolean | | Only products still on sale (true) or discontinued (false) |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `total` | number | | Rows matching the query across all pages |\n| `page_size` | number | | |\n| `items` | object[] | yes | Rows as KiotViet returns them |\n| `removed_ids` | number[] | | |\n\n### kiotviet_list_purchase_orders (workflow step)\n\n- List KiotViet purchase orders (phi\u1EBFu nh\u1EADp h\xE0ng) \u2014 goods received from suppliers \u2014 with line items in purchaseOrderDetails[].\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | KiotViet connected account |\n| `page_size` | number | | Rows per page, up to 100 |\n| `current_item` | number | | Zero-based offset of the first row |\n| `last_modified_from` | string | | ISO datetime; only rows modified at or after it |\n| `include_removed_ids` | boolean | | Also return removed_ids \u2014 rows deleted since last_modified_from |\n| `order_by` | string | | KiotViet field name to sort by |\n| `order_direction` | "Asc" \\\\| "Desc" | | |\n| `branch_ids` | number[] | | |\n| `status` | number[] | | KiotViet status codes; each row carries statusValue with the label |\n| `from_purchase_date` | string | | Date, yyyy-mm-dd |\n| `to_purchase_date` | string | | Date, yyyy-mm-dd |\n| `include_payment` | boolean | | Include payments[] on each row |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `total` | number | | Rows matching the query across all pages |\n| `page_size` | number | | |\n| `items` | object[] | yes | Rows as KiotViet returns them |\n| `removed_ids` | number[] | | |\n\n### kiotviet_update_category (workflow step)\n\n- Rename a KiotViet product group or move it under another parent.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | KiotViet connected account |\n| `id` | number | yes | |\n| `name` | string | | |\n| `parent_id` | number | | |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `category` | object | yes | |\n\n### kiotviet_update_customer (workflow step)\n\n- Update a KiotViet customer by id.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | KiotViet connected account |\n| `id` | number | yes | |\n| `name` | string | | |\n| `code` | string | | Customer code (m\xE3 kh\xE1ch h\xE0ng) |\n| `contact_number` | string | | |\n| `email` | string | | |\n| `address` | string | | |\n| `location_name` | string | | Province/district as KiotViet names it |\n| `ward_name` | string | | |\n| `gender` | boolean | | true for male, false for female |\n| `birth_date` | string | | yyyy-mm-dd |\n| `group_ids` | number[] | | Customer group ids |\n| `comments` | string | | |\n| `branch_id` | number | | |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `customer` | object | yes | |\n\n### kiotviet_update_invoice (workflow step)\n\n- Update a KiotViet sales invoice by id.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | KiotViet connected account |\n| `id` | number | yes | |\n| `branch_id` | number | | |\n| `customer_id` | number | | |\n| `sold_by_id` | number | | KiotViet user id of the seller |\n| `purchase_date` | string | | ISO datetime |\n| `description` | string | | |\n| `discount` | number | | Discount amount on the whole document |\n| `lines` | object[] | | |\n| `lines[].product_id` | number | yes | |\n| `lines[].quantity` | number | yes | |\n| `lines[].price` | number | | Unit price |\n| `lines[].discount` | number | | Discount amount on the line |\n| `lines[].note` | string | | |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `invoice` | object | yes | |\n\n### kiotviet_update_order (workflow step)\n\n- Update a KiotViet sales order by id.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | KiotViet connected account |\n| `id` | number | yes | |\n| `branch_id` | number | | |\n| `customer_id` | number | | |\n| `sold_by_id` | number | | KiotViet user id of the seller |\n| `purchase_date` | string | | ISO datetime |\n| `description` | string | | |\n| `discount` | number | | Discount amount on the whole document |\n| `lines` | object[] | | |\n| `lines[].product_id` | number | yes | |\n| `lines[].quantity` | number | yes | |\n| `lines[].price` | number | | Unit price |\n| `lines[].discount` | number | | Discount amount on the line |\n| `lines[].note` | string | | |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `order` | object | yes | |\n\n### kiotviet_update_product (workflow step)\n\n- Update a KiotViet product by id; inventories set the stock level per branch.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | KiotViet connected account |\n| `id` | number | yes | |\n| `name` | string | | |\n| `code` | string | | Product code (m\xE3 h\xE0ng) |\n| `category_id` | number | | Product group id |\n| `base_price` | number | | Selling price |\n| `unit` | string | | |\n| `allows_sale` | boolean | | |\n| `is_active` | boolean | | |\n| `description` | string | | |\n| `weight` | number | | Grams |\n| `inventories` | object[] | | Stock per branch |\n| `inventories[].branch_id` | number | yes | |\n| `inventories[].on_hand` | number | yes | |\n| `inventories[].cost` | number | | Unit cost at this branch |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `product` | object | yes | |\n\n## lark\n\n### lark_create_records (workflow step)\n\n- Create one or many records in a Lark Base (Bitable) table (max 500 per call). fields are keyed by Lark field name.\n- Returns the new record ids.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | Lark connected account |\n| `app_token` | string | yes | Lark Base app_token (the Base id) |\n| `table_id` | string | yes | Lark Bitable table id |\n| `records` | object[] | yes | |\n| `records[].fields` | object | yes | |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `created` | number | yes | |\n| `records` | object[] | yes | |\n| `records[].record_id` | string | yes | |\n| `records[].fields` | object | yes | |\n\n### lark_delete_records (workflow step)\n\n- Delete one or many records from a Lark Base (Bitable) table by record_id (max 500 per call).\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | Lark connected account |\n| `app_token` | string | yes | Lark Base app_token (the Base id) |\n| `table_id` | string | yes | Lark Bitable table id |\n| `record_ids` | string[] | yes | |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `deleted` | number | yes | |\n| `record_ids` | string[] | yes | |\n\n### lark_get_record (workflow step)\n\n- Get one record from a Lark Base (Bitable) table by its record_id.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | Lark connected account |\n| `app_token` | string | yes | Lark Base app_token (the Base id) |\n| `table_id` | string | yes | Lark Bitable table id |\n| `record_id` | string | yes | |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `record_id` | string | yes | |\n| `fields` | object | yes | |\n\n### lark_list_fields (workflow step)\n\n- List the fields (columns) of a Lark Base (Bitable) table \u2014 name, id, and type.\n- Use to discover the schema before reading or writing records.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | Lark connected account |\n| `app_token` | string | yes | Lark Base app_token (the Base id) |\n| `table_id` | string | yes | Lark Bitable table id |\n| `page_size` | number | | |\n| `page_token` | string | | |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `fields` | object[] | yes | |\n| `fields[].field_id` | string | | |\n| `fields[].field_name` | string | | |\n| `fields[].type` | number | | |\n| `fields[].ui_type` | string | | |\n| `fields[].is_primary` | boolean | | |\n| `has_more` | boolean | yes | |\n| `page_token` | string | | |\n\n### lark_list_records (workflow step)\n\n- List records from a Lark Base (Bitable) table.\n- Returns each record\'s id and fields (keyed by Lark field name).\n- Optionally narrow with filter / sort / field_names / view_id; paginate with page_token.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | Lark connected account |\n| `app_token` | string | yes | Lark Base app_token (the Base id) |\n| `table_id` | string | yes | Lark Bitable table id |\n| `filter` | object | | |\n| `filter.conjunction` | "and" \\\\| "or" | yes | |\n| `filter.conditions` | object[] | yes | |\n| `filter.conditions[].field_name` | string | yes | |\n| `filter.conditions[].operator` | string | yes | e.g. is, isNot, contains, isGreater, isEmpty |\n| `filter.conditions[].value` | string[] | | |\n| `sort` | object[] | | |\n| `sort[].field_name` | string | yes | |\n| `sort[].desc` | boolean | | |\n| `field_names` | string[] | | Restrict returned fields by name |\n| `view_id` | string | | |\n| `page_size` | number | | |\n| `page_token` | string | | |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `records` | object[] | yes | |\n| `records[].record_id` | string | yes | |\n| `records[].fields` | object | yes | |\n| `has_more` | boolean | yes | |\n| `page_token` | string | | |\n| `total` | number | | |\n\n### lark_list_tables (workflow step)\n\n- List the tables in a Lark Base (Bitable) \u2014 id and name.\n- Use to discover which table_id to read or write.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | Lark connected account |\n| `app_token` | string | yes | Lark Base app_token (the Base id) |\n| `page_size` | number | | |\n| `page_token` | string | | |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `tables` | object[] | yes | |\n| `tables[].table_id` | string | | |\n| `tables[].name` | string | | |\n| `has_more` | boolean | yes | |\n| `page_token` | string | | |\n\n### lark_update_records (workflow step)\n\n- Update one or many existing records in a Lark Base (Bitable) table by record_id (max 500 per call). fields are keyed by Lark field name; only provided fields change.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | Lark connected account |\n| `app_token` | string | yes | Lark Base app_token (the Base id) |\n| `table_id` | string | yes | Lark Bitable table id |\n| `records` | object[] | yes | |\n| `records[].record_id` | string | yes | |\n| `records[].fields` | object | yes | |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `updated` | number | yes | |\n| `records` | object[] | yes | |\n| `records[].record_id` | string | yes | |\n| `records[].fields` | object | yes | |\n\n## linkedin\n\n### linkedin_create_post (workflow step)\n\n- Publish a post to the connected LinkedIn member\'s profile.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | |\n| `text` | string | yes | |\n| `link` | string | | Shown as an article card; needs link_title. A post carries either a link or media. |\n| `link_title` | string | | |\n| `media_file_ids` | string[] | | Up to 20 images, or one video. |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `post_id` | string | yes | |\n| `url` | string | yes | |\n\n## list\n\n### list_banks (workflow step)\n\n- List banks supported by generate_bank_qr_code. (workflow step, chat)\n- Returns the bank code (used as input to the generator), display name, and country.\n- Call this before generate_bank_qr_code to discover valid codes. (workflow step, chat)\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `country` | "VN" | | Filter to banks from a specific country. Omit to list all supported banks. |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `banks` | object[] | yes | |\n| `banks[].country` | string | yes | |\n| `banks[].code` | string | yes | |\n| `banks[].bin` | string | yes | |\n| `banks[].short_name` | string | yes | |\n| `banks[].full_name` | string | yes | |\n\n## lock\n\n### lock_records (workflow step)\n\n- Lock records to prevent editing.\n- Returns `{ locked, record_ids }`.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `table_id` | string | yes | |\n| `record_ids` | string[] | | |\n| `filters` | any | | |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `locked` | number | yes | |\n| `record_ids` | string[] | yes | |\n\n## lookup\n\n### lookup_business (workflow step)\n\n- Look up business registration info by tax / registration code.\n- Defaults to Vietnam (country=\'VN\').\n- A VN registered name ending in "(NTNN)" marks a code for paying a foreign contractor\'s tax on the company\'s behalf, not the company\'s own code.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `tax_code` | string | yes | Business tax / registration code. Format varies by country; for VN this is a 10\u201313 digit m\xE3 s\u1ED1 thu\u1EBF. |\n| `country` | string | | ISO country code. Defaults to \'VN\' (Vietnam). Only \'VN\' is supported today. |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `country` | string | yes | |\n| `tax_code` | string | yes | |\n| `name` | string | yes | |\n| `address` | string | yes | |\n| `representative` | string \\\\| null | yes | |\n| `status` | string \\\\| null | yes | |\n| `international_name` | string \\\\| null | yes | |\n| `short_name` | string \\\\| null | yes | |\n| `operating_since` | string \\\\| null | yes | |\n| `managed_by` | string \\\\| null | yes | |\n| `company_type` | string \\\\| null | yes | |\n| `primary_industry` | string \\\\| null | yes | |\n\n## misa\n\n### misa_get_dictionary (workflow step)\n\n- Read master-data records from MISA AMIS to look up codes (customer code, item code, warehouse code, etc.) before pushing a voucher.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | MISA connected account to read from |\n| `data_type` | 1 \\\\| 2 \\\\| 3 \\\\| 4 \\\\| 5 \\\\| 6 \\\\| 8 \\\\| 9 \\\\| 10 \\\\| 11 \\\\| 12 | yes | 1 objects (customers/suppliers/employees), 2 inventory items, 3 stocks, 4 units, 5 chart of accounts, 6 organization units, 8 bank accounts, 9 projects, 10 cost objects, 11 payment terms, 12 banks |\n| `skip` | integer | | |\n| `take` | integer | | Max 100 per page |\n| `last_sync_time` | string | | ISO timestamp \u2014 only return records changed since this time |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `success` | boolean | yes | |\n| `data` | object[] | yes | The dictionary records, each as MISA names its fields |\n| `last_sync_time` | string | | Cursor \u2014 pass as last_sync_time on the next call to fetch only newer changes |\n| `error_code` | string | | |\n| `error_message` | string | | |\n\n### misa_save_bank_voucher (workflow step)\n\n- Push a bank voucher (deposit / withdrawal / transfer) into MISA AMIS. voucher_type: 1 deposit (b\xE1o c\xF3), 3 withdrawal/debit-advice (b\xE1o n\u1EE3), 2 internal transfer. bank_account_id is the company-side bank account GUID \u2014 look it up with misa_get_dictionary (data_type 8). (workflow step, chat)\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `voucher_type` | 1 \\\\| 2 \\\\| 3 | yes | |\n| `reftype` | integer | | |\n| `org_refid` | string | yes | a UUID that stays the same for the document \u2014 `uuidFrom(record.id)` |\n| `org_refno` | string | | Source-system document number |\n| `refdate` | string | yes | Document date, ISO 8601 |\n| `posted_date` | string | yes | Accounting posting date, ISO 8601 |\n| `branch_id` | string | | MISA branch GUID, optional for single-branch tenants |\n| `currency_id` | string | | Currency code, default VND |\n| `exchange_rate` | number | | FX rate, default 1.0 |\n| `journal_memo` | string | | Voucher memo/notes |\n| `custom_field1` | string | | |\n| `custom_field2` | string | | |\n| `custom_field3` | string | | |\n| `custom_field4` | string | | |\n| `custom_field5` | string | | |\n| `bank_account_id` | string | yes | Bank account GUID in MISA \u2014 look up via misa_get_dictionary (workflow step, chat) |\n| `account_object_code` | string | | |\n| `account_object_name` | string | | |\n| `total_amount_oc` | number | yes | |\n| `total_amount` | number | yes | |\n| `detail` | object[] | yes | |\n| `detail[].description` | string | yes | |\n| `detail[].amount_oc` | number | yes | |\n| `detail[].amount` | number | yes | |\n| `detail[].debit_account` | string | yes | |\n| `detail[].credit_account` | string | yes | |\n| `detail[].sort_order` | integer | | |\n| `connected_account_id` | string | yes | MISA connected account to push to |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `queued` | boolean | yes | |\n| `org_refid` | string | yes | |\n| `error_code` | string | | |\n| `error_message` | string | | |\n\n### misa_save_cash_voucher (workflow step)\n\n- Push a cash voucher (cash receipt or cash payment) into MISA AMIS. voucher_type: 5 receipt (thu ti\u1EC1n), 4 payment (chi ti\u1EC1n). detail array carries the journal lines with debit_account/credit_account per Vietnamese chart-of-accounts.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `voucher_type` | 4 \\\\| 5 | yes | |\n| `reftype` | integer | | |\n| `org_refid` | string | yes | a UUID that stays the same for the document \u2014 `uuidFrom(record.id)` |\n| `org_refno` | string | | Source-system document number |\n| `refdate` | string | yes | Document date, ISO 8601 |\n| `posted_date` | string | yes | Accounting posting date, ISO 8601 |\n| `branch_id` | string | | MISA branch GUID, optional for single-branch tenants |\n| `currency_id` | string | | Currency code, default VND |\n| `exchange_rate` | number | | FX rate, default 1.0 |\n| `journal_memo` | string | | Voucher memo/notes |\n| `custom_field1` | string | | |\n| `custom_field2` | string | | |\n| `custom_field3` | string | | |\n| `custom_field4` | string | | |\n| `custom_field5` | string | | |\n| `account_object_code` | string | | Counterparty code (customer/supplier/employee) |\n| `account_object_name` | string | | |\n| `total_amount_oc` | number | yes | |\n| `total_amount` | number | yes | |\n| `detail` | object[] | yes | |\n| `detail[].description` | string | yes | |\n| `detail[].amount_oc` | number | yes | |\n| `detail[].amount` | number | yes | |\n| `detail[].debit_account` | string | yes | |\n| `detail[].credit_account` | string | yes | |\n| `detail[].sort_order` | integer | | |\n| `connected_account_id` | string | yes | MISA connected account to push to |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `queued` | boolean | yes | |\n| `org_refid` | string | yes | |\n| `error_code` | string | | |\n| `error_message` | string | | |\n\n### misa_save_dictionary (workflow step)\n\n- Create or update master-data records in MISA AMIS (customers, suppliers, items, warehouses, etc.).\n- Use this before pushing a voucher that references a code MISA doesn\'t yet know about.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | MISA connected account to push to |\n| `dictionary_type` | 1 \\\\| 2 \\\\| 3 \\\\| 4 \\\\| 5 \\\\| 6 \\\\| 7 \\\\| 8 \\\\| 9 \\\\| 10 \\\\| 12 | yes | 1 customers/suppliers/employees, 2 object groups, 3 inventory items, 4 item categories, 5 warehouses, 6 units, 7 bank accounts, 8 banks, 9 expense items, 10 revenue/expense categories, 12 cost allocation |\n| `items` | object[] | yes | Master-data records to create or update. 1\u2013200 per call. Each item\'s required fields depend on dictionary_type \u2014 see MISA Open API docs (chat, MCP, CLI) |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `queued` | boolean | yes | |\n| `count` | integer | yes | |\n| `error_code` | string | | |\n| `error_message` | string | | |\n\n### misa_save_purchase_voucher (workflow step)\n\n- Push a purchase voucher (purchase invoice / return / discount-debit-note-to-supplier / service / general purchase / purchase order) into MISA AMIS. voucher_type: 15 invoice, 18 voucher, 17 service, 16 return, 14 discount (debit note to supplier), 21 purchase order. account_object_code identifies the supplier in MISA \u2014 must already exist.\n- MISA sync ack only confirms queueing; final accept/reject arrives async.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `voucher_type` | 14 \\\\| 15 \\\\| 16 \\\\| 17 \\\\| 18 \\\\| 21 | yes | |\n| `reftype` | integer | | |\n| `org_refid` | string | yes | a UUID that stays the same for the document \u2014 `uuidFrom(record.id)` |\n| `org_refno` | string | | Source-system document number |\n| `refdate` | string | yes | Document date, ISO 8601 |\n| `posted_date` | string | yes | Accounting posting date, ISO 8601 |\n| `branch_id` | string | | MISA branch GUID, optional for single-branch tenants |\n| `currency_id` | string | | Currency code, default VND |\n| `exchange_rate` | number | | FX rate, default 1.0 |\n| `journal_memo` | string | | Voucher memo/notes |\n| `custom_field1` | string | | |\n| `custom_field2` | string | | |\n| `custom_field3` | string | | |\n| `custom_field4` | string | | |\n| `custom_field5` | string | | |\n| `account_object_code` | string | yes | Supplier code in MISA |\n| `account_object_name` | string | | |\n| `account_object_tax_code` | string | | |\n| `account_object_address` | string | | |\n| `total_amount_oc` | number | yes | |\n| `total_amount` | number | yes | |\n| `total_vat_amount_oc` | number | yes | |\n| `total_vat_amount` | number | yes | |\n| `detail` | object[] | yes | |\n| `detail[].inventory_item_code` | string | | Item/product code in MISA. Skip when is_description=true |\n| `detail[].inventory_item_name` | string | yes | Item/product display name |\n| `detail[].inventory_item_type` | 0 \\\\| 1 \\\\| 2 \\\\| 3 | | Item type \u2014 0 goods, 1 finished, 2 service, 3 raw material |\n| `detail[].description` | string | | Line description |\n| `detail[].is_description` | boolean | | Description-only line \u2014 when true, only `description` is required |\n| `detail[].stock_code` | string | | Warehouse code in MISA |\n| `detail[].unit_name` | string | | Unit of measure name |\n| `detail[].quantity` | number | yes | Line quantity |\n| `detail[].unit_price` | number | yes | Unit price (in currency_id of voucher) |\n| `detail[].amount_oc` | number | yes | Line total in original currency |\n| `detail[].amount` | number | yes | Line total in accounting currency (= amount_oc when VND) |\n| `detail[].discount_rate` | number | | Line discount percent |\n| `detail[].discount_amount_oc` | number | | Discount amount, original currency |\n| `detail[].discount_amount` | number | | Discount amount, accounting currency |\n| `detail[].vat_rate` | number | yes | VAT percent. 0/5/8/10 for standard, -1 exempt, -2 not creditable, -3 other (set other_vat_rate) |\n| `detail[].other_vat_rate` | number | | Custom VAT percent \u2014 required when vat_rate=-3 |\n| `detail[].vat_amount_oc` | number | yes | VAT amount, original currency |\n| `detail[].vat_amount` | number | yes | VAT amount, accounting currency |\n| `detail[].debit_account` | string | yes | Chart-of-accounts code on debit side, e.g. 131 |\n| `detail[].credit_account` | string | yes | Chart-of-accounts code on credit side, e.g. 511 |\n| `detail[].sale_account` | string | | |\n| `detail[].vat_account` | string | | |\n| `detail[].inventory_account` | string | | |\n| `detail[].sort_order` | integer | | |\n| `detail[].lot_no` | string | | |\n| `detail[].expiry_date` | string | | ISO date |\n| `detail[].organization_unit_code` | string | | Department/branch code |\n| `connected_account_id` | string | yes | MISA connected account to push to |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `queued` | boolean | yes | |\n| `org_refid` | string | yes | |\n| `error_code` | string | | |\n| `error_message` | string | | |\n\n### misa_save_sales_voucher (workflow step)\n\n- Push a sales voucher (invoice / sales return / discount-credit-note / sales order) into MISA AMIS. voucher_type: 11 invoice, 13 sales voucher, 12 return, 10 discount/credit note, 20 sales order. reftype refines the sub-type (e.g. 3530 unpaid sale, 3560 sales invoice, 3571 service cash). account_object_code identifies the customer in MISA \u2014 must already exist (use misa_save_dictionary first if not). (workflow step, chat)\n- MISA sync ack only confirms queueing; final accept/reject arrives async on the registered callback URL.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `voucher_type` | 10 \\\\| 11 \\\\| 12 \\\\| 13 \\\\| 20 | yes | |\n| `reftype` | integer | | Voucher sub-type code \u2014 MISA assigns a default when omitted |\n| `org_refid` | string | yes | a UUID that stays the same for the document \u2014 `uuidFrom(record.id)` |\n| `org_refno` | string | | Source-system document number |\n| `refdate` | string | yes | Document date, ISO 8601 |\n| `posted_date` | string | yes | Accounting posting date, ISO 8601 |\n| `branch_id` | string | | MISA branch GUID, optional for single-branch tenants |\n| `currency_id` | string | | Currency code, default VND |\n| `exchange_rate` | number | | FX rate, default 1.0 |\n| `journal_memo` | string | | Voucher memo/notes |\n| `custom_field1` | string | | |\n| `custom_field2` | string | | |\n| `custom_field3` | string | | |\n| `custom_field4` | string | | |\n| `custom_field5` | string | | |\n| `account_object_code` | string | yes | Customer code in MISA |\n| `account_object_name` | string | | |\n| `account_object_tax_code` | string | | |\n| `account_object_address` | string | | |\n| `employee_code` | string | | Salesperson code |\n| `employee_name` | string | | |\n| `total_sale_amount_oc` | number | yes | |\n| `total_sale_amount` | number | yes | |\n| `total_discount_amount_oc` | number | | |\n| `total_discount_amount` | number | | |\n| `total_vat_amount_oc` | number | yes | |\n| `total_vat_amount` | number | yes | |\n| `total_amount_oc` | number | yes | |\n| `total_amount` | number | yes | |\n| `is_sale_with_outward` | boolean | | Auto-generate stock-out slip |\n| `detail` | object[] | yes | |\n| `detail[].inventory_item_code` | string | | Item/product code in MISA. Skip when is_description=true |\n| `detail[].inventory_item_name` | string | yes | Item/product display name |\n| `detail[].inventory_item_type` | 0 \\\\| 1 \\\\| 2 \\\\| 3 | | Item type \u2014 0 goods, 1 finished, 2 service, 3 raw material |\n| `detail[].description` | string | | Line description |\n| `detail[].is_description` | boolean | | Description-only line \u2014 when true, only `description` is required |\n| `detail[].stock_code` | string | | Warehouse code in MISA |\n| `detail[].unit_name` | string | | Unit of measure name |\n| `detail[].quantity` | number | yes | Line quantity |\n| `detail[].unit_price` | number | yes | Unit price (in currency_id of voucher) |\n| `detail[].amount_oc` | number | yes | Line total in original currency |\n| `detail[].amount` | number | yes | Line total in accounting currency (= amount_oc when VND) |\n| `detail[].discount_rate` | number | | Line discount percent |\n| `detail[].discount_amount_oc` | number | | Discount amount, original currency |\n| `detail[].discount_amount` | number | | Discount amount, accounting currency |\n| `detail[].vat_rate` | number | yes | VAT percent. 0/5/8/10 for standard, -1 exempt, -2 not creditable, -3 other (set other_vat_rate) |\n| `detail[].other_vat_rate` | number | | Custom VAT percent \u2014 required when vat_rate=-3 |\n| `detail[].vat_amount_oc` | number | yes | VAT amount, original currency |\n| `detail[].vat_amount` | number | yes | VAT amount, accounting currency |\n| `detail[].debit_account` | string | yes | Chart-of-accounts code on debit side, e.g. 131 |\n| `detail[].credit_account` | string | yes | Chart-of-accounts code on credit side, e.g. 511 |\n| `detail[].sale_account` | string | | |\n| `detail[].vat_account` | string | | |\n| `detail[].inventory_account` | string | | |\n| `detail[].sort_order` | integer | | |\n| `detail[].lot_no` | string | | |\n| `detail[].expiry_date` | string | | ISO date |\n| `detail[].organization_unit_code` | string | | Department/branch code |\n| `connected_account_id` | string | yes | MISA connected account to push to |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `queued` | boolean | yes | |\n| `org_refid` | string | yes | |\n| `error_code` | string | | |\n| `error_message` | string | | |\n\n## outlook\n\n### outlook_count_emails (workflow step)\n\n- Count Outlook emails matching a filter or search query.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | The Lotics connected account ID (cac_xxx), not the Microsoft user ID |\n| `search` | string | | KQL expression |\n| `filter` | string | | OData expression |\n| `folder` | string | | Mail folder: well-known name or folder ID |\n| `user_id` | string | | Mailbox owner user ID. |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `count` | number | yes | Number of matching emails |\n\n### outlook_query_emails (workflow step)\n\n- Search and filter Outlook emails.\n- Two modes: search (KQL keywords) or structured filters (from, to, subject, dates, etc.).\n- When search is provided, structured filters are ignored. ## KQL search syntax (for the search field) Bare keywords search across from, subject, and body.\n- Property restrictions (no space after colon): - People: from:, to:, cc:, bcc:, participants: (all people fields), recipients: (to+cc+bcc) - Content: subject:, body:, "exact phrase" - Attachments: hasAttachments:true, attachment:filename* - Dates: received:2024-01-01, received:2024-01-01..2024-01-31, received>=2024-01-01, received:today, received:"this week", sent:2024-06-01 - Size (bytes): size>1048576, size:1..10485760 - Status: importance:high, isRead:false, kind:email Combining (UPPERCASE required): AND, OR, NOT, - (exclude), () for grouping.\n- Prefix wildcard: subject:set* (end of word only, no *prefix or *mid*dle).\n- Examples: - from:john@contoso.com AND subject:"quarterly report" - participants:alice importance:high hasAttachments:true - body:contract AND received>=2024-01-01 AND received<=2024-06-30 - (from:legal OR from:compliance) AND subject:contract - attachment:annual* received:"this month"\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | The Lotics connected account ID (cac_xxx), not the Microsoft user ID |\n| `search` | string | | KQL search query \u2014 overrides all structured filter fields when provided |\n| `from` | string | | Sender email address exact match |\n| `to` | string | | Recipient email address exact match |\n| `subject` | string | | Subject starts with this text |\n| `after` | string | | ISO date \u2014 received on or after |\n| `before` | string | | ISO date \u2014 received before |\n| `is_read` | boolean | | |\n| `is_draft` | boolean | | |\n| `has_attachments` | boolean | | |\n| `importance` | "low" \\\\| "normal" \\\\| "high" | | |\n| `is_flagged` | boolean | | Whether the email is flagged for follow-up |\n| `classification` | "focused" \\\\| "other" | | Focused Inbox classification |\n| `category` | string | | Color category name |\n| `conversation_id` | string | | Outlook conversation ID \u2014 retrieves all messages in a thread |\n| `folder` | string | | Mail folder: well-known name (inbox, sentitems, drafts, deleteditems, junkemail, archive) or folder ID |\n| `skip` | number | | Number of results to skip for pagination. |\n| `max_result` | number | yes | Maximum number of emails to retrieve (1-50) |\n| `user_id` | string | | The ID of the user whose mailbox the email belongs to. If not provided, the connected account\'s user ID (me) will be used. |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `messages` | object[] | yes | List of matching Outlook messages |\n| `messages[].id` | string | yes | Outlook message ID |\n| `messages[].date` | string | yes | Email date in the workspace timezone, with its offset |\n| `messages[].from` | string | yes | Sender email address |\n| `messages[].subject` | string | yes | Email subject |\n| `messages[].to` | string | yes | Recipient email address |\n| `messages[].cc` | string \\\\| null | yes | CC recipients |\n| `messages[].bcc` | string \\\\| null | yes | BCC recipients |\n| `messages[].snippet` | string | yes | Short plain-text preview of the email body (first ~255 chars) |\n| `messages[].conversationId` | string | | Outlook conversation ID |\n| `messages[].receivedDateTime` | string | | Received date-time in ISO format |\n| `messages[].hasAttachments` | boolean | | Whether the email has attachments |\n| `messages[].importance` | string | | Email importance level |\n| `messages[].isRead` | boolean | | Whether the email has been read |\n| `messages[].isDraft` | boolean | | Whether the email is a draft |\n| `messages[].flagStatus` | string | | Flag status: notFlagged, complete, or flagged |\n| `messages[].classification` | string | | Focused Inbox classification: focused or other |\n| `messages[].categories` | string[] | | Color categories assigned to the email |\n\n### outlook_query_folders (workflow step)\n\n- List mail folders in an Outlook mailbox.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | The Lotics connected account ID (cac_xxx), not the Microsoft user ID |\n| `parent_folder_id` | string | | Parent folder ID to list child folders. Omit for top-level folders. |\n| `name` | string | | Match folders by display name prefix. |\n| `include_hidden` | boolean | | Include hidden system folders |\n| `max_result` | number | | Maximum number of folders to return (1-100) |\n| `skip` | number | | Number of results to skip for pagination |\n| `user_id` | string | | The ID of the user whose mailbox to query. Defaults to the connected account owner. |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `folders` | object[] | yes | List of mail folders |\n| `folders[].id` | string | yes | Folder ID |\n| `folders[].displayName` | string | yes | Folder display name |\n| `folders[].parentFolderId` | string | | Parent folder ID |\n| `folders[].childFolderCount` | number | yes | Number of child folders |\n| `folders[].totalItemCount` | number | yes | Total number of items in the folder |\n| `folders[].unreadItemCount` | number | yes | Number of unread items |\n| `folders[].isHidden` | boolean | yes | Whether the folder is hidden |\n\n### outlook_read_email (workflow step)\n\n- Fetch an Outlook email\'s body and the list of its attachments.\n- Attachments are stored as workspace files \u2014 the result names each one\'s file_id; read one with view_files, attach one to a record with update_records. (chat, MCP, CLI)\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | The Lotics connected account ID (cac_xxx), not the Microsoft user ID |\n| `message_id` | string | yes | The ID of the Outlook message to retrieve |\n| `user_id` | string | | The ID of the user whose mailbox the email belongs to. If not provided, the connected account\'s user ID (me) will be used. |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `message` | object | yes | The full Outlook message |\n| `message.id` | string | | Outlook message ID |\n| `message.date` | string | yes | Email date in the workspace timezone, with its offset |\n| `message.from` | string | yes | Sender email address |\n| `message.subject` | string | yes | Email subject |\n| `message.to` | string | yes | Recipient email address |\n| `message.cc` | string \\\\| null | yes | CC recipients |\n| `message.bcc` | string \\\\| null | yes | BCC recipients |\n| `message.inReplyTo` | string \\\\| null | yes | In-Reply-To header |\n| `message.replyTo` | string \\\\| null | yes | Reply-To header |\n| `message.references` | string[] \\\\| null | yes | References header |\n| `message.conversationId` | string | | Outlook conversation ID |\n| `message.receivedDateTime` | string | | Received date-time in ISO format |\n| `message.hasAttachments` | boolean | | Whether the email has attachments |\n| `message.importance` | string | | Email importance level |\n| `message.isRead` | boolean | | Whether the email has been read |\n| `message.body` | object | yes | Email body |\n| `message.body.content` | string | yes | Body content |\n| `message.body.contentType` | "text" \\\\| "html" | yes | Body content type |\n| `message.attachments` | object[] | | Email attachments |\n| `message.attachments[].id` | string | yes | Outlook attachment ID |\n| `message.attachments[].fileName` | string | | Attachment filename as stored, which may differ from the sender\'s |\n| `message.attachments[].contentType` | string | | MIME type as stored, recovered from the filename when Graph declared a generic one |\n| `message.attachments[].size` | number | | Stored size in bytes |\n| `message.attachments[].file_id` | string | | Stored file ID \u2014 pass to view_files to read it, or to update_records to attach it (chat, MCP, CLI) |\n\n### outlook_reply_email (workflow step)\n\n- Draft or send a reply to an Outlook email.\n- Use reply_body (markdown) or template_id + template_data \u2014 not both.\n- Attach stored files by passing their file_ids.\n- Leaves an unsent draft unless draft is false.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | The Lotics connected account ID (cac_xxx), not the Microsoft user ID |\n| `original_message_id` | string | yes | |\n| `reply_body` | string | | Reply body (markdown). Mutually exclusive with template_id. |\n| `template_id` | string | | |\n| `template_data` | object | | |\n| `cc` | string | | CC recipients, comma-separated |\n| `bcc` | string | | BCC recipients, comma-separated |\n| `draft` | boolean | | Leave true to save an unsent draft the member reviews. Pass false only to deliver the message now \u2014 delivery is irreversible. |\n| `file_ids` | string[] | yes | |\n| `user_id` | string | | Mailbox user ID |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `message_id` | string | yes | The ID of the sent message or saved draft |\n| `subject` | string | yes | The subject as sent |\n| `html` | string | yes | The body as sent, rendered to HTML |\n| `markdown` | string | | The body as written in markdown; absent when a template rendered it |\n| `to` | string | yes | The original sender the reply went to |\n\n### outlook_send_email (workflow step)\n\n- Draft or send an Outlook email.\n- Use content (markdown) or template_id + template_data \u2014 not both.\n- Attach stored files by passing their file_ids.\n- Leaves an unsent draft unless draft is false, and while drafting \'to\' may be omitted to leave the recipient line for the member to fill in.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | The Lotics connected account ID (cac_xxx), not the Microsoft user ID |\n| `to` | string | | Recipient email(s), comma-separated. Required unless using a template. |\n| `subject` | string | | |\n| `cc` | string | | CC recipients, comma-separated |\n| `bcc` | string | | BCC recipients, comma-separated |\n| `content` | string | | Email body (markdown). Mutually exclusive with template_id. |\n| `template_id` | string | | |\n| `template_data` | object | | |\n| `draft` | boolean | | Leave true to save an unsent draft the member reviews. Pass false only to deliver the message now \u2014 delivery is irreversible. |\n| `file_ids` | string[] | yes | |\n| `user_id` | string | | Mailbox user ID |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `message_id` | string | yes | The ID of the sent message or saved draft |\n| `subject` | string | yes | The subject as sent |\n| `html` | string | yes | The body as sent, rendered to HTML |\n| `markdown` | string | | The body as written in markdown; absent when a template rendered it |\n| `to` | string \\\\| null | yes | The recipients as sent, comma-separated; null on a draft saved without recipients |\n\n## press\n\n### press_button (workflow step)\n\n- Run a button field\'s action against a record \u2014 equivalent to a user clicking the button in the UI.\n- Buttons are a legacy field type; the action must already be wired.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `table_id` | string | yes | |\n| `record_id` | string | yes | |\n| `field_key` | string | yes | |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `execution_id` | string | | |\n| `status` | "success" \\\\| "error" | | |\n| `message` | string | | |\n\n## rename\n\n### rename_file (workflow step)\n\n- Get a file under another name: a new file over the same bytes.\n- Write its file_id into the files field in place of the old one; every other place holding the old file keeps its name.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `file_id` | string | yes | |\n| `filename` | string | yes | The whole new name, keeping the file\'s extension exactly. |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `file_id` | string | yes | The ID of the generated file. |\n| `url` | string | yes | The download URL of the generated file. |\n| `filename` | string | yes | The filename of the generated file, including extension. |\n| `mime_type` | string | yes | The MIME type of the generated file. |\n\n## request\n\n### request_locked_record_change (workflow step)\n\n- Submit one change request to change locked field values on a record.\n- Include every blocked field in the same call \u2014 the approver accepts or rejects the change set as a whole.\n- Values are NOT changed immediately; an approver must accept the request first.\n- Returns `{ request_id, status }`.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `table_id` | string | yes | |\n| `record_id` | string | yes | |\n| `changes` | object | yes | Map of field_key to proposed new value. Every key must be locked on this record. |\n| `reason` | string | yes | |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `request_id` | string | yes | |\n| `status` | "pending" | yes | |\n\n## save\n\n### save_file (workflow step)\n\n- Save a file from a URL to the workspace.\n- Max 20MB.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `url` | string | yes | Public URL to download the file from (https:// or http://). |\n| `filename` | string | | Filename with extension, e.g. \'report.pdf\'. Derived from URL if omitted. |\n| `mime_type` | string | | MIME type, e.g. \'application/pdf\'. Derived from URL response if omitted. |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `id` | string | yes | File ID. |\n| `filename` | string | yes | |\n| `mime_type` | string | yes | |\n| `url` | string | yes | |\n\n### save_record (workflow step)\n\n- Save a record found by its identity, with its lines, all or nothing.\n- A call whose match is carried by no live record adds it; one carried by a record changes the cells of set that differ and appends add_to, so sending the same call twice writes nothing the second time. match holds the record\'s identity: field keys with their values, exactly the fields of one uniqueness its table declares (a unique field, or fields unique together). set holds its other cells. add_to lists items to append to a files, multi-select or many-link field, keeping what it holds. lines saves rows of other tables that link the record.\n- Each entry names the child table_id, its one-row link field to this table, match (the child fields that with link are one uniqueness of the child table) and rows, each stating every match field. link is set by the step and no row states it.\n- A line found by its match changes the cells that differ; one not found is added; a line not listed is left as it is.\n- Any refusal \u2014 a table check, a locked record, a value a field does not take, no write access to a table \u2014 saves nothing.\n- Returns { record_id, created, updated_field_keys, lines }: the cells changed on a record that existed, and per entry of lines the ids it added, changed and left unchanged.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `table_id` | string | yes | |\n| `match` | object | yes | |\n| `set` | object \\\\| null | | |\n| `add_to` | object \\\\| null | | |\n| `lines` | object[] \\\\| null | | |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `record_id` | string | yes | |\n| `created` | boolean | yes | |\n| `updated_field_keys` | string[] | yes | |\n| `lines` | object[] | yes | |\n| `lines[].table_id` | string | yes | |\n| `lines[].created_ids` | string[] | yes | |\n| `lines[].updated_ids` | string[] | yes | |\n| `lines[].unchanged_ids` | string[] | yes | |\n\n## send\n\n### send_notification (workflow step)\n\n- Notify workspace members.\n- Lotics shows it to each recipient and emails it to their own address, through no connection; a member who signs in with an identifier an admin issued has no mailbox and sees it in Lotics alone.\n- A member is named by the member_id get_workspace kind member lists. (chat, MCP, CLI)\n- In a workflow body, every member is { type: "organization", id: runtime.organization_id } and the member who started the run { type: "member", id: runtime.triggered_by_member_id }; a run a schedule, a webhook or an email starts was started by no member. blocks draw under the message: text, stat, chart, fields, link, and record (table_id and record_id; the card shows the record\'s own title, read as the sender can read it). actions are buttons: each runs workflow_id under its owner\'s access when pressed, and its owner or an admin may name it.\n- A workflow a card can run declares notification inputs. inputs are the values the sender fixes; asks are the values the presser answers, each ask key an input of the workflow that inputs does not fix; every required input of the workflow is fixed or asked as required. decision is "any" (one decision for all recipients: the first press decides it) or "each" (every recipient decides alone); it is required with actions and refused without.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `recipients` | any[] | yes | List of recipients. Each entry is a principal: { type: \'member\', id } \\| { type: \'member_group\', id } \\| { type: \'organization\', id } |\n| `title` | string | yes | |\n| `body` | string | yes | |\n| `blocks` | any[] | | |\n| `actions` | object[] | | |\n| `actions[].key` | string | yes | |\n| `actions[].label` | string | yes | |\n| `actions[].confirm` | string | | |\n| `actions[].outcome` | "negative" | | Pressing it declines what the card asks: the button is drawn after the others, and the decided card ends with a cross rather than a check |\n| `actions[].asks` | any[] | | |\n| `actions[].workflow_id` | string | yes | |\n| `actions[].inputs` | object | yes | |\n| `decision` | "any" \\\\| "each" | | |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `message` | string | yes | |\n| `recipients_count` | number | yes | |\n\n## telegram\n\n### telegram_list_chats (workflow step)\n\n- List the chats that messaged a Telegram bot, or added it, in the last 24 hours \u2014 where a chat id comes from.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | Telegram connected account |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `chats` | object[] | yes | |\n| `chats[].chat_id` | string | yes | |\n| `chats[].type` | string | yes | private, group, supergroup or channel |\n| `chats[].name` | string | yes | |\n| `chats[].username` | string | | |\n| `chats[].last_seen_at` | string | yes | ISO timestamp of the chat\'s latest update |\n\n### telegram_send_document (workflow step)\n\n- Send a stored file from a Telegram bot to a chat, as a document with an optional caption.\n- The chat must have messaged the bot first.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | Telegram connected account |\n| `chat_id` | string | yes | Numeric chat id, or the @username of a public channel or group |\n| `file_id` | string | yes | |\n| `caption` | string | | |\n| `parse_mode` | "HTML" \\\\| "MarkdownV2" | | How the text is formatted: Telegram\'s HTML tags or its MarkdownV2 syntax |\n| `disable_notification` | boolean | | Deliver without a notification sound |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `message_id` | number | yes | |\n| `chat_id` | string | yes | |\n| `sent_at` | string | yes | ISO timestamp |\n\n### telegram_send_message (workflow step)\n\n- Send a text message from a Telegram bot to a chat.\n- The chat must have messaged the bot first.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | Telegram connected account |\n| `chat_id` | string | yes | Numeric chat id, or the @username of a public channel or group |\n| `text` | string | yes | |\n| `parse_mode` | "HTML" \\\\| "MarkdownV2" | | How the text is formatted: Telegram\'s HTML tags or its MarkdownV2 syntax |\n| `disable_notification` | boolean | | Deliver without a notification sound |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `message_id` | number | yes | |\n| `chat_id` | string | yes | |\n| `sent_at` | string | yes | ISO timestamp |\n\n## threads\n\n### threads_create_post (workflow step)\n\n- Publish a post to the connected Threads account.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | |\n| `text` | string | yes | |\n| `link` | string | | Shown as a link card. A post carries either a link or media. |\n| `media_file_ids` | string[] | | One image or video, or 2\u201320 images and videos as a carousel. |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `post_id` | string | yes | |\n| `url` | string | yes | |\n\n## vietcombank\n\n### vietcombank_convert_currency (workflow step)\n\n- Convert between currencies using live Vietcombank exchange rates.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `from_currency` | string | yes | Source currency code (e.g., \'USD\', \'EUR\', \'JPY\') |\n| `to_currency` | string | yes | Target currency code (e.g., \'USD\', \'EUR\', \'JPY\') |\n| `amount` | number | yes | The amount to convert (must be positive) |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `converted_amount` | number | yes | The converted amount |\n| `exchange_rate` | number | yes | The exchange rate |\n\n## wininvoice\n\n### wininvoice_create_or_update_invoice (workflow step)\n\n- Create or update a Vietnamese e-invoice in WinInvoice. invRef identifies the invoice: a value that already has one resolves to that invoice rather than issuing a new one, and isExisting: 1 means it came back unchanged with nothing issued.\n- Derive invRef from what is being billed rather than from a record that may later describe something else.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `invName` | string | yes | Invoice sample name, ex: 1,2,6 |\n| `invSerial` | string | yes | Invoice sign, ex: C24TAA, K24TXX |\n| `invNumber` | string | yes | Invoice number |\n| `invDate` | string | yes | Invoice date (format: yyyy/mm/dd) |\n| `invCustomer` | 0 \\\\| 1 | | Customer is not company? Value 1\\|0 |\n| `invRef` | string | yes | 3rd party Bill-ID. Identifies the invoice: a value that already has an invoice resolves to that invoice instead of issuing a new one |\n| `invRefDate` | string | | Bill date (format: yyyy/mm/dd) |\n| `billNumber` | string | | Bill number - extend |\n| `buyerTax` | string | | Buyer tax-number |\n| `buyerCode` | string | | Buyer-id |\n| `buyerName` | string | yes | Buyer full name |\n| `buyerCompany` | string | | Buyer company/ organization name |\n| `buyerAddress` | string | | Buyer full address |\n| `buyerAcc` | string | | Buyer bank account number |\n| `buyerBank` | string | | Buyer bank name |\n| `buyerEmail` | string | | Buyer email |\n| `buyerPhone` | string | | Buyer phone number |\n| `buyerFax` | string | | Buyer fax number |\n| `buyerCitizenIDNumber` | string | | Citizen Identification Number |\n| `buyerPassportNumber` | string | | Passport Number |\n| `govUnitCode` | string | | Budget-related Unit Code |\n| `invSubTotal` | number | yes | Invoice Subtotal (not include VAT, not include discount) |\n| `invVatRate` | number | yes | VAT Rate: 0,5,8,10 (0%,5%,8%,10%), -1 (Not taxable), -2 (Not declare and pay taxes) |\n| `invVatAmount` | number | yes | VAT Amount |\n| `invTotalAmount` | number | yes | Invoice Total |\n| `invPayment` | string | | Payment method |\n| `invExchangeRate` | number | | Exchange rate (to VietNam \u0111\u1ED3ng) |\n| `invCurrency` | string | | Payment currency |\n| `note` | string | | Note for discount |\n| `invAutoSign` | 0 \\\\| 1 | | Request sign invoice immediately after create successful? Value 1\\|0 |\n| `privateCode` | string | | The UID string (10-12 chars), the buyer will use this code to lookup invoice (after invoice signed). If blank, WinInvoice will generate automatically |\n| `option` | 0 \\\\| 1 \\\\| 2 \\\\| 3 \\\\| 4 | | Invoice type: 0 (Normal invoice), 1 (Information-adjustment invoice), 2 (Increases-adjustment invoice), 3 (Decreases-adjustment invoice), 4 (Replacement invoice - original will be marked as deleted when signed) |\n| `invCodeOld` | string | | Original invoice number (required for adjustment/replacement invoices) |\n| `invNameOld` | string | | Original invoice sample name (required for adjustment/replacement invoices) |\n| `invSignOld` | string | | Original invoice sign (required for adjustment/replacement invoices) |\n| `create04SSHDDT` | 0 \\\\| 1 | | Auto create 04/SS-H\u0110\u0110T? Value 1\\|0 (default 1) |\n| `reason04SSHDDT` | string | | 04/SS-H\u0110\u0110T Reason |\n| `isDscnForSaleInv` | 0 \\\\| 1 | | Apply an 8% tax reduction to the sales invoice? Value 1\\|0 (default 0) |\n| `saleInvVATRate` | number | | Tax rate based on revenue (Only applicable when isDscnForSaleInv = 1) |\n| `saleInvDscnAmnt` | number | | The reduction amount determined based on revenue and corresponding tax rate (Only applicable when isDscnForSaleInv = 1) |\n| `privateNote` | string | | Used for internal notes |\n| `items` | object[] | yes | Array of item/product in this bill |\n| `items[].itemNo` | string | | Item number |\n| `items[].itemCode` | string | | Product/Item code |\n| `items[].itemName` | string | yes | Name of product |\n| `items[].itemPromo` | 0 \\\\| 1 | | Is promotional product (gift)? Value 1\\|0 (default 0) |\n| `items[].isDscnItem` | 0 \\\\| 1 | | Is the discount line? Value 1\\|0 (default 0) |\n| `items[].itemUnit` | string | | Product Unit |\n| `items[].itemQuantity` | number | yes | Product quantity |\n| `items[].itemPrice` | number | yes | Product unit price (not include VAT) |\n| `items[].itemVatRate` | number | | Product VAT rate |\n| `items[].itemVatAmnt` | number | | Product VAT Amount |\n| `items[].itemDscnAmnt` | number | | Product Discount Amount |\n| `items[].itemAmountNoVat` | number | | Product Amount (not include VAT)(not include item discount) |\n| `items[].adjustType` | "PRICE" \\\\| "QTTY" | | Type of adjustment: PRICE (Adjust unit price of item in original invoice), QTTY (Adjust quantity of item in original invoice). This field has effect when value of option field is 2 or 3 |\n| `items[].itemPack` | string | | Product Lot |\n| `items[].itemDate` | string | | Product expiration date |\n| `items[].itemNote` | string | | Product note |\n| `items[].specialGoodsType` | 0 \\\\| 1 \\\\| 2 \\\\| 3 | | Special category of goods: 0 (Normal item/good), 1 (Cars or motorcycles), 2 (Transportation service), 3 (Transportation services on digital and e-commerce platforms) |\n| `items[].specialGoodsInfo` | object | | Data requirements for specialized goods based on specialGoodsType |\n| `items[].specialGoodsInfo.chassisNumb` | string | | Chassis Number (for cars/motorcycles - specialGoodsType = 1) |\n| `items[].specialGoodsInfo.engineNumb` | string | | Engine Number (for cars/motorcycles - specialGoodsType = 1) |\n| `items[].specialGoodsInfo.licensePlate` | string | | License plate of the transport vehicle (for transportation service - specialGoodsType = 2) |\n| `items[].specialGoodsInfo.senderName` | string | | Sender\'s Name (for shipping service - specialGoodsType = 3) |\n| `items[].specialGoodsInfo.senderAddress` | string | | Sender\'s Address (for shipping service - specialGoodsType = 3) |\n| `items[].specialGoodsInfo.senderTaxCode` | string | | Sender\'s Tax Code (for shipping service - specialGoodsType = 3) |\n| `items[].specialGoodsInfo.senderCitizenIDNumber` | string | | Sender\'s Citizen Identification Number (for shipping service - specialGoodsType = 3) |\n| `items[].isNoteItem` | 0 \\\\| 1 | | Is the note line? Value 1\\|0 (default 0) |\n| `connected_account_id` | string | yes | The ID of the connected account |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `oid` | string | yes | WinInvoice\'s UID |\n| `invCode` | string | yes | Invoice number (is \'0000000\' if has not signed) |\n| `invRef` | string | yes | 3rd party Bill-ID |\n| `invSign` | string | yes | Invoice sign, (as invSerial) |\n| `invDate` | string | yes | Invoice date, format yyyy-mm-dd |\n| `invName` | string | yes | Full invoice sample (invName + invSign) |\n| `privateCode` | string | yes | Private lookup code for buyer |\n| `itemTotal` | number | | Count of products in invoice |\n| `itemError` | number | | Count of error-products in invoice |\n| `govTranfer` | number | yes | Invoice has transferred to GOV? 1\\|0 |\n| `govTranID` | string | yes | Transaction ID used to transfer invoice to GOV |\n| `govTranferErr` | number | yes | ansferred to GOV has FAIL? 1\\|0 |\n| `govTranText` | string | yes | Error message if transfer to GOV has FAIL |\n| `govCode` | string | yes | The UID string issue by GOV for this invoice |\n| `autoSign` | number | | Has request sign immediately ? 1\\|0 |\n| `isExisting` | 0 \\\\| 1 | | 1 when invRef already had an invoice and this call returned it unchanged \u2014 no invoice was issued |\n| `link` | string | yes | Link to view the invoice |\n\n## x\n\n### x_create_post (workflow step)\n\n- Publish a post to the connected X account.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `connected_account_id` | string | yes | |\n| `text` | string | yes | |\n| `media_file_ids` | string[] | | Up to 4 images, or one GIF, or one video. |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `post_id` | string | yes | |\n| `url` | string | yes | |\n\n## zip\n\n### zip_files (workflow step)\n\n- Bundle multiple files into a zip archive.\n- Max 100 files.\n- An item in file_ids is a file id \u2014 or `{ id, name }` to name that entry in the archive: a file name, never a path, carrying the stored extension.\n- A bare id keeps the stored filename.\n\n**Inputs**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `file_ids` | string \\\\| object[] | yes | |\n| `filename` | string | | Name for the zip file, without the .zip extension. |\n\n**Answer**\n\n| Name | Type | Required | What it is |\n| --- | --- | --- | --- |\n| `file_id` | string | yes | The ID of the generated file. |\n| `url` | string | yes | The download URL of the generated file. |\n| `filename` | string | yes | The filename of the generated file, including extension. |\n| `mime_type` | string | yes | The MIME type of the generated file. |\n';
1910
1910
 
1911
1911
  // docs/app_bindings.md
1912
1912
  var app_bindings_default = "# App bindings \u2014 the queries and workflows an app calls\n\nA custom-code app reaches workspace data through two kinds of binding, each declared on the app\nunder an alias \u2014 a JS identifier (`/^[a-zA-Z_$][a-zA-Z0-9_$]*$/`):\n\n| Binding | Declared with | The app calls it with | An agent calls it with |\n|---|---|---|---|\n| Query | `set_app`, a `Query` node | `useQuery(\"<alias>\", params?)` | `run_app_query` |\n| Workflow | `set_workflow` | `useWorkflow(\"<alias>\")({ ...inputs })` | `run_app_workflow` |\n\nEach runs under the app's authority (`{ type: \"app\", app_id }`), the app owner's reach \u2014 never the\ncalling member's. Declaring one needs the app's owner or an admin. A write is live: the app's next\ncall uses it. `get_app` lists an app's aliases with their params and inputs.\n\nEach reader returns a fingerprint of what it read, and a write built on that read passes it back:\n`get_workflow`'s `version` as `set_workflow`'s `expected_version`, and `get_app`'s version as `set_app`'s\n`base_version_id`. The write is refused, and writes nothing, when it changed since; omit it for an unconditional write.\n\n## API apps\n\nAn API app is one a customer's own server calls. It holds only `Query` and `Workflow` nodes, so no address serves it, and it cannot be shared publicly.\n\n1. `set_app` with a tree of those nodes, naming the tables they read in `uses`. The answer carries the link where an admin creates its key, and `get_app` states it again.\n2. `set_workflow` sets each workflow's code.\n3. An admin opens the link and creates an app key (`lak_\u2026`). It reaches this app alone and only calls it; no other route and no tool answers it, and that can never be widened. Its secret is shown once, so it goes straight into the server's secrets, and no tool creates or reads one.\n4. To promise the shape to that server, an admin's `set_app` states `{ \"app_id\": \"\u2026\", \"api_published\": true }`: a numbered contract and an OpenAPI document, and a later write that would break it is refused.\n\nThe server sends `Authorization: Bearer lak_\u2026` to `POST /v1/apps/{app_id}/queries/{alias}` and `POST /v1/apps/{app_id}/workflows/{alias}/execute`. The answer holds what the app declares, with each row's own id and timestamps: no member's email, no field id, and a failed run a generic message beside its `execution_id`. A browser cannot call them, and a key never goes in a page.\n\nA `Query` node reads one table or List with `rows` or `list`. A wider read states the whole query as `ast`, below.\n\n## Queries\n\nA query declaration is `{ ast, params?, description?, templates? }`:\n\n- `ast` \u2014 a query template (a QueryNode, below). It fixes the tables, filters and columns the alias\n reads, so a caller cannot widen it.\n- `params` \u2014 the typed value holes the caller fills, each an input declaration (see **Inputs**),\n named in the ast as `{{params.<name>}}`. A param fills a VALUE position only \u2014 a filter value, a\n `search` \u2014 never a `table_id` or a field key. Every token the ast names is declared. An optional\n param left unset drops the conditions that read it; a required param that arrives empty is\n refused where a filter reads it.\n- `description` \u2014 one line saying what the query returns, for an agent choosing between aliases.\n- `templates` \u2014 the document templates an export of its rows may fill, by name:\n `{ <name>: { template_id: \"dtl_\u2026\", rows: \"<key the template lists the rows under>\" } }`.\n\nA save checks what a deploy checks: every table is in this workspace and within the owner's reach,\nevery projected, filtered and sorted field resolves, every param token is declared, and a key a\nnode's kind does not take (a stray `sort`, `limit`, `filter`, `search`) is refused by name.\n\n`set_app` states one as a `Query` node: `{ \"type\": \"Query\", \"key\": \"<alias>\", \"ast\": { \u2026 } }`, beside `params`,\n`description` and `templates`. On an app made from a tree it stands among the tree's `children`, and a `nodes` patch\nreplaces its `ast`, `params` or `templates` whole. On an app that serves\ncode, `nodes` takes `{ \"<alias>\": { \u2026 } }` and merges each: send only the fields you change, `null` clears `params`,\n`description` or `templates` (never `ast`), a new alias needs an `ast`, and an alias set to `null` is unbound. Its\n`children` state the list whole, each query entire, and an alias they omit is unbound. Any other field is refused by\nname, and `get_app`'s `body` reads them back by alias.\n\n### The query tree\n\nEvery node has a `kind`; all but `from_table` read the node under `from` (`join`: `left`/`right`,\n`union`: `sources`).\n\n| `kind` | Keys |\n|---|---|\n| `from_table` | `table_id`, `filter?`, `search?`, `sort?`, `limit?` |\n| `project` | `columns` \u2014 the output columns |\n| `filter` | `predicate` \u2014 a filter tree over the input's columns |\n| `join` | `left`, `right`, `on: { left_column, right_column }`, `type: \"inner\" \\| \"left\"` |\n| `union` | `sources` (at least two, columns aligned by name and type) |\n| `group` | `by` (columns, `{ bucket: { source, granularity, output } }`, or `{ band: { source, tiers, output } }`), `aggregates` |\n| `window` | `partition_by`, `order_by`, `frame?`, `aggregates?`, `functions?` |\n| `sort` | `by: [{ field_key, order }]` |\n| `limit` | `n`, `offset?` or `keyset?` |\n| `unpivot` | `passthrough`, `row_columns`, `rows` \u2014 one source row into several |\n| `unnest` | `source`, `output`, `display_output?`, `keep_empty?` \u2014 one row per element of a multi-value cell |\n\nFilters (`from_table.filter`, `filter.predicate`, an aggregate's `filter`) are the filter grammar \u2014 the\n`filters` reference \u2014 over the input's columns, taking `{{params.x}}` as values. `search` matches\nevery text-bearing field of the row, accent- and case-insensitive.\n\nA query names a table's fields by the alias its document states, wherever a node reads the table directly (a\n`from_table`'s filter and sort, the `project`, `filter`, `group`, `window`, `unnest` or `unpivot` over it) and a select\ncondition's values by the option's alias. A column a `project` writes answers under the alias it was written with; every\nname past a `project` or an aggregate is that column's own. A `union` whose arms read one alias from different tables\nprojects each arm's columns under one name first. The query is stored by key and read back by alias.\n\nA `project` column is a field's alias as a bare string (output name and type come from the field), or\n`{ output?, type?, source, writable_target?, limit? }` to rename, compute or bound one. A computed\n`source` is a field's alias, `{ literal }`, `{ eq: [a, b] }`, `{ neq: [a, b] }`, `{ isEmpty }`,\n`{ isNotEmpty }`, `{ coalesce: [...] }`, `{ concat: [...] }`, `{ record_id: true }`,\n`{ link: { source, field } }` (a field of the first linked record),\n`{ link_agg: { source, field, operation } }` (`sum`, `avg`, `min`, `max`, `count`, `string_agg`\nover every linked record), or `{ expression }`. A computed column states its `type`: `text`,\n`number`, `boolean`, `date`, `datetime`, `select`, `select_record_link`, `select_member`, `files`\nor `json`. `limit` (1\u201310) bounds a `files` column's entries per cell.\n\nAn aggregate column is `{ output, type, operation, input_column?, filter? }` \u2014 `string_agg` also\ntakes `separator`, `distinct` and `max_values`. A `window` function is\n`{ output, fn }` for `row_number`, `rank`, `dense_rank`, `percent_rank`, `cume_dist`, plus\n`buckets` for `ntile` and `input_column`, `offset?`, `default?` for `lag` / `lead`; functions need\na non-empty `order_by`.\n\n## Inputs\n\nA query's `params`, a workflow's `inputs` and an agent's `inputs` are one vocabulary: a map of\nname \u2192 `{ type, required?, description?, \u2026per type }`. An entry is required unless it states\n`required: false`.\n\n| `type` | Takes |\n|---|---|\n| `text`, `number`, `boolean`, `date`, `datetime`, `email` | \u2014 |\n| `record_link` | `table_id`; `multi?`; `max?` (with `multi`, the most ids one call carries) |\n| `select` | exactly one of `options: [{ label, value }]` or `field: \"<table id>.<alias>\"` (a select field whose CURRENT options back it); `multi?` |\n| `date_range` | `include_time?` |\n| `member` | `multi?`; `group?` (a member group the value must belong to) |\n| `file` | `multi?` \u2014 an uploaded `fil_\u2026` id, for a files field |\n| `json` | \u2014 any value |\n| `object` | `fields` \u2014 a nested map of entries |\n| `array` | `items` \u2014 one entry |\n\nA `record_link`'s `table_id`, in inputs and outputs, takes the table's id or alias and is stored as its id. Nesting stops at\ndepth 8. A `field`-form select tracks the field's options as they change, and `only: [\"<option key or alias>\", \u2026]` beside `field` keeps it to those options of the field (inputs and outputs of an app workflow, an app agent or a notification action, not a query's params); an\ninline `options` set is a fixed list. A query's select param takes an option by alias, label or key, each condition reading it by its own field's options, and a value that is none of them is refused naming the options.\n\n## Outputs\n\nA workflow's and an agent's `outputs` declare the structured data handed back: a map of\nname \u2192 `{ type, required?, description?, \u2026per type }`, every entry present unless it states\n`required: false`.\n\n| `type` | Takes |\n|---|---|\n| `text`, `number`, `boolean`, `date`, `datetime`, `email`, `json` | \u2014 |\n| `record_link` | `table_id`, `multi?` |\n| `select` | exactly one of `options: [{ label, value }]` or `field: \"<table id>.<alias>\"`; `multi?` |\n| `object` | `fields` |\n| `array` | `items` |\n\nThe returned value is checked against it, and the app reads it typed. An inline `options` set is\nalso enforced on the value returned, so the producer is told the legal keys; a `field`-form select\nkeeps the type tracking the live field.\n\n## Workflows\n\n`set_workflow` binds a workflow body to an alias: `{ workflow_id?, name?, description?, source }`, the `source`\nopening with `on({ type: \"app\", app_id, alias, inputs?, outputs? })`. Without a `workflow_id` it binds the alias; with\nthe one `get_app` lists for it, it replaces the body. On an app written as a tree the alias is one the tree names \u2014 a Workflow node's\n`key` or an Act's `workflow` \u2014 and the node states `inputs`, `outputs` and `description`\n(`reference/workflow-node`, whose value shapes differ from the **Inputs** below): a call stating any of\nthem for it is refused, and outputs the node leaves out are derived from the body. An alias the tree\nnames nowhere is archived by the next `set_app`. `set_app`'s `workflows` takes the same sources and saves them in the\nsame write as the tree: a change to what a workflow takes or hands back that its saved body no longer meets is refused\nunless the write carries the new body. A Workflow node runs only for someone who holds the\napp: on an app shared by a public link, a visitor's call of it is refused as an alias the app does\nnot have. This page's `inputs` and `outputs` are for a custom-code app.\n\n- `source` is the header, then the body; the app is the trigger. The body reads each declared\n input as `trigger.app_workflow.inputs.<name>`; no record is in scope, so it reads each one by id\n with `query_records` and `record_ids`.\n The body's steps are the `workflows` reference.\n- `inputs` in the header is the payload the call site passes (see **Inputs**). Omitted, an existing workflow keeps\n its inputs; on a first bind it takes an untyped payload. `{}` clears them.\n- `outputs` in the header is what `return({ data })` hands back (see **Outputs**). Usually omit it: the type is\n derived from the body's `return({ data })`, and the result echoes the bound `outputs`. Declared,\n the body does not save unless its return matches.\n- A save checks the body \u2014 parse, type-check against the declared inputs, names, lint, structure \u2014\n and answers with `[source/code] location: message` lines. `dry_run: true` makes every check\n and writes nothing. A call naming a live alias replaces its body in place, keeping its run history.\n- A call whose payload does not match `inputs` is refused before the body runs.\n\n`get_workflow` reads the source back; `set_workflow` with `dry_run` and `record_id` or `preview_inputs`\nrehearses a draft before binding; `set_workflow` with `delete: true` and the `workflow_id` unbinds it. An unbind is refused\nwhile the deployed version of the app calls the alias or an agent of the app declares it (`even_if_invoked` overrides it for a\nworkflow that has run, only when the caller that ran it is gone).\n";
@@ -22922,6 +22922,9 @@ function date4(params) {
22922
22922
  return _coercedDate(ZodDate, params);
22923
22923
  }
22924
22924
 
22925
+ // ../shared/src/app_capability_limits.ts
22926
+ var MAX_APP_CAPABILITY_DESCRIPTION = 300;
22927
+
22925
22928
  // ../../node_modules/big.js/big.mjs
22926
22929
  var DP = 20;
22927
22930
  var RM = 1;
@@ -24694,7 +24697,6 @@ function appWorkflowOutputDepth(output2) {
24694
24697
  return 1;
24695
24698
  }
24696
24699
  var APP_ALIAS_REGEX = /^[a-zA-Z_$][a-zA-Z0-9_$]*$/;
24697
- var MAX_APP_CAPABILITY_DESCRIPTION = 300;
24698
24700
  var APP_ANONYMOUS_REQUEST_MAX_BYTES = 256 * 1024;
24699
24701
  var APP_UPLOAD_MAX_BYTES = 25 * 1024 * 1024;
24700
24702
  var PUBLIC_APP_UPLOAD_BYTES_LIMIT = 500 * 1024 * 1024;
@@ -26799,9 +26801,12 @@ var APP_RULES = {
26799
26801
  // ─── Records ─────────────────────────────────────────────────────────────────
26800
26802
  "records.title": { sentence: "A title is the one field naming the row \u2014 any field but a button or a yes/no \u2014 and the subtitle never names the title's own field." },
26801
26803
  "records.image": { sentence: "`image` is a files field, never one an Act keeps the documents it makes in (`into`), or a single link to a table with a picture (never beside a `party`)." },
26802
- "records.mark": { sentence: "`mark` is a single select or a lookup of one through a one-row link, never a formula (a write setting one is refused: a derived flag is a Check), never the status field, nor on the folder an App works inside (`scope`), which its switcher names by a picture or its initials." },
26804
+ "records.mark": { sentence: "`mark` is a single select or a lookup of one through a one-row link, never a formula (a write setting one is refused: a derived flag is an issue), never the status field, nor on the folder an App works inside (`scope`), which its switcher names by a picture or its initials." },
26803
26805
  "records.description": { sentence: "`description` is a text field, read in the record's head \u2014 never a Field of a part too." },
26804
26806
  "records.status": { sentence: "A status is one single select, its options in the order the work goes through them, `closed` naming the ones that end it and `dropped` those of them reached from any stage." },
26807
+ "records.issues": {
26808
+ sentence: 'An issue is a formula of the row stating `output_type` "boolean" or "text" (a derived flag is an issue, never a select), listed once among the table\'s issues, or `{ rows }` naming a many-link paired to a one-row link, listed once, to a table that declares issues of its own \u2014 each rolled issue held as the count `<link>_<issue>` on the table.'
26809
+ },
26805
26810
  "records.history": {
26806
26811
  sentence: "A declared status `history` has exactly one link to the row it records, one single select holding every option of the status (or a text), exactly one date and at most one member."
26807
26812
  },
@@ -26857,7 +26862,7 @@ var APP_RULES = {
26857
26862
  design: "image"
26858
26863
  },
26859
26864
  "records.mark-derived": {
26860
- sentence: "A table whose `records.mark` is a formula keeps drawing it; a derived flag is a Check, so a write setting `mark` to a formula is refused (`records.mark`) and a stored one keeps drawing.",
26865
+ sentence: "A table whose `records.mark` is a formula keeps drawing it; a derived flag is an issue, so a write setting `mark` to a formula is refused (`records.mark`) and a stored one keeps drawing.",
26861
26866
  note: true
26862
26867
  },
26863
26868
  "records.mark-lead": {
@@ -27406,16 +27411,17 @@ var APP_RULES = {
27406
27411
  sentence: '`makes` names a child that the Act\'s entity states a `cadence` for, in a Record or in a List with `on: "view"` or `"ticked"` that is not a child List; never beside `set`, `workflow`, `template`, `templates`, `intake`, `record`, `sign`, `review` or `of`. The app lists the child\'s rows in a List, and every field of the child that the cadence does not fill and that a row requires has a `default_from`, a `default` or an autonumber, since the app writes the child. The child states a `unique` of its link to the parent and the `planned` date (the day its cadence fills, where the cadence states no `planned`), so two presses at once make a day once, and the cadence states `start` where the child\'s first date holds a moment.'
27407
27412
  },
27408
27413
  "act.workflow": {
27409
- sentence: "An Act's authored `workflow` body parses once the guards the Act states are placed above it: the code is the author's, the guards above it the platform's. A declared Workflow an Act runs takes the row pressed as `record_id` (a required record_link to the act's rows), is run by that one Act, over one row, which asks only its inputs and states no `set`, papers, `intake`, `record` or `review`. An authored `workflow` is one Act's. Where a Check refuses the Act through a List of its record's rows, the workflow holds those rows as one transaction and so cannot mail, notify, run an agent or wait.",
27414
+ sentence: "An Act's authored `workflow` body parses once the guards the Act states are placed above it: the code is the author's, the guards above it the platform's. A declared Workflow an Act runs takes the row pressed as `record_id` (a required record_link to the act's rows), is run by that one Act, over one row, which asks only its inputs and states no `set`, papers, `intake`, `record` or `review`. An authored `workflow` is one Act's. Where a Check on the count its issues roll up refuses the Act, the workflow holds the record as one transaction and so cannot mail, notify, run an agent or wait.",
27410
27415
  authoring: true
27411
27416
  },
27412
27417
  "act.set-tagged": { sentence: 'An Act\'s `set` states the moment as `{ "now": true }`, the person pressing as `{ "me": true }` and an input as `{ "input": \u2026 }` \u2014 never the strings `"now"`, `"me"` or `"input:\u2026"`.' },
27413
27418
  // ─── Checks ──────────────────────────────────────────────────────────────────
27414
- "check.field": { sentence: "A Check's `field` is a yes/no or text formula of the rows of the page's entity." },
27415
- "check.of": { sentence: "A Check stands in `pages/<entity>` and reads a yes/no or text formula of that entity." },
27419
+ "check.field": { sentence: "A Check's `field` is an issue its entity's table declares in `records.issues` \u2014 a yes/no or text formula of the row, or the count of rows a link lists that hold one (`<link>_<issue>`)." },
27420
+ "check.of": { sentence: "A Check stands in `pages/<entity>` and names an issue of that entity." },
27421
+ "check.states-nothing": { sentence: "A Check names an `on` or a `resolve`: a declared issue already stands wherever the row is drawn, so one that refuses and clears nothing adds nothing.", authoring: true },
27416
27422
  "check.not-placed": { sentence: "A Check's field is never also placed on the record as a Field \u2014 the line under the head says it." },
27417
27423
  "check.on": {
27418
- sentence: "A Check's `on` names what it refuses: `\"update\"` (the saves), the `key` of an Act over the Check's entity \u2014 on one row or over a List's rows \u2014 or `\"all\"`. One refusing a record's Acts through a List of that record's rows needs the List's link paired, so a row filed under the record waits for the Act pressed on it. It binds this App alone; a Delete is the table's checks' to refuse."
27424
+ sentence: "A Check's `on` names what it refuses: `\"update\"` (the saves), the `key` of an Act over the Check's entity \u2014 on one row or over a List's rows \u2014 or `\"all\"`. A record's Acts are refused by a Check of that record on the count its issues roll up from the rows it lists. It binds this App alone; a Delete is the table's checks' to refuse."
27419
27425
  },
27420
27426
  "check.resolve": { sentence: "A Check's `resolve` names an Act of this App on one row of the Check's entity, not refused by the Check, and drawn as a button \u2014 never a correction." },
27421
27427
  "check.restates-meter": { sentence: "A warning reading a gated meter's figure against its bound or pass mark is refused \u2014 the meter draws it." }