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 |
COMPANY |
RECRUITER |
ORGANISATION |
PARTNER |
AiChatContext
The contexts that the AI chat can be used in.
| Values |
|---|
HIRE |
DIALOG |
AiJobDescriptionContext
The job description context types
| Values |
|---|
JOB_POST |
DIRECT_HIRE |
ApprovalApprovableOrderByColumn
The columns that the approvables list can be ordered by.
| Values |
|---|
CREATED_AT |
ApprovalApprovableState
Status for approval states.
| Values |
|---|
UNKNOWN |
REQUESTED |
APPROVED |
REJECTED |
NEEDS_CHANGE |
CANCELLED |
ApprovalStatus
Status for approvals.
| Values |
|---|
ACTIVE |
INACTIVE |
ARCHIVED |
ApprovalTrigger
Trigger types for approvals.
| Values |
|---|
NONE |
HIRE_CREATED |
HIRE_CHANGED |
CLASSIFICATION_CREATED |
Association
The estimated commitment of a job.
| Values |
|---|
SMALL_TASK |
PROJECT |
BIG_PROJECT |
PART_TIME |
FULL_TIME |
BatchActionType
The action to run on a batch.
| Values |
|---|
PROCESS |
EXPORT |
UNDO |
BatchItemStatus
The status of an item in a batch.
| Values |
|---|
PROCESSING |
PROCESSED |
BatchType
The type of a batch.
| Values |
|---|
PARTNER_PAYMENT_REQUESTS |
BidStatus
The status of a bid.
| Values |
|---|
OPEN |
ACCEPTED |
REJECTED |
CANCELLED |
BusinessEntityType
Business Entity Type
| Values |
|---|
COMMON |
NO_SETUP |
PERSONAL |
AU_LTD |
AU_SOLE_TRADER |
DE_FREELANCER |
DE_TRADESPERSON |
DE_ENTREPRENEURIAL |
DE_LTD |
B_INCOME |
FR_LTD |
FR_SOLE_TRADER |
IE_LTD |
IE_SOLE_TRADER |
SG_LTD |
SG_SOLE_TRADER |
LTD |
SOLE_TRADER |
UMBRELLA |
Channel
No description
| Values |
|---|
EMAIL |
SMS |
TOTP |
ClassificationResult
Determination result
| Values |
|---|
EMPLOYEE |
LIKELY_EMPLOYEE Deprecated |
UNKNOWN |
LIKELY_INDEPENDENT Deprecated |
INDEPENDENT |
ClassificationStatus
Classification status
| Values |
|---|
INCOMPLETE |
SUBMITTED |
PENDING_ACCEPTANCE |
ACCEPTED |
ClassificationType
Determination
| Values |
|---|
IR35 |
UK_SOLE_TRADER_CLASSIFICATION |
US_WORKER_CLASSIFICATION |
GLOBAL_WORKER_CLASSIFICATION |
ComplianceActorTypes
The actor needed to complete a compliance.
| Values |
|---|
WORKER |
COMPANY |
RECRUITER |
WORKSOME |
ComplianceName
Compliance name identifier.
| Values |
|---|
ADDRESS |
BANK_ACCOUNT |
BACKGROUND_CHECKS |
COMMON_BUSINESS_ENTITY Deprecated |
COMPANY_COMMON_BUSINESS_ENTITY |
FREELANCER_COMMON_BUSINESS_ENTITY |
RECRUITER_COMMON_BUSINESS_ENTITY |
COMPANY_ADDRESS |
COMPANY_AU_BUSINESS_ENTITY |
COMPANY_CA_BUSINESS_ENTITY |
COMPANY_DE_BUSINESS_ENTITY |
COMPANY_SG_BUSINESS_ENTITY |
COMPANY_US_BUSINESS_ENTITY |
CONTRACT_CHANGES |
CONTRACT_DOC |
EMPLOYMENT_COST |
FREELANCER_AU_BUSINESS_ENTITY |
FREELANCER_CA_BUSINESS_ENTITY |
FREELANCER_DE_BUSINESS_ENTITY |
FREELANCER_DK_BUSINESS_ENTITY |
FREELANCER_FR_BUSINESS_ENTITY |
FREELANCER_IE_BUSINESS_ENTITY |
FREELANCER_SG_BUSINESS_ENTITY |
FREELANCER_UK_BUSINESS_ENTITY |
FREELANCER_US_BUSINESS_ENTITY |
FLSA |
FULL_NAME |
GATE_HIRE_ACCEPT |
GATE_HIRE_CREATE_BILL |
GATE_HIRE_OFFER |
GATE_HIRE_PROGRESS |
GLOBAL_CONTRACT_TYPE |
GLOBAL_CONTRACT_TYPE_HIRE |
IR35 |
IR35_COMPANY_SETTINGS |
ONSITE_PRESENCE |
PAYE_ACCEPT |
RECRUITER_US_BUSINESS_ENTITY |
UK_CONTRACT_TYPE |
UK_CONTRACT_TYPE_SOLE_TRADER |
UK_PAYE_EMPLOYMENT |
UK_PAYE_REQUIRED_CONTRACT_DATES |
UK_PAYROLL |
UK_PAYROLL_CONTRACT_PERIOD |
UK_SOLE_TRADER |
UK_SOLE_TRADER_CLASSIFICATION |
UK_STATEMENT_OF_WORK |
UK_TAX |
US_CONTRACT_TYPE |
US_TAX |
US_WORKER_CLASSIFICATION |
US_WORKER_LOCATION |
UK_VALID_CONTRACT_SETUP |
W2_HIRE |
GLOBAL_WORKER_CLASSIFICATION |
VALID_VAT |
EMPLOYER_OF_RECORD |
WCR_ACCEPTANCE |
CONTRACT_START_AND_END_DATE |
ContactStatus
The status of a contact.
| Values |
|---|
INVITED |
ACTIVE |
DECLINED |
APPLIED |
BLOCKED |
ContactStatusFilter
The status for filtering contacts.
| Values |
|---|
AVAILABLE |
UNAVAILABLE |
ContractStatus
The status of a contract.
| Values |
|---|
DRAFT |
ACTIVE |
ARCHIVED |
ContractTerminationReason
The reasons for terminating an active contract with a worker.
| Values |
|---|
WORKER_UNAVAILABILITY |
PROJECT_COMPLETED_EARLY |
MUTUAL_AGREEMENT_TO_TERMINATE |
BUDGET_CONSTRAINTS |
CHANGE_IN_PROJECT_SCOPE |
PERFORMANCE_ISSUES |
COMMUNICATION_ISSUES |
PERSONAL_REASONS |
LEGAL_OR_COMPLIANCE_ISSUES |
VIOLATION_OF_CONTRACT_TERMS |
UNFORESEEN_CIRCUMSTANCES |
DISSATISFACTION_WITH_QUALITY_OF_WORK |
CONFLICT_OF_INTEREST |
OTHER |
ContractType
The type of a contract.
| Values |
|---|
CONTRACT_TYPE_CONTRACTOR |
CONTRACT_TYPE_SOW |
CONTRACT_TYPE_FT |
CONTRACT_TYPE_SOLE_TRADER |
CONTRACT_TYPE_W_2 |
CONTRACT_TYPE_UNKNOWN |
CONTRACT_TYPE_UNDETERMINED |
CONTRACT_TYPE_DEFAULT |
CONTRACT_TYPE_WORKSOME_CLASSIFY |
CONTRACT_TYPE_GLOBAL_PAYROLL |
Currency
Currency
| Values |
|---|
CAD |
DKK |
EUR |
GBP |
NOK |
SEK |
USD |
AED |
SGD |
AUD |
CustomFieldType
A custom fields type.
| Values |
|---|
SINGLE_SELECT |
FREE_TEXT |
CustomFieldValidationRules
Enum of available validation rules applicable to CustomFields
| Values |
|---|
REQUIRED |
NULLABLE |
CustomFieldVisibility
Define the different values available for Custom field visibility field.
| Values |
|---|
INTERNAL |
WORKER |
EmployerRecordStatus
@implements IsStatusDeterminable<Employment>
| Values |
|---|
INCOMPLETE |
CHANGES_REQUESTED |
PROCESSING |
COMPLETE |
EmploymentCostCategory
The category of an employment cost.
| Values |
|---|
GENERAL |
EmploymentCostFrequency
The frequency of an employment cost.
| Values |
|---|
ONGOING |
ONE_TIME |
EmploymentCostType
The type of an employment cost.
| Values |
|---|
PERCENTAGE |
FIXED |
EmploymentOrderByColumn
The columns that the employments list can be ordered by.
| Values |
|---|
START_DATE |
END_DATE |
WORKER_NAME |
COMPANY_NAME |
JOB_NAME |
EmploymentStatus
@implements IsStatusDeterminable<Employment>
| Values |
|---|
DRAFT |
ACTIVE |
ENDED |
EvaluationPeriod
The evaluation period selection indicates how quickly a company expects to evaluate candidates and reply to bids on their job posts.
| Values |
|---|
MONTH |
WEEK |
QUICK |
ExpectedExperienceLevel
Expected experience level of the worker.
| Values |
|---|
STUDENT |
JUNIOR |
SENIOR |
EXPERT |
ExperienceLevel
Experience level
| Values |
|---|
NONE |
STUDENT |
NEW |
ONE_TO_FOUR |
FIVE_TO_NINE |
TEN_TO_FOURTEEN |
FIFTEEN_TO_TWENTY_FOUR |
TWENTY_FIVE_PLUS |
SENIOR |
ExportResponseStatus
The status of the export.
| Values |
|---|
SUCCESS |
ERROR |
Fluency
The fluency of a language.
| Values |
|---|
GOOD |
FLUENT |
GeneratorType
The types of export that can be generated.
| Values |
|---|
CSV |
HireActiveStatus
Hire activity status
| Values |
|---|
DRAFT |
OFFERED |
READY |
ACTIVE |
ENDED |
CANCELLED |
TERMINATED |
HireOrderByColumn
The columns that the hires list can be ordered by.
| Values |
|---|
START_DATE |
END_DATE |
COMPANY_NAME |
WORKER_NAME |
JOB_NAME |
HIRE_ID |
CREATED_AT |
InvoiceStatus
The status of an invoice.
| Values |
|---|
PAID |
UNPAID |
OVERDUE |
CREDITED |
InvoiceTransactionType
The transaction type of an invoice to use.
| Values |
|---|
INVOICE |
CREDIT_NOTE |
BATCH_INVOICE |
InvoicesOrderByColumn
The columns that invoices can be ordered by.
| Values |
|---|
DATE |
DUE_DATE |
NUMBER |
TOTAL_AMOUNT |
JobCandidateHiringStep
An enum representing the step a JobCandidate is at in the hiring process
| Values |
|---|
SHORTLISTED |
INVITED_TO_APPLY |
APPLIED |
HIRING |
JobCandidateOrderByColumn
The columns that the job candidates list can be ordered by.
| Values |
|---|
WORKER_NAME |
HIRING_STEP |
UPDATED_AT |
JobCandidateStatus
A job candidate may be in several statuses depending on decision taken during hiring process.
| Values |
|---|
ELIGIBLE |
NON_ELIGIBLE |
DUPLICATE |
JobCandidateStatusReason
Specific reason for having made a JobCandidate non-eligible to be a candidate anymore
| Values |
|---|
SKILLS_OR_EXPERIENCE |
SPECIFIC_JOB_CRITERIA |
AVAILABILITY |
MARKET_ELIGIBILITY |
BUDGET |
ACCEPTED_OTHER_JOB |
OTHER_CANDIDATE_ACCEPTED |
ADDED_BY_MISTAKE |
EXISTING_APPLICATION_THROUGH_OTHER_CHANNELS |
JobEndTimeframe
This class defines the different levels of time frames for job end.
| Values |
|---|
ONE_MONTH |
THREE_MONTHS |
SIX_MONTHS |
ON_DATE |
OPEN |
JobOrderByColumn
The columns that the jobs list can be ordered by.
| Values |
|---|
CREATED_AT |
EXPECTED_START_DATE |
PUBLISHED_DATE |
CANDIDATES |
JobShareOrderByColumn
The columns that the job shares list can be ordered by.
| Values |
|---|
CREATED_AT |
JobStartTimeframe
This class defines the different levels of time frames for job start.
| Values |
|---|
ASAP |
NEXT_MONTH |
ON_DATE |
JobStatus
Job status
| Values |
|---|
DRAFT |
ACTIVE |
COMPLETED |
REMOVED |
JobVisibility
The visibility of a job.
| Values |
|---|
VISIBLE_FOR_TRUSTED_CONTACTS |
VISIBLE_FOR_RECRUITERS |
VISIBLE_FOR_MARKETPLACE |
LanguageName
The name of a language.
| Values |
|---|
ARABIC |
ENGLISH |
FRENCH |
SPANISH |
GERMAN |
ITALIAN |
DANISH |
SWEDISH |
NORWEGIAN |
FINNISH |
DUTCH |
RUSSIAN |
LITHUANIAN |
GREEK |
POLISH |
PORTUGUESE |
CHINESE_MANDARIN |
LegacyTimesheetType
The type of a timesheet.
| Values |
|---|
FILE |
SHEET |
TEXT |
TIMESHEET |
Locale
A locale identifier.
| Values |
|---|
ENGLISH |
DANISH |
FRENCH |
GERMAN |
LocationPreference
The location preference.
| Values |
|---|
ONSITE_ONLY |
ONSITE_SOME |
REMOTE_ONLY |
MarketCode
The market code.
| Values |
|---|
US |
UK |
IE |
EU |
CA |
FR |
DE |
DK |
NO |
SE |
FI |
LT |
UAE |
SG |
AU |
WW |
MilestoneStatus
Milestone status.
| Values |
|---|
PENDING |
PAYMENT_REQUESTED |
COMPLETED |
OrderByRelationAggregateFunction
Aggregate functions when ordering by a relation without specifying a column.
| Values |
|---|
COUNT |
OrderByRelationWithColumnAggregateFunction
Aggregate functions when ordering by a relation that may specify a column.
| Values |
|---|
AVG |
MIN |
MAX |
SUM |
COUNT |
OvertimeType
The type for an overtime entry.
| Values |
|---|
DAILY |
WEEKLY |
SIXTH_DAY |
SEVENTH_DAY |
PaymentRequestOrderByColumn
The columns that the payment requests list can be ordered by.
| Values |
|---|
ISSUED_AT |
PaymentRequestStatus
Status for a payment request from the client perspective.
| Values |
|---|
APPROVED |
CANCELLED |
UNAPPROVED |
PaymentRequestWorkerStatus
Status for a payment request from the worker perspective.
| Values |
|---|
DRAFT |
REJECTED |
CANCELLED |
PROCESSING |
COMPLETED |
REQUESTED |
APPROVED |
PaymentScheme
The payment scheme.
| Values |
|---|
ANY |
COMPANY |
GLOBAL_PAYROLL |
UK_PAYE |
UK_PAYE_IR35 |
US_PAYROLL |
US_PAYROLL_WS |
DK_PAYROLL |
DK_B_INCOME |
AU_PAYROLL |
PARTNER_EOR |
PaymentTermDays
The different days supported as payment terms.
| Values |
|---|
EIGHT |
FOURTEEN |
THIRTY |
FORTY_FIVE |
FIFTY_THREE |
SIXTY |
SEVENTY_FIVE |
NINETY |
PaymentTermMethod
The method of payment over a specified term.
| Values |
|---|
END_OF_MONTH |
NET |
ProjectStatusFilter
The status for filtering projects.
| Values |
|---|
OPEN |
ENDED |
RateType
The rate type for payments.
| Values |
|---|
HOURLY |
DAILY |
WEEKLY |
MONTHLY |
FIXED |
UNKNOWN |
RecruiterOrderByColumn
The columns that the recruiters list can be ordered by.
| Values |
|---|
RECRUITER_NAME |
RECRUITER_MARKET |
RECRUITER_FEE |
RECRUITER_OWNERSHIP_DAYS |
RECRUITER_STATUS |
RecruiterStatus
Status for recruiter invites.
| Values |
|---|
ACTIVE |
INVITED |
SkillOrderByColumn
The columns that the skills list can be ordered by.
| Values |
|---|
NAME |
SkillableType
The types that the skills can be applied to.
| Values |
|---|
WORKER |
TRUSTED_CONTACT |
JOB |
SortOrder
Directions for ordering a list of records.
| Values |
|---|
ASC |
DESC |
SourcingChannel
A job candidate sourcing channel origin.
| Values |
|---|
TRUSTED_CONTACT |
CANDIDATE_SUBMISSION |
RECRUITER_ATTRIBUTION |
MARKETPLACE |
Status
No description
| Values |
|---|
APPROVED |
PENDING |
CANCELLED |
FAILED |
TimesheetRegistrationDurationUnit
The unit of a duration for a timesheet registration.
| Values |
|---|
HOURS |
DAYS |
TimesheetRegistrationType
The type of a timesheet registration.
| Values |
|---|
DAY |
BREAK |
LINE |
Trashed
Specify if you want to include or exclude trashed results from a query.
| Values |
|---|
ONLY |
WITH |
WITHOUT |
TrustedContactHireHistory
The options representing the hire history of a Trusted contact
| Values |
|---|
PREVIOUSLY_HIRED |
NOT_PREVIOUSLY_HIRED |
TrustedContactHireStatus
The options representing the hire status of a Trusted contact
| Values |
|---|
CURRENTLY_HIRED |
NOT_CURRENTLY_HIRED |
TrustedContactManagedStatus
Trusted Contact managed status.
| Values |
|---|
STAFFING_AGENCY |
WORKER |
UNMANAGED |
TrustedContactOnboardingStatus
The onboarding status of a trusted contact.
| Values |
|---|
PENDING |
COMPLETED |
TrustedContactOrderByColumn
The columns that the trusted contacts list can be ordered by.
| Values |
|---|
WORKER_NAME |
WORKER_JOBS_COUNT |
WORKER_MARKET |
WORKER_COUNTRY |
WORKER_BUSINESS_SETUP |
WORKER_COMPANY_NAME |
WORKER_DATE_ADDED |
WORKER_STATUS_UPDATED |
WORKER_RTW_VERIFICATION |
TrustedContactOrigin
The origin of the Trusted contact
| Values |
|---|
INVITED |
ADDED |
TrustedContactOriginChannel
The channel the trusted contact arrived from
| Values |
|---|
EXISTING_SETUP |
DIRECT_INVITE |
CANDIDATE_SUBMISSION |
MARKETPLACE_HIRE |
EXTERNAL_LINK |
ORGANISATION_HIRE |
TrustedContactStaffingAgencyStatus
The staffing agency assignment status for a worker.
| Values |
|---|
HAS_OWNERSHIP |
NO_OWNERSHIP |
TypeSupportingCustomFieldValues
A type that can have an custom field applied to it.
| Values |
|---|
JOB |
CONTRACT |
TRUSTED_CONTACT |
PAYMENT_REQUEST |
UserGroupStatus
Status for user groups.
| Values |
|---|
ACTIVE |
INACTIVE |
ARCHIVED |
WcrSupersedeType
Sds supersede type
| Values |
|---|
DISPUTE |
OVERRIDE |
WorkflowVariableOperator
This enum defines operators for use with approval rules.
Should be used as VariableValue WorkflowVariableOperator RuleValue
| Values |
|---|
LESS |
GREATER |
LESS_OR_EQUALS |
GREATER_OR_EQUALS |
EQUALS |
NOT_EQUALS |
CONTAINS |
DOES_NOT_CONTAIN |
CHANGED |