Objects

Object types are the most common type within GraphQL, they represent an object that can be fetched from the Worksome GraphQL API.

Address

An address.

Fields
`address`String The address.
`postCode`String The post code (ZIP code).
`city`String The city.
`state`String The state.
`country`Country The country object.
`formattedAddress`String The formatted address string.

Approval

The approval definition.

Fields
`id`ID! The ID of the approvals.
`name`String! The name of the approval.
`version`Int! The version of the approval.
`status`ApprovalStatus! The status of the approval.
`trigger`ApprovalTrigger! The trigger type of the approval.
`description`String The description of the approval.
`company`Company! The company owning the approval.
`approvalRules`[ApprovalRule!]! The approval rules related to the approval.
`createdAt`DateTime! The date and time that the approval was created.
`updatedAt`DateTime! The date and time that the approval was updated.
`latestVersionId`String! The id on the latest version of the approval.

ApprovalApprovable

The approval approvable definition.

Fields
`id`ID! The ID of the approval approvable.
`approval`Approval! The approval that the approvable belongs to.
`approvalRule`ApprovalRule! The approval rule that the approvable belongs to.
`approvalStates`[ApprovalState!]! The approval states that the approvable has.
`approvable`Approvable The approvable related to the approval approvable.
`viewerCanAction`Boolean! Indicates if the viewer can perform action on the approval approvable.

ApprovalApprovablePaginator

A paginated list of ApprovalApprovable items.

Fields
`paginatorInfo`PaginatorInfo! Pagination information about the list of items.
`data`[ApprovalApprovable!]! A list of ApprovalApprovable items.

ApprovalPaginator

A paginated list of Approval items.

Fields
`paginatorInfo`PaginatorInfo! Pagination information about the list of items.
`data`[Approval!]! A list of Approval items.

ApprovalRule

The approval rule definition.

Fields
`id`ID! The ID of the approval rules.
`approval`Approval! The approval owning this rule.
`fields`[CustomField!]! The fields related to the approval rule with associated rule definition.
`rules`[WorkflowVariableRule!]! The rules related to the approval rule.
`approvers`[Approver!]! The approvers related to the approval rule.
`approverCount`Int! The count of approvers related to the approval rule.
`createdAt`Date! The date that the approval rule was created.
`updatedAt`Date! The date that the approval rule was updated.

ApprovalRulePaginator

A paginated list of ApprovalRule items.

Fields
`paginatorInfo`PaginatorInfo! Pagination information about the list of items.
`data`[ApprovalRule!]! A list of ApprovalRule items.

ApprovalState

The approval state definition.

Fields
`id`ID! The ID of the approval approvable state.
`state`ApprovalApprovableState! The state of the approval approvable.
`actionedBy`User! The user that actioned on the approval approvable.
`message`String The message for the approval approvable.
`approver`Approver! The approver that the approval approvable belongs to.
`approvalApprovable`ApprovalApprovable! The approval approvable that the state belongs to.
`createdAt`DateTime The date that the approval state was created.

ApprovalStatePaginator

A paginated list of ApprovalState items.

Fields
`paginatorInfo`PaginatorInfo! Pagination information about the list of items.
`data`[ApprovalState!]! A list of ApprovalState items.

Approver

The approver definition.

Fields
`id`ID! The ID of the approvers.
`approvalRule`ApprovalRule! The approval rule this approver belongs to.
`userGroup`UserGroup! The user group related to this approver.
`position`Int! The position of this approver in the approval sequence.
`createdAt`Date! The date that the approver was created.
`updatedAt`Date! The date that the approver was updated.

ApproverPaginator

A paginated list of Approver items.

Fields
`paginatorInfo`PaginatorInfo! Pagination information about the list of items.
`data`[Approver!]! A list of Approver items.

AuthenticationToken

Contains information about an authentication token.

Fields
`accessToken`String! The access token for authenticating.

BankDetail

Bank account details.

Fields
`id`ID! The ID of the bank account details.
`name`String! The display name for this bank account.
`bankAddress`String! The address of this bank account.
`bankCountry`String! The country of this bank account.
`bankName`String! The name of this bank account.
`beneficiaryName`String! The beneficiary name of this bank account.
`bban`Bban The BBAN information, if applicable.
`iban`String The bank account IBAN, if applicable.
`swift`String The bank account SWIFT code, if applicable.

Batch

A batch of items for processing.

Batches are a way to group multiple items (such as payment requests) together so that you can perform bulk actions on them. They’re mainly intended for operational workflows inside the platform (e.g., approving or processing large sets of items at once). For most external integrations, batches are not usually needed – you’ll likely want to work directly with the individual items instead.

Fields
`id`ID! The ID of the batch.
`name`String! The name of the batch.
`type`BatchType! The type of batch.
`account`Account! The account that owns the batch.
`itemsCountByStatus`Int! The number of items in the batch that have the specified statuses.
`createdAt`DateTime! The date and time when the batch was created.
`updatedAt`DateTime! The date and time when the batch was last updated.
`deletedAt`DateTime The date and time when the batch was deleted (if soft deleted).
`items`BatchItemPaginator! The items in the batch.

BatchItemPaginator

A paginated list of BatchItem items.

Fields
`paginatorInfo`PaginatorInfo! Pagination information about the list of items.
`data`[BatchItem!]! A list of BatchItem items.

BatchPaginator

A paginated list of Batch items.

Fields
`paginatorInfo`PaginatorInfo! Pagination information about the list of items.
`data`[Batch!]! A list of Batch items.

Bban

The BBAN type details.

Fields
`bsb`String The Bank-State-Branch or BSB number.
`bankId`String The bank ID.
`bankCode`String The bank code.
`branchId`String The bank branch ID.
`branchCode`String The bank branch code.
`accountNumber`String The bank account number.
`accountSuffix`String The bank account suffix.
`institutionNumber`String The bank institution number
`transitNumber`String The bank transit number.
`registrationNumber`String The bank registration number.
`routingCode`String The bank routing code.
`sortCode`String The bank sort code.
`purposeOfPayment`String The bank purpose of payment code.

Bid

Represents a bid sent on a job.

Fields
`id`ID! The ID of the bid.
`status`BidStatus! The status of the bid.
`job`Job! The job which the bid was made on.
`conversation`Conversation! The conversation which contains the bid.
`message`Message! The message with the bid.
`worker`Worker! The worker that this bid belongs to.
`supplier`Account The supplier account for this bid, if applicable.

BidPaginator

A paginated list of Bid items.

Fields
`paginatorInfo`PaginatorInfo! Pagination information about the list of items.
`data`[Bid!]! A list of Bid items.

BusinessEntity

A business entity.

Fields
`id`ID! The ID of the business entity.
`type`BusinessEntityType! The business entity type.
`name`String! The name of the business entity type.
`localisedName`String! The localised friendly name of the business entity type.
`companyName`String The company name for the business entity.
`companyNumber`String The company number for the business entity.
`taxNumber`String The tax number for the business entity.

BusinessEntityPaginator

A paginated list of BusinessEntity items.

Fields
`paginatorInfo`PaginatorInfo! Pagination information about the list of items.
`data`[BusinessEntity!]! A list of BusinessEntity items.

Classification

A classification represents a worker classification (SDS/WCR) for a hire. This can be various types of classifications like IR35, US Worker Classification, etc.

Fields
`id`ID! The unique identifier of the classification
`user`User! The user who created this classification
`hire`Hire! The hire this classification belongs to
`company`Company! The company that requested this classification
`freelancer`Worker! The worker (freelancer) this classification is for
`type`ClassificationType! The type of classification (e.g., IR35, US Worker Classification)
`description`String Describes this classification type
`complianceName`String! The name of the compliance this classification is using
`status`ClassificationStatus! The current status of the classification
`acceptedStatus`Boolean! Whether this classification has been accepted by the company
`result`ClassificationResultDetails! The result of the classification with detailed outcome information
`pdfUrl`String! URL to download the PDF version of this classification (WCR/SDS)
`overridesAnother`Boolean! Whether this classification overrides another classification
`overrideReason`String The reason provided when this classification was overridden (null if not overridden)
`overrideUser`User The user who performed the override (null if not overridden)
`disputesAnother`Boolean! Whether this classification is the result of a dispute on another classification (when applicable)
`hasUnknownAnswers`Boolean! Whether there are any questions with an unknown answer in the classification questionnaire
`hasUpdatedAnswers`Boolean! Whether there are questions with an updated answer from the Worker in the classification questionnaire.
`hasWorkerCompletedAnswers`Boolean! Whether all questions for the worker has been resolved.
`canChange`Boolean! Whether this classification is allowed to be changed
`canOverride`Boolean! Whether this classification can be overridden
`hasHireBlockingCondition`Boolean! Whether the hire has blocking conditions that prevent the classification from continuing
`currentApprovalState`ApprovalState The overall state for approvals on the classification with a given trigger.
`hasPendingApproval`Boolean! Whether there is an approval request pending for the classification on the hire
`title`String! The user-friendly title for this classification
`wcrTerm`String! The WCR term used in the UI for this classification
`hasUpdatedHire`Boolean! Whether the hire has been updated since the determination input was provided

ClassificationPaginator

A paginated list of Classification items.

Fields
`paginatorInfo`PaginatorInfo! Pagination information about the list of items.
`data`[Classification!]! A list of Classification items.

ClassificationResultDetails

Detailed information about a classification result including outcome, label, and title.

Fields
`outcome`ClassificationResult! Canonical enum value (business logic)
`label`String! Short, user-friendly single-word/phrase
`title`String! Longer descriptive title of outcome

Client

The relationship between a worker and a company as seen from the workers perspective.

An equivalent relationship can be found for companies called TrustedContacts.

Fields
`id`ID! The ID of the client.
`company`Company! The client company account.
`status`ContactStatus! Status of the client relationship.
`statusUpdatedAt`Date! The date that the status of the contact was last updated.
`invitedAt`Date! The date that an invite as a contact was sent.
`token`String! The unique invite token used to accept invites from clients.
`origin`TrustedContactOrigin! The origin of the contact.
`originChannel`TrustedContactOriginChannel! The channel of origin of the contact.
`requiresOnboarding`Boolean! If the client has onboarding steps that need to be completed as part of the relationship.
`canLeaveClient`Boolean! Whether it’s possible at this time for the worker to end their relationship with the client.

Company

A company.

Fields
`id`ID! The ID of the company.
`name`String! The name of the company.
`currency`String! The company preferred currency.
`market`MarketCode! The market that the company is in.
`avatar`URL The avatar (or profile picture) for the company.
`profile`Profile The profile that the company has.
`contactInviteUrl`String The company full invite url.
`settings`CompanySettings The settings for the company.
`address`Address The address of the company.
`hasActiveWebhooks`Boolean! If the account has active webhooks.
`hasMultipleBusinessEntities`Boolean! If the account has multiple business entities.
`trustedContacts`TrustedContactPaginator! The trusted contacts that the company has.
`teamMembers`UserPaginator! The team members that the company has.
`teamMembersAndOwners`UserPaginator! The team members and owners that the company has.
`organisations`OrganisationPaginator! The organisations that a company is a part of.
`customFields`CustomFieldPaginator! The custom fields that the company owns.
`staffingAgencies`CompanyRecruiterPaginator! The staffing agencies that the company has relationships with.

CompanyPaginator

A paginated list of Company items.

Fields
`paginatorInfo`PaginatorInfo! Pagination information about the list of items.
`data`[Company!]! A list of Company items.

CompanyRecruiter

A company recruiter relationship.

Fields
`id`ID! The ID of the company recruiter.
`email`String The mail of the recruiter.
`status`ContactStatus! Status of the company recruiter.
`token`String The token used to invite the recruiter.
`message`String The message sent to the recruiter when inviting them.
`recruiterFee`Float The fee of the recruiter for the relationship.
`recruiterOwnershipDays`Int The days of ownership of the recruiter.
`recruiterOwnershipDaysLeft`Int! The amount of days left of the ownership.
`recruiterManagesWorkers`Boolean! Whether the recruiter manages workers for this company relationship.
`recruiter`Recruiter! The recruiter for this company recruiter.
`company`Company! The company recruiter company.
`tags`[Tag!]! The tags applied to the relationship.
`externalIdentifier`String An identifier associated with the company recruiter from an external system.

CompanyRecruiterPaginator

A paginated list of CompanyRecruiter items.

Fields
`paginatorInfo`PaginatorInfo! Pagination information about the list of items.
`data`[CompanyRecruiter!]! A list of CompanyRecruiter items.

CompanySettings

Company settings.

Fields
`projectTracking`Boolean Whether project tracking is enabled.
`requiredJobBudget`Boolean Whether job budget is required.
`multiCurrencyContractsDisabled`Boolean Whether a company has enabled multi currency contracts.
`staffingAgencyManagesWorker`Boolean Whether a company has enabled managing of workers by staffing agencies.
`defaultMessageRemindWorkerToBill`String The company default message for reminding workers to bill.

Compliance

A compliance requirement that must be met for business processes to proceed.

Fields
`actor`ComplianceActorTypes! The party responsible for completing this compliance
`name`ComplianceName! Unique identifier for this compliance requirement
`applicable`Boolean! Whether this compliance applies to the current context
`completed`Boolean! Whether this compliance has been completed
`type`String Optional categorization of the compliance
`title`String! Human readable title describing the compliance
`description`String! Detailed description of what needs to be done
`action`ComplianceAction Optional action details if user input is required
`validationDetails`ComplianceValidationDetails Details about validation status and any blocking issues

ComplianceAction

A compliance action represents an action that can be taken to complete a compliance requirement.

Fields
`action`String! URL or route where the action can be performed
`title`String! Title of the action button or link
`description`String! Description of what the action will do
`buttonText`String Optional button copy text
`tooltip`String Optional tooltip text for additional context

ComplianceValidationDetails

Validation details for a compliance requirement.

Fields
`isValid`Boolean! Whether the compliance passes all validation checks
`issues`[String!]! List of validation issues preventing completion

Contract

A contract.

Fields
`id`ID! The ID of the contract.
`jobName`String! The name of the contract that the job is for.
`jobDescription`String! The description of the contract that the job is for.
`locationPreference`LocationPreference! The location preference of the contract.
`status`ContractStatus! The status of the contract.
`startDate`Date The date that the contract started.
`endDate`Date The date that the contract ended.
`location`Address The address location associated to the contract.
`address`String The address of the contract.
`currency`Currency! The type of currency.
`rateType`RateType The unit of time when payment is due.
`rate`Float The payment amount per specified rate type.
`purchaseOrderNumber`String The Purchase Order (PO) number.
`companyCvr`String The company’s Central Virksomhed (Company) Registration (CVR) number. For more information, visit: https://datacvr.virk.dk
`pdfUrl`URL A URL of the actual contract. This URL will link to a PDF for the contract. This URL cannot be used for saving in external systems as it might change over time or be regenerated. If a permanent URL is needed for the contract, it should be stored in the clients own system.
`paymentTermMethod`PaymentTermMethod! The method of payment over the specified term.
`paymentTerm`Int! The term that the payment will be made within, in days. Example `paymentTerm: 10` means Worksome will pay the freelancers approved bills within 10 days.
`termsAccepted`Boolean! Whether the contract’s terms have been accepted.
`termsAcceptedAt`DateTime The date that the terms were accepted.
`workerAcceptedAt`DateTime The date that the terms were accepted by a worker.
`workerSignature`String The submitted signature of the accepted worker.
`job`Job! The job for which the contract is for.
`worker`Worker The worker for which the contract is for.
`company`Company! The company for which the contract is for.
`businessEntity`BusinessEntity The business entity associated with the contract.
`companyName`String The company name associated with the contract.
`companyLocation`Address The company location associated with the contract.
`milestoneDetails`MilestoneDetailPaginator! The latest milestone details at the time of creation of the contract.

ContractPaginator

A paginated list of Contract items.

Fields
`paginatorInfo`PaginatorInfo! Pagination information about the list of items.
`data`[Contract!]! A list of Contract items.

Conversation

A conversation between a company and a worker.

Fields
`id`ID! The ID of the conversation.
`subject`String! The subject line of the conversation.
`job`Job The job that the conversation is related to.
`latestMessage`Message The latest message sent in the conversation.
`url`URL! The URL for the conversation.
`createdAt`Date! The date that the conversation was created.
`isClosed`Boolean! Whether the conversation is closed.
`isUnread`Boolean! Whether the conversation is unread by the authenticated user.
`closedAt`Date The date that the conversation was closed.
`messages`MessagePaginator! The messages in the conversation.
`participants`ParticipantPaginator! The participants involved in the conversation.

ConversationPaginator

A paginated list of Conversation items.

Fields
`paginatorInfo`PaginatorInfo! Pagination information about the list of items.
`data`[Conversation!]! A list of Conversation items.

Country

A country.

Fields
`isoCode`String! The ISO 3166 alpha-2 code. This is a two-letter country identifier (e.g. US).
`name`String The full name of the country.

CreateCustomTimeSheetResponse

The response from creating a custom timesheet.

Fields
`providedRegistrations`Int! The number of timesheet registrations that were detected.
`successfulRegistrations`Int! The number of timesheet registrations that were successfully parsed.

CreateExportResponse

A response with data from the export creation.

Fields
`status`ExportResponseStatus! The status of the export.
`message`String! A message explaining the result of the export.

CustomField

A custom field.

Fields
`id`ID! The ID of the field.
`user`User! The user that created the field.
`account`Account! The account that the field is owned by.
`title`String! The title of the field.
`slug`String A unique human-readable key for the field, preferably in a slug format with lowercase and hyphens to replace spaces. The key is only unique within the same account.
`description`String The description of the field.
`fieldType`CustomFieldType! The type of the field.
`appliesTo`TypeSupportingCustomFieldValues! The type of item that the field applies to.
`customFieldOptions`[CustomFieldOption!]! The possible options for the field.
`settings`CustomFieldSettings! Additional custom field settings. For example, validation rules.
`visibility`CustomFieldVisibility! To which people should the custom field be visible to.
`customFieldValues`[CustomFieldValue!]! The custom field related values which were applied on an entity.
`isUsedInFieldValues`Boolean! Whether the field has been applied to an entity supporting custom fields.
`rule`WorkflowVariableRule Access to the approval rule field pivot, containing the operator and rule value.
`approval`Boolean! Whether the field is enabled for approval workflows.
`viewerCanUpdate`Boolean! Whether the user querying the field can edit it.
`apiOnly`Boolean! Whether the field is enabled to be updated by the API only.
`viewerCanManageFieldValues`Boolean! Whether the user querying the field can edit the field value. Not to be confused with ‘viewerCanUpdate’ which indicates if the user can edit the field itself, not the field value.
`createdAt`DateTime! The date and time that the field was created.
`updatedAt`DateTime! The date and time that the field was updated.
`deletedAt`DateTime The date and time that the field was deleted.

CustomFieldOption

A custom field option.

Fields
`id`ID! The ID of the field option.
`customField`CustomField! The field that the field option is valid for.
`displayOrder`Int! The display order of the field option. This is an unsigned integer.
`value`String! The value of the field option.

CustomFieldPaginator

A paginated list of CustomField items.

Fields
`paginatorInfo`PaginatorInfo! Pagination information about the list of items.
`data`[CustomField!]! A list of CustomField items.

CustomFieldSettings

The settings for a custom field.

Fields
`validation`[CustomFieldValidationRules!]! Validation rules for the custom field.

CustomFieldValue

A custom field value.

Those represents the custom fields value filled for an entity supporting custom fields.

e.g: You’ve defined a free-text “sector” custom field applying to Job entities. Say you have a job which is in the “IT” sector. You’d need to create a custom field value with field_id = <sector field id>, and content = "IT".

Fields
`id`ID! The ID of the field value.
`account`Account! The account that the field value is owned by.
`user`User! The user who created the field value.
`appliesTo`SupportsCustomFieldValue! The entity to which the custom field value is applying to.
`customField`CustomField! The field that the field value is valid for.
`customFieldOption`CustomFieldOption The field option which was applied for that field to the entity supporting custom fields. This will be present for a single-select field type.
`content`String The content of the custom field value in the case of a custom field not using custom field options. This will be present for a free-text field type.
`displayValue`String A representation of the value for easier display. This gives a “human” representation of the custom field value no matter the field type. For example, this will return `content` for a free-text value, or will return the custom field option `value` for a single-select value.

Employment

An employment.

Fields
`id`ID! The ID of the employment.
`worker`Worker! The worker that the employment relates to.
`employerOfRecord`Account The employer of record for this employment.
`hiringManagers`[User!]! The hiring managers for this employment.
`status`EmploymentStatus! The employment status for the employment.
`onboardingStatus`EmployerRecordStatus! The employer record status for the employment.
`startDate`Date The start date of the employment.
`endDate`Date The end date of the employment.
`firstPayrolledAt`DateTime The date when the worker was first payrolled.
`previouslyHired`Boolean Indicates if the worker was previously hired.
`createdAt`DateTime The date and time that the employment was created.
`updatedAt`DateTime The date and time that the employment was updated.
`isOnboarded`Boolean Whether the employment is onboarded.
`onboardedAt`DateTime The date when the employment was onboarded (status set to Complete).
`hires`HirePaginator! The hires associated with this employment.
`employmentCosts`EmploymentCostPaginator! The employment costs applied to the employment.

EmploymentCost

An employment cost.

Fields
`id`ID! The ID of the employment cost.
`category`EmploymentCostCategory! The category of the employment cost.
`type`EmploymentCostType! The type of the employment cost.
`frequency`EmploymentCostFrequency! The frequency of the employment cost.
`amount`Float! The amount of the employment cost.
`currency`String The currency of the employment cost.
`createdAt`DateTime The date and time that the employment cost was created.
`updatedAt`DateTime The date and time that the employment cost was updated.

EmploymentCostPaginator

A paginated list of EmploymentCost items.

Fields
`paginatorInfo`PaginatorInfo! Pagination information about the list of items.
`data`[EmploymentCost!]! A list of EmploymentCost items.

EmploymentPaginator

A paginated list of Employment items.

Fields
`paginatorInfo`PaginatorInfo! Pagination information about the list of items.
`data`[Employment!]! A list of Employment items.

Expense

An expense.

Fields
`id`ID! The ID of the expense.
`description`String The description of the expense.
`currency`Currency! The currency of the expense.
`amount`Float! The amount of the expense.
`vendor`String! The vendor of the expense.
`expenseAt`DateTime! The date and time that the expense was expensed.
`createdAt`DateTime! The date and time that the expense was created.

ExpensePaginator

A paginated list of Expense items.

Fields
`paginatorInfo`PaginatorInfo! Pagination information about the list of items.
`data`[Expense!]! A list of Expense items.

ExpenseReport

An expense report.

Fields
`id`ID! The ID of the expense report.
`title`String The title of the expense report.
`description`String The description of the expense report.
`total`Float! The total of the expense report.
`isDraft`Boolean! Whether the expense report is a draft.
`createdAt`DateTime The date and time that the expense report was created.
`expenses`ExpensePaginator! The expenses on the expense report.

ExpenseReportPaginator

A paginated list of ExpenseReport items.

Fields
`paginatorInfo`PaginatorInfo! Pagination information about the list of items.
`data`[ExpenseReport!]! A list of ExpenseReport items.

File

A file.

Fields
`id`ID! The ID of the file.
`name`String! The name of the file.
`size`Int! The size of the file in bytes.
`mimeType`String! The IANA MIME type of the file.
`owner`Account! The account that the file belongs to.
`url`String! The URL that should be used to download the file. This URL cannot be used for saving in external systems as it might change over time or be regenerated. If a permanent URL is needed for the file, it should be stored in the clients own system.

FilePaginator

A paginated list of File items.

Fields
`paginatorInfo`PaginatorInfo! Pagination information about the list of items.
`data`[File!]! A list of File items.

ForceLogoutPayload

Contains information about the user who was forcefully logged out.

Fields
`user`User! The user.
`revokedTokens`[Token!]! The tokens that have been revoked.

Gate

A gate represents a collection of related compliance requirements.

Fields
`actor`ComplianceActorTypes! The primary party responsible for this gate’s requirements
`name`ComplianceName! Unique identifier for this gate
`compliances`[Compliance!]! List of individual compliance requirements in this gate
`completed`Boolean! Whether all applicable compliances in this gate are complete
`applicable`Boolean! Whether this gate applies to the current context
`title`String! Human readable title describing the gate’s purpose
`description`String! Detailed description of what needs to be done in this gate

Hire

A representation of a hiring on a job between parties.

Usually a hire is between a worker and a company on a job created by a company. A hire is not a legal document, it is simply used to show that the parties have agreed to work together. The contracts which can be found on the hire is however a legal document.

Fields
`id`ID! The ID of the hire.
`number`String! The unique reference for the hire.
`latestContract`Contract! The latest contract, not necessarily the active one. The latest contract could for example be a draft, if one of the parties wanted to make changes to the currently active contract. see `hire.activeContract` for the current active one.
`activeContract`Contract The currently active contract. This has been accepted by all parties and is the active legal document between them.
`pendingContractChanges`Boolean! If there are pending changes to the contract that are awaiting acceptance by the worker.
`company`Company! The company which the worker will work with.
`job`Job! The job that the hire is on.
`recruiter`Recruiter The recruiter attributed to the hire.
`contractType`ContractType! The contract type for the hire (e.g., ‘SOW’, ‘Sole Trader’, etc.).
`contractTypeShort`String A short code or abbreviation representing the contract type (e.g., ‘W2’, ‘IR35’, etc.).
`contractTypeLabel`String! A descriptive label for the contract type. e.g. ‘Subject to Worksome Classify’.
`usesClassification`Boolean! If this hire is using Worksomes Classify for determining its classification.
`wcr`Wcr Deprecated The Worksome Classification Recommendation (WCR) currently linked to this hire.
`classification`Classification The worksome classification recommendation represents a worker classification (SDS/WCR) for a hire. This can be various types of classifications like IR35, US Worker Classification, etc.
`classificationResult`ClassificationResult! Deprecated The result of classification.
`classificationLabel`String Deprecated A context dependent label that helps interpret the classification result. It can return a much wider array of labels than the classificationResult can and therefore should be used when displaying the legal context for the classification.
`classificationPdfUrl`String! Deprecated A URL of the classification documentation result. This URL will link to a PDF for the classification result is present. This URL cannot be used for saving in external systems as it might change over time or be regenerated. If a permanent URL is needed for the classification result, it should be stored in the clients own system.
`worker`Worker! The worker which the company is hiring.
`conversation`Conversation The conversation in which the hire is happening. If the hire is stuck in an approval flow, there can exist a situation where no conversation exists yet.
`employment`Employment The employment record for the worker on this hire when they are employed by Worksome or an EoR partner. Note: This employment is not always tied to a specific hire.
`createdAt`Date! The date that the hire was created.
`startDate`Date The date that the hire started.
`endDate`Date The date that the hire ended.
`recruiterOwnershipStartDate`Date The date that recruiter ownership started.
`recruiterFee`Percentage The recruiter’s fee.
`recruiterOwnershipDays`Int The number of ownership days for the recruiter.
`recruiterOwnershipIsExpired`Boolean Indicates whether or not the recruiter ownership has expired yet.
`recruiterOwnershipDaysLeft`Int Number of days left in the recruiter’s ownership.
`currency`String! The currency of the hire.
`rate`Float The rate for the hire.
`rateType`String The rate type for the hire.
`status`HireActiveStatus! The hire status for the hire.
`offeredAt`Date The date that the hire became active.
`externalIdentifier`String An identifier associated with the hire from an external system.
`purchaseOrderNumber`String The assigned Purchase Order (PO) number, if one has been added.
`recruiterManagesWorkers`Boolean Whether the assigned recruiter manages workers.
`canRemoveRecruiter`Boolean Whether the assigned recruiter can be removed from the hire.
`canRemindWorkerForBilling`Boolean! Whether the assigned worker can be reminded for billing.
`user`User The user who created the Hire.
`activeStatus`HireActiveStatus! Trusted contact managed status.
`canTerminateContract`Boolean! If the company can terminate the contract of the hire.
`canCancelContract`Boolean! If the company can cancel the contract of the hire.
`hasMilestones`Boolean! If milestones exists for the hire.
`hasDraftContract`Boolean! If there is a draft contract for the hire.
`triggersApproval`Boolean If the hire triggers approval
`currentApprovalState`ApprovalState The overall state for approvals on the hire with a given trigger.
`owners`[User!]! The owners of the hire.
`endsWithinDays`Boolean! Check if this hire ends within a given number of days.
`tenure`Int! The number of days the hire has been active (tenure).
`contracts`ContractPaginator! The contracts for the hire. These are legal documents, however it can contain old contracts and drafts also.
`paymentRequests`PaymentRequestPaginator! The payment requests created on the hire.
`milestones`MilestonePaginator! The milestones for the hire.
`approvals`ApprovalPaginator! The approvals on a hire.

HirePaginator

A paginated list of Hire items.

Fields
`paginatorInfo`PaginatorInfo! Pagination information about the list of items.
`data`[Hire!]! A list of Hire items.

Industry

An industry.

Fields
`id`ID! The ID of the industry.
`name`String! The name of the industry.

IndustryPaginator

A paginated list of Industry items.

Fields
`paginatorInfo`PaginatorInfo! Pagination information about the list of items.
`data`[Industry!]! A list of Industry items.

Invoice

An invoice.

An invoice gets created when one or more worker payment requests gets approved by a company user.

The invoice defines the amount due and is to be paid to Worksome by the company.

Fields
`id`ID! The ID of the invoice.
`number`String A number referencing the invoice. This is usually printed on the invoice itself and should be used by booking system and finance departments. The invoice number is in a human readable format.
`pdfUrl`URL! A URL of the actual invoice. This URL will link to a PDF for the invoice. This URL cannot be used for saving in external systems as it might change over time or be regenerated. If a permanent URL is needed for the invoice, it should be stored in the clients own system.
`currency`Currency! The type of currency.
`grossAmount`Float! The total amount including taxes etc.
`grossOpenAmount`Float! The total amount due on invoice minus credited amounts including taxes etc.
`taxAmount`Float! The total amount of taxes to be paid.
`netAmount`Float! The total amount without taxes.
`markedPaidAt`Date The date that the invoice was marked paid by Worksome. This date might vary from the actual date it was paid, as it takes time for a payment to go through and be validated.
`dueDate`Date! The date that the invoice should be paid by.
`company`Company! The company that the invoice is for.
`date`Date! The date that the invoice was created.
`isBatched`Boolean! Checks if the invoice is a batched invoice. A batch invoice aggregates multiple payment requests together in one, summarised invoice over a period of time. This reduces the overhead of processing high volumes of payment requests and corresponding invoices.
`transactionType`InvoiceTransactionType! The type of transaction to be used for the invoice.
`isFullyCredited`Boolean! Checks if the invoice has been fully credited.
`isOverDue`Boolean Checks if the invoice is overdue.
`creditNotes`[Invoice!]! The credit notes associated with the invoice.
`originalInvoice`Invoice The original invoice credited by this credit note.
`rows`InvoiceRowPaginator! A paginated list of all the rows on the invoice. This can be used to gather more information about the invoice than just the overall amount.

InvoicePaginator

A paginated list of Invoice items.

Fields
`paginatorInfo`PaginatorInfo! Pagination information about the list of items.
`data`[Invoice!]! A list of Invoice items.

InvoiceRow

A row on the invoice.

Fields
`id`ID! The ID of the invoice row.
`paymentRequest`PaymentRequest The payment request which the row on the invoice is related to.
`worker`Worker The worker that is linked to this row.
`customText`String A custom text which will be shown on the invoice PDF.

InvoiceRowPaginator

A paginated list of InvoiceRow items.

Fields
`paginatorInfo`PaginatorInfo! Pagination information about the list of items.
`data`[InvoiceRow!]! A list of InvoiceRow items.

Job

A job that a company has created on Worksome.

Fields
`id`ID! The ID of the job.
`number`Int! The unique reference for the job.
`name`String! The name of the job.
`skills`[Skill!]! The skills required for the job.
`description`String The description of the job.
`market`MarketCode! The market that the job is in.
`status`JobStatus The status of the job.
`address`String Deprecated The address of the job.
`location`Address! The address location associated to the job.
`currency`Currency! The type of currency.
`rateType`RateType The unit of time when payment is due.
`rate`Float The payment amount per specified rate type.
`minimumRate`Float The minimum payment amount per specified rate type.
`maximumRate`Float The maximum payment amount per specified rate type.
`paymentScheme`PaymentScheme Deprecated The payment scheme that the job will use.
`companyFee`StrictPercentage The company fee (as a percentage).
`workerFee`StrictPercentage The worker fee (as a percentage).
`association`Association The project type of the job.
`project`Project The project the job associated to.
`internalBudget`Float Internal budget of the project.
`spent`Float! Total job spent. Only enterprise company owning the job could access the budget.
`expectedExperienceLevel`[ExpectedExperienceLevel!]! The expected experience levels required for the job.
`locationPreference`LocationPreference The location preference of the job.
`startDate`Date The date that the job started.
`startDateTimeframe`JobStartTimeframe The timeframe within the job is likely to start
`endDateTimeframe`JobEndTimeframe The timeframe within the job is likely to end
`endDate`Date The date that the job ended.
`attachments`[File!]! The files attached to the job.
`isExtensionAvailable`Boolean Whether the job can be extended.
`evaluationPeriod`EvaluationPeriod The period of time required to reply to candidates.
`languages`[Language!]! The languages required for the job.
`industries`[Industry!]! The industries that the worker requires experience in for the job.
`requiredWorkers`Int The number of workers that are required for the job. If excluded, the default is 1 profile.
`owners`[User!]! The owners of the job posting.
`customFieldValues`[CustomFieldValue!]! Additional custom fields values for the job. Details specified in this will only be visible to you and your team members, not to workers.
`visibility`[JobVisibility!]! The audiences that will be able to see the job listing.
`approved`Boolean! Whether the job has been approved by Worksome.
`available`Boolean! Whether the job is available to receive offers.
`paused`Boolean! Whether the job is currently paused.
`completed`Boolean! Whether the job is completed.
`published`Boolean! Whether the job has been published.
`draft`Boolean! Whether the job is a draft.
`removed`Boolean! Whether the job has been removed/discarded while being published and before having any hires.
`removedCause`String The cause for removal of the Job.
`publishedAt`DateTime The date and time that the job was published.
`company`Company! The company that the job is for.
`region`String The region for the job.
`url`URL! The URL for the job.
`viewerCanDelete`Boolean! Whether the viewer is able to delete the job.
`viewerCanEdit`Boolean! Whether the viewer is able to edit the job.
`viewerCanShare`Boolean! Whether the viewer is able to share the job.
`viewerCanCreateJobCandidate`Boolean! Whether the viewer is able to create a job candidate.
`viewerCanCreateHire`Boolean! Whether the viewer is able to create a hire on the job.
`createdAt`DateTime! The date and time that the job was created.
`updatedAt`DateTime! The date and time that the job was updated.
`isForContacts`Boolean! Whether the job is shared with contacts.
`isForRecruiters`Boolean! Whether the job is shared with recruiters.
`isForMarketplace`Boolean! Whether the job is shared publicly on the marketplace.
`externalIdentifier`String An identifier associated with the job from an external system.
`canBePublished`Boolean! Determines if the job can be published.
`isJobPost`Boolean Whether the job is a job post.
`isAvailable`Boolean Whether the job is available.
`hires`HirePaginator! The hires made on the job.
`conversations`ConversationPaginator! The conversations involving the job.
`notes`NotePaginator! The notes added to the job.
`paymentRequests`PaymentRequestPaginator! The payment requests created on the job.
`bids`BidPaginator! The bids submitted for the job.
`shares`JobSharePaginator! The contacts that this job was shared with.
`jobCandidates`JobCandidatePaginator! The workers candidates for this job.

JobCandidate

The relation between a job and a worker, making them a candidate for the job.

Fields
`id`ID! The ID of the approvals.
`job`Job! The job for which the worker is a candidate.
`worker`Worker! The worker who is a candidate for the Job.
`bid`Bid The active bid made by the worker for the job.
`hire`Hire The hire created by the company for the job and worker pairing.
`jobShare`JobShare The job share reference if the worker was invited to apply.
`sourcingChannel`SourcingChannel! The sourcing channel that the worker came from as a job candidate.
`owner`Account The owner of the submitted candidate. Only applies if the candidate was submitted.
`step`JobCandidateHiringStep! The step of the hiring process that the job candidate is in.
`status`JobCandidateStatus! The status of the job candidate.
`statusReason`JobCandidateStatusReason When not eligible anymore, indicates why the job candidate is not.
`statusComment`String Added comment regarding the reason for the job candidate not being eligible.
`isPreferred`Boolean! Whether the candidate has been selected as preferred.
`statusSetByUser`User! The user that last changed the job candidate status.
`stepSetByUser`User! The user that last changed the job candidate step.
`createdAt`DateTime! The date and time that the job candidate was created.
`createdByUser`User! The user that created the job candidate.
`updatedAt`DateTime The date and time that the job candidate was last updated.
`updatedByUser`User The user that last updated the job candidate.
`viewerCanUpdateStatus`Boolean! Whether the viewer can update the job candidate status.
`viewerCanUpdatePreferred`Boolean! Whether the viewer can update the job candidate preferred.

JobCandidatePaginator

A paginated list of JobCandidate items.

Fields
`paginatorInfo`PaginatorInfo! Pagination information about the list of items.
`data`[JobCandidate!]! A list of JobCandidate items.

JobPaginator

A paginated list of Job items.

Fields
`paginatorInfo`PaginatorInfo! Pagination information about the list of items.
`data`[Job!]! A list of Job items.

JobShare

The contacts that the job was shared with.

Fields
`id`ID! The ID of the job share.
`account`JobShareableAccount! The account that the job share belongs to.
`isActive`Boolean! Whether the job share is active.
`createdAt`DateTime! The date and time that the job share was created.
`job`Job! The job that the job share is related to.

JobSharePaginator

A paginated list of JobShare items.

Fields
`paginatorInfo`PaginatorInfo! Pagination information about the list of items.
`data`[JobShare!]! A list of JobShare items.

Language

A language that is required for a job.

Fields
`name`LanguageName! The name of the language.
`experience`Fluency! The required level of the language.

LegacyTimesheet

A legacy timesheet.

This is only for internal use within the Worksome platform.

Fields
`format`LegacyTimesheetType Deprecated The format of the legacy timesheet.
`html`String Deprecated The HTML representation of the legacy timesheet.

Link

A link on a profile.

Fields
`title`String! The title of the link.
`url`String! The URL of the link.

Market

A market.

Fields
`code`MarketCode! The market code.
`name`String! The name of the market.

Message

A message as part of a conversation.

Fields
`id`ID! The ID of the message.
`body`String The body of the message.
`author`User The author of the message.
`url`URL! The URL for the message.

MessagePaginator

A paginated list of Message items.

Fields
`paginatorInfo`PaginatorInfo! Pagination information about the list of items.
`data`[Message!]! A list of Message items.

Milestone

A milestone.

Fields
`id`ID! The ID of the milestone.
`name`String! The name of the milestone.
`purchaseOrderNumber`String The Purchase Order (PO) number of the milestone.
`status`MilestoneStatus! The current status of the milestone.
`details`MilestoneDetail! The current details of the milestone.
`hire`Hire! The hire that the milestone belongs to.
`paymentRequests`PaymentRequestPaginator! The payment requests that the milestone is related to.

MilestoneDetail

Milestone details.

Fields
`id`ID! The ID of the milestone details.
`dueDate`Date! The due date of the milestone detail.
`amount`Float! The total amount of the milestone detail.
`milestone`Milestone! The milestone that the details belong to.
`contracts`ContractPaginator! The contracts that the details belong to.

MilestoneDetailPaginator

A paginated list of MilestoneDetail items.

Fields
`paginatorInfo`PaginatorInfo! Pagination information about the list of items.
`data`[MilestoneDetail!]! A list of MilestoneDetail items.

MilestonePaginator

A paginated list of Milestone items.

Fields
`paginatorInfo`PaginatorInfo! Pagination information about the list of items.
`data`[Milestone!]! A list of Milestone items.

MultiFactorPaginator

A paginated list of MultiFactor items.

Fields
`paginatorInfo`PaginatorInfo! Pagination information about the list of items.
`data`[MultiFactor!]! A list of MultiFactor items.

Note

A note for an entity.

Fields
`id`ID! The ID of the note.
`title`String! The title of the note.
`body`String! The body of the note.
`author`User! The author of the note.
`notable`Notable! The entity that the note belongs to.
`account`Account! The account that the note belongs to.
`createdAt`DateTime! The date and time that the note was created.
`updatedAt`DateTime! The date and time that the note was updated.
`viewerCanUpdate`Boolean! Whether the viewer is able to update the note.
`viewerCanDelete`Boolean! Whether the viewer is able to delete the note.

NotePaginator

A paginated list of Note items.

Fields
`paginatorInfo`PaginatorInfo! Pagination information about the list of items.
`data`[Note!]! A list of Note items.

Organisation

An organisation.

Fields
`id`ID! The ID of the organisation.
`name`String! The name of the organisation.
`market`MarketCode! The market that the organisation is in.
`avatar`URL The avatar (or profile picture) for the organisation.
`divisions`CompanyPaginator! The divisions that an organisation contains.

OrganisationPaginator

A paginated list of Organisation items.

Fields
`paginatorInfo`PaginatorInfo! Pagination information about the list of items.
`data`[Organisation!]! A list of Organisation items.

Overtime

An overtime.

Fields
`id`ID! The ID of the overtime.
`type`OvertimeType! The type of the overtime.
`duration`Float! The duration of the overtime.
`rate`Float! The rate of the overtime.
`rateMultiplier`Float! The rate multiplier for the overtime.
`total`Int! The total of the overtime.
`worker`Worker The worker that the overtime is for.
`paymentRequest`PaymentRequest The payment request on which the overtime is charged.
`timesheet`Timesheet! The timesheet which prompted the creation of overtime.
`contributingPaymentRequestNumbers`[ID!]! The payment request numbers which contain contributing timesheets.
`createdAt`DateTime! The date and time that the overtime was created.
`updatedAt`DateTime! The date and time that the overtime was updated.

OvertimePaginator

A paginated list of Overtime items.

Fields
`paginatorInfo`PaginatorInfo! Pagination information about the list of items.
`data`[Overtime!]! A list of Overtime items.

PaginatorInfo

Information about pagination using a fully featured paginator.

Fields
`count`Int! Number of items in the current page.
`currentPage`Int! Index of the current page.
`firstItem`Int Index of the first item in the current page.
`hasMorePages`Boolean! Are there more pages after this one?
`lastItem`Int Index of the last item in the current page.
`lastPage`Int! Index of the last available page.
`perPage`Int! Number of items per page.
`total`Int! Number of total available items.

Participant

A participant in a conversation.

Fields
`id`ID! The ID of the participant.
`conversation`Conversation! The conversation that the participant is a part of.
`account`Account! The account of the participant.

ParticipantPaginator

A paginated list of Participant items.

Fields
`paginatorInfo`PaginatorInfo! Pagination information about the list of items.
`data`[Participant!]! A list of Participant items.

Partner

A partner.

Fields
`id`ID! The ID of the partner.
`name`String! The name of the partner.
`slug`String! The slug of the partner.
`currency`String! The partner preferred currency.
`market`MarketCode! The market that the partner is in.
`avatar`URL The avatar (or profile picture) for the partner.
`address`Address The address of the partner.
`primaryBusinessEntity`BusinessEntity The primary business entity of the partner.
`primaryProfile`Profile The primary profile of the partner.

PaymentRequest

A payment request.

Fields
`id`ID! The ID of the payment request.
`worker`Worker! The worker attached to the payment request.
`recruiter`Recruiter The Recruiter, if any, attached to the payment request.
`company`Company! The Company attached to the payment request.
`number`String! The unique reference for the payment request.
`purchaseOrderNumber`String The purchase order number assigned to the payment request.
`startDate`Date The date that the billing period started.
`endDate`Date The date that the billing period ended.
`currency`Currency! The currency used for this payment request.
`rate`Float The charged rate for this payment request.
`rateType`RateType The rate type required for this payment request.
`rateTypeName`String! The human friendly rate type required for this payment request.
`ratetypeNameSlash`String The abbreviated human friendly rate type required for this payment request.
`rateQuantity`Float! The quantity of the selected rate type for the payment request. The rate type can be seen by looking at `PaymentRequest.rateType` and the rate can be seen by looking at `PaymentRequest.rate`.
`serviceAmount`Float! The fee for using the Worksome Platform. This will change depending on who is viewing the api.
`expensesAmount`Float! The total amount of expenses reported on the payment request.
`netAmount`Float! The total amount excluding taxes.
`grossAmount`Float! The total amount including taxes.
`recruiterFeeAmount`Float! The agreed fee on the payment request between the company and recruiter. Only the company and recruiter can see this.
`employmentCostAmount`Float! The employment cost. The fee for payrolling a Worker. Only the Company can see this.
`billedAmount`Float! The total amount excluding fees and expenses.
`billedAmountWithExpenses`Float! The total amount including fees and expenses.
`date`Date! The date that the payment request was created.
`manuallyApprovedAt`Date The date that the payment request was manually approved.
`approvedBy`User The user that approved the payment request.
`autoApprovedAt`Date The date that the payment request was automatically approved (if applicable).
`rejectedAt`Date The date that the payment request was rejected (if applicable).
`prepaidAt`Date The date that the payment request was prepaid (if applicable).
`issuedAt`Date The date that the payment request was issued (if applicable).
`cancelledAt`Date The date that the payment request was cancelled (if applicable).
`paidAt`Date The date that the payment request was paid (if applicable).
`payrolledAt`Date The date that the payment request was payrolled (if applicable).
`dueAt`Date The date that the payment request is or was due.
`completedAt`Date The date that the payment request is or was completed (if applicable).
`processedAt`Date The date that the payment request is or was processed (if applicable).
`hire`Hire The hire attached to the payment request.
`job`Job! The job attached to the payment request.
`message`Message The message attached to the payment request.
`comments`String The comments relevant to the payment request.
`workerStatus`PaymentRequestWorkerStatus! The worker status relevant to the payment request.
`timesheet`Timesheet The timesheet attached to the payment request.
`legacyTimesheet`LegacyTimesheet Deprecated The legacy timesheet attached to the payment request. This is only for internal use within the Worksome platform.
`files`FilePaginator! The files attached to the payment request. There could potentially be a timesheet stored as a separate file.
`expenseReports`ExpenseReportPaginator! The expense reports for the payment request.
`batches`BatchPaginator! The batches for the payment request.
`milestones`MilestonePaginator! The milestones for the payment request.
`overtimes`OvertimePaginator! The overtimes for the payment request.
`supplierInvoices`SupplierInvoicePaginator! The supplier invoices for the payment request. Supplier invoices are only available to suppliers.

PaymentRequestPaginator

A paginated list of PaymentRequest items.

Fields
`paginatorInfo`PaginatorInfo! Pagination information about the list of items.
`data`[PaymentRequest!]! A list of PaymentRequest items.

Profile

A profile.

Fields
`id`ID! The ID of the profile.
`url`URL! The URL for the profile.
`links`[Link!]! The links for the profile

Project

A project with a budget containing one or more jobs.

Fields
`id`ID! The ID of the project.
`name`String! The name of the project.
`description`String The description of the project.
`currency`Currency! The currency used for this project.
`creator`User! The creator of the project.
`company`Company! The company that the project is for.
`internalBudget`Decimal The total internal budget for the project.
`allocatedBudget`Decimal! The sum of all associated job budgets that have been allocated to the internal budget of the project.
`spent`Decimal! The amount that is spent out of the internal budget for the project. Spent for the project budget is registered when a bill is approved on an associated job.
`endDate`Date The date that the project ended. If this is set to `null`, we will assume that the project is not yet ended but active.
`owners`[User!]! The owners of the project.
`externalIdentifier`String An identifier associated with the project from an external system.
`jobs`JobPaginator! Jobs added to this project.

ProjectPaginator

A paginated list of Project items.

Fields
`paginatorInfo`PaginatorInfo! Pagination information about the list of items.
`data`[Project!]! A list of Project items.

Recruiter

A recruiter.

Fields
`id`ID! The ID of the recruiter.
`name`String! The name of the recruiter.
`market`Market! The market that the recruiter is in.
`initials`String! The initials of the recruiter
`avatar`URL The avatar (or profile picture) for the recruiter.
`owner`User The owner of the recruiter account

RecruiterCandidate

A recruiter candidate relationship.

Fields
`id`ID! The ID of the recruiter candidate.
`recruiter`Recruiter! The recruiter of the relationship.
`worker`Worker! The candidate in the relationship.
`email`String The email of the candidate.
`status`ContactStatus! The status of the candidate relationship.
`token`String The token used to invite the candidate.
`rate`Float The rate of the candidate.
`jobTitle`String The candidate job title
`links`[String!]! The links attached to the relationship.
`tags`[Tag!]! The tags applied to the relationship.
`files`FilePaginator! The files attached to the relationship.

RecruiterCandidatePaginator

A paginated list of RecruiterCandidate items.

Fields
`paginatorInfo`PaginatorInfo! Pagination information about the list of items.
`data`[RecruiterCandidate!]! A list of RecruiterCandidate items.

RecruiterPaginator

A paginated list of Recruiter items.

Fields
`paginatorInfo`PaginatorInfo! Pagination information about the list of items.
`data`[Recruiter!]! A list of Recruiter items.

RunBatchActionResponse

The payload returned when running an action on a batch.

Fields
`batch`Batch The batch the action was run against.
`batchId`ID! The global ID of the batch. Always provided even if the batch was deleted.
`action`BatchActionType! The action that was requested.
`batchDeleted`Boolean! Whether the batch was deleted as a result of the action.
`resultUrl`String The URL of the result of the action.

Skill

A skill that is required for a job.

Fields
`id`ID! The ID of the skill.
`name`String! The name of the skill.

SkillPaginator

A paginated list of Skill items.

Fields
`paginatorInfo`PaginatorInfo! Pagination information about the list of items.
`data`[Skill!]! A list of Skill items.

SmsCreateMultiFactorPayload

A response payload for a newly-created SMS multi-factor authentication implementation.

Fields
`multiFactor`SmsMultiFactor! The newly-created SMS multi factor.

SmsMultiFactor

An SMS multi-factor authentication implementation.

Fields
`id`ID! The ID of the SMS multi-factor authentication implementation.
`name`String! The name of the SMS multi-factor authentication implementation.
`phoneNumber`E164PhoneNumber! The phone number for the SMS multi-factor authentication implementation.
`status`Status! The status of the SMS multi-factor authentication implementation.
`owner`User! The owner of the SMS multi-factor authentication implementation.
`verifiedAt`DateTime When the SMS multi-factor authentication implementation was verified.
`createdAt`DateTime! When the SMS multi-factor authentication implementation was created.
`updatedAt`DateTime! When the SMS multi-factor authentication implementation was updated.

SupplierInvoice

A supplier invoice.

The invoice defines the amount due and is to be paid to the worker.

Fields
`id`ID! The ID of the supplier invoice.
`number`String A number referencing the supplier invoice. This is usually printed on the supplier invoice itself and should be used by booking system and finance departments. The supplier invoice number is in a human readable format.
`pdfUrl`URL! A URL of the actual supplier invoice. This URL will link to a PDF for the supplier invoice. This URL cannot be used for saving in external systems as it might change over time or be regenerated. If a permanent URL is needed for the supplier invoice, it should be stored in the clients own system.

SupplierInvoicePaginator

A paginated list of SupplierInvoice items.

Fields
`paginatorInfo`PaginatorInfo! Pagination information about the list of items.
`data`[SupplierInvoice!]! A list of SupplierInvoice items.

Tag

A tag.

Fields
`id`ID! The ID of the tag.
`name`String The name of the tag.

TagPaginator

A paginated list of Tag items.

Fields
`paginatorInfo`PaginatorInfo! Pagination information about the list of items.
`data`[Tag!]! A list of Tag items.

TemporaryFileUploadResponse

The details for a temporary file upload.

Fields
`id`ID! The ID of the temporary file.
`name`String! The name of the file to be uploaded.
`url`URL! The temporary URL to upload the file to. The temporary URL will expire after 1 week.

Timesheet

A timesheet.

Fields
`id`ID! The ID of the timesheet.
`worker`Worker The worker that the timesheet belongs to.
`hire`Hire The hire that the timesheet belongs to.
`startDate`Date The start date of timesheet.
`endDate`Date The end date of timesheet.
`createdAt`DateTime! The date and time that the timesheet was created.
`paymentRequests`PaymentRequestPaginator! The payment requests created on the timesheet.
`registrations`TimesheetRegistrationPaginator! The timesheet registrations.
`files`FilePaginator! The files that are related to the timesheet.
`overtimes`OvertimePaginator! The overtimes that the timesheet belongs to.

TimesheetPaginator

A paginated list of Timesheet items.

Fields
`paginatorInfo`PaginatorInfo! Pagination information about the list of items.
`data`[Timesheet!]! A list of Timesheet items.

TimesheetRegistration

A registration for a timesheet.

Fields
`id`ID! The ID of the timesheet registration.
`type`TimesheetRegistrationType! The type of the timesheet registration.
`date`Date! The date of the timesheet registration.
`startTime`Time The start time of the timesheet registration.
`endTime`Time The end time of the timesheet registration.
`duration`Float! The duration of the timesheet registration.
`unit`TimesheetRegistrationDurationUnit! The unit of measurement for the timesheet registration.
`comments`String The comments for the timesheet registration.
`invoiceReferenceNumber`String The invoice reference number associated with the timesheet registration.
`externalIdentifier`String An identifier associated with the timesheet registration from an external system.
`isBillable`Boolean Whether the timesheet registration is billable.
`customFieldValues`[CustomFieldValue!]! The custom fields values for the timesheet registration.

TimesheetRegistrationPaginator

A paginated list of TimesheetRegistration items.

Fields
`paginatorInfo`PaginatorInfo! Pagination information about the list of items.
`data`[TimesheetRegistration!]! A list of TimesheetRegistration items.

Token

Contains information about an authentication token.

Fields
`jti`String! The access token JTI (JWT ID).

TotpCreateMultiFactorPayload

A response payload for a newly-created TOTP multi-factor authentication implementation.

Fields
`multiFactor`TotpMultiFactor! The newly-created TOTP multi factor.
`secret`String! The secret for the newly-created TOTP multi factor.
`qrCode`URL! A URL for the QR Code containing the secret. This is not the QR Code itself, but the URL that the QR code should contain. The URL is in `otpauth` format.

TotpMultiFactor

A TOTP multi-factor authentication implementation.

Fields
`id`ID! The ID of the TOTP multi-factor authentication implementation.
`name`String! The name of the TOTP multi-factor authentication implementation.
`status`Status! The status of the TOTP multi-factor authentication implementation.
`owner`User! The owner of the TOTP multi-factor authentication implementation.
`verifiedAt`DateTime When the TOTP multi-factor authentication implementation was verified.
`createdAt`DateTime! When the TOTP multi-factor authentication implementation was created.
`updatedAt`DateTime! When the TOTP multi-factor authentication implementation was updated.

TrustedContact

A trusted contact.

Fields
`id`ID! The ID of the trusted contact.
`worker`Worker! The trusted contact worker.
`company`Company! The trusted contact company.
`invitedByUser`User The user who invited the worker as trusted contact of the company. A `null` value here means the trusted contact was automatically added by a process.
`viewerCanApprove`Boolean! Whether the viewer is able to approve the trusted contact.
`viewerCanUpdate`Boolean! Whether the viewer is able to update the trusted contact.
`viewerCanDelete`Boolean! Whether the viewer is able to delete the trusted contact.
`viewerCanReInvite`Boolean! Whether the viewer is able to re-invite the trusted contact.
`links`[String!]! Links associated with the trusted contact.
`attachments`[File!]! File attachments uploaded by the company that are related to the worker.
`skills`[Skill!]! Skills associated with the trusted contact.
`managedStatus`TrustedContactManagedStatus Trusted contact managed status.
`status`ContactStatus! Status of the trusted contact.
`statusUpdatedAt`Date! The date that the status of the trusted contact was last updated.
`invitedAt`Date! The date that the trusted contact was invited.
`externalIdentifier`String An identifier associated with the trusted contact from an external system.
`origin`TrustedContactOrigin! The origin of the trusted contact
`originChannel`TrustedContactOriginChannel! The channel of origin of the trusted contact
`customFieldValues`[CustomFieldValue!]! The custom fields values for the trusted contact.
`onboardingStatus`TrustedContactOnboardingStatus The onboarding status of the trusted contact.
`tags`TagPaginator! Deprecated The tags for a trusted contact.
`notes`NotePaginator! Notes added to the trusted contact.

TrustedContactPaginator

A paginated list of TrustedContact items.

Fields
`paginatorInfo`PaginatorInfo! Pagination information about the list of items.
`data`[TrustedContact!]! A list of TrustedContact items.

User

Account of a person who utilizes this application.

Fields
`id`ID! Unique primary key.
`name`String! Non-unique name.
`email`String! Unique email address.
`emailVerifiedAt`DateTime When the email was verified.
`createdAt`DateTime! When the account was created.
`updatedAt`DateTime! When the account was last updated.
`canCreatePassword`Boolean! Whether the user is allowed to create a password for their account. The user might not be allowed if they already have a password, in which case they should use `updatePassword` or if they have SAML on their account.
`missingAuthentication`Boolean! Whether the user has any way of authenticating into the system. This will check that the user has no password, social, SAML etc. way of authenticating into their account.
`hasVerifiedEmail`Boolean! Checks whether the user has verified their email or not.
`avatar`URL The avatar (or profile picture) for the user.
`hasConsentedToWorksomeIntelligence`Boolean! Whether the user has consented to use Worksome Intelligence.

UserGroup

A user group.

Fields
`id`ID! The ID of the group.
`name`String! The name of the group.
`description`String The description of the group.
`company`Company! The company that the group is for.
`status`UserGroupStatus! The status of the user group.
`users`UserPaginator! The users of the group.

UserGroupPaginator

A paginated list of UserGroup items.

Fields
`paginatorInfo`PaginatorInfo! Pagination information about the list of items.
`data`[UserGroup!]! A list of UserGroup items.

UserPaginator

A paginated list of User items.

Fields
`paginatorInfo`PaginatorInfo! Pagination information about the list of items.
`data`[User!]! A list of User items.

Wcr

Represents the Worksome Classification Recommendation (WCR) in the system.

Fields
`id`ID! The ID of the WCR.
`user`User The user associated with this WCR.
`supersededBy`WcrSupersede Reference to a supersede record, indicating a newer WCR that replaces or supersedes a previous one.
`overridesAnother`Boolean! Determines whether this WCR overrides another WCR. Details can be found in the WcrSupersede.

WcrSupersede

Represents the supersede relationship for an WCR, used when one WCR replaces or supersedes another.

Fields
`type`WcrSupersedeType! The specific type of the supersede (e.g., ‘DISPUTE’, ‘OVERRIDE’, etc.).
`originalWcr`Wcr Reference to the original WCR that is being superseded.
`reason`String The reason provided for the supersede by the user.
`filedAt`Date! The date on which this supersede was filed.

Webhook

The webhook definition.

Fields
`id`ID! The ID of the webhook.
`title`String! The title of the webhook.
`description`String The description of the webhook.
`owner`String! The owner of the webhook (company name).
`url`String! The URL of the webhook.
`secret`String The secret of the webhook.
`isActive`Boolean Whether the webhook is active or not.
`clientId`String The client ID of the webhook, when using OAuth.
`clientSecret`String The client secret of the webhook, when using OAuth.
`clientUrl`String The client URL of the webhook, when using OAuth.
`createdAt`DateTime! The date and time that the webhook was created.
`updatedAt`DateTime! The date and time that the webhook was updated.

WebhookEvent

The webhook event definition.

Fields
`id`ID! The ID of the webhook event.
`key`String! The unique key of the webhook event.
`webhookId`ID! The ID of the webhook.
`event`String! The webhook event identifer. Refer to the webhook event documentation for more information about which event values Worksome uses here.
`description`String! The webhook event description (human readable version of the `event` field).
`status`String! The latest status of the webhook sending attempts: - `pending`: The webhook has not yet been sent. - `success`: The webhook was sent successfully. - `failed-N`: The webhook sending attempt failed for the N’th time. - `failed-finally`: The webhook sending attempt failed and will not be retried automatically.
`payload`JSON! The webhook event payload.
`logs`[WebhookEventLog!]! The log entries of webhook event calls.
`createdAt`DateTime! The date and time that the webhook event was created.
`updatedAt`DateTime! The date and time that the webhook event was updated.

WebhookEventLog

The webhook event log definition.

Fields
`id`ID! The ID of the webhook event log.
`key`String! The unique key of the webhook event.
`result`String! The result of the webhook sending attempt: - `success`: The webhook was sent successfully. - `failed-N`: The webhook sending attempt failed for the N’th time. - `failed-finally`: The webhook sending attempt failed and will not be retried automatically.
`statusCode`Int The HTTP status code of the the webhook sending attempt.
`webhook`Webhook! The webhook.
`webhookEvent`WebhookEvent! The webhook event.
`request`JSON! The webhook event request.
`response`JSON! The webhook event response.
`createdAt`DateTime! The date and time that the webhook event log was created.

WebhookEventLogPaginator

A paginated list of WebhookEventLog items.

Fields
`paginatorInfo`PaginatorInfo! Pagination information about the list of items.
`data`[WebhookEventLog!]! A list of WebhookEventLog items.

WebhookEventPaginator

A paginated list of WebhookEvent items.

Fields
`paginatorInfo`PaginatorInfo! Pagination information about the list of items.
`data`[WebhookEvent!]! A list of WebhookEvent items.

WebhookPaginator

A paginated list of Webhook items.

Fields
`paginatorInfo`PaginatorInfo! Pagination information about the list of items.
`data`[Webhook!]! A list of Webhook items.

Worker

A worker.

Fields
`id`ID! The ID of the worker.
`name`String! The name of the worker.
`firstName`String! The first name of the worker.
`lastName`String! The last name of the worker.
`middleName`String The middle name of the worker.
`email`String The email of the worker.
`phone`String The phone of the worker.
`avatar`URL The avatar (or profile picture) for the worker.
`address`Address The address that the worker is registered to.
`market`Market! The market that the worker is in.
`skills`[Skill!]! The skills that the worker has.
`profile`Profile The profile that the worker has.
`jobTitle`String The job title that the worker has.
`initials`String! The initials for the worker name.
`currency`String! The currency that the worker uses.
`dayRate`Float The daily rate for the worker.
`rtwVerifiedAt`DateTime Right to work verification and background checks have been made for this worker at this date.
`rtwExpiresAt`DateTime Right to work verification and background checks for this worker will expire by this date. If the expire date is in the future the verification is still valid.
`hiresWithAttribution`[Hire!]! The hires associated with the worker that has an attribution.
`primaryBusinessEntity`BusinessEntity The business entity that the worker uses.
`totalPaid`Float! The total amount received/paid by the given company.
`viewerIsClient`Boolean Whether the worker is a trusted contact for the current viewer. Only companies can see this.
`viewerCanContact`Boolean! Whether the viewer is able to contact the trusted contact.
`viewerCanOfferJob`Boolean! Whether the viewer is able to offer jobs to the trusted contact
`isCurrentlyHired`Boolean! Determines if the worker is currently hired by the given company.
`clients`[Client!]! A list of relations between the worker and a company as seen from the workers perspective.
`businessEntities`BusinessEntityPaginator! The business entities that the worker has.
`hires`HirePaginator! The hires associated with the worker.

Workflow

The workflow definition.

Fields
`id`ID! The ID of the workflow.
`nodes`[Nodeable!]! The nodes that are attached to this workflow.

WorkflowPaginator

A paginated list of Workflow items.

Fields
`paginatorInfo`PaginatorInfo! Pagination information about the list of items.
`data`[Workflow!]! A list of Workflow items.

WorkflowVariableOption

The workflow variable option.

Fields
`displayOrder`Int! The display order of the option.
`label`String! The display label of the option.
`value`String! The value of the option.

WorkflowVariableOptionType

The workflow variable for a variable of type option.

Fields
`id`ID! The ID of the workflow variable.
`title`String! The title of the variable.
`description`String The description of the variable.
`operators`[WorkflowVariableOperator!]! Operators that can be used with this variable.
`options`[WorkflowVariableOption!]! The options that can be used with this variable.

WorkflowVariablePaginator

A paginated list of WorkflowVariable items.

Fields
`paginatorInfo`PaginatorInfo! Pagination information about the list of items.
`data`[WorkflowVariable!]! A list of WorkflowVariable items.

WorkflowVariableRule

The workflow variable rule definition.

Fields
`id`ID! The ID of the rule.
`fieldId`String! The ID of the field which is either a string or id of CustomField model.
`approvalRule`ApprovalRule! The rule that the variable is connected to.
`variable`WorkflowVariable! The variable that the rule is connected to.
`operator`WorkflowVariableOperator! The operator that the rule is connected to.
`value`String! The value the rule would be compared to.
`createdAt`Date! The date that the rule was created.
`updatedAt`Date! The date that the rule was updated.

WorkflowVariableStringType

The workflow variable for a variable of type string.

Fields
`id`ID! The ID of the workflow variable.
`title`String! The title of the variable.
`description`String The description of the variable.
`operators`[WorkflowVariableOperator!]! Operators that can be used with this variable.