Customers are parties who create Bookings and receive Offers and Invoices. They can be internal departments, external organizations, or contractors. Customers can have zero or more Contacts, who are individuals associated with the Customer.
You can associate Customers with Bookings to track their booking history.
You can track billing information and compliance details for each Customer, auto-filling Offers and Invoices with relevant data.
Create a Customer
Creates a Customer based on the provided fields.
Request Body
orgIdstring · uuid · requiredThe id of the
Organizationthat owns thisCustomer.namestring · required
addressobjectA physical address.
einstringThe Employer Identification Number (EIN) of the
Customer, or international equivalent outside of the United States, like the Chamber of Commerce number.vatNumberstringThe VAT registration number of the
Customer(not used in the United States).emailstring · emailThe general email address of the
Customer, like [email protected].phonestringThe general phone number of the
Customer.detailsstring · htmlSupports basic HTML tags and formatting.
Responses
The newly created Customer.
customerobject · required
Update a Customer
Updates the specified Customer by setting the values of the fields passed. Any fields not provided will remain unchanged. By design, you cannot change a Customer's id.
path Parameters
customerIdstring · requiredThe id of the
Customer.
Request Body
namestringaddressobjectA physical address.
einstringThe Employer Identification Number (EIN) of the
Customer, or international equivalent outside of the United States, like the Chamber of Commerce number.vatNumberstringThe VAT registration number of the
Customer(not used in the United States).emailstring · emailThe general email address of the
Customer, like [email protected].phonestringThe general phone number of the
Customer.detailsstring · htmlSupports basic HTML tags and formatting.
Responses
The updated Customer.
customerobject · required