Sites
A site is a physical location belonging to a client, where workers are placed to complete
bookings. A site belongs to exactly one client and inherits that client’s branch and agency context.
Whether your credentials can reach a site — and its contacts, activities, rate contracts and cost
centres — is decided by that client’s branch, not by the site’s own optional branchId.
Sites carry the operational detail that governs work done there:
- Hourly rates per skill.
- Assessment requirements a worker must satisfy before being placed.
- Departments and contact persons for communication.
- Documents — site instructions, risk assessments and similar.
- Worker lists — the workers recorded as suitable, not suitable, assessed or banned there. These are held on the worker record; see Workers.
Why sites matter more than they look
Section titled “Why sites matter more than they look”Sites are the reference point for bookings, plans and invoices. Rates, assessment requirements and banned-worker rules are all site-specific, not client-specific — two sites of the same client can pay differently and admit different workers. Any integration that places workers has to read the site rather than the client.
Site endpoints are nested under their client, which reflects that ownership: a site is only ever addressed in the context of the client it belongs to. Sites are soft-deleted rather than removed, and a deleted site can be restored.
Site rates
Section titled “Site rates”Site rates are the reason sites matter commercially. A rate contract ties one job category — and optionally one shift — to what the agency pays the worker and what it charges the client for work at that site. A site can hold several, one per job category it books.
Every rate on a contract comes as a pair: a pre-parity rate and a post-parity rate. Under the Agency Workers Regulations a temporary worker becomes entitled to the same basic terms as a comparable permanent employee once they have been in the same role long enough, so a contract has to carry both the rate before that point and the rate after it. Both halves are stored together and always travel together.
Where an agency has set a minimum margin on a rate type, a contract whose pay and charge rates fall below it is still accepted — the shortfall is reported back as an advisory warning rather than rejected. Nothing in the API blocks an under-margin rate, so an integration that cares about margin has to read those warnings itself.
A rate contract is soft-deleted and there is no way to restore one, which keeps historical work priced against it intact.
Relationships
Section titled “Relationships”- One client has many sites.
- One site has many bookings.
- Workers are assigned to bookings at a site.
Back to the domain model, or straight to the reference.