Account

# Account

Information and settings for your account.

## Attributes

<table>
  <tr><th>Name</th><th>Type</th><th>Description</th></tr>
  <tr><td>created_at</td><td>Datetime</td><td>Automatically set</td></tr>
  <tr><td>updated_at</td><td>Datetime</td><td>Automatically set</td></tr>
  <tr><td>subdomain</td><td>String</td><td>Required</td></tr>
  <tr><td>email</td><td>String</td><td>Required</td></tr>
  <tr><td>name</td><td>String</td><td>Required</td></tr>
  <tr><td>google_analytics</td><td>String</td><td></td></tr>
  <tr><td>css_url</td><td>String</td><td></td></tr>
  <tr><td>time_zone</td><td>String</td><td>Required</td></tr>
  <tr><td>verification_method</td><td>String</td><td>Values: no_verification, email, sms, authenticated, id_porten, vipps.</td></tr>
  <tr><td>address</td><td>String</td><td></td></tr>
  <tr><td>country_code</td><td>String</td><td>Required. ISO 3166-1 alpha-2.</td></tr>
  <tr><td>logo</td><td>File</td><td></td></tr>
  <tr><td>template</td><td>String</td><td>Values: amsterdam, lviv, timisoara.</td></tr>
  <tr><td>service_template</td><td>String</td><td></td></tr>
  <tr><td>locale</td><td>String</td><td>Required. Supported locales: cs, da, de, en, en-GB, en-US, es, fr, he, it, lt, lv, ms, nb, nl, pl, ru, sl, sq, sv. Default: 'en'.</td></tr>
  <tr><td>currency</td><td>String</td><td>Required. ISO4217 currency code</td></tr>
  <tr><td>email_notification</td><td>Boolean</td><td></td></tr>
  <tr><td>mail_notification_recipient</td><td>Email</td><td></td></tr>
  <tr><td>sms_notification</td><td>Boolean</td><td></td></tr>
  <tr><td>phone_number</td><td>String</td><td></td></tr>
  <tr><td>confirm_manually</td><td>Boolean</td><td></td></tr>
  <tr><td>settings</td><td>Object</td><td>Key/value. Stored as strings.</td></tr>
  <tr><td>public_access</td><td>Boolean</td><td></td></tr>
  <tr><td>interval_rounding</td><td>Integer</td><td>Default setting for all services for rounding to next available time. '15' will round 10:07 to become 10:15 as next available slot time.</td></tr>
  <tr><td>slot_generation</td><td>String</td><td>Default: dynamic. Values: dynamic (next available), fixed.</td></tr>
  <tr><td>future_bookable_period</td><td>String</td><td>Natural language date/time relative to current time.</td></tr>
  <tr><td>first_bookable_period</td><td>String</td><td>Natural language date/time relative to current time.</td></tr>
  <tr><td>payment_provider</td><td>String</td><td></td></tr>
  <tr><td>footer</td><td>Text</td><td></td></tr>
  <tr><td>verification_methods</td><td>Array</td><td>Array of strings, see verification_method for values.</td></tr>
  <tr><td>reminder_sms</td><td>Boolean</td><td></td></tr>
  <tr><td>closed_for_holidays</td><td>Boolean</td><td></td></tr>
  <tr><td>reservation_form_text</td><td>Liquid-Text</td><td>Above booking form.</td></tr>
  <tr><td>new_booking_text</td><td>Liquid-Text</td><td>Booking confirmation page.</td></tr>
  <tr><td>booking_form</td><td>Liquid-Text</td><td>Custom booking form.</td></tr>
  <tr><td>person_form</td><td>Liquid-Text</td><td>For custom data in administration system.</td></tr>
  <tr><td>resource_form</td><td>Liquid-Text</td><td>For custom data in administration system.</td></tr>
  <tr><td>service_form</td><td>Liquid-Text</td><td>For custom data in administration system.</td></tr>
  <tr><td>event_form</td><td>Liquid-Text</td><td>For custom data in administration system.</td></tr>
  <tr><td>appointment_form</td><td>Liquid-Text</td><td>For custom data in administration system.</td></tr>
  <tr><td>category_form</td><td>Liquid-Text</td><td>For custom data in administration system.</td></tr>
  <tr><td>account_form</td><td>Liquid-Text</td><td>For custom data in administration system.</td></tr>
  <tr><td>custom_data</td><td>Object</td><td>Key/value. Stored as strings.</td></tr>
  <tr><td>sms_verification</td><td>Liquid-Text</td><td></td></tr>
  <tr><td>sms_confirmation</td><td>Liquid-Text</td><td></td></tr>
  <tr><td>sms_modification</td><td>Liquid-Text</td><td></td></tr>
  <tr><td>sms_cancellation</td><td>Liquid-Text</td><td></td></tr>
  <tr><td>sms_declined</td><td>Liquid-Text</td><td></td></tr>
  <tr><td>sms_reminder</td><td>Liquid-Text</td><td></td></tr>
  <tr><td>mail_verification</td><td>Liquid-Text</td><td></td></tr>
  <tr><td>mail_confirmation</td><td>Liquid-Text</td><td></td></tr>
  <tr><td>mail_modification</td><td>Liquid-Text</td><td></td></tr>
  <tr><td>mail_cancellation</td><td>Liquid-Text</td><td></td></tr>
  <tr><td>mail_declined</td><td>Liquid-Text</td><td></td></tr>
  <tr><td>mail_verification_subject</td><td>String</td><td></td></tr>
  <tr><td>mail_confirmation_subject</td><td>String</td><td></td></tr>
  <tr><td>mail_modification_subject</td><td>String</td><td></td></tr>
  <tr><td>mail_cancellation_subject</td><td>String</td><td></td></tr>
  <tr><td>mail_declined_subject</td><td>String</td><td></td></tr>
  <tr><td>allow_cancellation</td><td>Boolean</td><td></td></tr>
  <tr><td>cancellation_period</td><td>String</td><td>Natural language date/time relative to start of booking.</td></tr>
</table>

### Additional parameters

<table>
  <tr><th>Name</th><th>Type</th><th>Description</th></tr>
  <tr><td>remove_logo</td><td>Boolean</td><td></td></tr>
</table>

## Get account

`GET /client` will get the account.

## Update account

`PUT /client` will update the account.

## Holidays

Who doesn't like a holiday?

### Listing

`GET /client/holidays` will get holidays for account country.

Response

```json
[
  {
    "holiday": {
      "date": "2016-01-01",
      "name": "New Year's Day"
    }
  },
  {
    "holiday": {
      "date": "2016-05-01",
      "name": "International Workers' Day"
    }
  }
]
```

#### Query Parameters

<table>
  <tr><th>Name</th><th>Type</th><th>Description</th></tr>
  <tr><td>from</td><td>Date</td><td>Default: beginning of the current week.</td></tr>
  <tr><td>to</td><td>Date</td><td>Default: end of the week of from.</td></tr>
</table>

## Users

Users who can log in to the account.

### Attributes for user role on the account

<table>
  <tr><th>Name</th><th>Type</th><th>Description</th></tr>
  <tr><td>id</td><td>Integer</td><td>Automatically set</td></tr>
  <tr><td>created_at</td><td>Datetime</td><td>Automatically set</td></tr>
  <tr><td>updated_at</td><td>Datetime</td><td>Automatically set</td></tr>
  <tr><td>user_id</td><td>Integer</td><td>Automatically set</td></tr>
  <tr><td>role</td><td>String</td><td>admin, manager or staff</td></tr>
  <tr><td>user</td><td>Object</td><td>See attributes for a user</td></tr>
</table>

### Attributes for user

<table>
  <tr><th>Name</th><th>Type</th><th>Description</th></tr>
  <tr><td>id</td><td>Integer</td><td>Automatically set</td></tr>
  <tr><td>created_at</td><td>Datetime</td><td>Automatically set</td></tr>
  <tr><td>updated_at</td><td>Datetime</td><td>Automatically set</td></tr>
  <tr><td>name</td><td>String</td><td>Required</td></tr>
  <tr><td>email</td><td>String</td><td>Required</td></tr>
</table>

### Listing

`GET /client/users` will list all users with access to the account.

Response

```json
[
  {
    "client_user_link": {
      "id": 1337,
      "created_at": "2016-11-07T07:26:32+01:00",
      "updated_at": "2016-11-07T07:27:42+01:00",
      "role": "admin",
      "user_id": 1,
      "user": {
          "id": 1,
          "email": "maestro@example.org",
          "name": "Espen Antonsen",
          "created_at": "2016-11-07T07:26:32+01:00",
          "updated_at": "2016-11-07T07:27:42+01:00"
      }
    }
  }
]
```

## Get user

`GET /client/users/{user_link_id}` will get a user with id `{user_link_id}`.

## Add new user

`POST /client/users` will create a new user. An email is sent to the user so the user can specify their password.

## Update user

`PUT /client/users/{user_link_id}` will update the user role. Specify `role` in parameter `client_user_link`.

## Delete user

`DELETE /client/users/{user_link_id}` will remove the user from the account. The last admin user cannot be removed.

Information and settings for your account.

Attributes

Name	Type	Description
created_at	Datetime	Automatically set
updated_at	Datetime	Automatically set
subdomain	String	Required
email	String	Required
name	String	Required
google_analytics	String
css_url	String
time_zone	String	Required
verification_method	String	Values: no_verification, email, sms, authenticated, id_porten, vipps.
address	String
country_code	String	Required. ISO 3166-1 alpha-2.
logo	File
template	String	Values: amsterdam, lviv, timisoara.
service_template	String
locale	String	Required. Supported locales: cs, da, de, en, en-GB, en-US, es, fr, he, it, lt, lv, ms, nb, nl, pl, ru, sl, sq, sv. Default: 'en'.
currency	String	Required. ISO4217 currency code
email_notification	Boolean
mail_notification_recipient	Email
sms_notification	Boolean
phone_number	String
confirm_manually	Boolean
settings	Object	Key/value. Stored as strings.
public_access	Boolean
interval_rounding	Integer	Default setting for all services for rounding to next available time. '15' will round 10:07 to become 10:15 as next available slot time.
slot_generation	String	Default: dynamic. Values: dynamic (next available), fixed.
future_bookable_period	String	Natural language date/time relative to current time.
first_bookable_period	String	Natural language date/time relative to current time.
payment_provider	String
footer	Text
verification_methods	Array	Array of strings, see verification_method for values.
reminder_sms	Boolean
closed_for_holidays	Boolean
reservation_form_text	Liquid-Text	Above booking form.
new_booking_text	Liquid-Text	Booking confirmation page.
booking_form	Liquid-Text	Custom booking form.
person_form	Liquid-Text	For custom data in administration system.
resource_form	Liquid-Text	For custom data in administration system.
service_form	Liquid-Text	For custom data in administration system.
event_form	Liquid-Text	For custom data in administration system.
appointment_form	Liquid-Text	For custom data in administration system.
category_form	Liquid-Text	For custom data in administration system.
account_form	Liquid-Text	For custom data in administration system.
custom_data	Object	Key/value. Stored as strings.
sms_verification	Liquid-Text
sms_confirmation	Liquid-Text
sms_modification	Liquid-Text
sms_cancellation	Liquid-Text
sms_declined	Liquid-Text
sms_reminder	Liquid-Text
mail_verification	Liquid-Text
mail_confirmation	Liquid-Text
mail_modification	Liquid-Text
mail_cancellation	Liquid-Text
mail_declined	Liquid-Text
mail_verification_subject	String
mail_confirmation_subject	String
mail_modification_subject	String
mail_cancellation_subject	String
mail_declined_subject	String
allow_cancellation	Boolean
cancellation_period	String	Natural language date/time relative to start of booking.

Additional parameters

Name	Type	Description
remove_logo	Boolean

Get account

GET /client will get the account.

Update account

PUT /client will update the account.

Holidays

Who doesn’t like a holiday?

Listing

GET /client/holidays will get holidays for account country.

Response

[
  {
    "holiday": {
      "date": "2016-01-01",
      "name": "New Year's Day"
    }
  },
  {
    "holiday": {
      "date": "2016-05-01",
      "name": "International Workers' Day"
    }
  }
]

Query Parameters

Name	Type	Description
from	Date	Default: beginning of the current week.
to	Date	Default: end of the week of from.

Users

Users who can log in to the account.

Attributes for user role on the account

Name	Type	Description
id	Integer	Automatically set
created_at	Datetime	Automatically set
updated_at	Datetime	Automatically set
user_id	Integer	Automatically set
role	String	admin, manager or staff
user	Object	See attributes for a user

Attributes for user

Name	Type	Description
id	Integer	Automatically set
created_at	Datetime	Automatically set
updated_at	Datetime	Automatically set
name	String	Required
email	String	Required

Listing

GET /client/users will list all users with access to the account.

Response

[
  {
    "client_user_link": {
      "id": 1337,
      "created_at": "2016-11-07T07:26:32+01:00",
      "updated_at": "2016-11-07T07:27:42+01:00",
      "role": "admin",
      "user_id": 1,
      "user": {
          "id": 1,
          "email": "maestro@example.org",
          "name": "Espen Antonsen",
          "created_at": "2016-11-07T07:26:32+01:00",
          "updated_at": "2016-11-07T07:27:42+01:00"
      }
    }
  }
]

Get user

GET /client/users/{user_link_id} will get a user with id {user_link_id}.

Add new user

POST /client/users will create a new user. An email is sent to the user so the user can specify their password.

Update user

PUT /client/users/{user_link_id} will update the user role. Specify role in parameter client_user_link.

Delete user

DELETE /client/users/{user_link_id} will remove the user from the account. The last admin user cannot be removed.