Client proposal from a project, unpriced unless rates given
write_proposalWrites the client proposal My Project prints: scope by line or trade division, quantities in metric and imperial, assumptions, exclusions, terms, payment stages and the signature block. From a token, a file, calculators, takeoffs or a drawing. "Not priced" unless the reader's own rates are given.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| file | No | A My Project file (the backup a project-file answer returns, or one the reader exported): its active project's lines, with any hours and rates typed on them. | |
| name | No | The project's name on the document. | |
| intro | No | A covering note in the contractor's words. | |
| rates | No | The reader's own unit rates (the site holds no price), by line id or calculator slug: a number, or { low, high }. A line's own rate in a file stays unless its id is named here. | |
| terms | No | ||
| token | No | A project state token (cqp1.…) from a project-file answer or an update. | |
| client | No | ||
| detail | No | full (the default): the whole answer. summary: the result lines, the citation line and the page only — fewer tokens to read. | full |
| market | No | Optional. A market whose own opening choice some inputs take (a UK reader's code, an IEC motor), and whose currency symbol prints the caller's own money figures. | |
| system | No | The unit system inputs left out open in, and the one the page link opens in. The answer comes in both. | metric |
| drawing | No | A Construction Canvas drawing (a template, a house form, shapes, drawing commands or a canvas document), as a project file takes it. | |
| currency | No | The label the reader's rates are in ("$", "£", "lei"); the market's when left out. A label only: no currency is converted. | |
| takeoffs | No | Whole-job takeoffs, each an id and its measurements, as a project file takes them. | |
| reference | No | ||
| exclusions | No | ||
| preparedBy | No | ||
| validUntil | No | The date the proposal is valid until, as it is to print. | |
| calculators | No | Calculator lines, each a slug and its inputs, as a project file takes them. | |
| companyName | No | The contractor's name for the letterhead; blank prints none. | |
| includeNotes | No | ||
| showQuantities | No | ||
| groupByDivision | No | Group the scope by MasterFormat division. | |
| paymentSchedule | No | Stages of payment as the reader sets them; none is suggested. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||