Skip to content
Go

Accounts, Departments & Employees

Taxi & Private Hire › Products › Account › Accounts, Departments & Employees

Generally available

How a corporate account is structured — the account as the top-level business record, departments as budget and reporting sub-units, employees linking passengers to the account, and custom fields capturing per-account data at booking. Covers how authentication, merge preferences and split billing resolve across the hierarchy. The individual account features cover the field-level detail.

Example request

POST /client/{clientId}/account/{accountId}/accountdepartment

See the API reference for the full request and response schema.

Endpoints

MethodPath
POST /client/{clientId}/account/{accountId}/accountdepartment · primary
GET /client/{clientId}/account/{accountId}/accountdepartment
POST /client/{clientId}/account/{accountId}/accountdepartment/{accountdepartmentId}
POST /client/{clientId}/account/{accountId}/brand/{brandId}
POST /client/{clientId}/account/{accountId}/clientcapability/{capabilityId}
POST /client/{clientId}/account/{accountId}/tag/{tagName}
POST /client/{clientId}/account
DELETE /client/{clientId}/account/{accountId}/clientcapability/{capabilityId}
GET /client/{clientId}/account/{accountId}
GET /client/{clientId}/account/{accountId}/tag
DELETE /client/{clientId}/account/{accountId}/tag/{tagName}
GET /client/{clientId}/account/search
POST /client/{clientId}/account/{accountId}
POST /client/{clientId}/accountdepartment/{accountdepartmentId}/brand/{brandId}
POST /client/{clientId}/accountdepartment/{accountdepartmentId}/clientcapability/{capabilityId}
POST /client/{clientId}/accountdepartment
DELETE /client/{clientId}/accountdepartment/{accountdepartmentId}/clientcapability/{capabilityId}
GET /client/{clientId}/accountdepartment/{accountdepartmentId}
GET /client/{clientId}/accountdepartment
POST /client/{clientId}/accountdepartment/{accountdepartmentId}
POST /client/{clientId}/accountemployee
POST /client/{clientId}/account/{accountId}/accountemployee
POST /client/{clientId}/accountdepartment/{accountDepartmentId}/accountemployee
GET /client/{clientId}/accountemployee/{accountEmployeeId}
GET /client/{clientId}/account/{accountId}/accountemployee/{accountEmployeeId}
GET /client/{clientId}/accountdepartment/{accountDepartmentId}/accountemployee/{accountEmployeeId}
GET /client/{clientId}/accountemployee
GET /client/{clientId}/account/{accountId}/accountemployee
GET /client/{clientId}/accountdepartment/{accountDepartmentId}/accountemployee
GET /client/{clientId}/account/{accountId}/accountdepartment/{accountDepartmentId}/accountemployee
POST /client/{clientId}/accountemployee/{accountEmployeeId}
POST /client/{clientId}/account/{accountId}/accountemployee/{accountEmployeeId}
POST /client/{clientId}/accountdepartment/{accountDepartmentId}/accountemployee/{accountEmployeeId}
GET /client/{clientId}/brand/{brandId}/accountdepartment/{accountdepartmentId}
POST /client/{clientId}/brand/{brandId}/accountdepartment/{accountdepartmentId}
PUT /client/{clientId}/accountdepartment/{accountDepartmentId}/accountemployee/{accountEmployeeId}
PUT /client/{clientId}/accountemployee/{accountEmployeeId}/accountdepartment/{accountDepartmentId}
DELETE /client/{clientId}/accountdepartment/{accountDepartmentId}/accountemployee/{accountEmployeeId}
DELETE /client/{clientId}/accountemployee/{accountEmployeeId}/accountdepartment/{accountDepartmentId}

Full request/response schemas and an interactive explorer will live in the API reference (coming soon).

Use cases

Operator flows that exercise this feature.

Create a corporate account

config risk: low

Set up a corporate account with a department and an employee.

  1. POST /client/{clientId}/account
  2. POST /client/{clientId}/accountdepartment
  3. POST /client/{clientId}/accountemployee
Update an account

config risk: low

Modify a corporate account (billing, contacts, SLA).

  1. POST /client/{clientId}/account/{accountId}
Add an account department

config risk: low

Add a department (cost-centre) to an existing corporate account.

  1. POST /client/{clientId}/accountdepartment
Add an account employee

config risk: low

Add an employee / booker to a corporate account.

  1. POST /client/{clientId}/accountemployee