Doc
A proposal, contract or other document your client reviews and signs, with the people on it.
- createdType: stringFormat: date-time
_at requiredWhen the document was created.
- dealType: integer | null
_id requiredId of the deal the document is linked to, or
null. - docType: string | null
_number requiredHuman-readable document reference, unique within your account and assigned on creation.
- expirationType: string | nullFormat: date
_date requiredThe last day to sign, when the document uses a specific date rather than a preset.
nullwhen it usesexpiration_daysinstead, or never expires. - expirationType: integer | null
_days requiredHow many days after sending the deadline falls, when the document uses a preset:
7,14,30,60or90.nullwhen it usesexpiration_dateinstead, or never expires. - expiresType: string | nullFormat: date-time
_at requiredWhen signing closes: 11:59 PM on the last day to sign, with your account's timezone offset.
nullwhen the document has no deadline, and on a draft: its deadline is set when it is sent. - idType: integerrequired
Unique identifier for the document.
- projectType: array of integer
_ids requiredIds of the projects the document is linked to, limited to the projects your role can see.
- recipientsType:requiredProperties: 7
Everybody seated on the document, sender first, then receivers, then people copied in. Signing links are never included: Bonsai creates them when you send the document.
- statusType: stringenumrequired
Where the document is in its life:
draftuntil you send it, thensent, andcompletedonce everybody has signed. A sent document readsexpiredonce itsexpires_atpasses: your client can still open it but cannot sign it until you reopen it or move its deadline in Bonsai. A document that asks for an upfront payment waits inawaiting_paymentbetween the last signature and that payment.valuesdraftsentcompletedexpiredawaiting_payment - titleType: stringrequired
Document title.
- unassignedType:
_roles requiredProperties: 2Roles nobody fills yet. Fill them in Bonsai before sending; a receiver left here cannot sign.
- updatedType: stringFormat: date-time
_at requiredWhen the document was last changed.
- urlType: stringrequired
Absolute link to the document in the Bonsai app. A draft opens in the editor, ready to review and send.