For more general information about templates, see the Introduction to document templates.
| Field | Description | Example | Notes |
| id | Unique document id | “044a386c-b6fd-422d-9f91-b55215a0ddbb” | |
| contract_num | Contract number | 2 | |
| discount_amount | Contract discount amount | null | |
| deposit_percent | Contract deposit percent | 15 | |
| deposit_due_offset | Days before event when deposit is due | 45 | |
| total_amount_due_offset | Days before event when total amount (or remaining balance) is due | null | |
| signers[].id | User Id of recipient / signer | 1 | Signers must be displayed within a “block“ |
| signers[].name | Name of recipient / signer | "John Hancock" | |
| signers[].address_full | Address of recipient/ signer | "123 Main Street" | |
| signers[].email | Email of recipient / signer | "[email protected]" | |
| signers[].organization | Organization of recipient / signer | "Lumos Chicago" | |
| signers[].signed | Whether the contract has been signed | false | |
| signers[].signature.id | User Id of signatory | null | null if contract unsigned |
| signers[].signature.name | Name of signatory | null | null if contract unsigned |
| signers[].signature.address | Address of signatory | null | null if contract unsigned |
| signers[].signature.ip | IP address of signatory | null | null if contract unsigned |
| signers[].signature.user_agent | User agent (web browser) of signatory | null | null if contract unsigned |
| signers[].signature.signed_at | Timestamp of when contract was signed by this signatory | null | Timestamp stored in UTC |
| signed_by_id | User Id of signatory | null | null if contract unsigned * Maintained for backwards compatibility but will soon be deprecated. |
| signed_by_name | Name of signatory | null | null if contract unsigned * Maintained for backwards compatibility but will soon be deprecated. |
| signed_by_address | Address of signatory | null | null if contract unsigned * Maintained for backwards compatibility but will soon be deprecated. |
| signed_by_ip | IP address of signatory | null | null if contract unsigned * Maintained for backwards compatibility but will soon be deprecated. |
| signed_by_user_agent | User agent (web browser) of signatory | null | null if contract unsigned * Maintained for backwards compatibility but will soon be deprecated. |
| sent_at | Timestamp of when contract was most recently sent | “2021-04-29T04:58:03.000000Z” | Timestamp stored in UTC |
| signed_at | Timestamp of when contract was signed by all signers | null | Timestamp stored in UTC |
| signed_hash | Cryptographic hash (MD5) of contract contents | null | null if contract unsigned. can be verified by re-hashing contract body. |
| cancelled_at | Timestamp of when contract was cancelled | null | Timestamp stored in UTC |
| created_by_id | User Id of user that created contract | 1 | |
| updated_by_id | User Id of user that last modified the contract | 1 | |
| created_at | Timestamp of when contract was first created | “2021-04-27T06:07:17.000000Z” | Timestamp stored in UTC |
| updated_at | Timestamp of when contract was last modified | “2021-04-29T04:58:03.000000Z” | Timestamp stored in UTC |
| status | Current status of contract | “SENT” | |
| deposit_amount | Contract deposit amount | 221.25 | |
| deposit_due_at | Timestamp of when deposit is due | “2021-03-31T00:00:00.000000Z” | Date in YYYY-MM-DD format |
| remaining_balance_amount | Remaining balance amount after deposit and discounts | 1253.75 | |
| total_amount | Total amount of contract after all discounts | 1475 | |
| total_amount_due_at | Timestamp of when total amount (or remaining balance) Is due | “2021-05-15T00:00:00.000000Z” | Date in YYYY-MM-DD format |
| events[].id | Event’s unique id | “967d632e-264b-4002-a9ae-4c58b946d7ac” | Events must be displayed within a “block“ |
| events[].title | Event’s Title | “Jay & Ami Engagement Party” | |
| events[].date | Date of Event | “2021-05-15” | Date in YYYY-MM-DD format |
| events[].time.start | Start time of event | “18:00” | Time in 24 hour format |
| events[].time.end | End time of event | null | Time in 24 hour format |
| events[].num_guests | Total number of guests expected | 75 | |
| events[].notes | Notes associated with event | null | |
| events[].created_by_id | User Id of user that created the event | 1 | |
| events[].updated_by_id | User Id of user that last modified the event | 1 | |
| events[].created_at | Timestamp of when event was first created | “2021-04-24T20:54:07.000000Z” | Timestamp stored in UTC |
| events[].updated_at | Timestamp of when event was last modified | “2021-04-29T02:04:51.000000Z” | Timestamp stored in UTC |
| events[].subtitle | Subtitle or caption of event | null | |
| events[].event_type.label | Event type label | “Engagement Party” | |
| events[].event_type.color | Event type color | “#f5b9d6” | |
| events[].event_status.label | Event status label | “Confirmed” | |
| events[].event_status.color | Event status color | “#66BB6A” | |
| events[].package.label | Event package label | “Engagement Party Package” | |
| events[].package.description | Event package description | “Celebrate your proposal with your friends and family by dancing the night away!” | |
| events[].package.image | Event package image | “f29fd78b-a2e8-44ca-b81b-c8c5e89cec55/packages/d01e84c2-8595-4781-a2eb-3a340dcc7769” | |
| events[].package.cost | Event package cost | 1000 | |
| events[].addons[].label | Event addons label | “Uplighting” | Addons must be displayed within a “block“ |
| events[].addons[].description | Event addon description | “Add a flair to your event and brighten your event hall with brilliant uplighting.” | Addons must be displayed within a “block“ |
| events[].addons[].cost | Event addon cost | 300 | Addons must be displayed within a “block“ |
| events[].location.name | Event location name | “Godavari Restaurant” | |
| events[].location.phone | Event location phone | “949 273 3327” | |
| events[].location.address | Event location address | “24416 Muirlands Blvd” | |
| events[].location.suite | Event location suite | null | |
| events[].location.city | Event location city | “Lake Forest” | |
| events[].location.zip_code | Event location zip code | “92630” | |
| events[].location.state | Event location state | “CA” | |
| events[].location.notes | Event location notes | null | |
| events[].location.address_full | Event location full address | “24416 Muirlands Blvd Lake Forest CA 92630″ | |
| events[].location.contact_person.name | Event location contact person's name | “Jane Doe″ | |
| events[].location.contact_person.phone | Event location contact person's phone number | “123-456-7890″ | |
| events[].location.contact_person.email | Event location contact person's email address | “[email protected]″ |