Types
string
A basic string.
integer
A basic integer.
linked-id
Used to link the "linked" files back to the "main" file.
relation
Indicates that the field is referencing a row in another file. Eg: relation:"employees.id" expects that the value will an existing id in the employees file.
timezone
Must be a valid tz database name. Eg: America/New_York
currency
A supported currency, such as USD or CAD
booking-strategy
One of: client_employee, clientless, group, block_time, employeeless
color
A hex color, such as #ffffff for white.
datetime
A date & time string, in the format: 2020-01-26 13:00:00 (January 26th 2020 at 1pm)
date
A date string, in the format: 2020-01-26 (January 26th 2020)
boolean
Use a 1 for true and a 0 for false.
verification-method
One of: phone, email, other, plugin.text_reminders.reply
book-status
One of: active, archived
client-type
One of: inquiry, client, potential
email
Must be a valid email address.
gender
One of: M (male), F (female), C (couple)
phone
Must be a valid phone number in E.164 format: +18888675309
region
The ISO 3166-2 code of the state/region. Eg: US-NJ
postal
A zip/postal code. Eg: 90210
country
The full name of the country. Eg: United States
department
One of: front, back
money
An integer that represents a monetary value, in cents. Eg: 1928 to represent $19.28
client-status
One of: active, archived
json
A json encoded value.
payment-type
One of: payment, credit, refund
disbursement-method
For payments & refunds, one of: cash, check, credit, american-express, discover, mastercard, visa, bank-transfer, debit, electronic-check, paypal
For credits, one of: discount, write_off, coupon, gift, courtesy, prepayment, return, opening_record
employee-type
One of: archived_employee, basic_employee, manager
inquiry-method
One of: method, source, interest, teaching-time-source
payment-plan-interval
For time-based plans, one of: week, month, or an integer representing every x number of days.
For service-based plans, this should be a JSON-encoded string which includes the product ID and the frequency of appointments. Eg: {"product_id":"1234","frequency":10}
payment-plan-type
One of: service_based, time_based
product-status
One of: active, archived
product-type
One of: product, service, package
valid-hours
A JSON-encoded string that represents the start & end times for each day of the week. There can optionally be multiple time-blocks for any given day, which would indicate a break in the hours available for the day (such as being available morning and night with a break in the afternoon). Eg: {"monday":[{"start":{"time":"09:00"},"end":{"time":"22:00"}}],"tuesday":[{"start":{"time":"09:00"},"end":{"time":"22:00"}}],"wednesday":[{"start":{"time":"09:00"},"end":{"time":"22:00"}}],"thursday":[{"start":{"time":"09:00"},"end":{"time":"22:00"}}],"friday":[{"start":{"time":"09:00"},"end":{"time":"22:00"}}],"saturday":[{"start":{"time":"09:00"},"end":{"time":"22:00"}}],"sunday":[]}
(In the above example, the book is available from 9am to 10pm every day of the week except Sunday, when it is closed.)
rate
A decimal value, such as 0.22 for 22%