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.

ApprovalApprovableState

Status for approval states.

Values
`UNKNOWN` Approval state unknown status.
`REQUESTED` Approval state requested status.
`APPROVED` Approval state approved status.
`REJECTED` Approval state rejected status.
`NEEDS_CHANGE` Approval state needs change status.
`CANCELLED` Approval state cancelled status.

ApprovalStatus

Status for approvals.

Values
`ACTIVE` Approval active/live status.
`INACTIVE` Approval inactive status.
`ARCHIVED` Approval archived status.

ApprovalTrigger

Trigger types for approvals.

Values
`NONE` Nothing triggers.
`HIRE_CREATED` Hire was created.
`HIRE_CHANGED` Hire was updated, representing a contract change.
`CLASSIFICATION_CREATED` Classification was created.

Association

The association of a project.

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

BidStatus

The status of a bid.

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

BusinessEntityType

Business entity type

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 ltd
`B_INCOME` B income
`FR_LTD` Fr ltd
`FR_SOLE_TRADER` Fr sole trader
`IE_LTD` Ie ltd
`IE_SOLE_TRADER` Ie sole trader
`SG_LTD` Sg ltd
`SG_SOLE_TRADER` Sg sole trader
`LTD` Ltd
`SOLE_TRADER` Sole trader
`UMBRELLA` Umbrella

Channel

No description

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

ClassificationResult

Determination result

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

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 status of a contract.

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

ContractType

The type of a contract.

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

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

Define the different values available for Custom field visibility field

Values
`INTERNAL` Custom field with this visibility will only be seen internally bv the company

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 freelancer.

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

Export response status

Values
`SUCCESS` Success
`ERROR` Error

Fluency

The fluency of a language.

Values
`GOOD` Good.
`FLUENT` Fluent.

GeneratorType

Generator type

Values
`CSV` Csv

HireOrderByColumn

The columns that the hires list can be ordered by

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

HireStatus

Status for filtering hires.

Values
`DRAFT` Draft hire status.
`ACTIVE` Active hire status.
`COMPLETED` Completed hire status.

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.

InvoiceStatus

The status of an invoice.

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

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

This class defines the different levels of time frames for job end.

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

JobStartTimeframe

This class defines the different levels of time frames for job start.

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

JobVisibility

The visibility of a job.

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 type of a timesheet.

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

Locale

A locale identifier.

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

LocationPreference

The location preference.

Values
`ONSITE_ONLY` Onsite only
`ONSITE_SOME` Onsite some
`REMOTE_ONLY` Remote only

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
`WW` Ww

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 type for an overtime entry.

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

PaymentRequestStatus

Status for a payment request from the client perspective.

Values
`APPROVED` Approved status.
`CANCELLED` Cancelled status.
`UNAPPROVED` Unapproved status.

PaymentRequestWorkerStatus

Status for a payment request from the worker perspective.

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

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

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 rate type for payments.

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.

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

SkillOrderByColumn

The columns that the skills list can be ordered by.

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

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.

Status

No description

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

TimesheetRegistrationDurationUnit

The unit of a duration for a timesheet registration.

Values
`HOURS` Hours.
`DAYS` Days.

TimesheetRegistrationType

The type of a timesheet registration.

Values
`DAY` Day.
`BREAK` Break.
`PROJECT` Project.

TimesheetSource

The source for a timesheet.

Values
`TIMESHEET` The timesheet was created via Worksome.
`API` The timesheet was created via an API integration.

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

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
`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

TypeSupportingCustomFieldValues

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

Values
`JOB` A Job
`CONTRACT` A Contract
`TRUSTED_CONTACT` A Trusted Contact

UserGroupStatus

Status for user groups.

Values
`ACTIVE` User group active status.
`INACTIVE` User group inactive status.
`ARCHIVED` User group archived status.

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
`CHANGED` Variable value changed