Input Objects
Input Objects represent input to a query or mutation.
AcceptBidInput
The input used for hiring.
Fields |
---|
bid ID! |
contactPerson IDIf not supplied, the currently authenticated user will be used. |
billingContactPerson IDIf not supplied, the currently authenticated user will be used. |
startDate DateThis date is used on the draft contract. |
endDate DateThis date is used on the draft contract. |
jobTitle StringIf not filled out, the job title from the job of the bid will be used. This title is used on the draft contract. |
jobDescription StringIf not filled out, the job description from the job of the bid will be used. This title is used on the draft contract. |
paymentTermMethod PaymentTermMethod |
paymentTermDays PaymentTermDays |
purchaseOrderNumber String |
additionalTerms StringThe contract is always subject to the terms and conditions for Worksome’s platform. |
workplaceAddress StringThis will be part of the contract also. The Address should be a full address, with city and postal code. |
customInvoiceText StringThis text will be shown on the top of each invoice once they are created. |
companyName StringIf not set the current company name will be used instead. |
companyAddress StringIf not set the current company address will be used instead. |
companyZipCode StringIf not set the current company zip code will be used instead. |
companyCity StringIf not set the current company city will be used instead. |
companyCountry StringIf not set the current company country will be used instead. |
recruiter RecruiterInput |
closeOtherConversations Boolean |
closingMessage String |
attachments [ID!] |
externalIdentifier String |
ActionApprovalApprovableInput
The input used for creating approval rule fields.
Fields |
---|
id ID! |
status ApprovalStateEnum |
reason String |
ApprovalRuleFieldRuleInput
The input containing the rule value and operator.
Fields |
---|
value String! |
operator String! |
ApproveTrustedContactInput
The details for approving a trusted contact.
Fields |
---|
id ID! |
ArgsInput
An input for additional arguments for the export.
Fields |
---|
companies [Int!]! |
dateFrom Date |
dateTo Date |
meta String |
AttachJobsToProjectInput
The input used for attaching one or more jobs to a project.
Fields |
---|
jobs [ID!]! |
project ID! |
AttachUsersToUserGroupInput
The input used for attaching one or more users to a group.
Fields |
---|
userGroup ID! |
users [ID!] |
BbanInput
The BBAN input details.
Fields |
---|
bsb String |
bankId String |
bankCode String |
branchId String |
branchCode String |
accountNumber String |
accountSuffix String |
institutionNumber String |
transitNumber String |
registrationNumber String |
routingCode String |
sortCode String |
purposeOfPayment String |
ChangeEmailInput
The details required for changing the email.
Fields |
---|
user IDIf this is null or excluded, the currently authenticated user’s email will be changed. |
email String! |
CreateApprovalInput
The input used for creating an approval.
Fields |
---|
name String! |
status ApprovalStatus! |
trigger ApprovalTrigger! |
description String |
company ID! |
CreateApprovalRuleFieldInput
The input used for creating approval rule fields.
Fields |
---|
id ID! |
rule ApprovalRuleFieldRuleInput! |
CreateApprovalRuleInput
The input used for creating approval rules.
Fields |
---|
approval ID! |
fields [CreateApprovalRuleFieldInput!]! |
CreateApproverInput
The input used for creating approvers.
Fields |
---|
approvalRule ID! |
userGroup ID! |
position Int! |
CreateCompanyRecruiterInput
The details for adding and inviting a recruiter.
Fields |
---|
company ID! |
name String! |
email String! |
recruiterFee Float |
recruiterOwnershipDays Int |
message String |
tags [String!] |
externalIdentifier String |
CreateCustomFieldInput
The input for creating a custom field.
Fields |
---|
account ID! |
fieldType CustomFieldType!SINGLE_SELECT |
appliesTo TypeSupportingCustomFieldValues! |
title String! |
slug String |
description String |
settings CustomFieldSettingsInput! |
visibility CustomFieldVisibility!INTERNAL |
approval Boolean |
options [CustomFieldCustomFieldOptionInput!]Only applies to some custom field types (e.g. SINGLE_SELECT ) |
CreateCustomTimesheetInput
An input for creating a custom timesheet.
Fields |
---|
schema String!To obtain information on supported schemas, please reach out to Worksome. |
data String! |
CreateExportInput
An input for creating an export.
Fields |
---|
userId Int! |
impersonatorId Int |
accountId Int! |
accountType String! |
type String! |
generatorType String! |
deliveries [String!]! |
args ArgsInput! |
CreateJobCandidateInput
The details for creating a job candidate.
Fields |
---|
job ID! |
workers [ID!]! |
sourcingChannel SourcingChannel! |
CreateJobInput
An input for creating a new job.
Fields |
---|
company ID! |
name String! |
skills [String!]! |
CreateJobShareInput
An input for creating a job share.
Fields |
---|
job ID! |
accounts [ID!]! |
CreateNoteInput
An input for creating a note.
Fields |
---|
body String! |
title String |
accountId ID! |
notableId ID! |
CreatePasswordInput
The details required for creating a password.
Fields |
---|
password String! |
CreateProjectInput
The input used for projects.
Fields |
---|
name String! |
description String |
internalBudget Float |
company ID! |
owners [ID!] |
externalIdentifier String |
CreateSmsMultiFactorInput
An input for creating a new SMS multi-factor authentication implementation.
Fields |
---|
name String |
CreateTotpMultiFactorInput
An input for creating a new TOTP multi-factor authentication implementation.
Fields |
---|
name String |
CreateTrustedContactInput
The details for adding & inviting a trusted contact.
Fields |
---|
company ID! |
name String! |
email String! |
links [String!]! |
attachments [ID!]! |
skills [String!]! |
message String! |
notifyWorker Boolean!1 |
externalIdentifier String |
CreateUserGroupInput
The input used for groups.
Fields |
---|
name String! |
description String |
company ID! |
users [ID!] |
CreateWorkflowApproverInput
The input used for creating workflow approvers.
Fields |
---|
id ID |
parent ID |
children [ID!] |
data [ID!]! |
CreateWorkflowInput
The input used for creating workflows.
Fields |
---|
root CreateWorkflowRootInput! |
rules [CreateWorkflowRuleInput!] |
approvers [CreateWorkflowApproverInput!] |
CreateWorkflowRootInput
The input used for creating workflow approval.
Fields |
---|
id ID |
children [ID!] |
data CreateApprovalInput! |
CreateWorkflowRuleInput
The input used for creating workflow approval rule.
Fields |
---|
id ID |
parent ID |
children [ID!] |
data [CreateApprovalRuleFieldInput!] |
CustomFieldCustomFieldOptionInput
The settings input for custom fields.
Fields |
---|
option ID |
value String!For example: “title”, “label”, “number” |
displayOrder Int! |
CustomFieldSettingsInput
The settings input for custom fields.
Fields |
---|
validation [CustomFieldValidationRules!] |
CustomFieldTypeValueInput
An input for custom field value and to be filled according to the aimed field type.
All input’s fields are mutually exclusive to each other.
Fields |
---|
singleSelect SingleSelectCustomFieldValueInputSINGLE_SELECT field type. |
freeText FreeTextCustomFieldValueInputFREE_TEXT field type. |
CustomFieldValueInput
An input for a custom field value.
Fields |
---|
appliesTo ID! |
value CustomFieldTypeValueInput |
DateRangeInput
The input used for a date range.
Fields |
---|
from Date |
to Date |
DeleteCompanyRecruiterInput
The details for deleting a recruiter relationship.
Fields |
---|
id ID! |
DeleteCustomFieldInput
The input for the deletion of a custom field.
Fields |
---|
customField ID! |
DeleteNoteInput
An input for deleting a note.
Fields |
---|
id ID! |
DeleteTrustedContactInput
The details for deleting a trusted contact.
Fields |
---|
id ID! |
account ID! |
DetachJobFromProjectInput
The input used for attaching one or more jobs to a project.
Fields |
---|
job ID! |
project ID! |
DetachUsersFromUserGroupInput
The input used for detaching one or more users from a group.
Fields |
---|
userGroup ID! |
users [ID!] |
EndJobInput
An input for ending (aka closing) an existing job.
Fields |
---|
id ID! |
accountId ID! |
ForceLogoutInput
The details required for forcing logout of other sessions.
Fields |
---|
user ID! |
FreeTextCustomFieldValueInput
An input for a free-text custom field.
Fields |
---|
id ID! |
value String! |
GenerateInviteLinkInput
The input used to generate the company invite link token.
Fields |
---|
company ID! |
HireInput
The input used for direct hires.
Fields |
---|
trustedContact ID |
job ID |
name String |
description String |
message String |
rateType RateType |
rate Float |
locationPreference LocationPreferenceInput |
startDate DateThis date is used on the draft contract. |
endDate DateThis date is used on the draft contract. |
includeStandardContract BooleanThe default is to include a standard contract. |
purchaseOrderNumber String |
conversation ID |
recruiter RecruiterInput |
customFieldValues [CustomFieldTypeValueInput!]Details specified in this will only be visible to you and your team members, not to workers. |
company ID! |
externalIdentifier String |
HiresOrderByClauseInput
The input object used to sort hires
Fields |
---|
field HireOrderByColumn |
order SortOrder |
ImpersonateInput
The details required for impersonating a user.
Fields |
---|
user ID! |
InviteCompanyRecruiterInput
The details for inviting a recruiter.
Fields |
---|
id ID! |
company ID! |
recruiterFee Float |
recruiterOwnershipDays Int |
message String |
tags [String!] |
InvitedByInput
Trusted contact invited by users filter input.
If null
, all trusted contacts will be returned.
Fields |
---|
users [ID!]! |
includeAutomation Boolean! |
JobCandidateOrderByClauseInput
Trusted contact sorting clause input.
Fields |
---|
column JobCandidateOrderByColumn! |
order SortOrder!ASC |
LanguageInput
An input for a language.
Fields |
---|
name LanguageName! |
experience Fluency! |
LocationPreferenceInput
An input for the location preferences.
Fields |
---|
preference LocationPreference! |
address StringThis is not required when location is set to REMOTE_ONLY . |
OrderByClause
Allows ordering a list of records.
Fields |
---|
column String! |
order SortOrder! |
QueryInvoicesOrderByOrderByClause
Order by clause for Query.invoices.orderBy.
Fields |
---|
column InvoicesOrderByColumn! |
order SortOrder! |
RateInput
An input for the rate.
Fields |
---|
type RateType! |
rate Float |
range RateRangeInput |
RateRangeInput
An input for the rate as a range.
Fields |
---|
minimum Float! |
maximum Float! |
RecruiterInput
The input object used for all the information required to attribute a recruiter.
Fields |
---|
recruiter ID! |
fee StrictPercentage! |
ownershipDays Int! |
ownershipStartDate Date! |
RecruiterOrderByClauseInput
Recruiter sorting clause input.
Fields |
---|
column RecruiterOrderByColumn |
order SortOrderASC |
RemoveJobShareInput
An input for removing a job share.
Fields |
---|
ids [ID!]! |
RemoveMultiFactorInput
An input for removing a multi-factor authentication implementation.
Fields |
---|
id ID! |
SetInternalBudgetOnJobInput
The input used for setting the internal budget on a job
Fields |
---|
job ID! |
amount Float!Up to 2 decimal points are stored, the rest is omitted. |
SingleSelectCustomFieldValueInput
An input for a single-select custom field.
Fields |
---|
id ID! |
value ID! |
SkillOrderByClauseInput
Skill sorting clause input
Fields |
---|
column SkillOrderByColumn! |
order SortOrder!ASC |
StoreBankDetailsInput
The details for updating a bank account details.
Fields |
---|
accountId ID! |
name String |
bankAddress String! |
bankCountry String! |
bankName String! |
beneficiaryName String! |
bban BbanInput |
iban String |
swift String |
TrustedContactOrderByClauseInput
Trusted contact sorting clause input.
Fields |
---|
column TrustedContactOrderByColumn |
order SortOrderASC |
UpdateApprovalDataInput
The data input used for updating workflow approval.
Fields |
---|
name String |
status ApprovalStatus |
trigger ApprovalTrigger |
description String |
UpdateApprovalInput
The input used for updating an approval.
Fields |
---|
id ID! |
name String |
status ApprovalStatus |
trigger ApprovalTrigger |
description String |
UpdateApprovalRuleFieldInput
The input used for updating approval rule fields.
Fields |
---|
id ID! |
rule ApprovalRuleFieldRuleInput! |
UpdateApprovalRuleInput
The input used for updating approval rules.
Fields |
---|
id ID! |
approval ID! |
fields [CreateApprovalRuleFieldInput!]! |
UpdateApproverInput
The input used for updating an approver.
Fields |
---|
id ID! |
userGroup ID |
position Int |
UpdateCompanyRecruiterInput
The details for updating a recruiter relationship.
Fields |
---|
id ID! |
recruiterFee Float |
recruiterOwnershipDays Int |
tags [String!] |
externalIdentifier String |
UpdateCustomFieldInput
The input for updating a custom field.
Fields |
---|
customField ID! |
fieldType CustomFieldType!SINGLE_SELECT Updating a field type is restricted if the custom field already has values. |
title String! |
slug String |
description String |
settings CustomFieldSettingsInput! |
visibility CustomFieldVisibility! |
approval Boolean |
options [CustomFieldCustomFieldOptionInput!]Only applies to some field types (e.g. SINGLE_SELECT ). |
UpdateJobCandidatePreferredInput
The details for updating the “preferred” status of a job candidate.
Fields |
---|
jobCandidate ID! |
isPreferred Boolean! |
UpdateJobCandidateStatusInput
The details for updating a job candidate status.
Fields |
---|
jobCandidate ID! |
status JobCandidateStatus! |
statusReason JobCandidateStatusReason |
statusComment String |
feedback String |
UpdateJobInput
An input for updating an existing job.
Fields |
---|
id ID! |
locale LocaleIf set, skills and industries will use the locale’s spelling. |
name String |
description String |
skills [String!] |
attachments [ID!] |
association Association |
expectedExperienceLevel [ExpectedExperienceLevel!] |
locationPreference LocationPreferenceInput |
rateType RateInput |
paymentScheme PaymentScheme |
startDate DateIf this is set to null , we will assume that the job should start as soon as possible. |
endDate DateIf this is set to null , we will assume that the job’s end date is undetermined. |
startDateTimeframe JobStartTimeframe |
endDateTimeframe JobEndTimeframe |
isExtensionAvailable Boolean |
evaluationPeriod EvaluationPeriod |
languages [LanguageInput!] |
industries [ID!] |
owners [ID!] |
requiredWorkers Int |
visibility [JobVisibility!]It is therefore important to select which audiences should be allowed to see the job listing. |
customFieldValues [CustomFieldTypeValueInput!]Details specified in this will only be visible to you and your team members, not to workers. |
published Boolean |
externalIdentifier String |
UpdateNoteInput
An input for updating a note.
Fields |
---|
id ID! |
body String |
title String |
UpdatePasswordInput
The details required to update a user’s password.
Fields |
---|
currentPassword String! |
password String! |
passwordConfirmation String! |
UpdateProjectInput
An input for updating an existing project.
Fields |
---|
id ID! |
name String |
description String |
internalBudget Decimal |
owners [ID!] |
externalIdentifier String |
UpdateTrustedContactInput
The details for editing a trusted contact.
Fields |
---|
id ID! |
links [String!] |
attachments [ID!] |
skills [String!] |
externalIdentifier String |
UpdateUserGroupInput
An input for updating an existing group.
Fields |
---|
id ID! |
name String |
description String |
users [ID!] |
UpdateWorkerInput
The details for updating a worker.
Fields |
---|
id ID! |
jobTitle String |
links [String!]! |
skills [String!]! |
UpdateWorkflowApproverInput
The input used for updating workflow approver.
Fields |
---|
id ID |
parent ID |
children [ID!] |
data [ID!]! |
UpdateWorkflowInput
The input used for updating workflows.
Fields |
---|
root UpdateWorkflowRootInput! |
rules [UpdateWorkflowRuleInput!] |
approvers [UpdateWorkflowApproverInput!] |
UpdateWorkflowRootInput
The input used for updating workflow approval.
Fields |
---|
id ID |
children [ID!] |
data UpdateApprovalDataInput! |
UpdateWorkflowRuleInput
The input used for updating workflow approval rule.
Fields |
---|
id ID |
parent ID |
children [ID!] |
data [UpdateApprovalRuleFieldInput!] |
UploadFileInput
The input used for uploading a file.
Fields |
---|
owner ID! |
file Upload!Files should be mapped in the request payload as defined in the https://github.com/jaydenseric/graphql-multipart-request-spec specification. |
VerifySmsMultiFactorInput
An input for verifying a newly-created SMS multi-factor authentication implementation.
Fields |
---|
id ID! |
code String! |
VerifyTotpMultiFactorInput
An input for verifying a newly-created TOTP multi-factor authentication implementation.
Fields |
---|
id ID! |
code String! |