Enums
Enumeration Types (or Enums) are scalars that restrict 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. |
BLOCKED Item has been processed but is blocked, so it needs attention. |
BatchType
The type of items grouped in a batch for bulk processing.
| Values |
PARTNER_PAYMENT_REQUESTS Partner payment requests batch. |
INVOICES_FOR_INTEGRATIONS_SERVICE Invoices batch for processing by the Integrations Service. |
CUSTOMER_INVOICES Customer invoices exported to an accounting system. |
SELF_BILL_JOURNAL Self-bill journal entries exported to an accounting system. |
ACCRUALS_JOURNAL Accruals journal entries exported to an accounting system. |
PAYMENT_JOURNAL Journal entries for self-bills that have reached a payment file. |
TIMESHEET_IMPORT Timesheets uploaded together in one timesheet import. |
BidOrderByColumn
The columns that the bids list can be ordered by.
| Values |
CREATED_AT The date and time that the bid was created. |
STATUS The status of the bid. |
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 |
NL_GENERAL_PARTNERSHIP NL: General Partnership |
NL_PROFESSIONAL_PARTNERSHIP NL: Professional Partnership |
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 |
CandidateSubmissionType
Describes how a supplier relates to the candidate submitted in a pitch.
| Values |
MANAGED The supplier directly manages the candidate. |
REFERRED The supplier is referring an independent candidate they do not manage. |
ChecklistCheckState
Experimental. Where a check on a checklist stands.
| Values |
PENDING Still to be confirmed or marked not applicable. |
CONFIRMED Someone looked at the evidence and confirmed the check. |
NOT_APPLICABLE Someone judged that the check does not apply here, and gave a reason. |
ChecklistStatus
Experimental. Whether the checks on a checklist are done.
| Values |
COMPLETE Every check has been confirmed or marked not applicable. |
BLOCKED A check that blocks progress is still pending. |
OPEN Checks are still pending, but none of them block progress. |
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. |
ClientRelationAgencyOwnerOrderByColumn
The columns the people staffing agencies assign to a client can be ordered by.
| Values |
NAME The name of the person. |
ASSIGNED_AT When the person was assigned. |
STAFFING_AGENCY The name of the staffing agency the person works for. |
ClientRelationOwnerOrderByColumn
The columns a supplier’s own team on a client can be ordered by.
| Values |
NAME The name of the person. |
ASSIGNED_AT When the person was assigned. |
ClientRelationTeamOrderByColumn
The columns a client company’s team can be ordered by.
| Values |
NAME The name of the person. |
ACCOUNT_ROLE The account owner before the members. |
CompanyClientOrderByColumn
The columns that a supplier’s client list can be ordered by.
| Values |
CLIENT_NAME The name of the client company. |
CLIENT_LOCATION The client’s market, then its region by name. |
CLIENT_SINCE The date the client relationship was established. |
HIRES The number of hires the supplier has at the client. |
LINKED_STAFFING_AGENCIES The number of staffing agencies the supplier linked to the client. |
CompanyNumberValidationStatus
The outcome of an external validation check (e.g. KvK, VAT/VIES).
| Values |
PENDING Validation has not been attempted yet. |
VALID The external authority confirmed the number is valid. |
INVALID The external authority confirmed the number is not registered. |
NOT_VERIFIED Validation was attempted but the external authority was unavailable or returned an error. |
CompanyOrderByColumn
The columns that a list of companies can be ordered by.
| Values |
COMPANY_NAME The name of the company. |
CompanyTeamRole
Whether a person on a company team owns the company account or is a member of it.
| Values |
OWNER Owner |
MEMBER Member |
ComplianceActorTypes
The actor needed to complete a compliance.
| Values |
WORKER Worker |
COMPANY Company |
RECRUITER Recruiter |
WORKSOME Worksome |
ComplianceClassificationAnswer
Answer outcomes for a classification question.
| Values |
YES The worker answered the question affirmatively. |
NO The worker answered the question negatively. |
UNKNOWN The worker did not know, or chose not to answer. |
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 |
RECRUITER_DE_BUSINESS_ENTITY German 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_INSURANCE NL insurance 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 |
CHECKLISTS Experimental. Checklists compliance |
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 |
NL_KVK_REGISTRATION NL KvK (Chamber of Commerce) registration for staffing agencies |
NL_BTW_IDENTIFICATION NL BTW (VAT) identification for staffing agencies |
BUSINESS_ENTITY_TYPE_VALIDITY Business entity type validity compliance |
BUSINESS_ENTITY_TYPE_UPDATE Business entity type update compliance (dashboard alert) |
NL_G_ACCOUNT NL G-Account (Geblokkeerde Rekening) for staffing agency tax liability reserves |
NL_BSN NL BSN (Burgerservicenummer) for workers in the Netherlands |
FREELANCER_NL_KVK_CERTIFICATE NL KvK certificate upload compliance for freelancers |
RECRUITER_NL_KVK_CERTIFICATE NL KvK certificate upload compliance for staffing agencies |
NL_SUPPLIER_EMPLOYMENT_CONFIRMATION NL supplier employment confirmation for staffing agencies |
NL_SUPPLIER_EMPLOYMENT_CONFIRMATION_REVIEW Client review of NL supplier employment confirmation |
VERIFIED_WORKER_COMPLIANCE Verified worker compliance — company verification of a worker |
WORKER_ONBOARDING Worker onboarding — review of onboarding documents and required custom fields |
IDENTIFICATION Required identification details |
HIRE_WORKER_CUSTOM_FIELDS_BEFORE_OFFER Required hire custom fields the worker answers before the hire is offered |
HIRE_WORKER_CUSTOM_FIELDS_BEFORE_ACCEPTANCE Required hire custom fields the worker answers before accepting the contract |
VERIFIED_RECRUITER_COMPLIANCE Verified staffing-agency compliance — company verification of a staffing agency |
RECRUITER_ONBOARDING Staffing-agency onboarding — review of onboarding documents and required custom fields |
CLIENT_ONBOARDING Client onboarding — whether any of the account’s clients still needs onboarding completed |
DETERMINATION_SUPPLIER_HIRE_CLIENT_INPUT End client input for supplier-managed worker classification |
DETERMINATION_HIRE_FREELANCER_INPUT Worker input for the classification questions about their own hire |
DETERMINATION_SUPPLIER_HIRE_AWAITING_CLIENT Supplier awaiting end client classification input |
SUPPLIER_HIRE_PREPARED Downstream supplier-mirror hire is out of draft and prepared by the staffing agency |
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. |
ContractDocType
The type of contract document.
| Values |
KID Key Information Document. |
GENERIC Generic contract document. |
ONBOARDING Worker onboarding document. |
STAFFING_AGENCY_ONBOARDING Staffing agency onboarding document. |
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 Island & 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, Ascension & Tristan da Cunha |
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 and Antarctic Lands |
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
A currency code as defined by ISO 4217.
| Values |
AED United Arab Emirates Dirham |
AUD Australian Dollar |
CAD Canadian Dollar |
DKK Danish Krone |
EUR Euro |
GBP Great British Pound |
NOK Norwegian Krone |
SEK Swedish Krona |
SGD Singapore Dollar |
USD United States Dollar |
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 |
MULTI_SELECT Multi Select input field. Used to collect values from multi select dropdown. |
FILE_UPLOAD File Upload input field. Used to attach an uploaded file as the field value. |
DATE Date input field. Used to collect a single calendar date. |
BOOLEAN Boolean input field. Used to collect a yes or no answer. |
CustomFieldUsage
Something that depends on a custom field or one of its options, and so stops it being removed.
| Values |
RATE_CARD_LINES The option is used by a rate card, so it cannot be removed. |
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 hidden from the worker or editable by them.
| Values |
INTERNAL Custom field with this visibility will not be seen by the worker. |
WORKER Custom field with this visibility will be available to the worker for input. |
CustomFieldWorkerInputStage
When the worker, or the staffing agency managing them, must answer a hire custom field.
| Values |
BEFORE_OFFER The worker answers while the hire is a draft, before the company can offer it. |
BEFORE_ACCEPTANCE The worker answers before they can accept the contract. |
CustomTimesheetFileRejectionReason
The reason Worksome refused a whole timesheet file, so that none of its rows was checked or written.
| Values |
HEADER_MISMATCH The header row does not match the columns of your current timesheet import template. |
UNREADABLE_FILE The file could not be read as a CSV file: it is empty, has no header row, is not UTF-8 or holds the replacement character U+FFFD, is not separated by commas or semicolons, or has a line break inside a cell. |
TOO_MANY_ROWS The file has more data rows than one import accepts. |
FILE_TOO_LARGE The file is larger than one import accepts. |
CustomTimesheetRejectionReason
The reason a timesheet registration was rejected by Worksome.
| Values |
MISSING_REQUIRED_FIELD One or more required fields were missing or had the wrong type. |
HIRE_NOT_FOUND The hireId did not resolve to a hire the authenticated account can submit timesheets for. |
DATE_OUTSIDE_CONTRACT_PERIOD The reportedDate falls outside the hire’s contract start/end dates. |
DUPLICATE_ROW Another row in the same submission has the same hire and reportedDate, or the same hire, externalId and reportedDate. Every copy is rejected. |
HOURS_ALREADY_REGISTERED The hire already has hours registered on the reportedDate, and this import only adds hours. |
LIVE_PAYMENT_REQUEST_IN_WEEK The hire already has a live payment request in the week of the reportedDate, and this import only adds hours. |
OTHER_ROW_IN_WEEK_REJECTED Another row for the same hire and week was rejected, so no row of that week is written. |
NO_HIRE_IDENTIFIER The CSV row fills in none of its hire identifier columns. |
MULTIPLE_HIRES_MATCHED A hire identifier on the CSV row matches several hires. The two hires of a mirrored engagement count as one. |
HIRE_IDENTIFIERS_MISMATCH The hire identifiers on the CSV row point to different hires. |
UNREADABLE_LINE A cell of the CSV row could not be read or imported, for example a date that is not YYYY-MM-DD, a payable value that is not yes or no, or a line field value its field cannot take. |
ROAR_WORKER_NOT_IDENTIFIED No worker was found for the row’s CSID. The row is stored without a worker and is never billed. |
ROAR_MULTIPLE_ACTIVE_HIRES The worker has several active hires on the reportedDate. The row is stored without a hire and is never billed. |
CustomTimesheetRowStatus
What happens, or would happen with write set to false, to one submitted timesheet row.
| Values |
ACCEPTED The row is accepted for processing: written, or would be written. On a Roar dry run, the reason says when the row would be stored but never billed, or cannot be processed. |
REJECTED The row is not written. The reason says why. |
DELETED The row removes the hours it reports: a Roar row with the status unsubmitted or rejected, or with Deleted set to true. |
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.
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 employee on 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 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. |
CONTRACTOR_ZZP The engagement is ZZP (Netherlands independent contractor). |
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 Independent Contractor (via Worksome Classify). |
CONTRACTOR_ZZP_CLASSIFY The engagement is ZZP (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 |
MID_LEVEL Mid level |
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. |
FeeApplication
How a fee is applied when calculating or explaining an amount.
| Values |
ADDITIVE The fee is added on top of the base amount. |
CONSTITUENT The fee is a constituent part of an already agreed amount. |
FeeBasis
The basis on which a fee is calculated.
| Values |
PERCENTAGE A percentage of the total amount. |
HOURLY A fixed monetary rate per hour. |
DAILY A fixed monetary rate per day. |
WEEKLY A fixed monetary rate per week. |
MONTHLY A fixed monetary rate per month. |
FeeType
The type of fee being applied.
| Values |
REFERRAL A referral fee paid to a staffing agency for sourcing a worker. |
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 |
UPDATED_AT The date and time that the hire, its contract or its status was last changed. |
ENGAGEMENT_TYPE The hire engagement type |
LAST_PAYMENT_REQUEST_DATE The date the worker last submitted a payment request |
IdentificationDocumentType
The type of identification document a worker has provided for compliance.
| Values |
PASSPORT A government-issued passport. |
NATIONAL_ID_CARD A government-issued national identity card. |
RESIDENCE_PERMIT A residence permit issued by the worker’s country of residence. |
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 |
InvoiceDelivery
Who is emailed the client-side invoices of a mirror-model client relationship
| Values |
MSP Only the MSP (supplier) is emailed |
CLIENT Only the end client is emailed |
BOTH Both the MSP (supplier) and the end client are emailed |
InvoiceOrderByColumn
The columns that the invoices list can be ordered by.
| Values |
CREATED_AT The date that the invoice was created. |
DATE The date that the invoice was issued. |
DUE_DATE The due date of the invoice. |
NUMBER The invoice number. |
TOTAL_AMOUNT The net total of the invoice. |
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 |
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 |
SELECTION_SUBMITTED The supplier has uploaded a candidate. No action has been taken by the MSP yet. |
SELECTION_UNDER_REVIEW The MSP is reviewing the CV and assessing the candidate against the hard requirements of the request. |
SELECTION_SHORTLISTED The MSP has shortlisted the candidate with another runner-up. |
SELECTION_DECLINED_BY_MSP The candidate does not meet the requirements. A reason should be provided (e.g., rate, skills). |
SELECTION_WITHDRAWN The candidate has withdrawn themselves from the process. |
SELECTION_PRESENTED_TO_CLIENT The MSP has approved the candidate and presented them to the client. |
INTERVIEW_SELECTED The client has indicated that they want to speak with the candidate. |
INTERVIEW_SCHEDULED The date and time have been confirmed and recorded in the system. |
INTERVIEW_COMPLETED The interview is completed; we are waiting for feedback from the client or candidate. |
INTERVIEW_WITHDRAWN The candidate or supplier has withdrawn themselves from the process. |
INTERVIEW_SHORTLISTED The MSP is hesitant or is comparing the candidate with another runner-up. |
COMPLETION_REJECTED_BY_CLIENT The client does not choose this candidate after the interview. |
COMPLETION_DECLINED_BY_MSP The MSP decides to not accept candidate anymore. |
COMPLETION_WITHDRAWN The candidate/supplier has withdrawn themselves from the process. |
COMPLETION_OFFER_EXTENDED The client wants the candidate; the contract proposal is with the supplier. |
COMPLETION_CANDIDATE_ONBOARDING The supplier/freelancer is to provide all documents and information. |
COMPLETION_BACKGROUND_CHECK The MSP’s turn to screen all documents and information. |
COMPLETION_HIRED The contract is signed. Recruitment for this request is closed. |
COMPLETION_ON_HOLD Candidates on hold until interviews with other candidates have taken place. |
COMPLETION_TALENTPOOL Link a candidate to a talent pool across organizations. |
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 |
UPDATED_AT The job updated at |
EXPECTED_START_DATE The expected start date |
PUBLISHED_DATE The published date |
CANDIDATES Order by the number of candidates on the job. |
LAST_CANDIDATE_SUBMITTED_AT The date a supplier last submitted a candidate to 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. |
UPDATED_AT The date and time that the job share or its job was last changed. |
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 |
NlSnaStatus
SNA certification status for Dutch staffing agencies. Determines G-Account split percentage.
| Values |
CERTIFIED Agency holds valid SNA quality mark (NEN 4400-1). |
NOT_CERTIFIED Agency does not hold SNA certification. |
NOT_APPLICABLE SNA certification does not apply. |
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 |
OwnerResponsibility
What an owner looks after on a record they own. Carries no permissions: an owner without one is a plain owner.
| Values |
PRIMARY_CONTACT Primary contact |
COMPLIANCE Compliance |
PAYMENTS Payments |
RECRUITMENT Recruitment |
PayItemAssignmentStatus
Whether a pay item is offered on a job or selected on a contract.
| Values |
OFFERED The pay item is offered on a job for a contract to select. |
ACTIVE The pay item is selected and priced on a contract. |
PayItemBasis
How a pay item’s price is worked out.
| Values |
FLAT A fixed amount each time the item is charged. |
PER_UNIT An amount per unit, such as per hour, per shift or per 1,000 words. |
PERCENTAGE A percentage on top of the base pay. |
PayItemRole
What kind of pay a pay item is.
| Values |
BASE_PAY Pay for the work itself. |
PREMIUM Pay on top of the base pay, such as a shift or weekend premium. |
PayItemStatus
Whether a pay item can be used or has been archived.
| Values |
ACTIVE The pay item can be offered and charged. |
ARCHIVED The pay item has been archived. |
PayItemUnit
The unit a per-unit pay item is priced in.
| Values |
HOUR Per hour. |
DAY Per day. |
SHIFT Per shift. |
WEEK Per week. |
MONTH Per month. |
OTHER Per a unit the client names, such as 1,000 words, held in the item’s unit label. |
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. |
PaymentRequestViewerRole
Which side of a payment request the viewer is being asked about.
| Values |
PAYER The viewer is the one paying. |
PAYEE The viewer is the one being paid. |
ANY Either side. |
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. |
TWENTY_ONE Indicates an twenty one 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. |
RateCardComparisonResult
How an entered rate compares to a resolved rate card band.
| Values |
WITHIN_RANGE The rate is within the band. |
ABOVE_MAXIMUM The rate is above the band maximum. |
BELOW_MINIMUM The rate is below the band minimum. |
UNIT_MISMATCH The rate’s unit differs from the band’s, so the two aren’t measurable against each other. |
NO_MATCH Nothing matched a rate card line to compare against. |
RateCardNoMatchReason
Why a vacancy or payment request resolved to no rate card band.
| Values |
NO_RATE_CARD The owner has no rate card in the required currency. |
UNSUPPORTED_RATE_TYPE The rate type is unknown or absent, so no band can apply. |
NO_LINE_IN_FORCE The card has no line in force on the date requested. |
NO_LINE_MATCHED_CRITERIA A line was in force, but none matched the criteria supplied. |
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 |
RecruiterCandidateRelationshipLabel
Rolled-up label describing a staffing agency’s commercial relationship with a candidate.
| Values |
MANAGED Staffing agency fully manages at least one engagement for this worker. |
REFERRAL Staffing agency has at least one referral-fee engagement for this worker, none managed. |
LISTED Worker is on the staffing agency’s candidate list with no engagement yet. |
RecruiterComplianceStatus
The compliance review status of a staffing agency, mirroring the status pill shown on the compliance tracker row.
| Values |
INCOMPLETE The staffing agency hasn’t started or completed all sub-compliances yet. |
READY_TO_REVIEW All sub-compliances are complete and the staffing agency is awaiting review. |
CHANGES_REQUESTED The reviewer requested changes from the staffing agency. |
CLEARED The reviewer has cleared the staffing agency. |
RecruiterOnboardingStatus
The onboarding status of a staffing agency.
| Values |
PENDING Staffing agency has pending onboarding requirements. |
COMPLETED Staffing agency onboarding is completed. |
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. |
RECRUITER_INVITED_AT The date the staffing agency was invited. |
COMPLIANCE_UPDATED_AT The date the staffing-agency compliance was last updated. |
RecruiterReviewDecision
The outcome of a staffing-agency compliance review.
| Values |
CLEARED The reviewer marks the staffing agency’s compliance as cleared. |
CHANGES_REQUESTED The reviewer asks the staffing agency to supply or correct information. A note is delivered to the staffing agency. |
RecruiterStatus
Status for recruiter invites.
| Values |
ACTIVE Recruiter active status. |
INVITED Recruiter invited status. |
RightToWorkDocumentType
A category of right-to-work evidence a worker may be required to provide.
| Values |
IDENTITY_DOCUMENT A passport or national identity document evidencing identity and nationality. |
WORK_PERMIT A permit authorising the holder to work in the jurisdiction. |
RESIDENCE_PERMIT A permit authorising the holder to reside in the jurisdiction. |
WORK_AUTHORIZATION Evidence of authorisation to work, where that is issued separately from a permit. |
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. |
SourcingDeadlineChoice
Tracks a pending choice for a job’s sourcing deadline while it is still unresolved (sourcing_end_date is null and the job is not yet published). Cleared once sourcing_end_date is set, either by resolving “use default” at publish time or by the user picking a custom date directly.
| Values |
USE_DEFAULT Use the company’s configured default number of hours, resolved when the job is published. |
NONE Explicitly no sourcing deadline. |
StaffingAgencyClientOrderByColumn
Experimental. The columns that a staffing agency’s client list can be ordered by.
| Values |
CLIENT_NAME The name of the client company. |
RELATION Direct links first, then the name of the MSP the link goes through. |
CLIENT_SINCE The date the link was created. |
PLACEMENTS The number of the agency’s offered, ready, active, ended, cancelled and terminated hires at the client. |
SupplierClientOrderByColumn
The columns a client’s linked suppliers can be ordered by.
| Values |
SUPPLIER_NAME The name of the supplier. |
LINKED_AT The date the supplier was linked to this client. |
UPDATED_AT The date the link last changed. |
SUPPLIER_SINCE The date the supplier was added as a contracted supplier. |
PLACEMENTS The number of placements the supplier and the client share. |
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 has expired and the worker has not yet claimed the account. |
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 hires the worker has accepted with the trusted contact’s company, or with any company in the organisation for organisation trusted contacts. |
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. |
COMPLIANCE_UPDATED_AT The date the worker compliance was last updated. |
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 |
COMPANY_SUPPLIER A relationship between a client company and one of its suppliers |
EXPENSE An Expense |
HIRE A Hire |
CLASSIFICATION_INPUT The input collected for a worker classification |
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 |
VerifiedWorkerComplianceStatus
The compliance review status of a worker, mirroring the status pill shown on the compliance tracker row.
| Values |
INCOMPLETE The worker hasn’t started or completed all sub-compliances yet. |
READY_TO_REVIEW All sub-compliances are complete and the worker is awaiting review. |
CHANGES_REQUESTED The reviewer requested changes from the worker. |
CLEARED The reviewer has cleared the worker. |
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 Deprecated 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. |
CLASSIFICATION_ACCEPTED Triggered when a worker classification is accepted. |
JOB_SHARED Triggered when a job is shared with a staffing agency. |
JOB_SHARE_REMOVED Triggered when a job share is removed. |
JOB_UPDATED Triggered when the details of a job change. |
JOB_CLOSED Triggered when a job is closed or removed. |
JOB_CANDIDATE_UPDATED Triggered when the step of a job candidate changes. |
Weekday
A day of the week.
| Values |
MONDAY Monday. |
TUESDAY Tuesday. |
WEDNESDAY Wednesday. |
THURSDAY Thursday. |
FRIDAY Friday. |
SATURDAY Saturday. |
SUNDAY Sunday. |
WorkerReviewDecision
The outcome of a worker compliance review.
| Values |
CLEARED The reviewer marks the worker’s compliance as cleared. |
CHANGES_REQUESTED The reviewer asks the worker to supply or correct information. A note is delivered to the worker. |
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 |