Doc

A proposal, contract or other document your client reviews and signs, with the people on it.

  • created_at
    Type: stringFormat: date-time
    required

    When the document was created.

  • deal_id
    Type: integer | null
    required

    Id of the deal the document is linked to, or null.

  • doc_number
    Type: string | null
    required

    Human-readable document reference, unique within your account and assigned on creation.

  • id
    Type: integer
    required

    Unique identifier for the document.

  • project_ids
    Type: array of integer
    required

    Ids of the projects the document is linked to, limited to the projects your role can see.

  • recipients
    Type: array of DocRecipient
    required

    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.

    Properties: 7
  • status
    Type: stringenum
    required

    Where the document is in its life: draft until you send it, then sent, and completed once everybody has signed, or expired if it lapsed first.

    values
    draftsentcompletedexpired
  • title
    Type: string
    required

    Document title.

  • unassigned_roles
    Type: array of DocRole
    required

    Roles nobody fills yet. Fill them in Bonsai before sending; a receiver left here cannot sign.

    Properties: 2
  • updated_at
    Type: stringFormat: date-time
    required

    When the document was last changed.

  • url
    Type: string
    required

    Absolute link to the document in the Bonsai app. A draft opens in the editor, ready to review and send.