For more general information about templates, see the Introduction to document templates.
| Field | Description | Example | Notes |
| id | Unique document id | “7757dbd6-419b-4f91-8f1e-b63a84dc07b0” | |
| contract_id | Id of contract associated with invoice | null | This value is only used if “contract” is selected as the invoice souce |
| billable_items[].cost | Invoice billable item cost | 175 | Billable items must be displayed within a “block“ |
| billable_items[].type | Invoice billable item type | “Addon” | Billable items must be displayed within a “block“ |
| billable_items[].label | Invoice billable item label | “Drapes” | Billable items must be displayed within a “block“ |
| billable_items[].description | Invoice billable item description | “Cover your event hall with elegant draping that enhances the look and feel of your event!” | Billable items must be displayed within a “block“ |
| billing_method | Source of invoice billable items can be “EVENT”, “CONTRACT”, or “CUSTOM” | “EVENT” | |
| invoice_num | Invoice number | 2 | Invoice starting number can be adjusted in “billing options” |
| due_at | Timestamp of when invoice is due at | “2021-05-15T00:00:00.000000Z” | Date in YYYY-MM-DD format |
| deposit_percent | Invoice deposit percent | 25 | |
| deposit_due_at | Timestamp of when deposit is due at | “2021-03-31T00:00:00.000000Z” | Date in YYYY-MM-DD format |
| discount_amount | Invoice discount amount | null | |
| notes | Billing notes associated with invoice | null | |
| quote_at | Timestamp of when invoice was sent as a quote | “2021-04-28T03:38:39.000000Z” | Timestamp stored in UTC |
| sent_at | Timestamp of when invoice was most recently sent | “2021-04-28T03:38:39.000000Z” | Timestamp stored in UTC |
| paid_at | Timestamp of when invoice was paid | null | Timestamp stored in UTC |
| paid_in_full | Whether invoice has been paid in full | null | Stored as boolean value (true, false, or null) |
| cancelled_at | Timestamp of when invoice was cancelled | null | Timestamp stored in UTC |
| created_by_id | User Id of user that created the invoice | 1 | |
| updated_by_id | User Id of user that last modified the invoice | 1 | |
| created_at | Timestamp of when invoice was first created | “2021-04-26T05:37:37.000000Z” | Timestamp stored in UTC |
| updated_at | Timestamp of when invoice was last modified | “2021-04-30T15:20:55.000000Z” | Timestamp stored in UTC |
| status | Current status of invoice. Can be “DRAFT”, “QUOTE”, “SENT”, “PARTIAL”, “PAID”, or “CANCELLED” | “SENT” | |
| bill_from.name | Your company’s name | “Lumos Events Chicago” | Company information can be updated in “business information” |
| bill_from.address | Your company’s address | “5 N Wabash” | Company information can be updated in “business information” |
| bill_from.suite | Your company’s suite | null | Company information can be updated in “business information” |
| bill_from.city | Your company’s city | “Chicago” | Company information can be updated in “business information” |
| bill_from.state | Your company’s state | “IL” | Company information can be updated in “business information” |
| bill_from.zip_code | Your company’s zip code | “60606” | Company information can be updated in “business information” |
| bill_from.address_full | Your company’s full address | “5 N Wabash Chicago IL 60606″ | Company information can be updated in “business information” |
| total_amount | Total amount due for invoice after all discounts | 1475 | |
| sub_total_amount | Sub total of all billable items | 1475 | |
| deposit_amount | Deposit amount due | 368.75 | |
| remaining_balance_amount | Balance due after deposit is paid | 1106.25 | |
| outstanding_balance_amount | Outstanding amount still due on invoice | 1475 | |
| paid_amount | Amount paid to invoice | 0 | |
| footer | Footer that is applied to all invoices | “” | Footer can be modified in “billing options” |
| bill_to.name | Customer’s name | “John Doe” | |
| bill_to.organization | Customer’s organization | “ACME Company” | |
| bill_to.email | Customer’s email | “[email protected]” | |
| bill_to.phone | Customer’s phone number | null | |
| bill_to.address | Customer’s address | “1234 Main Street” | |
| bill_to.suite | Customer’s suite | null | |
| bill_to.city | Customer’s city | “Oakland” | |
| bill_to.zip_code | Customer’s zip code | “92835” | |
| bill_to.state | Customer’s state | “CA” | |
| bill_to.address_full | Customer’s full address | “1234 Sunnycrest Drive Oakland CA 90135″ | |
| 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]″ | |
| payments[].amount | The amount of the original payment | 200 | Payments must be displayed within a “block“ |
| payments[].amount_refunded | Any amounts that have been refunded | 0 | |
| payments[].amount_captured | The amount of payment that has been captured after any partial refunds | 200 | |
| payments[].method | Payment method | “CARD” | |
| payments[].notes | Payment notes | “Sample Notes” | |
| payments[].payor_name | Name of Payor | “John Smith” | |
| payments[].created_at | Timestamp of when payment was first created | “2021-04-29T02:04:51.000000Z” | Timestamp stored in UTC |
| payments[].updated_at | Timestamp of when payment was last modified | “2021-04-29T02:04:51.000000Z” | Timestamp stored in UTC |
| payments[].refunds.amount | The amount of the refund | 0 | Can only be accessed with a sub-block (for nested data) |
| payments[].refunds.created_at | Timestamp of when the refund was first created | “2021-04-29T02:04:51.000000Z” | Timestamp stored in UTC |