Unions
Union types define that a returned type may be one of many other types.
Approvable
The types of items that can require approval. Currently only hires go through approval workflows.
| Possible Types |
|---|
Hire |
BatchItem
An item in a batch.
| Possible Types |
|---|
PaymentRequest |
ComplianceData
Union of typed data a compliance can emit. Compose atomic ComplianceDataField entries for simple label/value rows, wrap them in a titled ComplianceDataGroup when multiple semantically-distinct groups belong to the same compliance, and reach for domain-reference variants (ComplianceDataBusinessEntity, ComplianceDataAddress, ComplianceDataUser, ComplianceDataBankDetail) when the frontend should be able to query a first-class domain type directly. ComplianceDataClassification is the specialised Q&A shape for determination compliances (IR35, NL/Global/US worker classification).
| Possible Types |
|---|
ComplianceDataField |
ComplianceDataGroup |
ComplianceDataFile |
ComplianceDataBusinessEntity |
ComplianceDataAddress |
ComplianceDataUser |
ComplianceDataBankDetail |
ComplianceDataClassification |
JobShareableAccount
Accounts that a job can be shared with.
| Possible Types |
|---|
Worker |
Recruiter |
Company |
MultiFactor
A multi-factor instance.
| Possible Types |
|---|
SmsMultiFactor |
TotpMultiFactor |
Nodeable
The types of nodes that can appear in a workflow tree. Currently only approval rules.
| Possible Types |
|---|
ApprovalRule |
Notable
Union of types which can include notes.
| Possible Types |
|---|
Job |
TrustedContact |
CompanyRecruiter |
SupportsCustomFieldValue
Union of types which custom field values may be applied to.
This is closely coupled to the TypeSupportingCustomFieldValues enum.
| Possible Types |
|---|
Job |
Contract |
TrustedContact |
CompanyRecruiter |