{"openapi":"3.1.0","info":{"title":"Endpoints","version":"1.0.0"},"paths":{"/contracts/{contract_id}/custom_fields/{id}":{"delete":{"operationId":"delete-contract-custom-field","summary":"Delete Contract custom field by Id","description":"Removes the custom field value from the contract custom field.\n **Token scopes**: `contracts:write`","tags":["subpackage_customFieldsContracts"],"parameters":[{"name":"id","in":"path","description":"Custom field id.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"contract_id","in":"path","description":"Contract id.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/custom-fields-contracts_deleteContractCustomField_Response_204"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"404":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}}}},"/contracts/custom_fields/{id}":{"get":{"operationId":"get-custom-field","summary":"Get custom fields from contracts","description":"Get custom field from contract by id\n **Token scopes**: `contracts:read`","tags":["subpackage_customFieldsContracts"],"parameters":[{"name":"id","in":"path","description":"Custom field id.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/custom-fields-contracts_getCustomField_Response_200"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"404":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCustomFieldsFromContractsRequestInternalServerError"}}}}}}},"/contracts/custom_fields":{"get":{"operationId":"get-contract-custom-fields","summary":"List all custom fields","description":"Use this endpoint to retrieve all custom fields defined for contracts. Use it when building contract creation or edit flows that need to display field options and requirements. This operation is read-only and non-destructive.\n **Token scopes**: `contracts:read`","tags":["subpackage_customFieldsContracts"],"parameters":[{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/custom-fields-contracts_getContractCustomFields_Response_200"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"404":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}}}},"/contracts/{contract_id}/custom_fields":{"put":{"operationId":"put-contract-custom-field","summary":"Update custom field value","description":"Update custom field value.\n **Token scopes**: `contracts:write`","tags":["subpackage_customFieldsContracts"],"parameters":[{"name":"contract_id","in":"path","description":"Contract id.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/custom-fields-contracts_putContractCustomField_Response_200"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ContractsContractIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaData"}},"required":["data"]}}}}}},"/people/{worker_id}/custom_fields/{id}":{"delete":{"operationId":"delete-person-custom-field","summary":"Delete the custom field value from Worker by Id","description":"Delete the custom field value from Worker by Id.\n **Token scopes**: `people:write`","tags":["subpackage_customFieldsPeople"],"parameters":[{"name":"id","in":"path","description":"Custom field id.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"worker_id","in":"path","description":"Worker id.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/custom-fields-people_deletePersonCustomField_Response_204"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}}}},"/people/custom_fields/{id}":{"get":{"operationId":"get-person-custom-field","summary":"Get custom field from people by id","description":"Get custom field from people by id.\n **Token scopes**: `people:read`","tags":["subpackage_customFieldsPeople"],"parameters":[{"name":"id","in":"path","description":"Custom field id.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/custom-fields-people_getPersonCustomField_Response_200"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"404":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}}}},"/people/custom_fields":{"get":{"operationId":"get-custom-fields","summary":"List all people custom fields","description":"Fetch all custom fields associated with People records, offering additional personalized information.\n **Token scopes**: `people:read`","tags":["subpackage_customFieldsPeople"],"parameters":[{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/custom-fields-people_getCustomFields_Response_200"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"404":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListAllPeopleCustomFieldsRequestInternalServerError"}}}}}}},"/people/{worker_id}/custom_fields":{"get":{"operationId":"get-person-custom-fields","summary":"Retrieve custom fields for a worker","description":"Retrieve custom fields for a worker\n **Token scopes**: `people:read`","tags":["subpackage_customFieldsPeople"],"parameters":[{"name":"worker_id","in":"path","description":"Worker id.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/custom-fields-people_getPersonCustomFields_Response_200"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"404":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}}},"put":{"operationId":"put-person-custom-field","summary":"Update custom field value","description":"Update custom field value.\n **Token scopes**: `people:write`","tags":["subpackage_customFieldsPeople"],"parameters":[{"name":"worker_id","in":"path","description":"Worker id.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/custom-fields-people_putPersonCustomField_Response_200"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"description":"Any type"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PeopleWorkerIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaData"}},"required":["data"]}}}}}},"/hris/organization_structures":{"post":{"operationId":"create-organization-structure","summary":"Create a new HRIS Organization Structure.","description":"Create a new HRIS Organization Structure.\n **Token scopes**: `organizations:write`","tags":["subpackage_organizationStructure"],"parameters":[{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/organization-structure_createOrganizationStructure_Response_200"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"404":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/HrisOrganizationStructuresPostRequestBodyContentApplicationJsonSchemaData"}}}}}}},"get":{"operationId":"get-organization-structures","summary":"Get Organization Structure","description":"Retrieves detailed information about the organization's hierarchical structure, including departments and teams.\n **Token scopes**: `organizations:read`","tags":["subpackage_organizationStructure"],"parameters":[{"name":"offset","in":"query","description":"Return a page of results with given number of records.","required":false,"schema":{"type":"integer","format":"int64","default":0}},{"name":"limit","in":"query","description":"Return a page of results with given number of records.","required":false,"schema":{"type":"number","format":"double"}},{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/organization-structure_getOrganizationStructures_Response_200"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"404":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}}}},"/hris/organization_structures/external/{external_id}":{"delete":{"operationId":"delete-organization-structure-by-external-id","summary":"Delete an Org Structure from the Organization by external ID","description":"undefined\n **Token scopes**: `organizations:write`","tags":["subpackage_organizationStructure"],"parameters":[{"name":"external_id","in":"path","description":"External ID","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successfully deleted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/organization-structure_deleteOrganizationStructureByExternalId_Response_200"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"404":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}}},"get":{"operationId":"get-organization-structure-by-external-id","summary":"Fetch an Org Structure from the Organization","description":"undefined\n **Token scopes**: `organizations:read`","tags":["subpackage_organizationStructure"],"parameters":[{"name":"external_id","in":"path","description":"External ID","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/organization-structure_getOrganizationStructureByExternalId_Response_200"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"404":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}}},"patch":{"operationId":"update-organization-structure-by-external-id","summary":"Update an existing HRIS Org Structure by external ID","description":"undefined\n **Token scopes**: `organizations:write`","tags":["subpackage_organizationStructure"],"parameters":[{"name":"external_id","in":"path","description":"External ID","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/organization-structure_updateOrganizationStructureByExternalId_Response_200"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"404":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/HrisOrganizationStructuresExternalExternalIdPatchRequestBodyContentApplicationJsonSchemaData"}}}}}}}},"/hris/organization_structures/{hrisOrgStr_id}":{"delete":{"operationId":"delete-organization-structure","summary":"Delete Organization Structure","tags":["subpackage_organizationStructure"],"parameters":[{"name":"hrisOrgStr_id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response"}}},"get":{"operationId":"get-organization-structure","summary":"Get Organization Structure","tags":["subpackage_organizationStructure"],"parameters":[{"name":"hrisOrgStr_id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response"}}},"patch":{"operationId":"update-organization-structure","summary":"Update Organization Structure","tags":["subpackage_organizationStructure"],"parameters":[{"name":"hrisOrgStr_id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response"}}}},"/hris/organization-structures/teams/{team_id}/custom-fields":{"get":{"operationId":"get-team-custom-fields","summary":"Retrieve custom fields for organization","description":"Retrieves custom field values for a specific organization structure (team). This endpoint returns all custom fields configured for organization structures, including their current values, inheritance status, and any pending change requests. Custom fields can be inherited from parent teams in the organizational hierarchy, and the response indicates whether each value is inherited or set directly on the specified team. If the user has permission to view data change requests, pending changes will also be included in the response.\n **Token scopes**: `organizations:read`","tags":["subpackage_organizationStructure"],"parameters":[{"name":"team_id","in":"path","description":"Public ID (UUID) of the HRIS team/organization structure","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"limit","in":"query","description":"Max items per page (default 20, max 100)","required":false,"schema":{"type":"integer","default":20}},{"name":"cursor","in":"query","description":"Opaque cursor for pagination","required":false,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Custom field values retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/organization-structure_getTeamCustomFields_Response_200"}}}},"400":{"description":"Bad request - Organization is not set or Deel HR is not enabled for this organization.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveCustomFieldsForOrganizationRequestBadRequestError"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"404":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}}},"patch":{"operationId":"update-team-custom-fields","summary":"Update organization structure team custom fields","description":"Use this endpoint to keep team metadata current or to schedule future organizational changes. Provide the custom field IDs to modify and use an effective date to schedule updates. Set the value to null to delete a field value.\n **Token scopes**: `organizations:read`","tags":["subpackage_organizationStructure"],"parameters":[{"name":"team_id","in":"path","description":"Public ID (UUID) of the HRIS team/organization structure","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Organization structure custom fields updated successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/organization-structure_updateTeamCustomFields_Response_200"}}}},"400":{"description":"Bad request - Organization is not set or Deel HR is not enabled for this organization.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateOrganizationStructureTeamCustomFieldsRequestBadRequestError"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"404":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/HrisOrganizationStructuresTeamsTeamIdCustomFieldsPatchRequestBodyContentApplicationJsonSchemaData"}},"required":["data"]}}}}}},"/people/{id}/department":{"put":{"operationId":"update-person-department","summary":"Update organization structure","description":"Update worker's department\n **Token scopes**: `people:write`","tags":["subpackage_organizationStructure"],"parameters":[{"name":"id","in":"path","description":"Hris profile ID","required":true,"schema":{"type":"string"}},{"name":"replace_other_positions","in":"query","description":"Indicates if this department position should replace all other positions or only append to the existing ones.","required":false,"schema":{"type":"boolean"}},{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/organization-structure_updatePersonDepartment_Response_200"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"404":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PeopleIdDepartmentPutRequestBodyContentApplicationJsonSchemaData"}},"required":["data"]}}}}}},"/pwac":{"post":{"operationId":"create-person-without-contract","summary":"Create a person without a contract","description":"Create a person without a contract hired under your own entity to Deel's HRIS.\n **Token scopes**: `people:write`","tags":["subpackage_people"],"parameters":[{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Successful operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/people_createPersonWithoutContract_Response_201"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAPersonWithoutAContract-v2026-01-01RequestBadRequestError"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"404":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAPersonWithoutAContract-v2026-01-01RequestInternalServerError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PwacPostRequestBodyContentApplicationJsonSchemaData"}},"required":["data"]}}}}}},"/people":{"get":{"operationId":"get-people","summary":"List of People","description":"Use this endpoint to retrieve people in your organization for building directories or syncing HR data. Paginate with offset/limit and filter with search, teams, and other query parameters. This operation is non-destructive.\n **Token scopes**: `people:read`","tags":["subpackage_people"],"parameters":[{"name":"offset","in":"query","description":"Return a page of results with given number of records.","required":false,"schema":{"type":"integer","default":0}},{"name":"limit","in":"query","description":"Return a page of results with given number of records.","required":false,"schema":{"type":"integer"}},{"name":"search","in":"query","description":"Include a contract if by name or contractor name contains given search term.","required":false,"schema":{"type":"string"}},{"name":"teams","in":"query","description":"Filter the results based on the team(group) the users contract is associated with","required":false,"schema":{"type":"array","items":{"type":"string","format":"uuid"}}},{"name":"fields","in":"query","description":"Pick the fields you want to see in the response in order to avoid a bloated people list output. Supports dot notation (e.g., 'employments[0].contract_status') to access nested fields.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/PeopleGetParametersFieldsSchemaItems"}}},{"name":"sort_by","in":"query","description":"Sort people by given field name.","required":false,"schema":{"$ref":"#/components/schemas/PeopleGetParametersSortBy"}},{"name":"sort_order","in":"query","description":"Order direction of results; ascending or descending.","required":false,"schema":{"$ref":"#/components/schemas/PeopleGetParametersSortOrder"}},{"name":"hiring_statuses","in":"query","description":"Employee's current hiring status.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/PeopleGetParametersHiringStatusesSchemaItems"}}},{"name":"band_placements","in":"query","description":"Employee's current band placement.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/PeopleGetParametersBandPlacementsSchemaItems"}}},{"name":"comparative_ratios_from","in":"query","description":"Employee's minimum band placement","required":false,"schema":{"type":"number","format":"double"}},{"name":"comparative_ratios_to","in":"query","description":"Employee's maximum band placement","required":false,"schema":{"type":"number","format":"double"}},{"name":"hiring_types","in":"query","description":"Filter people by hiring types","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/PeopleGetParametersHiringTypesSchemaItems"}}},{"name":"person_statuses","in":"query","description":"Filter people by person (worker profile) lifecycle status.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/PeopleGetParametersPersonStatusesSchemaItems"}}},{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/people_getPeople_Response_200"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"404":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListOfPeople-v2026-01-01RequestInternalServerError"}}}}}}},"/people/{hris_profile_id}":{"get":{"operationId":"get-person-by-id","summary":"Retrieve a single person","description":"Retrieves detailed information about a single person (employee, contractor, or worker) in the organization by their HRIS profile OID, including personal details, employment information, organizational structure, direct manager and reports, custom fields, and related metadata.\n **Token scopes**: `people:read`","tags":["subpackage_people"],"parameters":[{"name":"hris_profile_id","in":"path","description":"Unique identifier for the person.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"include_custom_fields","in":"query","description":"Include custom fields in the response.","required":false,"schema":{"type":"boolean"}},{"name":"include_worker_relations","in":"query","description":"Include worker relations in the response.","required":false,"schema":{"type":"boolean"}},{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/people_getPersonById_Response_200"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"404":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveASinglePersonRequestInternalServerError"}}}}}}},"/people/{id}/working-location":{"put":{"operationId":"update-person-working-location","summary":"Update working location","description":"undefined\n **Token scopes**: `people:write`","tags":["subpackage_people"],"parameters":[{"name":"id","in":"path","description":"Hris profile ID","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/people_updatePersonWorkingLocation_Response_200"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"404":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PeopleIdWorkingLocationPutRequestBodyContentApplicationJsonSchemaData"}},"required":["data"]}}}}}},"/people/{worker_id}/personal":{"get":{"operationId":"get-person-personal-info","summary":"Get personal information by id","description":"Get worker's personal information by using identifier.\n **Token scopes**: `people:read`","tags":["subpackage_personalInformation"],"parameters":[{"name":"worker_id","in":"path","description":"Unique identifier for a worker (External ID).","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/personal-information_getPersonPersonalInfo_Response_200"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"404":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetPersonalInformationByIdRequestInternalServerError"}}}}}},"patch":{"operationId":"update-person-personal-info","summary":"Update personal information","description":"Update worker's personal information.\n **Token scopes**: `people:write`","tags":["subpackage_personalInformation"],"parameters":[{"name":"worker_id","in":"path","description":"Unique identifier for a worker.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/personal-information_updatePersonPersonalInfo_Response_204"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"404":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PeopleWorkerIdPersonalPatchRequestBodyContentApplicationJsonSchemaData"}},"required":["data"]}}}}}},"/people/external/{worker_id}/personal":{"get":{"operationId":"get-person-personal-info-external-id","summary":"Get worker profile by external ID","description":"Retrieve a worker profile record using an external worker identifier.\n **Token scopes**: `people:read`","tags":["subpackage_personalInformation"],"parameters":[{"name":"worker_id","in":"path","description":"System-wide external identifier for a worker record.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/personal-information_getPersonPersonalInfoExternalID_Response_204"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"404":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}}},"patch":{"operationId":"update-person-personal-info-external-id","summary":"Update personal information by external id","description":"Update worker's personal information by using an external identifier.\n **Token scopes**: `people:write`","tags":["subpackage_personalInformation"],"parameters":[{"name":"worker_id","in":"path","description":"Unique identifier for a worker (External ID).","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/personal-information_updatePersonPersonalInfoExternalID_Response_204"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"404":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PeopleExternalWorkerIdPersonalPatchRequestBodyContentApplicationJsonSchemaData"}},"required":["data"]}}}}}},"/hris/positions/apply_changes":{"post":{"operationId":"apply-position-changes","summary":"Apply changes to positions.","description":"Applies a set of position changes (add, edit, delete) for a given HRIS profile.\n **Token scopes**: `profile:write`","tags":["subpackage_positions"],"parameters":[{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/positions_applyPositionChanges_Response_204"}}}},"400":{"description":"Bad Request. Invalid input parameters.","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Unauthorized. Invalid or expired token.","content":{"application/json":{"schema":{"description":"Any type"}}}},"403":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"404":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"500":{"description":"Internal Server Error. Could not process the request.","content":{"application/json":{"schema":{"description":"Any type"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/HrisPositionsApplyChangesPostRequestBodyContentApplicationJsonSchemaData","description":"The request payload containing the position changes to apply."}}}}}}}},"/hris/positions/profile/{hrisProfileId}":{"get":{"operationId":"get-positions-by-profile","summary":"Get Positions By Profile","tags":["subpackage_positions"],"parameters":[{"name":"hrisProfileId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response"}}}},"/time_offs/review":{"post":{"operationId":"review-time-off-request","summary":"Approve/Reject time-off requests","description":"Approve/Reject time-off requests in batch. The request body should contain a list of time-off IDs and the desired status (either APPROVED or REJECTED). The response will indicate which requests were successfully processed and which ones encountered errors.\n **Token scopes**: `time-off:write`","tags":["subpackage_timeOff"],"parameters":[{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Review process completed successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/time-off_reviewTimeOffRequest_Response_201"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApproveRejectTimeOffRequests-v2026-01-01RequestBadRequestError"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"404":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/TimeOffsReviewPostRequestBodyContentApplicationJsonSchemaDataItems"},"description":"Array of time-offs to be reviewed"}},"required":["data"]}}}}}},"/time_offs/{time_off_id}":{"delete":{"operationId":"delete-time-off-request","summary":"Cancel time-off request","description":"Cancels a time-off request regardless of its current status. This endpoint provides a simplified approach to time-off management by always setting the request status to CANCELED.\n **Token scopes**: `time-off:write`, `worker:write`","tags":["subpackage_timeOff"],"parameters":[{"name":"time_off_id","in":"path","description":"Time off request id","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"time off deleted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/time-off_deleteTimeOffRequest_Response_204"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"404":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}}},"patch":{"operationId":"update-time-off-request","summary":"Update time-off request","description":"Update time-off request\n **Token scopes**: `time-off:write`, `worker:write`","tags":["subpackage_timeOff"],"parameters":[{"name":"time_off_id","in":"path","description":"Time off request id","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Time off updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/time-off_updateTimeOffRequest_Response_200"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateTimeOffRequestRequestBadRequestError"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"404":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}},"requestBody":{"description":"Time off update request data","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/TimeOffsTimeOffIdPatchRequestBodyContentApplicationJsonSchemaData","description":"Time off update request data"}}}}}}}},"/time_offs":{"post":{"operationId":"create-time-off-request","summary":"Create time-off request","description":"Create time-off request\n **Token scopes**: `time-off:write`, `worker:write`","tags":["subpackage_timeOff"],"parameters":[{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Time off creation data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/time-off_createTimeOffRequest_Response_201"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateTimeOffRequest-v2026-01-01RequestBadRequestError"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateTimeOffRequest-v2026-01-01RequestForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateTimeOffRequest-v2026-01-01RequestNotFoundError"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}},"requestBody":{"description":"The time off request data","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/TimeOffsPostRequestBodyContentApplicationJsonSchemaData","description":"The time off request data"}}}}}}}},"/time_offs/global-payroll/sync":{"post":{"operationId":"sync-time-off-global-payroll","summary":"External HR Time Off Synchronization","description":"Synchronize time off requests from an external HRIS to Deel. Only Global Payroll contracts are allowed for this operation. This endpoint can perform 2 different operations with the provided time off list: i) upsert - time off requests identified by an external ID will be either inserted or updated at Deel. ii) delete - existing time off requests identified by an external ID with the parameter 'deleted: true' will be deleted. Deel will identify the impacts of each operation on each payroll cycle.\n **Token scopes**: `time-off:write`","tags":["subpackage_timeOff"],"parameters":[{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation time offs returned","content":{"application/json":{"schema":{"$ref":"#/components/schemas/time-off_syncTimeOffGlobalPayroll_Response_200"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalHrTimeOffSynchronizationRequestBadRequestError"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"404":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/TimeOffsGlobalPayrollSyncPostRequestBodyContentApplicationJsonSchemaData"}}}}}}}},"/time_offs/profile/{hris_profile_id}/entitlements":{"get":{"operationId":"get-time-off-entitlements","summary":"Get Profile Entitlements","description":"List time-off entitlements.\n **Token scopes**: `time-off:read`","tags":["subpackage_timeOff"],"parameters":[{"name":"hris_profile_id","in":"path","description":"HRIS profile ID","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"policy_type_name","in":"query","required":false,"schema":{"$ref":"#/components/schemas/TimeOffsProfileHrisProfileIdEntitlementsGetParametersPolicyTypeName"}},{"name":"tracking_period_date","in":"query","description":"Tracking period date","required":false,"schema":{"type":"string","format":"date"}},{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/time-off_getTimeOffEntitlements_Response_200"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"404":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}}}},"/time_offs/time-off-events":{"get":{"operationId":"get-time-off-events","summary":"Get Time Off Events for Profile","description":"List time off events for profile\n **Token scopes**: `time-off:read`","tags":["subpackage_timeOff"],"parameters":[{"name":"hris_profile_id","in":"query","description":"Worker hris profile id","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"time_off_type_id","in":"query","description":"Time off type id","required":false,"schema":{"type":"string","format":"uuid"}},{"name":"policy_id","in":"query","description":"Policy id","required":false,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"List of time off events for the profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/time-off_getTimeOffEvents_Response_200"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetTimeOffEventsForProfileRequestBadRequestError"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"404":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}}}},"/time_offs/dailies":{"get":{"operationId":"get-time-off-dailies","summary":"Get Work Schedule and Holidays","description":"Given a date range (start date, end date) gets the holidays, work schedule and time off dailies for a list of hrisProfileIds or countries.\n **Token scopes**: `time-off:read`","tags":["subpackage_timeOff"],"parameters":[{"name":"start_date","in":"query","description":"Start date of non working days date range","required":false,"schema":{"type":"string","format":"date"}},{"name":"end_date","in":"query","description":"End date of non working days date range","required":false,"schema":{"type":"string","format":"date"}},{"name":"hris_profile_ids","in":"query","description":"HRIS profile ids","required":false,"schema":{"type":"array","items":{"type":"string","format":"uuid"}}},{"name":"countries","in":"query","description":"List of countries to be fetched","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/time-off_getTimeOffDailies_Response_200"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetWorkScheduleAndHolidaysRequestBadRequestError"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"404":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}}}},"/time_offs/profile/{hris_profile_id}/policies":{"get":{"operationId":"get-time-off-policies","summary":"List policies","description":"List policies for profile\n **Token scopes**: `time-off:read`","tags":["subpackage_timeOff"],"parameters":[{"name":"hris_profile_id","in":"path","description":"hrisProfileId id.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"policy_type_name","in":"query","description":"Policy type name.","required":false,"schema":{"$ref":"#/components/schemas/TimeOffsProfileHrisProfileIdPoliciesGetParametersPolicyTypeName"}},{"name":"policy_type_id","in":"query","description":"policy type id","required":false,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/time-off_getTimeOffPolicies_Response_200"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"404":{"description":"Not Found - Resource not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListPoliciesRequestNotFoundError"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}}}},"/time_offs/profile/{hris_profile_id}":{"get":{"operationId":"get-time-off-profile","summary":"List time-off requests","description":"List time-off requests\n **Token scopes**: `time-off:read`","tags":["subpackage_timeOff"],"parameters":[{"name":"hris_profile_id","in":"path","description":"HRIS profile id","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"status","in":"query","description":"Time off status","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/TimeOffsProfileHrisProfileIdGetParametersStatusSchemaItems"}}},{"name":"time_off_ids","in":"query","description":"Time off ids","required":false,"schema":{"type":"array","items":{"type":"string","format":"uuid"}}},{"name":"start_date","in":"query","description":"Start date of time off","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"end_date","in":"query","description":"End date of time off","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"approval_start_date","in":"query","description":"Approval start date","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"approval_end_date","in":"query","description":"Approval end date","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"updated_start_date","in":"query","description":"Updated start date","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"updated_end_date","in":"query","description":"Updated end date","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"page_size","in":"query","description":"Page size","required":false,"schema":{"type":"integer"}},{"name":"policy_types","in":"query","description":"Policy types","required":false,"schema":{"type":"array","items":{"type":"string","format":"uuid"}}},{"name":"next","in":"query","description":"Next page","required":false,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation time offs returned","content":{"application/json":{"schema":{"$ref":"#/components/schemas/time-off_getTimeOffProfile_Response_200"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"404":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}}}},"/time_offs/policy-validation-templates":{"get":{"operationId":"get-time-off-policy-validation-templates","summary":"Retrieve policy validation templates","description":"Retrieves policy validation templates and policy types based on the provided countries. Policy types are unique.\n **Token scopes**: `time-off:read`","tags":["subpackage_timeOff"],"parameters":[{"name":"countries","in":"query","description":"List of countries (ISO 3166-1 alpha-2 codes) to fetch policy templates and types for.","required":true,"schema":{"type":"array","items":{"type":"string"}}},{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/time-off_getTimeOffPolicyValidationTemplates_Response_200"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrievePolicyValidationTemplatesRequestBadRequestError"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"404":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}}}},"/time_offs/validate":{"post":{"operationId":"validate-time-off","summary":"Validate time-off request","description":"Validate time-off requests and updates\n **Token scopes**: `time-off:read`","tags":["subpackage_timeOff"],"parameters":[{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Time off request validation result","content":{"application/json":{"schema":{"$ref":"#/components/schemas/time-off_validateTimeOff_Response_200"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidateTimeOffRequest-v2026-01-01RequestBadRequestError"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"404":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}},"requestBody":{"description":"Time off request data","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/TimeOffsValidatePostRequestBodyContentApplicationJsonSchemaData","description":"Time off request data"}}}}}}}},"/Users":{"get":{"operationId":"get-users","summary":"List users","description":"Retrieve a list of users in Deel's HRIS.\n **Token scopes**: `Users:read`","tags":["subpackage_users"],"parameters":[{"name":"filter","in":"query","description":"Filter results using [SCIM's filtering syntax](https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2.2). Currently supports only `eq` operator and filtering by a user's email. Expected format 'email eq \"email@domain.com\"'.","required":false,"schema":{"$ref":"#/components/schemas/UsersGetParametersFilter"}},{"name":"startIndex","in":"query","description":"The 1-based index of the first result to return. Used for pagination. Minimum value is 1. Defaults to 1 if not provided.","required":false,"schema":{"type":"string"}},{"name":"count","in":"query","description":"The maximum number of results to return per page. Used for pagination. A value of 0 is treated as a special case and returns 1 result. Typically should be a positive integer.","required":false,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Users_getUsers_Response_200"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too many requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListUsers-v2026-01-01RequestInternalServerError"}}}}}}},"/Users/{hrisProfileOid}":{"get":{"operationId":"get-user-by-id","summary":"Retrieve a single User","description":"Retrieve a single user by id.","tags":["subpackage_users"],"parameters":[{"name":"hrisProfileOid","in":"path","description":"Retrieve a single user by id.","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserResponse"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too many requests.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal server error,","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/Users/.search":{"post":{"operationId":"search-users","summary":"Search or list users","tags":["subpackage_users"],"parameters":[{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserSearchResponse"}}}},"400":{"description":"bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"authorization failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"permissions denied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"too many requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"description":"search parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchRequest"}}}}}},"/hris/worker_relations/profile/{hrisProfileOid}/child":{"put":{"operationId":"add-worker-relation-child","summary":"Add Worker Relation Child","tags":["subpackage_workerRelations"],"parameters":[{"name":"hrisProfileOid","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response"}}}},"/hris/worker_relations/profile/external/{profileId}/parent":{"put":{"operationId":"add-worker-relation-parent-by-external-id","summary":"Add Worker Relation Parent By External Id","tags":["subpackage_workerRelations"],"parameters":[{"name":"profileId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response"}}}},"/hris/worker_relations/profile/{hrisProfileOid}/parent":{"put":{"operationId":"add-worker-relation-parent","summary":"Create a parent worker relation","description":"Create a parent worker relation.\n **Token scopes**: `profile:write`","tags":["subpackage_workerRelations"],"parameters":[{"name":"hrisProfileOid","in":"path","description":"HrisProfile ID","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/worker-relations_addWorkerRelationParent_Response_204"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"404":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/HrisWorkerRelationsProfileHrisProfileOidParentPutRequestBodyContentApplicationJsonSchemaData"}}}}}}}},"/hris/worker_relations/profile":{"post":{"operationId":"create-worker-relation-profile","summary":"Create a worker relation","description":"Create a hierarchical relation between a worker and its subordinates.\n **Token scopes**: `profile:write`","tags":["subpackage_workerRelations"],"parameters":[{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/worker-relations_createWorkerRelationProfile_Response_201"}}}},"400":{"description":"Bad request - The request body is invalid, missing required fields, or a circular relationship was detected.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAWorkerRelation-v2026-01-01RequestBadRequestError"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"404":{"description":"Not found - The parent profile, child profile, or relationship type was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAWorkerRelation-v2026-01-01RequestNotFoundError"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/HrisWorkerRelationsProfilePostRequestBodyContentApplicationJsonSchemaData","description":"The request payload containing the relationship details."}}}}}}}},"/hris/worker_relations/profile/external/{profileId}/child":{"put":{"operationId":"add-worker-relation-child-by-external-id","summary":"Create child worker relation with external Id","description":"Create child worker relation with external Id.\n **Token scopes**: `profile:write`","tags":["subpackage_workerRelations"],"parameters":[{"name":"profileId","in":"path","description":"HrisProfile external ID","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/worker-relations_addWorkerRelationChildByExternalId_Response_204"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"404":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/HrisWorkerRelationsProfileExternalProfileIdChildPutRequestBodyContentApplicationJsonSchemaData"}}}}}}}},"/hris/worker_relations/types":{"post":{"operationId":"create-worker-relation-type","summary":"Create worker relation type","description":"Create worker relation type.\n **Token scopes**: `organizations:write`","tags":["subpackage_workerRelations"],"parameters":[{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/worker-relations_createWorkerRelationType_Response_201"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"404":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/HrisWorkerRelationsTypesPostRequestBodyContentApplicationJsonSchemaData"}}}}}}},"get":{"operationId":"get-worker-relation-types","summary":"Retrieve all worker relation types","description":"Retrieves all worker relationship types defined for the organization.\n **Token scopes**: `organizations:read`","tags":["subpackage_workerRelations"],"parameters":[{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/worker-relations_getWorkerRelationTypes_Response_200"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveAllWorkerRelationTypes-v2026-01-01RequestBadRequestError"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"404":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveAllWorkerRelationTypes-v2026-01-01RequestInternalServerError"}}}}}}},"/hris/worker_relations/profile/external":{"post":{"operationId":"create-worker-relation-profile-by-external-id","summary":"Create worker relation with external Ids","description":"Create a hierarchical relation between a worker and its subordinates using external IDs to identify them.\n **Token scopes**: `profile:write`","tags":["subpackage_workerRelations"],"parameters":[{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/worker-relations_createWorkerRelationProfileByExternalId_Response_201"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"404":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/HrisWorkerRelationsProfileExternalPostRequestBodyContentApplicationJsonSchemaData"}}}}}}}},"/hris/worker_relations/profile/{hrisProfileOid}":{"delete":{"operationId":"delete-worker-relation-profile","summary":"Delete a worker relation","description":"Delete a worker relation.\n **Token scopes**: `profile:write`","tags":["subpackage_workerRelations"],"parameters":[{"name":"hrisProfileOid","in":"path","description":"Worker Relation ID","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Successfully deleted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/worker-relations_deleteWorkerRelationProfile_Response_204"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"404":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}}},"get":{"operationId":"get-worker-relation-profile","summary":"List of worker relations","description":"List of worker relations.\n **Token scopes**: `profile:read`","tags":["subpackage_workerRelations"],"parameters":[{"name":"hrisProfileOid","in":"path","description":"HrisProfile ID","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/worker-relations_getWorkerRelationProfile_Response_200"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"404":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}}}},"/hris/worker_relations/profile/external/{profileId}":{"delete":{"operationId":"delete-worker-relation-profile-by-external-id","summary":"Delete a worker relation by external id","description":"Delete a worker relation by external id.\n **Token scopes**: `profile:write`","tags":["subpackage_workerRelations"],"parameters":[{"name":"profileId","in":"path","description":"Worker Relation external ID","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Successfully deleted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/worker-relations_deleteWorkerRelationProfileByExternalId_Response_204"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"404":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}}},"get":{"operationId":"get-worker-relation-profile-by-external-id","summary":"Get Worker Relation Profile By External Id","tags":["subpackage_workerRelations"],"parameters":[{"name":"profileId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response"}}}},"/hris/worker_relations/types/external/{externalId}":{"delete":{"operationId":"delete-worker-relation-type-by-external-id","summary":"Delete a worker relation type by external id","description":"Delete a Worker Relation Type by the external ID.\n **Token scopes**: `organizations:write`","tags":["subpackage_workerRelations"],"parameters":[{"name":"externalId","in":"path","description":"Worker Relation Type external ID","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/worker-relations_deleteWorkerRelationTypeByExternalId_Response_204"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"404":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}}},"patch":{"operationId":"update-worker-relation-type-by-external-id","summary":"Update a worker relation type by external id","description":"Update a worker relation type by external id.\n **Token scopes**: `organizations:write`","tags":["subpackage_workerRelations"],"parameters":[{"name":"externalId","in":"path","description":"Worker Relation Type external ID","required":true,"schema":{"type":"string"}},{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/worker-relations_updateWorkerRelationTypeByExternalId_Response_204"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"404":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/HrisWorkerRelationsTypesExternalExternalIdPatchRequestBodyContentApplicationJsonSchemaData"}}}}}}}},"/hris/worker_relations/types/{typeId}":{"delete":{"operationId":"delete-worker-relation-type","summary":"Delete Worker Relation Type","tags":["subpackage_workerRelations"],"parameters":[{"name":"typeId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful response"}}},"patch":{"operationId":"update-worker-relation-type","summary":"Update a worker relation type","description":"Update a worker relation type.\n **Token scopes**: `organizations:write`","tags":["subpackage_workerRelations"],"parameters":[{"name":"typeId","in":"path","description":"Worker Relation Type id","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"Authorization","in":"header","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/worker-relations_updateWorkerRelationType_Response_204"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"404":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/HrisWorkerRelationsTypesTypeIdPatchRequestBodyContentApplicationJsonSchemaData"}}}}}}}}},"servers":[{"url":"https://api.letsdeel.com/rest/v2"},{"url":"https://api-staging.letsdeel.com/rest/v2"},{"url":"https://api.letsdeel.com/scim/v2"},{"url":"https://api-staging.letsdeel.com/scim/v2"}],"components":{"schemas":{"custom-fields-contracts_deleteContractCustomField_Response_204":{"type":"object","properties":{},"description":"Empty response body","title":"custom-fields-contracts_deleteContractCustomField_Response_204"},"ApiErrorRequest":{"type":"object","properties":{"method":{"type":"string","description":"The HTTP method of the failed request"},"url":{"type":"string","description":"The relative URL of the failed request"},"status":{"type":"number","format":"double","description":"The status code of the response"},"api_req_id":{"type":"string","description":"The request ID of the failed request"},"docs":{"type":"string","description":"A link to the official documentation for the requested endpoint resource"},"source":{"type":"string","description":"The source handler which produced the returned error"},"code":{"type":"number","format":"double","description":"The code of the source handler which produced the returned error"}},"title":"ApiErrorRequest"},"ApiError":{"type":"object","properties":{"message":{"type":"string","description":"A description of the returned error"},"path":{"type":"string","description":"The JSON path where input validation failed"}},"title":"ApiError"},"ApiErrorContainer":{"type":"object","properties":{"request":{"$ref":"#/components/schemas/ApiErrorRequest"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/ApiError"}}},"title":"ApiErrorContainer"},"ContractsCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataTypeOneOf0Name":{"type":"string","enum":["text","number","date","percentage"],"description":"Simple field type","title":"ContractsCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataTypeOneOf0Name"},"ContractsCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataType0":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/ContractsCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataTypeOneOf0Name","description":"Simple field type"}},"description":"Simple custom field types","title":"ContractsCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataType0"},"ContractsCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataTypeOneOf1Name":{"type":"string","enum":["currency"],"description":"Currency field type","title":"ContractsCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataTypeOneOf1Name"},"ContractsCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataType1":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/ContractsCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataTypeOneOf1Name","description":"Currency field type"},"currency":{"type":"string","description":"ISO currency code"},"is_fixed":{"type":"boolean","description":"Whether the currency is fixed"}},"description":"Currency custom field type","title":"ContractsCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataType1"},"ContractsCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataTypeOneOf2Name":{"type":"string","enum":["list","multiselect"],"description":"List field type","title":"ContractsCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataTypeOneOf2Name"},"ContractsCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataType2":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/ContractsCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataTypeOneOf2Name","description":"List field type"},"options":{"type":"array","items":{"type":"string"},"description":"Available options for the list field"}},"description":"List or multiselect custom field type","title":"ContractsCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataType2"},"ContractsCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataType":{"oneOf":[{"$ref":"#/components/schemas/ContractsCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataType0"},{"$ref":"#/components/schemas/ContractsCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataType1"},{"$ref":"#/components/schemas/ContractsCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataType2"}],"description":"Type definition of the custom field","title":"ContractsCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataType"},"ContractsCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataSettingsAccessProvidedBy":{"type":"string","enum":["organization","worker"],"description":"Entity providing access","title":"ContractsCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataSettingsAccessProvidedBy"},"ContractsCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataSettingsAccess":{"type":"object","properties":{"provided_by":{"oneOf":[{"$ref":"#/components/schemas/ContractsCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataSettingsAccessProvidedBy"},{"type":"null"}],"description":"Entity providing access"},"is_sensitive":{"type":"boolean","description":"Whether the field contains sensitive data"}},"description":"Access control settings","title":"ContractsCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataSettingsAccess"},"ContractsCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataSettingsWorkerTypesItems":{"type":"string","enum":["eor","contractor","hris_direct_employee","direct_employee"],"description":"Worker type","title":"ContractsCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataSettingsWorkerTypesItems"},"ContractsCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataSettings":{"type":"object","properties":{"access":{"$ref":"#/components/schemas/ContractsCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataSettingsAccess","description":"Access control settings"},"required":{"type":"boolean","description":"Whether the field is mandatory"},"countries":{"type":"array","items":{"type":"string"},"description":"Countries where the field applies"},"is_enabled":{"type":"boolean","description":"Whether the field is enabled"},"worker_types":{"type":"array","items":{"$ref":"#/components/schemas/ContractsCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataSettingsWorkerTypesItems"},"description":"Applicable worker types"}},"description":"Configuration settings for the custom field","title":"ContractsCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataSettings"},"ContractsCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataPlacement":{"type":"string","enum":["profile","contract"],"description":"Where the custom field is displayed","title":"ContractsCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataPlacement"},"ContractsCustomFieldsIdGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Custom field id"},"name":{"type":"string","description":"Name of the custom field"},"type":{"$ref":"#/components/schemas/ContractsCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataType","description":"Type definition of the custom field"},"settings":{"$ref":"#/components/schemas/ContractsCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataSettings","description":"Configuration settings for the custom field"},"placement":{"$ref":"#/components/schemas/ContractsCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataPlacement","description":"Where the custom field is displayed"},"created_at":{"type":"string","format":"date-time","description":"Creation timestamp"},"description":{"type":["string","null"],"description":"Optional description of the custom field"}},"description":"Custom field object","title":"ContractsCustomFieldsIdGetResponsesContentApplicationJsonSchemaData"},"custom-fields-contracts_getCustomField_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ContractsCustomFieldsIdGetResponsesContentApplicationJsonSchemaData","description":"Custom field object"}},"required":["data"],"description":"Response wrapper object","title":"custom-fields-contracts_getCustomField_Response_200"},"ContractsCustomFieldsIdGetResponsesContentApplicationJsonSchemaError":{"type":"object","properties":{"code":{"type":"string","description":"Error code identifying the type of error."},"details":{"type":["string","null"],"description":"Additional details about the error."},"message":{"type":"string","description":"Error message describing what went wrong."}},"required":["code","message"],"title":"ContractsCustomFieldsIdGetResponsesContentApplicationJsonSchemaError"},"GetCustomFieldsFromContractsRequestInternalServerError":{"type":"object","properties":{"error":{"$ref":"#/components/schemas/ContractsCustomFieldsIdGetResponsesContentApplicationJsonSchemaError"}},"required":["error"],"title":"GetCustomFieldsFromContractsRequestInternalServerError"},"ContractsCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsTypeOneOf0Name":{"type":"string","enum":["text","number","date","percentage"],"description":"Simple types","title":"ContractsCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsTypeOneOf0Name"},"ContractsCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsType0":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/ContractsCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsTypeOneOf0Name","description":"Simple types"}},"required":["name"],"title":"ContractsCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsType0"},"ContractsCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsTypeOneOf1Name":{"type":"string","enum":["currency"],"description":"Currency type","title":"ContractsCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsTypeOneOf1Name"},"ContractsCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsType1":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/ContractsCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsTypeOneOf1Name","description":"Currency type"},"currency":{"type":["string","null"],"description":"Currency code (null when is_fixed is false)"},"is_fixed":{"type":"boolean","description":"When currency is fixed, only the amount can be edited by the users"}},"required":["name","is_fixed"],"title":"ContractsCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsType1"},"ContractsCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsTypeOneOf2Name":{"type":"string","enum":["list","multiselect"],"description":"List types","title":"ContractsCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsTypeOneOf2Name"},"ContractsCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsType2":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/ContractsCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsTypeOneOf2Name","description":"List types"},"options":{"type":"array","items":{"type":"string"},"description":"List of options for the custom field"}},"required":["name","options"],"title":"ContractsCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsType2"},"ContractsCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsType":{"oneOf":[{"$ref":"#/components/schemas/ContractsCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsType0"},{"$ref":"#/components/schemas/ContractsCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsType1"},{"$ref":"#/components/schemas/ContractsCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsType2"}],"description":"Type configuration of the custom field including its data type and type-specific properties","title":"ContractsCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsType"},"ContractsCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsSettingsAccessProvidedBy":{"type":"string","enum":["organization","worker"],"description":"Entity providing access to the custom field","title":"ContractsCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsSettingsAccessProvidedBy"},"ContractsCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsSettingsAccess":{"type":"object","properties":{"provided_by":{"oneOf":[{"$ref":"#/components/schemas/ContractsCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsSettingsAccessProvidedBy"},{"type":"null"}],"description":"Entity providing access to the custom field"},"is_sensitive":{"type":"boolean","description":"Whether the custom field is sensitive"},"group_permission_set":{"type":["string","null"],"description":"Permission set identifier for the custom field"}},"required":["is_sensitive"],"description":"Access settings for the custom field","title":"ContractsCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsSettingsAccess"},"ContractsCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsSettingsWorkerTypesItems":{"type":"string","enum":["eor","contractor","hris_direct_employee","direct_employee"],"title":"ContractsCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsSettingsWorkerTypesItems"},"ContractsCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsSettings":{"type":"object","properties":{"access":{"$ref":"#/components/schemas/ContractsCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsSettingsAccess","description":"Access settings for the custom field"},"required":{"type":"boolean","description":"Whether the custom field is required"},"countries":{"type":"array","items":{"type":"string"},"description":"Countries for which the custom field is applicable. Omitted when applicable to all."},"is_enabled":{"type":"boolean","description":"Whether the custom field is enabled"},"worker_types":{"type":"array","items":{"$ref":"#/components/schemas/ContractsCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsSettingsWorkerTypesItems"},"description":"Worker types for which the custom field is applicable. Omitted when applicable to all."}},"required":["access","required","is_enabled"],"description":"Configuration settings for the custom field including requirements, visibility, and access controls","title":"ContractsCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsSettings"},"ContractsCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsPlacement":{"type":"string","enum":["profile","contract"],"description":"Valid placements for custom field","title":"ContractsCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsPlacement"},"ContractsCustomFieldsGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the custom field"},"name":{"type":"string","description":"Name of the custom field"},"type":{"$ref":"#/components/schemas/ContractsCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsType","description":"Type configuration of the custom field including its data type and type-specific properties"},"settings":{"$ref":"#/components/schemas/ContractsCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsSettings","description":"Configuration settings for the custom field including requirements, visibility, and access controls"},"placement":{"oneOf":[{"$ref":"#/components/schemas/ContractsCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsPlacement"},{"type":"null"}],"description":"Valid placements for custom field"},"created_at":{"type":"string","format":"date-time","description":"Creation date of the custom field"},"description":{"type":["string","null"],"description":"Description of the custom field"}},"required":["id","name","type","settings","created_at"],"title":"ContractsCustomFieldsGetResponsesContentApplicationJsonSchemaDataItems"},"custom-fields-contracts_getContractCustomFields_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ContractsCustomFieldsGetResponsesContentApplicationJsonSchemaDataItems"}}},"required":["data"],"title":"custom-fields-contracts_getContractCustomFields_Response_200"},"ContractsContractIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaDataData0":{"type":"object","properties":{"value":{"type":"string"}},"description":"Text type","title":"ContractsContractIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaDataData0"},"ContractsContractIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaDataData1":{"type":"object","properties":{"value":{"type":"number","format":"double"}},"description":"Number type","title":"ContractsContractIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaDataData1"},"ContractsContractIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaDataData2":{"type":"object","properties":{"value":{"type":"string","format":"date"}},"description":"Date type: YYYY-MM-DD","title":"ContractsContractIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaDataData2"},"ContractsContractIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaDataData3":{"type":"object","properties":{"value":{"type":"number","format":"double"}},"description":"Percentage type","title":"ContractsContractIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaDataData3"},"ContractsContractIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaDataData4":{"type":"object","properties":{"amount":{"type":"number","format":"double"},"currency":{"type":"string","description":"Important: When currency type is fixed, the currency field is ignored. "}},"description":"Currency type","title":"ContractsContractIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaDataData4"},"ContractsContractIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaDataData5":{"type":"object","properties":{"option":{"type":"string"}},"description":"List type","title":"ContractsContractIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaDataData5"},"ContractsContractIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaDataData6":{"type":"object","properties":{"options":{"type":"array","items":{"type":"string"}}},"description":"Multiselect type","title":"ContractsContractIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaDataData6"},"ContractsContractIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaDataData":{"oneOf":[{"$ref":"#/components/schemas/ContractsContractIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaDataData0"},{"$ref":"#/components/schemas/ContractsContractIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaDataData1"},{"$ref":"#/components/schemas/ContractsContractIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaDataData2"},{"$ref":"#/components/schemas/ContractsContractIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaDataData3"},{"$ref":"#/components/schemas/ContractsContractIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaDataData4"},{"$ref":"#/components/schemas/ContractsContractIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaDataData5"},{"$ref":"#/components/schemas/ContractsContractIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaDataData6"}],"title":"ContractsContractIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaDataData"},"ContractsContractIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"UUID for the custom field value"},"data":{"$ref":"#/components/schemas/ContractsContractIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaDataData"}},"required":["id","data"],"title":"ContractsContractIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaData"},"custom-fields-contracts_putContractCustomField_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"custom-fields-contracts_putContractCustomField_Response_200"},"custom-fields-people_deletePersonCustomField_Response_204":{"type":"object","properties":{},"description":"Empty response body","title":"custom-fields-people_deletePersonCustomField_Response_204"},"PeopleCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataTypeOneOf0Name":{"type":"string","enum":["text","number","date","percentage"],"description":"Simple types","title":"PeopleCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataTypeOneOf0Name"},"PeopleCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataType0":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/PeopleCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataTypeOneOf0Name","description":"Simple types"}},"title":"PeopleCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataType0"},"PeopleCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataTypeOneOf1Name":{"type":"string","enum":["currency"],"description":"Currency type","title":"PeopleCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataTypeOneOf1Name"},"PeopleCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataType1":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/PeopleCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataTypeOneOf1Name","description":"Currency type"},"currency":{"type":"string","description":"Currency code"},"is_fixed":{"type":"boolean","description":"When currency is fixed, only the amount can be edited by the users"}},"title":"PeopleCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataType1"},"PeopleCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataTypeOneOf2Name":{"type":"string","enum":["list","multiselect"],"description":"List types","title":"PeopleCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataTypeOneOf2Name"},"PeopleCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataType2":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/PeopleCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataTypeOneOf2Name","description":"List types"},"options":{"type":"array","items":{"type":"string"},"description":"List of options for the custom field"}},"title":"PeopleCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataType2"},"PeopleCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataType":{"oneOf":[{"$ref":"#/components/schemas/PeopleCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataType0"},{"$ref":"#/components/schemas/PeopleCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataType1"},{"$ref":"#/components/schemas/PeopleCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataType2"}],"title":"PeopleCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataType"},"PeopleCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataSettingsAccessProvidedByItems":{"type":"string","enum":["organization","worker"],"title":"PeopleCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataSettingsAccessProvidedByItems"},"PeopleCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataSettingsAccess":{"type":"object","properties":{"provided_by":{"type":"array","items":{"$ref":"#/components/schemas/PeopleCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataSettingsAccessProvidedByItems"},"description":"Entities providing access to the custom field"},"is_sensitive":{"type":"boolean","description":"Whether the custom field is sensitive"}},"description":"Access settings for the custom field","title":"PeopleCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataSettingsAccess"},"PeopleCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataSettingsWorkerTypesItems":{"type":"string","enum":["eor","contractor","hris_direct_employee","direct_employee"],"title":"PeopleCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataSettingsWorkerTypesItems"},"PeopleCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataSettings":{"type":"object","properties":{"access":{"$ref":"#/components/schemas/PeopleCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataSettingsAccess","description":"Access settings for the custom field"},"required":{"type":"boolean","description":"Whether the custom field is required"},"countries":{"type":"array","items":{"type":"string"},"description":"Countries for which the custom field is applicable."},"is_enabled":{"type":"boolean","description":"Whether the custom field is enabled"},"worker_types":{"type":"array","items":{"$ref":"#/components/schemas/PeopleCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataSettingsWorkerTypesItems"},"description":"Worker types for which the custom field is applicable"}},"title":"PeopleCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataSettings"},"PeopleCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataPlacement":{"type":"string","enum":["profile","contract"],"description":"Valid placements for custom field","title":"PeopleCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataPlacement"},"PeopleCustomFieldsIdGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Custom field id"},"name":{"type":"string","description":"Name of the custom field"},"type":{"$ref":"#/components/schemas/PeopleCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataType"},"settings":{"$ref":"#/components/schemas/PeopleCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataSettings"},"placement":{"$ref":"#/components/schemas/PeopleCustomFieldsIdGetResponsesContentApplicationJsonSchemaDataPlacement","description":"Valid placements for custom field"},"created_at":{"type":"string","format":"date","description":"Creation date of the custom field"},"description":{"type":"string","description":"Description of the custom field"}},"title":"PeopleCustomFieldsIdGetResponsesContentApplicationJsonSchemaData"},"custom-fields-people_getPersonCustomField_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PeopleCustomFieldsIdGetResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"custom-fields-people_getPersonCustomField_Response_200"},"PeopleCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsTypeOneOf0Name":{"type":"string","enum":["text","number","date","percentage"],"description":"Simple types","title":"PeopleCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsTypeOneOf0Name"},"PeopleCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsType0":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/PeopleCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsTypeOneOf0Name","description":"Simple types"}},"required":["name"],"title":"PeopleCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsType0"},"PeopleCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsTypeOneOf1Name":{"type":"string","enum":["currency"],"description":"Currency type","title":"PeopleCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsTypeOneOf1Name"},"PeopleCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsType1":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/PeopleCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsTypeOneOf1Name","description":"Currency type"},"currency":{"type":["string","null"],"description":"Currency code"},"is_fixed":{"type":"boolean","description":"When currency is fixed, only the amount can be edited by the users"}},"required":["name","is_fixed"],"title":"PeopleCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsType1"},"PeopleCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsTypeOneOf2Name":{"type":"string","enum":["list","multiselect"],"description":"List types","title":"PeopleCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsTypeOneOf2Name"},"PeopleCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsType2":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/PeopleCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsTypeOneOf2Name","description":"List types"},"options":{"type":"array","items":{"type":"string"},"description":"List of options for the custom field"}},"required":["name","options"],"title":"PeopleCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsType2"},"PeopleCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsType":{"oneOf":[{"$ref":"#/components/schemas/PeopleCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsType0"},{"$ref":"#/components/schemas/PeopleCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsType1"},{"$ref":"#/components/schemas/PeopleCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsType2"}],"description":"Type of the custom field","title":"PeopleCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsType"},"PeopleCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsSettingsAccessProvidedBy":{"type":"string","enum":["organization","worker"],"description":"Entity providing access to the custom field","title":"PeopleCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsSettingsAccessProvidedBy"},"PeopleCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsSettingsAccess":{"type":"object","properties":{"provided_by":{"oneOf":[{"$ref":"#/components/schemas/PeopleCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsSettingsAccessProvidedBy"},{"type":"null"}],"description":"Entity providing access to the custom field"},"is_sensitive":{"type":"boolean","description":"Whether the custom field is sensitive"},"group_permission_set":{"type":["string","null"],"description":"Permission set identifier for the custom field"}},"required":["is_sensitive"],"description":"Access settings for the custom field","title":"PeopleCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsSettingsAccess"},"PeopleCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsSettingsWorkerTypesItems":{"type":"string","enum":["eor","contractor","hris_direct_employee","direct_employee","contractor_outside_deel"],"title":"PeopleCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsSettingsWorkerTypesItems"},"PeopleCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsSettings":{"type":"object","properties":{"access":{"$ref":"#/components/schemas/PeopleCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsSettingsAccess","description":"Access settings for the custom field"},"required":{"type":"boolean","description":"Whether the custom field is required"},"countries":{"type":"array","items":{"type":"string"},"description":"Countries for which the custom field is applicable."},"is_enabled":{"type":"boolean","description":"Whether the custom field is enabled"},"worker_types":{"type":"array","items":{"$ref":"#/components/schemas/PeopleCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsSettingsWorkerTypesItems"},"description":"Worker types for which the custom field is applicable"}},"required":["access","required","is_enabled"],"description":"Settings for the custom field","title":"PeopleCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsSettings"},"PeopleCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsPlacement":{"type":"string","enum":["profile","contract"],"description":"Valid placements for custom field","title":"PeopleCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsPlacement"},"PeopleCustomFieldsGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the custom field"},"name":{"type":"string","description":"Name of the custom field"},"type":{"$ref":"#/components/schemas/PeopleCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsType","description":"Type of the custom field"},"settings":{"$ref":"#/components/schemas/PeopleCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsSettings","description":"Settings for the custom field"},"placement":{"oneOf":[{"$ref":"#/components/schemas/PeopleCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsPlacement"},{"type":"null"}],"description":"Valid placements for custom field"},"created_at":{"type":"string","format":"date-time","description":"Creation date of the custom field"},"description":{"type":["string","null"],"description":"Description of the custom field"}},"title":"PeopleCustomFieldsGetResponsesContentApplicationJsonSchemaDataItems"},"custom-fields-people_getCustomFields_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/PeopleCustomFieldsGetResponsesContentApplicationJsonSchemaDataItems"}}},"required":["data"],"title":"custom-fields-people_getCustomFields_Response_200"},"ListAllPeopleCustomFieldsRequestInternalServerError":{"type":"object","properties":{"message":{"type":"string","description":"Error message"}},"title":"ListAllPeopleCustomFieldsRequestInternalServerError"},"PeopleWorkerIdCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsData0":{"type":"object","properties":{"value":{"type":"string"}},"description":"Text type","title":"PeopleWorkerIdCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsData0"},"PeopleWorkerIdCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsData1":{"type":"object","properties":{"value":{"type":"number","format":"double"}},"description":"Number type","title":"PeopleWorkerIdCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsData1"},"PeopleWorkerIdCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsData2":{"type":"object","properties":{"value":{"type":"string","format":"date"}},"description":"Date type: YYYY-MM-DD","title":"PeopleWorkerIdCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsData2"},"PeopleWorkerIdCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsData3":{"type":"object","properties":{"text":{"type":"string"},"value":{"type":"number","format":"double"}},"description":"Percentage type","title":"PeopleWorkerIdCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsData3"},"PeopleWorkerIdCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsData4":{"type":"object","properties":{"amount":{"type":"number","format":"double"},"currency":{"type":"string","description":"The currency code in ISO 4217 format"}},"description":"Currency type","title":"PeopleWorkerIdCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsData4"},"PeopleWorkerIdCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsData5":{"type":"object","properties":{"option":{"type":"string"}},"description":"List type","title":"PeopleWorkerIdCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsData5"},"PeopleWorkerIdCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsData6":{"type":"object","properties":{"options":{"type":"array","items":{"type":"string"}}},"description":"Multiselect type","title":"PeopleWorkerIdCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsData6"},"PeopleWorkerIdCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsData":{"oneOf":[{"$ref":"#/components/schemas/PeopleWorkerIdCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsData0"},{"$ref":"#/components/schemas/PeopleWorkerIdCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsData1"},{"$ref":"#/components/schemas/PeopleWorkerIdCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsData2"},{"$ref":"#/components/schemas/PeopleWorkerIdCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsData3"},{"$ref":"#/components/schemas/PeopleWorkerIdCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsData4"},{"$ref":"#/components/schemas/PeopleWorkerIdCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsData5"},{"$ref":"#/components/schemas/PeopleWorkerIdCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsData6"}],"title":"PeopleWorkerIdCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsData"},"PeopleWorkerIdCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsType":{"type":"string","enum":["text","number","currency","date","percentage","list","multiselect"],"description":"Type of the custom field","title":"PeopleWorkerIdCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsType"},"PeopleWorkerIdCustomFieldsGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"UUID for the custom field value"},"data":{"$ref":"#/components/schemas/PeopleWorkerIdCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsData"},"name":{"type":"string","description":"Name of the custom field"},"type":{"$ref":"#/components/schemas/PeopleWorkerIdCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsType","description":"Type of the custom field"}},"required":["id","data","name","type"],"title":"PeopleWorkerIdCustomFieldsGetResponsesContentApplicationJsonSchemaDataItems"},"custom-fields-people_getPersonCustomFields_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/PeopleWorkerIdCustomFieldsGetResponsesContentApplicationJsonSchemaDataItems"}}},"required":["data"],"title":"custom-fields-people_getPersonCustomFields_Response_200"},"PeopleWorkerIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaDataData0":{"type":"object","properties":{"value":{"type":"string","description":"Text type"}},"description":"Text type","title":"PeopleWorkerIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaDataData0"},"PeopleWorkerIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaDataData1":{"type":"object","properties":{"value":{"type":"number","format":"double","description":"Number type"}},"description":"Number type","title":"PeopleWorkerIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaDataData1"},"PeopleWorkerIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaDataData2":{"type":"object","properties":{"value":{"type":"string","format":"date","description":"Date type: YYYY-MM-DD"}},"description":"Date type: YYYY-MM-DD","title":"PeopleWorkerIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaDataData2"},"PeopleWorkerIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaDataData3":{"type":"object","properties":{"value":{"type":"number","format":"double","description":"Percentage type"}},"description":"Percentage type","title":"PeopleWorkerIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaDataData3"},"PeopleWorkerIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaDataData4":{"type":"object","properties":{"amount":{"type":"number","format":"double"},"currency":{"type":"string","description":"Important: When currency type is fixed, the currency field is ignored. "}},"description":"Currency type","title":"PeopleWorkerIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaDataData4"},"PeopleWorkerIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaDataData5":{"type":"object","properties":{"option":{"type":"string","description":"Option type"}},"description":"List type","title":"PeopleWorkerIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaDataData5"},"PeopleWorkerIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaDataData6":{"type":"object","properties":{"options":{"type":"array","items":{"type":"string"}}},"description":"Multiselect type","title":"PeopleWorkerIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaDataData6"},"PeopleWorkerIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaDataData":{"oneOf":[{"$ref":"#/components/schemas/PeopleWorkerIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaDataData0"},{"$ref":"#/components/schemas/PeopleWorkerIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaDataData1"},{"$ref":"#/components/schemas/PeopleWorkerIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaDataData2"},{"$ref":"#/components/schemas/PeopleWorkerIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaDataData3"},{"$ref":"#/components/schemas/PeopleWorkerIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaDataData4"},{"$ref":"#/components/schemas/PeopleWorkerIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaDataData5"},{"$ref":"#/components/schemas/PeopleWorkerIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaDataData6"}],"title":"PeopleWorkerIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaDataData"},"PeopleWorkerIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"UUID for the custom field value"},"data":{"$ref":"#/components/schemas/PeopleWorkerIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaDataData"}},"required":["id","data"],"title":"PeopleWorkerIdCustomFieldsPutRequestBodyContentApplicationJsonSchemaData"},"custom-fields-people_putPersonCustomField_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"custom-fields-people_putPersonCustomField_Response_200"},"HrisOrganizationStructuresPostRequestBodyContentApplicationJsonSchemaDataTeamsItems":{"type":"object","properties":{"name":{"type":"string","description":"The name of the team."},"external_id":{"type":"string","description":"The external identifier of the team."}},"title":"HrisOrganizationStructuresPostRequestBodyContentApplicationJsonSchemaDataTeamsItems"},"HrisOrganizationStructuresPostRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"name":{"type":"string","description":"The name of the organization structure."},"teams":{"type":"array","items":{"$ref":"#/components/schemas/HrisOrganizationStructuresPostRequestBodyContentApplicationJsonSchemaDataTeamsItems"}},"external_id":{"type":"string","description":"The external identifier of the organization structure."},"enable_roles":{"type":"boolean","default":true,"description":"Whether roles are enabled for the organization structure."},"is_multiple_select":{"type":"boolean","default":true,"description":"Whether multiple selection is enabled for the organization structure."}},"title":"HrisOrganizationStructuresPostRequestBodyContentApplicationJsonSchemaData"},"HrisOrganizationStructuresPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the organization structure."},"name":{"type":"string","description":"The name of the organization structure."},"type":{"type":"string","description":"The type of the organization structure."},"created_at":{"type":"string","format":"date-time","description":"The date and time when the organization structure was created."},"updated_at":{"type":"string","format":"date-time","description":"The date and time when the organization structure was last updated."},"external_id":{"type":"string","description":"The external identifier of the organization structure."},"enable_roles":{"type":"boolean","description":"Whether roles are enabled for the organization structure."},"is_multi_select":{"type":"boolean","description":"Whether multiple selection is enabled for the organization structure."},"organization_id":{"type":"integer","description":"The unique identifier of the organization."}},"title":"HrisOrganizationStructuresPostResponsesContentApplicationJsonSchemaData"},"organization-structure_createOrganizationStructure_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/HrisOrganizationStructuresPostResponsesContentApplicationJsonSchemaData"}},"title":"organization-structure_createOrganizationStructure_Response_200"},"organization-structure_deleteOrganizationStructureByExternalId_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"organization-structure_deleteOrganizationStructureByExternalId_Response_200"},"HrisOrganizationStructuresExternalExternalIdGetResponsesContentApplicationJsonSchemaDataRolesItems":{"type":"object","properties":{"id":{"type":"integer","description":"Role ID"},"name":{"type":"string","description":"Role name"}},"title":"HrisOrganizationStructuresExternalExternalIdGetResponsesContentApplicationJsonSchemaDataRolesItems"},"HrisOrganizationStructuresExternalExternalIdGetResponsesContentApplicationJsonSchemaDataTeamsItems":{"type":"object","properties":{},"title":"HrisOrganizationStructuresExternalExternalIdGetResponsesContentApplicationJsonSchemaDataTeamsItems"},"HrisOrganizationStructuresExternalExternalIdGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Organization ID"},"name":{"type":"string","description":"Organization name"},"type":{"type":"string","description":"Organization type"},"roles":{"type":"array","items":{"$ref":"#/components/schemas/HrisOrganizationStructuresExternalExternalIdGetResponsesContentApplicationJsonSchemaDataRolesItems"}},"teams":{"type":"array","items":{"$ref":"#/components/schemas/HrisOrganizationStructuresExternalExternalIdGetResponsesContentApplicationJsonSchemaDataTeamsItems"}},"external_id":{"type":"string","description":"External ID"},"teams_count":{"type":"integer","description":"Number of teams in the organization"},"enable_roles":{"type":"boolean","description":"Flag to enable roles in the organization"},"is_multiselect":{"type":"boolean","description":"Flag to enable multiselect in the organization"}},"title":"HrisOrganizationStructuresExternalExternalIdGetResponsesContentApplicationJsonSchemaData"},"organization-structure_getOrganizationStructureByExternalId_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/HrisOrganizationStructuresExternalExternalIdGetResponsesContentApplicationJsonSchemaData"}},"title":"organization-structure_getOrganizationStructureByExternalId_Response_200"},"HrisOrganizationStructuresGetResponsesContentApplicationJsonSchemaDataItemsRolesItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the Role."},"name":{"type":"string","description":"The name of the Role."}},"title":"HrisOrganizationStructuresGetResponsesContentApplicationJsonSchemaDataItemsRolesItems"},"HrisOrganizationStructuresGetResponsesContentApplicationJsonSchemaDataItemsTeamsItemsChildrenItems":{"type":"object","properties":{},"title":"HrisOrganizationStructuresGetResponsesContentApplicationJsonSchemaDataItemsTeamsItemsChildrenItems"},"HrisOrganizationStructuresGetResponsesContentApplicationJsonSchemaDataItemsTeamsItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the Team."},"name":{"type":"string","description":"The name of the Team."},"parent":{"type":["string","null"],"description":"The name of the parent Org Structure."},"children":{"type":"array","items":{"$ref":"#/components/schemas/HrisOrganizationStructuresGetResponsesContentApplicationJsonSchemaDataItemsTeamsItemsChildrenItems"}},"created_at":{"type":"string","format":"date-time","description":"The date and time when the Org Structure was created."},"name_route":{"type":["string","null"],"description":"The route name of the Team."},"external_id":{"type":["string","null"],"description":"The external identifier of the Team."}},"title":"HrisOrganizationStructuresGetResponsesContentApplicationJsonSchemaDataItemsTeamsItems"},"HrisOrganizationStructuresGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the Org Structure."},"name":{"type":"string","description":"The name of the Org Structure."},"type":{"type":"string","description":"The type of the Org Structure."},"roles":{"type":"array","items":{"$ref":"#/components/schemas/HrisOrganizationStructuresGetResponsesContentApplicationJsonSchemaDataItemsRolesItems"}},"teams":{"type":"array","items":{"$ref":"#/components/schemas/HrisOrganizationStructuresGetResponsesContentApplicationJsonSchemaDataItemsTeamsItems"}},"created_at":{"type":"string","format":"date-time","description":"The date and time when the Org Structure was created."},"external_id":{"type":["string","null"],"description":"The external identifier of the Org Structure."},"teams_count":{"type":"integer","description":"The number of Teams in the Org Structure."},"enable_roles":{"type":"boolean","description":"Whether the Org Structure has Roles enabled."},"is_multiselect":{"type":"boolean","description":"Whether the Org Structure is multiselect."}},"title":"HrisOrganizationStructuresGetResponsesContentApplicationJsonSchemaDataItems"},"organization-structure_getOrganizationStructures_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/HrisOrganizationStructuresGetResponsesContentApplicationJsonSchemaDataItems"}}},"title":"organization-structure_getOrganizationStructures_Response_200"},"HrisOrganizationStructuresTeamsTeamIdCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsType":{"type":"string","enum":["TEXT","LIST","MULTISELECT","NUMBER","CURRENCY","PERCENTAGE","DATE","NESTED"],"description":"Type of the custom field","title":"HrisOrganizationStructuresTeamsTeamIdCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsType"},"HrisOrganizationStructuresTeamsTeamIdCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsInheritedFrom":{"type":"object","properties":{"team_id":{"type":"string","format":"uuid","description":"Public ID of the parent team from which the value is inherited"},"team_name":{"type":"string","description":"Name of the parent team from which the value is inherited"}},"required":["team_id","team_name"],"description":"Parent team from which the value is inherited. Null if not inherited.","title":"HrisOrganizationStructuresTeamsTeamIdCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsInheritedFrom"},"HrisOrganizationStructuresTeamsTeamIdCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsPendingChangeStatus":{"type":"string","enum":["PENDING","SCHEDULED","COMMITTED","CANCELLED"],"description":"Status of the change request","title":"HrisOrganizationStructuresTeamsTeamIdCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsPendingChangeStatus"},"HrisOrganizationStructuresTeamsTeamIdCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsPendingChangeHrisCustomFieldValueIdsItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Public ID (UUID) of the nested custom field value"},"value":{"type":"string","description":"Value of the nested custom field"},"parent_id":{"type":["string","null"],"format":"uuid","description":"Public ID (UUID) of the parent nested custom field value, if applicable"}},"title":"HrisOrganizationStructuresTeamsTeamIdCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsPendingChangeHrisCustomFieldValueIdsItems"},"HrisOrganizationStructuresTeamsTeamIdCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsPendingChange":{"type":"object","properties":{"value":{"type":["string","null"],"description":"Pending value for the custom field (type depends on field type - can be string, number, array, or null)"},"status":{"$ref":"#/components/schemas/HrisOrganizationStructuresTeamsTeamIdCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsPendingChangeStatus","description":"Status of the change request"},"edited_by":{"type":["string","null"],"description":"Full name of the user who requested the change"},"raw_value":{"type":["string","null"],"description":"Pending raw value for the custom field (type depends on field type - can be string, number, array, or null)"},"requested_at":{"type":["string","null"],"format":"date","description":"Date when the change was requested (YYYY-MM-DD format)"},"is_approvable":{"type":"boolean","description":"Indicates whether the current user can approve this change request"},"effective_date":{"type":["string","null"],"format":"date","description":"Effective date for the change (YYYY-MM-DD format)"},"change_request_id":{"type":"string","format":"uuid","description":"Public ID (UUID) of the change request"},"approval_request_id":{"type":["string","null"],"format":"uuid","description":"Public ID (UUID) of the approval request associated with the change request"},"modification_reason":{"type":["string","null"],"description":"Reason for the modification"},"hris_custom_field_value_ids":{"type":["array","null"],"items":{"$ref":"#/components/schemas/HrisOrganizationStructuresTeamsTeamIdCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsPendingChangeHrisCustomFieldValueIdsItems"},"description":"Array of nested custom field value IDs (for NESTED type fields)"},"modification_reason_additional_info":{"type":["string","null"],"description":"Additional information about the modification reason"}},"required":["value","status","raw_value","is_approvable","change_request_id"],"description":"Pending change request information (only included if user has 'data_change_request.view' permission)","title":"HrisOrganizationStructuresTeamsTeamIdCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsPendingChange"},"HrisOrganizationStructuresTeamsTeamIdCustomFieldsGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Public ID (UUID) of the custom field"},"name":{"type":"string","description":"Name of the custom field"},"type":{"$ref":"#/components/schemas/HrisOrganizationStructuresTeamsTeamIdCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsType","description":"Type of the custom field"},"value":{"type":["string","null"],"description":"Formatted value of the custom field. Null if no value is set."},"values":{"type":"array","items":{"type":"string"},"description":"Available options for LIST or MULTISELECT type custom fields"},"currency":{"type":"string","description":"Currency code for CURRENCY type custom fields"},"raw_value":{"type":["string","null"],"description":"Raw/unformatted value. Null if no value is set."},"created_at":{"type":"string","format":"date-time","description":"ISO 8601 timestamp when the resource was created"},"updated_at":{"type":"string","format":"date-time","description":"ISO 8601 timestamp when the resource was last updated"},"is_editable":{"type":"boolean","description":"Indicates whether the custom field value can be edited"},"is_required":{"type":"boolean","description":"Indicates whether the custom field is required"},"is_inherited":{"type":"boolean","description":"Indicates whether the value is inherited from a parent team"},"inherited_from":{"oneOf":[{"$ref":"#/components/schemas/HrisOrganizationStructuresTeamsTeamIdCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsInheritedFrom"},{"type":"null"}],"description":"Parent team from which the value is inherited. Null if not inherited."},"pending_change":{"oneOf":[{"$ref":"#/components/schemas/HrisOrganizationStructuresTeamsTeamIdCustomFieldsGetResponsesContentApplicationJsonSchemaDataItemsPendingChange"},{"type":"null"}],"description":"Pending change request information (only included if user has 'data_change_request.view' permission)"}},"required":["id","name","type","value","raw_value","created_at","updated_at","is_inherited","inherited_from"],"title":"HrisOrganizationStructuresTeamsTeamIdCustomFieldsGetResponsesContentApplicationJsonSchemaDataItems"},"organization-structure_getTeamCustomFields_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/HrisOrganizationStructuresTeamsTeamIdCustomFieldsGetResponsesContentApplicationJsonSchemaDataItems"},"description":"Array of custom field values for the organization structure team"},"has_more":{"type":"boolean","description":"Whether more pages are available"},"next_cursor":{"type":["string","null"],"description":"Opaque cursor for the next page. Null if no more pages."},"total_count":{"type":"integer","description":"Total number of custom field values (across all pages)"}},"required":["data","has_more","next_cursor","total_count"],"title":"organization-structure_getTeamCustomFields_Response_200"},"HrisOrganizationStructuresTeamsTeamIdCustomFieldsGetResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string","description":"Error code identifying the type of error"},"field":{"type":"string","description":"The field name that caused the error, if applicable"},"message":{"type":"string","description":"Human-readable error message"}},"required":["code","message"],"title":"HrisOrganizationStructuresTeamsTeamIdCustomFieldsGetResponsesContentApplicationJsonSchemaErrorsItems"},"RetrieveCustomFieldsForOrganizationRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/HrisOrganizationStructuresTeamsTeamIdCustomFieldsGetResponsesContentApplicationJsonSchemaErrorsItems"},"description":"Array of error objects"}},"required":["errors"],"title":"RetrieveCustomFieldsForOrganizationRequestBadRequestError"},"HrisOrganizationStructuresExternalExternalIdPatchRequestBodyContentApplicationJsonSchemaDataTeamsItems":{"type":"object","properties":{},"title":"HrisOrganizationStructuresExternalExternalIdPatchRequestBodyContentApplicationJsonSchemaDataTeamsItems"},"HrisOrganizationStructuresExternalExternalIdPatchRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"name":{"type":"string","description":"Name of the organization"},"teams":{"type":"array","items":{"$ref":"#/components/schemas/HrisOrganizationStructuresExternalExternalIdPatchRequestBodyContentApplicationJsonSchemaDataTeamsItems"}},"external_id":{"type":"string","description":"External ID"},"enable_roles":{"type":"boolean","description":"Enable roles"},"is_multiselect":{"type":"boolean","description":"Is multiselect"}},"required":["teams"],"title":"HrisOrganizationStructuresExternalExternalIdPatchRequestBodyContentApplicationJsonSchemaData"},"organization-structure_updateOrganizationStructureByExternalId_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"organization-structure_updateOrganizationStructureByExternalId_Response_200"},"PeopleIdDepartmentPutRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"department_id":{"type":"string","format":"uuid","description":"Unique identifier of this resource."},"effective_date":{"type":"string","format":"date","description":"Effective date in YYYY-MM-DD format."}},"required":["department_id"],"title":"PeopleIdDepartmentPutRequestBodyContentApplicationJsonSchemaData"},"PeopleIdDepartmentPutResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"updated":{"type":"boolean","description":"Indicates if the resource was updated successfully."}},"required":["updated"],"title":"PeopleIdDepartmentPutResponsesContentApplicationJsonSchemaData"},"organization-structure_updatePersonDepartment_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PeopleIdDepartmentPutResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"organization-structure_updatePersonDepartment_Response_200"},"HrisOrganizationStructuresTeamsTeamIdCustomFieldsPatchRequestBodyContentApplicationJsonSchemaDataEditReason":{"type":"object","properties":{"reason_oid":{"type":"string","format":"uuid","description":"The public ID (UUID) of the modification reason"},"effective_date":{"type":["string","null"],"format":"date","description":"Effective date for the modification reason"},"additional_info":{"type":["string","null"],"description":"Additional information about the modification reason"}},"description":"Optional reason for the modification","title":"HrisOrganizationStructuresTeamsTeamIdCustomFieldsPatchRequestBodyContentApplicationJsonSchemaDataEditReason"},"HrisOrganizationStructuresTeamsTeamIdCustomFieldsPatchRequestBodyContentApplicationJsonSchemaDataCustomFieldsItems":{"type":"object","properties":{"value":{"type":["string","null"],"description":"The value for the custom field. Use null to delete."},"currency":{"type":["string","null"],"description":"Currency code for currency-type custom fields (ISO 4217)"},"effective_date":{"type":["string","null"],"format":"date","description":"Optional effective date for scheduled changes (YYYY-MM-DD)"},"custom_field_id":{"type":"string","format":"uuid","description":"The public ID (UUID) of the custom field"}},"required":["custom_field_id"],"title":"HrisOrganizationStructuresTeamsTeamIdCustomFieldsPatchRequestBodyContentApplicationJsonSchemaDataCustomFieldsItems"},"HrisOrganizationStructuresTeamsTeamIdCustomFieldsPatchRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"edit_reason":{"oneOf":[{"$ref":"#/components/schemas/HrisOrganizationStructuresTeamsTeamIdCustomFieldsPatchRequestBodyContentApplicationJsonSchemaDataEditReason"},{"type":"null"}],"description":"Optional reason for the modification"},"custom_fields":{"type":"array","items":{"$ref":"#/components/schemas/HrisOrganizationStructuresTeamsTeamIdCustomFieldsPatchRequestBodyContentApplicationJsonSchemaDataCustomFieldsItems"},"description":"Array of custom field values to update. Set value to null to delete a custom field."}},"required":["custom_fields"],"title":"HrisOrganizationStructuresTeamsTeamIdCustomFieldsPatchRequestBodyContentApplicationJsonSchemaData"},"HrisOrganizationStructuresTeamsTeamIdCustomFieldsPatchResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"System-generated ID of the resource"},"message":{"type":"string","description":"Success message"},"created_at":{"type":"string","format":"date-time","description":"Timestamp when the resource was created"}},"required":["id","message","created_at"],"title":"HrisOrganizationStructuresTeamsTeamIdCustomFieldsPatchResponsesContentApplicationJsonSchemaData"},"organization-structure_updateTeamCustomFields_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/HrisOrganizationStructuresTeamsTeamIdCustomFieldsPatchResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"organization-structure_updateTeamCustomFields_Response_200"},"HrisOrganizationStructuresTeamsTeamIdCustomFieldsPatchResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string","description":"Error code identifying the type of error"},"field":{"type":"string","description":"The field name that caused the error, if applicable"},"message":{"type":"string","description":"Human-readable error message"}},"required":["code","message"],"title":"HrisOrganizationStructuresTeamsTeamIdCustomFieldsPatchResponsesContentApplicationJsonSchemaErrorsItems"},"UpdateOrganizationStructureTeamCustomFieldsRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/HrisOrganizationStructuresTeamsTeamIdCustomFieldsPatchResponsesContentApplicationJsonSchemaErrorsItems"},"description":"Array of error objects"}},"required":["errors"],"title":"UpdateOrganizationStructureTeamCustomFieldsRequestBadRequestError"},"PwacPostRequestBodyContentApplicationJsonSchemaDataClientTeam":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The team that the person is part of"},"direct_manager_id":{"type":"string","format":"uuid","description":"The direct manager of the person"},"direct_reports_ids":{"type":"array","items":{"type":"string","format":"uuid"},"description":"The direct reports of the person"}},"required":["id"],"title":"PwacPostRequestBodyContentApplicationJsonSchemaDataClientTeam"},"PwacPostRequestBodyContentApplicationJsonSchemaDataClientDepartment":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The department that the person is part of"}},"required":["id"],"title":"PwacPostRequestBodyContentApplicationJsonSchemaDataClientDepartment"},"PwacPostRequestBodyContentApplicationJsonSchemaDataClientLegalEntity":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The legal entity that the person is part of"}},"required":["id"],"title":"PwacPostRequestBodyContentApplicationJsonSchemaDataClientLegalEntity"},"PwacPostRequestBodyContentApplicationJsonSchemaDataClient":{"type":"object","properties":{"team":{"$ref":"#/components/schemas/PwacPostRequestBodyContentApplicationJsonSchemaDataClientTeam"},"department":{"$ref":"#/components/schemas/PwacPostRequestBodyContentApplicationJsonSchemaDataClientDepartment"},"legal_entity":{"$ref":"#/components/schemas/PwacPostRequestBodyContentApplicationJsonSchemaDataClientLegalEntity"}},"required":["team","legal_entity"],"title":"PwacPostRequestBodyContentApplicationJsonSchemaDataClient"},"PwacPostRequestBodyContentApplicationJsonSchemaDataPerson":{"type":"object","properties":{"email":{"type":"string","format":"email","description":"The personal email of the person being hired"},"state":{"type":"string","description":"The state of the person being hired"},"country":{"type":"string","description":"The country of the person being hired"},"end_date":{"type":"string","format":"date","description":"The end date of the person being hired"},"job_title":{"type":"string","description":"The job title of the person being hired"},"last_name":{"type":"string","description":"The last name of the person being hired"},"seniority":{"type":"string","description":"The seniority of the person being hired"},"first_name":{"type":"string","description":"The first name of the person being hired"},"start_date":{"type":"string","format":"date","description":"The start date of the person being hired"},"work_email":{"type":"string","format":"email","description":"The work email of the person being hired"},"external_id":{"type":"string","description":"An external identifier for the person being hired"},"nationality":{"type":"string","description":"The nationality of the person being hired"},"preferred_last_name":{"type":"string","description":"The preferred last name of the person being hired"},"preferred_first_name":{"type":"string","description":"The preferred first name of the person being hired"}},"required":["email","last_name","first_name","start_date"],"description":"The person that is being hired","title":"PwacPostRequestBodyContentApplicationJsonSchemaDataPerson"},"PwacPostRequestBodyContentApplicationJsonSchemaDataInvitationAction":{"type":"string","enum":["DISABLE","IMMEDIATE"],"description":"Controls whether to send an invitation email.","title":"PwacPostRequestBodyContentApplicationJsonSchemaDataInvitationAction"},"PwacPostRequestBodyContentApplicationJsonSchemaDataInvitation":{"type":"object","properties":{"action":{"$ref":"#/components/schemas/PwacPostRequestBodyContentApplicationJsonSchemaDataInvitationAction","description":"Controls whether to send an invitation email."}},"description":"Optional invitation configuration for the new hire. Defaults to 'disable' if not provided.","title":"PwacPostRequestBodyContentApplicationJsonSchemaDataInvitation"},"PwacPostRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"client":{"$ref":"#/components/schemas/PwacPostRequestBodyContentApplicationJsonSchemaDataClient"},"person":{"$ref":"#/components/schemas/PwacPostRequestBodyContentApplicationJsonSchemaDataPerson","description":"The person that is being hired"},"invitation":{"$ref":"#/components/schemas/PwacPostRequestBodyContentApplicationJsonSchemaDataInvitation","description":"Optional invitation configuration for the new hire. Defaults to 'disable' if not provided."}},"required":["client","person"],"title":"PwacPostRequestBodyContentApplicationJsonSchemaData"},"PwacPostResponsesContentApplicationJsonSchemaDataPerson":{"type":"object","properties":{"email":{"type":"string","format":"email","description":"The personal email of the person being hired"},"state":{"type":"string","description":"The state of the person being hired"},"country":{"type":"string","description":"The country of the person being hired"},"end_date":{"type":["string","null"],"format":"date","description":"The end date of the person being hired"},"job_title":{"type":"string","description":"The job title of the person being hired"},"last_name":{"type":"string","description":"The last name of the person being hired"},"seniority":{"type":"string","description":"The seniority of the person being hired"},"worker_id":{"type":"number","format":"double","description":"The worker ID of the person being hired"},"first_name":{"type":"string","description":"The first name of the person being hired"},"start_date":{"type":"string","format":"date","description":"The start date of the person being hired"},"work_email":{"type":"string","format":"email","description":"The work email of the person being hired"},"external_id":{"type":["string","null"],"description":"An external identifier for the person being hired"},"nationality":{"type":"string","description":"The nationality of the person being hired"}},"required":["email","last_name","first_name","start_date"],"description":"The person that is being hired","title":"PwacPostResponsesContentApplicationJsonSchemaDataPerson"},"PwacPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The id of the person"},"person":{"$ref":"#/components/schemas/PwacPostResponsesContentApplicationJsonSchemaDataPerson","description":"The person that is being hired"}},"required":["id","person"],"title":"PwacPostResponsesContentApplicationJsonSchemaData"},"people_createPersonWithoutContract_Response_201":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PwacPostResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"people_createPersonWithoutContract_Response_201"},"PwacPostResponsesContentApplicationJsonSchemaError":{"type":"object","properties":{"code":{"type":"string","description":"Error code identifying the type of error"},"message":{"type":"string","description":"Human readable error message"}},"required":["code","message"],"title":"PwacPostResponsesContentApplicationJsonSchemaError"},"CreateAPersonWithoutAContract-v2026-01-01RequestBadRequestError":{"type":"object","properties":{"error":{"$ref":"#/components/schemas/PwacPostResponsesContentApplicationJsonSchemaError"}},"required":["error"],"title":"CreateAPersonWithoutAContract-v2026-01-01RequestBadRequestError"},"CreateAPersonWithoutAContract-v2026-01-01RequestInternalServerError":{"type":"object","properties":{"error":{"$ref":"#/components/schemas/PwacPostResponsesContentApplicationJsonSchemaError"}},"required":["error"],"title":"CreateAPersonWithoutAContract-v2026-01-01RequestInternalServerError"},"PeopleGetParametersFieldsSchemaItems":{"type":"string","enum":["id","first_name","last_name","full_name","display_name","preferred_name","preferred_first_name","preferred_last_name","personal_id","country","country_name","state","email","personal_email","work_email","phoneNumbers","nationalities","personal_address","addresses","pic_url","birth_date","nestedCustomFields","start_date","hris_original_start_date","worker_id","external_id","direct_reports","direct_reports_count","direct_manager","work_location","custom_fields","new_hiring_status","hiring_status","job_title","seniority","custom_field_values","worker_relations","timezone","employments","employments[0].id","employments[0].name","employments[0].start_date","employments[0].job_title","employments[0].hiring_status","employments[0].new_hiring_status","employments[0].seniority","employments[0].email","employments[0].work_email","employments[0].employee_number","employments[0].hiring_type","employments[0].team","employments[0].timezone","employments[0].client_legal_entity","employments[0].payment","employments[0].country","employments[0].state","employments[0].contract_status","employments[0].contract_type","employments[0].hris_service_provider","employments[0].hris_direct_employee_invitation","employments[0].voluntarily_left","employments[0].has_eor_termination","employments[0].contract_is_archived","employments[0].completion_date","employments[0].contract_has_contractor","employments[0].is_ended","employments[0].is_user_contract_deleted","employments[0].contract_coverage","employments[0].currency","employments[0].is_amending","employments[0].client_legal_entity_id","employments[0].is_eor_consultant_contract","employments[0].is_interview_process_required","employments[0].contract_timezone","employments[0].amendment_status","employments[0].pay_date","employments[0].termination_last_day","employments[0].custom_field_values","employments[0].hris_is_active","employments[0].isPrimary","employments[0].compensation_band_id","employments[0].band_placement","employments[0].comparative_ratio","direct_employee_termination_state","is_user_contract_deleted","orgStructures","ooo","is_ended","hris_service_provider","contract_types","contract_coverage","payments","pay_date","nextPayment","lastPayment","hourly_report_total","monthly_payment","hris_is_active","department","currency","contract_is_archived","termination_last_day","completion_date","hiring_type","worker_entity_name","client_legal_entity","parent_relations","child_relations","worker_termination_last_date_of_work","active_worker_termination_status","org_structures"],"title":"PeopleGetParametersFieldsSchemaItems"},"PeopleGetParametersSortBy":{"type":"string","enum":["id","first_name","last_name","full_name","email","country","birth_date","hiring_type","start_date","team","job_title","hiring_status","completion_date","direct_manager","direct_reports_count","band_placement","comparative_ratio"],"title":"PeopleGetParametersSortBy"},"PeopleGetParametersSortOrder":{"type":"string","enum":["asc","desc"],"title":"PeopleGetParametersSortOrder"},"PeopleGetParametersHiringStatusesSchemaItems":{"type":"string","enum":["pending_invite","draft","invited","onboarding","onboarding_at_risk","onboarding_overdue","onboarded","offboarding","active","inactive","in_review","quote_requires_changes"],"title":"PeopleGetParametersHiringStatusesSchemaItems"},"PeopleGetParametersBandPlacementsSchemaItems":{"type":"string","enum":["ABOVE","WITHIN","BELOW"],"title":"PeopleGetParametersBandPlacementsSchemaItems"},"PeopleGetParametersHiringTypesSchemaItems":{"type":"string","enum":["contractor","eor","peo","hris_direct_employee","hris_direct_contractor","direct_employee","contractor_outside_deel","person_without_contract"],"title":"PeopleGetParametersHiringTypesSchemaItems"},"PeopleGetParametersPersonStatusesSchemaItems":{"type":"string","enum":["ACTIVE","OFFBOARDING","NOT_STARTED","INACTIVE"],"title":"PeopleGetParametersPersonStatusesSchemaItems"},"PeopleGetResponsesContentApplicationJsonSchemaDataItemsEmailsItems":{"type":"object","properties":{"type":{"type":["string","null"],"description":"The type of email."},"value":{"type":["string","null"],"description":"The email address."}},"title":"PeopleGetResponsesContentApplicationJsonSchemaDataItemsEmailsItems"},"PeopleGetResponsesContentApplicationJsonSchemaDataItemsAddressesItems":{"type":"object","properties":{"region":{"type":"string","description":"Region code."},"country":{"type":["string","null"],"description":"Country code."},"locality":{"type":"string","description":"Locality name."},"postalCode":{"type":"string","description":"Postal code."},"streetAddress":{"type":"string","description":"Street and number."}},"title":"PeopleGetResponsesContentApplicationJsonSchemaDataItemsAddressesItems"},"PeopleGetResponsesContentApplicationJsonSchemaDataItemsDepartment":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of this resource."},"name":{"type":"string","description":"The name of the department."},"parent":{"type":"string","description":"The parent department name."}},"description":"The department of the employee.","title":"PeopleGetResponsesContentApplicationJsonSchemaDataItemsDepartment"},"PeopleGetResponsesContentApplicationJsonSchemaDataItemsEmploymentsItemsTeam":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Refers to Groups in the platform. Working groups that reflect the organization's structure."},"name":{"type":"string","description":"The team name."}},"description":"The team to which the employee belongs.","title":"PeopleGetResponsesContentApplicationJsonSchemaDataItemsEmploymentsItemsTeam"},"PeopleGetResponsesContentApplicationJsonSchemaDataItemsEmploymentsItemsPayment":{"type":"object","properties":{"rate":{"type":["number","null"],"format":"double","description":"The payment rate"},"scale":{"type":["string","null"],"description":"The payment scale (e.g., hourly, weekly, monthly, etc.)"},"currency":{"type":"string","description":"The currency code (ISO 4217) for the payment"},"contract_name":{"type":"string","description":"The name of the contract associated with the payment"}},"description":"Payment information for the employment, including rate, scale, currency, and associated contract name.","title":"PeopleGetResponsesContentApplicationJsonSchemaDataItemsEmploymentsItemsPayment"},"PeopleGetResponsesContentApplicationJsonSchemaDataItemsEmploymentsItemsBandPlacement":{"type":"string","enum":["ABOVE","WITHIN","BELOW"],"description":"Where the employee falls in their compensation band","title":"PeopleGetResponsesContentApplicationJsonSchemaDataItemsEmploymentsItemsBandPlacement"},"PeopleGetResponsesContentApplicationJsonSchemaDataItemsEmploymentsItemsContractCoverage":{"type":"string","enum":["is_premium","is_shielded","no_coverage"],"description":"The coverage of the employment contract.","title":"PeopleGetResponsesContentApplicationJsonSchemaDataItemsEmploymentsItemsContractCoverage"},"PeopleGetResponsesContentApplicationJsonSchemaDataItemsEmploymentsItemsClientLegalEntity":{"type":"object","properties":{"id":{"type":["string","null"],"format":"uuid","description":"Unique identifier of this resource."},"name":{"type":["string","null"],"description":"The name of the client legal entity."}},"description":"The client legal entity associated with this employment contract.","title":"PeopleGetResponsesContentApplicationJsonSchemaDataItemsEmploymentsItemsClientLegalEntity"},"PeopleGetResponsesContentApplicationJsonSchemaDataItemsEmploymentsItemsHrisDirectEmployeeInvitation":{"type":"object","properties":{"oid":{"type":"string","description":"Unique identifier of this resource."},"status":{"type":["string","null"],"description":"The HRIS direct employee invitation status."},"send_at":{"type":["string","null"],"format":"date-time","description":"The HRIS direct employee invitation send date."},"timezone":{"type":["string","null"],"description":"The HRIS direct employee invitation timezone."}},"description":"The HRIS direct employee invitation status.","title":"PeopleGetResponsesContentApplicationJsonSchemaDataItemsEmploymentsItemsHrisDirectEmployeeInvitation"},"PeopleGetResponsesContentApplicationJsonSchemaDataItemsEmploymentsItems":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the employment."},"name":{"type":"string","description":"Name of the employee."},"team":{"$ref":"#/components/schemas/PeopleGetResponsesContentApplicationJsonSchemaDataItemsEmploymentsItemsTeam","description":"The team to which the employee belongs."},"email":{"type":"string","description":"The work email of the employee."},"state":{"type":["string","null"],"description":"The state of employment."},"country":{"type":["string","null"],"description":"The country of employment."},"payment":{"$ref":"#/components/schemas/PeopleGetResponsesContentApplicationJsonSchemaDataItemsEmploymentsItemsPayment","description":"Payment information for the employment, including rate, scale, currency, and associated contract name."},"is_ended":{"type":"boolean","description":"Whether the employment has ended."},"timezone":{"type":["string","null"],"description":"The timezone of the employment."},"job_title":{"type":["string","null"],"description":"The job title of the employment."},"seniority":{"type":["string","null"],"description":"The seniority level of the employment."},"start_date":{"type":["string","null"],"format":"date","description":"The start date of the employment."},"work_email":{"type":["string","null"],"description":"The work email of the employment."},"hiring_type":{"type":["string","null"],"description":"The type of hiring of the employment."},"hiring_status":{"type":"string","description":"The current hiring status of the employment."},"band_placement":{"oneOf":[{"$ref":"#/components/schemas/PeopleGetResponsesContentApplicationJsonSchemaDataItemsEmploymentsItemsBandPlacement"},{"type":"null"}],"description":"Where the employee falls in their compensation band"},"completion_date":{"type":["string","null"],"description":"The completion date of the employment contract."},"contract_status":{"type":"string","description":"The status of the employment contract."},"voluntarily_left":{"type":["boolean","null"],"description":"Whether the employee voluntarily left the employment."},"comparative_ratio":{"type":["number","null"],"format":"double","description":"Number comparing an employee's compensation to the band midpoint"},"contract_coverage":{"oneOf":[{"$ref":"#/components/schemas/PeopleGetResponsesContentApplicationJsonSchemaDataItemsEmploymentsItemsContractCoverage"},{"type":"null"}],"description":"The coverage of the employment contract."},"new_hiring_status":{"type":["string","null"],"description":"The new hiring status of the employment."},"client_legal_entity":{"$ref":"#/components/schemas/PeopleGetResponsesContentApplicationJsonSchemaDataItemsEmploymentsItemsClientLegalEntity","description":"The client legal entity associated with this employment contract."},"has_eor_termination":{"type":["boolean","null"],"description":"Whether the employment has an EOR termination."},"compensation_band_id":{"type":["string","null"],"description":"The employee's assigned compensation band"},"contract_is_archived":{"type":"boolean","description":"Whether the employment contract is archived."},"termination_last_day":{"type":["string","null"],"format":"date-time","description":"The last day of work mentioned on the contract termination."},"contract_has_contractor":{"type":"boolean","description":"Whether the contract has a contractor."},"is_user_contract_deleted":{"type":"boolean","description":"Whether the user contract is deleted."},"hris_direct_employee_invitation":{"oneOf":[{"$ref":"#/components/schemas/PeopleGetResponsesContentApplicationJsonSchemaDataItemsEmploymentsItemsHrisDirectEmployeeInvitation"},{"type":"null"}],"description":"The HRIS direct employee invitation status."}},"title":"PeopleGetResponsesContentApplicationJsonSchemaDataItemsEmploymentsItems"},"PeopleGetResponsesContentApplicationJsonSchemaDataItemsPersonStatus":{"type":"string","enum":["ACTIVE","OFFBOARDING","NOT_STARTED","INACTIVE"],"description":"Lifecycle status of the person (worker profile). Omitted or null without people_person_status.view; excluded from the response when using `fields` if not requested.","title":"PeopleGetResponsesContentApplicationJsonSchemaDataItemsPersonStatus"},"PeopleGetResponsesContentApplicationJsonSchemaDataItemsDirectManager":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the manager."},"last_name":{"type":"string","description":"The last name of the manager."},"worker_id":{"type":"number","format":"double","description":"The worker ID of the manager."},"first_name":{"type":"string","description":"The first name of the manager."},"work_email":{"type":["string","null"],"description":"The work email of the manager."}},"description":"The direct manager of the employee.","title":"PeopleGetResponsesContentApplicationJsonSchemaDataItemsDirectManager"},"PeopleGetResponsesContentApplicationJsonSchemaDataItemsDirectReportsItems":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the direct report."},"last_name":{"type":"string","description":"The last name of the direct report."},"first_name":{"type":"string","description":"The first name of the direct report."},"work_email":{"type":["string","null"],"description":"The work email of the direct report."}},"title":"PeopleGetResponsesContentApplicationJsonSchemaDataItemsDirectReportsItems"},"PeopleGetResponsesContentApplicationJsonSchemaDataItemsClientLegalEntity":{"type":"object","properties":{"id":{"type":["string","null"],"format":"uuid","description":"Unique identifier of this resource."},"name":{"type":["string","null"],"description":"The name of the client legal entity."}},"description":"The primary client legal entity associated with the employee.","title":"PeopleGetResponsesContentApplicationJsonSchemaDataItemsClientLegalEntity"},"PeopleGetResponsesContentApplicationJsonSchemaDataItemsActiveWorkerTerminationStatus":{"type":"string","enum":["PENDING","CONTRACT_TERMINATION_DATA_COLLECTED","IN_PROGRESS","COMPLETED","FAILED","CANCELED"],"description":"The status of the active worker termination.","title":"PeopleGetResponsesContentApplicationJsonSchemaDataItemsActiveWorkerTerminationStatus"},"PeopleGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the employee."},"state":{"type":["string","null"],"description":"The state of the employee."},"emails":{"type":["array","null"],"items":{"$ref":"#/components/schemas/PeopleGetResponsesContentApplicationJsonSchemaDataItemsEmailsItems"},"description":"An array of the employee's email addresses."},"country":{"type":["string","null"],"description":"The country of the employee."},"is_pwac":{"type":"boolean","description":"Whether the worker is a Person Without a Contract (PWAC)"},"timezone":{"type":["string","null"],"description":"The timezone of the employee."},"addresses":{"type":["array","null"],"items":{"$ref":"#/components/schemas/PeopleGetResponsesContentApplicationJsonSchemaDataItemsAddressesItems"},"description":"An array of address objects containing the employee's physical addresses."},"full_name":{"type":"string","description":"The full name of the employee."},"job_title":{"type":["string","null"],"description":"The job title of the employee."},"last_name":{"type":["string","null"],"description":"The last name of the employee."},"seniority":{"type":["string","null"],"description":"The seniority level of the employee."},"worker_id":{"type":"string","description":"The worker ID of the employee."},"birth_date":{"type":["string","null"],"description":"The birth date of the employee."},"created_at":{"type":"string","format":"date-time","description":"The creation timestamp of the employee record."},"department":{"$ref":"#/components/schemas/PeopleGetResponsesContentApplicationJsonSchemaDataItemsDepartment","description":"The department of the employee."},"first_name":{"type":"string","description":"The first name of the employee."},"start_date":{"type":["string","null"],"format":"date","description":"The date the employee started working."},"updated_at":{"type":["string","null"],"format":"date-time","description":"Long date-time format following ISO-8601"},"employments":{"type":["array","null"],"items":{"$ref":"#/components/schemas/PeopleGetResponsesContentApplicationJsonSchemaDataItemsEmploymentsItems"},"description":"An array of employment records associated with the employee, including contract details, team information, payment details, and employment status."},"external_id":{"type":["string","null"],"description":"The external ID of the employee."},"hiring_type":{"type":["string","null"],"description":"The type of hiring of the employee."},"hiring_status":{"type":"string","description":"The current hiring status of the employee."},"nationalities":{"type":"array","items":{"type":"string"},"description":"The nationality of the employee."},"person_status":{"oneOf":[{"$ref":"#/components/schemas/PeopleGetResponsesContentApplicationJsonSchemaDataItemsPersonStatus"},{"type":"null"}],"description":"Lifecycle status of the person (worker profile). Omitted or null without people_person_status.view; excluded from the response when using `fields` if not requested."},"work_location":{"type":["string","null"],"description":"The work location of the employee."},"direct_manager":{"oneOf":[{"$ref":"#/components/schemas/PeopleGetResponsesContentApplicationJsonSchemaDataItemsDirectManager"},{"type":"null"}],"description":"The direct manager of the employee."},"direct_reports":{"type":["array","null"],"items":{"$ref":"#/components/schemas/PeopleGetResponsesContentApplicationJsonSchemaDataItemsDirectReportsItems"},"description":"The direct reports to the employee."},"completion_date":{"type":["string","null"],"description":"The completion date of the task or project."},"new_hiring_status":{"type":["string","null"],"description":"The new hiring status of the employee."},"client_legal_entity":{"$ref":"#/components/schemas/PeopleGetResponsesContentApplicationJsonSchemaDataItemsClientLegalEntity","description":"The primary client legal entity associated with the employee."},"preferred_last_name":{"type":["string","null"],"description":"The preferred last name of the employee."},"direct_reports_count":{"type":"integer","description":"The count of direct reports to the employee."},"preferred_first_name":{"type":["string","null"],"description":"The preferred first name of the employee."},"hris_organization_user_id":{"type":["string","null"],"format":"uuid","description":"HRIS Organization User ID of the employee. Used in products like Deel Engage."},"active_worker_termination_status":{"oneOf":[{"$ref":"#/components/schemas/PeopleGetResponsesContentApplicationJsonSchemaDataItemsActiveWorkerTerminationStatus"},{"type":"null"}],"description":"The status of the active worker termination."},"direct_employee_termination_last_day":{"type":"string","format":"date-time","description":"The last day of work mentioned on the primary contract termination."}},"title":"PeopleGetResponsesContentApplicationJsonSchemaDataItems"},"PeopleGetResponsesContentApplicationJsonSchemaPage":{"type":"object","properties":{"offset":{"type":"integer"},"total_rows":{"type":"number","format":"double"},"items_per_page":{"type":"number","format":"double"}},"required":["offset","total_rows","items_per_page"],"title":"PeopleGetResponsesContentApplicationJsonSchemaPage"},"people_getPeople_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/PeopleGetResponsesContentApplicationJsonSchemaDataItems"}},"page":{"$ref":"#/components/schemas/PeopleGetResponsesContentApplicationJsonSchemaPage"}},"required":["data"],"title":"people_getPeople_Response_200"},"PeopleGetResponsesContentApplicationJsonSchemaError":{"type":"object","properties":{"code":{"type":"string","description":"Error code identifying the type of error."},"details":{"type":["string","null"],"description":"Additional details about the error."},"message":{"type":"string","description":"Error message describing what went wrong."}},"required":["code","message"],"title":"PeopleGetResponsesContentApplicationJsonSchemaError"},"ListOfPeople-v2026-01-01RequestInternalServerError":{"type":"object","properties":{"error":{"$ref":"#/components/schemas/PeopleGetResponsesContentApplicationJsonSchemaError"}},"required":["error"],"title":"ListOfPeople-v2026-01-01RequestInternalServerError"},"PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataEmailsItems":{"type":"object","properties":{"type":{"type":"string","description":"The type of email."},"value":{"type":["string","null"],"description":"The email address."}},"title":"PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataEmailsItems"},"PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataAddressesItems":{"type":"object","properties":{"region":{"type":"string","description":"Region code."},"country":{"type":"string","description":"Country code."},"locality":{"type":"string","description":"Locality name."},"postalCode":{"type":"string","description":"Postal code."},"streetAddress":{"type":"string","description":"Street and number."}},"title":"PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataAddressesItems"},"PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataDepartment":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of this resource."},"name":{"type":"string","description":"The name of the department."},"parent":{"type":"string","description":"The parent department."}},"description":"The department of the employee.","title":"PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataDepartment"},"PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataEmploymentsItemsTeam":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Refers to Groups in the platform. Working groups that reflect the organization's structure."},"name":{"type":"string","description":"The team name."}},"description":"The team to which the employee belongs.","title":"PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataEmploymentsItemsTeam"},"PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataEmploymentsItemsPaymentRate":{"oneOf":[{"type":"string"},{"type":"number","format":"double"}],"description":"The payment rate. Value is a string if contract type is PEO.","title":"PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataEmploymentsItemsPaymentRate"},"PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataEmploymentsItemsPayment":{"type":"object","properties":{"rate":{"$ref":"#/components/schemas/PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataEmploymentsItemsPaymentRate","description":"The payment rate. Value is a string if contract type is PEO."},"scale":{"type":["string","null"],"description":"The payment scale (e.g., hourly, weekly, monthly, etc.)"},"currency":{"type":"string","description":"The currency code (ISO 4217) for the payment"},"contract_name":{"type":"string","description":"The name of the contract associated with the payment"}},"description":"Payment information for the employment, including rate, scale, currency, and associated contract name.","title":"PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataEmploymentsItemsPayment"},"PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataEmploymentsItemsContractCoverage":{"type":"string","enum":["is_shielded","is_premium"],"description":"The coverage type of the employment contract. 'is_shielded' = Contractor of Record, 'is_premium' = Premium, null = Standard (no coverage).","title":"PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataEmploymentsItemsContractCoverage"},"PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataEmploymentsItemsClientLegalEntity":{"type":"object","properties":{"id":{"type":["string","null"],"format":"uuid","description":"Unique identifier of this resource."},"name":{"type":["string","null"],"description":"The name of the client legal entity."}},"description":"The client legal entity associated with this employment contract.","title":"PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataEmploymentsItemsClientLegalEntity"},"PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataEmploymentsItemsHrisDirectEmployeeInvitation":{"type":"object","properties":{"oid":{"type":"string","description":"Unique identifier of this resource."},"status":{"type":["string","null"],"description":"The HRIS direct employee invitation status."},"send_at":{"type":["string","null"],"format":"date-time","description":"The HRIS direct employee invitation send date."},"timezone":{"type":["string","null"],"description":"The HRIS direct employee invitation timezone."}},"description":"The HRIS direct employee invitation status.","title":"PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataEmploymentsItemsHrisDirectEmployeeInvitation"},"PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataEmploymentsItems":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the employment."},"name":{"type":"string","description":"Name of the employee."},"team":{"$ref":"#/components/schemas/PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataEmploymentsItemsTeam","description":"The team to which the employee belongs."},"email":{"type":"string","description":"The work email of the employee."},"state":{"type":["string","null"],"description":"The state of employment."},"country":{"type":["string","null"],"description":"The country of employment."},"payment":{"$ref":"#/components/schemas/PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataEmploymentsItemsPayment","description":"Payment information for the employment, including rate, scale, currency, and associated contract name."},"is_ended":{"type":"boolean","description":"Whether the employment has ended."},"timezone":{"type":["string","null"],"description":"The timezone of the employment."},"job_title":{"type":["string","null"],"description":"The job title of the employment."},"seniority":{"type":["string","null"],"description":"The seniority level of the employment."},"start_date":{"type":["string","null"],"format":"date","description":"The start date of the employment."},"work_email":{"type":["string","null"],"description":"The work email of the employment."},"hiring_type":{"type":"string","description":"The type of hiring of the employment."},"hiring_status":{"type":"string","description":"The current hiring status of the employment."},"completion_date":{"type":["string","null"],"description":"The completion date of the employment contract."},"contract_status":{"type":"string","description":"The status of the employment contract."},"voluntarily_left":{"type":["boolean","null"],"description":"Whether the employee voluntarily left the employment."},"contract_coverage":{"oneOf":[{"$ref":"#/components/schemas/PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataEmploymentsItemsContractCoverage"},{"type":"null"}],"description":"The coverage type of the employment contract. 'is_shielded' = Contractor of Record, 'is_premium' = Premium, null = Standard (no coverage)."},"new_hiring_status":{"type":"string","description":"The new hiring status of the employment."},"client_legal_entity":{"oneOf":[{"$ref":"#/components/schemas/PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataEmploymentsItemsClientLegalEntity"},{"type":"null"}],"description":"The client legal entity associated with this employment contract."},"has_eor_termination":{"type":["boolean","null"],"description":"Whether the employment has an EOR termination."},"contract_is_archived":{"type":"boolean","description":"Whether the employment contract is archived."},"termination_last_day":{"type":["string","null"],"format":"date-time","description":"The last day of work mentioned on the contract termination."},"contract_has_contractor":{"type":"boolean","description":"Whether the contract has a contractor."},"is_user_contract_deleted":{"type":"boolean","description":"Whether the user contract is deleted."},"hris_direct_employee_invitation":{"oneOf":[{"$ref":"#/components/schemas/PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataEmploymentsItemsHrisDirectEmployeeInvitation"},{"type":"null"}],"description":"The HRIS direct employee invitation status."}},"title":"PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataEmploymentsItems"},"PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataDirectManager":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the manager."},"last_name":{"type":"string","description":"The last name of the manager."},"worker_id":{"type":"number","format":"double","description":"The worker ID of the manager."},"first_name":{"type":"string","description":"The first name of the manager."},"work_email":{"type":["string","null"],"description":"The work email of the manager."}},"description":"The direct manager of the employee.","title":"PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataDirectManager"},"PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataDirectReportsItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the direct report."},"last_name":{"type":"string","description":"The last name of the direct report."},"first_name":{"type":"string","description":"The first name of the direct report."},"work_email":{"type":["string","null"],"description":"The work email of the direct report."}},"title":"PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataDirectReportsItems"},"PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataClientLegalEntity":{"type":"object","properties":{"id":{"type":["string","null"],"format":"uuid","description":"Unique identifier of this resource."},"name":{"type":["string","null"],"description":"The name of the client legal entity."}},"description":"The primary client legal entity associated with the employee.","title":"PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataClientLegalEntity"},"PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataActiveWorkerTerminationStatus":{"type":"string","enum":["PENDING","CONTRACT_TERMINATION_DATA_COLLECTED","IN_PROGRESS","COMPLETED","FAILED","CANCELED"],"description":"The status of the active worker termination.","title":"PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataActiveWorkerTerminationStatus"},"PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataProfileOrganizationalStructuresItemsTeamsItemsPositionsItemsRole":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Id of the role."},"name":{"type":"string","description":"Name of the role."}},"description":"The role associated with this position, including role ID and name.","title":"PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataProfileOrganizationalStructuresItemsTeamsItemsPositionsItemsRole"},"PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataProfileOrganizationalStructuresItemsTeamsItemsPositionsItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Id of the position."},"role":{"oneOf":[{"$ref":"#/components/schemas/PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataProfileOrganizationalStructuresItemsTeamsItemsPositionsItemsRole"},{"type":"null"}],"description":"The role associated with this position, including role ID and name."},"is_supportive":{"type":"boolean","description":"Whether the position is supportive or not."}},"title":"PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataProfileOrganizationalStructuresItemsTeamsItemsPositionsItems"},"PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataProfileOrganizationalStructuresItemsTeamsItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Id of the team."},"name":{"type":"string","description":"Name of the team."},"positions":{"type":"array","items":{"$ref":"#/components/schemas/PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataProfileOrganizationalStructuresItemsTeamsItemsPositionsItems"},"description":"An array of positions held by the employee within this team."},"name_hierarchy":{"type":["string","null"],"description":"Hierarchy of the team."}},"title":"PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataProfileOrganizationalStructuresItemsTeamsItems"},"PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataProfileOrganizationalStructuresItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Id of the Organizational structure."},"name":{"type":"string","description":"Name of the Organizational structure."},"teams":{"type":"array","items":{"$ref":"#/components/schemas/PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataProfileOrganizationalStructuresItemsTeamsItems"},"description":"List of teams in the organizational structure."}},"title":"PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataProfileOrganizationalStructuresItems"},"PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataCustomFieldsItems":{"type":"object","properties":{"name":{"type":"string","description":"Custom field property name."},"value":{"type":["string","null"],"description":"Custom field property value."}},"description":"Customized attributes on people (Job title, Project code, etc).","title":"PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataCustomFieldsItems"},"PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the employee."},"state":{"type":["string","null"],"description":"The state of the employee."},"emails":{"type":"array","items":{"$ref":"#/components/schemas/PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataEmailsItems"},"description":"An array of the employee's email addresses."},"country":{"type":["string","null"],"description":"The country of the employee."},"timezone":{"type":["string","null"],"description":"The timezone of the employee."},"addresses":{"type":"array","items":{"$ref":"#/components/schemas/PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataAddressesItems"},"description":"An array of address objects containing the employee's physical addresses."},"full_name":{"type":"string","description":"The full name of the employee."},"job_title":{"type":["string","null"],"description":"The job title of the employee."},"last_name":{"type":"string","description":"The last name of the employee."},"seniority":{"type":["string","null"],"description":"The seniority level of the employee."},"worker_id":{"type":"string","description":"The worker ID of the employee."},"birth_date":{"type":["string","null"],"description":"The birth date of the employee."},"created_at":{"type":"string","format":"date-time","description":"The creation timestamp of the employee record."},"department":{"$ref":"#/components/schemas/PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataDepartment","description":"The department of the employee."},"first_name":{"type":"string","description":"The first name of the employee."},"start_date":{"type":["string","null"],"format":"date","description":"The date the employee started working."},"updated_at":{"type":["string","null"],"format":"date-time","description":"Long date-time format following ISO-8601"},"employments":{"type":"array","items":{"$ref":"#/components/schemas/PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataEmploymentsItems"},"description":"An array of employment records associated with the employee, including contract details, team information, payment details, and employment status."},"external_id":{"type":["string","null"],"description":"The external ID of the employee."},"hiring_type":{"type":"string","description":"The type of hiring of the employee."},"hiring_status":{"type":"string","description":"The current hiring status of the employee."},"nationalities":{"type":"array","items":{"type":"string"},"description":"The nationality of the employee."},"work_location":{"type":["string","null"],"description":"The work location of the employee."},"direct_manager":{"oneOf":[{"$ref":"#/components/schemas/PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataDirectManager"},{"type":"null"}],"description":"The direct manager of the employee."},"direct_reports":{"type":["array","null"],"items":{"$ref":"#/components/schemas/PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataDirectReportsItems"},"description":"The direct reports to the employee."},"completion_date":{"type":["string","null"],"description":"The completion date of the task or project."},"new_hiring_status":{"type":"string","description":"The new hiring status of the employee."},"client_legal_entity":{"$ref":"#/components/schemas/PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataClientLegalEntity","description":"The primary client legal entity associated with the employee."},"preferred_last_name":{"type":["string","null"],"description":"The preferred last name of the employee."},"direct_reports_count":{"type":"integer","description":"The count of direct reports to the employee."},"preferred_first_name":{"type":["string","null"],"description":"The preferred first name of the employee."},"active_worker_termination_status":{"oneOf":[{"$ref":"#/components/schemas/PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataActiveWorkerTerminationStatus"},{"type":"null"}],"description":"The status of the active worker termination."},"profile_organizational_structures":{"type":"array","items":{"$ref":"#/components/schemas/PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataProfileOrganizationalStructuresItems"},"description":"An array of organizational structures associated with the employee profile."},"direct_employee_termination_last_day":{"type":"string","format":"date","description":"The last day of work mentioned on the primary contract termination."},"custom_fields":{"type":"array","items":{"$ref":"#/components/schemas/PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaDataCustomFieldsItems"},"description":"An array of custom field objects containing additional attributes associated with the employee (e.g., Job title, Project code, etc.)."}},"title":"PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaData"},"people_getPersonById_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"people_getPersonById_Response_200"},"PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaError":{"type":"object","properties":{"code":{"type":"string","description":"Error code identifying the type of error."},"details":{"type":["string","null"],"description":"Additional details about the error."},"message":{"type":"string","description":"Error message describing what went wrong."}},"required":["code","message"],"title":"PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaError"},"RetrieveASinglePersonRequestInternalServerError":{"type":"object","properties":{"error":{"$ref":"#/components/schemas/PeopleHrisProfileIdGetResponsesContentApplicationJsonSchemaError"}},"required":["error"],"title":"RetrieveASinglePersonRequestInternalServerError"},"PeopleIdWorkingLocationPutRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"working_location_id":{"type":"number","format":"double","description":"Unique identifier of this resource."}},"required":["working_location_id"],"title":"PeopleIdWorkingLocationPutRequestBodyContentApplicationJsonSchemaData"},"PeopleIdWorkingLocationPutResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"updated":{"type":"boolean","description":"Indicates if the resource was updated successfully."}},"required":["updated"],"title":"PeopleIdWorkingLocationPutResponsesContentApplicationJsonSchemaData"},"people_updatePersonWorkingLocation_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PeopleIdWorkingLocationPutResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"people_updatePersonWorkingLocation_Response_200"},"PeopleWorkerIdPersonalGetResponsesContentApplicationJsonSchemaDataKyc":{"type":"object","properties":{"is_kyc_approved":{"type":"boolean","description":"Boolean to identify if the user is KYC verified"},"kyc_approval_date":{"type":["string","null"],"description":"The Date the user was KYC verified if applicable"}},"required":["is_kyc_approved","kyc_approval_date"],"description":"KYC (Know Your Customer) verification information for the worker.","title":"PeopleWorkerIdPersonalGetResponsesContentApplicationJsonSchemaDataKyc"},"PeopleWorkerIdPersonalGetResponsesContentApplicationJsonSchemaDataOooLeaveType":{"type":"string","enum":["LONG_TERM_LEAVE","SHORT_TERM_LEAVE"],"description":"The worker leave type.","title":"PeopleWorkerIdPersonalGetResponsesContentApplicationJsonSchemaDataOooLeaveType"},"PeopleWorkerIdPersonalGetResponsesContentApplicationJsonSchemaDataOoo":{"type":"object","properties":{"name":{"type":"string","description":"The worker out of office name."},"end_date":{"type":"string","description":"The worker out of office end date."},"leave_type":{"$ref":"#/components/schemas/PeopleWorkerIdPersonalGetResponsesContentApplicationJsonSchemaDataOooLeaveType","description":"The worker leave type."},"start_date":{"type":"string","format":"date","description":"The worker out of office start date."}},"required":["name","end_date","leave_type","start_date"],"description":"Out of office information for the worker, including leave type and dates.","title":"PeopleWorkerIdPersonalGetResponsesContentApplicationJsonSchemaDataOoo"},"PeopleWorkerIdPersonalGetResponsesContentApplicationJsonSchemaDataAddressesItemsType":{"type":"string","enum":["HOME","POSTAL","CONTRACT"],"description":"The type of the address.","title":"PeopleWorkerIdPersonalGetResponsesContentApplicationJsonSchemaDataAddressesItemsType"},"PeopleWorkerIdPersonalGetResponsesContentApplicationJsonSchemaDataAddressesItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the address."},"zip":{"type":["string","null"],"description":"The zip code."},"city":{"type":["string","null"],"description":"The city."},"type":{"$ref":"#/components/schemas/PeopleWorkerIdPersonalGetResponsesContentApplicationJsonSchemaDataAddressesItemsType","description":"The type of the address."},"state":{"type":["string","null"],"description":"The state."},"street":{"type":["string","null"],"description":"The street address."},"country":{"type":"string","description":"The country."}},"required":["id","zip","city","type","state","street","country"],"title":"PeopleWorkerIdPersonalGetResponsesContentApplicationJsonSchemaDataAddressesItems"},"PeopleWorkerIdPersonalGetResponsesContentApplicationJsonSchemaDataDemographicsGender":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the gender."},"name":{"type":"string","description":"The name of the gender."},"other_name":{"type":["string","null"],"description":"Gender added by user when \"Other\" option was chosen."}},"required":["id","name","other_name"],"description":"Gender information for the worker.","title":"PeopleWorkerIdPersonalGetResponsesContentApplicationJsonSchemaDataDemographicsGender"},"PeopleWorkerIdPersonalGetResponsesContentApplicationJsonSchemaDataDemographicsEthnicity":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the ethnicity."},"name":{"type":"string","description":"The name of the ethnicity."},"other_name":{"type":["string","null"],"description":"Ethnicity added by user when \"Other\" option was chosen."}},"required":["id","name","other_name"],"description":"Ethnicity information for the worker.","title":"PeopleWorkerIdPersonalGetResponsesContentApplicationJsonSchemaDataDemographicsEthnicity"},"PeopleWorkerIdPersonalGetResponsesContentApplicationJsonSchemaDataDemographics":{"type":"object","properties":{"gender":{"oneOf":[{"$ref":"#/components/schemas/PeopleWorkerIdPersonalGetResponsesContentApplicationJsonSchemaDataDemographicsGender"},{"type":"null"}],"description":"Gender information for the worker."},"ethnicity":{"oneOf":[{"$ref":"#/components/schemas/PeopleWorkerIdPersonalGetResponsesContentApplicationJsonSchemaDataDemographicsEthnicity"},{"type":"null"}],"description":"Ethnicity information for the worker."}},"required":["gender","ethnicity"],"description":"Demographic information for the worker, including gender and ethnicity.","title":"PeopleWorkerIdPersonalGetResponsesContentApplicationJsonSchemaDataDemographics"},"PeopleWorkerIdPersonalGetResponsesContentApplicationJsonSchemaDataNationalitiesItems":{"type":"object","properties":{"code":{"type":"string","description":"Unique 2-letters ISO country code."},"name":{"type":"string","description":"The name of the country."}},"required":["code","name"],"title":"PeopleWorkerIdPersonalGetResponsesContentApplicationJsonSchemaDataNationalitiesItems"},"PeopleWorkerIdPersonalGetResponsesContentApplicationJsonSchemaDataPhoneNumbersItemsType":{"type":"string","enum":["PERSONAL","WORK","HOME"],"description":"The type of the phone number.","title":"PeopleWorkerIdPersonalGetResponsesContentApplicationJsonSchemaDataPhoneNumbersItemsType"},"PeopleWorkerIdPersonalGetResponsesContentApplicationJsonSchemaDataPhoneNumbersItems":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/PeopleWorkerIdPersonalGetResponsesContentApplicationJsonSchemaDataPhoneNumbersItemsType","description":"The type of the phone number."},"dial_code":{"type":"string","description":"The dial code (also known as country code)."},"phone_number":{"type":"string","description":"The phone number."}},"required":["type","dial_code","phone_number"],"title":"PeopleWorkerIdPersonalGetResponsesContentApplicationJsonSchemaDataPhoneNumbersItems"},"PeopleWorkerIdPersonalGetResponsesContentApplicationJsonSchemaDataEmergencyContactsItemsPreferredLanguage":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier for the preferred language."},"language":{"type":"string","description":"The name of the language."}},"required":["id","language"],"description":"The preferred language in which the emergency contact should be contacted.","title":"PeopleWorkerIdPersonalGetResponsesContentApplicationJsonSchemaDataEmergencyContactsItemsPreferredLanguage"},"PeopleWorkerIdPersonalGetResponsesContentApplicationJsonSchemaDataEmergencyContactsItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the emergency contact."},"name":{"type":"string","description":"The name of the emergency contact."},"email":{"type":["string","null"],"format":"email","description":"The email of the emergency contact."},"phone":{"type":"string","description":"The phone number of the emergency contact."},"relationship":{"type":"string","description":"The type of relationship between the owner and the emergency contact."},"preferred_language":{"oneOf":[{"$ref":"#/components/schemas/PeopleWorkerIdPersonalGetResponsesContentApplicationJsonSchemaDataEmergencyContactsItemsPreferredLanguage"},{"type":"null"}],"description":"The preferred language in which the emergency contact should be contacted."}},"required":["id","name","email","phone","relationship","preferred_language"],"title":"PeopleWorkerIdPersonalGetResponsesContentApplicationJsonSchemaDataEmergencyContactsItems"},"PeopleWorkerIdPersonalGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the worker."},"kyc":{"$ref":"#/components/schemas/PeopleWorkerIdPersonalGetResponsesContentApplicationJsonSchemaDataKyc","description":"KYC (Know Your Customer) verification information for the worker."},"ooo":{"oneOf":[{"$ref":"#/components/schemas/PeopleWorkerIdPersonalGetResponsesContentApplicationJsonSchemaDataOoo"},{"type":"null"}],"description":"Out of office information for the worker, including leave type and dates."},"addresses":{"type":["array","null"],"items":{"$ref":"#/components/schemas/PeopleWorkerIdPersonalGetResponsesContentApplicationJsonSchemaDataAddressesItems"},"description":"Array of addresses associated with the worker."},"worker_id":{"type":"integer","description":"The worker id."},"work_email":{"type":["string","null"],"format":"email","description":"The work email of the worker."},"external_id":{"type":["string","null"],"description":"The external id of the worker."},"demographics":{"oneOf":[{"$ref":"#/components/schemas/PeopleWorkerIdPersonalGetResponsesContentApplicationJsonSchemaDataDemographics"},{"type":"null"}],"description":"Demographic information for the worker, including gender and ethnicity."},"date_of_birth":{"type":["string","null"],"format":"date","description":"The date of birth of the worker."},"nationalities":{"type":["array","null"],"items":{"$ref":"#/components/schemas/PeopleWorkerIdPersonalGetResponsesContentApplicationJsonSchemaDataNationalitiesItems"},"description":"Array of nationalities associated with the worker."},"phone_numbers":{"type":["array","null"],"items":{"$ref":"#/components/schemas/PeopleWorkerIdPersonalGetResponsesContentApplicationJsonSchemaDataPhoneNumbersItems"},"description":"Array of phone numbers associated with the worker."},"personal_email":{"type":["string","null"],"format":"email","description":"The personal email of the worker."},"preferred_name":{"type":["string","null"],"description":"The preferred name of the worker."},"legal_last_name":{"type":["string","null"],"description":"The legal last name of the worker."},"legal_first_name":{"type":["string","null"],"description":"The legal first name of the worker."},"emergency_contacts":{"type":"array","items":{"$ref":"#/components/schemas/PeopleWorkerIdPersonalGetResponsesContentApplicationJsonSchemaDataEmergencyContactsItems"},"description":"Array of emergency contacts associated with the worker."}},"required":["id","worker_id","emergency_contacts"],"title":"PeopleWorkerIdPersonalGetResponsesContentApplicationJsonSchemaData"},"personal-information_getPersonPersonalInfo_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PeopleWorkerIdPersonalGetResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"personal-information_getPersonPersonalInfo_Response_200"},"PeopleWorkerIdPersonalGetResponsesContentApplicationJsonSchemaError":{"type":"object","properties":{"code":{"type":"string","description":"Error code identifying the type of error."},"details":{"type":["string","null"],"description":"Additional details about the error."},"message":{"type":"string","description":"Error message describing what went wrong."}},"required":["code","message"],"title":"PeopleWorkerIdPersonalGetResponsesContentApplicationJsonSchemaError"},"GetPersonalInformationByIdRequestInternalServerError":{"type":"object","properties":{"error":{"$ref":"#/components/schemas/PeopleWorkerIdPersonalGetResponsesContentApplicationJsonSchemaError"}},"required":["error"],"title":"GetPersonalInformationByIdRequestInternalServerError"},"personal-information_getPersonPersonalInfoExternalID_Response_204":{"type":"object","properties":{},"description":"Empty response body","title":"personal-information_getPersonPersonalInfoExternalID_Response_204"},"PeopleWorkerIdPersonalPatchRequestBodyContentApplicationJsonSchemaDataPhoneNumbersItemsType":{"type":"string","enum":["PERSONAL","WORK","HOME"],"description":"The type of the phone number.","title":"PeopleWorkerIdPersonalPatchRequestBodyContentApplicationJsonSchemaDataPhoneNumbersItemsType"},"PeopleWorkerIdPersonalPatchRequestBodyContentApplicationJsonSchemaDataPhoneNumbersItems":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/PeopleWorkerIdPersonalPatchRequestBodyContentApplicationJsonSchemaDataPhoneNumbersItemsType","description":"The type of the phone number."},"dial_code":{"type":"string","description":"The dial code (also known as country code)."},"phone_number":{"type":"string","description":"The phone number."}},"required":["type","dial_code","phone_number"],"title":"PeopleWorkerIdPersonalPatchRequestBodyContentApplicationJsonSchemaDataPhoneNumbersItems"},"PeopleWorkerIdPersonalPatchRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"work_email":{"type":"string","format":"email","description":"The personal email of the worker."},"date_of_birth":{"type":"string","format":"date","description":"The date of birth of the worker. Format: YYYY-MM-DD."},"phone_numbers":{"type":"array","items":{"$ref":"#/components/schemas/PeopleWorkerIdPersonalPatchRequestBodyContentApplicationJsonSchemaDataPhoneNumbersItems"}},"personal_email":{"type":"string","format":"email","description":"The personal email of the worker."},"preferred_name":{"type":["string","null"],"description":"The preferred name of the worker."},"legal_last_name":{"type":"string","description":"The legal last name of the worker."},"legal_first_name":{"type":"string","description":"The legal first name of the worker."}},"title":"PeopleWorkerIdPersonalPatchRequestBodyContentApplicationJsonSchemaData"},"personal-information_updatePersonPersonalInfo_Response_204":{"type":"object","properties":{},"description":"Empty response body","title":"personal-information_updatePersonPersonalInfo_Response_204"},"PeopleExternalWorkerIdPersonalPatchRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"date_of_birth":{"type":"string","format":"date","description":"The date of birth of the worker. Format: YYYY-MM-DD."},"personal_email":{"type":"string","format":"email","description":"The personal email of the worker."},"preferred_name":{"type":["string","null"],"description":"The preferred name of the worker."},"legal_last_name":{"type":"string","description":"The legal last name of the worker."},"legal_first_name":{"type":"string","description":"The legal first name of the worker."}},"title":"PeopleExternalWorkerIdPersonalPatchRequestBodyContentApplicationJsonSchemaData"},"personal-information_updatePersonPersonalInfoExternalID_Response_204":{"type":"object","properties":{},"description":"Empty response body","title":"personal-information_updatePersonPersonalInfoExternalID_Response_204"},"HrisPositionsApplyChangesPostRequestBodyContentApplicationJsonSchemaDataAddItems":{"type":"object","properties":{"role_id":{"type":["string","null"],"format":"uuid","description":"Id of the role to be assigned to the position."},"team_id":{"type":"string","format":"uuid","description":"Id of the team to be assigned to the position."},"is_supportive":{"type":"boolean","description":"Flag to indicate if the position is supportive."}},"required":["team_id"],"title":"HrisPositionsApplyChangesPostRequestBodyContentApplicationJsonSchemaDataAddItems"},"HrisPositionsApplyChangesPostRequestBodyContentApplicationJsonSchemaDataEditItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Id of the position to be edited."},"role_id":{"type":["string","null"],"format":"uuid","description":"Id of the role to be assigned to the position."},"is_supportive":{"type":"boolean","description":"Flag to indicate if the position is supportive."}},"required":["id"],"title":"HrisPositionsApplyChangesPostRequestBodyContentApplicationJsonSchemaDataEditItems"},"HrisPositionsApplyChangesPostRequestBodyContentApplicationJsonSchemaDataDeleteItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Id of the position to be deleted."}},"required":["id"],"title":"HrisPositionsApplyChangesPostRequestBodyContentApplicationJsonSchemaDataDeleteItems"},"HrisPositionsApplyChangesPostRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"add":{"type":"array","items":{"$ref":"#/components/schemas/HrisPositionsApplyChangesPostRequestBodyContentApplicationJsonSchemaDataAddItems"}},"edit":{"type":"array","items":{"$ref":"#/components/schemas/HrisPositionsApplyChangesPostRequestBodyContentApplicationJsonSchemaDataEditItems"}},"delete":{"type":"array","items":{"$ref":"#/components/schemas/HrisPositionsApplyChangesPostRequestBodyContentApplicationJsonSchemaDataDeleteItems"}},"profile_id":{"type":"string","format":"uuid","description":"Id of the profile to which the positions belong."}},"required":["profile_id"],"description":"The request payload containing the position changes to apply.","title":"HrisPositionsApplyChangesPostRequestBodyContentApplicationJsonSchemaData"},"positions_applyPositionChanges_Response_204":{"type":"object","properties":{},"description":"Empty response body","title":"positions_applyPositionChanges_Response_204"},"TimeOffsReviewPostRequestBodyContentApplicationJsonSchemaDataItemsStatus":{"type":"string","enum":["APPROVED","REJECTED"],"description":"Decision on whether the time off request was approved or rejected","title":"TimeOffsReviewPostRequestBodyContentApplicationJsonSchemaDataItemsStatus"},"TimeOffsReviewPostRequestBodyContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"id":{"type":"string","description":"Time off id"},"status":{"$ref":"#/components/schemas/TimeOffsReviewPostRequestBodyContentApplicationJsonSchemaDataItemsStatus","description":"Decision on whether the time off request was approved or rejected"}},"required":["id","status"],"title":"TimeOffsReviewPostRequestBodyContentApplicationJsonSchemaDataItems"},"TimeOffsReviewPostResponsesContentApplicationJsonSchemaDataReviewedItemsStatus":{"type":"string","enum":["APPROVED","USED","REJECTED"],"description":"Time off status after review","title":"TimeOffsReviewPostResponsesContentApplicationJsonSchemaDataReviewedItemsStatus"},"TimeOffsReviewPostResponsesContentApplicationJsonSchemaDataReviewedItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Time off id"},"status":{"$ref":"#/components/schemas/TimeOffsReviewPostResponsesContentApplicationJsonSchemaDataReviewedItemsStatus","description":"Time off status after review"}},"required":["id","status"],"title":"TimeOffsReviewPostResponsesContentApplicationJsonSchemaDataReviewedItems"},"TimeOffsReviewPostResponsesContentApplicationJsonSchemaDataNotReviewedItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Time off id"},"error":{"type":"string","description":"The error or reason why a time-off could not be reviewed"}},"required":["id","error"],"title":"TimeOffsReviewPostResponsesContentApplicationJsonSchemaDataNotReviewedItems"},"TimeOffsReviewPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"reviewed":{"type":"array","items":{"$ref":"#/components/schemas/TimeOffsReviewPostResponsesContentApplicationJsonSchemaDataReviewedItems"}},"not_reviewed":{"type":"array","items":{"$ref":"#/components/schemas/TimeOffsReviewPostResponsesContentApplicationJsonSchemaDataNotReviewedItems"}}},"required":["reviewed","not_reviewed"],"title":"TimeOffsReviewPostResponsesContentApplicationJsonSchemaData"},"time-off_reviewTimeOffRequest_Response_201":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/TimeOffsReviewPostResponsesContentApplicationJsonSchemaData"}},"required":["data"],"description":"The response contains two lists: one for time-offs that were successfully reviewed and another for those that could not be reviewed. Each time-off in the reviewed list contains its ID and the status it was set to (either APPROVED/USED or REJECTED). The notReviewed list contains the IDs of time-offs that could not be reviewed along with an error message explaining why.","title":"time-off_reviewTimeOffRequest_Response_201"},"TimeOffsReviewPostResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"path":{"type":"string","description":"The JSON path where input validation failed"},"message":{"type":"string","description":"A description of the returned error"}},"title":"TimeOffsReviewPostResponsesContentApplicationJsonSchemaErrorsItems"},"TimeOffsReviewPostResponsesContentApplicationJsonSchemaRequest":{"type":"object","properties":{"url":{"type":"string","description":"The relative URL of the failed request"},"code":{"type":"number","format":"double","description":"The code of the source handler which produced the returned error"},"docs":{"type":"string","description":"A link to the official documentation for the requested endpoint resource"},"method":{"type":"string","description":"The HTTP method of the failed request"},"source":{"type":"string","description":"The source handler which produced the returned error"},"status":{"type":"number","format":"double","description":"The status code of the response"},"api_req_id":{"type":"string","description":"The request ID of the failed request"}},"title":"TimeOffsReviewPostResponsesContentApplicationJsonSchemaRequest"},"ApproveRejectTimeOffRequests-v2026-01-01RequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/TimeOffsReviewPostResponsesContentApplicationJsonSchemaErrorsItems"}},"request":{"$ref":"#/components/schemas/TimeOffsReviewPostResponsesContentApplicationJsonSchemaRequest"}},"title":"ApproveRejectTimeOffRequests-v2026-01-01RequestBadRequestError"},"time-off_deleteTimeOffRequest_Response_204":{"type":"object","properties":{},"title":"time-off_deleteTimeOffRequest_Response_204"},"TimeOffsPostRequestBodyContentApplicationJsonSchemaDataDatesItemsDate":{"oneOf":[{"type":"string","format":"date"},{"type":"string","format":"date-time"}],"description":"An specific date in the time-off request","title":"TimeOffsPostRequestBodyContentApplicationJsonSchemaDataDatesItemsDate"},"TimeOffsPostRequestBodyContentApplicationJsonSchemaDataDatesItemsDayType":{"type":"string","enum":["HALF_DAY","FULL_DAY","PERCENTAGE","HOURLY"],"description":"The type of day for the time off request. All dates must follow the same type.","title":"TimeOffsPostRequestBodyContentApplicationJsonSchemaDataDatesItemsDayType"},"TimeOffsPostRequestBodyContentApplicationJsonSchemaDataDatesItems":{"type":"object","properties":{"date":{"$ref":"#/components/schemas/TimeOffsPostRequestBodyContentApplicationJsonSchemaDataDatesItemsDate","description":"An specific date in the time-off request"},"hours":{"type":"number","format":"double","description":"The amount taken in hours during this specific date. It can not exceed the maximum allowed hours for the date."},"amount":{"type":"number","format":"double","description":"The amount of time off requested for the date. It must be in the same time unit as in the total amount for the time off request."},"day_type":{"$ref":"#/components/schemas/TimeOffsPostRequestBodyContentApplicationJsonSchemaDataDatesItemsDayType","description":"The type of day for the time off request. All dates must follow the same type."}},"required":["date"],"description":"The dates breakdown for the time off request.","title":"TimeOffsPostRequestBodyContentApplicationJsonSchemaDataDatesItems"},"TimeOffsPostRequestBodyContentApplicationJsonSchemaDataStatus":{"type":"string","enum":["REQUESTED","APPROVED"],"default":"APPROVED","description":"Status for the time off request. When set to REQUESTED the time off should be reviewed later through the Approve/Reject time off api.","title":"TimeOffsPostRequestBodyContentApplicationJsonSchemaDataStatus"},"TimeOffsPostRequestBodyContentApplicationJsonSchemaDataEndDate":{"oneOf":[{"type":"string","format":"date"},{"type":"string","format":"date-time"}],"description":"End date of the time off request. This is the date when the time off ends. For example, if you take 2 days off, this will be the end date of the second day.","title":"TimeOffsPostRequestBodyContentApplicationJsonSchemaDataEndDate"},"TimeOffsPostRequestBodyContentApplicationJsonSchemaDataStartDate":{"oneOf":[{"type":"string","format":"date"},{"type":"string","format":"date-time"}],"description":"Start date of the time off request. This is the date when the time off starts. For example, if you take 2 days off, this will be the start date of the first day.","title":"TimeOffsPostRequestBodyContentApplicationJsonSchemaDataStartDate"},"TimeOffsPostRequestBodyContentApplicationJsonSchemaDataEventDetails":{"type":"object","properties":{"birth_date":{"type":"string","format":"date","description":"The birth date of the child. This is used for parental leave requests."},"adoption_date":{"type":"string","format":"date","description":"The date of adoption. This is used for parental leave requests."},"was_premature_birth":{"type":"boolean","description":"Whether the birth was premature or not. This is used for parental leave requests."},"had_multiple_children":{"type":"boolean","description":"Whether the birth was multiple or not. This is used for parental leave requests."}},"required":["birth_date","was_premature_birth","had_multiple_children"],"description":"Details of the event associated with the time off request. Required for event based policies such as parental leave.","title":"TimeOffsPostRequestBodyContentApplicationJsonSchemaDataEventDetails"},"TimeOffsPostRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"dates":{"type":"array","items":{"$ref":"#/components/schemas/TimeOffsPostRequestBodyContentApplicationJsonSchemaDataDatesItems"},"description":"The dates breakdown for the time off request."},"reason":{"type":["string","null"],"description":"Reason for taking time off. This is complementary information for the time-off description. Useful to provide sub categories for the same policy."},"status":{"$ref":"#/components/schemas/TimeOffsPostRequestBodyContentApplicationJsonSchemaDataStatus","description":"Status for the time off request. When set to REQUESTED the time off should be reviewed later through the Approve/Reject time off api."},"is_paid":{"type":"boolean","description":"Whether the time off is paid or unpaid. By default it follows the policy configuration."},"end_date":{"$ref":"#/components/schemas/TimeOffsPostRequestBodyContentApplicationJsonSchemaDataEndDate","description":"End date of the time off request. This is the date when the time off ends. For example, if you take 2 days off, this will be the end date of the second day."},"policy_id":{"type":"string","format":"uuid","description":"The time off policy id. Can be used in place of time_off_type_id"},"start_date":{"$ref":"#/components/schemas/TimeOffsPostRequestBodyContentApplicationJsonSchemaDataStartDate","description":"Start date of the time off request. This is the date when the time off starts. For example, if you take 2 days off, this will be the start date of the first day."},"description":{"type":["string","null"],"description":"Description of the time off request. Some policies require that a description is provided."},"contract_oid":{"type":["string","null"],"description":"Contract id. This is the id of the contract associated with the time off request."},"event_details":{"$ref":"#/components/schemas/TimeOffsPostRequestBodyContentApplicationJsonSchemaDataEventDetails","description":"Details of the event associated with the time off request. Required for event based policies such as parental leave."},"deduction_amount":{"type":["number","null"],"format":"double","description":"Deduction amount. Available for independent contractor's policies"},"time_off_type_id":{"type":"string","format":"uuid","description":"The time off type id. Required when policy_id is not provided"},"time_off_event_id":{"type":"string","format":"uuid","description":"The time off event id. This is used to link the time off request to an event."},"time_off_percentage":{"type":["number","null"],"format":"double","description":"This is the percentage of time off taken. This is used when the time off request is a percentage."},"recipient_profile_id":{"type":"string","format":"uuid","description":"The hris profile id of the recipient"},"other_type_description":{"type":["string","null"],"description":"Description of the time off type. This is used when the policy is OTHER."}},"required":["end_date","start_date","recipient_profile_id"],"description":"The time off request data","title":"TimeOffsPostRequestBodyContentApplicationJsonSchemaData"},"TimeOffsPostResponsesContentApplicationJsonSchemaTimeOffsItemsStatus":{"type":"string","enum":["REQUESTED","APPROVED","REJECTED","USED","CANCELED"],"description":"Status of the time off request. Can be REQUESTED, APPROVED, REJECTED, USED or CANCELED.","title":"TimeOffsPostResponsesContentApplicationJsonSchemaTimeOffsItemsStatus"},"TimeOffsPostResponsesContentApplicationJsonSchemaTimeOffsItemsAttachmentsItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Attachment id"},"filename":{"type":"string","description":"Filename of the attachment"},"created_at":{"type":"string","format":"date-time","description":"This is the date when the attachment was created in the database."},"updated_at":{"type":"string","format":"date-time","description":"This is the date when the attachment was last updated in the database."}},"required":["id","filename","created_at","updated_at"],"description":"An attachment associated with the time off request.","title":"TimeOffsPostResponsesContentApplicationJsonSchemaTimeOffsItemsAttachmentsItems"},"TimeOffsPostResponsesContentApplicationJsonSchemaTimeOffsItemsTimeOffTypePolicyPolicyType":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Policy type id"},"name":{"type":"string","description":"Depicts the type of policy, like VACATION, SICK etc"}},"required":["id","name"],"title":"TimeOffsPostResponsesContentApplicationJsonSchemaTimeOffsItemsTimeOffTypePolicyPolicyType"},"TimeOffsPostResponsesContentApplicationJsonSchemaTimeOffsItemsTimeOffTypePolicy":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Policy id"},"name":{"type":"string","description":"The custom name given to policy during policy creation."},"policy_type":{"$ref":"#/components/schemas/TimeOffsPostResponsesContentApplicationJsonSchemaTimeOffsItemsTimeOffTypePolicyPolicyType"}},"required":["id","name","policy_type"],"description":"The policy associated with the time off type.","title":"TimeOffsPostResponsesContentApplicationJsonSchemaTimeOffsItemsTimeOffTypePolicy"},"TimeOffsPostResponsesContentApplicationJsonSchemaTimeOffsItemsTimeOffType":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Time off type id."},"name":{"type":"string","description":"Time off type name. Basically the reason or category of time-off taken. For SICK leave, it can be doctor appointment, surgery etc."},"policy":{"$ref":"#/components/schemas/TimeOffsPostResponsesContentApplicationJsonSchemaTimeOffsItemsTimeOffTypePolicy","description":"The policy associated with the time off type."}},"required":["id","name"],"description":"The type of time off taken.","title":"TimeOffsPostResponsesContentApplicationJsonSchemaTimeOffsItemsTimeOffType"},"TimeOffsPostResponsesContentApplicationJsonSchemaTimeOffsItemsTimeOffEventType":{"type":"string","enum":["PARENTAL_LEAVE"],"description":"The type of the time off event.","title":"TimeOffsPostResponsesContentApplicationJsonSchemaTimeOffsItemsTimeOffEventType"},"TimeOffsPostResponsesContentApplicationJsonSchemaTimeOffsItemsTimeOffEventEventDetails":{"type":"object","properties":{"birth_date":{"type":"string","format":"date","description":"The birth date of the child. This is used for parental leave requests."},"adoption_date":{"type":"string","format":"date","description":"The date of adoption. This is used for parental leave requests."},"was_premature_birth":{"type":"boolean","description":"Whether the birth was premature or not. This is used for parental leave requests."},"estimated_birth_date":{"type":"string","format":"date","description":"The estimated birth date of the child. Birth is estimated when the birth date has not been confirmed yet."},"had_multiple_children":{"type":"boolean","description":"Whether the birth was multiple or not. This is used for parental leave requests."},"estimated_adoption_date":{"type":"string","format":"date","description":"The estimated adoption date of the child. Birth is estimated when the adoption date has not been confirmed yet."}},"required":["was_premature_birth","had_multiple_children"],"description":"Details of the event associated with the time off request. Required for event based policies such as parental leave.","title":"TimeOffsPostResponsesContentApplicationJsonSchemaTimeOffsItemsTimeOffEventEventDetails"},"TimeOffsPostResponsesContentApplicationJsonSchemaTimeOffsItemsTimeOffEvent":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The time off event id. This is used to link the time off request to an event."},"type":{"$ref":"#/components/schemas/TimeOffsPostResponsesContentApplicationJsonSchemaTimeOffsItemsTimeOffEventType","description":"The type of the time off event."},"policy_id":{"type":"string","format":"uuid","description":"The policy id associated with the time off event. Same as the policy_id in the time off type."},"created_at":{"type":"string","format":"date-time","description":"The date when the time off event was created in the database."},"updated_at":{"type":"string","format":"date-time","description":"The date when the time off event was last updated in the database."},"event_details":{"$ref":"#/components/schemas/TimeOffsPostResponsesContentApplicationJsonSchemaTimeOffsItemsTimeOffEventEventDetails","description":"Details of the event associated with the time off request. Required for event based policies such as parental leave."},"hris_profile_id":{"type":"string","format":"uuid","description":"The HRIS profile id of the worker associated with the time off event. Same as the hris_profile_id in the recipient_profile."},"time_off_type_id":{"type":"string","format":"uuid","description":"The time off type id associated with the time off event. Same as the time_off_type_id in the time off request."}},"title":"TimeOffsPostResponsesContentApplicationJsonSchemaTimeOffsItemsTimeOffEvent"},"TimeOffsPostResponsesContentApplicationJsonSchemaTimeOffsItemsEntitlementUnit":{"type":"string","enum":["HOUR","BUSINESS_DAY","CALENDAR_DAY","WEEK","MONTH","YEAR"],"description":"The unit in which the time off usage and entitlement are calculated.","title":"TimeOffsPostResponsesContentApplicationJsonSchemaTimeOffsItemsEntitlementUnit"},"TimeOffsPostResponsesContentApplicationJsonSchemaTimeOffsItemsTimeOffDailiesItemsType":{"type":"string","enum":["WORKING_DAY","NON_WORKING_DAY","HOLIDAY"],"description":"Type of the time off daily. Can be WORKING_DAY, NON_WORKING_DAY or HOLIDAY.","title":"TimeOffsPostResponsesContentApplicationJsonSchemaTimeOffsItemsTimeOffDailiesItemsType"},"TimeOffsPostResponsesContentApplicationJsonSchemaTimeOffsItemsTimeOffDailiesItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Time off daily id"},"date":{"type":"string","format":"date","description":"Date of the time off daily. This is the date when the time off was taken."},"type":{"$ref":"#/components/schemas/TimeOffsPostResponsesContentApplicationJsonSchemaTimeOffsItemsTimeOffDailiesItemsType","description":"Type of the time off daily. Can be WORKING_DAY, NON_WORKING_DAY or HOLIDAY."},"amount":{"type":"number","format":"double","description":"Amount of time off taken in this specific date."},"created_at":{"type":"string","format":"date-time","description":"This is the date when the time off daily was created in the database."},"updated_at":{"type":"string","format":"date-time","description":"This is the date when the time off daily was last updated in the database."},"description":{"type":["string","null"],"description":"Description of the time off daily. When it is a HOLIDAY this is the holiday name."},"time_off_id":{"type":"string","format":"uuid","description":"Time off id. This is the id of the time off request associated with the time off daily."}},"required":["id","date","type","amount","created_at","updated_at","time_off_id"],"title":"TimeOffsPostResponsesContentApplicationJsonSchemaTimeOffsItemsTimeOffDailiesItems"},"TimeOffsPostResponsesContentApplicationJsonSchemaTimeOffsItemsRecipientProfile":{"type":"object","properties":{"hris_profile_id":{"type":"string","format":"uuid","description":"The worker HRIS profile id in the given organization."},"organization_id":{"type":"string","format":"uuid","description":"Id of the organization the profile belongs to."}},"required":["hris_profile_id","organization_id"],"description":"The time off profile of the recipient of the time off request. Must be a worker profile.","title":"TimeOffsPostResponsesContentApplicationJsonSchemaTimeOffsItemsRecipientProfile"},"TimeOffsPostResponsesContentApplicationJsonSchemaTimeOffsItemsRequesterProfile":{"type":"object","properties":{"hris_profile_id":{"type":"string","format":"uuid","description":"The worker HRIS profile id in the given organization. Available when the requester is a worker."},"organization_id":{"type":"string","format":"uuid","description":"Id of the organization the profile belongs to."},"client_profile_id":{"type":"string","format":"uuid","description":"Id of the client profile. Available when the requester is a client."}},"required":["organization_id"],"description":"The time off profile of the requester of the time off request. Can be either a client or worker profile.","title":"TimeOffsPostResponsesContentApplicationJsonSchemaTimeOffsItemsRequesterProfile"},"TimeOffsPostResponsesContentApplicationJsonSchemaTimeOffsItems":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"Amount of time off taken. This is the total amount of time off taken. For example, if you take 2 days off, this will be 2. If you take 1 day off, this will be 1."},"reason":{"type":"string","description":"Reason for taking time off. This is complementary information for the time-off description. Useful to provide sub categories for the same policy."},"status":{"$ref":"#/components/schemas/TimeOffsPostResponsesContentApplicationJsonSchemaTimeOffsItemsStatus","description":"Status of the time off request. Can be REQUESTED, APPROVED, REJECTED, USED or CANCELED."},"is_paid":{"type":"boolean","description":"Whether the time off is paid or unpaid."},"end_date":{"type":"string","format":"date","description":"End date of the time off request. This is the date when the time off ends. For example, if you take 2 days off, this will be the end date of the second day."},"created_at":{"type":"string","format":"date-time","description":"This is the date when the time off request was created in the database."},"start_date":{"type":"string","format":"date","description":"Start date of the time off request. This is the date when the time off starts. For example, if you take 2 days off, this will be the start date of the first day."},"updated_at":{"type":"string","format":"date-time","description":"This is the date when the time off request was last updated in the database."},"approved_at":{"type":["string","null"],"format":"date-time","description":"This is the date when the time off request was approved. This will be null if the time off request is not approved yet."},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/TimeOffsPostResponsesContentApplicationJsonSchemaTimeOffsItemsAttachmentsItems"},"description":"List of attachments associated with the time off request."},"description":{"type":"string","description":"Description of the time off request. Some policies require that a description is provided."},"contract_oid":{"type":["string","null"],"description":"Contract id. This is the id of the contract associated with the time off request."},"requested_at":{"type":"string","format":"date","description":"This is the date when the time off request was made."},"half_end_date":{"type":"boolean","description":"Whether the end date is a half day or not."},"time_off_type":{"$ref":"#/components/schemas/TimeOffsPostResponsesContentApplicationJsonSchemaTimeOffsItemsTimeOffType","description":"The type of time off taken."},"time_off_event":{"$ref":"#/components/schemas/TimeOffsPostResponsesContentApplicationJsonSchemaTimeOffsItemsTimeOffEvent"},"half_start_date":{"type":"boolean","description":"Whether the start date is a half day or not."},"deduction_amount":{"type":["number","null"],"format":"double","description":"Deduction amount. Available for independent contractor's policies"},"entitlement_unit":{"$ref":"#/components/schemas/TimeOffsPostResponsesContentApplicationJsonSchemaTimeOffsItemsEntitlementUnit","description":"The unit in which the time off usage and entitlement are calculated."},"time_off_dailies":{"type":"array","items":{"$ref":"#/components/schemas/TimeOffsPostResponsesContentApplicationJsonSchemaTimeOffsItemsTimeOffDailiesItems"}},"time_off_type_id":{"type":"string","format":"uuid","description":"Time off type id. This is the id of the time off type associated with the time off request."},"recipient_profile":{"$ref":"#/components/schemas/TimeOffsPostResponsesContentApplicationJsonSchemaTimeOffsItemsRecipientProfile","description":"The time off profile of the recipient of the time off request. Must be a worker profile."},"requester_profile":{"$ref":"#/components/schemas/TimeOffsPostResponsesContentApplicationJsonSchemaTimeOffsItemsRequesterProfile","description":"The time off profile of the requester of the time off request. Can be either a client or worker profile."},"time_off_percentage":{"type":["number","null"],"format":"double","description":"This is the percentage of time off taken."},"is_end_date_estimated":{"type":"boolean","description":"Whether the end date is estimated or not. This is used on event based policies such as Parental leave."},"other_type_description":{"type":["string","null"],"description":"Description of the time off type. This is used when the policy is OTHER."}},"required":["is_paid","end_date","created_at","start_date","updated_at","requested_at","half_end_date","half_start_date","entitlement_unit","time_off_type_id"],"description":"Created time off request","title":"TimeOffsPostResponsesContentApplicationJsonSchemaTimeOffsItems"},"time-off_createTimeOffRequest_Response_201":{"type":"object","properties":{"time_offs":{"type":"array","items":{"$ref":"#/components/schemas/TimeOffsPostResponsesContentApplicationJsonSchemaTimeOffsItems"},"description":"The list of created time offs. Depending on the selected dates, a time off can be split into more than one request."}},"required":["time_offs"],"description":"The list of created time offs. Depending on the selected dates, a time off can be split into more than one request.","title":"time-off_createTimeOffRequest_Response_201"},"TimeOffsPostResponsesContentApplicationJsonSchemaErrors":{"type":"object","properties":{"message":{"type":"string","description":"Error message describing what went wrong"}},"description":"Error details","title":"TimeOffsPostResponsesContentApplicationJsonSchemaErrors"},"TimeOffsPostResponsesContentApplicationJsonSchemaRequest":{"type":"object","properties":{"url":{"type":"string","description":"Request URL path"},"docs":{"type":"string","description":"Documentation reference"},"method":{"type":"string","description":"HTTP method"},"source":{"type":"string","description":"Request source"},"status":{"type":"integer","description":"HTTP status code"},"api_req_id":{"type":"string","description":"Unique API request identifier"}},"description":"Request metadata","title":"TimeOffsPostResponsesContentApplicationJsonSchemaRequest"},"CreateTimeOffRequest-v2026-01-01RequestBadRequestError":{"type":"object","properties":{"errors":{"$ref":"#/components/schemas/TimeOffsPostResponsesContentApplicationJsonSchemaErrors","description":"Error details"},"request":{"$ref":"#/components/schemas/TimeOffsPostResponsesContentApplicationJsonSchemaRequest","description":"Request metadata"}},"title":"CreateTimeOffRequest-v2026-01-01RequestBadRequestError"},"CreateTimeOffRequest-v2026-01-01RequestForbiddenError":{"type":"object","properties":{"errors":{"$ref":"#/components/schemas/TimeOffsPostResponsesContentApplicationJsonSchemaErrors","description":"Error details"},"request":{"$ref":"#/components/schemas/TimeOffsPostResponsesContentApplicationJsonSchemaRequest","description":"Request metadata"}},"title":"CreateTimeOffRequest-v2026-01-01RequestForbiddenError"},"CreateTimeOffRequest-v2026-01-01RequestNotFoundError":{"type":"object","properties":{"errors":{"$ref":"#/components/schemas/TimeOffsPostResponsesContentApplicationJsonSchemaErrors","description":"Error details"},"request":{"$ref":"#/components/schemas/TimeOffsPostResponsesContentApplicationJsonSchemaRequest","description":"Request metadata"}},"title":"CreateTimeOffRequest-v2026-01-01RequestNotFoundError"},"TimeOffsGlobalPayrollSyncPostRequestBodyContentApplicationJsonSchemaDataTimeOffsItemsOneOf0PolicyType":{"type":"string","enum":["Adoption leave","Advanced vacation","Bereavement leave","Blood donation leave","Breastfeeding leave","Childbirth leave","Childcare leave","Civic/public duty leave","Disability leave","Doctor's appointment leave","Family & domestic violence leave","Floating Holiday Allowance","Hajj leave","Marriage/wedding leave","Maternity leave","Military leave","Moving leave","Other leave","Paid leave","Parental leave","Paternity leave","Personal leave","Pregnancy leave","Regional holiday","RTT","Sick leave","Study leave","Supplementary Leave","Unpaid leave","Vacation","Volunteer leave","Work accident leave"],"description":"The Deel policy type of the policy the time off is being requested for.","title":"TimeOffsGlobalPayrollSyncPostRequestBodyContentApplicationJsonSchemaDataTimeOffsItemsOneOf0PolicyType"},"TimeOffsGlobalPayrollSyncPostRequestBodyContentApplicationJsonSchemaDataTimeOffsItemsOneOf0EntitlementUnit":{"type":"string","enum":["HOUR","BUSINESS_DAY","CALENDAR_DAY","WEEK","MONTH","YEAR"],"description":"The time unit for this time off. *Mandatory when amount parameter is informed*. If no amount and no entitlement_unit are informed, it will be calculated using Deel's internal country templates for compliant time off policies.","title":"TimeOffsGlobalPayrollSyncPostRequestBodyContentApplicationJsonSchemaDataTimeOffsItemsOneOf0EntitlementUnit"},"TimeOffsGlobalPayrollSyncPostRequestBodyContentApplicationJsonSchemaDataTimeOffsItems0":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"The amount in time units for this time off. When no amount is informed, it will be calculated using work schedules and public holidays defined at Deel."},"is_paid":{"type":"boolean","default":true,"description":"Allows the consumer to specify whether the time off is considered as paid (at statutory) or unpaid based on the configuration of the policy in the external HRIS."},"end_date":{"type":"string","format":"date","description":"The end date of the time off."},"start_date":{"type":"string","format":"date","description":"The start date of the time off."},"approved_at":{"type":"string","format":"date","default":"time off start date","description":"The approval date of the time off. If no approval date is informed, the start date of this request will be used as the approval date. Note: use this field in order to support retrospective leaves so Deel can identify requests made after the payroll cycle."},"description":{"type":["string","null"],"description":"The description of the time off."},"external_id":{"type":"string","description":"External ID to link a Deel time off object with an external time off object. It will be used to determine which operation should be done: INSERT, UPDATE or DELETE."},"policy_name":{"type":"string","description":"The policy name the time off is being requested for. If not informed, a default name will be generated using the policy type and contract's country (eg: Vacation - US)."},"policy_type":{"oneOf":[{"$ref":"#/components/schemas/TimeOffsGlobalPayrollSyncPostRequestBodyContentApplicationJsonSchemaDataTimeOffsItemsOneOf0PolicyType"},{"type":"null"}],"description":"The Deel policy type of the policy the time off is being requested for."},"contract_oid":{"type":"string","description":"The contract id that has requested the time off."},"requested_at":{"type":"string","format":"date","description":"The request date of the time off."},"entitlement_unit":{"$ref":"#/components/schemas/TimeOffsGlobalPayrollSyncPostRequestBodyContentApplicationJsonSchemaDataTimeOffsItemsOneOf0EntitlementUnit","description":"The time unit for this time off. *Mandatory when amount parameter is informed*. If no amount and no entitlement_unit are informed, it will be calculated using Deel's internal country templates for compliant time off policies."}},"required":["end_date","start_date","external_id","policy_type","contract_oid"],"title":"TimeOffsGlobalPayrollSyncPostRequestBodyContentApplicationJsonSchemaDataTimeOffsItems0"},"TimeOffsGlobalPayrollSyncPostRequestBodyContentApplicationJsonSchemaDataTimeOffsItems1":{"type":"object","properties":{"deleted":{"type":"boolean","description":"Indicates this time off request must be deleted"},"external_id":{"type":"string","description":"External ID to link a Deel time off object with an external time off object. It will be used to determine which operation should be done: INSERT, UPDATE or DELETE."},"contract_oid":{"type":"string","description":"The contract id that has requested the time off."}},"required":["deleted","external_id","contract_oid"],"title":"TimeOffsGlobalPayrollSyncPostRequestBodyContentApplicationJsonSchemaDataTimeOffsItems1"},"TimeOffsGlobalPayrollSyncPostRequestBodyContentApplicationJsonSchemaDataTimeOffsItems":{"oneOf":[{"$ref":"#/components/schemas/TimeOffsGlobalPayrollSyncPostRequestBodyContentApplicationJsonSchemaDataTimeOffsItems0"},{"$ref":"#/components/schemas/TimeOffsGlobalPayrollSyncPostRequestBodyContentApplicationJsonSchemaDataTimeOffsItems1"}],"title":"TimeOffsGlobalPayrollSyncPostRequestBodyContentApplicationJsonSchemaDataTimeOffsItems"},"TimeOffsGlobalPayrollSyncPostRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"time_offs":{"type":"array","items":{"$ref":"#/components/schemas/TimeOffsGlobalPayrollSyncPostRequestBodyContentApplicationJsonSchemaDataTimeOffsItems"}}},"required":["time_offs"],"title":"TimeOffsGlobalPayrollSyncPostRequestBodyContentApplicationJsonSchemaData"},"TimeOffsGlobalPayrollSyncPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"deleted":{"type":"number","format":"double","description":"Number of time off requests that were deleted"},"updated":{"type":"number","format":"double","description":"Number of time off requests that were updated"},"inserted":{"type":"number","format":"double","description":"Number of time off requests that were inserted"}},"title":"TimeOffsGlobalPayrollSyncPostResponsesContentApplicationJsonSchemaData"},"time-off_syncTimeOffGlobalPayroll_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/TimeOffsGlobalPayrollSyncPostResponsesContentApplicationJsonSchemaData"}},"description":"List of time offs persisted at Deel","title":"time-off_syncTimeOffGlobalPayroll_Response_200"},"TimeOffsGlobalPayrollSyncPostResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"path":{"type":"string","description":"The JSON path where input validation failed"},"message":{"type":"string","description":"A description of the returned error"}},"title":"TimeOffsGlobalPayrollSyncPostResponsesContentApplicationJsonSchemaErrorsItems"},"TimeOffsGlobalPayrollSyncPostResponsesContentApplicationJsonSchemaRequest":{"type":"object","properties":{"url":{"type":"string","description":"The relative URL of the failed request"},"code":{"type":"number","format":"double","description":"The code of the source handler which produced the returned error"},"docs":{"type":"string","description":"A link to the official documentation for the requested endpoint resource"},"method":{"type":"string","description":"The HTTP method of the failed request"},"source":{"type":"string","description":"The source handler which produced the returned error"},"status":{"type":"number","format":"double","description":"The status code of the response"},"api_req_id":{"type":"string","description":"The request ID of the failed request"}},"title":"TimeOffsGlobalPayrollSyncPostResponsesContentApplicationJsonSchemaRequest"},"ExternalHrTimeOffSynchronizationRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/TimeOffsGlobalPayrollSyncPostResponsesContentApplicationJsonSchemaErrorsItems"}},"request":{"$ref":"#/components/schemas/TimeOffsGlobalPayrollSyncPostResponsesContentApplicationJsonSchemaRequest"}},"title":"ExternalHrTimeOffSynchronizationRequestBadRequestError"},"TimeOffsProfileHrisProfileIdEntitlementsGetParametersPolicyTypeName":{"type":"string","enum":["Moving leave","Adoption leave","Personal leave","Parental leave","Military leave","Childbirth leave","Study leave","Sick leave","Bereavement leave","Family & domestic violence leave","Marriage/wedding leave","Blood donation leave","Volunteer leave","Vacation","Doctor's appointment leave","Maternity leave","Hajj leave","Paternity leave","Civic/public duty leave","Childcare leave","Unpaid leave","Paid leave","Other leave","Disability leave","Pregnancy leave","RTT","Regional holiday","Breastfeeding leave","Advanced vacation"],"description":"Policy type name","title":"TimeOffsProfileHrisProfileIdEntitlementsGetParametersPolicyTypeName"},"TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItemsEventsItemsType":{"type":"string","enum":["ACCRUAL","ACCRUAL_DEDUCTION","ACCRUAL_PRORATE","ACCRUAL_TERMINATION","MANUAL_ADJUSTMENT","NO_ROLLOVER","ROLLOVER_ADJUSTMENT","ROLLOVER_CARRY_OVER","ROLLOVER_EXPIRATION","ROLLOVER_PAYOUT","ROLLOVER_PROJECTED","TIME_OFF"],"description":"Event type","title":"TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItemsEventsItemsType"},"TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItemsEventsItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Event ID"},"type":{"$ref":"#/components/schemas/TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItemsEventsItemsType","description":"Event type"},"amount":{"type":"number","format":"double","description":"Event amount"},"policy_id":{"type":"string","format":"uuid","description":"Policy ID"},"created_at":{"type":"string","format":"date-time","description":"Event creation date"},"event_date":{"type":"string","format":"date-time","description":"Event date"},"profile_id":{"type":"string","format":"uuid","description":"Profile ID"},"updated_at":{"type":"string","format":"date-time","description":"Event update date"},"description":{"type":"string","description":"Event description"},"time_off_id":{"type":"string","format":"uuid","description":"Time off ID"},"accrual_date":{"type":"string","format":"date-time","description":"Accrual date"},"expiration_date":{"type":"string","format":"date-time","description":"Expiration date"},"tracking_period":{"type":"string","format":"date-time","description":"Tracking period"},"rollover_tracking_period":{"type":"string","format":"date-time","description":"Rollover tracking period"}},"required":["id","type","amount","policy_id","created_at","profile_id","updated_at","tracking_period"],"title":"TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItemsEventsItems"},"TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItemsPolicyLeaveType":{"type":"string","enum":["SHORT_TERM_LEAVE","LONG_TERM_LEAVE"],"description":"Leave type","title":"TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItemsPolicyLeaveType"},"TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItemsPolicyPolicyType":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Policy type ID"},"name":{"type":"string","description":"Policy type name"}},"required":["id","name"],"title":"TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItemsPolicyPolicyType"},"TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItemsPolicyTrackingUnit":{"type":"string","enum":["HOUR","BUSINESS_DAY","CALENDAR_DAY","WEEK","MONTH","YEAR"],"description":"Tracking unit","title":"TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItemsPolicyTrackingUnit"},"TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItemsPolicyTimeOffTypesItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Time off type ID"},"name":{"type":"string","description":"Time off type name"}},"required":["id","name"],"title":"TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItemsPolicyTimeOffTypesItems"},"TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItemsPolicyTrackingCadence":{"type":"string","enum":["FIXED_DAY","ANNIVERSARY"],"description":"Tracking cadence","title":"TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItemsPolicyTrackingCadence"},"TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItemsPolicy":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Policy ID"},"name":{"type":"string","description":"Policy name"},"created_at":{"type":"string","format":"date-time","description":"Policy creation date"},"leave_type":{"$ref":"#/components/schemas/TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItemsPolicyLeaveType","description":"Leave type"},"updated_at":{"type":"string","format":"date-time","description":"Policy update date"},"description":{"type":"string","description":"Policy description"},"policy_type":{"$ref":"#/components/schemas/TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItemsPolicyPolicyType"},"tracking_unit":{"$ref":"#/components/schemas/TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItemsPolicyTrackingUnit","description":"Tracking unit"},"policy_type_id":{"type":"string","format":"uuid","description":"Policy type ID"},"time_off_types":{"type":"array","items":{"$ref":"#/components/schemas/TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItemsPolicyTimeOffTypesItems"}},"tracking_cadence":{"$ref":"#/components/schemas/TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItemsPolicyTrackingCadence","description":"Tracking cadence"},"tracking_start_date":{"type":"string","format":"date","description":"Tracking start date"},"tracking_unit_amount":{"type":"number","format":"double","description":"Tracking unit amount"}},"required":["id","name","created_at","updated_at"],"title":"TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItemsPolicy"},"TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItemsRolloversItemsAmount":{"oneOf":[{"type":"number","format":"double"},{"type":"string"}],"title":"TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItemsRolloversItemsAmount"},"TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItemsRolloversItems":{"type":"object","properties":{"amount":{"$ref":"#/components/schemas/TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItemsRolloversItemsAmount"},"expiration_date":{"type":"string","format":"date-time","description":"Rollover expiration date"},"rollover_tracking_period":{"type":"string","format":"date-time","description":"Rollover tracking period"}},"required":["amount","rollover_tracking_period"],"title":"TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItemsRolloversItems"},"TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItemsAccrualUnit":{"type":"string","enum":["HOUR","BUSINESS_DAY","CALENDAR_DAY","WEEK","MONTH","YEAR"],"description":"Accrual unit","title":"TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItemsAccrualUnit"},"TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItemsFutureEventsItemsType":{"type":"string","enum":["ACCRUAL","ACCRUAL_DEDUCTION","ACCRUAL_PRORATE","ACCRUAL_TERMINATION","MANUAL_ADJUSTMENT","NO_ROLLOVER","ROLLOVER_ADJUSTMENT","ROLLOVER_CARRY_OVER","ROLLOVER_EXPIRATION","ROLLOVER_PAYOUT","ROLLOVER_PROJECTED","TIME_OFF"],"description":"Event type","title":"TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItemsFutureEventsItemsType"},"TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItemsFutureEventsItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Event ID"},"type":{"$ref":"#/components/schemas/TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItemsFutureEventsItemsType","description":"Event type"},"amount":{"type":"number","format":"double","description":"Event amount"},"policy_id":{"type":"string","format":"uuid","description":"Policy ID"},"created_at":{"type":"string","format":"date-time","description":"Event creation date"},"event_date":{"type":"string","format":"date-time","description":"Event date"},"profile_id":{"type":"string","format":"uuid","description":"Profile ID"},"updated_at":{"type":"string","format":"date-time","description":"Event update date"},"description":{"type":"string","description":"Event description"},"time_off_id":{"type":"string","format":"uuid","description":"Time off ID"},"accrual_date":{"type":"string","format":"date-time","description":"Accrual date"},"expiration_date":{"type":"string","format":"date-time","description":"Expiration date"},"tracking_period":{"type":"string","format":"date-time","description":"Tracking period"},"rollover_tracking_period":{"type":"string","format":"date-time","description":"Rollover tracking period"}},"required":["id","type","amount","policy_id","created_at","profile_id","updated_at","tracking_period"],"title":"TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItemsFutureEventsItems"},"TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItems":{"type":"object","properties":{"id":{"type":"string","description":"Entitlement ID"},"used":{"type":"string","description":"Used time off"},"events":{"type":["array","null"],"items":{"$ref":"#/components/schemas/TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItemsEventsItems"}},"policy":{"$ref":"#/components/schemas/TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItemsPolicy"},"accrued":{"type":["string","null"],"description":"Accrued time off"},"expired":{"type":"string","description":"Expired time off"},"approved":{"type":"string","description":"Approved time off"},"allowance":{"type":["string","null"],"description":"Time off allowance"},"available":{"type":["string","null"],"description":"Available time off. Will be null if is_allowance_unlimited is true"},"requested":{"type":"string","description":"Requested time off"},"rollovers":{"type":["array","null"],"items":{"$ref":"#/components/schemas/TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItemsRolloversItems"}},"accrual_unit":{"$ref":"#/components/schemas/TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItemsAccrualUnit","description":"Accrual unit"},"future_events":{"type":["array","null"],"items":{"$ref":"#/components/schemas/TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItemsFutureEventsItems"}},"accrual_amount":{"type":"string","description":"Accrual amount"},"tracking_period":{"type":"string","description":"Tracking period"},"balance_adjusted":{"type":["string","null"],"description":"Balance adjusted"},"time_off_event_id":{"type":"string","description":"Time off event ID"},"upcoming_accruals":{"type":"string","description":"Upcoming accruals"},"total_entitlements":{"type":"string","description":"Total entitlements"},"past_tracking_periods":{"type":"array","items":{"type":"string"}},"is_allowance_unlimited":{"type":"boolean","description":"True when the allowance is unlimited"},"tracking_period_end_date":{"type":"string","description":"Tracking period end date"}},"required":["available","tracking_period","total_entitlements","is_allowance_unlimited","tracking_period_end_date"],"title":"TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItems"},"time-off_getTimeOffEntitlements_Response_200":{"type":"object","properties":{"entitlements":{"type":"array","items":{"$ref":"#/components/schemas/TimeOffsProfileHrisProfileIdEntitlementsGetResponsesContentApplicationJsonSchemaEntitlementsItems"}},"hris_profile_id":{"type":"string","description":"HRIS profile ID"}},"required":["entitlements","hris_profile_id"],"title":"time-off_getTimeOffEntitlements_Response_200"},"TimeOffsTimeOffEventsGetResponsesContentApplicationJsonSchemaDataItemsEventDetails":{"type":"object","properties":{"birth_date":{"type":"string","format":"date","description":"Start date of the time off"},"adoption_date":{"type":"string","format":"date","description":"End date of the time off"},"was_premature_birth":{"type":"boolean","description":"Was the child born prematurely?"},"estimated_birth_date":{"type":"string","format":"date","description":"The estimated date of the child birth"},"had_multiple_children":{"type":"boolean","description":"Was it the birth of multiple children?"},"estimated_adoption_date":{"type":"string","format":"date","description":"The estimated date of the child adoption"}},"description":"Details of the time off event","title":"TimeOffsTimeOffEventsGetResponsesContentApplicationJsonSchemaDataItemsEventDetails"},"TimeOffsTimeOffEventsGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Time off event id"},"type":{"type":"string","description":"The type of event"},"policy_id":{"type":"string","description":"Policy id"},"created_at":{"type":"string","format":"date-time","description":"Time off creation date"},"updated_at":{"type":"string","format":"date-time","description":"Time off update date"},"event_details":{"$ref":"#/components/schemas/TimeOffsTimeOffEventsGetResponsesContentApplicationJsonSchemaDataItemsEventDetails","description":"Details of the time off event"},"hris_profile_id":{"type":"string","format":"uuid","description":"Worker hris profile id"},"time_off_type_id":{"type":"string","description":"Time off type id"}},"required":["id","type","policy_id","created_at","updated_at","event_details","hris_profile_id","time_off_type_id"],"description":"Time off event object","title":"TimeOffsTimeOffEventsGetResponsesContentApplicationJsonSchemaDataItems"},"time-off_getTimeOffEvents_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/TimeOffsTimeOffEventsGetResponsesContentApplicationJsonSchemaDataItems"},"description":"List of time off events for the profile"}},"required":["data"],"description":"List of time off events for the profile","title":"time-off_getTimeOffEvents_Response_200"},"TimeOffsTimeOffEventsGetResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"path":{"type":"string","description":"The JSON path where input validation failed"},"message":{"type":"string","description":"A description of the returned error"}},"title":"TimeOffsTimeOffEventsGetResponsesContentApplicationJsonSchemaErrorsItems"},"TimeOffsTimeOffEventsGetResponsesContentApplicationJsonSchemaRequest":{"type":"object","properties":{"url":{"type":"string","description":"The relative URL of the failed request"},"code":{"type":"number","format":"double","description":"The code of the source handler which produced the returned error"},"docs":{"type":"string","description":"A link to the official documentation for the requested endpoint resource"},"method":{"type":"string","description":"The HTTP method of the failed request"},"source":{"type":"string","description":"The source handler which produced the returned error"},"status":{"type":"number","format":"double","description":"The status code of the response"},"api_req_id":{"type":"string","description":"The request ID of the failed request"}},"title":"TimeOffsTimeOffEventsGetResponsesContentApplicationJsonSchemaRequest"},"GetTimeOffEventsForProfileRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/TimeOffsTimeOffEventsGetResponsesContentApplicationJsonSchemaErrorsItems"}},"request":{"$ref":"#/components/schemas/TimeOffsTimeOffEventsGetResponsesContentApplicationJsonSchemaRequest"}},"title":"GetTimeOffEventsForProfileRequestBadRequestError"},"TimeOffsDailiesGetResponsesContentApplicationJsonSchemaDataItemsHolidaysItemsType":{"type":"string","enum":["MANDATORY","OPTIONAL","HIDDEN","HOLIDAY","WORKING_DAY"],"description":"Type of the holiday","title":"TimeOffsDailiesGetResponsesContentApplicationJsonSchemaDataItemsHolidaysItemsType"},"TimeOffsDailiesGetResponsesContentApplicationJsonSchemaDataItemsHolidaysItemsSource":{"type":"string","enum":["EXTERNAL","DEEL","ORGANIZATION_CUSTOM","ORGANIZATION_OVERRIDE","ORGANIZATION_CONVERT"],"description":"Source of creation of the holiday","title":"TimeOffsDailiesGetResponsesContentApplicationJsonSchemaDataItemsHolidaysItemsSource"},"TimeOffsDailiesGetResponsesContentApplicationJsonSchemaDataItemsHolidaysItems":{"type":"object","properties":{"date":{"type":"string","format":"date-time","description":"Date of the holiday"},"name":{"type":"string","description":"Name of the holiday"},"type":{"$ref":"#/components/schemas/TimeOffsDailiesGetResponsesContentApplicationJsonSchemaDataItemsHolidaysItemsType","description":"Type of the holiday"},"source":{"oneOf":[{"$ref":"#/components/schemas/TimeOffsDailiesGetResponsesContentApplicationJsonSchemaDataItemsHolidaysItemsSource"},{"type":"null"}],"description":"Source of creation of the holiday"},"states":{"type":"array","items":{"type":"string"},"description":"List of states where the holiday is celebrated, if empty it is a country holiday"},"country":{"type":"string","description":"The ISO 3166-1 alpha-2 country code."},"description":{"type":["string","null"],"description":"Description of the holiday"},"parsed_date":{"type":"string","format":"date-time","description":"Parsed date time of the holiday"},"is_mandatory":{"type":"boolean","description":"Describes if the holiday is mandatory"},"is_every_year":{"type":"boolean","description":"Sets if the holiday is a recurring event"},"formatted_date":{"type":"string","format":"date","description":"Formated 'YYYY-MM-DD' date of the holiday"},"name_variations":{"type":"array","items":{"type":"string"},"description":"Alternative names or labels used to refer to this holiday"},"created_by_profile_id":{"type":["number","null"],"format":"double","description":"HRIS profile id of the creator of the holiday"}},"required":["date","name","type","source","description","is_mandatory","is_every_year","formatted_date"],"title":"TimeOffsDailiesGetResponsesContentApplicationJsonSchemaDataItemsHolidaysItems"},"TimeOffsDailiesGetResponsesContentApplicationJsonSchemaDataItemsWorkScheduleWorkWeek":{"type":"object","properties":{"friday":{"type":"number","format":"double","description":"Working hours on friday"},"monday":{"type":"number","format":"double","description":"Working hours on monday"},"sunday":{"type":"number","format":"double","description":"Working hours on sunday"},"tuesday":{"type":"number","format":"double","description":"Working hours on tuesday"},"saturday":{"type":"number","format":"double","description":"Working hours on saturday"},"thursday":{"type":"number","format":"double","description":"Working hours on thursday"},"wednesday":{"type":"number","format":"double","description":"Working hours on wednesday"}},"required":["friday","monday","sunday","tuesday","saturday","thursday","wednesday"],"description":"The work week schedule for the HRIS profile","title":"TimeOffsDailiesGetResponsesContentApplicationJsonSchemaDataItemsWorkScheduleWorkWeek"},"TimeOffsDailiesGetResponsesContentApplicationJsonSchemaDataItemsWorkSchedule":{"type":"object","properties":{"work_week":{"$ref":"#/components/schemas/TimeOffsDailiesGetResponsesContentApplicationJsonSchemaDataItemsWorkScheduleWorkWeek","description":"The work week schedule for the HRIS profile"},"hours_per_day":{"type":"number","format":"double","description":"Working hours per day"},"hris_profile_id":{"type":"string","format":"uuid","description":"HRIS profile id"}},"description":"Detail of working hours by week day for an HRIS profile","title":"TimeOffsDailiesGetResponsesContentApplicationJsonSchemaDataItemsWorkSchedule"},"TimeOffsDailiesGetResponsesContentApplicationJsonSchemaDataItemsTimeOffDailiesItemsTimeOffDailyType":{"type":"string","enum":["HOLIDAY","WORKING_DAY","NON_WORKING_DAY"],"description":"Type of work status or holiday","title":"TimeOffsDailiesGetResponsesContentApplicationJsonSchemaDataItemsTimeOffDailiesItemsTimeOffDailyType"},"TimeOffsDailiesGetResponsesContentApplicationJsonSchemaDataItemsTimeOffDailiesItems":{"type":"object","properties":{"date":{"type":"string","format":"date","description":"Date of the daily"},"time_off_daily_type":{"$ref":"#/components/schemas/TimeOffsDailiesGetResponsesContentApplicationJsonSchemaDataItemsTimeOffDailiesItemsTimeOffDailyType","description":"Type of work status or holiday"}},"required":["date","time_off_daily_type"],"description":"Date with holiday or work status by day","title":"TimeOffsDailiesGetResponsesContentApplicationJsonSchemaDataItemsTimeOffDailiesItems"},"TimeOffsDailiesGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"holidays":{"type":"array","items":{"$ref":"#/components/schemas/TimeOffsDailiesGetResponsesContentApplicationJsonSchemaDataItemsHolidaysItems"},"description":"List of holidays within the date range "},"work_schedule":{"$ref":"#/components/schemas/TimeOffsDailiesGetResponsesContentApplicationJsonSchemaDataItemsWorkSchedule","description":"Detail of working hours by week day for an HRIS profile"},"time_off_dailies":{"type":"array","items":{"$ref":"#/components/schemas/TimeOffsDailiesGetResponsesContentApplicationJsonSchemaDataItemsTimeOffDailiesItems"},"description":"List of days with holiday or work status"}},"required":["holidays","work_schedule","time_off_dailies"],"title":"TimeOffsDailiesGetResponsesContentApplicationJsonSchemaDataItems"},"time-off_getTimeOffDailies_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/TimeOffsDailiesGetResponsesContentApplicationJsonSchemaDataItems"},"description":"List of holiday and work schedule information grouped by HRIS profile, including holidays within the date range, work schedule details, and daily work status"}},"title":"time-off_getTimeOffDailies_Response_200"},"TimeOffsDailiesGetResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"path":{"type":"string","description":"The JSON path where input validation failed"},"message":{"type":"string","description":"A description of the returned error"}},"title":"TimeOffsDailiesGetResponsesContentApplicationJsonSchemaErrorsItems"},"TimeOffsDailiesGetResponsesContentApplicationJsonSchemaRequest":{"type":"object","properties":{"url":{"type":"string","description":"The relative URL of the failed request"},"code":{"type":"number","format":"double","description":"The code of the source handler which produced the returned error"},"docs":{"type":"string","description":"A link to the official documentation for the requested endpoint resource"},"method":{"type":"string","description":"The HTTP method of the failed request"},"source":{"type":"string","description":"The source handler which produced the returned error"},"status":{"type":"number","format":"double","description":"The status code of the response"},"api_req_id":{"type":"string","description":"The request ID of the failed request"}},"title":"TimeOffsDailiesGetResponsesContentApplicationJsonSchemaRequest"},"GetWorkScheduleAndHolidaysRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/TimeOffsDailiesGetResponsesContentApplicationJsonSchemaErrorsItems"}},"request":{"$ref":"#/components/schemas/TimeOffsDailiesGetResponsesContentApplicationJsonSchemaRequest"}},"title":"GetWorkScheduleAndHolidaysRequestBadRequestError"},"TimeOffsProfileHrisProfileIdPoliciesGetParametersPolicyTypeName":{"type":"string","enum":["Moving leave","Adoption leave","Personal leave","Parental leave","Military leave","Childbirth leave","Study leave","Sick leave","Bereavement leave","Family & domestic violence leave","Marriage/wedding leave","Blood donation leave","Volunteer leave","Vacation","Doctor's appointment leave","Maternity leave","Hajj leave","Paternity leave","Civic/public duty leave","Childcare leave","Unpaid leave","Paid leave","Other leave","Disability leave","Pregnancy leave","RTT","Regional holiday","Breastfeeding leave","Advanced vacation"],"title":"TimeOffsProfileHrisProfileIdPoliciesGetParametersPolicyTypeName"},"TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsLeaveType":{"type":"string","enum":["SHORT_TERM_LEAVE","LONG_TERM_LEAVE"],"description":"Type of leave for this policy","title":"TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsLeaveType"},"TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPolicyType":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the policy type"},"name":{"type":"string","description":"Name of the policy type"}},"required":["id","name"],"description":"Type of this policy","title":"TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPolicyType"},"TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPaymentType":{"type":"string","enum":["PAID","UNPAID"],"description":"Payment type for the time off policy","title":"TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPaymentType"},"TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsTrackingUnit":{"type":"string","enum":["HOUR","BUSINESS_DAY","CALENDAR_DAY","WEEK","MONTH","YEAR"],"description":"Unit used for tracking policy periods","title":"TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsTrackingUnit"},"TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsTimeOffTypesItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the time off type"},"name":{"type":"string","description":"Name of the time off type"},"description":{"type":["string","null"],"description":"Description of the time off type"}},"title":"TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsTimeOffTypesItems"},"TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsTrackingCadence":{"type":"string","enum":["FIXED_DAY","ANNIVERSARY"],"description":"Cadence for tracking policy periods","title":"TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsTrackingCadence"},"TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPolicyAllowancesItemsType":{"type":"string","enum":["BASE_ALLOWANCE","ADDITIONAL_ALLOWANCE"],"description":"Type of the policy allowance","title":"TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPolicyAllowancesItemsType"},"TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPolicyAllowancesItemsAccrualType":{"type":"string","enum":["LUMPSUM","TIMEFRAME","EVENT","TIME_OFF_IN_LIEU"],"description":"Type of accrual for the allowance. Determines how/when profiles should earn their entitlement (aka: allowance).","title":"TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPolicyAllowancesItemsAccrualType"},"TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPolicyAllowancesItemsAccrualUnit":{"type":"string","enum":["HOUR","BUSINESS_DAY","CALENDAR_DAY","WEEK","MONTH","YEAR"],"description":"Unit used for accrual","title":"TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPolicyAllowancesItemsAccrualUnit"},"TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPolicyAllowancesItemsRolloverType":{"type":"string","enum":["NO_ROLLOVER","PAY_OUT","CARRY_OVER","CARRY_OVER_PAY_OUT"],"description":"Type of rollover","title":"TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPolicyAllowancesItemsRolloverType"},"TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPolicyAllowancesItemsEntitlementUnit":{"type":"string","enum":["HOUR","BUSINESS_DAY","CALENDAR_DAY","WEEK","MONTH","YEAR"],"description":"Unit used for entitlement","title":"TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPolicyAllowancesItemsEntitlementUnit"},"TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPolicyAllowancesItemsBalanceTrackingType":{"type":"string","enum":["INFLEXIBLE","FLEXIBLE_NO_LIMIT","FLEXIBLE_CUSTOM_AMOUNT","FLEXIBLE_UP_TO_YEARLY_ALLOWANCE"],"description":"Type of balance tracking. Determines how workers can request their time off.","title":"TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPolicyAllowancesItemsBalanceTrackingType"},"TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPolicyAllowancesItemsEntitlementStartType":{"type":"string","enum":["IMMEDIATELY","FIXED_PERIOD","FIXED_DAY"],"description":"Type of entitlement start","title":"TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPolicyAllowancesItemsEntitlementStartType"},"TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPolicyAllowancesItemsEntitlementStartUnit":{"type":"string","enum":["HOUR","BUSINESS_DAY","CALENDAR_DAY","WEEK","MONTH","YEAR"],"description":"Unit used for entitlement start","title":"TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPolicyAllowancesItemsEntitlementStartUnit"},"TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPolicyAllowancesItemsAccrualApplicationType":{"type":"string","enum":["BEGIN_OF_CYCLE","END_OF_CYCLE","BEGIN_OF_NEXT_CYCLE"],"description":"Type of accrual application. Enum to indicate when accruals will be applied within the accrual cycles.","title":"TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPolicyAllowancesItemsAccrualApplicationType"},"TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPolicyAllowancesItemsRolloverExpirationUnit":{"type":"string","enum":["HOUR","BUSINESS_DAY","CALENDAR_DAY","WEEK","MONTH","YEAR"],"description":"Unit used for rollover expiration","title":"TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPolicyAllowancesItemsRolloverExpirationUnit"},"TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPolicyAllowancesItemsEntitlementExpirationUnit":{"type":"string","enum":["HOUR","BUSINESS_DAY","CALENDAR_DAY","WEEK","MONTH","YEAR"],"description":"Unit used for entitlement expiration","title":"TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPolicyAllowancesItemsEntitlementExpirationUnit"},"TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPolicyAllowancesItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the policy allowance"},"type":{"$ref":"#/components/schemas/TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPolicyAllowancesItemsType","description":"Type of the policy allowance"},"accrual_type":{"$ref":"#/components/schemas/TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPolicyAllowancesItemsAccrualType","description":"Type of accrual for the allowance. Determines how/when profiles should earn their entitlement (aka: allowance)."},"accrual_unit":{"oneOf":[{"$ref":"#/components/schemas/TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPolicyAllowancesItemsAccrualUnit"},{"type":"null"}],"description":"Unit used for accrual"},"rollover_type":{"oneOf":[{"$ref":"#/components/schemas/TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPolicyAllowancesItemsRolloverType"},{"type":"null"}],"description":"Type of rollover"},"entitlement_unit":{"oneOf":[{"$ref":"#/components/schemas/TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPolicyAllowancesItemsEntitlementUnit"},{"type":"null"}],"description":"Unit used for entitlement"},"accrual_unit_amount":{"type":["number","null"],"format":"double","description":"Amount of accrual units"},"enable_bank_holidays":{"type":"boolean","description":"Whether bank holidays are enabled for this allowance"},"balance_tracking_type":{"oneOf":[{"$ref":"#/components/schemas/TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPolicyAllowancesItemsBalanceTrackingType"},{"type":"null"}],"description":"Type of balance tracking. Determines how workers can request their time off."},"entitlement_start_date":{"type":["string","null"],"format":"date","description":"Start date for entitlement"},"entitlement_start_type":{"$ref":"#/components/schemas/TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPolicyAllowancesItemsEntitlementStartType","description":"Type of entitlement start"},"entitlement_start_unit":{"oneOf":[{"$ref":"#/components/schemas/TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPolicyAllowancesItemsEntitlementStartUnit"},{"type":"null"}],"description":"Unit used for entitlement start"},"entitlement_unit_amount":{"type":["number","null"],"format":"double","description":"Amount of entitlement units"},"accrual_application_type":{"oneOf":[{"$ref":"#/components/schemas/TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPolicyAllowancesItemsAccrualApplicationType"},{"type":"null"}],"description":"Type of accrual application. Enum to indicate when accruals will be applied within the accrual cycles."},"rollover_expiration_unit":{"oneOf":[{"$ref":"#/components/schemas/TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPolicyAllowancesItemsRolloverExpirationUnit"},{"type":"null"}],"description":"Unit used for rollover expiration"},"rollover_limit_unit_amount":{"type":["number","null"],"format":"double","description":"Amount of rollover limit units"},"entitlement_expiration_unit":{"oneOf":[{"$ref":"#/components/schemas/TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPolicyAllowancesItemsEntitlementExpirationUnit"},{"type":"null"}],"description":"Unit used for entitlement expiration"},"entitlement_start_unit_amount":{"type":["number","null"],"format":"double","description":"Amount of entitlement start units"},"rollover_expiration_unit_amount":{"type":["number","null"],"format":"double","description":"Amount of rollover expiration units"},"entitlement_expiration_unit_amount":{"type":["number","null"],"format":"double","description":"Amount of entitlement expiration units"},"zero_out_negative_balances_on_rollover":{"type":"boolean","description":"Whether negative balances are zeroed out on rollover"},"part_time_prorated_entitlement_unit_amount":{"type":["number","null"],"format":"double","description":"The total prorated policy allowance entitlement amount if the worker is part-time."},"balance_tracking_flexible_custom_request_amount":{"type":["number","null"],"format":"double","description":"Amount for flexible custom request balance tracking. The flexible custom extra amount request of the policy allowance."}},"required":["id","type","accrual_type","accrual_unit","rollover_type","entitlement_unit","accrual_unit_amount","enable_bank_holidays","balance_tracking_type","entitlement_start_date","entitlement_start_type","entitlement_start_unit","entitlement_unit_amount","accrual_application_type","rollover_expiration_unit","rollover_limit_unit_amount","entitlement_expiration_unit","entitlement_start_unit_amount","rollover_expiration_unit_amount","entitlement_expiration_unit_amount","zero_out_negative_balances_on_rollover","balance_tracking_flexible_custom_request_amount"],"title":"TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPolicyAllowancesItems"},"TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsNoticePeriodUnit":{"type":"string","enum":["HOUR","BUSINESS_DAY","CALENDAR_DAY","WEEK","MONTH","YEAR"],"description":"Unit for notice period","title":"TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsNoticePeriodUnit"},"TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsRequestStartType":{"type":"string","enum":["IMMEDIATELY","FIXED_PERIOD"],"description":"Type of request start configuration","title":"TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsRequestStartType"},"TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsRequestStartUnit":{"type":"string","enum":["HOUR","BUSINESS_DAY","CALENDAR_DAY","WEEK","MONTH","YEAR"],"description":"Unit used for request start configuration","title":"TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsRequestStartUnit"},"TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsOverlapRequestType":{"type":"string","enum":["ALLOWED","NOT_ALLOWED"],"description":"Type of overlapping requests allowed","title":"TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsOverlapRequestType"},"TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsTimeOffRequestType":{"type":"string","enum":["HALF_DAY","HOURLY","FULL_DAY","PERCENTAGE","PARTIAL_HOURS"],"description":"Type of time off requests allowed","title":"TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsTimeOffRequestType"},"TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsIsAttachmentRequired":{"type":"string","enum":["NOT_REQUIRED","REQUIRED","CONDITIONALLY_REQUIRED"],"description":"Whether an attachment is required for time off requests","title":"TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsIsAttachmentRequired"},"TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPolicyAllowanceProrationPartTimeWorkerTreatmentType":{"type":"string","enum":["SAME_AS_FTE","PERCENTAGE_OF_FTE","BASED_ON_WORK_HOURS","BASED_ON_WORK_DAYS","CUSTOM_ENTITLEMENT"],"description":"Type of treatment for part-time workers","title":"TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPolicyAllowanceProrationPartTimeWorkerTreatmentType"},"TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPolicyAllowanceProration":{"type":"object","properties":{"prorates_on_hire":{"type":"boolean","description":"Whether proration is applied on hire"},"prorates_on_termination":{"type":"boolean","description":"Whether proration is applied on termination"},"part_time_worker_treatment_type":{"$ref":"#/components/schemas/TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPolicyAllowanceProrationPartTimeWorkerTreatmentType","description":"Type of treatment for part-time workers"},"part_time_worker_treatment_specific_amount":{"type":["number","null"],"format":"double","description":"Specific amount for part-time worker treatment when the type is CUSTOM_ENTITLEMENT"}},"required":["prorates_on_hire","prorates_on_termination","part_time_worker_treatment_type","part_time_worker_treatment_specific_amount"],"description":"Proration configuration for policy allowances","title":"TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPolicyAllowanceProration"},"TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsRetrospectiveRequestType":{"type":"string","enum":["ALLOWED","NOT_ALLOWED"],"description":"Type of retrospective requests allowed","title":"TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsRetrospectiveRequestType"},"TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsAutoApprovalInactivityTimeUnit":{"type":"string","enum":["HOUR","BUSINESS_DAY","CALENDAR_DAY","WEEK","MONTH","YEAR"],"description":"Unit for auto-approval inactivity time","title":"TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsAutoApprovalInactivityTimeUnit"},"TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the policy"},"name":{"type":"string","description":"Name of the policy"},"created_at":{"type":"string","format":"date-time","description":"Date and time when the policy was created"},"leave_type":{"$ref":"#/components/schemas/TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsLeaveType","description":"Type of leave for this policy"},"updated_at":{"type":"string","format":"date-time","description":"Date and time when the policy was last updated"},"description":{"type":["string","null"],"description":"Description of the policy"},"policy_type":{"$ref":"#/components/schemas/TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPolicyType","description":"Type of this policy"},"payment_type":{"$ref":"#/components/schemas/TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPaymentType","description":"Payment type for the time off policy"},"tracking_unit":{"oneOf":[{"$ref":"#/components/schemas/TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsTrackingUnit"},{"type":"null"}],"description":"Unit used for tracking policy periods"},"policy_type_id":{"type":"string","format":"uuid","description":"Unique identifier of the policy type"},"time_off_types":{"type":"array","items":{"$ref":"#/components/schemas/TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsTimeOffTypesItems"},"description":"Time off types associated with this policy"},"tracking_cadence":{"oneOf":[{"$ref":"#/components/schemas/TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsTrackingCadence"},{"type":"null"}],"description":"Cadence for tracking policy periods"},"policy_allowances":{"type":"array","items":{"$ref":"#/components/schemas/TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPolicyAllowancesItems"},"description":"Allowances associated with this policy"},"notice_period_unit":{"oneOf":[{"$ref":"#/components/schemas/TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsNoticePeriodUnit"},{"type":"null"}],"description":"Unit for notice period"},"request_start_type":{"oneOf":[{"$ref":"#/components/schemas/TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsRequestStartType"},{"type":"null"}],"description":"Type of request start configuration"},"request_start_unit":{"oneOf":[{"$ref":"#/components/schemas/TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsRequestStartUnit"},{"type":"null"}],"description":"Unit used for request start configuration"},"tracking_start_date":{"type":["string","null"],"format":"date","description":"Start date for tracking policy periods"},"overlap_request_type":{"$ref":"#/components/schemas/TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsOverlapRequestType","description":"Type of overlapping requests allowed"},"tracking_unit_amount":{"type":["number","null"],"format":"double","description":"Amount of tracking units"},"time_off_request_type":{"$ref":"#/components/schemas/TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsTimeOffRequestType","description":"Type of time off requests allowed"},"is_attachment_required":{"$ref":"#/components/schemas/TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsIsAttachmentRequired","description":"Whether an attachment is required for time off requests"},"is_description_required":{"type":"boolean","description":"Whether a description is required for time off requests"},"notice_period_unit_amount":{"type":["number","null"],"format":"double","description":"Amount of notice period units"},"request_start_unit_amount":{"type":["number","null"],"format":"double","description":"Amount of request start units"},"policy_allowance_proration":{"$ref":"#/components/schemas/TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsPolicyAllowanceProration","description":"Proration configuration for policy allowances"},"retrospective_request_type":{"$ref":"#/components/schemas/TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsRetrospectiveRequestType","description":"Type of retrospective requests allowed"},"allow_to_edit_past_time_offs":{"type":"boolean","description":"Whether editing past time offs is allowed"},"auto_approval_inactivity_time_unit":{"oneOf":[{"$ref":"#/components/schemas/TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItemsAutoApprovalInactivityTimeUnit"},{"type":"null"}],"description":"Unit for auto-approval inactivity time"},"auto_approval_inactivity_time_unit_amount":{"type":["number","null"],"format":"double","description":"Amount of auto-approval inactivity time units"}},"required":["id","name","created_at","leave_type","updated_at","policy_type","payment_type","tracking_unit","policy_allowances","notice_period_unit","request_start_type","request_start_unit","overlap_request_type","tracking_unit_amount","time_off_request_type","is_attachment_required","is_description_required","notice_period_unit_amount","request_start_unit_amount","policy_allowance_proration","retrospective_request_type","allow_to_edit_past_time_offs","auto_approval_inactivity_time_unit","auto_approval_inactivity_time_unit_amount"],"description":"Time off policy","title":"TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItems"},"time-off_getTimeOffPolicies_Response_200":{"type":"object","properties":{"policies":{"type":"array","items":{"$ref":"#/components/schemas/TimeOffsProfileHrisProfileIdPoliciesGetResponsesContentApplicationJsonSchemaPoliciesItems"}}},"title":"time-off_getTimeOffPolicies_Response_200"},"ListPoliciesRequestNotFoundError":{"type":"object","properties":{"message":{"type":"string"}},"title":"ListPoliciesRequestNotFoundError"},"TimeOffsProfileHrisProfileIdGetParametersStatusSchemaItems":{"type":"string","enum":["REQUESTED","APPROVED","REJECTED","USED","CANCELED"],"title":"TimeOffsProfileHrisProfileIdGetParametersStatusSchemaItems"},"TimeOffsProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataItemsStatus":{"type":"string","enum":["REQUESTED","APPROVED","REJECTED","USED","CANCELED"],"description":"Status of time off","title":"TimeOffsProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataItemsStatus"},"TimeOffsProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataItemsEntitlementUnit":{"type":"string","enum":["HOUR","BUSINESS_DAY","CALENDAR_DAY","WEEK","MONTH","YEAR"],"description":"The unit in which the time off usage and entitlement are calculated.","title":"TimeOffsProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataItemsEntitlementUnit"},"TimeOffsProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataItemsTimeOffDailiesItemsType":{"type":"string","enum":["WORKING_DAY","NON_WORKING_DAY","HOLIDAY"],"description":"Time off daily type","title":"TimeOffsProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataItemsTimeOffDailiesItemsType"},"TimeOffsProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataItemsTimeOffDailiesItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Time off daily id"},"date":{"type":"string","format":"date","description":"Time off daily date"},"type":{"$ref":"#/components/schemas/TimeOffsProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataItemsTimeOffDailiesItemsType","description":"Time off daily type"},"amount":{"type":"number","format":"double","description":"Time off daily amount"},"created_at":{"type":"string","format":"date-time","description":"Time off daily creation date"},"updated_at":{"type":"string","format":"date-time","description":"Time off daily update date"},"description":{"type":["string","null"],"description":"Time off daily description"},"time_off_id":{"type":"string","format":"uuid","description":"Time off id"}},"required":["id","date","type","amount","created_at","updated_at","time_off_id"],"title":"TimeOffsProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataItemsTimeOffDailiesItems"},"TimeOffsProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataItemsRecipientProfile":{"type":"object","properties":{"hris_profile_id":{"type":"string","format":"uuid","description":"Recipient hris profile id"},"organization_id":{"type":"string","format":"uuid","description":"Recipient organization id"},"client_profile_id":{"type":"string","format":"uuid","description":"Recipient client profile id"}},"title":"TimeOffsProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataItemsRecipientProfile"},"TimeOffsProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataItemsRequesterProfile":{"type":"object","properties":{"hris_profile_id":{"type":"string","format":"uuid","description":"Request hris profile id"},"organization_id":{"type":"string","format":"uuid","description":"Request organization id"},"client_profile_id":{"type":"string","format":"uuid","description":"Request client profile id"}},"title":"TimeOffsProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataItemsRequesterProfile"},"TimeOffsProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Time off id"},"amount":{"type":"number","format":"double","description":"Amount of time off"},"reason":{"type":"string","description":"Reason for time off"},"status":{"$ref":"#/components/schemas/TimeOffsProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataItemsStatus","description":"Status of time off"},"is_paid":{"type":"boolean","description":"Is time off paid"},"end_date":{"type":"string","format":"date","description":"End date of time off"},"created_at":{"type":"string","format":"date-time","description":"Time off creation date"},"start_date":{"type":"string","format":"date","description":"Start date of time off"},"updated_at":{"type":"string","format":"date-time","description":"Time off update date"},"approved_at":{"type":["string","null"],"format":"date-time","description":"Time off approval date"},"description":{"type":["string","null"],"description":"Time off description"},"contract_oid":{"type":"string","description":"Contract id"},"requested_at":{"type":"string","format":"date","description":"Time off request date"},"half_end_date":{"type":"boolean","description":"Is half end date. Only used for backwards compatibility, please do not use."},"half_start_date":{"type":"boolean","description":"Is half start date. Only used for backwards compatibility, please do not use."},"deduction_amount":{"type":["number","null"],"format":"double","description":"Deduction amount"},"entitlement_unit":{"$ref":"#/components/schemas/TimeOffsProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataItemsEntitlementUnit","description":"The unit in which the time off usage and entitlement are calculated."},"time_off_dailies":{"type":"array","items":{"$ref":"#/components/schemas/TimeOffsProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataItemsTimeOffDailiesItems"}},"time_off_type_id":{"type":"string","description":"Time off type id"},"recipient_profile":{"$ref":"#/components/schemas/TimeOffsProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataItemsRecipientProfile"},"requester_profile":{"$ref":"#/components/schemas/TimeOffsProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataItemsRequesterProfile"},"time_off_percentage":{"type":["number","null"],"format":"double","description":"Time off percentage"},"is_end_date_estimated":{"type":"boolean","description":"Is end date estimated"},"other_type_description":{"type":["string","null"],"description":"Other type description"}},"required":["id","amount","is_paid","end_date","created_at","start_date","updated_at","requested_at","half_end_date","half_start_date","entitlement_unit","time_off_type_id"],"title":"TimeOffsProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataItems"},"time-off_getTimeOffProfile_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/TimeOffsProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataItems"}},"next":{"type":"string"},"page_size":{"type":"integer","description":"Page size"},"has_next_page":{"type":"boolean","description":"Has next page"}},"required":["data","page_size","has_next_page"],"description":"Time offs associated to the query","title":"time-off_getTimeOffProfile_Response_200"},"TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyTypesItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the policy type."},"name":{"type":"string","description":"Name of the policy type."},"description":{"type":["string","null"],"description":"Description of the policy type."}},"title":"TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyTypesItems"},"TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsLeaveType":{"type":"string","enum":["SHORT_TERM_LEAVE","LONG_TERM_LEAVE"],"description":"Classification of the leave duration.","title":"TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsLeaveType"},"TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyType":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the policy type."},"name":{"type":"string","description":"Name of the policy type."},"description":{"type":["string","null"],"description":"Description of the policy type."}},"description":"Details of the associated policy type.","title":"TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyType"},"TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsTrackingUnit":{"type":"string","enum":["YEAR","MONTH","WEEK","DAY","BUSINESS_DAY","CALENDAR_DAY","HOUR"],"description":"The unit used for tracking the policy cycle (e.g., yearly).","title":"TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsTrackingUnit"},"TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsTrackingCadence":{"type":"string","enum":["FIXED_DAY","ANNIVERSARY"],"description":"Determines when the tracking cycle starts.","title":"TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsTrackingCadence"},"TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItemsType":{"type":"string","enum":["BASE_ALLOWANCE","ADDITIONAL_ALLOWANCE"],"description":"Type of allowance (base or additional).","title":"TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItemsType"},"TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItemsAccrualType":{"type":"string","enum":["TIMEFRAME","EVENT_BASED","EVENT","TIME_OFF_IN_LIEU","HOURLY","LUMPSUM"],"description":"How entitlement accrues (over time or based on events).","title":"TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItemsAccrualType"},"TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItemsAccrualUnit":{"type":"string","enum":["YEAR","MONTH","WEEK","DAY","BUSINESS_DAY","CALENDAR_DAY","HOUR"],"description":"Unit for accrual if type is TIMEFRAME.","title":"TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItemsAccrualUnit"},"TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItemsRolloverType":{"type":"string","enum":["NO_ROLLOVER","LIMITED_ROLLOVER","UNLIMITED_ROLLOVER","PAY_OUT","CARRY_OVER","CARRY_OVER_PAY_OUT"],"description":"Rule for carrying over unused balance to the next cycle.","title":"TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItemsRolloverType"},"TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItemsEntitlementUnit":{"type":"string","enum":["YEAR","MONTH","WEEK","DAY","BUSINESS_DAY","CALENDAR_DAY","HOUR"],"description":"Unit in which the entitlement is measured.","title":"TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItemsEntitlementUnit"},"TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItemsTerminationType":{"type":"string","enum":["NO_PAYOUT","PAYOUT_BALANCE"],"description":"Rule for handling the balance upon termination.","title":"TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItemsTerminationType"},"TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItemsAccrualProrateTypesItems":{"type":"string","enum":["PRORATE_UNPAID_LEAVE","PRORATE_PAID_LEAVE","NO_PRORATE"],"title":"TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItemsAccrualProrateTypesItems"},"TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItemsBalanceTrackingType":{"type":"string","enum":["FLEXIBLE_UP_TO_YEARLY_ALLOWANCE","FLEXIBLE_NO_LIMIT","FLEXIBLE_CUSTOM_AMOUNT","INFLEXIBLE"],"description":"How the balance is tracked (e.g., flexible, inflexible).","title":"TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItemsBalanceTrackingType"},"TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItemsEntitlementStartType":{"type":"string","enum":["IMMEDIATELY","FIXED_PERIOD","FIXED_DATE"],"description":"When the entitlement starts.","title":"TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItemsEntitlementStartType"},"TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItemsEntitlementStartUnit":{"type":"string","enum":["YEAR","MONTH","WEEK","DAY","BUSINESS_DAY","CALENDAR_DAY","HOUR"],"description":"Unit for the start period if type is FIXED_PERIOD.","title":"TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItemsEntitlementStartUnit"},"TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItemsAccrualApplicationType":{"type":"string","enum":["BEGIN_OF_CYCLE","BEGIN_OF_NEXT_CYCLE","END_OF_CYCLE"],"description":"When the accrued amount is applied to the balance.","title":"TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItemsAccrualApplicationType"},"TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItemsRolloverExpirationUnit":{"type":"string","enum":["YEAR","MONTH","WEEK","DAY","BUSINESS_DAY","CALENDAR_DAY","HOUR"],"description":"Unit for the expiration period of rolled-over balance.","title":"TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItemsRolloverExpirationUnit"},"TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItemsAdditionalAllowanceRulesItems":{"type":"object","properties":{},"title":"TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItemsAdditionalAllowanceRulesItems"},"TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItemsEntitlementExpirationUnit":{"type":"string","enum":["YEAR","MONTH","WEEK","DAY","BUSINESS_DAY","CALENDAR_DAY","HOUR"],"description":"Unit for entitlement expiration period.","title":"TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItemsEntitlementExpirationUnit"},"TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItemsPartTimeWorkerAdditionalAllowanceType":{"type":"string","enum":["SAME_AS_FTE","PERCENTAGE_OF_FTE","NO_ADDITIONAL_ALLOWANCE"],"description":"How additional allowances apply to part-time workers.","title":"TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItemsPartTimeWorkerAdditionalAllowanceType"},"TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the policy allowance."},"name":{"type":"string","description":"Name of the allowance."},"type":{"$ref":"#/components/schemas/TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItemsType","description":"Type of allowance (base or additional)."},"accrual_type":{"$ref":"#/components/schemas/TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItemsAccrualType","description":"How entitlement accrues (over time or based on events)."},"accrual_unit":{"oneOf":[{"$ref":"#/components/schemas/TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItemsAccrualUnit"},{"type":"null"}],"description":"Unit for accrual if type is TIMEFRAME."},"rollover_type":{"oneOf":[{"$ref":"#/components/schemas/TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItemsRolloverType"},{"type":"null"}],"description":"Rule for carrying over unused balance to the next cycle."},"entitlement_unit":{"$ref":"#/components/schemas/TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItemsEntitlementUnit","description":"Unit in which the entitlement is measured."},"termination_type":{"$ref":"#/components/schemas/TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItemsTerminationType","description":"Rule for handling the balance upon termination."},"accrual_unit_amount":{"type":["integer","null"],"description":"Amount of accrual per unit if type is TIMEFRAME."},"enable_bank_holidays":{"type":"boolean","description":"Whether bank holidays affect the entitlement or usage."},"accrual_prorate_types":{"type":["array","null"],"items":{"$ref":"#/components/schemas/TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItemsAccrualProrateTypesItems"},"description":"Specifies conditions under which accrual should be prorated."},"balance_tracking_type":{"oneOf":[{"$ref":"#/components/schemas/TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItemsBalanceTrackingType"},{"type":"null"}],"description":"How the balance is tracked (e.g., flexible, inflexible)."},"entitlement_start_type":{"oneOf":[{"$ref":"#/components/schemas/TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItemsEntitlementStartType"},{"type":"null"}],"description":"When the entitlement starts."},"entitlement_start_unit":{"oneOf":[{"$ref":"#/components/schemas/TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItemsEntitlementStartUnit"},{"type":"null"}],"description":"Unit for the start period if type is FIXED_PERIOD."},"entitlement_unit_amount":{"type":["number","null"],"format":"double","description":"Amount of entitlement granted in entitlement_unit."},"accrual_application_type":{"oneOf":[{"$ref":"#/components/schemas/TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItemsAccrualApplicationType"},{"type":"null"}],"description":"When the accrued amount is applied to the balance."},"rollover_expiration_unit":{"oneOf":[{"$ref":"#/components/schemas/TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItemsRolloverExpirationUnit"},{"type":"null"}],"description":"Unit for the expiration period of rolled-over balance."},"additional_allowance_rules":{"type":"array","items":{"$ref":"#/components/schemas/TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItemsAdditionalAllowanceRulesItems"},"description":"Specific rules governing additional allowances."},"rollover_limit_unit_amount":{"type":["integer","null"],"description":"Maximum amount that can be rolled over if type is LIMITED_ROLLOVER."},"entitlement_expiration_unit":{"oneOf":[{"$ref":"#/components/schemas/TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItemsEntitlementExpirationUnit"},{"type":"null"}],"description":"Unit for entitlement expiration period."},"entitlement_start_unit_amount":{"type":["integer","null"],"description":"Amount for the start period if type is FIXED_PERIOD."},"rollover_expiration_unit_amount":{"type":["integer","null"],"description":"Amount for the expiration period of rolled-over balance."},"entitlement_expiration_unit_amount":{"type":["integer","null"],"description":"Amount for entitlement expiration period."},"zero_out_negative_balances_on_rollover":{"type":"boolean","description":"Whether negative balances are reset to zero at rollover."},"part_time_worker_additional_allowance_type":{"$ref":"#/components/schemas/TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItemsPartTimeWorkerAdditionalAllowanceType","description":"How additional allowances apply to part-time workers."},"balance_tracking_flexible_custom_request_amount":{"type":["integer","null"],"description":"Custom amount for flexible balance tracking if applicable."}},"title":"TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItems"},"TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsNoticePeriodUnit":{"type":"string","enum":["YEAR","MONTH","WEEK","DAY","BUSINESS_DAY","CALENDAR_DAY","HOUR"],"description":"Unit for the required notice period.","title":"TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsNoticePeriodUnit"},"TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsRequestStartType":{"type":"string","enum":["IMMEDIATELY","FIXED_PERIOD"],"description":"When a worker can start requesting time off after becoming eligible.","title":"TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsRequestStartType"},"TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsRequestStartUnit":{"type":"string","enum":["YEAR","MONTH","WEEK","DAY","BUSINESS_DAY","CALENDAR_DAY","HOUR"],"description":"Unit for the waiting period if request_start_type is FIXED_PERIOD.","title":"TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsRequestStartUnit"},"TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsBenefitsPayerType":{"type":"string","enum":["ORGANIZATION","GOVERNMENT"],"description":"Who pays for the benefits associated with this time off.","title":"TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsBenefitsPayerType"},"TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsAttachmentCondition":{"type":"string","enum":["GREATER_THAN","LESS_THAN","GREATER_THAN_OR_EQUAL","LESS_THAN_OR_EQUAL"],"description":"Comparison operator if attachment is conditionally required.","title":"TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsAttachmentCondition"},"TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsOverlapRequestType":{"type":"string","enum":["ALLOWED","NOT_ALLOWED","ALLOWED_WITH_APPROVAL"],"description":"Rule for requesting time off that overlaps with existing requests.","title":"TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsOverlapRequestType"},"TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsTimeOffRequestType":{"type":"string","enum":["FULL_DAY","HALF_DAY","HOURLY","PERCENTAGE","FLEXIBLE"],"description":"Allowed types of time off requests (e.g., full day, hourly).","title":"TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsTimeOffRequestType"},"TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsAdoptionDateDefinition":{"type":"string","enum":["REQUIRED","OPTIONAL","FORBIDDEN"],"description":"Rule regarding the requirement of an adoption date for relevant policies.","title":"TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsAdoptionDateDefinition"},"TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsAttachmentConditionUnit":{"type":"string","enum":["YEAR","MONTH","WEEK","DAY","BUSINESS_DAY","CALENDAR_DAY","HOUR"],"description":"Unit for the attachment condition amount.","title":"TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsAttachmentConditionUnit"},"TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsTimeOffTypeValidationsItems":{"type":"object","properties":{},"title":"TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsTimeOffTypeValidationsItems"},"TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowanceProrationHireProrationRule":{"type":"string","enum":["NO_PRORATION","FULL_AMOUNT","PRORATED_MONTHLY","PRORATED_DAILY","COUNTRY_SPECIFIC","FULL_MONTH_PRORATION_BASED_ON_DAY","TENURE_BOUNDARY_PRORATION"],"description":"Rule for prorating entitlement upon hiring.","title":"TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowanceProrationHireProrationRule"},"TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowanceProrationTerminationProrationRule":{"type":"string","enum":["NO_PRORATION","FULL_AMOUNT","PRORATED_MONTHLY","PRORATED_DAILY","COUNTRY_SPECIFIC","FULL_MONTH_PRORATION_BASED_ON_DAY","TENURE_BOUNDARY_PRORATION"],"description":"Rule for prorating entitlement upon termination.","title":"TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowanceProrationTerminationProrationRule"},"TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowanceProrationPartTimeWorkerTreatmentType":{"type":"string","enum":["SAME_AS_FTE","SPECIFIC_AMOUNT","PRO_RATA","PERCENTAGE_OF_FTE","BASED_ON_WORK_HOURS","BASED_ON_WORK_DAYS","CUSTOM_ENTITLEMENT"],"description":"How part-time workers are treated regarding entitlement.","title":"TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowanceProrationPartTimeWorkerTreatmentType"},"TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowanceProration":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the proration settings."},"has_partial_prorate":{"type":"boolean","description":"Indicates if partial proration rules are applied."},"hire_proration_rule":{"$ref":"#/components/schemas/TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowanceProrationHireProrationRule","description":"Rule for prorating entitlement upon hiring."},"is_accrual_prorate_policy":{"type":"boolean","description":"Indicates if accrual is prorated based on policy rules."},"termination_proration_rule":{"$ref":"#/components/schemas/TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowanceProrationTerminationProrationRule","description":"Rule for prorating entitlement upon termination."},"hire_proration_cut_off_date":{"type":["integer","null"],"description":"Day of the month used as cut-off for hire proration."},"part_time_worker_treatment_type":{"$ref":"#/components/schemas/TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowanceProrationPartTimeWorkerTreatmentType","description":"How part-time workers are treated regarding entitlement."},"termination_proration_cut_off_date":{"type":["integer","null"],"description":"Day of the month used as cut-off for termination proration."},"part_time_worker_treatment_specific_amount":{"type":["number","null"],"format":"double","description":"Specific amount if treatment type is SPECIFIC_AMOUNT."},"max_part_time_worker_treatment_specific_amount":{"type":["number","null"],"format":"double","description":"Maximum specific amount for part-time treatment."},"min_part_time_worker_treatment_specific_amount":{"type":["number","null"],"format":"double","description":"Minimum specific amount for part-time treatment."}},"description":"Proration rules applied to the policy allowances.","title":"TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowanceProration"},"TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsRetrospectiveRequestType":{"type":"string","enum":["ALLOWED","NOT_ALLOWED","ALLOWED_WITH_APPROVAL"],"description":"Rule for requesting time off for past dates.","title":"TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsRetrospectiveRequestType"},"TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsUploadAttachmentCondition":{"type":"string","enum":["REQUIRED","NOT_REQUIRED","CONDITIONALLY_REQUIRED","REQUIRED_WITH_CONDITION","ALWAYS_REQUIRED"],"description":"Condition under which an attachment is needed for a request.","title":"TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsUploadAttachmentCondition"},"TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsAutoApprovalInactivityTimeUnit":{"type":"string","enum":["YEAR","MONTH","WEEK","DAY","BUSINESS_DAY","CALENDAR_DAY","HOUR"],"description":"Unit for the auto-approval inactivity period.","title":"TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsAutoApprovalInactivityTimeUnit"},"TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyValidationTemplateRemindersItems":{"type":"object","properties":{},"title":"TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyValidationTemplateRemindersItems"},"TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the policy validation template."},"country":{"type":["string","null"],"description":"Country code associated with this specific template instance, if applicable."},"leave_type":{"$ref":"#/components/schemas/TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsLeaveType","description":"Classification of the leave duration."},"policy_type":{"$ref":"#/components/schemas/TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyType","description":"Details of the associated policy type."},"template_name":{"type":["string","null"],"description":"Optional name for this specific template instance."},"tracking_unit":{"oneOf":[{"$ref":"#/components/schemas/TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsTrackingUnit"},{"type":"null"}],"description":"The unit used for tracking the policy cycle (e.g., yearly)."},"policy_type_id":{"type":"string","format":"uuid","description":"Identifier of the associated policy type."},"tracking_cadence":{"$ref":"#/components/schemas/TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsTrackingCadence","description":"Determines when the tracking cycle starts."},"policy_allowances":{"type":"array","items":{"$ref":"#/components/schemas/TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowancesItems"},"description":"List of allowances defined within this policy template."},"is_payment_top_off":{"type":"boolean","description":"Indicates if the policy involves payment top-offs."},"notice_period_unit":{"oneOf":[{"$ref":"#/components/schemas/TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsNoticePeriodUnit"},{"type":"null"}],"description":"Unit for the required notice period."},"request_start_type":{"$ref":"#/components/schemas/TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsRequestStartType","description":"When a worker can start requesting time off after becoming eligible."},"request_start_unit":{"oneOf":[{"$ref":"#/components/schemas/TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsRequestStartUnit"},{"type":"null"}],"description":"Unit for the waiting period if request_start_type is FIXED_PERIOD."},"benefits_payer_type":{"$ref":"#/components/schemas/TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsBenefitsPayerType","description":"Who pays for the benefits associated with this time off."},"tracking_start_date":{"type":["string","null"],"format":"date","description":"Specific start date for FIXED_DAY tracking cadence (YYYY-MM-DD)."},"attachment_condition":{"oneOf":[{"$ref":"#/components/schemas/TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsAttachmentCondition"},{"type":"null"}],"description":"Comparison operator if attachment is conditionally required."},"overlap_request_type":{"$ref":"#/components/schemas/TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsOverlapRequestType","description":"Rule for requesting time off that overlaps with existing requests."},"enabled_policy_fields":{"type":["array","null"],"items":{"type":"string"},"description":"List of specific policy fields that are enabled or configurable."},"require_notice_period":{"type":["boolean","null"],"description":"Whether a notice period is required before taking time off."},"time_off_request_type":{"$ref":"#/components/schemas/TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsTimeOffRequestType","description":"Allowed types of time off requests (e.g., full day, hourly)."},"enable_pay_out_balance":{"type":"boolean","description":"Whether unused balance can be paid out."},"adoption_date_definition":{"$ref":"#/components/schemas/TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsAdoptionDateDefinition","description":"Rule regarding the requirement of an adoption date for relevant policies."},"allow_estimated_end_date":{"type":"boolean","description":"Whether an estimated end date can be provided for the time off request."},"max_tracking_unit_amount":{"type":["integer","null"],"description":"Maximum duration of the tracking cycle in tracking_unit."},"min_tracking_unit_amount":{"type":["integer","null"],"description":"Minimum duration of the tracking cycle in tracking_unit."},"attachment_condition_unit":{"oneOf":[{"$ref":"#/components/schemas/TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsAttachmentConditionUnit"},{"type":"null"}],"description":"Unit for the attachment condition amount."},"max_time_off_per_tracking":{"type":["number","null"],"format":"double","description":"Maximum amount of time off allowed per tracking cycle."},"min_time_off_per_tracking":{"type":["number","null"],"format":"double","description":"Minimum amount of time off required per tracking cycle."},"notice_period_unit_amount":{"type":["integer","null"],"description":"Amount for the required notice period."},"time_off_type_validations":{"type":"array","items":{"$ref":"#/components/schemas/TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsTimeOffTypeValidationsItems"},"description":"Specific validation rules applied to time off types under this policy."},"allow_approvers_to_request":{"type":"boolean","description":"Whether designated approvers can also request time off under this policy."},"policy_allowance_proration":{"oneOf":[{"$ref":"#/components/schemas/TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyAllowanceProration"},{"type":"null"}],"description":"Proration rules applied to the policy allowances."},"retrospective_request_type":{"$ref":"#/components/schemas/TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsRetrospectiveRequestType","description":"Rule for requesting time off for past dates."},"attachment_condition_amount":{"type":["integer","null"],"description":"Threshold amount for the attachment condition."},"disable_termination_editing":{"type":"boolean","description":"Whether editing related to termination is disabled."},"include_in_termination_flow":{"type":"boolean","description":"Whether this policy is considered during the termination process."},"max_entitlement_unit_amount":{"type":["number","null"],"format":"double","description":"Maximum allowed entitlement amount."},"min_entitlement_unit_amount":{"type":["number","null"],"format":"double","description":"Minimum allowed entitlement amount."},"upload_attachment_condition":{"$ref":"#/components/schemas/TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsUploadAttachmentCondition","description":"Condition under which an attachment is needed for a request."},"allow_to_edit_past_time_offs":{"type":"boolean","description":"Whether past time off requests under this policy can be edited."},"max_request_start_unit_amount":{"type":["integer","null"],"description":"Maximum waiting period amount if request_start_type is FIXED_PERIOD."},"min_request_start_unit_amount":{"type":["integer","null"],"description":"Minimum waiting period amount if request_start_type is FIXED_PERIOD."},"default_entitlement_unit_amount":{"type":["number","null"],"format":"double","description":"Default amount of entitlement granted per cycle."},"maximum_time_off_request_amount":{"type":["number","null"],"format":"double","description":"Maximum amount that can be requested in a single time off request."},"minimum_time_off_request_amount":{"type":["number","null"],"format":"double","description":"Minimum amount that can be requested in a single time off request."},"auto_approval_inactivity_time_unit":{"oneOf":[{"$ref":"#/components/schemas/TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsAutoApprovalInactivityTimeUnit"},{"type":"null"}],"description":"Unit for the auto-approval inactivity period."},"enable_absence_percentage_requests":{"type":"boolean","description":"Whether requests can be made as a percentage of the workday."},"estimated_end_date_client_reminder":{"type":["array","null"],"items":{"type":"integer"},"description":"Days before estimated end date to remind the client/manager."},"estimated_end_date_worker_reminder":{"type":["array","null"],"items":{"type":"integer"},"description":"Days before estimated end date to remind the worker."},"policy_validation_template_reminders":{"type":"array","items":{"$ref":"#/components/schemas/TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItemsPolicyValidationTemplateRemindersItems"},"description":"Configuration for reminders related to this policy template."},"is_auto_approval_on_inactivity_enabled":{"type":["boolean","null"],"description":"Whether requests are automatically approved after a period of inactivity."},"allow_time_off_payment_treatment_upsert":{"type":["boolean","null"],"description":"Whether payment treatment details can be updated."},"ops_workbench_process_template_reference":{"type":["string","null"],"description":"Reference to an Ops Workbench process template, if applicable."},"auto_approval_inactivity_time_unit_amount":{"type":["integer","null"],"description":"Amount for the auto-approval inactivity period."},"enable_accrued_days_for_policy_on_termination_flow":{"type":"boolean","description":"Calculate accrued days specifically for this policy during termination."},"enable_high_accuracy_accrued_days_on_termination_flow":{"type":"boolean","description":"Use high accuracy calculation for accrued days during termination."}},"title":"TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItems"},"TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"policy_types":{"type":"array","items":{"$ref":"#/components/schemas/TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyTypesItems"},"description":"List of unique policy types associated with the retrieved templates."},"policy_validation_templates":{"type":"array","items":{"$ref":"#/components/schemas/TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaDataPolicyValidationTemplatesItems"},"description":"List of policy validation templates matching the criteria."}},"title":"TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaData"},"time-off_getTimeOffPolicyValidationTemplates_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaData"}},"title":"time-off_getTimeOffPolicyValidationTemplates_Response_200"},"TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"path":{"type":"string","description":"The JSON path where input validation failed"},"message":{"type":"string","description":"A description of the returned error"}},"title":"TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaErrorsItems"},"TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaRequest":{"type":"object","properties":{"url":{"type":"string","description":"The relative URL of the failed request"},"code":{"type":"number","format":"double","description":"The code of the source handler which produced the returned error"},"docs":{"type":"string","description":"A link to the official documentation for the requested endpoint resource"},"method":{"type":"string","description":"The HTTP method of the failed request"},"source":{"type":"string","description":"The source handler which produced the returned error"},"status":{"type":"number","format":"double","description":"The status code of the response"},"api_req_id":{"type":"string","description":"The request ID of the failed request"}},"title":"TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaRequest"},"RetrievePolicyValidationTemplatesRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaErrorsItems"}},"request":{"$ref":"#/components/schemas/TimeOffsPolicyValidationTemplatesGetResponsesContentApplicationJsonSchemaRequest"}},"title":"RetrievePolicyValidationTemplatesRequestBadRequestError"},"TimeOffsTimeOffIdPatchRequestBodyContentApplicationJsonSchemaDataDatesItemsDate":{"oneOf":[{"type":"string","format":"date"},{"type":"string","format":"date-time"}],"description":"An specific date in the time-off request","title":"TimeOffsTimeOffIdPatchRequestBodyContentApplicationJsonSchemaDataDatesItemsDate"},"TimeOffsTimeOffIdPatchRequestBodyContentApplicationJsonSchemaDataDatesItemsDayType":{"type":"string","enum":["HALF_DAY","FULL_DAY","PERCENTAGE","HOURLY"],"description":"The type of day for the time off request. All dates must follow the same type.","title":"TimeOffsTimeOffIdPatchRequestBodyContentApplicationJsonSchemaDataDatesItemsDayType"},"TimeOffsTimeOffIdPatchRequestBodyContentApplicationJsonSchemaDataDatesItems":{"type":"object","properties":{"date":{"$ref":"#/components/schemas/TimeOffsTimeOffIdPatchRequestBodyContentApplicationJsonSchemaDataDatesItemsDate","description":"An specific date in the time-off request"},"hours":{"type":"number","format":"double","description":"The amount taken in hours during this specific date. It can not exceed the maximum allowed hours for the date."},"amount":{"type":"number","format":"double","description":"The amount of time off requested for the date. It must be in the same time unit as in the total amount for the time off request."},"day_type":{"$ref":"#/components/schemas/TimeOffsTimeOffIdPatchRequestBodyContentApplicationJsonSchemaDataDatesItemsDayType","description":"The type of day for the time off request. All dates must follow the same type."}},"required":["date"],"description":"The dates breakdown for the time off request.","title":"TimeOffsTimeOffIdPatchRequestBodyContentApplicationJsonSchemaDataDatesItems"},"TimeOffsTimeOffIdPatchRequestBodyContentApplicationJsonSchemaDataEndDate":{"oneOf":[{"type":"string","format":"date"},{"type":"string","format":"date-time"}],"description":"End date of the time off request. This is the date when the time off ends. For example, if you take 2 days off, this will be the end date of the second day.","title":"TimeOffsTimeOffIdPatchRequestBodyContentApplicationJsonSchemaDataEndDate"},"TimeOffsTimeOffIdPatchRequestBodyContentApplicationJsonSchemaDataStartDate":{"oneOf":[{"type":"string","format":"date"},{"type":"string","format":"date-time"}],"description":"Start date of the time off request. This is the date when the time off starts. For example, if you take 2 days off, this will be the start date of the first day.","title":"TimeOffsTimeOffIdPatchRequestBodyContentApplicationJsonSchemaDataStartDate"},"TimeOffsTimeOffIdPatchRequestBodyContentApplicationJsonSchemaDataEventDetails":{"type":"object","properties":{"birth_date":{"type":"string","format":"date","description":"The birth date of the child. This is used for parental leave requests."},"adoption_date":{"type":"string","format":"date","description":"The date of adoption. This is used for parental leave requests."},"is_confirmation":{"type":"boolean","description":"Whether the event date are a confirmed or not. This is used for parental leave requests when either the birth date or adoption date are not estimated anymore but actually confirmed."},"was_premature_birth":{"type":"boolean","description":"Whether the birth was premature or not. This is used for parental leave requests."},"had_multiple_children":{"type":"boolean","description":"Whether the birth was multiple or not. This is used for parental leave requests."}},"required":["birth_date","was_premature_birth","had_multiple_children"],"description":"Details of the event associated with the time off request. Required for event based policies such as parental leave.","title":"TimeOffsTimeOffIdPatchRequestBodyContentApplicationJsonSchemaDataEventDetails"},"TimeOffsTimeOffIdPatchRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"dates":{"type":"array","items":{"$ref":"#/components/schemas/TimeOffsTimeOffIdPatchRequestBodyContentApplicationJsonSchemaDataDatesItems"},"description":"The dates breakdown for the time off request."},"reason":{"type":["string","null"],"description":"Reason for taking time off. This is complementary information for the time-off description. Useful to provide sub categories for the same policy."},"is_paid":{"type":"boolean","description":"Whether the time off is paid or unpaid. By default it follows the policy configuration."},"end_date":{"$ref":"#/components/schemas/TimeOffsTimeOffIdPatchRequestBodyContentApplicationJsonSchemaDataEndDate","description":"End date of the time off request. This is the date when the time off ends. For example, if you take 2 days off, this will be the end date of the second day."},"policy_id":{"type":"string","format":"uuid","description":"The time off policy id. Can be used in place of time_off_type_id"},"start_date":{"$ref":"#/components/schemas/TimeOffsTimeOffIdPatchRequestBodyContentApplicationJsonSchemaDataStartDate","description":"Start date of the time off request. This is the date when the time off starts. For example, if you take 2 days off, this will be the start date of the first day."},"description":{"type":["string","null"],"description":"Description of the time off request. Some policies require that a description is provided."},"contract_oid":{"type":["string","null"],"description":"Contract id. This is the id of the contract associated with the time off request."},"event_details":{"$ref":"#/components/schemas/TimeOffsTimeOffIdPatchRequestBodyContentApplicationJsonSchemaDataEventDetails","description":"Details of the event associated with the time off request. Required for event based policies such as parental leave."},"deduction_amount":{"type":["number","null"],"format":"double","description":"Deduction amount. Available for independent contractor's policies"},"time_off_type_id":{"type":"string","format":"uuid","description":"The time off type id. Required when policy_id is not provided"},"time_off_event_id":{"type":"string","format":"uuid","description":"The time off event id. This is used to link the time off request to an event."},"time_off_percentage":{"type":["number","null"],"format":"double","description":"This is the percentage of time off taken. This is used when the time off request is a percentage."},"recipient_profile_id":{"type":"string","format":"uuid","description":"The hris profile id of the recipient"},"other_type_description":{"type":["string","null"],"description":"Description of the time off type. This is used when the policy is OTHER."}},"required":["end_date","start_date","recipient_profile_id"],"description":"Time off update request data","title":"TimeOffsTimeOffIdPatchRequestBodyContentApplicationJsonSchemaData"},"TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaTimeOffStatus":{"type":"string","enum":["REQUESTED","APPROVED","REJECTED","USED","CANCELED"],"description":"Status of the time off request. Can be REQUESTED, APPROVED, REJECTED, USED or CANCELED.","title":"TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaTimeOffStatus"},"TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaTimeOffAttachmentsItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Attachment id"},"filename":{"type":"string","description":"Filename of the attachment"},"created_at":{"type":"string","format":"date-time","description":"This is the date when the attachment was created in the database."},"updated_at":{"type":"string","format":"date-time","description":"This is the date when the attachment was last updated in the database."}},"required":["id","filename","created_at","updated_at"],"description":"An attachment associated with the time off request.","title":"TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaTimeOffAttachmentsItems"},"TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaTimeOffTimeOffTypePolicyPolicyType":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Policy type id"},"name":{"type":"string","description":"Depicts the type of policy, like VACATION, SICK etc"}},"required":["id","name"],"title":"TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaTimeOffTimeOffTypePolicyPolicyType"},"TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaTimeOffTimeOffTypePolicy":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Policy id"},"name":{"type":"string","description":"The custom name given to policy during policy creation."},"policy_type":{"$ref":"#/components/schemas/TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaTimeOffTimeOffTypePolicyPolicyType"}},"required":["id","name","policy_type"],"description":"The policy associated with the time off type.","title":"TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaTimeOffTimeOffTypePolicy"},"TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaTimeOffTimeOffType":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Time off type id."},"name":{"type":"string","description":"Time off type name. Basically the reason or category of time-off taken. For SICK leave, it can be doctor appointment, surgery etc."},"policy":{"$ref":"#/components/schemas/TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaTimeOffTimeOffTypePolicy","description":"The policy associated with the time off type."}},"required":["id","name"],"description":"The type of time off taken.","title":"TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaTimeOffTimeOffType"},"TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaTimeOffTimeOffEventType":{"type":"string","enum":["PARENTAL_LEAVE"],"description":"The type of the time off event.","title":"TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaTimeOffTimeOffEventType"},"TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaTimeOffTimeOffEventEventDetails":{"type":"object","properties":{"birth_date":{"type":"string","format":"date","description":"The birth date of the child. This is used for parental leave requests."},"adoption_date":{"type":"string","format":"date","description":"The date of adoption. This is used for parental leave requests."},"was_premature_birth":{"type":"boolean","description":"Whether the birth was premature or not. This is used for parental leave requests."},"estimated_birth_date":{"type":"string","format":"date","description":"The estimated birth date of the child. Birth is estimated when the birth date has not been confirmed yet."},"had_multiple_children":{"type":"boolean","description":"Whether the birth was multiple or not. This is used for parental leave requests."},"estimated_adoption_date":{"type":"string","format":"date","description":"The estimated adoption date of the child. Birth is estimated when the adoption date has not been confirmed yet."}},"required":["was_premature_birth","had_multiple_children"],"description":"Details of the event associated with the time off request. Required for event based policies such as parental leave.","title":"TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaTimeOffTimeOffEventEventDetails"},"TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaTimeOffTimeOffEvent":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The time off event id. This is used to link the time off request to an event."},"type":{"$ref":"#/components/schemas/TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaTimeOffTimeOffEventType","description":"The type of the time off event."},"policy_id":{"type":"string","format":"uuid","description":"The policy id associated with the time off event. Same as the policy_id in the time off type."},"created_at":{"type":"string","format":"date-time","description":"The date when the time off event was created in the database."},"updated_at":{"type":"string","format":"date-time","description":"The date when the time off event was last updated in the database."},"event_details":{"$ref":"#/components/schemas/TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaTimeOffTimeOffEventEventDetails","description":"Details of the event associated with the time off request. Required for event based policies such as parental leave."},"hris_profile_id":{"type":"string","format":"uuid","description":"The HRIS profile id of the worker associated with the time off event. Same as the hris_profile_id in the recipient_profile."},"time_off_type_id":{"type":"string","format":"uuid","description":"The time off type id associated with the time off event. Same as the time_off_type_id in the time off request."}},"title":"TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaTimeOffTimeOffEvent"},"TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaTimeOffEntitlementUnit":{"type":"string","enum":["HOUR","BUSINESS_DAY","CALENDAR_DAY","WEEK","MONTH","YEAR"],"description":"The unit in which the time off usage and entitlement are calculated.","title":"TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaTimeOffEntitlementUnit"},"TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaTimeOffTimeOffDailiesItemsType":{"type":"string","enum":["WORKING_DAY","NON_WORKING_DAY","HOLIDAY"],"description":"Type of the time off daily. Can be WORKING_DAY, NON_WORKING_DAY or HOLIDAY.","title":"TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaTimeOffTimeOffDailiesItemsType"},"TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaTimeOffTimeOffDailiesItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Time off daily id"},"date":{"type":"string","format":"date","description":"Date of the time off daily. This is the date when the time off was taken."},"type":{"$ref":"#/components/schemas/TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaTimeOffTimeOffDailiesItemsType","description":"Type of the time off daily. Can be WORKING_DAY, NON_WORKING_DAY or HOLIDAY."},"amount":{"type":"number","format":"double","description":"Amount of time off taken in this specific date."},"created_at":{"type":"string","format":"date-time","description":"This is the date when the time off daily was created in the database."},"updated_at":{"type":"string","format":"date-time","description":"This is the date when the time off daily was last updated in the database."},"description":{"type":["string","null"],"description":"Description of the time off daily. When it is a HOLIDAY this is the holiday name."},"time_off_id":{"type":"string","format":"uuid","description":"Time off id. This is the id of the time off request associated with the time off daily."}},"required":["id","date","type","amount","created_at","updated_at","time_off_id"],"title":"TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaTimeOffTimeOffDailiesItems"},"TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaTimeOffRecipientProfile":{"type":"object","properties":{"hris_profile_id":{"type":"string","format":"uuid","description":"The worker HRIS profile id in the given organization."},"organization_id":{"type":"string","format":"uuid","description":"Id of the organization the profile belongs to."}},"required":["hris_profile_id","organization_id"],"description":"The time off profile of the recipient of the time off request. Must be a worker profile.","title":"TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaTimeOffRecipientProfile"},"TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaTimeOffRequesterProfile":{"type":"object","properties":{"hris_profile_id":{"type":"string","format":"uuid","description":"The worker HRIS profile id in the given organization. Available when the requester is a worker."},"organization_id":{"type":"string","format":"uuid","description":"Id of the organization the profile belongs to."},"client_profile_id":{"type":"string","format":"uuid","description":"Id of the client profile. Available when the requester is a client."}},"required":["organization_id"],"description":"The time off profile of the requester of the time off request. Can be either a client or worker profile.","title":"TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaTimeOffRequesterProfile"},"TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaTimeOff":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"Amount of time off taken. This is the total amount of time off taken. For example, if you take 2 days off, this will be 2. If you take 1 day off, this will be 1."},"reason":{"type":"string","description":"Reason for taking time off. This is complementary information for the time-off description. Useful to provide sub categories for the same policy."},"status":{"$ref":"#/components/schemas/TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaTimeOffStatus","description":"Status of the time off request. Can be REQUESTED, APPROVED, REJECTED, USED or CANCELED."},"is_paid":{"type":"boolean","description":"Whether the time off is paid or unpaid."},"end_date":{"type":"string","format":"date","description":"End date of the time off request. This is the date when the time off ends. For example, if you take 2 days off, this will be the end date of the second day."},"created_at":{"type":"string","format":"date-time","description":"This is the date when the time off request was created in the database."},"start_date":{"type":"string","format":"date","description":"Start date of the time off request. This is the date when the time off starts. For example, if you take 2 days off, this will be the start date of the first day."},"updated_at":{"type":"string","format":"date-time","description":"This is the date when the time off request was last updated in the database."},"approved_at":{"type":["string","null"],"format":"date-time","description":"This is the date when the time off request was approved. This will be null if the time off request is not approved yet."},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaTimeOffAttachmentsItems"},"description":"List of attachments associated with the time off request."},"description":{"type":"string","description":"Description of the time off request. Some policies require that a description is provided."},"contract_oid":{"type":"string","description":"Contract id. This is the id of the contract associated with the time off request."},"requested_at":{"type":"string","format":"date","description":"This is the date when the time off request was made."},"half_end_date":{"type":"boolean","description":"Whether the end date is a half day or not."},"time_off_type":{"$ref":"#/components/schemas/TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaTimeOffTimeOffType","description":"The type of time off taken."},"time_off_event":{"$ref":"#/components/schemas/TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaTimeOffTimeOffEvent"},"half_start_date":{"type":"boolean","description":"Whether the start date is a half day or not."},"deduction_amount":{"type":"number","format":"double","description":"Deduction amount. Available for independent contractor's policies"},"entitlement_unit":{"$ref":"#/components/schemas/TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaTimeOffEntitlementUnit","description":"The unit in which the time off usage and entitlement are calculated."},"time_off_dailies":{"type":"array","items":{"$ref":"#/components/schemas/TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaTimeOffTimeOffDailiesItems"},"description":"Used to break down the time off request into daily records. Each entry represents a single day within the time off period, allowing for detailed tracking of working days, non-working days, and holidays included in the request."},"time_off_type_id":{"type":"string","format":"uuid","description":"Time off type id. This is the id of the time off type associated with the time off request."},"recipient_profile":{"$ref":"#/components/schemas/TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaTimeOffRecipientProfile","description":"The time off profile of the recipient of the time off request. Must be a worker profile."},"requester_profile":{"$ref":"#/components/schemas/TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaTimeOffRequesterProfile","description":"The time off profile of the requester of the time off request. Can be either a client or worker profile."},"time_off_percentage":{"type":"number","format":"double","description":"Used to specify the percentage of time off taken relative to full-time employment. This value ranges from 0 to 1, where 1 represents full-time (100%) and 0.5 represents part-time (50%). This is useful for part-time workers or when taking partial time off."},"is_end_date_estimated":{"type":"boolean","description":"Used to indicate if the end date is an estimate rather than a confirmed date. This is particularly important for event-based policies such as Parental Leave, where the actual end date may depend on the actual birth or adoption date, which may not be known at the time of request submission."},"other_type_description":{"type":"string","description":"Used to provide a custom description when the time off type is categorized as 'OTHER'. This allows users to specify the nature of time off that doesn't fit into standard categories, providing flexibility for unique or organization-specific time off types."}},"required":["amount","is_paid","end_date","created_at","start_date","updated_at","requested_at","half_end_date","half_start_date","entitlement_unit","time_off_type_id"],"description":"Used to return the updated time off request after modification. Contains all the time off details including status, dates, amounts, and associated metadata.","title":"TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaTimeOff"},"time-off_updateTimeOffRequest_Response_200":{"type":"object","properties":{"time_off":{"$ref":"#/components/schemas/TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaTimeOff","description":"Used to return the updated time off request after modification. Contains all the time off details including status, dates, amounts, and associated metadata."}},"required":["time_off"],"description":"Time off data to be updated","title":"time-off_updateTimeOffRequest_Response_200"},"TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaErrors":{"type":"object","properties":{"message":{"type":"string","description":"Error message describing what went wrong"}},"description":"Error details","title":"TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaErrors"},"TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaRequest":{"type":"object","properties":{"url":{"type":"string","description":"Request URL path"},"docs":{"type":"string","description":"Documentation reference"},"method":{"type":"string","description":"HTTP method"},"source":{"type":"string","description":"Request source"},"status":{"type":"integer","description":"HTTP status code"},"api_req_id":{"type":"string","description":"Unique API request identifier"}},"description":"Request metadata","title":"TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaRequest"},"UpdateTimeOffRequestRequestBadRequestError":{"type":"object","properties":{"errors":{"$ref":"#/components/schemas/TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaErrors","description":"Error details"},"request":{"$ref":"#/components/schemas/TimeOffsTimeOffIdPatchResponsesContentApplicationJsonSchemaRequest","description":"Request metadata"}},"title":"UpdateTimeOffRequestRequestBadRequestError"},"TimeOffsValidatePostRequestBodyContentApplicationJsonSchemaDataDatesItemsDayType":{"type":"string","enum":["HALF_DAY","FULL_DAY","PERCENTAGE","HOURLY"],"description":"The type of day for the time off request. All dates must follow the same type.","title":"TimeOffsValidatePostRequestBodyContentApplicationJsonSchemaDataDatesItemsDayType"},"TimeOffsValidatePostRequestBodyContentApplicationJsonSchemaDataDatesItems":{"type":"object","properties":{"date":{"type":"string","format":"date","description":"An specific date in the time-off request"},"hours":{"type":"number","format":"double","description":"The amount taken in hours during this specific date. It can not exceed the maximum allowed hours for the date."},"amount":{"type":"number","format":"double","description":"The amount of time off requested for the date. It must be in the same time unit as in the total amount for the time off request."},"day_type":{"$ref":"#/components/schemas/TimeOffsValidatePostRequestBodyContentApplicationJsonSchemaDataDatesItemsDayType","description":"The type of day for the time off request. All dates must follow the same type."}},"required":["date"],"description":"The dates breakdown for the time off request.","title":"TimeOffsValidatePostRequestBodyContentApplicationJsonSchemaDataDatesItems"},"TimeOffsValidatePostRequestBodyContentApplicationJsonSchemaDataEventDetails":{"type":"object","properties":{"birth_date":{"type":"string","format":"date","description":"The birth-date of the child. Required for parental leave requests."},"adoption_date":{"type":"string","format":"date","description":"The adoption-date of the child. Required depending on the type of the leave requests."},"was_premature_birth":{"type":"boolean","description":"Indicates if the child was born prematurely. Required for parental leave requests."},"had_multiple_children":{"type":"boolean","description":"Indicates if the request is for multiple children. Required for parental leave requests."}},"description":"Event details regarding the leave. Required for event based policies such as parental leave.","title":"TimeOffsValidatePostRequestBodyContentApplicationJsonSchemaDataEventDetails"},"TimeOffsValidatePostRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","description":"The time off id. Required when validating a time off update request"},"dates":{"type":"array","items":{"$ref":"#/components/schemas/TimeOffsValidatePostRequestBodyContentApplicationJsonSchemaDataDatesItems"},"description":"The dates breakdown for the time off request."},"is_paid":{"type":"boolean","description":"Indicates if the time off request is paid or not. By default it follows the policy configuration."},"end_date":{"type":"string","format":"date","description":"The end date of the time off request."},"policy_id":{"type":"string","description":"The time off policy id. Can be used in place of time_off_type_id"},"start_date":{"type":"string","format":"date","description":"The start date of the time off request."},"description":{"type":["string","null"],"description":"The description of the time off request"},"event_details":{"$ref":"#/components/schemas/TimeOffsValidatePostRequestBodyContentApplicationJsonSchemaDataEventDetails","description":"Event details regarding the leave. Required for event based policies such as parental leave."},"deduction_amount":{"type":"number","format":"double","description":"The amount to be deducted from the time off balance. Only valid for policies used by independent contractors"},"time_off_type_id":{"type":"string","description":"The time off type id. Required when policy_id is not provided"},"time_off_event_id":{"type":"string","description":"The time off event id that this request is associated with. Only present for event-based policies such as parental leave."},"time_off_percentage":{"type":["number","null"],"format":"double","description":"The percentage of time off requested. For example, if the request is for a full day, the percentage will be 1. If it's for half a day, the percentage will be 0.5."},"recipient_profile_id":{"type":"string","description":"The hris profile id of the recipient"}},"required":["end_date","start_date","recipient_profile_id"],"description":"Time off request data","title":"TimeOffsValidatePostRequestBodyContentApplicationJsonSchemaData"},"TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataDatesItemsType":{"type":"string","enum":["WORKING_DAY","NON_WORKING_DAY","HOLIDAY","FORFAIT_HOUR_DAY"],"description":"The type of day for the time off request. All dates must follow the same type.","title":"TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataDatesItemsType"},"TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataDatesItemsDayTypesItems":{"type":"string","enum":["FULL_DAY","HALF_DAY","PERCENTAGE","HOURLY"],"description":"The type of leave for the day.","title":"TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataDatesItemsDayTypesItems"},"TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataDatesItems":{"type":"object","properties":{"date":{"type":"string","format":"date","description":"An specific date in the time-off request"},"type":{"$ref":"#/components/schemas/TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataDatesItemsType","description":"The type of day for the time off request. All dates must follow the same type."},"hours":{"type":"array","items":{"type":"number","format":"double"},"description":"The maximum allowed number of hours that can be take in this specific date. For example, if there is another leave taking 3 hours in the same date, the maximum allowed hours will be 5 (assuming a work schedule of 8 hours)."},"amount":{"type":"number","format":"double","description":"The amount of time off requested for the date. It uses the same time unit as in the total amount for the time off request."},"day_types":{"type":"array","items":{"$ref":"#/components/schemas/TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataDatesItemsDayTypesItems"},"description":"The types of leave available for the date. Either FULL_DAY or HALF_DAY."},"holiday_name":{"type":"string","description":"The name of the holiday for the date. Only applicable for holidays. Only present when date type is HOLIDAY."},"time_off_percentage":{"type":"number","format":"double","description":"The percentage of time off requested for the date. For example, if the request is for a full day, the percentage will be 1. If it's for half a day, the percentage will be 0.5."}},"required":["date","type"],"title":"TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataDatesItems"},"TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataEventDetailsFieldsBirthDateType":{"type":"string","enum":["date-only"],"description":"The type of the field, indicating it is a date-only field","title":"TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataEventDetailsFieldsBirthDateType"},"TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataEventDetailsFieldsBirthDate":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataEventDetailsFieldsBirthDateType","description":"The type of the field, indicating it is a date-only field"},"required":{"type":"boolean","description":"Indicates if the field is required"}},"required":["type","required"],"description":"The birth-date of the child. Required for parental leave requests.","title":"TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataEventDetailsFieldsBirthDate"},"TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataEventDetailsFieldsAdoptionDateType":{"type":"string","enum":["date-only"],"description":"The type of the field, indicating it is a date-only field","title":"TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataEventDetailsFieldsAdoptionDateType"},"TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataEventDetailsFieldsAdoptionDate":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataEventDetailsFieldsAdoptionDateType","description":"The type of the field, indicating it is a date-only field"},"required":{"type":"boolean","description":"Indicates if the field is required"}},"required":["type","required"],"description":"The adoption-date of the child. Might be required depending on the type if leave requests.","title":"TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataEventDetailsFieldsAdoptionDate"},"TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataEventDetailsFieldsWasPrematureBirthType":{"type":"string","enum":["boolean"],"description":"The type of the field, indicating it is a boolean field","title":"TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataEventDetailsFieldsWasPrematureBirthType"},"TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataEventDetailsFieldsWasPrematureBirth":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataEventDetailsFieldsWasPrematureBirthType","description":"The type of the field, indicating it is a boolean field"},"required":{"type":"boolean","description":"Indicates if the field is required"}},"required":["type","required"],"description":"Indicates if the child was born prematurely. Required for parental leave requests.","title":"TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataEventDetailsFieldsWasPrematureBirth"},"TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataEventDetailsFieldsHadMultipleChildrenType":{"type":"string","enum":["boolean"],"description":"The type of the field, indicating it is a boolean field","title":"TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataEventDetailsFieldsHadMultipleChildrenType"},"TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataEventDetailsFieldsHadMultipleChildren":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataEventDetailsFieldsHadMultipleChildrenType","description":"The type of the field, indicating it is a boolean field"},"required":{"type":"boolean","description":"Indicates if the field is required"}},"required":["type","required"],"description":"Indicates if the request is for multiple children. Required for parental leave requests.","title":"TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataEventDetailsFieldsHadMultipleChildren"},"TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataEventDetailsFields":{"type":"object","properties":{"birth_date":{"$ref":"#/components/schemas/TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataEventDetailsFieldsBirthDate","description":"The birth-date of the child. Required for parental leave requests."},"adoption_date":{"$ref":"#/components/schemas/TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataEventDetailsFieldsAdoptionDate","description":"The adoption-date of the child. Might be required depending on the type if leave requests."},"was_premature_birth":{"$ref":"#/components/schemas/TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataEventDetailsFieldsWasPrematureBirth","description":"Indicates if the child was born prematurely. Required for parental leave requests."},"had_multiple_children":{"$ref":"#/components/schemas/TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataEventDetailsFieldsHadMultipleChildren","description":"Indicates if the request is for multiple children. Required for parental leave requests."}},"description":"Fields required for specific time off requests, such as parental leave.","title":"TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataEventDetailsFields"},"TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataCountrySpecificValidationResultsItemsDataRangesItems":{"type":"object","properties":{"end_day":{"type":"number","format":"double","description":"The end day in the range"},"start_day":{"type":"number","format":"double","description":"The start day in the range"}},"required":["start_day"],"title":"TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataCountrySpecificValidationResultsItemsDataRangesItems"},"TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataCountrySpecificValidationResultsItemsData":{"type":"object","properties":{"ranges":{"type":"array","items":{"$ref":"#/components/schemas/TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataCountrySpecificValidationResultsItemsDataRangesItems"},"description":"Date ranges that were validated"},"max_requests":{"type":"number","format":"double","description":"Maximum number of requests allowed by this validation rule"},"remaining_balance":{"type":"number","format":"double","description":"Remaining balance at the time of applying this rule"}},"title":"TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataCountrySpecificValidationResultsItemsData"},"TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataCountrySpecificValidationResultsItems":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataCountrySpecificValidationResultsItemsData"},"is_valid":{"type":"boolean","description":"Indicates if this specific validation passed"},"description":{"type":"string","description":"A human-readable description of the validation result"},"validation_type":{"type":"string","description":"The type of validation rule being applied"}},"required":["validation_type"],"description":"Result of a specific country validation rule","title":"TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataCountrySpecificValidationResultsItems"},"TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataCountrySpecificValidationResultsNextTrackingPeriodItemsDataRangesItems":{"type":"object","properties":{"end_day":{"type":"number","format":"double","description":"The end day in the range"},"start_day":{"type":"number","format":"double","description":"The start day in the range"}},"required":["start_day"],"title":"TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataCountrySpecificValidationResultsNextTrackingPeriodItemsDataRangesItems"},"TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataCountrySpecificValidationResultsNextTrackingPeriodItemsData":{"type":"object","properties":{"ranges":{"type":"array","items":{"$ref":"#/components/schemas/TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataCountrySpecificValidationResultsNextTrackingPeriodItemsDataRangesItems"},"description":"Date ranges that were validated"},"max_requests":{"type":"number","format":"double","description":"Maximum number of requests allowed by this validation rule"},"remaining_balance":{"type":"number","format":"double","description":"Remaining balance at the time of applying this rule"}},"title":"TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataCountrySpecificValidationResultsNextTrackingPeriodItemsData"},"TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataCountrySpecificValidationResultsNextTrackingPeriodItems":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataCountrySpecificValidationResultsNextTrackingPeriodItemsData"},"is_valid":{"type":"boolean","description":"Indicates if this specific validation passed"},"description":{"type":"string","description":"A human-readable description of the validation result"},"validation_type":{"type":"string","description":"The type of validation rule being applied"}},"required":["validation_type"],"description":"Result of a specific country validation rule","title":"TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataCountrySpecificValidationResultsNextTrackingPeriodItems"},"TimeOffsValidatePostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"dates":{"type":"array","items":{"$ref":"#/components/schemas/TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataDatesItems"},"description":"The dates breakdown for the time off request."},"amount":{"type":"number","format":"double","description":"The amount of time off requested."},"is_valid":{"type":"boolean","description":"Indicates if the time off request is valid or not. When false, the response will contain an error message."},"new_end_date":{"type":"string","format":"date","description":"The new end date for the time off request. It could be different from the original end date depending on the policy configuration. For example, for forfait-jour policies"},"is_event_based":{"type":"boolean","description":"Indicates if the time off request is event-based, such as parental leave"},"new_start_date":{"type":"string","format":"date","description":"The new start date for the time off request. It could be different from the original start date depending on the policy configuration. For example, for forfait-jour policies"},"remaining_balance":{"type":"number","format":"double","description":"The remaining policy balance for the tracking period"},"require_attachment":{"type":"boolean","description":"Indicates if an attachment is required for the time off request"},"require_description":{"type":"boolean","description":"Indicates if a description is required for the time off request"},"event_details_fields":{"$ref":"#/components/schemas/TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataEventDetailsFields","description":"Fields required for specific time off requests, such as parental leave."},"max_time_off_percentage":{"type":"number","format":"double","description":"The maximum time off percentage allowed for the request"},"validation_error_message":{"type":"string","description":"Error message when the time off request is invalid"},"amount_next_tracking_period":{"type":"number","format":"double","description":"The amount of time off requested to be applicable in the next tracking period."},"country_specific_validation_results":{"type":"array","items":{"$ref":"#/components/schemas/TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataCountrySpecificValidationResultsItems"},"description":"Results of country-specific validation rules"},"remaining_balance_next_tracking_period":{"type":"number","format":"double","description":"The remaining policy balance for the next tracking period"},"country_specific_validation_results_next_tracking_period":{"type":"array","items":{"$ref":"#/components/schemas/TimeOffsValidatePostResponsesContentApplicationJsonSchemaDataCountrySpecificValidationResultsNextTrackingPeriodItems"},"description":"Results of country-specific validation rules"}},"required":["is_valid"],"description":"Time off request validation result","title":"TimeOffsValidatePostResponsesContentApplicationJsonSchemaData"},"time-off_validateTimeOff_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/TimeOffsValidatePostResponsesContentApplicationJsonSchemaData","description":"Time off request validation result"}},"required":["data"],"description":"Time off request validation result","title":"time-off_validateTimeOff_Response_200"},"TimeOffsValidatePostResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"path":{"type":"string","description":"The JSON path where input validation failed"},"message":{"type":"string","description":"A description of the returned error"}},"title":"TimeOffsValidatePostResponsesContentApplicationJsonSchemaErrorsItems"},"TimeOffsValidatePostResponsesContentApplicationJsonSchemaRequest":{"type":"object","properties":{"url":{"type":"string","description":"The relative URL of the failed request"},"code":{"type":"number","format":"double","description":"The code of the source handler which produced the returned error"},"docs":{"type":"string","description":"A link to the official documentation for the requested endpoint resource"},"method":{"type":"string","description":"The HTTP method of the failed request"},"source":{"type":"string","description":"The source handler which produced the returned error"},"status":{"type":"number","format":"double","description":"The status code of the response"},"api_req_id":{"type":"string","description":"The request ID of the failed request"}},"title":"TimeOffsValidatePostResponsesContentApplicationJsonSchemaRequest"},"ValidateTimeOffRequest-v2026-01-01RequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/TimeOffsValidatePostResponsesContentApplicationJsonSchemaErrorsItems"}},"request":{"$ref":"#/components/schemas/TimeOffsValidatePostResponsesContentApplicationJsonSchemaRequest"}},"title":"ValidateTimeOffRequest-v2026-01-01RequestBadRequestError"},"UsersGetParametersFilter":{"oneOf":[{"type":"string"},{"type":"array","items":{"type":"string"}}],"title":"UsersGetParametersFilter"},"UsersGetResponsesContentApplicationJsonSchemaSchemasItems":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:ListResponse"],"title":"UsersGetResponsesContentApplicationJsonSchemaSchemasItems"},"UsersGetResponsesContentApplicationJsonSchemaResourcesItemsMetaResourceType":{"type":"string","enum":["User","Group"],"title":"UsersGetResponsesContentApplicationJsonSchemaResourcesItemsMetaResourceType"},"UsersGetResponsesContentApplicationJsonSchemaResourcesItemsMeta":{"type":"object","properties":{"created":{"type":"string"},"location":{"type":"string"},"lastModified":{"type":"string"},"resourceType":{"$ref":"#/components/schemas/UsersGetResponsesContentApplicationJsonSchemaResourcesItemsMetaResourceType"}},"title":"UsersGetResponsesContentApplicationJsonSchemaResourcesItemsMeta"},"UsersGetResponsesContentApplicationJsonSchemaResourcesItemsName":{"type":"object","properties":{"givenName":{"type":["string","null"]},"familyName":{"type":["string","null"]}},"required":["givenName","familyName"],"title":"UsersGetResponsesContentApplicationJsonSchemaResourcesItemsName"},"UsersGetResponsesContentApplicationJsonSchemaResourcesItemsEmailsItemsType":{"type":"string","enum":["home","work","other"],"title":"UsersGetResponsesContentApplicationJsonSchemaResourcesItemsEmailsItemsType"},"UsersGetResponsesContentApplicationJsonSchemaResourcesItemsEmailsItems":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/UsersGetResponsesContentApplicationJsonSchemaResourcesItemsEmailsItemsType"},"value":{"type":"string"},"primary":{"type":"boolean","default":false}},"required":["type","value"],"title":"UsersGetResponsesContentApplicationJsonSchemaResourcesItemsEmailsItems"},"UsersGetResponsesContentApplicationJsonSchemaResourcesItemsSchemasItems":{"type":"string","enum":["urn:ietf:params:scim:schemas:core:2.0:User"],"title":"UsersGetResponsesContentApplicationJsonSchemaResourcesItemsSchemasItems"},"UsersGetResponsesContentApplicationJsonSchemaResourcesItemsAddressesItems":{"type":"object","properties":{"type":{"type":"string"},"region":{"type":"string"},"country":{"type":["string","null"]},"lineTwo":{"type":"string"},"locality":{"type":"string"},"postalCode":{"type":"string"},"streetAddress":{"type":"string"}},"title":"UsersGetResponsesContentApplicationJsonSchemaResourcesItemsAddressesItems"},"UsersGetResponsesContentApplicationJsonSchemaResourcesItemsUrnIetfParamsScimSchemasExtension20UserEmploymentsItemsTeam":{"type":"object","properties":{"name":{"type":["string","null"]}},"title":"UsersGetResponsesContentApplicationJsonSchemaResourcesItemsUrnIetfParamsScimSchemasExtension20UserEmploymentsItemsTeam"},"UsersGetResponsesContentApplicationJsonSchemaResourcesItemsUrnIetfParamsScimSchemasExtension20UserEmploymentsItemsCustomFieldsItemsData":{"type":"object","properties":{},"description":"The custom field value payload. Structure varies by field type: Text/Number/Date have {value}, Percentage has {value, text}, Currency has {amount, currency}, List has {option}, Multiselect has {options}.","title":"UsersGetResponsesContentApplicationJsonSchemaResourcesItemsUrnIetfParamsScimSchemasExtension20UserEmploymentsItemsCustomFieldsItemsData"},"UsersGetResponsesContentApplicationJsonSchemaResourcesItemsUrnIetfParamsScimSchemasExtension20UserEmploymentsItemsCustomFieldsItems":{"type":"object","properties":{"id":{"type":"string"},"data":{"oneOf":[{"$ref":"#/components/schemas/UsersGetResponsesContentApplicationJsonSchemaResourcesItemsUrnIetfParamsScimSchemasExtension20UserEmploymentsItemsCustomFieldsItemsData"},{"type":"null"}],"description":"The custom field value payload. Structure varies by field type: Text/Number/Date have {value}, Percentage has {value, text}, Currency has {amount, currency}, List has {option}, Multiselect has {options}."},"name":{"type":"string"},"type":{"type":"string"}},"title":"UsersGetResponsesContentApplicationJsonSchemaResourcesItemsUrnIetfParamsScimSchemasExtension20UserEmploymentsItemsCustomFieldsItems"},"UsersGetResponsesContentApplicationJsonSchemaResourcesItemsUrnIetfParamsScimSchemasExtension20UserEmploymentsItems":{"type":"object","properties":{"team":{"$ref":"#/components/schemas/UsersGetResponsesContentApplicationJsonSchemaResourcesItemsUrnIetfParamsScimSchemasExtension20UserEmploymentsItemsTeam"},"state":{"type":["string","null"]},"title":{"type":["string","null"]},"active":{"type":"boolean","default":false},"country":{"type":["string","null"]},"startDate":{"type":["string","null"]},"contractId":{"type":"string"},"contractType":{"type":["string","null"]},"customFields":{"type":"array","items":{"$ref":"#/components/schemas/UsersGetResponsesContentApplicationJsonSchemaResourcesItemsUrnIetfParamsScimSchemasExtension20UserEmploymentsItemsCustomFieldsItems"},"description":"Contract-level custom fields associated with the employment"},"employeeNumber":{"type":["string","null"]}},"title":"UsersGetResponsesContentApplicationJsonSchemaResourcesItemsUrnIetfParamsScimSchemasExtension20UserEmploymentsItems"},"UsersGetResponsesContentApplicationJsonSchemaResourcesItemsUrnIetfParamsScimSchemasExtension20UserCustomFieldsItems":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":["string","null"]},"value":{"type":["string","null"]}},"title":"UsersGetResponsesContentApplicationJsonSchemaResourcesItemsUrnIetfParamsScimSchemasExtension20UserCustomFieldsItems"},"UsersGetResponsesContentApplicationJsonSchemaResourcesItemsUrnIetfParamsScimSchemasExtension20UserOrganizationalStructuresItems":{"type":"object","properties":{"name":{"type":"string"},"externalId":{"type":["string","null"]},"structureId":{"type":"string"},"nameHierarchy":{"type":"string"},"structureName":{"type":"string"},"externalIdHierarchy":{"type":["string","null"]}},"title":"UsersGetResponsesContentApplicationJsonSchemaResourcesItemsUrnIetfParamsScimSchemasExtension20UserOrganizationalStructuresItems"},"UsersGetResponsesContentApplicationJsonSchemaResourcesItemsUrnIetfParamsScimSchemasExtension20User":{"type":"object","properties":{"state":{"type":["string","null"]},"country":{"type":["string","null"]},"endDate":{"type":"string"},"birthday":{"type":"string"},"workerId":{"type":["string","null"]},"isManager":{"type":"boolean","default":false},"startDate":{"type":["string","null"]},"employments":{"type":["array","null"],"items":{"$ref":"#/components/schemas/UsersGetResponsesContentApplicationJsonSchemaResourcesItemsUrnIetfParamsScimSchemasExtension20UserEmploymentsItems"}},"customFields":{"type":["array","null"],"items":{"$ref":"#/components/schemas/UsersGetResponsesContentApplicationJsonSchemaResourcesItemsUrnIetfParamsScimSchemasExtension20UserCustomFieldsItems"}},"hiringStatus":{"type":"string"},"workLocation":{"type":["string","null"],"description":"The work location label assigned to the worker's HRIS profile"},"preferredName":{"type":"string"},"preferredLastName":{"type":"string"},"preferredFirstName":{"type":"string"},"departmentHierarchy":{"type":["string","null"]},"departmentExternalId":{"type":["string","null"]},"organizationalStructures":{"type":"array","items":{"$ref":"#/components/schemas/UsersGetResponsesContentApplicationJsonSchemaResourcesItemsUrnIetfParamsScimSchemasExtension20UserOrganizationalStructuresItems"}},"departmentExternalIdHierarchy":{"type":["string","null"]},"workerTerminationLastDateOfWork":{"type":["string","null"]}},"title":"UsersGetResponsesContentApplicationJsonSchemaResourcesItemsUrnIetfParamsScimSchemasExtension20User"},"UsersGetResponsesContentApplicationJsonSchemaResourcesItemsUrnIetfParamsScimSchemasExtensionEnterprise20UserManager":{"type":"object","properties":{"email":{"type":"string"},"value":{"type":"string"},"displayName":{"type":"string"}},"required":["value"],"title":"UsersGetResponsesContentApplicationJsonSchemaResourcesItemsUrnIetfParamsScimSchemasExtensionEnterprise20UserManager"},"UsersGetResponsesContentApplicationJsonSchemaResourcesItemsUrnIetfParamsScimSchemasExtensionEnterprise20User":{"type":"object","properties":{"manager":{"$ref":"#/components/schemas/UsersGetResponsesContentApplicationJsonSchemaResourcesItemsUrnIetfParamsScimSchemasExtensionEnterprise20UserManager"},"costCenter":{"type":"string"},"department":{"type":"string"},"customFields":{"type":"object","additionalProperties":{"type":"string"}},"organization":{"type":"string"},"preferredLastName":{"type":"string"},"preferredFirstName":{"type":"string"}},"title":"UsersGetResponsesContentApplicationJsonSchemaResourcesItemsUrnIetfParamsScimSchemasExtensionEnterprise20User"},"UsersGetResponsesContentApplicationJsonSchemaResourcesItems":{"type":"object","properties":{"id":{"type":"string"},"meta":{"$ref":"#/components/schemas/UsersGetResponsesContentApplicationJsonSchemaResourcesItemsMeta"},"name":{"$ref":"#/components/schemas/UsersGetResponsesContentApplicationJsonSchemaResourcesItemsName"},"title":{"type":"string"},"active":{"type":"boolean","default":false},"emails":{"type":"array","items":{"$ref":"#/components/schemas/UsersGetResponsesContentApplicationJsonSchemaResourcesItemsEmailsItems"}},"schemas":{"type":"array","items":{"$ref":"#/components/schemas/UsersGetResponsesContentApplicationJsonSchemaResourcesItemsSchemasItems"}},"userName":{"type":"string"},"userType":{"type":"string"},"addresses":{"type":"array","items":{"$ref":"#/components/schemas/UsersGetResponsesContentApplicationJsonSchemaResourcesItemsAddressesItems"}},"urn:ietf:params:scim:schemas:extension:2.0:User":{"$ref":"#/components/schemas/UsersGetResponsesContentApplicationJsonSchemaResourcesItemsUrnIetfParamsScimSchemasExtension20User"},"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{"$ref":"#/components/schemas/UsersGetResponsesContentApplicationJsonSchemaResourcesItemsUrnIetfParamsScimSchemasExtensionEnterprise20User"}},"required":["meta","name","emails","schemas","userName"],"title":"UsersGetResponsesContentApplicationJsonSchemaResourcesItems"},"Users_getUsers_Response_200":{"type":"object","properties":{"schemas":{"type":"array","items":{"$ref":"#/components/schemas/UsersGetResponsesContentApplicationJsonSchemaSchemasItems"}},"Resources":{"type":"array","items":{"$ref":"#/components/schemas/UsersGetResponsesContentApplicationJsonSchemaResourcesItems"}},"startIndex":{"type":"integer","format":"int64"},"itemsPerPage":{"type":"integer","format":"int64"},"totalResults":{"type":"integer","format":"int64"}},"title":"Users_getUsers_Response_200"},"ErrorResponseSchemasItems":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:Error"],"title":"ErrorResponseSchemasItems"},"ErrorResponseScimType":{"type":"string","enum":["uniqueness","tooMany","mutability","sensitive","invalidSyntax","invalidFilter","invalidPath","invalidValue","invalidVers","noTarget"],"description":"bad request type when status code is 400","title":"ErrorResponseScimType"},"ErrorResponse":{"type":"object","properties":{"detail":{"type":"string","description":"detail error message"},"schemas":{"type":"array","items":{"$ref":"#/components/schemas/ErrorResponseSchemasItems"}},"scimType":{"$ref":"#/components/schemas/ErrorResponseScimType","description":"bad request type when status code is 400"},"status":{"type":"string","description":"same as HTTP status code, e.g. 400, 401, etc."}},"title":"ErrorResponse"},"UsersGetResponsesContentApplicationJsonSchemaError":{"type":"object","properties":{"code":{"type":"string","description":"Error code identifying the type of error."},"details":{"type":["string","null"],"description":"Additional details about the error."},"message":{"type":"string","description":"Error message describing what went wrong."}},"required":["code","message"],"title":"UsersGetResponsesContentApplicationJsonSchemaError"},"ListUsers-v2026-01-01RequestInternalServerError":{"type":"object","properties":{"error":{"$ref":"#/components/schemas/UsersGetResponsesContentApplicationJsonSchemaError"}},"required":["error"],"title":"ListUsers-v2026-01-01RequestInternalServerError"},"EmailType":{"type":"string","enum":["work"],"title":"EmailType"},"Email":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/EmailType"},"value":{"type":"string"},"primary":{"type":"boolean","default":false}},"required":["type","value"],"title":"Email"},"CountryCode":{"type":"string","title":"CountryCode"},"Address":{"type":"object","properties":{"streetAddress":{"type":"string","description":"Street and number."},"locality":{"type":"string","description":"Locality name."},"region":{"type":"string","description":"Region code."},"postalCode":{"type":"string","description":"Postal code."},"country":{"$ref":"#/components/schemas/CountryCode"},"type":{"type":"string","description":"Address type."}},"title":"Address"},"Name":{"type":"object","properties":{"familyName":{"type":"string","description":"User's family name."},"givenName":{"type":"string","description":"User's given name. Also known as first name."}},"required":["familyName","givenName"],"title":"Name"},"UserSchemasItems":{"type":"string","enum":["urn:ietf:params:scim:schemas:core:2.0:User"],"title":"UserSchemasItems"},"Manager":{"type":"object","properties":{"value":{"type":"string","description":"Manager's unique identifier."},"displayName":{"type":"string","description":"Manager's full name."},"email":{"type":"string","description":"Manager's email."}},"required":["value"],"title":"Manager"},"EnterpriseUser":{"type":"object","properties":{"department":{"type":"string","description":"Employee's department in Deel HRIS."},"costCenter":{"type":"string","description":"Legal entity."},"organization":{"type":"string","description":"Organization name in Deel."},"manager":{"$ref":"#/components/schemas/Manager"}},"title":"EnterpriseUser"},"UserExtensionEmploymentsItemsTeam":{"type":"object","properties":{"name":{"type":"string","description":"Team name."}},"description":"Team name.","title":"UserExtensionEmploymentsItemsTeam"},"UserExtensionEmploymentsItems":{"type":"object","properties":{"contractId":{"type":"string","description":"Contract identifier."},"title":{"type":["string","null"],"description":"Contract title"},"startDate":{"type":["string","null"],"description":"Contract start date."},"contractType":{"type":["string","null"],"description":"Type of Deel contract"},"active":{"type":"boolean","default":false,"description":"Indicates if the contract is currently active."},"state":{"type":["string","null"],"description":"State code."},"country":{"type":["string","null"],"description":"Country code."},"team":{"$ref":"#/components/schemas/UserExtensionEmploymentsItemsTeam","description":"Team name."}},"title":"UserExtensionEmploymentsItems"},"CustomField":{"type":"object","properties":{"id":{"type":"string","description":"Custom fields's unique identifier."},"name":{"type":"string","description":"Custom fields's name."},"value":{"type":"string","description":"Custom fields's value."}},"title":"CustomField"},"OrganizationalStructure":{"type":"object","properties":{"structureId":{"type":"string","description":"Id of the Organizational structure."},"structureName":{"type":"string","description":"Name of the Organizational structure."},"nameHierarchy":{"type":"string","description":"Org structure hierarchy by name."},"name":{"type":"string","description":"Team name."},"externalId":{"type":"string","description":"Team external ID."},"externalIdHierarchy":{"type":"string","description":"Org structure hierarchy by external IDs."}},"title":"OrganizationalStructure"},"UserExtension":{"type":"object","properties":{"preferredFirstName":{"type":["string","null"],"description":"Preferred First Name"},"preferredLastName":{"type":["string","null"],"description":"Preferred Last Name"},"preferredName":{"type":["string","null"],"description":"Preferred Full Name"},"workerId":{"type":["number","null"],"format":"double","description":"Worker ID"},"startDate":{"type":"string","format":"date-time","description":"Start date of employment."},"endDate":{"type":"string","format":"date-time","description":"End date of employment."},"birthday":{"type":"string","format":"string","description":"Yearless representation of the user's birthday. Format MM-DD"},"hiringStatus":{"type":"string","description":"Hiring status."},"state":{"type":["string","null"],"description":"State code."},"country":{"type":["string","null"],"description":"Country code."},"employments":{"type":["array","null"],"items":{"$ref":"#/components/schemas/UserExtensionEmploymentsItems"}},"customFields":{"type":["array","null"],"items":{"$ref":"#/components/schemas/CustomField"}},"organizationalStructures":{"type":["array","null"],"items":{"$ref":"#/components/schemas/OrganizationalStructure"}},"isManager":{"type":["boolean","null"],"description":"Flag to highlight if the user is a manager or not"},"departmentHierarchy":{"type":["string","null"],"description":"Hierarchy path of the team up to the root"},"departmentExternalId":{"type":["string","null"],"description":"Team external id"},"departmentExternalIdHierarchy":{"type":["string","null"],"description":"Hierarchy path of the team up to the root using external ids"}},"title":"UserExtension"},"UserMeta":{"type":"object","properties":{"created":{"type":"string","description":"Time at which the resource was created."},"lastModified":{"type":"string","description":"Time at which the resource was last modified."},"resourceType":{"type":"string","description":"Resource type."},"location":{"type":"string","description":"API endpoint to retrieve resource."}},"title":"UserMeta"},"MetaResourceType":{"type":"string","enum":["User","Group"],"title":"MetaResourceType"},"Meta":{"type":"object","properties":{"created":{"type":"string","format":"date-time"},"lastModified":{"type":"string","format":"date-time"},"location":{"type":"string","description":"resource location URI"},"resourceType":{"$ref":"#/components/schemas/MetaResourceType"}},"description":"Resource metadata.","title":"Meta"},"UserResponse":{"type":"object","properties":{"active":{"type":"boolean","default":false,"description":"Hiring status. True if user employment is active. False if employment is not active."},"emails":{"type":"array","items":{"$ref":"#/components/schemas/Email"}},"title":{"type":"string","description":"Job title."},"userType":{"type":"string","description":"User type."},"addresses":{"type":"array","items":{"$ref":"#/components/schemas/Address"}},"id":{"type":"string","description":"Unique resource id (UUID) defined by Deel."},"name":{"$ref":"#/components/schemas/Name"},"schemas":{"type":"array","items":{"$ref":"#/components/schemas/UserSchemasItems"}},"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{"$ref":"#/components/schemas/EnterpriseUser"},"urn:ietf:params:scim:schemas:extension:2.0:User":{"$ref":"#/components/schemas/UserExtension"},"userName":{"type":"string","description":"User's work email."},"meta":{"$ref":"#/components/schemas/Meta"}},"required":["emails","name","schemas","userName","meta"],"title":"UserResponse"},"SearchRequestSchemasItems":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:SearchRequest"],"title":"SearchRequestSchemasItems"},"SearchRequest":{"type":"object","properties":{"count":{"type":"integer","description":"page size"},"filter":{"type":"string","description":"only support 'userName' or 'email' filter expressions for now"},"schemas":{"type":"array","items":{"$ref":"#/components/schemas/SearchRequestSchemasItems"}},"startIndex":{"type":"integer","description":"start index (1-based)"}},"title":"SearchRequest"},"UserSearchResponseSchemasItems":{"type":"string","enum":["urn:ietf:params:scim:api:messages:2.0:ListResponse"],"title":"UserSearchResponseSchemasItems"},"UserSearchResponse":{"type":"object","properties":{"Resources":{"type":"array","items":{"$ref":"#/components/schemas/UserResponse"},"description":"User list."},"itemsPerPage":{"type":"integer","format":"int64"},"schemas":{"type":"array","items":{"$ref":"#/components/schemas/UserSearchResponseSchemasItems"}},"startIndex":{"type":"integer","format":"int64","description":"Start index of the current page."},"totalResults":{"type":"integer","format":"int64"}},"title":"UserSearchResponse"},"HrisWorkerRelationsProfileHrisProfileOidParentPutRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The ID of the parent profile"},"hris_relationship_type_id":{"type":"string","format":"uuid","description":"The ID of the relationship type"}},"required":["id","hris_relationship_type_id"],"title":"HrisWorkerRelationsProfileHrisProfileOidParentPutRequestBodyContentApplicationJsonSchemaData"},"worker-relations_addWorkerRelationParent_Response_204":{"type":"object","properties":{},"description":"Empty response body","title":"worker-relations_addWorkerRelationParent_Response_204"},"HrisWorkerRelationsProfilePostRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"child_hris_profile_ids":{"type":"array","items":{"type":"string","format":"uuid"},"description":"An array containing the secondary HrisProfiles IDs."},"parent_hris_profile_id":{"type":"string","format":"uuid","description":"Primary HrisProfile ID"},"hris_relationship_type_id":{"type":"string","format":"uuid","description":"The ID of the Worker Relation Type."}},"required":["child_hris_profile_ids","parent_hris_profile_id","hris_relationship_type_id"],"description":"The request payload containing the relationship details.","title":"HrisWorkerRelationsProfilePostRequestBodyContentApplicationJsonSchemaData"},"worker-relations_createWorkerRelationProfile_Response_201":{"type":"object","properties":{},"description":"Empty response body","title":"worker-relations_createWorkerRelationProfile_Response_201"},"HrisWorkerRelationsProfilePostResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string"},"field":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"title":"HrisWorkerRelationsProfilePostResponsesContentApplicationJsonSchemaErrorsItems"},"CreateAWorkerRelation-v2026-01-01RequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/HrisWorkerRelationsProfilePostResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"CreateAWorkerRelation-v2026-01-01RequestBadRequestError"},"CreateAWorkerRelation-v2026-01-01RequestNotFoundError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/HrisWorkerRelationsProfilePostResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"CreateAWorkerRelation-v2026-01-01RequestNotFoundError"},"HrisWorkerRelationsProfileExternalProfileIdChildPutRequestBodyContentApplicationJsonSchemaDataChildHrisProfileIdsItems0":{"type":"object","properties":{"relation_external_id":{"type":"string"},"external_hris_profile_id":{"type":"string"}},"required":["relation_external_id","external_hris_profile_id"],"title":"HrisWorkerRelationsProfileExternalProfileIdChildPutRequestBodyContentApplicationJsonSchemaDataChildHrisProfileIdsItems0"},"HrisWorkerRelationsProfileExternalProfileIdChildPutRequestBodyContentApplicationJsonSchemaDataChildHrisProfileIdsItems":{"oneOf":[{"$ref":"#/components/schemas/HrisWorkerRelationsProfileExternalProfileIdChildPutRequestBodyContentApplicationJsonSchemaDataChildHrisProfileIdsItems0"}],"title":"HrisWorkerRelationsProfileExternalProfileIdChildPutRequestBodyContentApplicationJsonSchemaDataChildHrisProfileIdsItems"},"HrisWorkerRelationsProfileExternalProfileIdChildPutRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"child_hris_profile_ids":{"type":"array","items":{"$ref":"#/components/schemas/HrisWorkerRelationsProfileExternalProfileIdChildPutRequestBodyContentApplicationJsonSchemaDataChildHrisProfileIdsItems"}},"hris_relationship_type_external_id":{"type":"string","format":"uuid"}},"required":["child_hris_profile_ids"],"title":"HrisWorkerRelationsProfileExternalProfileIdChildPutRequestBodyContentApplicationJsonSchemaData"},"worker-relations_addWorkerRelationChildByExternalId_Response_204":{"type":"object","properties":{},"description":"Empty response body","title":"worker-relations_addWorkerRelationChildByExternalId_Response_204"},"HrisWorkerRelationsTypesPostRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"child_name":{"type":"string","description":"The name of the secondary party in the relationship"},"is_default":{"type":"boolean","default":false,"description":"Whether this relation is default or not"},"external_id":{"type":"string","description":"A custom ID for the relation type"},"parent_name":{"type":"string","description":"The name of the primary party in the relationship"}},"title":"HrisWorkerRelationsTypesPostRequestBodyContentApplicationJsonSchemaData"},"HrisWorkerRelationsTypesPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The ID of the relation type"},"child_name":{"type":"string","description":"The name of the secondary party in the relationship"},"is_default":{"type":"boolean","description":"Whether this relation is default or not"},"external_id":{"type":"string","description":"A custom ID for the relation type"},"parent_name":{"type":"string","description":"The name of the primary party in the relationship"}},"title":"HrisWorkerRelationsTypesPostResponsesContentApplicationJsonSchemaData"},"worker-relations_createWorkerRelationType_Response_201":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/HrisWorkerRelationsTypesPostResponsesContentApplicationJsonSchemaData"}},"title":"worker-relations_createWorkerRelationType_Response_201"},"HrisWorkerRelationsProfileExternalPostRequestBodyContentApplicationJsonSchemaDataChildHrisProfileIdsItems":{"type":"object","properties":{"relation_external_id":{"type":"string","description":"A custom ID to set to the relation."},"external_hris_profile_id":{"type":"string","description":"The external ID of the secondary HrisProfile."}},"required":["relation_external_id","external_hris_profile_id"],"title":"HrisWorkerRelationsProfileExternalPostRequestBodyContentApplicationJsonSchemaDataChildHrisProfileIdsItems"},"HrisWorkerRelationsProfileExternalPostRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"child_hris_profile_ids":{"type":"array","items":{"$ref":"#/components/schemas/HrisWorkerRelationsProfileExternalPostRequestBodyContentApplicationJsonSchemaDataChildHrisProfileIdsItems"},"description":"An array containing the secondary HrisProfiles external IDs and the relation external ID."},"parent_external_hris_profile_id":{"type":"string","description":"Primary HrisProfile external ID"},"hris_relationship_type_external_id":{"type":"string","description":"The external ID of the Worker Relation Type."}},"required":["child_hris_profile_ids","parent_external_hris_profile_id","hris_relationship_type_external_id"],"title":"HrisWorkerRelationsProfileExternalPostRequestBodyContentApplicationJsonSchemaData"},"worker-relations_createWorkerRelationProfileByExternalId_Response_201":{"type":"object","properties":{},"description":"Empty response body","title":"worker-relations_createWorkerRelationProfileByExternalId_Response_201"},"worker-relations_deleteWorkerRelationProfile_Response_204":{"type":"object","properties":{},"description":"Empty response body","title":"worker-relations_deleteWorkerRelationProfile_Response_204"},"worker-relations_deleteWorkerRelationProfileByExternalId_Response_204":{"type":"object","properties":{},"description":"Empty response body","title":"worker-relations_deleteWorkerRelationProfileByExternalId_Response_204"},"worker-relations_deleteWorkerRelationTypeByExternalId_Response_204":{"type":"object","properties":{},"description":"Empty response body","title":"worker-relations_deleteWorkerRelationTypeByExternalId_Response_204"},"HrisWorkerRelationsProfileHrisProfileOidGetResponsesContentApplicationJsonSchemaDataItemsChildRelationshipsItems":{"type":"object","properties":{"last_name":{"type":"string","description":"The last name of the child profile"},"first_name":{"type":"string","description":"The first name of the child profile"},"profile_id":{"type":"string","format":"uuid","description":"The ID of the child profile"},"relation_id":{"type":"string","format":"uuid","description":"The ID of the relation between the profiles"}},"title":"HrisWorkerRelationsProfileHrisProfileOidGetResponsesContentApplicationJsonSchemaDataItemsChildRelationshipsItems"},"HrisWorkerRelationsProfileHrisProfileOidGetResponsesContentApplicationJsonSchemaDataItemsParentRelationship":{"type":"object","properties":{"last_name":{"type":"string","description":"The last name of the parent profile"},"first_name":{"type":"string","description":"The first name of the parent profile"},"profile_id":{"type":"string","format":"uuid","description":"The ID of the parent profile"},"relation_id":{"type":"string","format":"uuid","description":"The ID of the relation between the profiles"}},"description":"An object that has information about the parent profile in the relation.","title":"HrisWorkerRelationsProfileHrisProfileOidGetResponsesContentApplicationJsonSchemaDataItemsParentRelationship"},"HrisWorkerRelationsProfileHrisProfileOidGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The ID of the relation type"},"name":{"type":"string","description":"The name of the relation type"},"is_parent":{"type":"boolean","description":"Whether this relation is the parent or not"},"is_default":{"type":"boolean","description":"Whether this relation is default or not"},"child_relationships":{"type":"array","items":{"$ref":"#/components/schemas/HrisWorkerRelationsProfileHrisProfileOidGetResponsesContentApplicationJsonSchemaDataItemsChildRelationshipsItems"},"description":"An array containing the information about the child profiles in the relation."},"parent_relationship":{"oneOf":[{"$ref":"#/components/schemas/HrisWorkerRelationsProfileHrisProfileOidGetResponsesContentApplicationJsonSchemaDataItemsParentRelationship"},{"type":"null"}],"description":"An object that has information about the parent profile in the relation."}},"title":"HrisWorkerRelationsProfileHrisProfileOidGetResponsesContentApplicationJsonSchemaDataItems"},"worker-relations_getWorkerRelationProfile_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/HrisWorkerRelationsProfileHrisProfileOidGetResponsesContentApplicationJsonSchemaDataItems"},"description":"An array containing the Worker Relations of the profile. It includes either the parent or child relations."}},"title":"worker-relations_getWorkerRelationProfile_Response_200"},"HrisWorkerRelationsTypesGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The ID of the relation type"},"child_name":{"type":"string","description":"The name of the secondary party in the relationship"},"is_default":{"type":"boolean","description":"Whether this relation is default or not"},"external_id":{"type":["string","null"],"description":"A custom ID for the relation type"},"parent_name":{"type":"string","description":"The name of the primary party in the relationship"}},"title":"HrisWorkerRelationsTypesGetResponsesContentApplicationJsonSchemaDataItems"},"worker-relations_getWorkerRelationTypes_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/HrisWorkerRelationsTypesGetResponsesContentApplicationJsonSchemaDataItems"}}},"title":"worker-relations_getWorkerRelationTypes_Response_200"},"HrisWorkerRelationsTypesGetResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code"},"message":{"type":"string","description":"Human-readable explanation of the error"}},"title":"HrisWorkerRelationsTypesGetResponsesContentApplicationJsonSchemaErrorsItems"},"RetrieveAllWorkerRelationTypes-v2026-01-01RequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/HrisWorkerRelationsTypesGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"RetrieveAllWorkerRelationTypes-v2026-01-01RequestBadRequestError"},"RetrieveAllWorkerRelationTypes-v2026-01-01RequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/HrisWorkerRelationsTypesGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"RetrieveAllWorkerRelationTypes-v2026-01-01RequestInternalServerError"},"HrisWorkerRelationsTypesTypeIdPatchRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"child_name":{"type":"string","description":"The name of the secondary party in the relationship"},"external_id":{"type":"string","description":"A custom ID for the relation type"},"parent_name":{"type":"string","description":"The name of the primary party in the relationship"}},"title":"HrisWorkerRelationsTypesTypeIdPatchRequestBodyContentApplicationJsonSchemaData"},"HrisWorkerRelationsTypesTypeIdPatchResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"integer","description":"Worker Relation Type id"},"child_name":{"type":"string","description":"The name of the secondary party in the relationship"},"is_default":{"type":"boolean","description":"Whether this relation is default or not"},"external_id":{"type":"string","description":"A custom ID for the relation type"},"parent_name":{"type":"string","description":"The name of the primary party in the relationship"}},"title":"HrisWorkerRelationsTypesTypeIdPatchResponsesContentApplicationJsonSchemaData"},"worker-relations_updateWorkerRelationType_Response_204":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/HrisWorkerRelationsTypesTypeIdPatchResponsesContentApplicationJsonSchemaData"}},"title":"worker-relations_updateWorkerRelationType_Response_204"},"HrisWorkerRelationsTypesExternalExternalIdPatchRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"child_name":{"type":"string","description":"The name of the secondary party in the relationship"},"external_id":{"type":"string","description":"A custom ID for the relation type"},"parent_name":{"type":"string","description":"The name of the primary party in the relationship"}},"title":"HrisWorkerRelationsTypesExternalExternalIdPatchRequestBodyContentApplicationJsonSchemaData"},"HrisWorkerRelationsTypesExternalExternalIdPatchResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"integer","description":"The ID of the relation type"},"child_name":{"type":"string","description":"The name of the secondary party in the relationship"},"is_default":{"type":"boolean","description":"Whether this relation is default or not"},"external_id":{"type":"string","description":"A custom ID for the relation type"},"parent_name":{"type":"string","description":"The name of the primary party in the relationship"}},"title":"HrisWorkerRelationsTypesExternalExternalIdPatchResponsesContentApplicationJsonSchemaData"},"worker-relations_updateWorkerRelationTypeByExternalId_Response_204":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/HrisWorkerRelationsTypesExternalExternalIdPatchResponsesContentApplicationJsonSchemaData"}},"title":"worker-relations_updateWorkerRelationTypeByExternalId_Response_204"}},"securitySchemes":{"deelToken":{"type":"http","scheme":"bearer","description":"## Authentication\nThe Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.\n\n```curl\ncurl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \\\n  -H 'Authorization: Bearer YOUR-TOKEN-HERE'\n```\n\n[Learn more about authentication](/api/authentication)\n"},"oauth2":{"type":"http","scheme":"bearer","description":"Standard OAuth2 security scheme based on https://swagger.io/docs/specification/authentication/"}}}}