Enums

Enumeration Types (or Enums) are scalars that restricts the value to a set of predefined constants.

AccountType

The type of account a user can have.

Values
`WORKER` A Worker account type.
`COMPANY` A Company account type.
`RECRUITER` A Recruiter account type.
`ORGANISATION` An Organisation account type.
`PARTNER` A Partner account type.

AiChatContext

The contexts that the AI chat can be used in.

Values
`HIRE` The context for a hire.
`DIALOG` The context for a dialog.

AiJobDescriptionContext

The job description context types

Values
`JOB_POST` Job Post
`DIRECT_HIRE` Direct Hire

ApprovalApprovableOrderByColumn

The columns that the approvables list can be ordered by.

Values
`CREATED_AT` The approvable created at date

ApprovalApprovableState

The state of an approval request or an action taken by an approver.

Values
`UNKNOWN` The approval state could not be determined.
`REQUESTED` The approval has been requested and is waiting for an approver to act. The item (e.g. hire) is blocked until reviewed.
`APPROVED` The approver has approved the request. If all approvers in the sequence have approved, the item proceeds.
`REJECTED` The approver has rejected the request. For hires, this results in the hire being cancelled.
`NEEDS_CHANGE` The approver has requested changes before they can approve. The item remains blocked until the changes are made and the request is re-evaluated.
`CANCELLED` The approval request was automatically cancelled — for example, the hire was cancelled, the job was closed, or the workflow was re-triggered.

ApprovalCancellationReason

The reason an approval request was automatically cancelled before completion.

Values
`HIRE_ENDED` The hire reached its end date or was otherwise ended, making the pending approval unnecessary.
`HIRE_CANCELLED` The hire was cancelled by the company before the approval could be completed.
`JOB_CLOSED` The job associated with the approval was closed, invalidating the pending request.
`APPROVAL_REJECTED` Another approval in the same workflow was rejected, causing this request to be cancelled as a consequence.
`CLASSIFICATION_RETRIGGERED` A new classification was triggered, replacing the one this approval was for.
`WORKFLOW_RETRIGGERED` The approval workflow was re-triggered (e.g. after a contract change), replacing this request with a new one.
`APPROVABLE_REMOVED` The item that required approval was removed from the system.

ApprovalStatus

The operational status of an approval flow. Only active approvals are evaluated when trigger events occur.

Values
`ACTIVE` The approval flow is live and will be evaluated when its trigger event fires.
`INACTIVE` The approval flow is paused and will not be evaluated. Can be reactivated later.
`ARCHIVED` The approval flow has been retired and is kept for historical reference only.

ApprovalTrigger

The event that triggers an approval flow. All triggers currently apply to hires only — jobs, payment requests, and other entities are not supported.

Values
`NONE` No trigger — the approval flow will not be automatically evaluated.
`HIRE_CREATED` Triggered when a new hire is created. Evaluates conditions like rate and budget against the new hire details.
`HIRE_CHANGED` Triggered when a hire contract is changed (e.g. rate or end date updated). Evaluates conditions against the updated contract terms.
`CLASSIFICATION_CREATED` Triggered when a worker classification (e.g. IR35 or US worker classification) is completed. Evaluates conditions against the classification result.

Association

The estimated commitment of a job.

Values
`SMALL_TASK` Small task
`PROJECT` Project
`BIG_PROJECT` Big project
`PART_TIME` Part time
`FULL_TIME` Full time

BatchActionType

The action to run on a batch.

Values
`PROCESS` Process items in the batch.
`EXPORT` Export items in the batch.
`UNDO` Undo processing for items in the batch.

BatchItemStatus

The status of an item in a batch.

Values
`PROCESSING` Item is processing.
`PROCESSED` Item has been processed.

BatchType

The type of items grouped in a batch for bulk processing.

Values
`PARTNER_PAYMENT_REQUESTS` Partner payment requests batch.

BidStatus

The status of a bid.

Values
`OPEN` Offer was created.
`ACCEPTED` Offer was accepted.
`REJECTED` Offer was rejected.
`CANCELLED` Offer was cancelled.

BusinessEntityType

The legal structure of a worker’s business, which varies by market and determines payment and compliance requirements.

Values
`COMMON` Common
`NO_SETUP` No Setup
`PERSONAL` Personal
`AU_LTD` AU: Ltd
`AU_SOLE_TRADER` AU: Sole Trader
`DE_FREELANCER` DE: Freelancer
`DE_TRADESPERSON` DE: Tradesperson
`DE_ENTREPRENEURIAL` DE: Entrepreneurial
`DE_LTD` DE: Limited
`NL_LTD` NL: Limited
`NL_SOLE_TRADER` NL: Sole Trader
`B_INCOME` B-income
`FR_LTD` FR: Limited
`FR_SOLE_TRADER` FR: Sole Trader
`IE_LTD` IE: Limited
`IE_SOLE_TRADER` IE: Sole Trader
`SG_LTD` SG: Limited
`SG_SOLE_TRADER` SG: Sole Trader
`LTD` UK: Limited
`SOLE_TRADER` UK: Sole Trader
`UMBRELLA` UK: Umbrella

ClassificationResult

Determination result

Values
`EMPLOYEE` Employee
`LIKELY_EMPLOYEE` Deprecated Likely employee
`UNKNOWN` Unknown
`LIKELY_INDEPENDENT` Deprecated Likely independent
`INDEPENDENT` Independent

ClassificationStatus

The status of a worker classification (e.g. IR35) on a hire, from initial questionnaire through to acceptance.

Values
`INCOMPLETE` No answers filled yet
`SUBMITTED` Answers submitted, awaiting classification
`PENDING_ACCEPTANCE` Classification created, awaiting acceptance
`ACCEPTED` Accepted and finalized

ClassificationType

Determination

Values
`IR35` Ir35
`UK_SOLE_TRADER_CLASSIFICATION` Uk sole trader classification
`US_WORKER_CLASSIFICATION` Us worker classification
`GLOBAL_WORKER_CLASSIFICATION` Global worker classification
`NL_WORKER_CLASSIFICATION` Nl worker classification

ClassificationUsage

Indicates whether a hire uses Worksome Classify or not, and if the classification has been overridden.

Values
`NOT_USING` The hire does not use Worksome Classify.
`USING` The hire uses Worksome Classify.
`USING_WITH_OVERRIDE` The hire uses Worksome Classify and the classification result has been overridden.

ComplianceActorTypes

The actor needed to complete a compliance.

Values
`WORKER` Worker
`COMPANY` Company
`RECRUITER` Recruiter
`WORKSOME` Worksome

ComplianceName

Compliance name identifier.

Values
`ADDRESS` Address compliance
`BANK_ACCOUNT` Bank account compliance
`BACKGROUND_CHECKS` Background checks compliance
`COMMON_BUSINESS_ENTITY` Deprecated Common business entity compliance
`COMPANY_COMMON_BUSINESS_ENTITY` Company common business entity compliance
`FREELANCER_COMMON_BUSINESS_ENTITY` Freelancer common business entity compliance
`RECRUITER_COMMON_BUSINESS_ENTITY` Recruiter common business entity compliance
`COMPANY_ADDRESS` Company address compliance
`COMPANY_AU_BUSINESS_ENTITY` Australian company business entity compliance
`COMPANY_CA_BUSINESS_ENTITY` Canadian company business entity compliance
`COMPANY_DE_BUSINESS_ENTITY` German company business entity compliance
`COMPANY_NL_BUSINESS_ENTITY` Dutch company business entity compliance
`COMPANY_SG_BUSINESS_ENTITY` Singapore company business entity compliance
`COMPANY_US_BUSINESS_ENTITY` US company business entity compliance
`CONTRACT_CHANGES` Contract changes compliance
`CONTRACT_DOC` Contract document compliance
`EMPLOYMENT_COST` Employment cost compliance
`FREELANCER_AU_BUSINESS_ENTITY` Australian freelancer business entity compliance
`FREELANCER_CA_BUSINESS_ENTITY` Canadian freelancer business entity compliance
`FREELANCER_DE_BUSINESS_ENTITY` German freelancer business entity compliance
`FREELANCER_DK_BUSINESS_ENTITY` Danish freelancer business entity compliance
`FREELANCER_FR_BUSINESS_ENTITY` French freelancer business entity compliance
`FREELANCER_IE_BUSINESS_ENTITY` Irish freelancer business entity compliance
`FREELANCER_NL_BUSINESS_ENTITY` Dutch freelancer business entity compliance
`FREELANCER_SG_BUSINESS_ENTITY` Singapore freelancer business entity compliance
`FREELANCER_UK_BUSINESS_ENTITY` UK freelancer business entity compliance
`FREELANCER_US_BUSINESS_ENTITY` US freelancer business entity compliance
`FLSA` FLSA compliance
`FULL_NAME` Full name compliance
`GATE_HIRE_ACCEPT` Hire acceptance gate compliance
`GATE_HIRE_CREATE_BILL` Hire create bill gate compliance
`GATE_HIRE_OFFER` Hire offer gate compliance
`GATE_HIRE_PROGRESS` Hire progress gate compliance
`GLOBAL_CONTRACT_TYPE` Global contract type compliance
`GLOBAL_CONTRACT_TYPE_HIRE` Global contract type hire compliance
`IR35` IR35 compliance
`IR35_COMPANY_SETTINGS` IR35 company settings compliance
`ONSITE_PRESENCE` Onsite presence compliance
`PAYE_ACCEPT` PAYE accept compliance
`RECRUITER_US_BUSINESS_ENTITY` US recruiter business entity compliance
`RECRUITER_NL_BUSINESS_ENTITY` Netherlands recruiter business entity compliance
`UK_CONTRACT_TYPE` UK contract type compliance
`UK_CONTRACT_TYPE_SOLE_TRADER` UK contract type sole trader compliance
`UK_PAYE_EMPLOYMENT` UK PAYE employment compliance
`UK_PAYE_REQUIRED_CONTRACT_DATES` UK PAYE required contract dates compliance
`UK_PAYROLL` UK payroll compliance
`UK_PAYROLL_CONTRACT_PERIOD` UK payroll contract period compliance
`UK_SOLE_TRADER` UK sole trader compliance
`UK_SOLE_TRADER_CLASSIFICATION` UK sole trader classification compliance
`UK_STATEMENT_OF_WORK` UK statement of work compliance
`UK_TAX` UK tax compliance
`US_CONTRACT_TYPE` US contract type compliance
`US_TAX` US tax compliance
`US_WORKER_CLASSIFICATION` US worker classification compliance
`US_WORKER_LOCATION` US worker location compliance
`US_W2_RETROACTIVE_START_DATE` US W-2 retroactive start date compliance
`UK_VALID_CONTRACT_SETUP` UK valid contract setup compliance
`W2_HIRE` W2 hire compliance
`GLOBAL_WORKER_CLASSIFICATION` Global worker classification compliance
`NL_CONTRACT_TYPE` NL contract type compliance
`NL_WORKER_CLASSIFICATION` NL worker classification compliance
`VALID_VAT` Valid VAT compliance
`EMPLOYER_OF_RECORD` Employer of record
`WCR_ACCEPTANCE` WCR acceptance
`CONTRACT_START_AND_END_DATE` Contract end date
`PAYROLL_CURRENCY` Payroll currency compliance
`SO_W_CONFIRMATION` Statement of Work confirmation compliance
`NL_WAADI_REGISTRATION` NL WAADI registration compliance for staffing agencies
`NL_SNA_CERTIFICATION` NL SNA quality mark certification for staffing agencies
`BUSINESS_ENTITY_TYPE_VALIDITY` Business entity type validity compliance
`BUSINESS_ENTITY_TYPE_UPDATE` Business entity type update compliance (dashboard alert)

ContactStatus

The status of a contact.

Values
`INVITED` Contact was invited.
`ACTIVE` Contact is active.
`DECLINED` Contact was declined.
`APPLIED` Contact applied.
`BLOCKED` Contact application was blocked.

ContactStatusFilter

The status for filtering contacts.

Values
`AVAILABLE` The status is either INVITED or ACTIVE.
`UNAVAILABLE` The status is not INVITED or ACTIVE.

ContractStatus

The lifecycle status of a contract within a hire — draft, active, or archived.

Values
`DRAFT` Draft
`ACTIVE` Active
`ARCHIVED` Archived

ContractTerminationReason

The reasons for terminating an active contract with a worker.

Values
`WORKER_UNAVAILABILITY` The worker is no longer able to fulfil the contract.
`PROJECT_COMPLETED_EARLY` The project was finished ahead of schedule.
`MUTUAL_AGREEMENT_TO_TERMINATE` Both the client and the worker agree to end the contract.
`BUDGET_CONSTRAINTS` Financial limitations necessitate ending the contract early.
`CHANGE_IN_PROJECT_SCOPE` Significant alterations in project requirements or objectives.
`PERFORMANCE_ISSUES` The work delivered does not meet expected standards.
`COMMUNICATION_ISSUES` Challenges in effective communication between parties.
`PERSONAL_REASONS` Personal circumstances affecting the Worker’s ability to work.
`LEGAL_OR_COMPLIANCE_ISSUES` Legal matters or compliance regulations require termination.
`VIOLATION_OF_CONTRACT_TERMS` Breach of agreed-upon terms by one of the parties.
`UNFORESEEN_CIRCUMSTANCES` Events beyond control, such as natural disasters or emergencies.
`DISSATISFACTION_WITH_QUALITY_OF_WORK` The quality of work is not satisfactory to the client.
`CONFLICT_OF_INTEREST` A conflict has arisen that affects the working relationship.
`OTHER` Any reason not covered above.

ContractType

The engagement model of a contract, which determines payment method and compliance requirements (e.g. PSC Contractor, PAYE, Statement of Work).

Values
`CONTRACT_TYPE_CONTRACTOR` PSC
`CONTRACT_TYPE_SOW` SoW
`CONTRACT_TYPE_FT` PAYE
`CONTRACT_TYPE_SOLE_TRADER` Sole Trader
`CONTRACT_TYPE_W_2` W2
`CONTRACT_TYPE_UNKNOWN` Unknown
`CONTRACT_TYPE_UNDETERMINED` Undetermined
`CONTRACT_TYPE_DEFAULT` Default
`CONTRACT_TYPE_WORKSOME_CLASSIFY` Classify
`CONTRACT_TYPE_GLOBAL_PAYROLL` Payroll
`CONTRACT_TYPE_NL_PAYROLL` NL Payroll

CountryCode

An ISO 3166-1 alpha-2 country code

Values
`AD` Andorra
`AE` United Arab Emirates
`AF` Afghanistan
`AG` Antigua & Barbuda
`AI` Anguilla
`AL` Albania
`AM` Armenia
`AO` Angola
`AQ` Antarctica
`AR` Argentina
`AS` American Samoa
`AT` Austria
`AU` Australia
`AW` Aruba
`AX` Åland Islands
`AZ` Azerbaijan
`BA` Bosnia & Herzegovina
`BB` Barbados
`BD` Bangladesh
`BE` Belgium
`BF` Burkina Faso
`BG` Bulgaria
`BH` Bahrain
`BI` Burundi
`BJ` Benin
`BL` St. Barthélemy
`BM` Bermuda
`BN` Brunei
`BO` Bolivia
`BQ` Caribbean Netherlands
`BR` Brazil
`BS` Bahamas
`BT` Bhutan
`BV` Bouvet Island
`BW` Botswana
`BY` Belarus
`BZ` Belize
`CA` Canada
`CC` Cocos (Keeling) Islands
`CD` Congo - Kinshasa
`CF` Central African Republic
`CG` Congo - Brazzaville
`CH` Switzerland
`CI` Côte d’Ivoire
`CK` Cook Islands
`CL` Chile
`CM` Cameroon
`CN` China
`CO` Colombia
`CR` Costa Rica
`CU` Cuba
`CV` Cape Verde
`CW` Curaçao
`CX` Christmas Island
`CY` Cyprus
`CZ` Czechia
`DE` Germany
`DJ` Djibouti
`DK` Denmark
`DM` Dominica
`DO` Dominican Republic
`DZ` Algeria
`EC` Ecuador
`EE` Estonia
`EG` Egypt
`EH` Western Sahara
`ER` Eritrea
`ES` Spain
`ET` Ethiopia
`FI` Finland
`FJ` Fiji
`FK` Falkland Islands
`FM` Micronesia
`FO` Faroe Islands
`FR` France
`GA` Gabon
`GB` United Kingdom
`GD` Grenada
`GE` Georgia
`GF` French Guiana
`GG` Guernsey
`GH` Ghana
`GI` Gibraltar
`GL` Greenland
`GM` Gambia
`GN` Guinea
`GP` Guadeloupe
`GQ` Equatorial Guinea
`GR` Greece
`GS` South Georgia & South Sandwich Islands
`GT` Guatemala
`GU` Guam
`GW` Guinea-Bissau
`GY` Guyana
`HK` Hong Kong SAR China
`HM` Heard & McDonald Islands
`HN` Honduras
`HR` Croatia
`HT` Haiti
`HU` Hungary
`ID` Indonesia
`IE` Ireland
`IL` Israel
`IM` Isle of Man
`IN` India
`IO` British Indian Ocean Territory
`IQ` Iraq
`IR` Iran
`IS` Iceland
`IT` Italy
`JE` Jersey
`JM` Jamaica
`JO` Jordan
`JP` Japan
`KE` Kenya
`KG` Kyrgyzstan
`KH` Cambodia
`KI` Kiribati
`KM` Comoros
`KN` St. Kitts & Nevis
`KP` North Korea
`KR` South Korea
`KW` Kuwait
`KY` Cayman Islands
`KZ` Kazakhstan
`LA` Laos
`LB` Lebanon
`LC` St. Lucia
`LI` Liechtenstein
`LK` Sri Lanka
`LR` Liberia
`LS` Lesotho
`LT` Lithuania
`LU` Luxembourg
`LV` Latvia
`LY` Libya
`MA` Morocco
`MC` Monaco
`MD` Moldova
`ME` Montenegro
`MF` St. Martin
`MG` Madagascar
`MH` Marshall Islands
`MK` North Macedonia
`ML` Mali
`MM` Myanmar (Burma)
`MN` Mongolia
`MO` Macao SAR China
`MP` Northern Mariana Islands
`MQ` Martinique
`MR` Mauritania
`MS` Montserrat
`MT` Malta
`MU` Mauritius
`MV` Maldives
`MW` Malawi
`MX` Mexico
`MY` Malaysia
`MZ` Mozambique
`NA` Namibia
`NC` New Caledonia
`NE` Niger
`NF` Norfolk Island
`NG` Nigeria
`NI` Nicaragua
`NL` Netherlands
`NO` Norway
`NP` Nepal
`NR` Nauru
`NU` Niue
`NZ` New Zealand
`OM` Oman
`PA` Panama
`PE` Peru
`PF` French Polynesia
`PG` Papua New Guinea
`PH` Philippines
`PK` Pakistan
`PL` Poland
`PM` St. Pierre & Miquelon
`PN` Pitcairn Islands
`PR` Puerto Rico
`PS` Palestinian Territories
`PT` Portugal
`PW` Palau
`PY` Paraguay
`QA` Qatar
`RE` Réunion
`RO` Romania
`RS` Serbia
`RU` Russia
`RW` Rwanda
`SA` Saudi Arabia
`SB` Solomon Islands
`SC` Seychelles
`SD` Sudan
`SE` Sweden
`SG` Singapore
`SH` St. Helena
`SI` Slovenia
`SJ` Svalbard & Jan Mayen
`SK` Slovakia
`SL` Sierra Leone
`SM` San Marino
`SN` Senegal
`SO` Somalia
`SR` Suriname
`SS` South Sudan
`ST` São Tomé & Príncipe
`SV` El Salvador
`SX` Sint Maarten
`SY` Syria
`SZ` Eswatini
`TC` Turks & Caicos Islands
`TD` Chad
`TF` French Southern Territories
`TG` Togo
`TH` Thailand
`TJ` Tajikistan
`TK` Tokelau
`TL` Timor-Leste
`TM` Turkmenistan
`TN` Tunisia
`TO` Tonga
`TR` Türkiye
`TT` Trinidad & Tobago
`TV` Tuvalu
`TW` Taiwan
`TZ` Tanzania
`UA` Ukraine
`UG` Uganda
`UM` U.S. Outlying Islands
`US` United States
`UY` Uruguay
`UZ` Uzbekistan
`VA` Vatican City
`VC` St. Vincent & Grenadines
`VE` Venezuela
`VG` British Virgin Islands
`VI` U.S. Virgin Islands
`VN` Vietnam
`VU` Vanuatu
`WF` Wallis & Futuna
`WS` Samoa
`YE` Yemen
`YT` Mayotte
`ZA` South Africa
`ZM` Zambia
`ZW` Zimbabwe

Currency

Values
`CAD` CAD
`DKK` DKK
`EUR` EUR
`GBP` GBP
`NOK` NOK
`SEK` SEK
`USD` USD
`AED` AED
`SGD` SGD
`AUD` AUD

CustomFieldType

A custom fields type.

Values
`SINGLE_SELECT` Single Select input field. Used to collect value from single select dropdown.
`FREE_TEXT` Free Text input field. This can be used to receive any text value

CustomFieldValidationRules

Enum of available validation rules applicable to CustomFields

Values
`REQUIRED` Indicated that a CustomField is obligated to have a value when applied to a supporting entity
`NULLABLE` Indicated that a CustomField is not obligated to have a value

CustomFieldVisibility

The visibility of a custom field — whether it is only visible to the company or also editable by the worker.

Values
`INTERNAL` Custom field with this visibility will only be seen internally by the company.
`WORKER` Custom field with this visibility will be available to the worker for input.

EmployerRecordStatus

The status of the employer record setup for a payroll employment, tracking whether required information has been provided.

Values
`INCOMPLETE` Incomplete
`CHANGES_REQUESTED` Changes requested
`PROCESSING` Processing
`COMPLETE` Complete

EmploymentCostCategory

The category grouping for an employment cost on a payroll engagement.

Values
`GENERAL` General

EmploymentCostFrequency

How often an employment cost is applied — ongoing (every pay period) or as a one-time charge.

Values
`ONGOING` Ongoing
`ONE_TIME` One time

EmploymentCostType

How an employment cost is calculated — as a percentage of the worker’s pay or as a fixed amount.

Values
`PERCENTAGE` Percentage
`FIXED` Fixed

EmploymentOrderByColumn

The columns that the employments list can be ordered by.

Values
`START_DATE` The hire start date
`END_DATE` The hire end date
`WORKER_NAME` The worker name
`COMPANY_NAME` The company that created the hire
`JOB_NAME` The hire job name

EmploymentStatus

The lifecycle status of a payroll employment record associated with a hire.

Values
`DRAFT` Draft
`ACTIVE` Active
`ENDED` Ended

EngagementType

How a worker is engaged on a hire — as a contractor (direct payment), on payroll, via an external arrangement, or pending classification.

Values
`PAYROLL` The engagement is payroll.
`CONTRACTOR` The engagement is a contractor.
`EXTERNAL` The engagement is managed via an external source.
`PENDING` The associated hire is awaiting an engagement type selection or classification result.

EngagementTypeSetup

The specific setup type of an engagement type.

Values
`W2` The engagement is W-2.
`PAYE` The engagement is PAYE.
`INSIDE_IR35` The engagement is Inside IR35.
`GLOBAL_PAYROLL` The engagement is Global Payroll.
`W2_CLASSIFY` The engagement is W-2 (via Worksome Classify).
`PAYE_CLASSIFY` The engagement is PAYE (via Worksome Classify).
`INSIDE_IR35_CLASSIFY` The engagement is Inside IR35 (via Worksome Classify).
`GLOBAL_EMPLOYEE_CLASSIFY` The engagement is Global Employee (via Worksome Classify).
`IC1099` The engagement is 1099.
`OUTSIDE_IR35` The engagement is Outside IR35.
`SOLE_TRADER` The engagement is Sole Trader.
`STATEMENT_OF_WORK` The engagement is Statement of Work.
`DEFAULT` The engagement is Default.
`IC1099_CLASSIFY` The engagement is 1099 (via Worksome Classify).
`OUTSIDE_IR35_CLASSIFY` The engagement is Outside IR35 (via Worksome Classify).
`SOLE_TRADER_CLASSIFY` The engagement is Sole Trader (via Worksome Classify).
`GLOBAL_CONTRACTOR_CLASSIFY` The engagement is Global Contractor (via Worksome Classify).
`UMBRELLA` The worker is engaged via an umbrella company.
`STAFFING_AGENCY` The associated hire is managed via a staffing agency.
`PENDING` The engagement type setup is pending.

EvaluationPeriod

The evaluation period selection indicates how quickly a company expects to evaluate candidates and reply to bids on their job posts.

Values
`MONTH` Monthly
`WEEK` Weekly
`QUICK` Quickly and ongoing

ExpectedExperienceLevel

Expected experience level of the worker.

Values
`STUDENT` Student
`JUNIOR` Junior
`SENIOR` Senior
`EXPERT` Expert

ExperienceLevel

Experience level

Values
`NONE` None
`STUDENT` Student
`NEW` New
`ONE_TO_FOUR` One to four
`FIVE_TO_NINE` Five to nine
`TEN_TO_FOURTEEN` Ten to fourteen
`FIFTEEN_TO_TWENTY_FOUR` Fifteen to twenty four
`TWENTY_FIVE_PLUS` Twenty five plus
`SENIOR` Senior

ExportResponseStatus

The status of the export.

Values
`SUCCESS` The export was successful.
`ERROR` The export experienced one or more errors.

Fluency

The fluency of a language.

Values
`GOOD` Good.
`FLUENT` Fluent.

GeneratorType

The types of export that can be generated.

Values
`CSV` Comma-separated values (CSV).

HireActiveStatus

The lifecycle status of a hire, from initial creation through completion or early termination. Draft: created but not yet offered, may be pending approval. Offered: awaiting worker acceptance. Ready: accepted but start date not yet reached. Active: engagement in progress. Ended: concluded naturally or job removed. Cancelled: cancelled before becoming active (includes approval rejections). Terminated: ended early by the company with a termination reason.

Values
`DRAFT` Draft
`OFFERED` Offered
`READY` Ready
`ACTIVE` Active
`ENDED` Ended
`CANCELLED` Cancelled
`TERMINATED` Terminated

HireOrderByColumn

The columns that the hires list can be ordered by.

Values
`START_DATE` The hire start date
`END_DATE` The hire end date
`COMPANY_NAME` The company that created the hire
`WORKER_NAME` The worker name
`JOB_NAME` The hire job name
`HIRE_ID` The hire id
`CREATED_AT` The hire created at date
`ENGAGEMENT_TYPE` The hire engagement type

InsuranceType

The type of insurance for a worker.

Values
`GENERAL_LIABILITY` General liability insurance
`UMBRELLA_INSURANCE` Umbrella insurance
`PROFESSIONAL_INDEMNITY` Professional indemnity insurance
`WORKERS_COMPENSATION` Workers compensation insurance

InvoiceStatus

The payment status of an invoice issued to a company.

Values
`PAID` Invoice has been paid.
`UNPAID` Invoice has not been paid.
`OVERDUE` Invoice has not been paid and is overdue.
`CREDITED` Invoice has been credited.

InvoiceTransactionType

The transaction type of an invoice to use.

Values
`INVOICE` Invoice
`CREDIT_NOTE` Credit Note
`BATCH_INVOICE` Batch Invoice

InvoicesOrderByColumn

The columns that invoices can be ordered by.

Values
`DATE` The date the invoice was created.
`DUE_DATE` The due date.
`NUMBER` The invoice number.
`TOTAL_AMOUNT` The net total.

JobCandidateHiringStep

An enum representing the step a JobCandidate is at in the hiring process

Values
`SHORTLISTED` A JobCandidate in the shortlisted (they have been added as a candidate) hiring step
`INVITED_TO_APPLY` A JobCandidate in the invited to apply (the job has been shared with them) hiring step
`APPLIED` A JobCandidate in the applied (they have submitted an offer) hiring step
`HIRING` A JobCandidate in the (they have a hire for the job) hiring step

JobCandidateOrderByColumn

The columns that the job candidates list can be ordered by.

Values
`WORKER_NAME` The name of the worker.
`HIRING_STEP` The job candidate hiring step
`UPDATED_AT` The job candidate updated at timestamp

JobCandidateStatus

A job candidate may be in several statuses depending on decision taken during hiring process.

Values
`ELIGIBLE` Indicates a job candidate still eligible for a Job.
`NON_ELIGIBLE` Indicates a job candidate not being eligible for the Job anymore.
`DUPLICATE` Indicates a job candidate which was submitted while already being submitted by someone else.

JobCandidateStatusReason

Specific reason for having made a JobCandidate non-eligible to be a candidate anymore

Values
`SKILLS_OR_EXPERIENCE` Skills or experience
`SPECIFIC_JOB_CRITERIA` Specific job criteria
`AVAILABILITY` Availability
`MARKET_ELIGIBILITY` Market eligibility
`BUDGET` Budget
`ACCEPTED_OTHER_JOB` Accepted other job
`OTHER_CANDIDATE_ACCEPTED` Other candidate accepted
`ADDED_BY_MISTAKE` Added by mistake
`EXISTING_APPLICATION_THROUGH_OTHER_CHANNELS` Existing application through other channels

JobEndTimeframe

The expected duration or end date of a job engagement.

Values
`ONE_MONTH` 1 month
`THREE_MONTHS` Three months
`SIX_MONTHS` Six months
`ON_DATE` On date
`OPEN` Open

JobOrderByColumn

The columns that the jobs list can be ordered by.

Values
`CREATED_AT` The job created at
`EXPECTED_START_DATE` The expected start date
`PUBLISHED_DATE` The published date
`CANDIDATES` Order by the number of candidates on the job.

JobShareOrderByColumn

The columns that the job shares list can be ordered by.

Values
`CREATED_AT` The date and time that the job share was created.

JobStartTimeframe

When the company expects the job engagement to start.

Values
`ASAP` As soon as possible (ASAP)
`NEXT_MONTH` Next month
`ON_DATE` On Date

JobStatus

The lifecycle status of a job posting. Draft jobs are not yet published — use updateJob to complete details and publish. Active jobs are visible and accepting bids. Completed jobs have been closed after filling or manually. Removed jobs were discarded before any hires.

Values
`DRAFT` Draft
`ACTIVE` Active
`COMPLETED` Completed
`REMOVED` Removed

JobVisibility

Who can see a job posting — trusted contacts in the Talent Pool, staffing agencies, or all workers on the marketplace.

Values
`VISIBLE_FOR_TRUSTED_CONTACTS` The job is visible to trusted contacts.
`VISIBLE_FOR_RECRUITERS` The job is visible to recruiters.
`VISIBLE_FOR_MARKETPLACE` The job is visible on the marketplace.

LanguageName

The name of a language.

Values
`ARABIC` Arabic
`ENGLISH` English
`FRENCH` French
`SPANISH` Spanish
`GERMAN` German
`ITALIAN` Italian
`DANISH` Danish
`SWEDISH` Swedish
`NORWEGIAN` Norwegian
`FINNISH` Finnish
`DUTCH` Dutch
`RUSSIAN` Russian
`LITHUANIAN` Lithuanian
`GREEK` Greek
`POLISH` Polish
`PORTUGUESE` Portuguese
`CHINESE_MANDARIN` Chinese (Mandarin)

LegacyTimesheetType

The format of a timesheet submission — structured sheet, uploaded file, free-text entry, or standard timesheet.

Values
`FILE` File
`SHEET` Sheet
`TEXT` Text
`TIMESHEET` Timesheet

Locale

A locale identifier.

Values
`ENGLISH` English.
`DANISH` Danish.
`FRENCH` French.
`GERMAN` German.
`DUTCH` Dutch.

LocationPreference

The location preference.

Values
`ONSITE_ONLY` Onsite
`ONSITE_SOME` Hybrid
`REMOTE_ONLY` Remote

MarketCode

The market code.

Values
`US` Us
`UK` Uk
`IE` Ie
`EU` Eu
`CA` Ca
`FR` Fr
`DE` De
`DK` Dk
`NO` No
`SE` Se
`FI` Fi
`LT` Lt
`UAE` Uae
`SG` Sg
`AU` Au
`NL` Nl
`WW` Ww

MilestoneStatus

The status of a deliverable-based milestone, tracking whether payment has been requested and completed.

Values
`PENDING` Milestone is pending completion.
`PAYMENT_REQUESTED` Payment has been requested for the milestone.
`COMPLETED` Milestone has been completed.

MultiFactorChannel

No description

Values
`EMAIL` No description
`SMS` No description
`TOTP` No description

MultiFactorStatus

No description

Values
`APPROVED` No description
`PENDING` No description
`CANCELLED` No description
`FAILED` No description

OrderByRelationAggregateFunction

Aggregate functions when ordering by a relation without specifying a column.

Values
`COUNT` Amount of items.

OrderByRelationWithColumnAggregateFunction

Aggregate functions when ordering by a relation that may specify a column.

Values
`AVG` Average.
`MIN` Minimum.
`MAX` Maximum.
`SUM` Sum.
`COUNT` Amount of items.

OvertimeType

The overtime calculation period — daily, weekly, or based on sixth/seventh consecutive working days.

Values
`DAILY` Daily
`WEEKLY` Weekly
`SIXTH_DAY` Sixth Day
`SEVENTH_DAY` Seventh Day

PaymentRequestOrderByColumn

The columns that the payment requests list can be ordered by.

Values
`ISSUED_AT` The date and time that the payment request was submitted
`PRIORITY` Pending requests first, then by issued date
`WORKER` The name of the worker associated with the payment request
`TOTAL_AMOUNT` The total amount of the payment request

PaymentRequestStatus

The approval status of a payment request from the company’s perspective.

Values
`APPROVED` Approved
`CANCELLED` Cancelled
`UNAPPROVED` Unapproved
`REJECTED` Rejected

PaymentRequestType

The basis for a payment request — time-based (hours/days), a fixed amount, or expenses.

Values
`TIME` Time based payment request.
`AMOUNT` Amount based payment requests.
`EXPENSES` Expenses added to a payment request.

PaymentRequestWorkerPayoutStatus

The worker payout status for a payment request, as seen by the company.

Values
`PAID` The worker has been paid.
`PREPAID` The worker has been prepaid (paid in advance).
`DUE` The payment is due but not yet overdue.
`OVERDUE` The payment is overdue.
`UNPAID` The payment request has not been paid yet.

PaymentRequestWorkerStatus

The status of a payment request as seen by the worker who submitted it.

Values
`DRAFT` Draft
`REJECTED` Rejected
`CANCELLED` Cancelled
`PROCESSING` Processing
`COMPLETED` Completed
`REQUESTED` Requested
`APPROVED` Approved

PaymentScheme

The payment scheme.

Values
`ANY` Any
`COMPANY` Company
`GLOBAL_PAYROLL` Global payroll
`UK_PAYE` Uk paye
`UK_PAYE_IR35` Uk paye ir35
`US_PAYROLL` Us payroll
`US_PAYROLL_WS` Us payroll ws
`DK_PAYROLL` Dk payroll
`DK_B_INCOME` Dk b income
`AU_PAYROLL` Au payroll
`PARTNER_EOR` Partner eor

PaymentTermDays

The different days supported as payment terms.

Values
`EIGHT` Indicates an eight day payment term.
`FOURTEEN` Indicates an fourteen day payment term.
`THIRTY` Indicates an thirty day payment term.
`FORTY_FIVE` Indicates an forty five day payment term.
`FIFTY_THREE` Indicates an fifty three day payment term.
`SIXTY` Indicates an sixty day payment term.
`SEVENTY_FIVE` Indicates an seventy five day payment term.
`NINETY` Indicates an ninety day payment term.

PaymentTermMethod

The method of payment over a specified term.

Values
`END_OF_MONTH` End of the month.
`NET` Net.

ProjectStatusFilter

The status for filtering projects.

Values
`OPEN` Project is open.
`ENDED` Project has been ended.

RateType

The billing frequency for a hire or payment request — hourly, daily, weekly, monthly, or a fixed amount.

Values
`HOURLY` Hourly
`DAILY` Daily
`WEEKLY` Weekly
`MONTHLY` Monthly
`FIXED` Fixed
`UNKNOWN` Unknown

RecruiterOrderByColumn

The columns that the recruiters list can be ordered by.

Values
`RECRUITER_NAME` The name of the recruiter.
`RECRUITER_MARKET` The market the recruiter is on.
`RECRUITER_FEE` The recruiter fee.
`RECRUITER_OWNERSHIP_DAYS` The recruiter ownership days.
`RECRUITER_STATUS` The recruiter invite status.

RecruiterStatus

Status for recruiter invites.

Values
`ACTIVE` Recruiter active status.
`INVITED` Recruiter invited status.

SkillOrderByColumn

The columns that the skills list can be ordered by.

Values
`NAME` The skill name localized to current user local.

SkillableType

The types that the skills can be applied to.

Values
`WORKER` Skills applying to Workers
`TRUSTED_CONTACT` Skills applying to TrustedContacts
`JOB` Skills applying to Jobs

SortOrder

Directions for ordering a list of records.

Values
`ASC` Sort records in ascending order.
`DESC` Sort records in descending order.

SourcingChannel

A job candidate sourcing channel origin.

Values
`TRUSTED_CONTACT` A job candidate originated from trusted contact.
`CANDIDATE_SUBMISSION` A job candidate originated from recruiter candidate submission.
`RECRUITER_ATTRIBUTION` A job candidate originated from recruiter attribution.
`MARKETPLACE` A job candidate originated from Marketplace.

TimesheetRegistrationDurationUnit

The unit of a duration for a timesheet registration.

Values
`HOURS` Hours.
`DAYS` Days.

TimesheetRegistrationType

The type of an individual entry within a timesheet — a full day, a break period, or a line item.

Values
`DAY` Day.
`BREAK` Break.
`LINE` Line.

Trashed

Specify if you want to include or exclude trashed results from a query.

Values
`ONLY` Only return trashed results.
`WITH` Return both trashed and non-trashed results.
`WITHOUT` Only return non-trashed results.

TrustedContactHireHistory

The options representing the hire history of a Trusted contact

Values
`PREVIOUSLY_HIRED` The contact has been previously hired by the company
`NOT_PREVIOUSLY_HIRED` The contact has never been hired by the company

TrustedContactHireStatus

The options representing the hire status of a Trusted contact

Values
`CURRENTLY_HIRED` The contact is currently hired in one of the given companies
`NOT_CURRENTLY_HIRED` The contact is not currently hired in one of the given companies

TrustedContactManagedStatus

Who currently manages a trusted contact’s profile — the worker themselves, a staffing agency, or no one (unmanaged).

Values
`STAFFING_AGENCY` The Trusted Contact profile is currently managed by a staffing agency.
`WORKER` The Trusted Contact profile is managed by the worker themselves.
`UNMANAGED` A Staffing Agency’s ownership of the Trusted Contact has expired and the profile is not yet claimed by the worker.

TrustedContactOnboardingStatus

The onboarding status of a trusted contact.

Values
`PENDING` Trusted contact has pending onboarding requirements (documents or custom fields).
`COMPLETED` Trusted contact onboarding is completed.

TrustedContactOrderByColumn

The columns that the trusted contacts list can be ordered by.

Values
`WORKER_NAME` The name of the worker.
`WORKER_JOBS_COUNT` The number of jobs taken by the worker with the viewing company.
`WORKER_MARKET` The market the worker is on.
`WORKER_COUNTRY` The country the worker is in.
`WORKER_BUSINESS_SETUP` The business setup of the worker.
`WORKER_COMPANY_NAME` The name of the company the worker belongs to.
`WORKER_DATE_ADDED` The point in time the relationship was created
`WORKER_STATUS_UPDATED` The last time the relationship status was updated
`WORKER_RTW_VERIFICATION` Sort by the right to work verification status on the worker.

TrustedContactOrigin

The origin of the Trusted contact

Values
`INVITED` The contact was invited by the company
`ADDED` The contact was automatically added

TrustedContactOriginChannel

The channel the trusted contact arrived from

Values
`EXISTING_SETUP` Existing setup.
`DIRECT_INVITE` Invited directly by the company
`PERSONAL_INVITE` Invited through a personal invite link
`CANDIDATE_SUBMISSION` Added through recruiter submission or Staffing agency hire
`MARKETPLACE_HIRE` Added after hire from marketplace
`EXTERNAL_LINK` Signed up through invite link
`ORGANISATION_HIRE` Added after hired through Organisation Talent pool

TrustedContactStaffingAgencyStatus

The staffing agency assignment status for a worker.

Values
`HAS_OWNERSHIP` A staffing agency has ownership of the worker.
`NO_OWNERSHIP` A staffing agency does not have ownership of the worker.

TypeSupportingCustomFieldValues

A type that can have an custom field applied to it.

Values
`JOB` A Job
`CONTRACT` A Contract
`TRUSTED_CONTACT` A Trusted Contact
`PAYMENT_REQUEST` A Payment request
`COMPANY_RECRUITER` A Company Recruiter relationship

UserGroupStatus

The status of a user group used in approval workflows — active groups can be assigned as approvers.

Values
`ACTIVE` Active
`INACTIVE` Inactive
`ARCHIVED` Archived

WcrSupersedeType

Sds supersede type

Values
`DISPUTE` Dispute
`OVERRIDE` Override

WebhookEventType

The types of events that can trigger a webhook.

Values
`CONTRACT_ACCEPTED` Triggered when a contract is accepted by a worker.
`HIRE_ENDED` Triggered when a hire ends.
`HIRE_ACCEPTED` Triggered when a hire is accepted.
`HIRE_CANCELLED` Triggered when a hire is cancelled.
`HIRE_UPDATED` Triggered when a hire is updated.
`TRUSTED_CONTACT_UPDATED` Triggered when a trusted contact is updated.
`HIRE_TERMINATED` Triggered when a hire is terminated.
`PAYMENT_REQUEST_ISSUED` Triggered when a payment request is issued.
`PAYMENT_REQUEST_APPROVED` Triggered when a payment request is approved.
`PAYMENT_REQUEST_REJECTED` Triggered when a payment request is rejected.
`PAYMENT_REQUEST_PAID` Triggered when a payment request is paid by the company.
`PAYMENT_REQUEST_CANCELLED` Triggered when a payment request is cancelled.
`PAYMENT_REQUEST_WORKER_PAID_OUT` Triggered when a worker has been paid out for a payment request.
`PAYMENT_REQUEST_RECRUITER_PAID_OUT` Triggered when a recruiter has been paid out for a payment request.
`INVOICE_CREATED` Triggered when an invoice is created.
`INVOICE_PAID` Triggered when an invoice is paid.
`CREDIT_NOTE_CREATED` Triggered when a credit note is created.

WorkflowVariableOperator

This enum defines operators for use with approval rules.

Should be used as VariableValue WorkflowVariableOperator RuleValue

Values
`LESS` Variable value is less than rule value
`GREATER` Variable value is greater than rule value
`LESS_OR_EQUALS` Variable value is less than or equals rule value
`GREATER_OR_EQUALS` Variable value is greater than or equals rule value
`EQUALS` Variable value equals rule value
`NOT_EQUALS` Variable value does not equal rule value
`CONTAINS` Variable value contains rule value
`DOES_NOT_CONTAIN` Variable value does not contain rule value
`CHANGED` Variable value changed