booking

ACCESS

Directly accessible in:

Booking Details Invoice Message Payment Reminder

Example

json

{
  "id": 1,
  "name": "Syngency Summer Lookbook",
  "description": "TVC — 30 second spot",
  "start_date": "2025-01-31 12:00:00",
  "currency_html": "$",
  "invoice_number": "INV-0042",
  "invoice_date": "2025-01-31 12:00:00",
  "invoice_due_date": "2025-01-31 12:00:00",
  "payment_terms": "NET 30",
  "purchase_order_number": null,
  "job_number": null,
  "invoice_note": null,
  "invoice_due_status": "overdue",
  "payment_url": null,
  "usages": "Digital, Print",
  "territories": "Worldwide",
  "usage_territories": "Worldwide\nAustralia & New Zealand",
  "usage_periods": "12 months",
  "usage_period": "12 months",
  "totals": [],
  "production": [{
    "name": "Hair & Makeup",
    "role": "Jane Smith"
  }],
  "flights": null,
  "accommodation": null,
  "driver": null,
  "user": {
    "name": "Alex Johnson",
    "email": "alex@agency.com",
    "email_signature": null
  },
  "model": {
    "id": 1,
    "display_name": "Sarah Jones",
    "first_name": "Sarah",
    "last_name": "Jones",
    "address": "123 Main St, Los Angeles, CA",
    "headshot_url": null,
    "notes": "<p>Blonde highlights, open to dye.</p>",
    "response_url": null,
    "schedules": [],
    "fees": [{
      "description": "Day Rate",
      "quantity": 2,
      "rate_per": "Day",
      "rate": "$750.00",
      "amount": "$1,500.00"
    }],
    "expenses": [{
      "description": "Travel",
      "quantity": null,
      "rate_per": null,
      "rate": null,
      "amount": "$250.00",
      "is_paid_to_model": 0
    }],
    "attachments": [{
      "token": null,
      "name": "Brief",
      "ext": "pdf",
      "size": 1,
      "url": null
    }]
  },
  "custom_fields": [],
  "models": [{
    "display_name": "Sarah Jones",
    "is_released": 0,
    "schedules": [],
    "fees": [{
      "description": "Day Rate",
      "quantity": 2,
      "rate_per": "Day",
      "rate": "$750.00",
      "amount": "$1,500.00"
    }],
    "expenses": [{
      "description": "Travel",
      "quantity": null,
      "rate_per": null,
      "rate": null,
      "amount": "$250.00"
    }]
  }]
}

Properties

id integer

name string

description string

Available in documents.booking_confirmation, documents.booking_invoice, documents.booking_quote, and documents.model_statement.

start_date datetime

Use with the Liquid date filter to format. Available in documents.booking_confirmation.

currency_html string

Currency symbol for the booking.

invoice_number string

Available in documents.booking_invoice and documents.booking_quote.

invoice_date datetime

Use with the Liquid date filter to format. Available in documents.booking_invoice and documents.booking_quote.

invoice_due_date datetime

Use with the Liquid date filter to format. Available in documents.booking_invoice and documents.booking_quote.

payment_terms string

e.g. NET 30, NET 0. When NET 0, display as Due Upon Receipt. Available in documents.booking_invoice and documents.booking_quote.

purchase_order_number string

Available in documents.booking_confirmation, documents.booking_invoice, and documents.booking_quote.

job_number string

Available in documents.booking_confirmation, documents.booking_invoice, and documents.booking_quote.

invoice_note string

Optional note displayed at the bottom of the invoice. Available in documents.booking_invoice and documents.booking_quote.

invoice_due_status string

Human-readable due status, e.g. overdue, due today. Available in email.payment_reminder.

payment_url string

Format: absolute-url

Link for the contact to pay the invoice online. Available in email.payment_reminder.

usages string

territories string

Available in email.booking_details. Use with newline_to_br filter.

usage_territories string

Available in documents.booking_confirmation. Use with newline_to_br filter.

usage_periods string

Available in email.booking_details.

usage_period string

Available in documents.booking_confirmation. Use with newline_to_br filter.

totals array

Array of [label, amount] pairs. Each item is a two-element array — index 0 is the label (e.g. Subtotal, GST, Total), index 1 is the raw amount. Use with money_without_currency filter. Available in documents.booking_confirmation, documents.booking_invoice, and documents.booking_quote — see the top-level totals object for the documents.model_statement variant.

production array

name string

role string

flights string

Format: html

Available in email.booking_details.

accommodation string

Format: html

Available in email.booking_details.

driver string

Available in email.booking_details.

user object

The booker assigned to this booking.

name string

email string

email_signature string

Format: html

Available in email.invoice_message.

model object

The talent assigned to the booking. Present in email.booking_details and documents.model_statement.

id integer

display_name string

first_name string

last_name string

address string

Available in documents.model_statement.

headshot_url string

Format: absolute-url

Available in email.booking_details.

notes string

Format: html

Booking-specific notes for this talent. Available in email.booking_details.

response_url string

Format: absolute-url

URL for the talent to confirm or decline the booking. Available in email.booking_details.

schedules array

Array of schedule objects.

fees array

description string

quantity integer

rate_per string

rate string

amount string

expenses array

Expense line items for this talent. Available in documents.model_statement.

description string

quantity integer

rate_per string

rate string

amount string

is_paid_to_model boolean

If true, this expense is payable directly to the talent.

attachments array

Available in email.booking_details.

token string

name string

ext string

size integer

File size in bytes.

url string

Format: absolute-url

custom_fields array

Array of custom_field objects.

models array

All talent assigned to the booking. Available in documents.booking_confirmation, documents.booking_invoice, and documents.booking_quote.

display_name string

is_released boolean

If true, this talent has been released from the booking. Available in documents.booking_confirmation.

schedules array

Available in documents.booking_confirmation.

Array of schedule objects.

fees array

Invoice line items for this talent.

description string

quantity integer

rate_per string

rate string

amount string

expenses array

Expense line items for this talent. Same structure as fees.

description string

quantity integer

rate_per string

rate string

amount string

booking ​

Example ​

Properties ​

booking

Example

Properties