Coworkers
Create Coworker
Create a new Coworker record.
POST
Create Coworker
A customer is a person or company that uses a location; members have an active contract and contacts do not.
Authentication
This endpoint requires OAuth2 authentication. Include a valid bearer token in the
Authorization header.
The authenticated user must be a full unrestricted administrator or have the Coworker-Create role.Enums
eCoworkerRecordType — CoworkerType values
eCoworkerRecordType — CoworkerType values
eGender — Gender values
eGender — Gender values
eCoworkerTaxRateType — TaxRateType values
eCoworkerTaxRateType — TaxRateType values
eCoworkerAttendance — MondayAttendance values
eCoworkerAttendance — MondayAttendance values
eRegularPaymentProvider
eRegularPaymentProvider
Request Body
Required Fields
Whether this customer record represents an Individual or a Company.. Defaults to
eCoworkerRecordType.Individual.Optional customer gender: NotSet, Male, Female, Other, or RatherNotSay.. Defaults to
eGender.NotSet.Customer email address; required by entity validation and used when creating an associated user account..
ID of the customer’s contact country; global reference data and required by entity validation..
ID of the customer’s time zone; global reference data and required by entity validation..
Tax treatment for this customer: Default, Reduced, or Exempt.. Defaults to
eCoworkerTaxRateType.Default.Expected Monday attendance: WorkingFromOffice or WorkingRemotely.. Defaults to
eCoworkerAttendance.WorkingFromOffice.Expected Tuesday attendance: WorkingFromOffice or WorkingRemotely.. Defaults to
eCoworkerAttendance.WorkingFromOffice.Expected Wednesday attendance: WorkingFromOffice or WorkingRemotely.. Defaults to
eCoworkerAttendance.WorkingFromOffice.Expected Thursday attendance: WorkingFromOffice or WorkingRemotely.. Defaults to
eCoworkerAttendance.WorkingFromOffice.Expected Friday attendance: WorkingFromOffice or WorkingRemotely.. Defaults to
eCoworkerAttendance.WorkingFromOffice.Expected Saturday attendance: WorkingFromOffice or WorkingRemotely.. Defaults to
eCoworkerAttendance.WorkingFromOffice.Expected Sunday attendance: WorkingFromOffice or WorkingRemotely.. Defaults to
eCoworkerAttendance.WorkingFromOffice.Optional Fields
List of location IDs where this customer is registered; replacing the list replaces all registrations..
List of team IDs this customer belongs to; replacing the list replaces all team memberships..
Optional preferred form of address, such as ‘Dr Adrian’; include how the customer wants to be addressed and never use a title alone, limited to 254 characters..
Whether to create the associated user account when this customer is first created; create-only..
ID of the location that owns this customer (their home location) and issues their invoices unless invoice split by location is enabled; defaults to the current location when omitted on create..
Legal or trading name printed on invoices; when empty, invoices use the company name for Company customers or FullName otherwise..
ID of the country for invoice addresses; global reference data, with the contact country and then the location country used as fallbacks..
Customer bank account identifier for a regular-payment arrangement; do not expose or set it through the agent..
Customer bank branch or sort code for a regular-payment arrangement; do not expose or set it through the agent..
External GoCardless mandate or contract identifier; managed by the payment integration and not exposed to the agent..
Stripe BACS payment-method identifier; managed by the payment integration and not exposed to the agent..
Stripe BACS mandate identifier; managed by the payment integration and not exposed to the agent..
Stripe BACS customer token; security-sensitive integration credential not exposed to the agent..
Timestamp of the last overdue-invoice reminder; maintained by reminder processing and not exposed to the agent..
Timestamp of the last low-credit reminder; maintained by reminder processing and not exposed to the agent..
Regular-payment provider selected for this customer; set by the supported payment flow rather than by manual provider assignment.. See
eRegularPaymentProvider? enum above.Read-only last four digits of the customer’s payment card; supplied by the payment provider and not exposed to the agent..
Physical access-card identifier; managed through access control and not exposed to the agent..
Physical access key-fob identifier; managed through access control and not exposed to the agent..
ID of the optional user account linked to this customer; update-only because creating the account uses CreateUser..
Next scheduled automatic-invoice date; recalculated from active contracts and maintained by invoicing processing..
Timestamp used by allowance-renewal processing; maintained by the system and not exposed to the agent..
Timestamp of the latest invoice-processing attempt; maintained by the system and not exposed to the agent..
Doordeck public key used by the access integration; not exposed through customer administration..
Internal Stripe ACH agreement status; maintained by the payment flow and not exposed to the agent..
Internal Stripe ACH deposit-verification status; maintained by the payment flow and not exposed to the agent..
Internal Square synchronization flag; maintained by the integration and not exposed to the agent..
Internal marker that an access-control error notification was sent; not exposed to the agent..
Whether customer-specific invoice-segregation settings override the location-level settings..
Whether charges for contracts other than the main contract are invoiced separately from main-contract charges when invoice segregation is enabled..
Whether booking charges are invoiced separately from plan and contract charges when invoice segregation is enabled..
Whether product charges are invoiced separately from plan and contract charges when invoice segregation is enabled..
Whether pass charges are invoiced separately from plan and contract charges when invoice segregation is enabled..
Whether event-ticket charges are invoiced separately from plan and contract charges when invoice segregation is enabled..
Whether this is the active customer profile when the linked user account has multiple customer profiles..
Whether one-off charges are invoiced separately from plan and contract charges when invoice segregation is enabled..
Code Examples
Response
200
Example Response
400
Example Response