{"openapi":"3.1.0","info":{"title":"Endpoints","version":"1.0.0"},"paths":{"/invoices/{id}/download":{"get":{"operationId":"get-billing-invoice-download-link","summary":"Download invoice PDF","description":"Get a link to download the invoice PDF.\n **Token scopes**: `accounting:read`","tags":["subpackage_accounting"],"parameters":[{"name":"id","in":"path","description":"The invoice ID used to identify the invoice to be downloaded.","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/Accounting_getBillingInvoiceDownloadLink_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"}}}}}}},"/invoices/{invoice_id}":{"get":{"operationId":"get-invoice-by-id-v-2026-01-01","summary":"Get invoice by id","description":"Retrieve invoice details\n **Token scopes**: `accounting:read`","tags":["subpackage_accounting"],"parameters":[{"name":"invoice_id","in":"path","description":"The invoice ID used to identify the invoice to be retireved.","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":"The invoice resource returned","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Accounting_getInvoiceById-v2026-01-01_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":"Invoice not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetInvoiceById-v2026-01-01RequestNotFoundError"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}}}},"/payments/{payment_id}/breakdown":{"get":{"operationId":"retrieve-a-payment-breakdown-v-2026-01-01","summary":"Retrieve a payment breakdown","description":"Get a full breakdown of a payment made to Deel. Breakdown will include individual invoices and Deel fee as line items.\n **Token scopes**: `accounting:read`","tags":["subpackage_accounting"],"parameters":[{"name":"payment_id","in":"path","description":"Unique identifier for the payment to retrieve the breakdown.","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/Accounting_retrieveAPaymentBreakdown-v2026-01-01_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"}}}}}}},"/invoices/deel":{"get":{"operationId":"retrieve-deel-invoices","summary":"Retrieve Deel invoices","description":"Retrieve a list of invoices related to Deel fees.\n **Token scopes**: `accounting:read`","tags":["subpackage_accounting"],"parameters":[{"name":"limit","in":"query","description":"Return a page of results with given number of records; NOTE technically ALL query parameters are strings or array of strings","required":false,"schema":{"type":"string"}},{"name":"offset","in":"query","description":"Return a page of results after given index of row; NOTE technically ALL query parameters are strings or array of strings'","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/Accounting_retrieveDeelInvoices_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"}}}}}}},"/invoices":{"get":{"operationId":"retrieve-invoices","summary":"Retrieve invoices","description":"Retrieve a list of paid invoices for your workforce.\n **Token scopes**: `accounting:read`","tags":["subpackage_accounting"],"parameters":[{"name":"issued_from_date","in":"query","description":"Filter invoices issued on or after the specified date.","required":false,"schema":{"type":"string"}},{"name":"issued_to_date","in":"query","description":"Filter invoices issued before the specified date.","required":false,"schema":{"type":"string"}},{"name":"status","in":"query","description":"If status query has value of all, all invoices will be returned. Otherwise only paid invoices will be fetched.","required":false,"schema":{"$ref":"#/components/schemas/InvoicesGetParametersStatus"}},{"name":"limit","in":"query","description":"Number of records to retrieve per page.","required":false,"schema":{"type":"number","format":"double","default":25}},{"name":"offset","in":"query","description":"Index of the first record to return.","required":false,"schema":{"type":"integer","format":"int64","default":0}},{"name":"cursor","in":"query","description":"Return next page of results after the given cursor.","required":false,"schema":{"type":"string"}},{"name":"include","in":"query","description":"Will include invoices from COR workers in the response.","required":false,"schema":{"$ref":"#/components/schemas/InvoicesGetParametersInclude"}},{"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/Accounting_retrieveInvoices_Response_200"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/InvoicesGetResponsesContentApplicationJsonSchemaItems"}}}}},"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"}}}}}}},"/payments":{"get":{"operationId":"retrieve-payment-receipts-v-2026-01-01","summary":"Retrieve payment receipts","description":"Returns a cursor-paginated list of payments made to Deel, including worker details, payment status, and payment methods. Use the `next_cursor` value from the response to retrieve subsequent pages.\n **Token scopes**: `accounting:read`","tags":["subpackage_accounting"],"parameters":[{"name":"date_from","in":"query","description":"Filters results to include payments created on or after this date (in ISO 8601 format).","required":false,"schema":{"type":"string","format":"date"}},{"name":"date_to","in":"query","description":"Filters results to include payments created before this date (in ISO 8601 format).","required":false,"schema":{"type":"string","format":"date"}},{"name":"cursor","in":"query","description":"A cursor for pagination. Use the value returned in the 'next_cursor' field to get the next page of results.","required":false,"schema":{"type":"string"}},{"name":"currencies","in":"query","description":"Filters payments by their currency codes. Can be a single currency code or an array of codes.","required":false,"schema":{"$ref":"#/components/schemas/PaymentsGetParametersCurrencies"}},{"name":"entities","in":"query","description":"Filters payments by legal entity type (e.g., 'individual' or 'company'). Can be a single entity type or an array.","required":false,"schema":{"$ref":"#/components/schemas/PaymentsGetParametersEntities"}},{"name":"statuses","in":"query","description":"Filters payments by their status (e.g., 'paid' or 'processing'). Can be a single status type or an array.","required":false,"schema":{"$ref":"#/components/schemas/PaymentsGetParametersStatuses"}},{"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/Accounting_retrievePaymentReceipts-v2026-01-01_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/RetrievePaymentReceipts-v2026-01-01RequestInternalServerError"}}}}}}},"/adjustments":{"post":{"operationId":"create-contract-adjustment","summary":"Create a new adjustment","description":"Generates a new adjustment entry attributed to a specific worker\n **Token scopes**: `adjustments:write`","tags":["subpackage_adjustments"],"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/adjustments_createContractAdjustment_Response_201"}}}},"400":{"description":"Bad Request – failed to create adjustments","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateANewAdjustment-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":"Creation data for a new adjustment","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"string","format":"binary","description":"File of adjustment."},"title":{"type":"string","description":"Title of adjustment."},"amount":{"$ref":"#/components/schemas/AdjustmentsPostRequestBodyContentMultipartFormDataSchemaAmount","description":"Amount of adjustment."},"vendor":{"type":"string","description":"Vendor of adjustment."},"country":{"type":"string","description":"Country code."},"contract_id":{"type":"string","description":"The identifier of the contract associated with the adjustment"},"description":{"type":"string","description":"Description of adjustment."},"cycle_reference":{"type":"string","description":"Cycle reference of adjustment."},"move_next_cycle":{"type":["boolean","null"],"description":"If an adjustments can belong to another payroll cycle."},"date_of_adjustment":{"type":["string","null"],"format":"date","description":"Short date in format ISO-8601 (YYYY-MM-DD). For example: 2022-12-31."},"adjustment_category_id":{"type":"string","description":"Adjustment category id."}},"required":["file","title","amount","vendor","country","contract_id","description","adjustment_category_id"]}}}}}},"/adjustments/{id}":{"delete":{"operationId":"delete-contract-adjustment","summary":"Delete an adjustment","description":"Delete an adjustment.\n **Token scopes**: `adjustments:write`","tags":["subpackage_adjustments"],"parameters":[{"name":"id","in":"path","description":"Deel adjustment 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/adjustments_deleteContractAdjustment_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-contract-adjustment","summary":"Retrieve an adjustment","description":"Use this endpoint to retrieve details of a specific adjustment by its id. You can view its amount, status, dates, and related contract_id\n **Token scopes**: `adjustments:read`","tags":["subpackage_adjustments"],"parameters":[{"name":"id","in":"path","description":"Deel adjustment 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/adjustments_getContractAdjustment_Response_200"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveAnAdjustmentRequestBadRequestError"}}}},"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-contract-adjustment","summary":"Update an adjustment","description":"Update an adjustment.\n **Token scopes**: `adjustments:write`","tags":["subpackage_adjustments"],"parameters":[{"name":"id","in":"path","description":"Deel adjustment 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/adjustments_updateContractAdjustment_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":{"description":"Adjustment object that needs to be updated","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AdjustmentsIdPatchRequestBodyContentMultipartFormDataSchemaData","description":"Details of adjustment to update"}},"required":["data"]}}}}}},"/contracts/{contract_id}/adjustments":{"get":{"operationId":"get-contract-adjustments","summary":"Retrieve adjustments","description":"Get all adjustments for the specific contract.\n **Token scopes**: `adjustments:read`","tags":["subpackage_adjustments"],"parameters":[{"name":"contract_id","in":"path","description":"Deel adjustment id.","required":true,"schema":{"type":"string"}},{"name":"from","in":"query","description":"Filter adjustments by start date.","required":false,"schema":{"type":"string","format":"date"}},{"name":"to","in":"query","description":"Filter adjustments by end 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 operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/adjustments_getContractAdjustments_Response_200"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveAdjustmentsRequestBadRequestError"}}}},"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"}}}}}}},"/adjustments/categories":{"get":{"operationId":"get-adjustment-categories","summary":"Retrieve categories","description":"Get all categories for your organization.\n **Token scopes**: `adjustments:read`","tags":["subpackage_adjustments"],"parameters":[{"name":"contract_types","in":"query","description":"array of contract types to filter categories","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/AdjustmentsCategoriesGetParametersContractTypesSchemaItems"}}},{"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/adjustments_getAdjustmentCategories_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"}}}}}}},"/it/assets":{"get":{"operationId":"get-it-assets","summary":"List IT assets","description":"Retrieve a paginated list of all IT assets managed by the organization. This is useful for getting a complete overview of your equipment inventory and understanding the state of each asset. For more info, visit [Assets](https://developer.deel.com/docs/deel-it-api#assets).\n **Token scopes**: `it-assets:read`","tags":["subpackage_assets"],"parameters":[{"name":"cursor","in":"query","description":"Indicates where the next page of results starts, as returned in a paginated list response","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Return a page of results with given number of records","required":false,"schema":{"type":"integer","default":20}},{"name":"hris_profile_id","in":"query","description":"Filter assets by assigned worker with given HRIS Profile ID","required":false,"schema":{"type":"string","format":"uuid"}},{"name":"location","in":"query","description":"Filter assets by their location","required":false,"schema":{"$ref":"#/components/schemas/ItAssetsGetParametersLocation"}},{"name":"category","in":"query","description":"Filter assets by their product category","required":false,"schema":{"$ref":"#/components/schemas/ItAssetsGetParametersCategory"}},{"name":"status","in":"query","description":"Filter assets by their status","required":false,"schema":{"$ref":"#/components/schemas/ItAssetsGetParametersStatus"}},{"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":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/assets_getITAssets_Response_200"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListItAssetsRequestBadRequestError"}}}},"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/ListItAssetsRequestInternalServerError"}}}}}}},"/it/assets/{asset_id}":{"get":{"operationId":"get-it-asset-by-id","summary":"Retrieve an IT asset","description":"Retrieve the details of a specific IT asset using its unique identifier. This allows you to check information such as the asset's model, serial number, status, and location.  For more info, visit [Assets](https://developer.deel.com/docs/deel-it-api#assets).\n **Token scopes**: `it-assets:read`","tags":["subpackage_assets"],"parameters":[{"name":"asset_id","in":"path","description":"Unique identifier of the IT asset","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":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/assets_getITAssetById_Response_200"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveAnItAssetRequestBadRequestError"}}}},"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/RetrieveAnItAssetRequestInternalServerError"}}}}}}},"/ats/applications/{application_id}/notes":{"post":{"operationId":"add-note-to-an-application-v-2026-01-01","summary":"Add note to an application","description":"Create application note: Adds a new note to a specific candidate application. Use this to record interview feedback, recruiter observations, or internal comments during the hiring process. The 'authorId' must correspond to a valid HRIS user. Scope: ats:write\n **Token scopes**: `ats:write`","tags":["subpackage_ats"],"parameters":[{"name":"application_id","in":"path","description":"Id of the application which the note will be added","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":{"201":{"description":"Application note created successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ATS_addNoteToAnApplication-v2026-01-01_Response_201"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddNoteToAnApplication-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/AddNoteToAnApplication-v2026-01-01RequestInternalServerError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AtsApplicationsApplicationIdNotesPostRequestBodyContentApplicationJsonSchemaData"}},"required":["data"]}}}}}},"/ats/applications/{application_id}/interview-plan-stages":{"post":{"operationId":"associate-application-with-an-interview-plan-stage-v-2026-01-01","summary":"Associate application with an interview plan stage","description":"Use this endpoint to associate an application with a specific interview plan stage in the hiring workflow. Use it when moving a candidate into a stage or backfilling history. Set is_current_stage to true to update the application's current stage; set it to false to record a historical entry without changing the current stage. To control triggered activities, pass applicable_job_activities; omit it to trigger all activities or pass an empty array to trigger none. If the candidate is being archived, include candidate_archivation_reason_id and optionally candidate_archivation_email_template_id to send a rejection email.\n **Token scopes**: `ats:write`","tags":["subpackage_ats"],"parameters":[{"name":"application_id","in":"path","description":"ID of the application to be associated with the interview plan stage","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":{"201":{"description":"Application interview plan stage successfully created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ATS_associateApplicationWithAnInterviewPlanStage-v2026-01-01_Response_201"}}}},"400":{"description":"Email body contains placeholders that can't be resolved","content":{"application/json":{"schema":{"description":"Any type"}}}},"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/AtsApplicationsApplicationIdInterviewPlanStagesPostRequestBodyContentApplicationJsonSchemaData"}},"required":["data"]}}}}}},"/ats/applications":{"post":{"operationId":"create-ats-application-v-2026-01-01","summary":"Create ATS Application","description":"Use this endpoint to create a new application linking an existing candidate to a job in your ATS. Call it when a candidate applies or when importing applications from another system.\n **Token scopes**: `ats:write`","tags":["subpackage_ats"],"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 response with application data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ATS_createAtsApplication-v2026-01-01_Response_201"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAtsApplication-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/CreateAtsApplication-v2026-01-01RequestInternalServerError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AtsApplicationsPostRequestBodyContentApplicationJsonSchemaData"}},"required":["data"]}}}}},"get":{"operationId":"retrieve-a-list-of-ats-applications-v-2026-01-01","summary":"Retrieve a list of ATS applications","description":"List applications: Returns a paginated list of candidate applications for an organization. Use this to track and review the progress of candidates across all open positions. Supports cursor-based pagination and filtering via query parameters. Scope: ats:read\n **Token scopes**: `ats:read`","tags":["subpackage_ats"],"parameters":[{"name":"cursor","in":"query","description":"Cursor for pagination. Use the nextCursor value from the previous response to get the next page of results.","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Maximum number of applications to return per page","required":false,"schema":{"type":"integer","default":20}},{"name":"search_text","in":"query","description":"Search text to filter applications by candidate name or email","required":false,"schema":{"type":"string"}},{"name":"job_id","in":"query","description":"Filter applications by specific job ID","required":false,"schema":{"type":"string","format":"uuid"}},{"name":"interview_plan_stage_ids","in":"query","description":"Filter applications by specific interview plan stage IDs","required":false,"schema":{"type":"array","items":{"type":"string","format":"uuid"}}},{"name":"candidate_tag_ids","in":"query","description":"Filter applications by candidate tag IDs","required":false,"schema":{"type":"array","items":{"type":"string","format":"uuid"}}},{"name":"source_slugs","in":"query","description":"Filter applications by source slugs","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"job_criterias_matchings","in":"query","description":"Filter applications by job criteria matching state. Each object specifies a job criteria ID and whether the candidate matches it.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/AtsApplicationsGetParametersJobCriteriasMatchingsSchemaItems"}}},{"name":"current_stage_category_type_slugs","in":"query","description":"Filter applications by current stage category type slugs","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"current_stage_default_type_slugs","in":"query","description":"Filter applications by current stage default type slugs. Use 'others' for custom stages.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"updated_after","in":"query","description":"Filter applications updated after this timestamp (ISO 8601 format)","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"sort_by","in":"query","description":"Field to sort applications by","required":false,"schema":{"$ref":"#/components/schemas/AtsApplicationsGetParametersSortBy"}},{"name":"sort_order","in":"query","description":"Sort order for applications","required":false,"schema":{"$ref":"#/components/schemas/AtsApplicationsGetParametersSortOrder"}},{"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 retrieved applications","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ATS_retrieveAListOfAtsApplications-v2026-01-01_Response_200"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveAListOfAtsApplications-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/RetrieveAListOfAtsApplications-v2026-01-01RequestInternalServerError"}}}}}}},"/ats/candidates":{"post":{"operationId":"create-ats-candidate-v-2026-01-01","summary":"Create ATS Candidate","description":"This endpoint allows the creation of a new candidate within the ATS system. The user must provide all required fields, and the candidate will be created with the specified details.\n **Token scopes**: `ats:write`","tags":["subpackage_ats"],"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 response with candidate data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ATS_createAtsCandidate-v2026-01-01_Response_201"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAtsCandidate-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/CreateAtsCandidate-v2026-01-01RequestInternalServerError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AtsCandidatesPostRequestBodyContentApplicationJsonSchemaData"}},"required":["data"]}}}}},"get":{"operationId":"retrieve-paginated-list-of-ats-candidates-v-2026-01-01","summary":"Retrieve paginated list of ATS Candidates","description":"Retrieves a list of candidates in the Applicant Tracking System. You can filter candidates by jobs, departments, and tags to narrow down the results\n **Token scopes**: `ats:read`","tags":["subpackage_ats"],"parameters":[{"name":"cursor","in":"query","description":"The cursor for pagination","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Maximum number of records returned in one response","required":false,"schema":{"type":"integer","default":20}},{"name":"search","in":"query","description":"Search text for filtering candidates","required":false,"schema":{"type":"string"}},{"name":"job_ids","in":"query","description":"Filter candidates by job IDs","required":false,"schema":{"type":"array","items":{"type":"string","format":"uuid"}}},{"name":"department_ids","in":"query","description":"Filter candidates by department IDs","required":false,"schema":{"type":"array","items":{"type":"string","format":"uuid"}}},{"name":"tag_ids","in":"query","description":"Filter candidates by tag IDs","required":false,"schema":{"type":"array","items":{"type":"string","format":"uuid"}}},{"name":"current_stage_category_type_slugs","in":"query","description":"Filter candidates by current stage category type slugs","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"current_stage_default_type_slugs","in":"query","description":"Filter candidates by current stage default type slugs","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"updated_after","in":"query","description":"Filter applications updated after this timestamp (ISO 8601 format)","required":false,"schema":{"type":"string","format":"date-time"}},{"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/ATS_retrievePaginatedListOfAtsCandidates-v2026-01-01_Response_200"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrievePaginatedListOfAtsCandidates-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/RetrievePaginatedListOfAtsCandidates-v2026-01-01RequestInternalServerError"}}}}}}},"/ats/jobs":{"post":{"operationId":"create-ats-job","summary":"Create ATS Job","description":"This endpoint allows the creation of a new job within the ATS system. The user must provide all required fields, and the job will be created with the specified details.\n **Token scopes**: `ats:write`","tags":["subpackage_ats"],"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":"Job successfully created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ATS_createAtsJob_Response_201"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAtsJobRequestBadRequestError"}}}},"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/AtsJobsPostRequestBodyContentApplicationJsonSchemaData"}}}}}}},"get":{"operationId":"retrieve-a-list-of-ats-jobs","summary":"Retrieve a list of ATS jobs","description":"Retrieves a list of all jobs in the Applicant Tracking System. Results can be filtered by query parameters.\n **Token scopes**: `ats:read`","tags":["subpackage_ats"],"parameters":[{"name":"cursor","in":"query","description":"The cursor for pagination","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Maximum number of records returned in one response","required":false,"schema":{"type":"integer","default":20}},{"name":"search","in":"query","description":"Text to search for in job records (optional)","required":false,"schema":{"type":"string"}},{"name":"interview_plan_id","in":"query","description":"Interview plan UUID (optional)","required":false,"schema":{"type":"string","format":"uuid"}},{"name":"location_ids","in":"query","description":"Array of location UUIDs (optional)","required":false,"schema":{"type":"array","items":{"type":"string","format":"uuid"}}},{"name":"team_ids","in":"query","description":"Array of team UUIDs (optional)","required":false,"schema":{"type":"array","items":{"type":"string","format":"uuid"}}},{"name":"employment_type_ids","in":"query","description":"Array of employment type UUIDs (optional)","required":false,"schema":{"type":"array","items":{"type":"string","format":"uuid"}}},{"name":"department_ids","in":"query","description":"Array of department UUIDs (optional)","required":false,"schema":{"type":"array","items":{"type":"string","format":"uuid"}}},{"name":"updated_after","in":"query","description":"Filter jobs updated after this timestamp (ISO 8601 format)","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"status","in":"query","description":"Array of job status values (optional)","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/AtsJobsGetParametersStatusSchemaItems"}}},{"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/ATS_retrieveAListOfAtsJobs_Response_200"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AtsJobsGetResponsesContentApplicationJsonSchemaItems"}}}}},"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"}}}}}}},"/ats/candidates/{candidate_id}/tags":{"post":{"operationId":"create-candidate-tags-v-2026-02-27","summary":"Create candidate tags","description":"This endpoint replaces all existing tags associated with a candidate with a new set. Use this when updating candidate tags is necessary.\n **Token scopes**: `ats:write`","tags":["subpackage_ats"],"parameters":[{"name":"candidate_id","in":"path","description":"The unique identifier of the candidate.","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":{"201":{"description":"Successfully created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ATS_createCandidateTags-v2026-02-27_Response_201"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCandidateTags-v2026-02-27RequestBadRequestError"}}}},"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/CreateCandidateTags-v2026-02-27RequestInternalServerError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"tag_ids":{"type":"array","items":{"type":"string","format":"uuid"},"description":"List of tag IDs to associate with the candidate"}},"required":["tag_ids"]}}}}}},"/ats/tags":{"get":{"operationId":"list-tags-v-2026-02-27","summary":"List tags","description":"Use this endpoint to list all tags associated with the organization. View or organize tags based on filters like label or tag group.\n **Token scopes**: `ats:read`","tags":["subpackage_ats"],"parameters":[{"name":"search_text","in":"query","description":"Filter tags by label (case-insensitive partial match)","required":false,"schema":{"type":"string"}},{"name":"tag_group_slug","in":"query","description":"Filter by tag group. Use CANDIDATE for candidate tags.","required":false,"schema":{"$ref":"#/components/schemas/AtsTagsGetParametersTagGroupSlug"}},{"name":"include_counts","in":"query","description":"When true, each tag includes candidates_count (number of candidates with that tag)","required":false,"schema":{"$ref":"#/components/schemas/AtsTagsGetParametersIncludeCounts"}},{"name":"cursor","in":"query","description":"Opaque cursor for pagination. Use the value from next_cursor of the previous response to fetch the next page.","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Maximum number of tags to return per page (default: 20, max: 100).","required":false,"schema":{"type":"integer","default":20}},{"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. Returns the list of tags for the organization.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ATS_listTags-v2026-02-27_Response_200"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListTags-v2026-02-27RequestBadRequestError"}}}},"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/ListTags-v2026-02-27RequestInternalServerError"}}}}}}},"/ats/application-sources":{"get":{"operationId":"retrieve-a-list-of-ats-application-sources","summary":"Retrieve a list of ATS application sources","description":"Retrieves a list of the available application sources in the Applicant Tracking System.\n **Token scopes**: `ats:read`","tags":["subpackage_ats"],"parameters":[{"name":"cursor","in":"query","description":"The cursor for pagination","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Maximum number of records returned in one response","required":false,"schema":{"type":"integer","default":20}},{"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 retrieved application sources","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ATS_retrieveAListOfAtsApplicationSources_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"}}}}}}},"/ats/departments":{"get":{"operationId":"retrieve-a-list-of-ats-departments","summary":"Retrieve a list of ATS departments","description":"Retrieves a list of all departments in the Applicant Tracking System\n **Token scopes**: `ats:read`","tags":["subpackage_ats"],"parameters":[{"name":"cursor","in":"query","description":"The cursor for pagination","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Maximum number of records returned in one response","required":false,"schema":{"type":"integer","default":20}},{"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 with departments data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ATS_retrieveAListOfAtsDepartments_Response_200"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveAListOfAtsDepartmentsRequestBadRequestError"}}}},"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"}}}}}}},"/ats/employment-types":{"get":{"operationId":"retrieve-a-list-of-ats-employment-types","summary":"Retrieve a list of ATS employment types","description":"Use this endpoint to fetch employment types available in ATS for syncing and validation workflows.\n **Token scopes**: `ats:read`","tags":["subpackage_ats"],"parameters":[{"name":"cursor","in":"query","description":"The cursor for pagination","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Maximum number of records returned in one response","required":false,"schema":{"type":"integer","default":20}},{"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 with employment types data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ATS_retrieveAListOfAtsEmploymentTypes_Response_200"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveAListOfAtsEmploymentTypesRequestBadRequestError"}}}},"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"}}}}}}},"/ats/job-boards/{job_board_id}/job-postings":{"get":{"operationId":"retrieve-a-list-of-ats-job-postings","summary":"Retrieve a list of ATS job postings","description":"Retrieves a list of all job postings in the Applicant Tracking System. Results can be filtered by query parameters.\n **Token scopes**: `ats:read`","tags":["subpackage_ats"],"parameters":[{"name":"job_board_id","in":"path","description":"Job Board ID must be a valid UUID","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"cursor","in":"query","description":"The cursor for pagination (optional)","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Maximum number of records returned in one response (optional)","required":false,"schema":{"type":"integer","default":20}},{"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/ATS_retrieveAListOfAtsJobPostings_Response_200"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaItems"}}}}},"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"}}}}}}},"/ats/locations":{"get":{"operationId":"retrieve-a-list-of-ats-locations-v-2026-01-01","summary":"Retrieve a list of ATS locations","description":"List locations: Returns a paginated list of all locations associated with an organization in ATS. Use this to retrieve available work locations when creating job postings or filtering candidates by location. Scope: ats:read\n **Token scopes**: `ats:read`","tags":["subpackage_ats"],"parameters":[{"name":"cursor","in":"query","description":"The cursor for pagination","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Maximum number of records returned in one response","required":false,"schema":{"type":"integer","default":20}},{"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 with locations data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ATS_retrieveAListOfAtsLocations-v2026-01-01_Response_200"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveAListOfAtsLocations-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"}}}}}}},"/ats/offers":{"get":{"operationId":"retrieve-a-list-of-ats-offers-v-2026-01-01","summary":"Retrieve a list of ATS offers","description":"List offers: Returns all offers associated with an organization, including worker type and offer status. Use this to review outstanding or accepted offers before initiating onboarding or contract creation workflows. Scope: ats:read\n **Token scopes**: `ats:read`","tags":["subpackage_ats"],"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/ATS_retrieveAListOfAtsOffers-v2026-01-01_Response_200"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveAListOfAtsOffers-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"}}}}}}},"/ats/email-templates":{"get":{"operationId":"retrieve-a-list-of-published-ats-email-templates-v-2026-02-11","summary":"Retrieve a list of published ATS email templates","description":"List email templates: Returns a paginated list of published email templates for an organization. Use this to populate template selectors when composing candidate communications or automating outreach workflows. Supports cursor-based pagination and filtering by update time via the 'updatedAfter' query parameter. Scope: ats:read\n **Token scopes**: `ats:read`","tags":["subpackage_ats"],"parameters":[{"name":"cursor","in":"query","description":"Cursor for pagination. Use the nextCursor value from the previous response to get the next page of results.","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Maximum number of email templates to return per page","required":false,"schema":{"type":"integer","default":20}},{"name":"updated_after","in":"query","description":"Return only email templates that were updated after this timestamp (ISO 8601 format)","required":false,"schema":{"type":"string","format":"date-time"}},{"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 retrieved email templates","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ATS_retrieveAListOfPublishedAtsEmailTemplates-v2026-02-11_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/RetrieveAListOfPublishedAtsEmailTemplates-v2026-02-11RequestInternalServerError"}}}}}}},"/ats/applications/{application_id}":{"get":{"operationId":"retrieve-ats-application-v-2026-01-01","summary":"Retrieve ATS application","description":"This endpoint retrieves a single application by its ID for a specific organization. It provides detailed information about the application, including its associated job details, job posting details, and other relevant metadata.\n **Token scopes**: `ats:read`","tags":["subpackage_ats"],"parameters":[{"name":"application_id","in":"path","description":"Unique identifier of the application to retrieve","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 with application data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ATS_retrieveAtsApplication-v2026-01-01_Response_200"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveAtsApplication-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/RetrieveAtsApplication-v2026-01-01RequestInternalServerError"}}}}}}},"/ats/hiring-members":{"get":{"operationId":"retrieve-ats-hiring-members","summary":"Retrieve ATS hiring members","description":"This endpoint retrieves a list of ATS hiring members. It provides detailed information about each hiring member, including their unique identifier, name, job title, email, profile picture URL, etc. The response also includes pagination details to help navigate through large sets of hiring members.\n **Token scopes**: `ats:read`","tags":["subpackage_ats"],"parameters":[{"name":"cursor","in":"query","description":"The cursor for pagination","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Maximum number of records returned in one response","required":false,"schema":{"type":"integer","default":20}},{"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/ATS_retrieveAtsHiringMembers_Response_200"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveAtsHiringMembersRequestBadRequestError"}}}},"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/RetrieveAtsHiringMembersRequestInternalServerError"}}}}}}},"/ats/job-postings/{job_posting_id}":{"get":{"operationId":"retrieve-ats-job-posting","summary":"Retrieve ATS job posting","description":"This endpoint retrieves a single job posting by its ID. It provides detailed information about the job posting, including its associated job details, publication status, and other relevant metadata.\n **Token scopes**: `ats:read`","tags":["subpackage_ats"],"parameters":[{"name":"job_posting_id","in":"path","description":"Unique identifier of the job posting to retrieve","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/ATS_retrieveAtsJobPosting_Response_200"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaItems"}}}}},"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"}}}}}}},"/ats/job-postings":{"get":{"operationId":"retrieve-ats-job-postings-v-2026-04-10","summary":"Retrieve ATS job postings","description":"Use this endpoint to retrieve job postings by specifying the job board ID or job ID. It provides detailed postings with job details, publication status, and relevant metadata.\n **Token scopes**: `ats:read`","tags":["subpackage_ats"],"parameters":[{"name":"job_board_id","in":"query","description":"Job board to list postings from (UUID).","required":false,"schema":{"type":"string","format":"uuid"}},{"name":"job_id","in":"query","description":"When set, only postings for this job are returned (UUID).","required":false,"schema":{"type":"string","format":"uuid"}},{"name":"cursor","in":"query","description":"Opaque cursor for pagination. Use the value from next_cursor of the previous response to fetch the next page.","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Maximum number of job postings to return per page (min: 1, max: 100).","required":false,"schema":{"type":"integer"}},{"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. Returns job postings for the requested job board (and optional job filter), with nested job details and publication state per board.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ATS_retrieveAtsJobPostings-v2026-04-10_Response_200"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveAtsJobPostings-v2026-04-10RequestBadRequestError"}}}},"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/RetrieveAtsJobPostings-v2026-04-10RequestInternalServerError"}}}}}}},"/ats/attachments/{attachable_type_slug}/{attachable_id}/{attachment_type_slug}":{"get":{"operationId":"retrieve-paginated-list-of-ats-attachment-files-v-2026-01-01","summary":"Retrieve paginated list of ATS attachment files","description":"Use this endpoint to list attachment files for a specific ATS entity. Provide attachable_type_slug, attachable_id, and attachment_type_slug to specify which entity and attachment type to list.\n **Token scopes**: `ats:read`","tags":["subpackage_ats"],"parameters":[{"name":"attachable_id","in":"path","description":"Unique identifier for the attachable entity","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"attachment_type_slug","in":"path","description":"Type of the attachment","required":true,"schema":{"$ref":"#/components/schemas/AtsAttachmentsAttachableTypeSlugAttachableIdAttachmentTypeSlugGetParametersAttachmentTypeSlug"}},{"name":"attachable_type_slug","in":"path","description":"Type of the attachable entity","required":true,"schema":{"$ref":"#/components/schemas/AtsAttachmentsAttachableTypeSlugAttachableIdAttachmentTypeSlugGetParametersAttachableTypeSlug"}},{"name":"cursor","in":"query","description":"The cursor for pagination","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Maximum number of records returned in one response","required":false,"schema":{"type":"integer","default":20}},{"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/ATS_retrievePaginatedListOfAtsAttachmentFiles-v2026-01-01_Response_200"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrievePaginatedListOfAtsAttachmentFiles-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/RetrievePaginatedListOfAtsAttachmentFiles-v2026-01-01RequestInternalServerError"}}}}}}},"/ats/reasons":{"get":{"operationId":"retrieve-paginated-list-of-ats-rejection-archivation-reasons-v-2026-01-01","summary":"Retrieve paginated list of ATS Rejection/Archivation reasons","description":"Retrieves a list of rejection or archivation reasons in the Applicant Tracking System. You can filter reasons by group and subgroup to narrow down the results\n **Token scopes**: `ats:read`","tags":["subpackage_ats"],"parameters":[{"name":"cursor","in":"query","description":"The cursor for pagination","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Maximum number of records returned in one response","required":false,"schema":{"type":"integer","default":20}},{"name":"search","in":"query","description":"Search text for filtering candidates","required":false,"schema":{"type":"string"}},{"name":"reason_group_slug","in":"query","description":"Reason group enum","required":false,"schema":{"$ref":"#/components/schemas/AtsReasonsGetParametersReasonGroupSlug"}},{"name":"include_counts","in":"query","description":"If sent true, it will fetch result with counts","required":false,"schema":{"type":"string"}},{"name":"subgroup_slug","in":"query","description":"Reason subgroup enum","required":false,"schema":{"$ref":"#/components/schemas/AtsReasonsGetParametersSubgroupSlug"}},{"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/ATS_retrievePaginatedListOfAtsRejectionArchivationReasons-v2026-01-01_Response_200"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrievePaginatedListOfAtsRejectionArchivationReasons-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/RetrievePaginatedListOfAtsRejectionArchivationReasons-v2026-01-01RequestInternalServerError"}}}}}}},"/candidates":{"post":{"operationId":"add-candidate","summary":"Add Candidate","description":"Add a candidate to Deel.\n **Token scopes**: `candidates:write`","tags":["subpackage_candidates"],"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/Candidates_addCandidate_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":{"description":"Add a candidate to Deel","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CandidatesPostRequestBodyContentApplicationJsonSchemaData","description":"Details of candidate to create"}},"required":["data"]}}}}}},"/consent_token":{"post":{"operationId":"create-consent-token","summary":"Create a consent token","description":"Creates a consent token for the specified user, profile and contract","tags":["subpackage_consent"],"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":"Consent token created successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Consent_createConsentToken_Response_201"}}}},"400":{"description":"Validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateConsentTokenRequestBadRequestError"}}}},"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/CreateConsentTokenRequestInternalServerError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ConsentTokenPostRequestBodyContentApplicationJsonSchemaData"}},"required":["data"]}}}}}},"/contracts/{contract_id}/amendments":{"post":{"operationId":"create-contract-amendment","summary":"Amend contract","description":"Amend the details of a contract. Please note that if the contract is already signed or active, then the update will have to be approved and re-signed for to take effect.\n **Token scopes**: `contracts:write`","tags":["subpackage_contractorAmendments"],"parameters":[{"name":"contract_id","in":"path","description":"The unique identifier of the employee contract.","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":{"201":{"description":"Successful operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/contractor-amendments_createContractAmendment_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":{"description":"Contract object that needs to be amended","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaData","description":"You can specify any combination of data points that need changing."}},"required":["data"]}}}}},"get":{"operationId":"get-contract-amendments","summary":"List contract amendments","description":"Retrieve amendments of a contract\n **Token scopes**: `contracts:read`, `contracts:write`","tags":["subpackage_contractorAmendments"],"parameters":[{"name":"contract_id","in":"path","description":"Unique identifier of the contract","required":true,"schema":{"type":"string"}},{"name":"statuses","in":"query","description":"Filter by work statement status.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/ContractsContractIdAmendmentsGetParametersStatusesSchemaItems"}}},{"name":"sign_statuses","in":"query","description":"Filter by work statement sign status.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/ContractsContractIdAmendmentsGetParametersSignStatusesSchemaItems"}}},{"name":"limit","in":"query","description":"Maximum number of work statements to return.","required":false,"schema":{"type":"integer","default":20}},{"name":"cursor","in":"query","description":"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":"Successful operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/contractor-amendments_getContractAmendments_Response_200"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListContractAmendments-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/ListContractAmendments-v2026-01-01RequestInternalServerError"}}}}}}},"/contracts/{contract_id}/documents":{"post":{"operationId":"create-contract-document","summary":"Attach a file to contract","description":"Attach a file to contract document.\n **Token scopes**: `contracts:write`","tags":["subpackage_contractorHiring"],"parameters":[{"name":"contract_id","in":"path","description":"Deel 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":{"201":{"description":"Successful operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/contractor-hiring_createContractDocument_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":{"description":"A form to attach a file to contract document.","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"string","format":"binary","description":"Upload the file you want to attach to this entry."}}}}}}}},"/contracts/{contract_id}/invite":{"get":{"operationId":"get-contract-invite","summary":"Get worker invite link","description":"Generates and returns a signed invitation URL that allows a worker to review and sign their contract securely. Use this endpoint to initiate or resend the contract signing process after the contract has been created. Requires the contract_id, which is provided during the initial Create Contract workflow.\n **Token scopes**: `contracts:read`","tags":["subpackage_contractorHiring"],"parameters":[{"name":"contract_id","in":"path","description":"Deel contract id.","required":true,"schema":{"type":"string"}},{"name":"locale","in":"query","description":"Locale to use for the invite link.","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.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/contractor-hiring_getContractInvite_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}/preview":{"get":{"operationId":"get-contract-preview","summary":"Preview a contract agreement","description":"Retrieve an IC and EOR contract agreement content in HTML. If no template is specified, the default or currently assigned template will be used. This endpoint does not support Global Payroll contract type.\n **Token scopes**: `contracts:read`, `worker:read`","tags":["subpackage_contractorHiring"],"parameters":[{"name":"contract_id","in":"path","description":"Deel contract id.","required":true,"schema":{"type":"string"}},{"name":"templateId","in":"query","description":"ID of an existing contract template.","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":{"type":"object","properties":{}}}}},"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}/invitations":{"delete":{"operationId":"get-contract-invitations","summary":"Remove invite","description":"Remove invite in order to re-invite a worker to sign the contract\n **Token scopes**: `contracts:write`","tags":["subpackage_contractorHiring"],"parameters":[{"name":"contract_id","in":"path","description":"Deel 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 operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/contractor-hiring_getContractInvitations_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"}}}}}},"post":{"operationId":"create-contract-invitation","summary":"Send contract to worker","description":"Invite a worker to sign the contract. Worker will be notified via email\n **Token scopes**: `contracts:write`","tags":["subpackage_contractorHiring"],"parameters":[{"name":"contract_id","in":"path","description":"Deel 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":{"201":{"description":"Successful operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/contractor-hiring_createContractInvitation_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/ContractsContractIdInvitationsPostRequestBodyContentApplicationJsonSchemaData"}}}}}}}},"/contracts/{contract_id}/payment_cycles":{"get":{"operationId":"get-contract-payment-cycles","summary":"Retrieve contractor payment dates","description":"Fetches a list of payment dates associated with a specific contract. This endpoint provides information on when contractors are scheduled to be paid, along with the current status of each payment cycle.\n **Token scopes**: `contracts:read`","tags":["subpackage_contractorHiring"],"parameters":[{"name":"contract_id","in":"path","description":"The Deel contract ID for which payment dates are being retrieved.","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":"A successful response containing contractor payment dates.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/contractor-hiring_getContractPaymentCycles_Response_200"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}}}},"/contracts/{contract_id}/signatures":{"post":{"operationId":"create-contract-signature","summary":"Sign a contract","description":"Sign a contract as a client.\n **Token scopes**: `contracts:write`","tags":["subpackage_contractorHiring"],"parameters":[{"name":"contract_id","in":"path","description":"Deel 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":{"201":{"description":"Successful operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/contractor-hiring_createContractSignature_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/ContractsContractIdSignaturesPostRequestBodyContentApplicationJsonSchemaData"}}}}}}}},"/contracts/{contract_id}":{"patch":{"operationId":"update-ic-contract","summary":"Add external Id","description":"Add an external Id to a Deel contract. You can use this to add a Deel contract's refernece Id in your platform. External Id can be passed as a query parameter in List contract endpoint to find this contract later.\n **Token scopes**: `contracts:write`","tags":["subpackage_contracts"],"parameters":[{"name":"contract_id","in":"path","description":"Deel 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 operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/contracts_updateICContract_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":{"$ref":"#/components/schemas/AddExternalIdRequestNotFoundError"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}},"requestBody":{"description":"Contract object that needs to be created","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ContractsContractIdPatchRequestBodyContentApplicationJsonSchemaData"}},"required":["data"]}}}}},"get":{"operationId":"get-contract","summary":"Retrieve a single contract","description":"Retrieve a single contract.\n **Token scopes**: `contracts:read`","tags":["subpackage_contracts"],"parameters":[{"name":"contract_id","in":"path","description":"Unique identifier of the contract.","required":true,"schema":{"type":"string"}},{"name":"expand","in":"query","description":"Include cost centers in the response.","required":false,"schema":{"$ref":"#/components/schemas/ContractsContractIdGetParametersExpand"}},{"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/contracts_getContract_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":{"$ref":"#/components/schemas/RetrieveASingleContract-v2026-01-01RequestNotFoundError"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}}}},"/equity/exercise/{public_id}":{"patch":{"operationId":"approve-an-equity-exercise-v-2026-01-01","summary":"Approve an equity exercise","description":"Approve an equity exercise.\n **Token scopes**: `contracts:write`","tags":["subpackage_contracts"],"parameters":[{"name":"public_id","in":"path","description":"Equity exercise public 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/Contracts_approveAnEquityExercise-v2026-01-01_Response_200"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"401":{"description":"Authentication failed. The access token is missing, expired, or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApproveAnEquityExercise-v2026-01-01RequestUnauthorizedError"}}}},"403":{"description":"Access denied. The authenticated user does not have the required contracts:write scope.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApproveAnEquityExercise-v2026-01-01RequestForbiddenError"}}}},"404":{"description":"Resource not found. The equity exercise request does not exist, is not in the required status (APPROVED_BY_EMPLOYEE), or its associated worker profile was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApproveAnEquityExercise-v2026-01-01RequestNotFoundError"}}}},"429":{"description":"Rate limit exceeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApproveAnEquityExercise-v2026-01-01RequestTooManyRequestsError"}}}},"500":{"description":"Internal server error. Occurs when an unexpected failure happens during approval processing (e.g., funding task creation failure). The exercise request status may be set to ERROR.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApproveAnEquityExercise-v2026-01-01RequestInternalServerError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"employer_approval":{"type":"string","description":"Approval decision by the employer for the equity exercise. Valid values: 'approved', 'rejected'."}},"required":["employer_approval"]}}}}}},"/contracts":{"post":{"operationId":"create-ic-contract","summary":"Create a new contract","description":"Create a new Deel contract.\n **Token scopes**: `contracts:write`","tags":["subpackage_contracts"],"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/contracts_createICContract_Response_201"}}}},"400":{"description":"Bad Request - Validation error or invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateANewContract-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":{"$ref":"#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaData"}},"required":["data"]}}}}},"get":{"operationId":"get-contracts","summary":"List of contracts","description":"Retrieve a list of contracts.\n **Token scopes**: `contracts:read`","tags":["subpackage_contracts"],"parameters":[{"name":"after_cursor","in":"query","description":"Return next page of results after the given cursor.","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Return a page of results with the given number of records.","required":false,"schema":{"type":"string"}},{"name":"order_direction","in":"query","description":"Order direction of results; ascending or descending.","required":false,"schema":{"$ref":"#/components/schemas/ContractsGetParametersOrderDirection"}},{"name":"types","in":"query","description":"Filter contracts by type. A contract is included in the results if its type is in this list.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/ContractsGetParametersTypesSchemaItems"}}},{"name":"statuses","in":"query","description":"Filter contracts by current status. A contract is included in the results if its status is in this list.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/ContractsGetParametersStatusesSchemaItems"}}},{"name":"team_id","in":"query","description":"Filter contracts for the given team ID. NOTE: All query parameters are technically strings or arrays of strings.","required":false,"schema":{"type":"string"}},{"name":"external_id","in":"query","description":"Filter contracts for the given external ID.","required":false,"schema":{"type":"string"}},{"name":"external_id_absent","in":"query","description":"Filter contracts by external ID presence. When true, returns contracts without an external ID. When false, returns contracts with an external ID. Cannot be used with external_id query param when set to true.","required":false,"schema":{"type":"string"}},{"name":"countries","in":"query","description":"Filter contracts by country codes.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"currencies","in":"query","description":"Filter contracts by currency codes.","required":false,"schema":{"$ref":"#/components/schemas/ContractsGetParametersCurrencies"}},{"name":"search","in":"query","description":"Include a contract if its name or the contractor's name contains the given search term.","required":false,"schema":{"type":"string"}},{"name":"sort_by","in":"query","description":"Sort contracts by the given field name.","required":false,"schema":{"$ref":"#/components/schemas/ContractsGetParametersSortBy"}},{"name":"expand","in":"query","description":"Include cost centers in the response.","required":false,"schema":{"$ref":"#/components/schemas/ContractsGetParametersExpand"}},{"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/contracts_getContracts_Response_200"}}}},"400":{"description":"Bad Request - Validation error or invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListOfContractsRequestBadRequestError"}}}},"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"}}}}}}},"/equity/exercise":{"post":{"operationId":"create-a-request-to-exercise-equity-v-2026-01-01","summary":"Create a request to exercise equity.","description":"Create a request to exercise equity.\n **Token scopes**: `contracts:write`","tags":["subpackage_contracts"],"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":"Equity exercise request created successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Contracts_createARequestToExerciseEquity-v2026-01-01_Response_201"}}}},"400":{"description":"Request validation failed. A required field is missing, has an invalid format, or the worker is not eligible for equity exercise.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateARequestToExerciseEquity-v2026-01-01RequestBadRequestError"}}}},"401":{"description":"Authentication failed. The access token is missing, expired, or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateARequestToExerciseEquity-v2026-01-01RequestUnauthorizedError"}}}},"403":{"description":"Access denied. The authenticated user does not have the required contracts:write scope.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateARequestToExerciseEquity-v2026-01-01RequestForbiddenError"}}}},"404":{"description":"The worker profile associated with the given worker_id was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateARequestToExerciseEquity-v2026-01-01RequestNotFoundError"}}}},"422":{"description":"A request with the same exercise_id already exists. Each exercise_id can only be used once.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateARequestToExerciseEquity-v2026-01-01RequestUnprocessableEntityError"}}}},"429":{"description":"Rate limit exceeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateARequestToExerciseEquity-v2026-01-01RequestTooManyRequestsError"}}}},"500":{"description":"Internal server error. Possible causes include missing EOR contract for the worker, FX rate service failure, or database errors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateARequestToExerciseEquity-v2026-01-01RequestInternalServerError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"fmv":{"type":"string","description":"The fair market value of the equity."},"quantity":{"type":"number","format":"double","description":"The quantity of equity to exercise. Must be a positive number."},"issuer_id":{"type":"string","description":"The unique identifier of the issuer."},"worker_id":{"type":"string","description":"The public UUID of the worker. Must correspond to an existing worker in the system."},"address_zip":{"type":"string","description":"The zip code of the address."},"exercise_id":{"type":"string","format":"uuid","description":"The unique identifier of the exercise."},"address_city":{"type":"string","description":"The city of the address."},"address_state":{"type":"string","description":"The state of the address."},"address_street":{"type":"string","description":"The street of the address."},"stakeholder_id":{"type":"string","description":"The unique identifier of the stakeholder."},"address_country":{"type":"string","description":"The country of the address."},"option_grant_id":{"type":"string","description":"The numeric identifier of the option grant. Must contain only digits."},"fmv_currency_code":{"type":"string","description":"The currency code of the fair market value (ISO 4217)."},"stakeholder_email":{"type":"string","format":"email","description":"The email address of the stakeholder."},"option_grant_issue":{"type":"string","description":"The issue of the option grant."},"option_grant_label":{"type":"string","description":"The label of the option grant."},"option_grant_currency":{"type":"string","description":"The currency of the option grant (ISO 4217)."},"option_grant_issue_date":{"type":"string","format":"date","description":"The issue date of the option grant (ISO 8601 date)."},"option_grant_expiry_date":{"type":"string","format":"date","description":"The expiry date of the option grant (ISO 8601 date)."},"stakeholder_relationship":{"type":"string","description":"The relationship of the stakeholder."},"option_grant_strike_price":{"type":"string","description":"The strike price of the option grant."}},"required":["fmv","quantity","issuer_id","worker_id","address_zip","exercise_id","address_city","address_state","address_street","stakeholder_id","address_country","option_grant_id","fmv_currency_code","stakeholder_email","option_grant_issue","option_grant_label","option_grant_currency","option_grant_issue_date","option_grant_expiry_date","stakeholder_relationship","option_grant_strike_price"]}}}}}},"/contracts/{contract_id}/equity_withholding_estimate":{"get":{"operationId":"get-contract-equity-withholding-amount","summary":"Get an estimate of withholding amount given an equity event.","description":"Get an estimate of the withholding amount required as well as the assumptions behind the estimate, given a contract id, event amount and currency code.\n **Token scopes**: `contracts:read`, `global-payroll:read`","tags":["subpackage_contracts"],"parameters":[{"name":"contract_id","in":"path","description":"Deel contract id.","required":true,"schema":{"type":"string"}},{"name":"event_value","in":"query","description":"The monetary value of the equity event.","required":true,"schema":{"type":"string"}},{"name":"event_currency","in":"query","description":"Three-letter currency code for the payment, following ISO 4217.","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/Contracts_getContractEquityWithholdingAmount_Response_200"}}}},"400":{"description":"Bad request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetContractEquityWithholdingAmountRequestBadRequestError"}}}},"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":"Unable to calculate due to missing information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetContractEquityWithholdingAmountRequestNotFoundError"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}}}},"/workers/contracts/{contract_id}/reject":{"post":{"operationId":"reject-contract","summary":"Reject contract","description":"Rejects a contract that is in the pending (unsigned) state by specifying its public ID in the contract_id parameter. Use this endpoint when you do not wish to proceed with the agreement. Only contracts that have not yet been signed or previously rejected are eligible for this action\n **Token scopes**: `worker:write`","tags":["subpackage_contracts"],"parameters":[{"name":"contract_id","in":"path","description":"The unique public identifier of the contract to reject. This is the contract's public ID that can be used to identify the specific contract in the system.","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":"No Content","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Contracts_rejectContract_Response_204"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RejectContractRequestBadRequestError"}}}},"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/RejectContractRequestInternalServerError"}}}}}}},"/workers/contracts/{contract_id}/pdf":{"get":{"operationId":"retrieve-contract-pdf-download-link","summary":"Retrieve contract PDF download link","description":"Use this endpoint to retrieve a secure URL for downloading the PDF version of a specific contract. Provide the contract_id in the path to get the download link. This link can be used by the authenticated worker to access the contract document.\n **Token scopes**: `worker:read`","tags":["subpackage_contracts"],"parameters":[{"name":"contract_id","in":"path","description":"The unique public identifier of the contract.","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/Contracts_retrieveContractPdfDownloadLink_Response_200"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveContractPdfDownloadLinkRequestBadRequestError"}}}},"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/RetrieveContractPdfDownloadLinkRequestInternalServerError"}}}}}}},"/contract-templates":{"get":{"operationId":"get-contract-templates","summary":"Retrieve contract templates","description":"Fetches a collection of contract templates available within your organization. Use this endpoint to retrieve metadata about the templates.\n **Token scopes**: `contracts:read`","tags":["subpackage_contracts"],"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":"A successful response containing contract templates.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Contracts_getContractTemplates_Response_200"}}}},"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"}}}}}}},"/workers/amendments/{amendment_id}/sign":{"post":{"operationId":"sign-amendment","summary":"Sign amendment","description":"Sign amendment as worker\n **Token scopes**: `worker:read`, `worker:write`, `benefits:read`","tags":["subpackage_contracts"],"parameters":[{"name":"amendment_id","in":"path","description":"The unique identifier of the amendment to sign","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":{"201":{"description":"Amendment successfully signed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Contracts_signAmendment_Response_201"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignAmendmentRequestBadRequestError"}}}},"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/WorkersAmendmentsAmendmentIdSignPostRequestBodyContentApplicationJsonSchemaData"}}}}}}}},"/workers/contracts/{contract_id}/signatures":{"post":{"operationId":"sign-worker-contract","summary":"Sign worker contract","description":"Sign contract as worker\n **Token scopes**: `worker:write`","tags":["subpackage_contracts"],"parameters":[{"name":"contract_id","in":"path","description":"The unique identifier of the contract.","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":{"201":{"description":"Contract successfully signed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Contracts_signWorkerContract_Response_201"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignWorkerContractRequestBadRequestError"}}}},"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/SignWorkerContractRequestInternalServerError"}}}}},"requestBody":{"description":"worker signature object that needs to be submitted","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/WorkersContractsContractIdSignaturesPostRequestBodyContentApplicationJsonSchemaData"}},"required":["data"]}}}}}},"/eor/employment_cost":{"post":{"operationId":"get-employment-cost","summary":"Calculate Employee Costs Globally","description":"Determine the total employment costs for an Employee of Record (EOR) arrangement across different countries, including salary, employer costs, benefits, and additional fees.","tags":["subpackage_costCalculator"],"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":"Successfully calculated employee costs.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cost-calculator_getEmploymentCost_Response_200"}}}},"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"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorEmploymentCostPostRequestBodyContentApplicationJsonSchemaData"}}}}}}}},"/contracts/{contract_id}/cost-centers":{"post":{"operationId":"assign-cost-centers-to-an-employment-contract-v-2026-01-01","summary":"Assign cost centers to an employment contract","description":"Assign cost centers to employment by contract id\n **Token scopes**: `contracts:write`","tags":["subpackage_costCenters"],"parameters":[{"name":"contract_id","in":"path","description":"Employment's 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":{"201":{"description":"Cost center allocation was successfully added to the contract","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Cost Centers_assignCostCentersToAnEmploymentContract-v2026-01-01_Response_201"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssignCostCentersToAnEmploymentContract-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":"Cost center information to allocate to the contract","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ContractsContractIdCostCentersPostRequestBodyContentApplicationJsonSchemaData"}},"required":["data"]}}}}}},"/legal-entities/{legal_entity_id}/cost-centers":{"get":{"operationId":"get-legal-entity-cost-centers","summary":"Get cost centers by legal entity","description":"Fetch all cost centers related to a given legal entity id\n **Token scopes**: `legal-entity:read`","tags":["subpackage_costCenters"],"parameters":[{"name":"legal_entity_id","in":"path","description":"Legal entity 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":"Cost center data was successfully fetched","content":{"application/json":{"schema":{"$ref":"#/components/schemas/cost-centers_getLegalEntityCostCenters_Response_200"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCostCentersByLegalEntityRequestBadRequestError"}}}},"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"}}}}}}},"/legal-entities/{legal_entity_id}/cost-centers/synchronize":{"post":{"operationId":"sync-cost-centers-for-legal-entity-v-2026-01-01","summary":"Sync cost centers for legal entity","description":"Update legal entity cost center's data to replicate the data provided on the request\n **Token scopes**: `legal-entity:write`","tags":["subpackage_costCenters"],"parameters":[{"name":"legal_entity_id","in":"path","description":"Legal entity 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":{"201":{"description":"Cost center data was successfully updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Cost Centers_syncCostCentersForLegalEntity-v2026-01-01_Response_201"}}}},"400":{"description":"Cannot define legal entity cost centers as the provided data.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SyncCostCentersForLegalEntity-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":"Unexpected error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SyncCostCentersForLegalEntity-v2026-01-01RequestInternalServerError"}}}}},"requestBody":{"description":"Cost center data to overwrite current configuration","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/LegalEntitiesLegalEntityIdCostCentersSynchronizePostRequestBodyContentApplicationJsonSchemaDataItems"}}},"required":["data"]}}}}}},"/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"]}}}}}},"/daas/payslips":{"get":{"operationId":"get-eor-employee-payslips","summary":"Get list of payslips for an EOR employee","description":"Get list of payslips for an EOR employee.\n **Token scopes**: `worker:read`","tags":["subpackage_deelAsAService"],"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":"Payslip records successfully retrieved.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Deel As a Service_getEorEmployeePayslips_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"}}}}}}},"/daas/banks/{bank_id}":{"patch":{"operationId":"patch-eor-bank-account","summary":"Modify bank account for an EOR employee","description":"Modify bank account for an EOR employee.\n **Token scopes**: `worker:write`","tags":["subpackage_deelAsAService"],"parameters":[{"name":"bank_id","in":"path","description":"Unique identifier for a bank in UUID format.","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":{"201":{"description":"Successful operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Deel As a Service_patchEORBankAccount_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":{"description":"Bank Account object that needs to be modified","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/DaasBanksBankIdPatchRequestBodyContentApplicationJsonSchemaDataItems"},"description":"Array of key value properties of bank account"}},"required":["data"]}}}}}},"/employee-info/contract-types/{type}/countries/{country}":{"get":{"operationId":"employee-additional-info-template-v-2026-01-01","summary":"Employee additional info template","description":"Lists employee additional info template by the contract type and the employment country\n **Token scopes**: `contracts:read`","tags":["subpackage_employeeInformation"],"parameters":[{"name":"type","in":"path","description":"The contract type. Must be 'eor' (Employer of Record) or 'gp' (Global Payroll).","required":true,"schema":{"$ref":"#/components/schemas/EmployeeInfoContractTypesTypeCountriesCountryGetParametersType"}},{"name":"country","in":"path","description":"ISO 3166-1 alpha-2 country code.","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/Employee Information_employeeAdditionalInfoTemplate-v2026-01-01_Response_200"}}}},"400":{"description":"Invalid country code or contract type.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmployeeAdditionalInfoTemplate-v2026-01-01RequestBadRequestError"}}}},"401":{"description":"Authentication failed. The access token is missing, expired, or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmployeeAdditionalInfoTemplate-v2026-01-01RequestUnauthorizedError"}}}},"403":{"description":"Access denied. The authenticated user does not have the required contracts:read scope or contracts.view permission.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmployeeAdditionalInfoTemplate-v2026-01-01RequestForbiddenError"}}}},"404":{"description":"No additional info template exists for the given country and contract type combination in the Employee Data Management system.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmployeeAdditionalInfoTemplate-v2026-01-01RequestNotFoundError"}}}},"429":{"description":"Rate limit exceeded. The client has sent too many requests in a given time window.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmployeeAdditionalInfoTemplate-v2026-01-01RequestTooManyRequestsError"}}}},"500":{"description":"Internal server error. Returned when the Employee Data Management service is unreachable or an unexpected error occurs.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmployeeAdditionalInfoTemplate-v2026-01-01RequestInternalServerError"}}}}}}},"/benefits/legal-entities/{id}/employees/{employee_id}":{"get":{"operationId":"get-employee-from-organization-integrated-with-external-benefits-vendor-v-2026-01-01","summary":"Get employee from organization integrated with external benefits vendor","description":"Returns profile and contract data for a single employee within a legal entity integrated with an external benefits vendor. When `active_contracts` is `true`, only active contracts are included in the response.\n\n**Related endpoints**\n- use `contract_id` from contracts in response with `GET /benefits/legal-entities/{legal_entity_id}/contracts/{contract_id}/plans/{plan_id}`\n- use `contract_id` from contracts in response with `DELETE /benefits/legal-entities/{id}/contracts/{contract_id}/plans/{plan_id}`\n **Token scopes**: `people:read`","tags":["subpackage_employees"],"parameters":[{"name":"id","in":"path","description":"Id from the legal entity to fetch data","required":true,"schema":{"type":"string"}},{"name":"employee_id","in":"path","description":"Employee id from the legal entity to fetch data","required":true,"schema":{"type":"string"}},{"name":"active_contracts","in":"query","description":"Fetch only active contracts for employees","required":false,"schema":{"type":"boolean","default":true}},{"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/Employees_getEmployeeFromOrganizationIntegratedWithExternalBenefitsVendor-v2026-01-01_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"}}}}}}},"/benefits/legal-entities/{legal_entity_id}/contracts/{contract_id}/plans/{plan_id}":{"post":{"operationId":"enroll-an-employee-in-a-401-k-plan-v-2026-01-01","summary":"Enroll an employee in a 401k plan","description":"Enroll an employee in a 401k plan\n **Token scopes**: `benefits:write`","tags":["subpackage_enrollments"],"parameters":[{"name":"legal_entity_id","in":"path","description":"Legal entity id which employee/contract belongs","required":true,"schema":{"type":"string"}},{"name":"contract_id","in":"path","description":"Contract id from the employee","required":true,"schema":{"type":"string"}},{"name":"plan_id","in":"path","description":"Plan id to enroll the employee into","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/Enrollments_enrollAnEmployeeInA401KPlan-v2026-01-01_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":{"type":{"$ref":"#/components/schemas/BenefitsLegalEntitiesLegalEntityIdContractsContractIdPlansPlanIdPostRequestBodyContentApplicationJsonSchemaType","description":"Type of the contribution for 401k."},"details":{"$ref":"#/components/schemas/BenefitsLegalEntitiesLegalEntityIdContractsContractIdPlansPlanIdPostRequestBodyContentApplicationJsonSchemaDetails","description":"Object containing additional information about the enrollment."},"contribution_type":{"$ref":"#/components/schemas/BenefitsLegalEntitiesLegalEntityIdContractsContractIdPlansPlanIdPostRequestBodyContentApplicationJsonSchemaContributionType","description":"Type of contribution."},"contribution_limit":{"type":"number","format":"double","description":"Maximum limit of contribution."},"contribution_value":{"type":"number","format":"double","description":"Value of the contribution."}},"required":["type","contribution_limit"]}}}}},"get":{"operationId":"get-enrollment-settings-from-an-employee-in-a-401-k-plan-v-2026-01-01","summary":"Get enrollment settings from an employee in a 401k plan","description":"Get enrollment settings from an employee in a 401k plan\n **Token scopes**: `benefits:read`","tags":["subpackage_enrollments"],"parameters":[{"name":"legal_entity_id","in":"path","description":"Legal entity id which employee/contract belongs","required":true,"schema":{"type":"string"}},{"name":"contract_id","in":"path","description":"Contract id from the employee","required":true,"schema":{"type":"string"}},{"name":"plan_id","in":"path","description":"Plan id to enroll the employee into","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/Enrollments_getEnrollmentSettingsFromAnEmployeeInA401KPlan-v2026-01-01_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"}}}}}}},"/eor/contracts/{contract_id}/amendments/{amendment_id}/accept":{"post":{"operationId":"accept-contract-amendment","summary":"Accept amendment","description":"Allows the client to accept a contract amendment, formally acknowledging and approving the modifications to the contract.\n **Token scopes**: `contracts:write`","tags":["subpackage_eorAmendments"],"parameters":[{"name":"contract_id","in":"path","description":"The unique identifier of EOR worker contract.","required":true,"schema":{"type":"string","format":"alphanumeric"}},{"name":"amendment_id","in":"path","description":"A unique identifier for the employee contract amendment.","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":"Amendment info","content":{"application/json":{"schema":{"$ref":"#/components/schemas/eor-amendments_acceptContractAmendment_Response_200"}}}},"400":{"description":"Bad Request. The request could not be understood or was missing required parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AcceptAContractAmendmentOnBehalfOfTheClientRequestBadRequestError"}}}},"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":"Resource not found (e.g., contract, profile, amendment, change request).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AcceptAContractAmendmentOnBehalfOfTheClientRequestNotFoundError"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AcceptAContractAmendmentOnBehalfOfTheClientRequestInternalServerError"}}}}},"requestBody":{"description":"This operation does not require a request body. Provide an empty JSON object if required by the client.","content":{"application/json":{"schema":{"type":"object","properties":{}}}}}}},"/eor/contracts/{contract_id}/amendments/{amendment_id}":{"delete":{"operationId":"delete-contract-amendment","summary":"Cancel amendment","description":"Cancel a pending employee contract amendment. This action voids the amendment request and prevents it from being reviewed or applied.\n **Token scopes**: `contracts:write`","tags":["subpackage_eorAmendments"],"parameters":[{"name":"contract_id","in":"path","description":"The unique identifier of EOR worker contract.","required":true,"schema":{"type":"string","format":"alphanumeric"}},{"name":"amendment_id","in":"path","description":"A unique identifier for the employee contract amendment.","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/eor-amendments_deleteContractAmendment_Response_200"}}}},"400":{"description":"Bad Request. The request could not be understood or was missing required parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancelAmendmentRequestBadRequestError"}}}},"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":"Resource not found (e.g., contract, profile, amendment, change request).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancelAmendmentRequestNotFoundError"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancelAmendmentRequestInternalServerError"}}}}}},"get":{"operationId":"get-contract-amendment-by-id","summary":"Get amendment by ID","description":"Retrieves the full details for a specific EOR contract amendment, including requested changes to salary, scope, and key dates.\n **Token scopes**: `contracts:read`","tags":["subpackage_eorAmendments"],"parameters":[{"name":"contract_id","in":"path","description":"The unique identifier of EOR worker contract.","required":true,"schema":{"type":"string","format":"alphanumeric"}},{"name":"amendment_id","in":"path","description":"A unique identifier for the employee contract amendment.","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":"Amendment info","content":{"application/json":{"schema":{"$ref":"#/components/schemas/eor-amendments_getContractAmendmentById_Response_200"}}}},"400":{"description":"Bad Request. The request could not be understood or was missing required parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ViewInformationAboutAmendmentRequestBadRequestError"}}}},"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":"Resource not found (e.g., contract, profile, amendment, change request).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ViewInformationAboutAmendmentRequestNotFoundError"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ViewInformationAboutAmendmentRequestInternalServerError"}}}}}},"patch":{"operationId":"update-contract-amendment","summary":"Update amendment","description":"Updates a specific contract amendment. This can only be performed on amendments in a DRAFT status. This action is irreversible and will overwrite any previous draft data.\n **Token scopes**: `contracts:write`","tags":["subpackage_eorAmendments"],"parameters":[{"name":"contract_id","in":"path","description":"The unique identifier of EOR worker contract.","required":true,"schema":{"type":"string","format":"alphanumeric"}},{"name":"amendment_id","in":"path","description":"A unique identifier for the employee contract amendment. This string is either supplied by the client or generated by the system and is used to uniquely identify the amendment during upsert operations.","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":"Amendment info","content":{"application/json":{"schema":{"$ref":"#/components/schemas/eor-amendments_updateContractAmendment_Response_200"}}}},"400":{"description":"Bad Request. The request could not be understood or was missing required parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateASpecificEorContractAmendmentRequestBadRequestError"}}}},"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":"Resource not found (e.g., contract, profile, amendment, change request).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateASpecificEorContractAmendmentRequestNotFoundError"}}}},"409":{"description":"Conflict error. Indicates that the requested operation conflicts with the current state of the resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateASpecificEorContractAmendmentRequestConflictError"}}}},"422":{"description":"Validation errors or disabled amendments.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateASpecificEorContractAmendmentRequestUnprocessableEntityError"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateASpecificEorContractAmendmentRequestInternalServerError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPatchRequestBodyContentApplicationJsonSchemaData"}}}}}}}},"/eor/contracts/{contract_id}/amendments/{amendment_id}/confirm":{"post":{"operationId":"confirm-contract-amendment","summary":"Confirm amendment","description":"Confirms an existing contract amendment and initiates the review process, sending it to both Deel and the employee for acknowledgment and approval.\n **Token scopes**: `contracts:write`","tags":["subpackage_eorAmendments"],"parameters":[{"name":"contract_id","in":"path","description":"The unique identifier of EOR worker contract.","required":true,"schema":{"type":"string","format":"alphanumeric"}},{"name":"amendment_id","in":"path","description":"A unique identifier for the employee contract amendment.","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":"Amendment info","content":{"application/json":{"schema":{"$ref":"#/components/schemas/eor-amendments_confirmContractAmendment_Response_200"}}}},"400":{"description":"Bad Request. The request could not be understood or was missing required parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfirmAnExistingContractAmendment-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":"Resource not found (e.g., contract, profile, amendment, change request).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfirmAnExistingContractAmendment-v2026-01-01RequestNotFoundError"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfirmAnExistingContractAmendment-v2026-01-01RequestInternalServerError"}}}}},"requestBody":{"description":"This operation does not require a request body. Provide an empty JSON object if required by the client.","content":{"application/json":{"schema":{"type":"object","properties":{}}}}}}},"/eor/contracts/{contract_id}/amendments/{amendment_id}/pdf":{"get":{"operationId":"get-contract-amendment-pdf","summary":"Contract amendment PDF","description":"Generates a secure PDF download link for the EOR contract amendment, valid for 15 minutes.\n **Token scopes**: `contracts:read`","tags":["subpackage_eorAmendments"],"parameters":[{"name":"contract_id","in":"path","description":"The unique identifier of EOR worker contract.","required":true,"schema":{"type":"string","format":"alphanumeric"}},{"name":"amendment_id","in":"path","description":"A unique identifier for the employee contract amendment.","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":"URL of exported PDF(valid for 15m)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/eor-amendments_getContractAmendmentPdf_Response_200"}}}},"400":{"description":"Bad Request. The request could not be understood or was missing required parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetEorContractAmendmentPdfDownloadLinkForClientAndEmployeeRequestBadRequestError"}}}},"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":"Resource not found (e.g., contract, profile, amendment, change request).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetEorContractAmendmentPdfDownloadLinkForClientAndEmployeeRequestNotFoundError"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetEorContractAmendmentPdfDownloadLinkForClientAndEmployeeRequestInternalServerError"}}}}}}},"/eor/contracts/{contract_id}/amendments":{"post":{"operationId":"create-contract-amendment","summary":"Create amendment","description":"This endpoint allows you to create a new amendment for a EOR contract. Amendments may include changes to salary, currency, effective date, or other contract terms, and all requests are validated against business and regulatory rules.\n **Token scopes**: `contracts:write`","tags":["subpackage_eorAmendments"],"parameters":[{"name":"contract_id","in":"path","description":"The unique identifier of the EOR worker contract","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":{"201":{"description":"Amendment info","content":{"application/json":{"schema":{"$ref":"#/components/schemas/eor-amendments_createContractAmendment_Response_201"}}}},"400":{"description":"Bad Request. The request could not be understood or was missing required parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAnEorContractAmendment-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":"Resource not found (e.g., contract, profile, amendment, change request).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAnEorContractAmendment-v2026-01-01RequestNotFoundError"}}}},"409":{"description":"Conflict error. Indicates that the requested operation conflicts with the current state of the resource.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAnEorContractAmendment-v2026-01-01RequestConflictError"}}}},"422":{"description":"Validation errors or disabled amendments.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAnEorContractAmendment-v2026-01-01RequestUnprocessableEntityError"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAnEorContractAmendment-v2026-01-01RequestInternalServerError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaData"}}}}}}},"get":{"operationId":"get-contract-amendments","summary":"Get amendments by contract","description":"This endpoint retrieves all EOR contact amendments. It provides details such as the amendment type, effective date, and current status, allowing clients to understand the history and state of changes applied to the contract.\n **Token scopes**: `contracts:read`","tags":["subpackage_eorAmendments"],"parameters":[{"name":"contract_id","in":"path","description":"The unique identifier of EOR worker contract.","required":true,"schema":{"type":"string","format":"alphanumeric"}},{"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":"Amendment info. Returns the amendment flow details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/eor-amendments_getContractAmendments_Response_200"}}}},"400":{"description":"Bad Request. The request could not be understood or was missing required parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListAllAmendmentsForAnEorContract-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":"Resource not found (e.g., contract, profile, amendment, change request).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListAllAmendmentsForAnEorContract-v2026-01-01RequestNotFoundError"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListAllAmendmentsForAnEorContract-v2026-01-01RequestInternalServerError"}}}}}}},"/eor/contracts/{contract_id}/amendments/validation/settings":{"get":{"operationId":"get-contract-amendments-validation-settings","summary":"Get amendment validation settings","description":"Get all amendment validations settings of available data points for an EOR contract amendment\n **Token scopes**: `contracts:read`","tags":["subpackage_eorAmendments"],"parameters":[{"name":"contract_id","in":"path","description":"The unique identifier of EOR worker contract.","required":true,"schema":{"type":"string","format":"alphanumeric"}},{"name":"employment_state","in":"query","description":"The employment state of the EOR worker contract","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":"Amendment settings response with additional_details included as optional.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/eor-amendments_getContractAmendmentsValidationSettings_Response_200"}}}},"400":{"description":"Bad Request. The request could not be understood or was missing required parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAmendmentValidationSettingsForAnEorContractRequestBadRequestError"}}}},"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":"Resource not found (e.g., contract, profile, amendment, change request).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAmendmentValidationSettingsForAnEorContractRequestNotFoundError"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAmendmentValidationSettingsForAnEorContractRequestInternalServerError"}}}}}}},"/eor/contracts/{contract_id}/amendments/{amendment_id}/effective-date-limitations":{"get":{"operationId":"get-contract-amendment-effective-date-limitations","summary":"Retrieve Effective Date Limitations","description":"Retrieves validation rules for the effective date in an amendment flow of an EOR contract, including date limits, defaults, and visibility settings.\n **Token scopes**: `contracts:read`","tags":["subpackage_eorAmendments"],"parameters":[{"name":"contract_id","in":"path","description":"The unique identifier of the EOR worker contract","required":true,"schema":{"type":"string"}},{"name":"amendment_id","in":"path","description":"A unique identifier for the employee contract amendment","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":"Returns the effective date limits for the amendment.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/eor-amendments_getContractAmendmentEffectiveDateLimitations_Response_200"}}}},"400":{"description":"Bad Request. The request could not be understood or was missing required parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveEffectiveDateLimitationsRequestBadRequestError"}}}},"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":"Resource not found (e.g., contract, profile, amendment, change request).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveEffectiveDateLimitationsRequestNotFoundError"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveEffectiveDateLimitationsRequestInternalServerError"}}}}}}},"/eor/contracts/{contract_id}/amendments/{amendment_id}/sign":{"post":{"operationId":"sign-eor-amendment","summary":"Sign a contract amendment (employee)","description":"Allows the employee to provide their signature for a specific contract amendment, confirming acknowledgment and acceptance of the changes.\n **Token scopes**: `contracts:write`","tags":["subpackage_eorAmendments"],"parameters":[{"name":"contract_id","in":"path","description":"The unique identifier of EOR worker contract.","required":true,"schema":{"type":"string","format":"alphanumeric"}},{"name":"amendment_id","in":"path","description":"A unique identifier for the employee contract amendment.","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":"Amendment info","content":{"application/json":{"schema":{"$ref":"#/components/schemas/eor-amendments_signEORAmendment_Response_200"}}}},"400":{"description":"Bad Request. The request could not be understood or was missing required parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignAContractAmendmentEmployeeRequestBadRequestError"}}}},"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":"Resource not found (e.g., contract, profile, amendment, change request).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignAContractAmendmentEmployeeRequestNotFoundError"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignAContractAmendmentEmployeeRequestInternalServerError"}}}}},"requestBody":{"description":"This operation does not require a request body. Provide an empty JSON object if required by the client.","content":{"application/json":{"schema":{"type":"object","properties":{}}}}}}},"/eor/contracts/{contract_id}/amendments/validate":{"post":{"operationId":"validate-eor-amendments","summary":"Validate amendment data points","description":"Validate amendment data points that require external validation\n **Token scopes**: `contracts:write`","tags":["subpackage_eorAmendments"],"parameters":[{"name":"contract_id","in":"path","description":"The unique identifier of the employee contract.","required":true,"schema":{"type":"string","format":"alphanumeric"}},{"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":"Validation result","content":{"application/json":{"schema":{"$ref":"#/components/schemas/eor-amendments_validateEORAmendments_Response_200"}}}},"400":{"description":"Bad Request. The request could not be understood or was missing required parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidateAmendmentDataPointsRequestBadRequestError"}}}},"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":"Resource not found (e.g., contract, profile, amendment, change request).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidateAmendmentDataPointsRequestNotFoundError"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidateAmendmentDataPointsRequestInternalServerError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","additionalProperties":{"description":"Any type"},"description":"Dynamic object containing amendment fields. Supports flexible keys such as scope, job_title, or others."}}}}}}}},"/eor/{contract_id}/benefits":{"get":{"operationId":"get-eor-benefits-by-contract-id","summary":"Retrieve Benefits for EOR Contract","description":"Fetch detailed information about benefits associated with a specific Employee of Record (EOR) contract. The benefits include plan details, provider information, and enrollment statuses.\n **Token scopes**: `contracts:read`","tags":["subpackage_eorBenefits"],"parameters":[{"name":"contract_id","in":"path","description":"Deel 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":"Successfully retrieved the list of EOR contract benefits.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/eor-benefits_getEORBenefitsByContractId_Response_200"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}}}},"/eor":{"post":{"operationId":"create-eor-contract","summary":"Create an EOR contract","description":"Creates an Employee of Record (EOR) contract quote. This endpoint allows to submit details for an EOR contract. Deel will process the information and return a quote for the requested contract.\n **Token scopes**: `contracts:write`","tags":["subpackage_eorContract"],"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":"Successfully created the EOR contract quote.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/eor-contract_createEORContract_Response_201"}}}},"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"}}}}},"requestBody":{"description":"The details of the Employee (EOR) contract to be created.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorPostRequestBodyContentApplicationJsonSchemaData"}},"required":["data"]}}}}}},"/eor/contracts/{contract_id}/details":{"get":{"operationId":"get-eor-contract-details","summary":"Retrieve EOR Contract Details","description":"Returns the basic information for an EOR contract, along with employment costs associated to it\n **Token scopes**: `contracts:read`","tags":["subpackage_eorContract"],"parameters":[{"name":"contract_id","in":"path","description":"The unique identifier for the Deel contract","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/eor-contract_getEORContractDetails_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":"Access denied","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveEorContractDetails-v2026-01-01RequestForbiddenError"}}}},"404":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}}}},"/eor/contract/{contract_id}":{"patch":{"operationId":"update-eor-contract","summary":"Update EOR Contract","description":"This endpoint is used to modify mutable fields of an EOR contract, such as salary, job title, or benefits. It supports partial updates—only include fields that should be updated. Required fields must still be present for validation.\n **Token scopes**: `contracts:write`","tags":["subpackage_eorContract"],"parameters":[{"name":"contract_id","in":"path","description":"The unique identifier of the employee contract.","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":"Contract updated successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/eor-contract_updateEORContract_Response_200"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateEorContractRequestBadRequestError"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateEorContractRequestForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateEorContractRequestNotFoundError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateEorContractRequestInternalServerError"}}}}},"requestBody":{"description":"Contract update request object","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaData"}},"required":["data"]}}}}}},"/eor/contracts/{contract_id}/documents":{"get":{"operationId":"get-eor-contract-documents","summary":"Fetch EOR contract documents","description":"Lists all documents for a given EOR contract\n **Token scopes**: `contracts:read`","tags":["subpackage_eorContractDocuments"],"parameters":[{"name":"contract_id","in":"path","description":"EOR 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":"The documents for the given EOR contract","content":{"application/json":{"schema":{"$ref":"#/components/schemas/eor-contract-documents_getEORContractDocuments_Response_200"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FetchEorContractDocumentsRequestBadRequestError"}}}},"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"}}}}}}},"/eor/contract/{oid}/cancel":{"post":{"operationId":"cancel-contract","summary":"Cancel EOR Contract","description":"Cancel EOR Contract\n **Token scopes**: `contracts:write`","tags":["subpackage_eorHiring"],"parameters":[{"name":"oid","in":"path","description":"Contract oid","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":"Contract cancelled successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/eor-hiring_cancelContract_Response_204"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancelEorContractRequestBadRequestError"}}}},"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":"Contract not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancelEorContractRequestNotFoundError"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}},"requestBody":{"description":"Cancel EOR Contract","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorContractOidCancelPostRequestBodyContentApplicationJsonSchemaData"}},"required":["data"]}}}}}},"/eor/contract/{oid}/delay-onboarding":{"patch":{"operationId":"delay-onboarding","summary":"Delay EOR employee onboarding","description":"Delay EOR employee onboarding\n **Token scopes**: `contracts:write`","tags":["subpackage_eorHiring"],"parameters":[{"name":"oid","in":"path","description":"Contract oid","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":"Employee onboarding delay status updated successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/eor-hiring_delayOnboarding_Response_200"}}}},"400":{"description":"Bad Request - Contract not found or invalid status","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DelayEorEmployeeOnboardingRequestBadRequestError"}}}},"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":"Indicates if the employee onboarding is delayed","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorContractOidDelayOnboardingPatchRequestBodyContentApplicationJsonSchemaData"}},"required":["data"]}}}}}},"/forms/eor/create-contract/{country_code}":{"get":{"operationId":"get-create-contract-form","summary":"Fetch EOR Contract form","description":"Returns a formulary for creating EOR Contracts\n **Token scopes**: `forms:read`","tags":["subpackage_eorHiring"],"parameters":[{"name":"country_code","in":"path","description":"Two-letter country code in ISO 3166-1 alpha-2 format","required":true,"schema":{"type":"string"}},{"name":"state","in":"query","description":"The selected state code of the contract. This is only required for countries that specify it.","required":false,"schema":{"type":"string"}},{"name":"start_date","in":"query","description":"The selected start date of the contract in ISO 8601 formatted date string.","required":false,"schema":{"type":"string"}},{"name":"work_hours_per_week","in":"query","description":"The selected number of work hours per week.","required":false,"schema":{"type":"integer"}},{"name":"contract_duration_in_days","in":"query","description":"The contract duration in days for definite contracts.","required":false,"schema":{"type":"integer"}},{"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 containing form configuration data.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/eor-hiring_getCreateContractForm_Response_200"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FetchEorContractFormRequestBadRequestError"}}}},"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"}}}}}}},"/eor/start-date":{"get":{"operationId":"get-start-date","summary":"Fetch Start Date for EOR Contracts","description":"Returns the earliest allowed start date for a new EOR contract quote based on employment parameters.\n **Token scopes**: `contracts:read`","tags":["subpackage_eorHiring"],"parameters":[{"name":"employment_country","in":"query","description":"Employment country in ISO 3166-1 alpha-2 format","required":true,"schema":{"type":"string"}},{"name":"employee_nationality","in":"query","description":"Employee nationality in ISO 3166-1 alpha-2 format","required":false,"schema":{"type":"string"}},{"name":"work_visa","in":"query","description":"Whether a work visa is required","required":false,"schema":{"type":"boolean"}},{"name":"team_id","in":"query","description":"Team ID","required":true,"schema":{"type":"string"}},{"name":"legal_entity_id","in":"query","description":"Legal entity ID","required":false,"schema":{"type":"string"}},{"name":"employment_state","in":"query","description":"State or province of employment","required":false,"schema":{"type":"string"}},{"name":"special_job_id","in":"query","description":"Special job ID (if applicable)","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":"Start date details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/eor-hiring_getStartDate_Response_200"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FetchStartDateForEorContractsRequestBadRequestError"}}}},"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"}}}}}}},"/eor/additional-costs/{country}":{"get":{"operationId":"get-additional-costs","summary":"Get EOR Additional Costs","description":"Retrieve all additional costs to eor quote flow by country\n **Token scopes**: `contracts:read`","tags":["subpackage_eorHiring"],"parameters":[{"name":"country","in":"path","description":"The two-letter ISO code of the country for which to retrieve the EOR additional costs.","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/eor-hiring_getAdditionalCosts_Response_200"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetEorAdditionalCostsRequestBadRequestError"}}}},"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"}}}}}}},"/eor/benefits":{"get":{"operationId":"get-benefits","summary":"Retrieve Benefits by Country","description":"Retrieves list of benefits available in a specific country based work visa requirement, work hours, employment type, team, and legal entity.\n **Token scopes**: `benefits:read`","tags":["subpackage_eorHiring"],"parameters":[{"name":"country_code","in":"query","description":"Country code.","required":true,"schema":{"type":"string"}},{"name":"work_visa","in":"query","description":"Indicates if work visa is required.","required":true,"schema":{"type":"boolean"}},{"name":"work_hours_per_week","in":"query","description":"Working hours per week","required":true,"schema":{"type":"number","format":"double"}},{"name":"employment_type","in":"query","description":"Type of employment","required":true,"schema":{"$ref":"#/components/schemas/EorBenefitsGetParametersEmploymentType"}},{"name":"team_id","in":"query","description":"The ID of the team the worker belongs to.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"legal_entity_id","in":"query","description":"The ID of the legal entity.","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/eor-hiring_getBenefits_Response_200"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveBenefitsByCountryRequestBadRequestError"}}}},"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"}}}}}}},"/eor/validations/{country_code}":{"get":{"operationId":"get-eor-hiring-guide-by-country","summary":"Retrieve detailed hiring guide for a country","description":"Retrieve comprehensive hiring guide data for a specific country. This data can be used in creation and validation of Employee of Record (EOR) contract quotes, providing details on salaries, holidays, insurance, and other employment specifics.\n **Token scopes**: `contracts:read`","tags":["subpackage_eorHiring"],"parameters":[{"name":"country_code","in":"path","description":"The two-letter ISO code of the country for which to retrieve the hiring guide.","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":"The hiring guide data was successfully retrieved.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/eor-hiring_getEORHiringGuideByCountry_Response_200"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}}}},"/eor/contracts/{contract_id}/documents/{type}/sign":{"post":{"operationId":"sign-contract-document","summary":"Sign EOR contract document","description":"Signs a document with the provided signature and title\n **Token scopes**: `contracts:write`","tags":["subpackage_eorHiring"],"parameters":[{"name":"contract_id","in":"path","description":"EOR contract ID","required":true,"schema":{"type":"string"}},{"name":"type","in":"path","description":"The type of document. Currently only FRAMEWORK_AGREEMENT is supported.","required":true,"schema":{"$ref":"#/components/schemas/EorContractsContractIdDocumentsTypeSignPostParametersType"}},{"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":"The document has been signed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/eor-hiring_signContractDocument_Response_200"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignEorContractDocumentRequestBadRequestError"}}}},"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/EorContractsContractIdDocumentsTypeSignPostRequestBodyContentApplicationJsonSchemaData"}}}}}}}},"/eor/contracts/{contract_id}/employee-information":{"patch":{"operationId":"update-contract-employee-information","summary":"Update Employee Information for EOR Contract","description":"Updates employee information related to an EOR Contract. This endpoint supports partial updates. Attempting to update any undocumented fields will result in a validation error. This endpoint will only work for contracts with status `new`, `under_review`, `waiting_for_client_sign`, `waiting_for_eor_sign`, `waiting_for_employee_contract`, `waiting_for_employee_sign`, `awaiting_deposit_payment`, or `rejected`.\n **Token scopes**: `contracts:write`","tags":["subpackage_eorHiring"],"parameters":[{"name":"contract_id","in":"path","description":"The unique identifier of the employee contract.","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":"Employee information updated successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/eor-hiring_updateContractEmployeeInformation_Response_200"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateEmployeeInformationForEorContractRequestBadRequestError"}}}},"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":"Contract not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateEmployeeInformationForEorContractRequestNotFoundError"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateEmployeeInformationForEorContractRequestInternalServerError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorContractsContractIdEmployeeInformationPatchRequestBodyContentApplicationJsonSchemaData"}}}}}}}},"/eor/job-scopes":{"get":{"operationId":"get-job-scopes","summary":"List of job scope templates for EOR contracts","description":"Returns a list of predefined job scope templates for an EOR contract, which can be filtered by team. The list includes both predefined and custom job scope templates belonging to the user's teams.\n **Token scopes**: `organizations:read`","tags":["subpackage_eorJobScopes"],"parameters":[{"name":"team","in":"query","description":"Team public id","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":"Successfull response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EorJobScopesGetResponsesContentApplicationJsonSchemaItems"}}}}},"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 - Organization not linked to profile or no teams found for the organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListOfJobScopeTemplatesForEorContractsRequestNotFoundError"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}}}},"/eor/job-scopes/validate":{"post":{"operationId":"validate-job-scope","summary":"Request job scope validation","description":"This endpoint allows client to validate job scope description.\n **Token scopes**: `contracts:write`","tags":["subpackage_eorJobScopes"],"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/eor-job-scopes_validateJobScope_Response_200"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestJobScopeValidation-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":"Run job scope validation","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorJobScopesValidatePostRequestBodyContentApplicationJsonSchemaData","description":"details of job scope"}},"required":["data"]}}}}}},"/eor/contracts/{contract_id}/offboarding/review-client-sign-offs":{"post":{"operationId":"create-eor-offboarding-client-sign-off","summary":"Create client sign off","description":"Use this endpoint to review, approve, or request changes to EOR employee offboarding documents for a specific contract during the client sign‑off step.\n **Token scopes**: `contracts:write`","tags":["subpackage_eorOffboarding"],"parameters":[{"name":"contract_id","in":"path","description":"The unique identifier of the employee contract.","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":"Approval submitted successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/eor-offboarding_createEOROffboardingClientSignOff_Response_200"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReviewApproveOrRequestChangesToEorOffboardingDocumentsRequestBadRequestError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReviewApproveOrRequestChangesToEorOffboardingDocumentsRequestUnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReviewApproveOrRequestChangesToEorOffboardingDocumentsRequestForbiddenError"}}}},"404":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReviewApproveOrRequestChangesToEorOffboardingDocumentsRequestInternalServerError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingReviewClientSignOffsPostRequestBodyContentApplicationJsonSchemaData"}},"required":["data"]}}}}}},"/eor/contracts/{contract_id}/offboarding/required-information":{"get":{"operationId":"get-eor-contract-offboarding-required-information","summary":"Get additional information required to request employee termination","description":"This endpoint provides additional country-specific requirements for employee offboarding. It specifies any mandatory or optional questions that the client must answer and identifies required supporting documents that must be uploaded during the offboarding process. This ensures compliance with local regulations and streamlines the offboarding workflow.\n **Token scopes**: `contracts:read`","tags":["subpackage_eorOffboarding"],"parameters":[{"name":"contract_id","in":"path","description":"The unique identifier of the employee contract.","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":"Ok response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/eor-offboarding_getEORContractOffboardingRequiredInformation_Response_200"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAdditionalInformationRequiredToRequestEmployeeTerminationRequestBadRequestError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAdditionalInformationRequiredToRequestEmployeeTerminationRequestUnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAdditionalInformationRequiredToRequestEmployeeTerminationRequestForbiddenError"}}}},"404":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAdditionalInformationRequiredToRequestEmployeeTerminationRequestInternalServerError"}}}}}}},"/eor/contracts/{contract_id}/offboarding/time-offs":{"get":{"operationId":"get-contract-offboarding-time-offs","summary":"Retrieve Employee Time Off Data for Offboarding","description":"This endpoint provides detailed time off information for an employee, including accrued, used, and scheduled days across all tracking periods. It also includes policy details, tracking configurations, and additional metadata to support the offboarding request process. The data is used to display comprehensive time off information on the offboarding request page.\n **Token scopes**: `contracts:read`","tags":["subpackage_eorOffboarding"],"parameters":[{"name":"contract_id","in":"path","description":"The unique identifier of the employee contract.","required":true,"schema":{"type":"string"}},{"name":"end_date","in":"query","description":"Desired end date for offboarding","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":"Successfully retrieved used time off information","content":{"application/json":{"schema":{"$ref":"#/components/schemas/eor-offboarding_getContractOffboardingTimeOffs_Response_200"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveEmployeeTimeOffDataForOffboardingRequestBadRequestError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveEmployeeTimeOffDataForOffboardingRequestUnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveEmployeeTimeOffDataForOffboardingRequestForbiddenError"}}}},"404":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveEmployeeTimeOffDataForOffboardingRequestInternalServerError"}}}}}}},"/eor/contracts/{contract_id}/offboarding/attachments/{attachment_id}":{"get":{"operationId":"get-contract-offboarding-attachment-by-id","summary":"Retrieve offboarding attachment","description":"This endpoint allows client and employee download the content of a specific attachment associated with a termination for the given contract.\n **Token scopes**: `contracts:read`","tags":["subpackage_eorOffboarding"],"parameters":[{"name":"contract_id","in":"path","description":"The unique identifier of the employee contract.","required":true,"schema":{"type":"string"}},{"name":"attachment_id","in":"path","description":"The unique identifier of the attachment to download.","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":"File download successful","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveOffboardingAttachmentRequestBadRequestError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveOffboardingAttachmentRequestUnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveOffboardingAttachmentRequestForbiddenError"}}}},"404":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveOffboardingAttachmentRequestInternalServerError"}}}}}}},"/eor/contracts/{contract_id}/offboarding":{"get":{"operationId":"get-contract-offboarding","summary":"Retrieve Offboarding Request","description":"Retrieve the offboarding request associated with a specific EOR contract (contract_id). Use it to review termination details, document review status, offboarding request data, and notifications required for the employee.\n **Token scopes**: `contracts:read`, `worker:read`","tags":["subpackage_eorOffboarding"],"parameters":[{"name":"contract_id","in":"path","description":"The unique identifier of the employee contract.","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 retrieval of the offboarding request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/eor-offboarding_getContractOffboarding_Response_200"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveOffboardingRequestRequestBadRequestError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveOffboardingRequestRequestUnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveOffboardingRequestRequestForbiddenError"}}}},"404":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveOffboardingRequestRequestInternalServerError"}}}}}}},"/eor/contracts/{contract_id}/offboarding/restricted-dates":{"get":{"operationId":"get-contract-offboarding-restricted-dates","summary":"Retrieve restricted offboarding dates","description":"Retrieves a list of dates, including weekends and public holidays, that are restricted for employee offboarding based on country-specific rules. Use this endpoint to plan employee offboarding by validating end-date selection. Call it when initiating an EOR offboarding flow to determine which dates are unavailable and what is the first day available.\n **Token scopes**: `contracts:read`","tags":["subpackage_eorOffboarding"],"parameters":[{"name":"contract_id","in":"path","description":"The unique identifier of the employee contract.","required":true,"schema":{"type":"string"}},{"name":"termination_type","in":"query","description":"Type of offboarding.","required":false,"schema":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingRestrictedDatesGetParametersTerminationType"}},{"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 retrieval of restricted dates.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/eor-offboarding_getContractOffboardingRestrictedDates_Response_200"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveRestrictedOffboardingDatesRequestBadRequestError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveRestrictedOffboardingDatesRequestUnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveRestrictedOffboardingDatesRequestForbiddenError"}}}},"404":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveRestrictedOffboardingDatesRequestInternalServerError"}}}}}}},"/eor/contracts/{contract_id}/offboarding/resignations/review-pto":{"post":{"operationId":"review-eor-offboarding-pto","summary":"Submit employee resignation PTO review","description":"Allows a client to review and submit the Paid Time Off (PTO) details for an employee resignation request. This endpoint updates the resignation with the provided PTO information, triggers related notifications, and finalizes the PTO review process. Only available when the resignation status is AWAITING_PTO.\n **Token scopes**: `contracts:write`","tags":["subpackage_eorOffboarding"],"parameters":[{"name":"contract_id","in":"path","description":"The unique identifier of the employee contract.","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":{"201":{"description":"PTO review submitted successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/eor-offboarding_reviewEOROffboardingPTO_Response_201"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitEmployeeResignationPtoReviewRequestBadRequestError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitEmployeeResignationPtoReviewRequestUnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitEmployeeResignationPtoReviewRequestForbiddenError"}}}},"404":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitEmployeeResignationPtoReviewRequestInternalServerError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingResignationsReviewPtoPostRequestBodyContentApplicationJsonSchemaData"}}}}}}}},"/eor/contracts/{contract_id}/offboarding/review-employee-sign-offs":{"post":{"operationId":"review-eor-offboarding-employee-sign-offs","summary":"Submit employee sign-off review for offboarding documents","description":"Use this endpoint to submit an employee's review decision for the EOR offboarding document set for contract. Employees can approve the documents or request changes by providing feedback.\n **Token scopes**: `worker:write`","tags":["subpackage_eorOffboarding"],"parameters":[{"name":"contract_id","in":"path","description":"The unique identifier of the employee contract.","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":"Approval submitted successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/eor-offboarding_reviewEOROffboardingEmployeeSignOffs_Response_200"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitEmployeeSignOffReviewForOffboardingDocumentsRequestBadRequestError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitEmployeeSignOffReviewForOffboardingDocumentsRequestUnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitEmployeeSignOffReviewForOffboardingDocumentsRequestForbiddenError"}}}},"404":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitEmployeeSignOffReviewForOffboardingDocumentsRequestInternalServerError"}}}}},"requestBody":{"description":"Ok response","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingReviewEmployeeSignOffsPostRequestBodyContentApplicationJsonSchemaData"}}}}}}}},"/eor/workers/{worker_id}/payslips":{"get":{"operationId":"get-worker-payslips","summary":"Retrieve employee payslip records","description":"Retrieve a list of payslip records for a specific employee, detailing payment periods, status, and associated identifiers.\n **Token scopes**: `payslips:read`","tags":["subpackage_eorPayslips"],"parameters":[{"name":"worker_id","in":"path","description":"The ID of the worker whose payslips are being retrieved.","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":"Payslip records successfully retrieved.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/eor-payslips_getWorkerPayslips_Response_200"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}}}},"/eor/contracts/{contract_id}/project-assignment/accept":{"post":{"operationId":"accept-project-assignment","summary":"Accept EOR project assignment as client","description":"Utilize this endpoint to accept a project assignment for an EOR contract once the client has reviewed and approved the terms.\n **Token scopes**: `contracts:write`","tags":["subpackage_eorProjectAssignment"],"parameters":[{"name":"contract_id","in":"path","description":"The unique identifier of the employee contract.","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":"The project assignment was accepted successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/eor-project-assignment_acceptProjectAssignment_Response_204"}}}},"400":{"description":"Bad Request. The request could not be understood or was missing required parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AcceptEorProjectAssignmentAsClientRequestBadRequestError"}}}},"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"}}}},"409":{"description":"The requested version of the document mismatch the current version.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AcceptEorProjectAssignmentAsClientRequestConflictError"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AcceptEorProjectAssignmentAsClientRequestInternalServerError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorContractsContractIdProjectAssignmentAcceptPostRequestBodyContentApplicationJsonSchemaData"}}}}}}}},"/eor/contracts/{contract_id}/project-assignment":{"get":{"operationId":"get-project-assignment","summary":"Fetch EOR project assignment PDF","description":"Utilize this endpoint to retrieve the PDF of the project assignment for an EOR contract that a client is required to approve.\n **Token scopes**: `contracts:read`","tags":["subpackage_eorProjectAssignment"],"parameters":[{"name":"contract_id","in":"path","description":"The unique identifier of the employee contract.","required":true,"schema":{"type":"string"}},{"name":"version","in":"query","description":"This field is to ensure that the latest version of the project assignment PDF matches the version received from the webhook. If it is not sent, the version validation is not performed and the endpoint returns the PDF. If it is sent, it is checked whether the current version is equal to the version sent; if not, a 409 error occurs, otherwise, the PDF is returned.","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/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Bad Request. The request could not be understood or was missing required parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FetchEorProjectAssignmentPdfRequestBadRequestError"}}}},"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"}}}},"409":{"description":"The requested version of the document mismatch the current version.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FetchEorProjectAssignmentPdfRequestConflictError"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FetchEorProjectAssignmentPdfRequestInternalServerError"}}}}}}},"/eor/contracts/{contract_id}/project-assignment/checkin":{"get":{"operationId":"get-project-assignment-checkin","summary":"Fetch Project Assignment Checkin Questionnaire Data","description":"Use this endpoint to fetch the project assignment checkin data with all necessary information to render in your side the questionnaire\n **Token scopes**: `contracts:read`","tags":["subpackage_eorProjectAssignment"],"parameters":[{"name":"contract_id","in":"path","description":"The unique identifier of the contract.","required":true,"schema":{"type":"string"}},{"name":"version","in":"query","description":"This field is to ensure that the latest version of the project assignment checkin matches the version received from the webhook. If it is not sent, the version validation is not performed. If it is sent, it is checked whether the current version is equal to the version sent; if not, a 409 error occurs, otherwise, the data is returned.","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 containing form configuration data.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/eor-project-assignment_getProjectAssignmentCheckin_Response_200"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FetchProjectAssignmentCheckinQuestionnaireDataRequestBadRequestError"}}}},"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"}}}},"409":{"description":"The requested version of the document mismatch the current version.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FetchProjectAssignmentCheckinQuestionnaireDataRequestConflictError"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FetchProjectAssignmentCheckinQuestionnaireDataRequestInternalServerError"}}}}}},"post":{"operationId":"checkin-project-assignment","summary":"Submit Project Assignment Checkin Questionnaire Data","description":"Use this endpoint to submit the checkin questionnaire. It is necessary to send all required questionnaire answers.\n **Token scopes**: `contracts:read`, `contracts:write`","tags":["subpackage_eorProjectAssignment"],"parameters":[{"name":"contract_id","in":"path","description":"The unique identifier of the contract.","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":"No content. The request was successful, but there is no response body.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/eor-project-assignment_checkinProjectAssignment_Response_204"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitProjectAssignmentCheckinQuestionnaireDataRequestBadRequestError"}}}},"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"}}}},"409":{"description":"The requested version of the document mismatch the current version.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitProjectAssignmentCheckinQuestionnaireDataRequestConflictError"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitProjectAssignmentCheckinQuestionnaireDataRequestInternalServerError"}}}}},"requestBody":{"description":"Payload for submitting employee or client form answers.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorContractsContractIdProjectAssignmentCheckinPostRequestBodyContentApplicationJsonSchemaData","description":"Form submission payload containing respondent type, question answers, and optional version."}}}}}}}},"/eor/{oid}/terminations/{terminationId}":{"get":{"operationId":"get-termination","summary":"Get termination","description":"This API allows clients and employees with viewer permissions to retrieve termination data. It ensures that only authorized users can access sensitive information related to terminations.\n **Token scopes**: `contracts:read`","tags":["subpackage_eorTerminations"],"parameters":[{"name":"oid","in":"path","description":"Public contract oid","required":true,"schema":{"type":"string"}},{"name":"terminationId","in":"path","description":"Termination 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":"Ok response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/eor-terminations_getTermination_Response_200"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"401":{"description":"Unauthorized response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EorOidTerminationsTerminationIdGetResponsesContentApplicationJsonSchemaItems"}}}}},"403":{"description":"Forbidden response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EorOidTerminationsTerminationIdGetResponsesContentApplicationJsonSchemaItems"}}}}},"404":{"description":"Not Found response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EorOidTerminationsTerminationIdGetResponsesContentApplicationJsonSchemaItems"}}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}}}},"/eor/contracts/{contract_id}/offboarding/termination":{"post":{"operationId":"create-offboarding-termination","summary":"Initiate EOR contract termination request","description":"Enables clients to initiate a request for the termination of an Employee of Record (EOR) contract for members of their team.\n **Token scopes**: `contracts:write`","tags":["subpackage_eorTerminations"],"parameters":[{"name":"contract_id","in":"path","description":"The unique identifier of the employee contract.","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":{"201":{"description":"Ok response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/eor-terminations_createOffboardingTermination_Response_201"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InitiateEorContractTerminationRequestRequestBadRequestError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InitiateEorContractTerminationRequestRequestUnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InitiateEorContractTerminationRequestRequestForbiddenError"}}}},"404":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InitiateEorContractTerminationRequestRequestInternalServerError"}}}}},"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingTerminationPostRequestBodyContentMultipartFormDataSchemaData"}},"required":["data"]}}}}}},"/eor/{oid}/terminations/resignation":{"post":{"operationId":"create-resignation","summary":"Request EOR Contract Resignation","description":"Enable clients with group admin and people manager permissions to initiate a resignation request for an Employee of Record (EOR) contract within their team.\n **Token scopes**: `contracts:read`, `contracts:write`","tags":["subpackage_eorTerminations"],"parameters":[{"name":"oid","in":"path","description":"Public contract oid","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":"Ok response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/eor-terminations_createResignation_Response_200"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"401":{"description":"Unauthorized response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EorOidTerminationsResignationPostResponsesContentApplicationJsonSchemaItems"}}}}},"403":{"description":"Forbidden response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EorOidTerminationsResignationPostResponsesContentApplicationJsonSchemaItems"}}}}},"404":{"description":"Not Found response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EorOidTerminationsResignationPostResponsesContentApplicationJsonSchemaItems"}}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaData"}},"required":["data"]}}}}}},"/eor/{oid}/terminations/regular":{"post":{"operationId":"create-regular-termination","summary":"Termination Request","description":"This API enables clients with group admin and people manager permissions to initiate a request for the termination of an Employee of Record (EOR) contract for members of their team.\n **Token scopes**: `contracts:read`, `contracts:write`","tags":["subpackage_eorTerminations"],"parameters":[{"name":"oid","in":"path","description":"Public 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":"Ok response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/eor-terminations_createRegularTermination_Response_200"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"401":{"description":"Unauthorized response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EorOidTerminationsRegularPostResponsesContentApplicationJsonSchemaItems"}}}}},"403":{"description":"Forbidden response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EorOidTerminationsRegularPostResponsesContentApplicationJsonSchemaItems"}}}}},"404":{"description":"Not Found response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EorOidTerminationsRegularPostResponsesContentApplicationJsonSchemaItems"}}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaData"}},"required":["data"]}}}}}},"/eor/worker":{"post":{"operationId":"create-worker","summary":"Create EOR Worker","description":"Create EOR Worker\n **Token scopes**: `people:write`","tags":["subpackage_eorWorkerAccounts"],"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/eor-worker-accounts_createWorker_Response_201"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateEorWorker-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":{"$ref":"#/components/schemas/EorWorkerPostRequestBodyContentApplicationJsonSchemaData"}}}}}}}},"/eor/workers/contracts/{contract_id}/employee-agreement/download":{"get":{"operationId":"download-worker-employee-agreement","summary":"Download employee agreement PDF","description":"Get link to download the employee agreement PDF.\n **Token scopes**: `worker:read`","tags":["subpackage_eorWorkerAgreements"],"parameters":[{"name":"contract_id","in":"path","description":"The unique identifier of the employee contract.","required":true,"schema":{"type":"string"}},{"name":"version","in":"query","description":"Optional version of the Employment Agreement to be signed. If informed and in the case of a mismatch, the API will return an error.","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.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/eor-worker-agreements_downloadWorkerEmployeeAgreement_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"}}}},"409":{"description":"Employment Agreement version mismatch.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DownloadEmployeeAgreementPdfRequestConflictError"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}}}},"/eor/workers/contracts/{contract_id}/offer-letter":{"get":{"operationId":"download-worker-offer-letter","summary":"Preview job offer letter","description":"Retrieve an EOR job offer letter in HTML. This endpoint does not support IC and Global Payroll contract types.\n **Token scopes**: `worker:read`","tags":["subpackage_eorWorkerAgreements"],"parameters":[{"name":"contract_id","in":"path","description":"Deel 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 operation.","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"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"}}}}}}},"/eor/workers/contracts/{contract_id}/signatures":{"post":{"operationId":"sign-eor-contract-as-worker","summary":"Sign a contract ","description":"Sign a contract as a employee.\n **Token scopes**: `worker:write`","tags":["subpackage_eorWorkerAgreements"],"parameters":[{"name":"contract_id","in":"path","description":"The unique identifier of the employee contract.","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":{"201":{"description":"Successful operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/eor-worker-agreements_signEORContractAsWorker_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"}}}},"409":{"description":"Employment Agreement version mismatch.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignAContractRequestConflictError"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorWorkersContractsContractIdSignaturesPostRequestBodyContentApplicationJsonSchemaData"}}}}}}}},"/eor/workers/banks-guide/country/{country}/currency/{currency}":{"get":{"operationId":"get-eor-worker-bank-guide-by-country-and-currency","summary":"Retrieve bank account guide","description":"Retrieve bank account form guide for an EOR employee. This data can be used to add a new bank account for an employee.\n **Token scopes**: `worker:read`","tags":["subpackage_eorWorkerBanks"],"parameters":[{"name":"country","in":"path","description":"Country","required":true,"schema":{"type":"string"}},{"name":"currency","in":"path","description":"Currency","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/eor-worker-banks_getEORWorkerBankGuideByCountryAndCurrency_Response_200"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveBankAccountGuide-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"}}}}}}},"/eor/workers/banks/guide":{"get":{"operationId":"get-eor-worker-bank-guide","summary":"Retrieve bank account guide","description":"Retrieve bank account form guide for an EOR employee. This data can be used to add a new bank account for an employee.\n **Token scopes**: `worker:read`","tags":["subpackage_eorWorkerBanks"],"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/eor-worker-banks_getEORWorkerBankGuide_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"}}}}}}},"/eor/worker/benefits":{"get":{"operationId":"get-eor-worker-benefits","summary":"Retrieve Benefits for Employee","description":"Retrieves list of benefits for employee. This endpoint requires the employee’s auth token, as the employee ID is inferred from the token.\n **Token scopes**: `benefits:read`","tags":["subpackage_eorWorkerBenefits"],"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/eor-worker-benefits_getEORWorkerBenefits_Response_200"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveBenefitsForEmployeeRequestBadRequestError"}}}},"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"}}}}}}},"/eor/workers/compliance-documents/{document_id}/acknowledgement":{"post":{"operationId":"create-compliance-document-acknowledgement","summary":"Acknowledge a compliance document","description":"API endpoint to submit consent for compliance documents that require acknowledgement.\n **Token scopes**: `worker:write`","tags":["subpackage_eorWorkerCompliance"],"parameters":[{"name":"document_id","in":"path","description":"The unique identifier of the compliance document.","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":"Document was acknowledged successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/eor-worker-compliance_createComplianceDocumentAcknowledgement_Response_204"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AcknowledgeAComplianceDocumentRequestBadRequestError"}}}},"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/AcknowledgeAComplianceDocumentRequestInternalServerError"}}}}}}},"/eor/workers/compliance-documents/{document_id}/templates/download":{"get":{"operationId":"download-compliance-document-template","summary":"Download employee compliance document template","description":"Get the download link for an employee compliance document template, if it exists.\n **Token scopes**: `worker:read`","tags":["subpackage_eorWorkerCompliance"],"parameters":[{"name":"document_id","in":"path","description":"Unique identifier for a compliance document in Deel.","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/eor-worker-compliance_downloadComplianceDocumentTemplate_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"}}}}}}},"/eor/workers/compliance-documents/{document_id}/download":{"get":{"operationId":"download-compliance-document","summary":"Download submitted compliance document","description":"Get the download link for an employee's submitted compliance document.\n **Token scopes**: `worker:read`","tags":["subpackage_eorWorkerCompliance"],"parameters":[{"name":"document_id","in":"path","description":"Unique identifier for a compliance document in Deel.","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/eor-worker-compliance_downloadComplianceDocument_Response_200"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DownloadSubmittedComplianceDocumentRequestBadRequestError"}}}},"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"}}}}}}},"/eor/workers/compliance-documents":{"get":{"operationId":"get-eor-worker-compliance-documents","summary":"List of employee compliance documents","description":"Get a list of employee compliance documents.\n **Token scopes**: `worker:read`","tags":["subpackage_eorWorkerCompliance"],"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/eor-worker-compliance_getEORWorkerComplianceDocuments_Response_200"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"401":{"description":"Authentication failed. The access token is missing, expired, or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListOfEmployeeComplianceDocuments-v2026-01-01RequestUnauthorizedError"}}}},"403":{"description":"Access denied. The authenticated user does not have the required worker:read scope or is not an employee profile.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListOfEmployeeComplianceDocuments-v2026-01-01RequestForbiddenError"}}}},"404":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListOfEmployeeComplianceDocuments-v2026-01-01RequestInternalServerError"}}}}}}},"/eor/workers/compliance-documents/{document_id}":{"post":{"operationId":"upload-eor-worker-compliance-document","summary":"Upload employee compliance document","description":"Upload compliance document for an EOR employee.\n **Token scopes**: `worker:write`","tags":["subpackage_eorWorkerCompliance"],"parameters":[{"name":"document_id","in":"path","description":"Unique identifier for a compliance document in Deel.","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/eor-worker-compliance_uploadEORWorkerComplianceDocument_Response_200"}}}},"400":{"description":"Bad request. The file is missing or the document_id format is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UploadEmployeeComplianceDocument-v2026-01-01RequestBadRequestError"}}}},"401":{"description":"Authentication failed. Bearer token is missing, expired, or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UploadEmployeeComplianceDocument-v2026-01-01RequestUnauthorizedError"}}}},"403":{"description":"Forbidden. The worker does not have permission to upload to this compliance document, the document cannot be submitted in its current state, or the requirement is obsolete.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UploadEmployeeComplianceDocument-v2026-01-01RequestForbiddenError"}}}},"404":{"description":"The compliance document specified by document_id was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UploadEmployeeComplianceDocument-v2026-01-01RequestNotFoundError"}}}},"500":{"description":"Internal server error. The file upload failed or an unexpected error occurred.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UploadEmployeeComplianceDocument-v2026-01-01RequestInternalServerError"}}}}},"requestBody":{"description":"The employee compliance document data to upload","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"string","format":"binary","description":"The employee compliance document to upload. Accepted formats: PNG, JPG, JPEG, HEIC, PDF."}}}}}}}},"/eor/workers/contracts/{contract_id}/hr-documents":{"get":{"operationId":"get-eor-worker-hr-documents","summary":"List HR verification letters and documents","description":"List all HR verification letters and documents available.\n **Token scopes**: `worker:read`","tags":["subpackage_eorWorkerDocuments"],"parameters":[{"name":"contract_id","in":"path","description":"The unique identifier of the employee contract.","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/eor-worker-documents_getEORWorkerHRDocuments_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"}}}}}}},"/eor/workers/contracts/{contract_id}/additional-information":{"post":{"operationId":"create-gp-worker-additional-information","summary":"Add additional information","description":"Add additional information for an EOR employee.\n **Token scopes**: `worker:write`","tags":["subpackage_eorWorkerInformation"],"parameters":[{"name":"contract_id","in":"path","description":"Deel 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 operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/eor-worker-information_createGPWorkerAdditionalInformation_Response_200"}}}},"400":{"description":"Bad request. Contract not found, contract is not EOR, required base fields are missing, or country-specific additional field validation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddAdditionalInformation-v2026-01-01RequestBadRequestError"}}}},"401":{"description":"Authentication failed. Bearer token is missing, expired, or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddAdditionalInformation-v2026-01-01RequestUnauthorizedError"}}}},"403":{"description":"Forbidden. The token lacks worker:write scope or the worker cannot update this contract.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddAdditionalInformation-v2026-01-01RequestForbiddenError"}}}},"404":{"description":"Not found. No additional information template exists for the employment country/state.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddAdditionalInformation-v2026-01-01RequestNotFoundError"}}}},"429":{"description":"Rate limit exceeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddAdditionalInformation-v2026-01-01RequestTooManyRequestsError"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddAdditionalInformation-v2026-01-01RequestInternalServerError"}}}}},"requestBody":{"description":"Add additional information for an EOR employee.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorWorkersContractsContractIdAdditionalInformationPostRequestBodyContentApplicationJsonSchemaData","description":"Additional fields are country/state-specific and validated against the worker additional fields form for the employment country."}},"required":["data"]}}}}},"patch":{"operationId":"update-eor-worker-additional-information","summary":"Update additional information","description":"Updates additional information for an EOR employee agreement. Only works if the employee’s contract status is new, under_review, or waiting_for_employee_contract. Using other statuses can cause errors.\n **Token scopes**: `worker:write`","tags":["subpackage_eorWorkerInformation"],"parameters":[{"name":"contract_id","in":"path","description":"Deel 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 operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/eor-worker-information_updateEORWorkerAdditionalInformation_Response_200"}}}},"400":{"description":"Bad request. Contract not found, contract is not EOR, or additional information validation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAdditionalInformation-v2026-01-01RequestBadRequestError"}}}},"401":{"description":"Authentication failed. Bearer token is missing, expired, or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAdditionalInformation-v2026-01-01RequestUnauthorizedError"}}}},"403":{"description":"Forbidden. The token lacks worker:write scope or the worker cannot update this contract.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAdditionalInformation-v2026-01-01RequestForbiddenError"}}}},"404":{"description":"Not found. No additional info template exists for the employment country/state.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAdditionalInformation-v2026-01-01RequestNotFoundError"}}}},"429":{"description":"Rate limit exceeded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAdditionalInformation-v2026-01-01RequestTooManyRequestsError"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAdditionalInformation-v2026-01-01RequestInternalServerError"}}}}},"requestBody":{"description":"Patch additional information for an EOR employee contract.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorWorkersContractsContractIdAdditionalInformationPatchRequestBodyContentApplicationJsonSchemaData","description":"You can submit any subset of fields. Keys not listed above are treated as country/state-specific additional information fields. Those keys must match the fields returned by GET /forms/eor/worker-additional-fields/{country_code} (public keys)."}},"required":["data"]}}}}}},"/eor/workers/banks":{"post":{"operationId":"create-eor-worker-bank-account","summary":"Add bank account","description":"Add bank account for an EOR employee.\n **Token scopes**: `worker:write`","tags":["subpackage_eorWorkerInformation"],"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/eor-worker-information_createEORWorkerBankAccount_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":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersBanksPostRequestBodyContentApplicationJsonSchemaDataItems"},"description":"Array of key value properties of bank account"}},"required":["data"]}}}}}},"/eor/workers/tax-documents":{"get":{"operationId":"get-eor-worker-tax-documents","summary":"List of tax documents for an employee","description":"Get list of tax documents for an employee.\n **Token scopes**: `worker:read`","tags":["subpackage_eorWorkerInformation"],"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":"Tax documents successfully retrieved.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/eor-worker-information_getEORWorkerTaxDocuments_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"}}}}}}},"/eor/mailboxes/change-password":{"post":{"operationId":"change-password","summary":"Change EOR Mailbox Password","description":"Use this endpoint to change an EOR mailbox password for a worker\n **Token scopes**: `worker:write`","tags":["subpackage_eorWorkerMailboxes"],"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/eor-worker-mailboxes_changePassword_Response_204"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChangeEorMailboxPasswordRequestBadRequestError"}}}},"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/ChangeEorMailboxPasswordRequestInternalServerError"}}}}},"requestBody":{"description":"The new password to be set","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorMailboxesChangePasswordPostRequestBodyContentApplicationJsonSchemaData"}},"required":["data"]}}}}}},"/eor/workers/contracts/{contract_id}/offboarding/resignation-letter":{"get":{"operationId":"download-employee-resignation-letter","summary":"Preview Resignation Letter","description":"This endpoint allows workers to preview a resignation letter for an EOR Contract.\n **Token scopes**: `worker:read`","tags":["subpackage_eorWorkerOffboarding"],"parameters":[{"name":"contract_id","in":"path","description":"The unique identifier of the employee contract.","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":"File download successful","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreviewResignationLetterRequestBadRequestError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreviewResignationLetterRequestUnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreviewResignationLetterRequestForbiddenError"}}}},"404":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PreviewResignationLetterRequestInternalServerError"}}}}}}},"/eor/contracts/{contract_id}/offboarding/resignation":{"post":{"operationId":"create-employee-resignation","summary":"Request contract resignation","description":"Enable clients to initiate a resignation request for an Employee of Record (EOR) contract within their team\n **Token scopes**: `contracts:write`","tags":["subpackage_eorWorkerOffboarding"],"parameters":[{"name":"contract_id","in":"path","description":"The unique identifier of the employee contract.","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":{"201":{"description":"Resignation request submitted successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/eor-worker-offboarding_createEmployeeResignation_Response_201"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestContractResignationRequestBadRequestError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestContractResignationRequestUnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestContractResignationRequestForbiddenError"}}}},"404":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestContractResignationRequestInternalServerError"}}}}},"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingResignationPostRequestBodyContentMultipartFormDataSchemaData"}},"required":["data"]}}}}}},"/eor/workers/resignations":{"get":{"operationId":"get-employee-resignations","summary":"Retrieve worker resignations","description":"Use this endpoint to retrieve resignations submitted by Employer of Record (EOR) workers. Use it when you need to review resignation progress, confirm desired and confirmed end dates, and access resignation letter details. Filter results by resignation letter status using the query parameter\n **Token scopes**: `worker:read`","tags":["subpackage_eorWorkerOffboarding"],"parameters":[{"name":"status","in":"query","description":"Filter by resignation letter status","required":false,"schema":{"$ref":"#/components/schemas/EorWorkersResignationsGetParametersStatus"}},{"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/eor-worker-offboarding_getEmployeeResignations_Response_200"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveWorkerResignationsRequestBadRequestError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveWorkerResignationsRequestUnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveWorkerResignationsRequestForbiddenError"}}}},"404":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveWorkerResignationsRequestInternalServerError"}}}}}}},"/eor/workers/contracts/{contract_id}/offboarding/resignation-letter/sign":{"post":{"operationId":"sign-employee-resignation-letter","summary":"Sign Resignation Letter","description":"This endpoint allows workers to provide their signature for a resignation letter. The signature is required to finalize the resignation process. Upon successful submission, the resignation letter is queued for PDF generation and further processing.\n **Token scopes**: `worker:write`","tags":["subpackage_eorWorkerOffboarding"],"parameters":[{"name":"contract_id","in":"path","description":"The unique identifier of the employee contract.","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":{"201":{"description":"Resignation signed successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/eor-worker-offboarding_signEmployeeResignationLetter_Response_201"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignResignationLetterRequestBadRequestError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignResignationLetterRequestUnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignResignationLetterRequestForbiddenError"}}}},"404":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignResignationLetterRequestInternalServerError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorWorkersContractsContractIdOffboardingResignationLetterSignPostRequestBodyContentApplicationJsonSchemaData"}},"required":["data"]}}}}}},"/eor/workers/contracts/{contract_id}/offboarding":{"post":{"operationId":"submit-eor-worker-resignation","summary":"Submit EOR Worker Resignation","description":"This endpoint allows workers to formally request the resignation of their EOR contract\n **Token scopes**: `worker:write`","tags":["subpackage_eorWorkerOffboarding"],"parameters":[{"name":"contract_id","in":"path","description":"The unique identifier of the employee contract.","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":{"201":{"description":"Ok response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/eor-worker-offboarding_submitEORWorkerResignation_Response_201"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitEorWorkerResignationRequestBadRequestError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitEorWorkerResignationRequestUnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitEorWorkerResignationRequestForbiddenError"}}}},"404":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitEorWorkerResignationRequestInternalServerError"}}}}},"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorWorkersContractsContractIdOffboardingPostRequestBodyContentMultipartFormDataSchemaData"}},"required":["data"]}}}}}},"/eor/workers/{worker_id}/payslips/{payslip_id}/download":{"get":{"operationId":"get-worker-payslips-download","summary":"Retrieve payslip PDF download link","description":"Retrieve a URL to download a specific payslip PDF for a EoR worker. This endpoint is useful for accessing detailed payment records in a portable document format.\n **Token scopes**: `payslips:read`","tags":["subpackage_eorWorkerPayslips"],"parameters":[{"name":"worker_id","in":"path","description":"The ID of the worker whose payslip download link is being requested.","required":true,"schema":{"type":"string"}},{"name":"payslip_id","in":"path","description":"The ID of the specific payslip to download.","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 retrieved the payslip download link.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/eor-worker-payslips_getWorkerPayslipsDownload_Response_200"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}}}},"/equities-tokens/tax-events":{"post":{"operationId":"create-equity-or-token-tax-event","summary":"Create equity or token tax event","description":"Use this endpoint to submit an equity or token tax event for an EOR onboarded to Equity & Token Services\n **Token scopes**: `equities:write`","tags":["subpackage_equityTokens"],"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/Equity Tokens_createEquityOrTokenTaxEvent_Response_201"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateEquityOrTokenTaxEventRequestBadRequestError"}}}},"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/EquitiesTokensTaxEventsPostRequestBodyContentApplicationJsonSchemaData"}}}}}}}},"/forms/eor/create-contract/definitions":{"post":{"operationId":"fetch-multiple-eor-contract-forms","summary":"Fetch multiple EOR Contract forms","description":"Retrieve paginated, versioned form definitions for creating EOR contracts for the specified countries. Use this endpoint when initializing or resuming a contract-creation flow to determine the required sections, fields, validation rules, and conditional logic per country (and optional contract type/locale). Always consume the latest effective version from the response and handle pagination. Not intended for reading or updating existing contracts.\n **Token scopes**: `forms:read`","tags":["subpackage_forms"],"parameters":[{"name":"limit","in":"query","description":"Maximum number of countries to return in a single response. Defaults to 10.","required":false,"schema":{"type":"integer","default":10}},{"name":"cursor","in":"query","description":"Pagination cursor for fetching subsequent pages of results.","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 containing multiple form configuration data.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Forms_fetchMultipleEorContractForms_Response_200"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FetchMultipleEorContractFormsRequestBadRequestError"}}}},"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/FetchMultipleEorContractFormsRequestInternalServerError"}}}}},"requestBody":{"description":"Request body containing countries and optional parameters for bulk quote form fetching.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/FormsEorCreateContractDefinitionsPostRequestBodyContentApplicationJsonSchemaData"}},"required":["data"]}}}}}},"/forms/eor/worker-additional-fields/{country_code}":{"get":{"operationId":"get-worker-additional-fields-for-eor","summary":"Get worker additional fields for (EOR)","description":"Use this endpoint to retrieve the additional form fields required for EOR workers in a specified country.\n **Token scopes**: `forms:read`","tags":["subpackage_forms"],"parameters":[{"name":"country_code","in":"path","description":"Country code","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/Forms_getWorkerAdditionalFieldsForEor_Response_200"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetWorkerAdditionalFieldsForEorRequestBadRequestError"}}}},"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/GetWorkerAdditionalFieldsForEorRequestInternalServerError"}}}}}}},"/gp/workers/{id}/payslips/{payslip_id}/download":{"get":{"operationId":"download-a-gp-worker-payslip-v-2026-01-01","summary":"Download a GP worker payslip","description":"Returns a pre-signed download URL for a specific Global Payroll (GP) employee payslip PDF. Use this after calling Retrieve employee payslips to obtain the payslipId. Requires the worker id (UUID) and the payslipId from the list response. The returned URL is temporary and should be used promptly to download the file. Supports only GP contract types.\n **Token scopes**: `payslips:read`","tags":["subpackage_globalPayroll"],"parameters":[{"name":"id","in":"path","description":"Unique identifier for the worker.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"payslipId","in":"path","description":"Unique identifier for the payslip.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"payslip_id","in":"path","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/Global Payroll_downloadAGpWorkerPayslip-v2026-01-01_Response_200"}}}},"400":{"description":"Bad Request - Validation error or invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DownloadAGpWorkerPayslip-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"}}}}}}},"/cycles/{cycle_id}/payroll-report":{"get":{"operationId":"get-payroll-report-v-2026-03-30","summary":"Get Payroll Report","description":"Get payroll report data for a payroll cycle, including available columns, employee row values, and optional previous report items. Use this response to discover payroll_report_column_id and payroll_id before updating entries.\n **Token scopes**: `global-payroll:read`","tags":["subpackage_globalPayroll"],"parameters":[{"name":"cycle_id","in":"path","description":"Payroll event/cycle id.","required":true,"schema":{"type":"string"}},{"name":"contract_oids","in":"query","description":"Contract OID(s) to filter report rows.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"search","in":"query","description":"Filter by employee name.","required":false,"schema":{"type":"string"}},{"name":"employee_status","in":"query","description":"Employee status filter.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"limit","in":"query","description":"Maximum number of report rows.","required":false,"schema":{"type":"integer","default":100}},{"name":"cursor","in":"query","description":"Cursor for pagination.","required":false,"schema":{"$ref":"#/components/schemas/CyclesCycleIdPayrollReportGetParametersCursor"}},{"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/Global Payroll_getPayrollReport-v2026-03-30_Response_200"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetPayrollReport-v2026-03-30RequestBadRequestError"}}}},"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/GetPayrollReport-v2026-03-30RequestInternalServerError"}}}}}}},"/forms/gp/worker-additional-fields/{country_code}":{"get":{"operationId":"retrieve-additional-information-fields-for-gp-workers-by-country-v-2026-01-01","summary":"Retrieve additional information fields for GP workers by country","description":"Retrieves GP workers additional information fields that are required for running payroll depending on the country regulations\n **Token scopes**: `forms:read`","tags":["subpackage_globalPayroll"],"parameters":[{"name":"country_code","in":"path","description":"ISO 3166-1 alpha-2 country code for which to retrieve GP worker additional fields.","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":"Use this response to render dynamic form fields for GP worker onboarding. Contains field configuration, validation rules, display metadata, and dependency logic needed to build country-specific additional information forms.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Global Payroll_retrieveAdditionalInformationFieldsForGpWorkersByCountry-v2026-01-01_Response_200"}}}},"400":{"description":"Returned when the country_code path parameter is not a recognized ISO 3166-1 alpha-2 code.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveAdditionalInformationFieldsForGpWorkersByCountry-v2026-01-01RequestBadRequestError"}}}},"401":{"description":"Authentication failed. The access token is missing, expired, or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveAdditionalInformationFieldsForGpWorkersByCountry-v2026-01-01RequestUnauthorizedError"}}}},"403":{"description":"Access denied. The authenticated user does not have the required forms:read scope.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveAdditionalInformationFieldsForGpWorkersByCountry-v2026-01-01RequestForbiddenError"}}}},"404":{"description":"The country_code is a valid ISO code but no additional information template exists for it in the Employee Data Management system.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveAdditionalInformationFieldsForGpWorkersByCountry-v2026-01-01RequestNotFoundError"}}}},"429":{"description":"Rate limit exceeded. The client has sent too many requests in a given time window.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveAdditionalInformationFieldsForGpWorkersByCountry-v2026-01-01RequestTooManyRequestsError"}}}},"500":{"description":"Internal server error. Returned when the Employee Data Management service is unreachable, or an unexpected error occurs during field retrieval.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveAdditionalInformationFieldsForGpWorkersByCountry-v2026-01-01RequestInternalServerError"}}}}}}},"/contracts/gp":{"post":{"operationId":"create-gp-contract","summary":"Create a Global Payroll (GP) contract","description":"Create a Global Payroll contract, including dataset such as employment, employee address, client legal_entity/team, compensation_details, job_title, invite_employee_to_app, work_location for US\n **Token scopes**: `contracts:write`","tags":["subpackage_gpHiring"],"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/gp-hiring_createGPContract_Response_201"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAGlobalPayrollGpContract-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/CreateAGlobalPayrollGpContract-v2026-01-01RequestInternalServerError"}}}}},"requestBody":{"description":"Global Payroll (GP) contract object that needs to be created.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ContractsGpPostRequestBodyContentApplicationJsonSchemaData"}},"required":["data"]}}}}}},"/gp/workers/{worker_id}/terminations":{"post":{"operationId":"create-gp-worker-termination","summary":"Request termination","description":"Request a termination for a global payroll employee. A successful call starts the termination process and does not confirm termination.\n **Token scopes**: `global-payroll:write`","tags":["subpackage_gpHiring"],"parameters":[{"name":"worker_id","in":"path","description":"Unique identifier for a worker in UUID format.","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":{"201":{"description":"Successful operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/gp-hiring_createGPWorkerTermination_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":{"description":"Request body to request a termination for an employee.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/GpWorkersWorkerIdTerminationsPostRequestBodyContentApplicationJsonSchemaData"}},"required":["data"]}}}}}},"/groups/{id}/clone":{"post":{"operationId":"clone-group","summary":"Clone a Group","description":"Clone an existing group within the organization. This creates a new group with the specified name, copying the structure and settings from the source group.\n **Token scopes**: `groups:write`","tags":["subpackage_groups"],"parameters":[{"name":"id","in":"path","description":"Unique identifier of the group to be cloned.","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":{"201":{"description":"Group cloned successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/groups_cloneGroup_Response_201"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloneAGroupRequestBadRequestError"}}}},"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/GroupsIdClonePostRequestBodyContentApplicationJsonSchemaData"}},"required":["data"]}}}}}},"/groups":{"post":{"operationId":"create-group","summary":"Create a group","description":"Create a new group within your organization.\n **Token scopes**: `groups:read`, `groups:write`","tags":["subpackage_groups"],"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":"Group created successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/groups_createGroup_Response_200"}}}},"400":{"description":"Invalid request payload","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateGroupRequestBadRequestError"}}}},"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/GroupsPostRequestBodyContentApplicationJsonSchemaData"}},"required":["data"]}}}}},"get":{"operationId":"get-groups","summary":"Return list of groups","description":"List all the groups in your organization.\n **Token scopes**: `groups:read`","tags":["subpackage_groups"],"parameters":[{"name":"limit","in":"query","description":"The maximum number of groups to return (between 1 and 100)","required":false,"schema":{"type":"integer","default":100}},{"name":"sort_order","in":"query","description":"Sort the results in ascending (ASC) or descending (DESC) order based on the group name.","required":false,"schema":{"$ref":"#/components/schemas/GroupsGetParametersSortOrder"}},{"name":"cursor","in":"query","description":"The encoded cursor for paginated results. This is an opaque string that allows fetching the next set of results.","required":false,"schema":{"type":"string"}},{"name":"include_archived_groups","in":"query","description":"Include archived groups (soft deleted records). Defaults to `true`.","required":false,"schema":{"type":"boolean","default":true}},{"name":"external_metadata","in":"query","description":"Extra information about the group.","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":"A list of groups in the organization.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/groups_getGroups_Response_200"}}}},"400":{"description":"Invalid request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetGroupsRequestBadRequestError"}}}},"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"}}}}}}},"/groups/{id}":{"delete":{"operationId":"delete-group","summary":"Delete a group","description":"Archive an existing group.\n **Token scopes**: `groups:write`","tags":["subpackage_groups"],"parameters":[{"name":"id","in":"path","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":"Group archived successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/groups_deleteGroup_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteGroupRequestBadRequestError"}}}},"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":"Group not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteGroupRequestNotFoundError"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}}},"patch":{"operationId":"update-group","summary":"Edit a group","description":"Edit the details of an existing group.\n **Token scopes**: `groups:read`, `groups:write`","tags":["subpackage_groups"],"parameters":[{"name":"id","in":"path","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":"Group updated successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/groups_updateGroup_Response_200"}}}},"400":{"description":"Invalid request payload","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EditGroupRequestBadRequestError"}}}},"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/GroupsIdPatchRequestBodyContentApplicationJsonSchemaData"}},"required":["data"]}}}}}},"/eor/contracts/{contract_id}/hrx-documents/{document_id}":{"get":{"operationId":"download-hrx-documents","summary":"Download HRX documents","description":"Generates a pre-signed URL to download a specific HRX document as a PDF file for a given EOR contract. The URL is valid for 15 minutes. The document is generated and managed by HRX (Human Resources Experience) and includes various employment-related documents such as employment agreements, onboarding materials, tax documents, visa support letters, and other official documentation required throughout the employment lifecycle.\n **Token scopes**: `contracts:read`, `worker:read`","tags":["subpackage_hrxDocuments"],"parameters":[{"name":"contract_id","in":"path","description":"The unique identifier of the employee contract.","required":true,"schema":{"type":"string"}},{"name":"document_id","in":"path","description":"The unique identifier of the document to download.","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":"Successfully generated pre-signed URL for HRX document download","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HRX Documents_downloadHrxDocuments_Response_200"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DownloadHrxDocumentsRequestBadRequestError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DownloadHrxDocumentsRequestUnauthorizedError"}}}},"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"}}}}}}},"/eor/contracts/{contract_id}/hrx-documents":{"get":{"operationId":"retrieve-hrx-documents","summary":"Retrieve HRX documents","description":"Retrieves a list of HRX documents that have been shared with an employee for a specific EOR contract. These documents are generated and managed by HRX (Human Resources Experience) and include various employment-related documents such as employment agreements, onboarding materials, tax documents, visa support letters, and other official documentation required throughout the employment lifecycle.\n **Token scopes**: `worker:read`, `contracts:read`","tags":["subpackage_hrxDocuments"],"parameters":[{"name":"contract_id","in":"path","description":"The unique identifier of the employee contract.","required":true,"schema":{"type":"string"}},{"name":"cursor","in":"query","description":"Cursor for pagination. Use the cursor from the previous response to get the next page of results.","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Number of items to return per page. Maximum is 100, default is 20.","required":false,"schema":{"type":"integer","default":20}},{"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":"HRX documents successfully retrieved for EOR contract","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HRX Documents_retrieveHrxDocuments_Response_200"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveHrxDocumentsRequestBadRequestError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveHrxDocumentsRequestUnauthorizedError"}}}},"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":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveHrxDocumentsRequestInternalServerError"}}}}}}},"/contracts/{contract_id}/ic-invoicing-taxes":{"post":{"operationId":"create-ic-invoicing-tax","summary":"Create IC invoicing tax","description":"Use this endpoint to create an invoicing tax for an independent contractor contract.\n **Token scopes**: `invoice-adjustments:write`","tags":["subpackage_icInvoicingTaxes"],"parameters":[{"name":"contract_id","in":"path","description":"Deel 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":{"201":{"description":"IC tax successfully created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IC invoicing taxes_createIcInvoicingTax_Response_201"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateIcInvoicingTaxRequestBadRequestError"}}}},"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/CreateIcInvoicingTaxRequestInternalServerError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ContractsContractIdIcInvoicingTaxesPostRequestBodyContentApplicationJsonSchemaData"}}}}}}},"get":{"operationId":"get-ic-invoicing-taxes","summary":"Get IC invoicing taxes","description":"Use this endpoint to retrieve invoicing tax settings for an IC contract. Provide the contract_id to fetch vat.percentage and withholding_tax.percentage, which can be used when displaying or calculating taxes on invoices for the contract.\n **Token scopes**: `invoice-adjustments:read`","tags":["subpackage_icInvoicingTaxes"],"parameters":[{"name":"contract_id","in":"path","description":"Deel 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":"IC invoicing taxes response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IC invoicing taxes_getIcInvoicingTaxes_Response_200"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetIcInvoicingTaxesRequestBadRequestError"}}}},"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/GetIcInvoicingTaxesRequestInternalServerError"}}}}}},"patch":{"operationId":"update-ic-invoicing-tax","summary":"Update IC invoicing tax","description":"Use this endpoint to update the invoicing tax for an independent contractor’s contract. Provide tax_type (WITHHOLDING_TAX or VAT) and percentage to adjust how taxes are applied to invoices.\n **Token scopes**: `invoice-adjustments:write`","tags":["subpackage_icInvoicingTaxes"],"parameters":[{"name":"contract_id","in":"path","description":"Deel 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":{"204":{"description":"IC tax successfully updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IC invoicing taxes_updateIcInvoicingTax_Response_204"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateIcInvoicingTaxRequestBadRequestError"}}}},"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/UpdateIcInvoicingTaxRequestInternalServerError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ContractsContractIdIcInvoicingTaxesPatchRequestBodyContentApplicationJsonSchemaData"}}}}}}}},"/contracts/{contract_id}/ic-invoicing-taxes/{tax_type}":{"delete":{"operationId":"delete-ic-invoicing-tax","summary":"Delete IC invoicing tax","description":"Use this endpoint to remove an IC invoicing tax from a contract when it no longer applies. Specify the contract_id and tax_type in the path. This action is irreversible and removes the tax from future invoicing.\n **Token scopes**: `invoice-adjustments:write`","tags":["subpackage_icInvoicingTaxes"],"parameters":[{"name":"contract_id","in":"path","description":"Deel Contract ID","required":true,"schema":{"type":"string"}},{"name":"tax_type","in":"path","description":"IC tax type","required":true,"schema":{"$ref":"#/components/schemas/ContractsContractIdIcInvoicingTaxesTaxTypeDeleteParametersTaxType"}},{"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":"IC tax successfully deleted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IC invoicing taxes_deleteIcInvoicingTax_Response_204"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteIcInvoicingTaxRequestBadRequestError"}}}},"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/DeleteIcInvoicingTaxRequestInternalServerError"}}}}}}},"/immigration/client/cases":{"post":{"operationId":"create-an-immigration-case","summary":"Create an immigration case","description":"Create an immigration case.\n **Token scopes**: `immigration:write`","tags":["subpackage_immigration"],"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/Immigration_createAnImmigrationCase_Response_201"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAnImmigrationCaseRequestBadRequestError"}}}},"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/CreateAnImmigrationCaseRequestInternalServerError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ImmigrationClientCasesPostRequestBodyContentApplicationJsonSchemaData"}}}}}}},"get":{"operationId":"get-client-cases","summary":"List of immigration cases","description":"Retrieves a paginated list of immigration cases with filters for applicant name, case type, status, and country. Returns case details including type, status, process, timestamps, and optional closure information.\n **Token scopes**: `immigration:read`","tags":["subpackage_immigration"],"parameters":[{"name":"search","in":"query","description":"Search by applicant name or code","required":false,"schema":{"type":"string"}},{"name":"case_type_ids","in":"query","description":"Filter by case type IDs","required":false,"schema":{"type":"array","items":{"type":"string","format":"uuid"}}},{"name":"statuses","in":"query","description":"Filter by case status","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/ImmigrationClientCasesGetParametersStatusesSchemaItems"}}},{"name":"countries","in":"query","description":"Filter by country. Uses ISO 3166-1 alpha-2 codes (https://www.iban.com/country-codes).","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"cursor","in":"query","description":"Pagination cursor for fetching next set of results","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Max number of results to return","required":false,"schema":{"type":"integer","default":20}},{"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/immigration_getClientCases_Response_200"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListOfImmigrationCases-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/ListOfImmigrationCases-v2026-01-01RequestInternalServerError"}}}}}}},"/immigration/visa-requirement/business":{"get":{"operationId":"get-business-visa-requirement","summary":"Get business visa eligibility and requirements","description":"This endpoint receives personal information and desired travel information, analyzes and returns the possible business visa options for the given data.\n **Token scopes**: `immigration:read`","tags":["subpackage_immigration"],"parameters":[{"name":"destination_country","in":"query","description":"The destination country code of the trip in ISO 3166-1 alpha-2 format","required":true,"schema":{"type":"string"}},{"name":"nationality","in":"query","description":"The nationality country code of the person in ISO 3166-1 alpha-2 format","required":true,"schema":{"type":"string"}},{"name":"residence_country","in":"query","description":"The residence country code of the person in ISO 3166-1 alpha-2 format","required":true,"schema":{"type":"string"}},{"name":"trip_start_date","in":"query","description":"The trip start date in ISO 8601 format (YYYY-MM-DD)","required":true,"schema":{"type":"string","format":"date"}},{"name":"trip_end_date","in":"query","description":"The trip end date in ISO 8601 format (YYYY-MM-DD)","required":true,"schema":{"type":"string","format":"date"}},{"name":"trip_reason","in":"query","description":"The reason for the trip","required":true,"schema":{"$ref":"#/components/schemas/ImmigrationVisaRequirementBusinessGetParametersTripReason"}},{"name":"second_nationality","in":"query","description":"The second nationality country code of the person in ISO 3166-1 alpha-2 format (optional)","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.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/immigration_getBusinessVisaRequirement_Response_200"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetBusinessVisaEligibilityAndRequirementsRequestBadRequestError"}}}},"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/GetBusinessVisaEligibilityAndRequirementsRequestInternalServerError"}}}}}}},"/immigration/client/cases/{id}":{"get":{"operationId":"get-client-case","summary":"Get immigration case details","description":"Get detailed information for a specific immigration case. Use this to check case status and track process progress. The id path parameter is the case UUID returned from the 'Create Client Case' endpoint. Response is enriched with applicant profile, visa type, case status, estimated completion date, process details, and compliance document details.\n **Token scopes**: `immigration:read`","tags":["subpackage_immigration"],"parameters":[{"name":"id","in":"path","description":"Immigration case 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/immigration_getClientCase_Response_200"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetImmigrationCaseDetails-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/GetImmigrationCaseDetails-v2026-01-01RequestInternalServerError"}}}}}}},"/immigration/workers/cases/{case_id}":{"get":{"operationId":"get-worker-case","summary":"Get specific immigration case details ","description":"Get detailed information for a specific immigration case. Use this to check case status and track process progress. The id path parameter is the case UUID returned from the 'Create Client Case' endpoint. Response is enriched with applicant profile, visa type, case status, estimated completion date, process details, and compliance document details.\n **Token scopes**: `worker:read`","tags":["subpackage_immigration"],"parameters":[{"name":"case_id","in":"path","description":"Filter by case 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/immigration_getWorkerCase_Response_200"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetSpecificImmigrationCaseDetails-v2026-04-02RequestBadRequestError"}}}},"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/GetSpecificImmigrationCaseDetails-v2026-04-02RequestInternalServerError"}}}}}}},"/immigration/documents/{id}":{"get":{"operationId":"get-document","summary":"Immigration document","description":"Fetch immigration document details by document id\n **Token scopes**: `immigration:read`","tags":["subpackage_immigration"],"parameters":[{"name":"id","in":"path","description":"Immigration case document 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/immigration_getDocument_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"}}}}}}},"/immigration/visa-types/{country_code}":{"get":{"operationId":"get-visa-types","summary":"Immigration visa types","description":"Fetch immigration supported visa types by country\n **Token scopes**: `immigration:read`","tags":["subpackage_immigration"],"parameters":[{"name":"country_code","in":"path","description":"Alpha 2 country code","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/immigration_getVisaTypes_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"}}}}}}},"/immigration/workers/cases":{"get":{"operationId":"get-worker-cases","summary":"List of immigration cases for workers","description":"Retrieves a paginated list of immigration cases with filters for applicant name, case type, status, and country. Returns case details including type, status, process, timestamps, and optional closure information.\n **Token scopes**: `worker:read`","tags":["subpackage_immigration"],"parameters":[{"name":"search","in":"query","description":"Search by applicant name or code","required":false,"schema":{"type":"string"}},{"name":"case_type_ids","in":"query","description":"Filter by case type IDs","required":false,"schema":{"type":"array","items":{"type":"string","format":"uuid"}}},{"name":"statuses","in":"query","description":"Filter by case status","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/ImmigrationWorkersCasesGetParametersStatusesSchemaItems"}}},{"name":"countries","in":"query","description":"Filter by country. Uses ISO 3166-1 alpha-2 codes (https://www.iban.com/country-codes).","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"cursor","in":"query","description":"Pagination cursor for fetching next set of results","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Max number of results to return","required":false,"schema":{"type":"integer","default":20}},{"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/immigration_getWorkerCases_Response_200"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListOfImmigrationCasesForWorkers-v2026-04-02RequestBadRequestError"}}}},"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/ListOfImmigrationCasesForWorkers-v2026-04-02RequestInternalServerError"}}}}}}},"/immigration/workers/{worker_id}/cases/{case_id}/required-document":{"get":{"operationId":"get-worker-case-required-document","summary":"Retrieve a required document for a case","description":"Use this endpoint to retrieve the details of a specific document requirement for a worker's case. This includes the requirement's status and information about any previously rejected documents\n **Token scopes**: `worker:read`","tags":["subpackage_immigration"],"parameters":[{"name":"worker_id","in":"path","description":"The hris profile oid (public id) of the worker.","required":true,"schema":{"type":"string"}},{"name":"case_id","in":"path","description":"The unique identifier of the case for which the required document is being requested.","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/immigration_getWorkerCaseRequiredDocument_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"}}}}}}},"/immigration/workers/{worker_id}/onboarding-case":{"get":{"operationId":"get-worker-onboarding-case","summary":"Retrieve onboarding right-to-work case for a worker","description":"Returns the right to work case for employee onboarding including the documents if any. In case no right to work case is open, the response will be empty.\n **Token scopes**: `worker:read`","tags":["subpackage_immigration"],"parameters":[{"name":"worker_id","in":"path","description":"The hris profile oid (public id) of the worker.","required":true,"schema":{"type":"string"}},{"name":"contract_id","in":"query","description":"Filters the worker's onboarding case to a specific contract. If the worker has multiple contracts and this parameter is omitted, the response may return a case from any associated contract; the response includes contract.id to indicate which contract was used. Provide this parameter for deterministic results.","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.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/immigration_getWorkerOnboardingCase_Response_200"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveOnboardingRightToWorkCaseForAWorkerRequestBadRequestError"}}}},"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":"Case not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveOnboardingRightToWorkCaseForAWorkerRequestNotFoundError"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveOnboardingRightToWorkCaseForAWorkerRequestInternalServerError"}}}}}}},"/immigration/workers/{worker_id}/cases/{case_id}/required-document/{document_request_id}":{"post":{"operationId":"create-worker-case-required-document","summary":"Upload a required immigration document","description":"Upload a required immigration document for a specific case. The document will be submitted for review.\n **Token scopes**: `worker:write`","tags":["subpackage_immigration"],"parameters":[{"name":"worker_id","in":"path","description":"The hris profile oid (public id) of the worker.","required":true,"schema":{"type":"string"}},{"name":"case_id","in":"path","description":"The unique identifier of the case for which the required document is being requested.","required":true,"schema":{"type":"string"}},{"name":"document_request_id","in":"path","description":"The unique identifier of the document request fo which this document is being uplodaded","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":{"201":{"description":"Document uploaded.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/immigration_createWorkerCaseRequiredDocument_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":{"description":"Upload of immigration document","content":{"multipart/form-data":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ImmigrationWorkersWorkerIdCasesCaseIdRequiredDocumentDocumentRequestIdPostRequestBodyContentMultipartFormDataSchemaData","description":"Details of immigration document upload"}},"required":["data"]}}}}}},"/integrations/consent":{"get":{"operationId":"get-integration-consent","summary":"Get integration consent","description":"Retrieve the consent for the authenticated user or organization.","tags":["subpackage_integrations"],"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/Integrations_getIntegrationConsent_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"}}}}}}},"/invoice-adjustments":{"post":{"operationId":"create-invoice-adjustment","summary":"Create an invoice adjustment","description":"Create an invoice adjustment using this endpoint. For example, you can add a bonus, commission, VAT %, deduction etc. to an invoice.\n **Token scopes**: `invoice-adjustments:write`, `worker:write`","tags":["subpackage_invoiceAdjustments"],"parameters":[{"name":"recurring","in":"query","description":"Add this invoice adjustment as recurring","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":{"201":{"description":"Successful operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/invoice-adjustments_createInvoiceAdjustment_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":{"description":"InvoiceAdjustment object that needs to be created","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/InvoiceAdjustmentsPostRequestBodyContentApplicationJsonSchemaData","description":"Details of invoice adjustment to create."}},"required":["data"]}}}}},"get":{"operationId":"get-invoice-adjustments","summary":"List invoice adjustments","description":"Retrieve invoice adjustments. You can filter the list by providing additional parameters e.g. contract_id, contract_type etc.\n **Token scopes**: `invoice-adjustments:read`","tags":["subpackage_invoiceAdjustments"],"parameters":[{"name":"contract_id","in":"query","description":"Id of an Deel contract.","required":false,"schema":{"type":"string"}},{"name":"contract_types","in":"query","description":"types of contracts to filter","required":false,"schema":{"$ref":"#/components/schemas/InvoiceAdjustmentsGetParametersContractTypes"}},{"name":"types","in":"query","description":"types of invoice adjustments to filter","required":false,"schema":{"$ref":"#/components/schemas/InvoiceAdjustmentsGetParametersTypes"}},{"name":"statuses","in":"query","description":"statuses of invoice adjustment to filter","required":false,"schema":{"$ref":"#/components/schemas/InvoiceAdjustmentsGetParametersStatuses"}},{"name":"invoice_id","in":"query","description":"ID of an existing invoice","required":false,"schema":{"type":"string"}},{"name":"reporter_id","in":"query","description":"ID of an existing profile","required":false,"schema":{"type":"string","format":"uuid"}},{"name":"date_from","in":"query","description":"To get invoice adjustments submitted on or after given start date (inclusive). Short date in format ISO-8601 (YYYY-MM-DD). For example: 2022-12-31.","required":false,"schema":{"type":"string","format":"date"}},{"name":"date_to","in":"query","description":"To get invoice adjustments submitted before given end date (excludes records submitted on this date). Short date in format ISO-8601 (YYYY-MM-DD). For example: 2022-12-31.","required":false,"schema":{"type":"string","format":"date"}},{"name":"limit","in":"query","description":"Return a page of results with given number of records; NOTE: technically ALL query parameters are strings or array of strings","required":false,"schema":{"type":"string"}},{"name":"offset","in":"query","description":"Return a page of results after given index of row; NOTE: technically ALL query parameters are strings or array of strings","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.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/invoice-adjustments_getInvoiceAdjustments_Response_200"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListInvoiceAdjustments-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"}}}}}}},"/invoice-adjustments/{id}":{"delete":{"operationId":"delete-invoice-adjustment","summary":"Delete adjustment","description":"Delete an adjustment.\n **Token scopes**: `invoice-adjustments:write`","tags":["subpackage_invoiceAdjustments"],"parameters":[{"name":"id","in":"path","description":"Invoice adjustment 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/invoice-adjustments_deleteInvoiceAdjustment_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-invoice-adjustment-by-id","summary":"Invoice line item by Id","description":"Use this endpoint to retrieve the details of a specific invoice adjustment (line item) by its id. Call it when you need to display or audit a charge, deduction, or expense on an invoice, or to reconcile a payment discrepancy. Provide the adjustment id in the path parameter. This operation is read-only.\n **Token scopes**: `invoice-adjustments:read`, `worker:read`","tags":["subpackage_invoiceAdjustments"],"parameters":[{"name":"id","in":"path","description":"ID of an existing invoice","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/invoice-adjustments_getInvoiceAdjustmentById_Response_200"}}}},"400":{"description":"Fetch failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoiceLineItemById-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"}}}}}},"patch":{"operationId":"update-invoice-adjustment","summary":"Update an invoice adjustment","description":"Update an invoice adjustment.\n **Token scopes**: `invoice-adjustments:write`, `worker:write`","tags":["subpackage_invoiceAdjustments"],"parameters":[{"name":"id","in":"path","description":"Invoice adjustment 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/invoice-adjustments_updateInvoiceAdjustment_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/InvoiceAdjustmentsIdPatchRequestBodyContentApplicationJsonSchemaData","description":"Details of adjustment to update"}},"required":["data"]}}}}}},"/contracts/{contract_id}/invoice-adjustments":{"get":{"operationId":"get-contract-invoice-adjustments","summary":"Invoice line items by contract","description":"Retrieve invoice line items for a given contract id.\n **Token scopes**: `invoice-adjustments:read`","tags":["subpackage_invoiceAdjustments"],"parameters":[{"name":"contract_id","in":"path","description":"Deel contract id.","required":true,"schema":{"type":"string"}},{"name":"contract_types","in":"query","description":"types of contracts to filter","required":false,"schema":{"$ref":"#/components/schemas/ContractsContractIdInvoiceAdjustmentsGetParametersContractTypes"}},{"name":"types","in":"query","description":"types of invoice adjustments to filter","required":false,"schema":{"$ref":"#/components/schemas/ContractsContractIdInvoiceAdjustmentsGetParametersTypes"}},{"name":"statuses","in":"query","description":"statuses of invoice adjustment to filter","required":false,"schema":{"$ref":"#/components/schemas/ContractsContractIdInvoiceAdjustmentsGetParametersStatuses"}},{"name":"invoice_id","in":"query","description":"ID of an existing invoice","required":false,"schema":{"type":"string"}},{"name":"reporter_id","in":"query","description":"ID of an existing profile","required":false,"schema":{"type":"string","format":"uuid"}},{"name":"date_from","in":"query","description":"To get invoice adjustments submitted on or after given start date (inclusive).    Short date in format ISO-8601 (YYYY-MM-DD). For example: 2022-12-31.","required":false,"schema":{"type":"string","format":"date"}},{"name":"date_to","in":"query","description":"To get invoice adjustments submitted before given end date (excludes records submitted on this date).    Short date in format ISO-8601 (YYYY-MM-DD). For example: 2022-12-31.","required":false,"schema":{"type":"string","format":"date"}},{"name":"limit","in":"query","description":"Return a page of results with given number of records; NOTE: technically ALL query parameters are strings or array of strings","required":false,"schema":{"type":"string"}},{"name":"offset","in":"query","description":"Return a page of results after given index of row; NOTE: technically ALL query parameters are strings or array of strings","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.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/invoice-adjustments_getContractInvoiceAdjustments_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"}}}}}}},"/invoice-adjustments/{id}/reviews":{"post":{"operationId":"create-invoice-adjustment-review","summary":"Review a single invoice adjustment","description":"Review a single invoice adjustment to approve or decline it.\n **Token scopes**: `invoice-adjustments:write`","tags":["subpackage_invoiceAdjustments"],"parameters":[{"name":"id","in":"path","description":"ID of an existing invoice adjustment.","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":{"201":{"description":"Successful operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/invoice-adjustments_createInvoiceAdjustmentReview_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/InvoiceAdjustmentsIdReviewsPostRequestBodyContentApplicationJsonSchemaData"}},"required":["data"]}}}}}},"/knowledge-hub/country-guide/{country_code}":{"get":{"operationId":"get-knowledge-hub-country-guides-by-country-code","summary":"Get Knowledge Hub Country Guides by Country Code","description":"Retrieve country guide for different audience and contract type by the country code\n **Token scopes**: `knowledge-hub:read`","tags":["subpackage_knowledgeHub"],"parameters":[{"name":"country_code","in":"path","description":"Country code for which we need to fetch the country guides","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 containing audiences, their contract types, and associated categories, fields, and articles.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Knowledge Hub_getKnowledgeHubCountryGuidesByCountryCode_Response_200"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetKnowledgeHubCountryGuidesByCountryCodeRequestBadRequestError"}}}},"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/GetKnowledgeHubCountryGuidesByCountryCodeRequestInternalServerError"}}}}}}},"/engage/learning/actionable-journeys":{"get":{"operationId":"retrieve-workers-actionable-journeys","summary":"Retrieve worker's actionable journeys","description":"Return list of ActionableJourneys for a given Worker. The concept of Actionable Journeys in the Public API corresponds directly to what is labeled as Courses in the user interface. Learn more about [Learning Management](https://www.deel.com/hr/engage/learning-management-software/)\n **Token scopes**: `worker:read`","tags":["subpackage_learning"],"parameters":[{"name":"journey_ids","in":"query","description":"Filter by Journey IDs.","required":false,"schema":{"type":"array","items":{"type":"string","format":"uuid"}}},{"name":"journey_assignment_ids","in":"query","description":"Filter by JourneyAssignment IDs.","required":false,"schema":{"type":"array","items":{"type":"string","format":"uuid"}}},{"name":"limit","in":"query","description":"Return a page of results with given number of records.","required":false,"schema":{"type":"number","format":"double","default":20}},{"name":"cursor","in":"query","description":"Cursor to the next page of results. If not provided, the first page will be returned.","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 retrieval of actionable journeys","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Learning_retrieveWorkersActionableJourneys_Response_200"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveWorkersActionableJourneysRequestBadRequestError"}}}},"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"}}}}}}},"/legal-entities":{"post":{"operationId":"create-legal-entity","summary":"Create a new legal entity","description":"Create a new legal entity under an organization.\n **Token scopes**: `legal-entity:write`, `legal-entity:read`","tags":["subpackage_legalEntities"],"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":"Successfully created legal entity.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/legal-entities_createLegalEntity_Response_200"}}}},"400":{"description":"Invalid request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateLegalEntityRequestBadRequestError"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Permission denied. User must have the `entities.manage` permission.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateLegalEntityRequestForbiddenError"}}}},"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/LegalEntitiesPostRequestBodyContentApplicationJsonSchemaData"}}}}}}},"get":{"operationId":"get-legal-entities","summary":"List of legal entities","description":"Retrieve a list of legal entities in your account.\n **Token scopes**: `organizations:read`, `accounting:read`","tags":["subpackage_legalEntities"],"parameters":[{"name":"limit","in":"query","description":"The number of results to return per page.","required":false,"schema":{"type":"integer","default":100}},{"name":"sort_order","in":"query","description":"Sorting order of the results.","required":false,"schema":{"$ref":"#/components/schemas/LegalEntitiesGetParametersSortOrder"}},{"name":"cursor","in":"query","description":"Cursor for pagination.","required":false,"schema":{"type":"string"}},{"name":"include_archived","in":"query","description":"Whether to include archived legal entities in the results.","required":false,"schema":{"type":"boolean","default":true}},{"name":"legal_entity_id","in":"query","description":"Filter by specific legal entity ID.","required":false,"schema":{"type":"string"}},{"name":"global_payroll","in":"query","description":"Filter by global payroll flag.","required":false,"schema":{"type":"boolean"}},{"name":"type","in":"query","description":"Filter by entity type.","required":false,"schema":{"type":"string"}},{"name":"country","in":"query","description":"Filter by country.","required":false,"schema":{"type":"string"}},{"name":"include_payroll_settings","in":"query","description":"Whether to include payroll settings 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 operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/legal-entities_getLegalEntities_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"}}}}}}},"/legal-entities/{id}":{"delete":{"operationId":"delete-legal-entity","summary":"Delete a legal entity","description":"Archive a legal entity. This marks the entity as inactive but does not permanently remove it.\n **Token scopes**: `legal-entity:read`, `legal-entity:write`","tags":["subpackage_legalEntities"],"parameters":[{"name":"id","in":"path","description":"The ID of the legal entity to archive.","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 archived the legal entity.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/legal-entities_deleteLegalEntity_Response_200"}}}},"400":{"description":"Invalid request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteLegalEntityRequestBadRequestError"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Permission denied.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteLegalEntityRequestForbiddenError"}}}},"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-legal-entity","summary":"Edit a legal entity","description":"Update the details of an existing legal entity.\n **Token scopes**: `legal-entity:read`, `legal-entity:write`","tags":["subpackage_legalEntities"],"parameters":[{"name":"id","in":"path","description":"The ID of the legal entity to update.","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 updated the legal entity.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/legal-entities_updateLegalEntity_Response_200"}}}},"400":{"description":"Invalid request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EditLegalEntityRequestBadRequestError"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Permission denied.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EditLegalEntityRequestForbiddenError"}}}},"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":{"name":{"type":"string","description":"The name of the legal entity."},"phone":{"type":"string","description":"The phone number of the legal entity."},"address":{"$ref":"#/components/schemas/LegalEntitiesIdPatchRequestBodyContentApplicationJsonSchemaAddress"},"sic_number":{"type":"string","description":"The SIC number of the legal entity."},"entity_type":{"type":"string","description":"The type of the legal entity."},"industry_name":{"type":"string","description":"The industry name of the legal entity."},"company_identifiers":{"$ref":"#/components/schemas/LegalEntitiesIdPatchRequestBodyContentApplicationJsonSchemaCompanyIdentifiers","description":"Identifiers associated with the legal entity."}}}}}}}},"/benefits/legal-entities/{id}":{"get":{"operationId":"get-legal-entity-data-from-organization-integrated-with-external-benefits-vendor-v-2026-01-01","summary":"Get legal entity data from organization integrated with external benefits vendor","description":"Returns legal entity data for an organization integrated with an external benefits vendor, identified by `id`, including registration details, address, entity type, and employment classification.\n **Token scopes**: `organizations:read`","tags":["subpackage_legalEntities"],"parameters":[{"name":"id","in":"path","description":"Id from the legal entity to fetch data","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/Legal Entities_getLegalEntityDataFromOrganizationIntegratedWithExternalBenefitsVendor-v2026-01-01_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"}}}}}}},"/industries":{"get":{"operationId":"get-industries","summary":"List all industry subcategories","description":"List industry subcategories with their parent category details, supporting cursor-based pagination and sorting by category or subcategory name. Each subcategory is identified by a UUID and includes NAICS codes. Used during entity setup to select an industry classification.\n **Token scopes**: `legal-entity:read`","tags":["subpackage_legalEntities"],"parameters":[{"name":"limit","in":"query","description":"Maximum number of items to return per page.","required":false,"schema":{"type":"integer"}},{"name":"order","in":"query","description":"Sorting order of the results.","required":false,"schema":{"$ref":"#/components/schemas/IndustriesGetParametersOrder"}},{"name":"sort_by","in":"query","description":"Field used to sort the results.","required":false,"schema":{"$ref":"#/components/schemas/IndustriesGetParametersSortBy"}},{"name":"cursor","in":"query","description":"Cursor used for paginating to the next page of results.","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":"List of industry subcategories.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/legal-entities_getIndustries_Response_200"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListAllIndustrySubcategories-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"}}}}}}},"/legal-entities/{legal_entity_id}/payroll-events":{"get":{"operationId":"list-payroll-cycles-v-2026-01-01","summary":"List payroll cycles","description":"Use this endpoint to retrieve a list of payroll events for a specified legal entity.\n **Token scopes**: `legal-entity:read`","tags":["subpackage_listCycles"],"parameters":[{"name":"legal_entity_id","in":"path","description":"The unique identifier (public ID) for the legal entity.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"date_start","in":"query","description":"Start date in the format 'YYYY-MM-DD'. Must not be earlier than 5 years ago.","required":false,"schema":{"type":"string","format":"date"}},{"name":"date_end","in":"query","description":"End date in the format 'YYYY-MM-DD'. Must not exceed 5 years in the future.","required":false,"schema":{"type":"string","format":"date"}},{"name":"limit","in":"query","description":"Maximum number of items to return.","required":false,"schema":{"type":"integer","default":20}},{"name":"cursor","in":"query","description":"Pagination cursor, CUID or UUID format.","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.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/List Cycles_listPayrollCycles-v2026-01-01_Response_200"}}}},"400":{"description":"Validation error or bad input.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListPayrollCycles-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":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListPayrollCycles-v2026-01-01RequestInternalServerError"}}}}}}},"/lookups/job-titles":{"get":{"operationId":"get-job-titles","summary":"Job titles list","description":"Retrieve a list of pre-defined job titles in Deel platform.","tags":["subpackage_lookups"],"parameters":[{"name":"after_cursor","in":"query","description":"Cursor for pagination. Use this to retrieve the next page of results.","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.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/lookups_getJobTitles_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"}}}}}}},"/lookups/countries":{"get":{"operationId":"get-countries","summary":"Retrieve Country List","description":"Retrieve a list of countries supported by Deel, along with details about visa and EoR support, sub-territories, and their classifications.","tags":["subpackage_lookups"],"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/lookups_getCountries_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"}}}}}}},"/lookups":{"get":{"operationId":"get-lookups","summary":"Retrieve lookup information for currencies, countries, entity types, etc","description":"Retrieve lookup information such as currencies, countries, entity types, or SIC numbers. Use the `type` query parameter to specify which data to retrieve.\n **Token scopes**: `legal-entity:read`","tags":["subpackage_lookups"],"parameters":[{"name":"documents","in":"query","description":"The type of lookup data to retrieve. Options are `currencies`, `countries`, `entity_types`, and `sic_numbers`.","required":true,"schema":{"$ref":"#/components/schemas/LookupsGetParametersDocuments"}},{"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":"A list of lookup information based on the requested type.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Lookups_getLookups_Response_200"}}}},"400":{"description":"Invalid request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetLookupsRequestBadRequestError"}}}},"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"}}}}}}},"/lookups/seniorities":{"get":{"operationId":"get-seniority-levels","summary":"Retrieve Seniority Levels","description":"Retrieve a list of predefined seniority levels for roles in the Deel platform, including their names, hierarchical levels, and unique identifiers.","tags":["subpackage_lookups"],"parameters":[{"name":"is_eor_contract","in":"query","description":"when `true`, exclude C-level seniorities for EOR contracts. Set to `false` to return all seniorities","required":false,"schema":{"type":"boolean","default":true}},{"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/lookups_getSeniorityLevels_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"}}}}}}},"/lookups/currencies":{"get":{"operationId":"get-currencies","summary":"Retrieve Supported Currency List","description":"Retrieve the list of currencies supported by Deel, including their ISO codes and names","tags":["subpackage_lookups"],"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/lookups_getCurrencies_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"}}}}}}},"/lookups/time-off-types":{"get":{"operationId":"get-time-off-types","summary":"Retrieve Time-Off Types","description":"Retrieve a list of predefined time-off types that can be registered in the Deel platform.","tags":["subpackage_lookups"],"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/lookups_getTimeOffTypes_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":"Resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveTimeOffTypesRequestNotFoundError"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}}}},"/magic-link":{"post":{"operationId":"create-magic-link","summary":"Create magic link","description":"Use this endpoint to generate secure, time-limited magic links that enable password-free, seamless worker authentication for quick and safe access. Ideal for temporary sessions or low-friction login flows.\n **Token scopes**: `worker:read`","tags":["subpackage_magicLink"],"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":"Magic link generated successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/magic-link_createMagicLink_Response_201"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"401":{"description":"Unauthorized - Invalid or missing authentication token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateMagicLinkRequestUnauthorizedError"}}}},"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/CreateMagicLinkRequestInternalServerError"}}}}},"requestBody":{"description":"Details for magic link generation.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/MagicLinkPostRequestBodyContentApplicationJsonSchemaData"}}}}}}}},"/managers":{"post":{"operationId":"create-manager","summary":"Create a Manager","description":"Create a new manager for the organization by providing the required user details. This endpoint returns the newly created manager's information.\n **Token scopes**: `organizations:write`","tags":["subpackage_managers"],"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":"Manager created successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/managers_createManager_Response_201"}}}},"400":{"description":"Invalid request. The input data did not meet the required validation rules.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateManagerRequestBadRequestError"}}}},"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"}}}},"409":{"description":"Conflict. A manager with the provided email already exists.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateManagerRequestConflictError"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}},"requestBody":{"description":"Details of the new manager to be created.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ManagersPostRequestBodyContentApplicationJsonSchemaData"}},"required":["data"]}}}}},"get":{"operationId":"get-managers","summary":"Retrieve List of Managers","description":"Retrieve a list of all managers in the organization along with pagination details.\n **Token scopes**: `organizations:read`","tags":["subpackage_managers"],"parameters":[{"name":"limit","in":"query","description":"The number of records to return in the response.","required":false,"schema":{"type":"integer"}},{"name":"offset","in":"query","description":"The offset or starting point for pagination.","required":false,"schema":{"type":"integer"}},{"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/managers_getManagers_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"}}}}}}},"/managers/magic-links":{"post":{"operationId":"generate-magic-link-for-manager-login","summary":"Generate magic link for manager login","description":"Generate a one-time magic link that allows a manager to log in to Deel without entering credentials. The target manager must belong to the requesting organization and cannot be an organization admin. Only available for White Label enabled organizations or Partners or Child organizations. The magic link expires after 5 minutes and can only be used once. After clicking the link, the manager will be automatically authenticated and redirected to Deel.\n **Token scopes**: `auth:write`","tags":["subpackage_managers"],"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":"Magic link generated successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Managers_generateMagicLinkForManagerLogin_Response_201"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"401":{"description":"Unauthorized - Invalid or missing authentication token","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerateMagicLinkForManagerLoginRequestUnauthorizedError"}}}},"403":{"description":"Forbidden - Not allowed to generate magic link for this manager","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerateMagicLinkForManagerLoginRequestForbiddenError"}}}},"404":{"description":"Not Found - Manager does not exist or is not in organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerateMagicLinkForManagerLoginRequestNotFoundError"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerateMagicLinkForManagerLoginRequestInternalServerError"}}}}},"requestBody":{"description":"Details for magic link for managers generation.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ManagersMagicLinksPostRequestBodyContentApplicationJsonSchemaData"}}}}}}}},"/contracts/{contract_id}/milestones":{"post":{"operationId":"create-contract-milestone","summary":"Create a Milestone","description":"Add a new milestone to a specific contract. Milestones represent distinct deliverables or phases in the contract and can include additional details such as attachments.\n **Token scopes**: `milestones:write`","tags":["subpackage_milestones"],"parameters":[{"name":"contract_id","in":"path","description":"The unique identifier of the Deel contract where the milestone will be added.","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":{"201":{"description":"Milestone created successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/milestones_createContractMilestone_Response_201"}}}},"400":{"description":"Invalid request. The input data did not meet the required validation rules.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateMilestoneRequestBadRequestError"}}}},"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":"The specified contract ID does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateMilestoneRequestNotFoundError"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}},"requestBody":{"description":"The milestone object containing the required details to be added to the contract.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ContractsContractIdMilestonesPostRequestBodyContentApplicationJsonSchemaData"}},"required":["data"]}}}}},"get":{"operationId":"get-contract-milestones","summary":"Retrieve Milestones by Contract","description":"Retrieve a list of milestones associated with a specific contract. Each milestone includes details such as its title, amount, status, and relevant dates, along with information about the creator and reviewer.\n **Token scopes**: `milestones:read`","tags":["subpackage_milestones"],"parameters":[{"name":"contract_id","in":"path","description":"The unique identifier of the Deel contract for which milestones are being retrieved.","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":"A list of milestones for the specified contract.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/milestones_getContractMilestones_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}/milestones/{milestone_id}":{"delete":{"operationId":"delete-contract-milestone","summary":"Delete a Milestone","description":"Delete a specific milestone associated with a contract. This operation removes the milestone and its data permanently from the system.\n **Token scopes**: `milestones:write`","tags":["subpackage_milestones"],"parameters":[{"name":"contract_id","in":"path","description":"The unique identifier of the Deel contract from which the milestone will be deleted.","required":true,"schema":{"type":"string"}},{"name":"milestone_id","in":"path","description":"The unique identifier of the milestone that is to be deleted.","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":"Milestone successfully deleted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/milestones_deleteContractMilestone_Response_200"}}}},"400":{"description":"Invalid request. The provided contract or milestone ID is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteMilestoneByIdRequestBadRequestError"}}}},"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":"Contract or milestone not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteMilestoneByIdRequestNotFoundError"}}}},"500":{"description":"Server error. Something went wrong while processing the request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteMilestoneByIdRequestInternalServerError"}}}}}},"get":{"operationId":"get-contract-milestone-by-id","summary":"Retrieve a single milestone","description":"Retrieve a single milestone.\n **Token scopes**: `milestones:read`","tags":["subpackage_milestones"],"parameters":[{"name":"contract_id","in":"path","description":"Deel contract id.","required":true,"schema":{"type":"string"}},{"name":"milestone_id","in":"path","description":"ID of milestone to return","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/milestones_getContractMilestoneById_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}/off-cycle-payments":{"post":{"operationId":"create-contract-off-cycle-payment","summary":"Add off-cycle payment","description":"Add a new invoice line-item for the purpose of an off-cycle payment associated with a specific contract. This is typically used for exceptional payments outside the regular payment schedule.\n **Token scopes**: `off-cycle-payments:write`","tags":["subpackage_offCycle"],"parameters":[{"name":"contract_id","in":"path","description":"The unique identifier (ID) of the Deel contract for which the off-cycle payment is being created.","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":{"201":{"description":"The off-cycle payment was successfully created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/off-cycle_createContractOffCyclePayment_Response_201"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}},"requestBody":{"description":"Details of the off-cycle payment to be created.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ContractsContractIdOffCyclePaymentsPostRequestBodyContentApplicationJsonSchemaData"}}}}}}},"get":{"operationId":"get-contract-off-cycle-payments","summary":"List of off-cycle payments","description":"Retrieve a list of off-cycle payments for the specified contract ID. Off-cycle payments are payments made outside the regular payment schedule, often for exceptional or one-time expenses.\n **Token scopes**: `off-cycle-payments:read`","tags":["subpackage_offCycle"],"parameters":[{"name":"contract_id","in":"path","description":"The unique identifier (ID) of the Deel contract for which to retrieve off-cycle payments.","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 retrieval of off-cycle payments.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/off-cycle_getContractOffCyclePayments_Response_200"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}}}},"/contracts/{contract_id}/off-cycle-payments/{id}":{"get":{"operationId":"get-contract-off-cycle-payment-by-id","summary":"Retrieve a single off-cycle payment","description":"Retrieve a single off-cycle payment.\n **Token scopes**: `off-cycle-payments:read`","tags":["subpackage_offCycle"],"parameters":[{"name":"contract_id","in":"path","description":"Deel contract id.","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Deel off-cycle payment 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/off-cycle_getContractOffCyclePaymentById_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"}}}}}}},"/offboarding/tracker":{"get":{"operationId":"retrieve-offboarding-list","summary":"Retrieve offboarding list","description":"Retrieve offboarding list\n **Token scopes**: `contracts:read`, `people:read`","tags":["subpackage_offboarding"],"parameters":[{"name":"search","in":"query","description":"Search term to filter contracts by name or other attributes","required":false,"schema":{"type":"string"}},{"name":"hiring_types","in":"query","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/OffboardingTrackerGetParametersHiringTypesSchemaItems"}}},{"name":"progress_statuses","in":"query","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/OffboardingTrackerGetParametersProgressStatusesSchemaItems"}}},{"name":"limit","in":"query","description":"Number of results to return per page","required":false,"schema":{"type":"integer","default":20}},{"name":"sort_by","in":"query","description":"Field to sort by","required":false,"schema":{"$ref":"#/components/schemas/OffboardingTrackerGetParametersSortBy"}},{"name":"sort_order","in":"query","description":"Sorting order","required":false,"schema":{"$ref":"#/components/schemas/OffboardingTrackerGetParametersSortOrder"}},{"name":"pagination","in":"query","required":false,"schema":{"$ref":"#/components/schemas/OffboardingTrackerGetParametersPagination"}},{"name":"include_overview","in":"query","description":"Include an overview of the contract","required":false,"schema":{"type":"boolean","default":false}},{"name":"ignore_date_range","in":"query","description":"Ignore the default 45-day date range and retrieve all terminations","required":false,"schema":{"type":"boolean","default":false}},{"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 retrieved list of offboarding","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Offboarding_retrieveOffboardingList_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"}}}}}}},"/offboarding/tracker/{id}":{"get":{"operationId":"retrieve-termination-details","summary":"Retrieve termination details","description":"Retrieve termination details by tracker id\n **Token scopes**: `contracts:read`, `people:read`","tags":["subpackage_offboarding"],"parameters":[{"name":"id","in":"path","description":"Unique onboarding tracker identifier","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 retrieved offboarding details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Offboarding_retrieveTerminationDetails_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/RetrieveTerminationDetailsRequestInternalServerError"}}}}}}},"/offboarding/tracker/hris_profile/{oid}":{"get":{"operationId":"retrieve-termination-details-by-hris-profile-identifier","summary":"Retrieve termination details by HRIS profile identifier","description":"Retrieve termination details by hris profile oid\n **Token scopes**: `contracts:read`, `people:read`","tags":["subpackage_offboarding"],"parameters":[{"name":"oid","in":"path","description":"Unique hris profile oid","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 retrieved offboarding details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Offboarding_retrieveTerminationDetailsByHrisProfileIdentifier_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"}}}}}}},"/onboarding/tracker/hris_profile/{hris_profile_id}":{"get":{"operationId":"get-onboarding-details-by-employee-hris-profile-id-v-2026-01-01","summary":"Get onboarding details by employee HRIS profile ID","description":"Use this endpoint to retrieve a comprehensive overview of a worker's onboarding status, including their profile details, contract status, and checklist progress.\n **Token scopes**: `contracts:read`, `people:read`","tags":["subpackage_onboarding"],"parameters":[{"name":"hris_profile_id","in":"path","description":"The unique identifier of the employee HRIS profile.","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":"Onboarding overview","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Onboarding_getOnboardingDetailsByEmployeeHrisProfileId-v2026-01-01_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"}}}}}}},"/onboarding/tracker/{tracker_id}":{"get":{"operationId":"get-onboarding-details-by-onboarding-tracker-id-v-2026-01-01","summary":"Get onboarding details by onboarding tracker ID","description":"Use this endpoint to retrieve a comprehensive overview of a worker's onboarding status, including their profile details, contract status, and checklist progress.\n **Token scopes**: `contracts:read`, `people:read`","tags":["subpackage_onboarding"],"parameters":[{"name":"tracker_id","in":"path","description":"The unique identifier of the onboarding tracker.","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":"Onboarding overview","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Onboarding_getOnboardingDetailsByOnboardingTrackerId-v2026-01-01_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"}}}}}}},"/onboarding/tracker":{"get":{"operationId":"list-onboarding-employees-v-2026-01-01","summary":"List onboarding employees","description":"Returns a list of all workers currently going through the onboarding process, including contract details, HRIS profile information, current onboarding status, and onboarding due dates. Use this endpoint to monitor onboarding progress, track pending actions, and ensure deadlines are met.\n **Token scopes**: `contracts:read`, `people:read`","tags":["subpackage_onboarding"],"parameters":[{"name":"search","in":"query","description":"Search term to filter contracts by name or other attributes","required":false,"schema":{"type":"string"}},{"name":"contractOid","in":"query","description":"Search attribute to filter onboarding list by contract id","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"hiringTypes","in":"query","description":"Search attribute to filter onboarding list by hiring type","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/OnboardingTrackerGetParametersHiringTypesSchemaItems"}}},{"name":"progressStatuses","in":"query","description":"Search attribute to filter onboarding list by progress status","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/OnboardingTrackerGetParametersProgressStatusesSchemaItems"}}},{"name":"countries","in":"query","description":"Search attribute to filter onboarding list by country","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"teams","in":"query","description":"Search attribute to filter onboarding list by team","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"legalEntities","in":"query","description":"Search attribute to filter onboarding list by legal entity","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"hrisDirectManagers","in":"query","description":"Search attribute to filter onboarding list by HRIS direct manager","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"fromDate","in":"query","description":"Start date for filtering contracts","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"toDate","in":"query","description":"End date for filtering contracts","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"actions","in":"query","description":"Onboarding actions","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/OnboardingTrackerGetParametersActionsSchemaItems"}}},{"name":"limit","in":"query","description":"Number of results to return per page","required":false,"schema":{"type":"integer","default":20}},{"name":"sort_by","in":"query","description":"Field to sort by","required":false,"schema":{"$ref":"#/components/schemas/OnboardingTrackerGetParametersSortBy"}},{"name":"sort_order","in":"query","description":"Sorting order","required":false,"schema":{"$ref":"#/components/schemas/OnboardingTrackerGetParametersSortOrder"}},{"name":"cursor","in":"query","description":"Cursor for pagination","required":false,"schema":{"type":"string"}},{"name":"include_overview","in":"query","description":"Include an overview of the contract","required":false,"schema":{"type":"boolean","default":false}},{"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":"A list of onboarding and their details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Onboarding_listOnboardingEmployees-v2026-01-01_Response_200"}}}},"400":{"description":"Bad Request - Validation error or invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListOnboardingEmployees-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"}}}}}}},"/it/orders":{"get":{"operationId":"get-it-orders","summary":"List IT orders","description":"Retrieve a paginated list of all IT equipment orders for the organization. This is useful for reviewing both historical and current procurement requests to track overall equipment provisioning.  For more info, visit [Orders](https://developer.deel.com/docs/deel-it-api#orders).\n **Token scopes**: `it-orders:read`","tags":["subpackage_orders"],"parameters":[{"name":"cursor","in":"query","description":"Indicates where the next page of results starts, as returned in a paginated list response","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Return a page of results with given number of records","required":false,"schema":{"type":"integer","default":20}},{"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":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/orders_getITOrders_Response_200"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListItOrdersRequestBadRequestError"}}}},"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/ListItOrdersRequestInternalServerError"}}}}}}},"/it/orders/{order_id}":{"get":{"operationId":"get-it-order-by-id","summary":"Retrieve an IT order","description":"Retrieve detailed information about a single IT equipment order using its unique identifier. This allows you to track the order's status, review shipping details, and see the associated product.  For more info, visit [Orders](https://developer.deel.com/docs/deel-it-api#orders)\n **Token scopes**: `it-orders:read`","tags":["subpackage_orders"],"parameters":[{"name":"order_id","in":"path","description":"Unique identifier of the IT order","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":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/orders_getITOrderById_Response_200"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveAnItOrderRequestBadRequestError"}}}},"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/RetrieveAnItOrderRequestInternalServerError"}}}}}}},"/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/{hris_org_structure_id}":{"delete":{"operationId":"delete-an-org-structure-from-the-organization-v-2026-01-01","summary":"Delete an Org Structure from the Organization","description":"Delete an Org Structure from the Organization. Use the force flag to bypass validation checks and remove the structure even when profiles are still assigned to it.\n **Token scopes**: `organizations:write`","tags":["subpackage_organizationStructure"],"parameters":[{"name":"hris_org_structure_id","in":"path","description":"Org Structure","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_deleteAnOrgStructureFromTheOrganization-v2026-01-01_Response_200"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteAnOrgStructureFromTheOrganization-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/DeleteAnOrgStructureFromTheOrganization-v2026-01-01RequestInternalServerError"}}}}}},"get":{"operationId":"fetch-an-org-structure-from-the-organization-v-2026-01-01","summary":"Fetch an Org Structure from the Organization","description":"Retrieves detailed information about a specific organizational structure including its teams and roles.\n **Token scopes**: `organizations:read`","tags":["subpackage_organizationStructure"],"parameters":[{"name":"hris_org_structure_id","in":"path","description":"HRIS Organization Structure 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_fetchAnOrgStructureFromTheOrganization-v2026-01-01_Response_200"}}}},"400":{"description":"Bad request - The provided hrisOrgStructureId is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FetchAnOrgStructureFromTheOrganization-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 - No organization structure exists for the provided ID.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FetchAnOrgStructureFromTheOrganization-v2026-01-01RequestNotFoundError"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}}},"patch":{"operationId":"update-an-existing-hris-org-structure-v-2026-01-01","summary":"Update an existing HRIS Org Structure","description":"Update an existing HRIS Org Structure including its name, settings, and teams hierarchy.\n **Token scopes**: `organizations:write`","tags":["subpackage_organizationStructure"],"parameters":[{"name":"hris_org_structure_id","in":"path","description":"Org Structure","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_updateAnExistingHrisOrgStructure-v2026-01-01_Response_200"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAnExistingHrisOrgStructure-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/UpdateAnExistingHrisOrgStructure-v2026-01-01RequestInternalServerError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/HrisOrganizationStructuresHrisOrgStructureIdPatchRequestBodyContentApplicationJsonSchemaData"}}}}}}}},"/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"]}}}}}},"/organizations/tasks":{"get":{"operationId":"list-organization-tasks-v-2026-03-03","summary":"List organization tasks","description":"Returns a paginated list of tasks for the current organization. Intended for client users with organization.manage permission (Example: org admins). Use this to see all tasks for the organization, not only those assigned to the caller. Supports filtering by status, category, search, and external ID, and either offset/limit or cursor-based pagination.\n **Token scopes**: `tasks:read`","tags":["subpackage_organizationTasks"],"parameters":[{"name":"statuses","in":"query","description":"Filter by task statuses.","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/OrganizationsTasksGetParametersStatusesSchemaItems"}}},{"name":"category","in":"query","description":"Filter by task category.","required":false,"schema":{"$ref":"#/components/schemas/OrganizationsTasksGetParametersCategory"}},{"name":"search","in":"query","description":"Search string for task display name or description.","required":false,"schema":{"type":"string"}},{"name":"external_id","in":"query","description":"Filter by external ID (for tasks created with an external reference).","required":false,"schema":{"type":"string"}},{"name":"cursor","in":"query","description":"Opaque cursor for cursor-based pagination. When provided, use with limit only (do not use offset).","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Maximum number of records to return (1-100).","required":false,"schema":{"type":"integer","default":20}},{"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. Returns tasks for the organization","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Organization Tasks_listOrganizationTasks-v2026-03-03_Response_200"}}}},"400":{"description":"Bad request Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListOrganizationTasks-v2026-03-03RequestBadRequestError"}}}},"401":{"description":"Invalid, expired, or missing API token.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListOrganizationTasks-v2026-03-03RequestUnauthorizedError"}}}},"403":{"description":"User does not have permission Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListOrganizationTasks-v2026-03-03RequestForbiddenError"}}}},"404":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"422":{"description":"Validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListOrganizationTasks-v2026-03-03RequestUnprocessableEntityError"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListOrganizationTasks-v2026-03-03RequestInternalServerError"}}}}}}},"/organizations/children":{"post":{"operationId":"create-organization-child","summary":"Create child organization","description":"Creates a new organization along with:\n\n- An API token scoped to the new organization. This token can be used to perform API operations on behalf of the new organization.\n- A default group for the organization.\n- A hierarchy linking the authenticated organization (the Parent Organization) with the new one (the Child Organization).\n- A user from the parent organization who will be assigned to the child organization.\n\nThis endpoint sets up the bare minimum required for the new organization to be operational immediately after creation.\n **Token scopes**: `organizations:write`","tags":["subpackage_organizations"],"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":"Operation successful. The child organization was created successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/organizations_createOrganizationChild_Response_201"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateChildOrganizationRequestBadRequestError"}}}},"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/OrganizationsChildrenPostRequestBodyContentApplicationJsonSchemaData","description":"The request payload."}},"required":["data"]}}}}}},"/roles":{"post":{"operationId":"create-organization-role","summary":"Create organization custom role.","description":"Create organization custom role.\n **Token scopes**: `organizations:write`","tags":["subpackage_organizations"],"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/Organizations_CreateOrganizationRole_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/RolesPostRequestBodyContentApplicationJsonSchemaData"}}}}}}},"get":{"operationId":"get-the-roles-of-the-current-organization-v-2026-01-01","summary":"Get the roles of the current organization.","description":"Retrieve a list of roles assigned within the current organization. Each role has a unique identifier, name, scope, and optional HRIS structure ID. This helps determine the types of roles within the organization and their corresponding access levels.\n **Token scopes**: `organizations:read`","tags":["subpackage_organizations"],"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 retrieval of the organization roles.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Organizations_getTheRolesOfTheCurrentOrganization-v2026-01-01_Response_200"}}}},"400":{"description":"Bad request. The request was malformed or missing required parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetTheRolesOfTheCurrentOrganization-v2026-01-01RequestBadRequestError"}}}},"401":{"description":"Unauthorized. The request is missing authentication credentials or the credentials provided are invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetTheRolesOfTheCurrentOrganization-v2026-01-01RequestUnauthorizedError"}}}},"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. An error occurred while processing the request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetTheRolesOfTheCurrentOrganization-v2026-01-01RequestInternalServerError"}}}}}}},"/organizations":{"get":{"operationId":"get-organizations","summary":"Get Current Organization","description":"Retrieve details of the current organization associated with the authenticated user. The organization is automatically detected based on the authentication token provided in the request.\n **Token scopes**: `organizations:read`","tags":["subpackage_organizations"],"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 retrieval of the organization details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/organizations_getOrganizations_Response_200"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"401":{"description":"Unauthorized. The request is missing authentication credentials or the credentials provided are invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOrganizationsRequestUnauthorizedError"}}}},"403":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"404":{"description":"Organization not found. The current organization associated with the authentication token could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOrganizationsRequestNotFoundError"}}}},"500":{"description":"Internal server error. An error occurred on the server while processing the request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOrganizationsRequestInternalServerError"}}}}}}},"/teams":{"get":{"operationId":"get-teams","summary":"Get Team List","description":"Retrieve a list of teams within the organization associated with the authenticated user. This list provides basic details about each team, including the team ID and name.\n **Token scopes**: `organizations:read`","tags":["subpackage_organizations"],"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 retrieval of the teams in the organization.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Organizations_getTeams_Response_200"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"401":{"description":"Unauthorized. The request is missing authentication credentials or the credentials provided are invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetTeamsRequestUnauthorizedError"}}}},"403":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"404":{"description":"No teams found. There are no teams associated with the current organization.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetTeamsRequestNotFoundError"}}}},"500":{"description":"Internal server error. An error occurred on the server while processing the request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetTeamsRequestInternalServerError"}}}}}}},"/departments":{"get":{"operationId":"get-departments","summary":"Retrieve Departments","description":"Retrieve a list of departments within the organization associated with the authenticated user. Each department contains its unique identifier, name, and optionally, the parent department if applicable.\n **Token scopes**: `organizations:read`","tags":["subpackage_organizations"],"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 retrieval of the list of departments.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Organizations_GetDepartments_Response_200"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"401":{"description":"Unauthorized. The request is missing authentication credentials or the credentials provided are invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetDepartmentsRequestUnauthorizedError"}}}},"403":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"404":{"description":"No departments found. There are no departments associated with the current organization.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetDepartmentsRequestNotFoundError"}}}},"500":{"description":"Internal server error. An error occurred on the server while processing the request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetDepartmentsRequestInternalServerError"}}}}}}},"/working-locations":{"get":{"operationId":"retrieve-working-locations","summary":"Retrieve working locations","description":"Retrieves the list of available work location labels configured in the HRIS system for the organization.\n **Token scopes**: `organizations:read`","tags":["subpackage_organizations"],"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/Organizations_retrieveWorkingLocations_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"}}}}}}},"/roles/{roleId}":{"patch":{"operationId":"update-organization-role","summary":"Update organization custom role","description":"undefined\n **Token scopes**: `organizations:write`","tags":["subpackage_organizations"],"parameters":[{"name":"roleId","in":"path","description":"ID of the role","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/Organizations_UpdateOrganizationRole_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/RolesRoleIdPatchRequestBodyContentApplicationJsonSchemaData"}}}}}}}},"/payouts/employees/methods":{"post":{"operationId":"add-edit-bank-details","summary":"Add/Edit Bank Details","description":"Add/Edit Bank Details\n **Token scopes**: `worker:read`, `worker:write`","tags":["subpackage_payouts"],"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":"Add Bank Details / Edit Bank Details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Payouts_addEditBankDetails_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/PayoutsEmployeesMethodsPostRequestBodyContentApplicationJsonSchemaData","description":"Request data"}}}}}}},"get":{"operationId":"get-bank-details","summary":"Get Bank Details","description":"Get Bank Details\n **Token scopes**: `worker:read`, `worker:write`","tags":["subpackage_payouts"],"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":"Get Bank Details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Payouts_getBankDetails_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"}}}}}}},"/payouts/auto-withdrawal-setting":{"patch":{"operationId":"change-the-auto-withdrawal-setting-v-2026-01-01","summary":"Change the auto-withdrawal setting","description":"Turn auto-withdrawal on or off and choose a method to withdraw to\n **Token scopes**: `worker:write`","tags":["subpackage_payouts"],"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":"Successfully update auto-withdrawal settings","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Payouts_changeTheAutoWithdrawalSetting-v2026-01-01_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"}}}}},"requestBody":{"description":"Change the auto withdrawal setting","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PayoutsAutoWithdrawalSettingPatchRequestBodyContentApplicationJsonSchemaData"}}}}}}},"get":{"operationId":"get-the-auto-withdrawal-setting","summary":"Get the auto-withdrawal setting","description":"Get whether auto-withdrawal is turned on and which method is selected to withdraw to\n **Token scopes**: `worker:read`","tags":["subpackage_payouts"],"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":"Auto-withdrawal setting result","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Payouts_getTheAutoWithdrawalSetting_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"}}}}}}},"/payouts/contractors/methods":{"post":{"operationId":"create-bank-transfer-method","summary":"Create a bank transfer method","description":"Creates a bank transfer method with dynamic payload properties based on the selected option.\n **Token scopes**: `worker:read`, `worker:write`","tags":["subpackage_payouts"],"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":"Bank transfer method created successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Payouts_createBankTransferMethod_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/PayoutsContractorsMethodsPostRequestBodyContentApplicationJsonSchemaData"}},"required":["data"]}}}}},"get":{"operationId":"get-payout-methods","summary":"Fetch all payout methods","description":"Retrieves all payout methods associated with the current user or account. Supports filtering by default method status.\n **Token scopes**: `worker:read`, `worker:write`","tags":["subpackage_payouts"],"parameters":[{"name":"is_default","in":"query","description":"Filter by whether the method is default. If true, only default methods will be returned.","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":"List of payout methods retrieved successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Payouts_getPayoutMethods_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"}}}}}}},"/payouts/employees/methods/{id}":{"delete":{"operationId":"delete-bank-details","summary":"Delete Bank Details","description":"Delete Bank Details\n **Token scopes**: `worker:read`, `worker:write`","tags":["subpackage_payouts"],"parameters":[{"name":"id","in":"path","description":"method 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":"Delete Bank Details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Payouts_deleteBankDetails_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"}}}}}}},"/payouts/employees/methods/bank_transfers/requirements":{"post":{"operationId":"dynamic-requirements","summary":"Dynamic Requirements","description":"Dynamic Requirements\n **Token scopes**: `worker:read`, `worker:write`","tags":["subpackage_payouts"],"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":"Dynamic Requirements","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Payouts_dynamicRequirements_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/PayoutsEmployeesMethodsBankTransfersRequirementsPostRequestBodyContentApplicationJsonSchemaData","description":"Request data"}}}}}}}},"/payouts/contractors/methods/bank_transfers/requirements":{"get":{"operationId":"get-bank-transfer-requirements","summary":"Get bank transfer requirements","description":"Retrieve requireements for bank transfer method creation\n **Token scopes**: `worker:read`, `worker:write`","tags":["subpackage_payouts"],"parameters":[{"name":"country","in":"query","description":"Country code","required":true,"schema":{"type":"string"}},{"name":"currency","in":"query","description":"Currency code","required":true,"schema":{"type":"string"}},{"name":"amount","in":"query","description":"Amount for calculating fees, if not provided, the default amount of 100.00 is used","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/Payouts_getBankTransferRequirements_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"}}}}}}},"/payouts/contractors/methods/bank_transfers/supported_routes":{"get":{"operationId":"get-bank-transfer-supported-routes","summary":"Get bank transfer supported routes for contractor","description":"Get all bank transfer supported routes for specific contractor.\n **Token scopes**: `worker:read`, `worker:write`","tags":["subpackage_payouts"],"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/Payouts_getBankTransferSupportedRoutes_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"}}}}}}},"/payouts/balances":{"get":{"operationId":"list-contractor-balances","summary":"List Contractor Balances","description":"Retrieves the total available balances for the authenticated contractor, broken down by currency and in total.\n **Token scopes**: `worker:read`","tags":["subpackage_payouts"],"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. Returns the contractor's balances.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Payouts_listContractorBalances_Response_200"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PayoutsBalancesGetResponsesContentApplicationJsonSchemaItems"}}}}},"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"}}}}}}},"/payouts/withdrawals":{"post":{"operationId":"request-to-withdraw-funds","summary":"Request to withdraw funds","description":"Request to withdraw some or all of the available funds to a method\n **Token scopes**: `worker:write`","tags":["subpackage_payouts"],"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":"Withdrawal successfully initiated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Payouts_requestToWithdrawFunds_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":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestToWithdrawFundsRequestInternalServerError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PayoutsWithdrawalsPostRequestBodyContentApplicationJsonSchemaData"}},"required":["data"]}}}}}},"/payouts/contractors/methods/{id}":{"put":{"operationId":"update-bank-transfer-method","summary":"Update a bank transfer method","description":"Updates a bank transfer method\n **Token scopes**: `worker:read`, `worker:write`","tags":["subpackage_payouts"],"parameters":[{"name":"id","in":"path","description":"Method unique identifier","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":"Bank transfer method created successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Payouts_updateBankTransferMethod_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/PayoutsContractorsMethodsIdPutRequestBodyContentApplicationJsonSchemaData"}},"required":["data"]}}}}}},"/payouts/contractors/settings/auto_withdraw":{"post":{"operationId":"update-auto-withdraw-setting","summary":"Update auto withdraw setting for contractor","description":"Updates auto withdraw setting for contractor\n **Token scopes**: `worker:read`, `worker:write`","tags":["subpackage_payouts"],"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":"Auto withdraw setting updated successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Payouts_updateAutoWithdrawSetting_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/PayoutsContractorsSettingsAutoWithdrawPostRequestBodyContentApplicationJsonSchemaData"}},"required":["data"]}}}}}},"/benefits/legal-entities/{id}/pay-stub":{"get":{"operationId":"get-pay-stub-from-employees-from-organization-integrated-with-external-benefits-vendor-v-2026-01-01","summary":"Get pay stub from employees from organization integrated with external benefits vendor","description":"Returns pay stub records for employees within a legal entity integrated with an external benefits vendor, with support for filtering by payroll date range, status, and offset-based pagination.\n **Token scopes**: `organizations:read`","tags":["subpackage_payroll"],"parameters":[{"name":"id","in":"path","description":"Id from the legal entity to fetch data","required":true,"schema":{"type":"string"}},{"name":"payroll_start_date","in":"query","description":"Payroll start date","required":false,"schema":{"type":"string"}},{"name":"payroll_end_date","in":"query","description":"Payroll end date","required":false,"schema":{"type":"string"}},{"name":"status","in":"query","description":"Payroll status","required":false,"schema":{"type":"string"}},{"name":"items_per_page","in":"query","description":"Items per page","required":false,"schema":{"type":"integer","default":100}},{"name":"offset","in":"query","description":"Items to be skipped when searching","required":false,"schema":{"type":"integer","default":0}},{"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/Payroll_getPayStubFromEmployeesFromOrganizationIntegratedWithExternalBenefitsVendor-v2026-01-01_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"}}}}}}},"/benefits/legal-entities/{id}/year-to-date-pay":{"get":{"operationId":"get-year-to-date-pay","summary":"Get year to date payment for benefits 401k.","description":"Get year to date from employees from organization integrated with external benefits vendor\n **Token scopes**: `organizations:read`","tags":["subpackage_payroll"],"parameters":[{"name":"id","in":"path","description":"Id from the legal entity to fetch data","required":true,"schema":{"type":"string"}},{"name":"date_start","in":"query","description":"Start date to fetch aggregated pay data","required":true,"schema":{"type":"string"}},{"name":"date_end","in":"query","description":"End date to fetch aggregated pay data","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/Payroll_getYearToDatePay_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"}}}}}}},"/gp/workers/{id}/payslips":{"get":{"operationId":"get-gp-worker-payslips","summary":"Retrieve employee payslips","description":"Returns a list of payslips for a Global Payroll (GP) employee, including each payslip's date range and current status. Use this endpoint to display payslip history or verify that payslips have been published before initiating a download. Requires the worker id (UUID), which can be obtained from the List GPworkers endpoint. Each payslip in the response includes an id that is required for the download endpoint. Supports only GP contract types.\n **Token scopes**: `payslips:read`","tags":["subpackage_payslips"],"parameters":[{"name":"id","in":"path","description":"Unique identifier for the 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":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/payslips_getGPWorkerPayslips_Response_200"}}}},"400":{"description":"Bad Request - Validation error or invalid parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveEmployeePayslips-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"}}}}}}},"/benefits/legal-entities/{legal_entity_id}/paystubs":{"get":{"operationId":"get-paystubs-from-legal-entity-integrated-with-external-benefits-vendor-v-2026-01-01","summary":"Get paystubs from legal entity integrated with external benefits vendor","description":"Returns paginated paystubs for a legal entity that is integrated with an external benefits vendor. Results can be filtered by payroll state and date range; paystubs in the `OPEN` state do not include employee-level detail.\n **Token scopes**: `benefits:read`","tags":["subpackage_paystubs"],"parameters":[{"name":"legal_entity_id","in":"path","description":"Id from the legal entity to fetch data","required":true,"schema":{"type":"string"}},{"name":"states","in":"query","description":"Payroll states: OPEN | LOCKED | CLOSED (OPEN doesn't have `employees` info)","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/BenefitsLegalEntitiesLegalEntityIdPaystubsGetParametersStatesSchemaItems"}}},{"name":"date_start","in":"query","description":"Start date to fectch the paystubs from","required":false,"schema":{"type":"string"}},{"name":"date_end","in":"query","description":"End date to fectch the paystubs","required":false,"schema":{"type":"string"}},{"name":"items_per_page","in":"query","description":"Items per page","required":false,"schema":{"type":"integer","default":10}},{"name":"cursor","in":"query","description":"The last fetched id to start querying from","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.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Paystubs_getPaystubsFromLegalEntityIntegratedWithExternalBenefitsVendor-v2026-01-01_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":{"post":{"operationId":"create-a-direct-employee","summary":"Create a direct employee","description":"Create employee hired under your own entity to Deel's HRIS. Manage your employee through Deel and export a payroll report to your own providers.\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_createADirectEmployee_Response_201"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateADirectEmployeeRequestBadRequestError"}}}},"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/CreateADirectEmployeeRequestInternalServerError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PeoplePostRequestBodyContentApplicationJsonSchemaData"}},"required":["data"]}}}}},"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"}}}}}}},"/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/me":{"get":{"operationId":"get-my-current-personal-profile","summary":"Get my current personal profile","description":"Retrieve the current user's profile.\n **Token scopes**: `worker:read`, `people:read`","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":{"200":{"description":"Successful operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/People_getMyCurrentPersonalProfile_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/{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"]}}}}}},"/benefits/legal-entities/{id}/benefits/401k/activate":{"post":{"operationId":"activate-the-401-k-integration-for-the-legal-entity-v-2026-01-01","summary":"Activate the 401k integration for the legal entity","description":"Activate the 401k integration for the legal entity\n **Token scopes**: `benefits:write`","tags":["subpackage_plans401K"],"parameters":[{"name":"id","in":"path","description":"Id from the legal entity to activate 401k integration","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/Plans 401K_activateThe401KIntegrationForTheLegalEntity-v2026-01-01_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"}}}}}}},"/benefits/legal-entities/{id}/401k/plans/clean-up":{"post":{"operationId":"clean-up-plan-for-a-given-legal-entity-v-2026-01-01","summary":"Clean up plan for a given legal entity","description":"Clean up plan for a given legal entity\n **Token scopes**: `benefits:write`","tags":["subpackage_plans401K"],"parameters":[{"name":"id","in":"path","description":"Id from the legal entity to clean up","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":{"202":{"description":"Request accepted, processing asynchronously.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Plans 401K_cleanUpPlanForAGivenLegalEntity-v2026-01-01_Response_202"}}}},"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"}}}}}}},"/benefits/legal-entities/{legal_entity_id}/401k/plans":{"post":{"operationId":"create-401-k-plan-for-legal-entity-v-2026-01-01","summary":"Create 401k plan for legal entity","description":"Create a new 401k plan for existing provider to legal entity\n **Token scopes**: `benefits:write`","tags":["subpackage_plans401K"],"parameters":[{"name":"legal_entity_id","in":"path","description":"Id from the legal entity to receive a new 401k plan","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/Plans 401K_create401KPlanForLegalEntity-v2026-01-01_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":{"name":{"type":"string","description":"Name of the 401K plan."},"details":{"$ref":"#/components/schemas/BenefitsLegalEntitiesLegalEntityId401KPlansPostRequestBodyContentApplicationJsonSchemaDetails","description":"Object containing additional information about the 401K plan."},"start_date":{"type":"string","format":"date","description":"Start date of the plan."},"contribution_type":{"$ref":"#/components/schemas/BenefitsLegalEntitiesLegalEntityId401KPlansPostRequestBodyContentApplicationJsonSchemaContributionType","description":"Type of contribution for the 401K plan."},"contribution_value":{"type":"number","format":"double","description":"Value of the contribution if type is percent or amount."},"contribution_value_for_match_rate":{"type":"array","items":{"$ref":"#/components/schemas/BenefitsLegalEntitiesLegalEntityId401KPlansPostRequestBodyContentApplicationJsonSchemaContributionValueForMatchRateItems"},"description":"Array of objects containing limits and rates for match rate contribution type."}},"required":["name","start_date","contribution_type"]}}}}}},"/benefits/legal-entities/{id}/401k/plans":{"get":{"operationId":"get-401-k-plans-for-legal-entity-v-2026-01-01","summary":"Get 401k plans for legal entity","description":"Get 401k plans legal entity\n **Token scopes**: `benefits:read`","tags":["subpackage_plans401K"],"parameters":[{"name":"id","in":"path","description":"Id from the legal entity to fetch 401k plans","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/Plans 401K_get401KPlansForLegalEntity-v2026-01-01_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"}}}}}}},"/benefits/legal-entities/{legal_entity_id}/401k/plans/{plan_id}":{"put":{"operationId":"update-401-k-plan-v-2026-01-01","summary":"Update 401k plan","description":"Update 401k plan\n **Token scopes**: `benefits:write`","tags":["subpackage_plans401K"],"parameters":[{"name":"legal_entity_id","in":"path","description":"Id from the legal entity to update a 401k plan","required":true,"schema":{"type":"string"}},{"name":"plan_id","in":"path","description":"401K plan 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/Plans 401K_update401KPlan-v2026-01-01_Response_200"}}}},"400":{"description":"Bad Request - Invalid input parameters or validation error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Update401KPlan-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 specified plan or legal entity was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Update401KPlan-v2026-01-01RequestNotFoundError"}}}},"500":{"description":"Internal Server Error - An unexpected error occurred on the server.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Update401KPlan-v2026-01-01RequestInternalServerError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BenefitsLegalEntitiesLegalEntityId401KPlansPlanIdPutRequestBodyContentApplicationJsonSchemaData","description":"Schema for the 401K Guideline Plan request body."}},"required":["data"]}}}}}},"/it/policies":{"get":{"operationId":"get-it-policies","summary":"List IT hardware policies","description":"Retrieve a list of all available IT hardware policies. These policies define the equipment that can be ordered.  For more info, visit [IT policies](https://developer.deel.com/docs/deel-it-api#it-policies).\n **Token scopes**: `it-policies:read`","tags":["subpackage_policies"],"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":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/policies_getITPolicies_Response_200"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListItHardwarePoliciesRequestBadRequestError"}}}},"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/ListItHardwarePoliciesRequestInternalServerError"}}}}}}},"/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/{hris_profile_id}":{"get":{"operationId":"fetch-hris-positions-from-a-hris-profile-v-2026-01-01","summary":"Fetch HrisPositions from a HrisProfile","description":"Retrieves all positions assigned to a given HRIS profile, including the associated role, team, and organization structure for each position.\n **Token scopes**: `profile:read`","tags":["subpackage_positions"],"parameters":[{"name":"hris_profile_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/Positions_fetchHrisPositionsFromAHrisProfile-v2026-01-01_Response_200"}}}},"400":{"description":"Bad request - The provided hrisProfileId or hrisOrgStructureId is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FetchHrisPositionsFromAHrisProfile-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 - No HRIS profile exists for the provided ID.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FetchHrisPositionsFromAHrisProfile-v2026-01-01RequestNotFoundError"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}}}},"/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"}}}},"/profiles":{"patch":{"operationId":"profiles","summary":"Profiles","description":"Edit Profie\n **Token scopes**: `profile:write`, `profile:read`","tags":[""],"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":"Successfully updated profile.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/profiles_Response_200"}}}},"400":{"description":"Invalid request parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProfilesRequestBadRequestError"}}}},"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":"Update profile information for the authenticated user","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ProfilesPatchRequestBodyContentApplicationJsonSchemaData"}},"required":["data"]}}}}}},"/timesheets/presets":{"post":{"operationId":"create-timesheets-preset","summary":"Create Hourly Report Preset","description":"Create a new hourly report preset.\n **Token scopes**: `timesheets:write`","tags":["subpackage_projects"],"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/Projects_createTimesheetsPreset_Response_201"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateHourlyReportPresetRequestBadRequestError"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateHourlyReportPresetRequestForbiddenError"}}}},"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/TimesheetsPresetsPostRequestBodyContentApplicationJsonSchemaData"}},"required":["data"]}}}}}},"/timesheets/root-presets":{"post":{"operationId":"create-root-timesheets-preset","summary":"Create Hourly Report Root Preset","description":"Create a new hourly report root preset.\n **Token scopes**: `timesheets:write`","tags":["subpackage_projects"],"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/Projects_createRootTimesheetsPreset_Response_200"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateHourlyReportRootPresetRequestBadRequestError"}}}},"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":{"file":{"type":["string","null"],"format":"binary","description":"Optional file attachment for the root preset"},"type":{"$ref":"#/components/schemas/TimesheetsRootPresetsPostRequestBodyContentApplicationJsonSchemaType","description":"The type of preset, RATE – indicates a preset that overrides the default contract rate, TRACKING - used exclusively for tracking, applying the default contract rate"},"title":{"type":"string","description":"The title of the hourly report root preset (maximum 255 characters)"},"description":{"type":"string","description":"Detailed description of the root preset's purpose and usage (maximum 30000 characters)"},"hourly_report_presets":{"type":"array","items":{"$ref":"#/components/schemas/TimesheetsRootPresetsPostRequestBodyContentApplicationJsonSchemaHourlyReportPresetsItems"},"description":"Array of preset configurations to be created along with the root preset"},"hourly_report_presets_processing_type":{"$ref":"#/components/schemas/TimesheetsRootPresetsPostRequestBodyContentApplicationJsonSchemaHourlyReportPresetsProcessingType","description":"Determines whether presets should be processed synchronously or asynchronously"}},"required":["title"]}}}}},"get":{"operationId":"get-hourly-report-root-presets","summary":"Get Hourly Report Root Presets","description":"Retrieve a list of hourly report root presets.\n **Token scopes**: `timesheets:read`","tags":["subpackage_projects"],"parameters":[{"name":"limit","in":"query","description":"Maximum number of items to return per page (max: 100)","required":false,"schema":{"type":"integer","default":10}},{"name":"order_by","in":"query","description":"Field to order the results by","required":false,"schema":{"$ref":"#/components/schemas/TimesheetsRootPresetsGetParametersOrderBy"}},{"name":"order_direction","in":"query","description":"Direction to order the results (ascending or descending)","required":false,"schema":{"$ref":"#/components/schemas/TimesheetsRootPresetsGetParametersOrderDirection"}},{"name":"work_statement_statuses","in":"query","description":"Filter results by work statement status","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"cursor","in":"query","description":"Pagination cursor for fetching the next page of results","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.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Projects_getHourlyReportRootPresets_Response_200"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetHourlyReportRootPresetsRequestBadRequestError"}}}},"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"}}}}}}},"/timesheets/presets/{id}":{"delete":{"operationId":"delete-timesheets-preset","summary":"Delete Hourly Report Preset","description":"Delete an existing hourly report preset.\n **Token scopes**: `timesheets:write`","tags":["subpackage_projects"],"parameters":[{"name":"id","in":"path","description":"The unique identifier of the hourly report preset to delete","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/Projects_deleteTimesheetsPreset_Response_200"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteHourlyReportPresetRequestBadRequestError"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteHourlyReportPresetRequestForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteHourlyReportPresetRequestNotFoundError"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}}},"get":{"operationId":"get-timesheets-preset-by-id","summary":"Get Hourly Report Preset by ID","description":"Retrieve a specific hourly report preset by its ID.\n **Token scopes**: `timesheets:read`","tags":["subpackage_projects"],"parameters":[{"name":"id","in":"path","description":"The unique identifier of the hourly report preset to retrieve","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/Projects_getTimesheetsPresetById_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":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetHourlyReportPresetByIdRequestForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetHourlyReportPresetByIdRequestNotFoundError"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}}},"patch":{"operationId":"update-timesheets-preset","summary":"Update Hourly Report Preset","description":"Update an existing hourly report preset.\n **Token scopes**: `timesheets:write`","tags":["subpackage_projects"],"parameters":[{"name":"id","in":"path","description":"The unique identifier of the hourly report preset to update","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/Projects_updateTimesheetsPreset_Response_200"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateHourlyReportPresetRequestBadRequestError"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateHourlyReportPresetRequestForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateHourlyReportPresetRequestNotFoundError"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/TimesheetsPresetsIdPatchRequestBodyContentApplicationJsonSchemaData"}},"required":["data"]}}}}}},"/contracts/{contract_id}/timesheets/presets":{"get":{"operationId":"get-contract-timesheets-presets","summary":"Get Hourly Report Presets","description":"Retrieve hourly report presets for a given contract and work statement.\n **Token scopes**: `timesheets:read`","tags":["subpackage_projects"],"parameters":[{"name":"contract_id","in":"path","description":"ID of the Deel contract","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"work_statement_id","in":"query","description":"ID of the work statement (optional)","required":false,"schema":{"type":"string","format":"uuid"}},{"name":"order_by","in":"query","description":"Field to order results by (title or created_at)","required":false,"schema":{"type":"string","default":"title"}},{"name":"order_direction","in":"query","description":"Direction of ordering (ASC or DESC)","required":false,"schema":{"type":"string","default":"ASC"}},{"name":"cursor","in":"query","description":"Pagination cursor for fetching next set of results","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Number of results to return per page","required":false,"schema":{"type":"integer","default":100}},{"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/Projects_getContractTimesheetsPresets_Response_200"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetHourlyReportPresetsRequestBadRequestError"}}}},"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"}}}}}}},"/timesheets/root-presets/{id}":{"get":{"operationId":"get-hourly-report-root-preset-by-id","summary":"Get Hourly Report Root Preset by ID","description":"Retrieve a specific hourly report root preset by its ID.\n **Token scopes**: `timesheets:read`","tags":["subpackage_projects"],"parameters":[{"name":"id","in":"path","description":"The unique identifier of the hourly report root preset to retrieve","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/Projects_getHourlyReportRootPresetById_Response_200"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetHourlyReportRootPresetByIdRequestBadRequestError"}}}},"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":{"$ref":"#/components/schemas/GetHourlyReportRootPresetByIdRequestNotFoundError"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}}}},"/gp/reports/{id}/gross_to_net/csv":{"get":{"operationId":"get-gp-report-gross-to-net-csv","summary":"Download gross to net report","description":"Download global payroll reports detailing gross-to-net calculations.\n **Token scopes**: `global-payroll:read`","tags":["subpackage_reports"],"parameters":[{"name":"id","in":"path","description":"Id of the gp payroll report.","required":true,"schema":{"type":"string"}},{"name":"currency","in":"query","description":"Currency to be used in the report calculation.","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.","content":{"application/json":{"schema":{"type":"object","properties":{}}}}},"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"}}}}}}},"/reports/payroll/cycles/{cycle_id}/gross-to-net":{"get":{"operationId":"gets-g-2-n-report-data-for-a-given-payroll-cycle-by-its-id-v-2026-01-01","summary":"Gets G2N report data for a given payroll cycle by it's ID.","description":"This endpoint gets categorized G2N data (including category group, category, sub-category and label) for each contract within a given payroll cycle for the provided id.\n **Token scopes**: `payslips:read`","tags":["subpackage_reports"],"parameters":[{"name":"cycle_id","in":"path","description":"The unique identifier for the payroll event.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"limit","in":"query","description":"Maximum number of items to return. Defaults to 20.","required":false,"schema":{"type":"integer","default":20}},{"name":"cursor","in":"query","description":"Cursor for pagination of results.","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.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Reports_getsG2NReportDataForAGivenPayrollCycleByItsId-v2026-01-01_Response_200"}}}},"400":{"description":"Bad Request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetsG2NReportDataForAGivenPayrollCycleByItsId-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":"Resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetsG2NReportDataForAGivenPayrollCycleByItsId-v2026-01-01RequestNotFoundError"}}}},"500":{"description":"Internal Server Error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetsG2NReportDataForAGivenPayrollCycleByItsId-v2026-01-01RequestInternalServerError"}}}}}}},"/gp/reports/{id}/gross_to_net":{"get":{"operationId":"get-gp-report-gross-to-net","summary":"List gross-to-net report.","description":"Get a list of global payroll reports detailing gross-to-net calculations. Supports pagination through limit and offset query parameters.\n **Token scopes**: `global-payroll:read`","tags":["subpackage_reports"],"parameters":[{"name":"id","in":"path","description":"Id of the gp payroll report.","required":true,"schema":{"type":"string"}},{"name":"currency","in":"query","description":"Currency to be used in the report calculation.","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","description":"Maximum number of records to return.","required":false,"schema":{"type":"number","format":"double"}},{"name":"offset","in":"query","description":"Offset/index of record for the next page of records to return.","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/reports_getGPReportGrossToNet_Response_200"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListGrossToNetReportRequestBadRequestError"}}}},"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"}}}}}}},"/gp/legal-entities/{legal_entity_id}/reports":{"get":{"operationId":"get-gp-legal-entity-reports","summary":"List payroll events by legal entity","description":"Use this endpoint to retrieve payroll events for a specific legal entity when preparing payroll reports or auditing pay cycles. This operation is read-only and does not modify any data.\n **Token scopes**: `global-payroll:read`","tags":["subpackage_reports"],"parameters":[{"name":"legal_entity_id","in":"path","description":"Unique identifier for the legal entity.","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/reports_getGPLegalEntityReports_Response_200"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListPayrollEventsByLegalEntityRequestBadRequestError"}}}},"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"}}}}}}},"/screenings/manual-verification":{"post":{"operationId":"create-manual-verification","summary":"Create manual verification screening","description":"Use this endpoint to create a manual identity verification submission (in case automated one has failed multiple times or document country is not supported by automated solution)\n **Token scopes**: `worker:write`","tags":["subpackage_screenings"],"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/screenings_createManualVerification_Response_201"}}}},"400":{"description":"Bad Request - Validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateManualVerificationScreeningRequestBadRequestError"}}}},"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"}}}},"409":{"description":"Conflict - There is an existing name change screening pending","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateManualVerificationScreeningRequestConflictError"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}},"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"back":{"type":"string","format":"binary","description":"The back side of the document"},"front":{"type":"string","format":"binary","description":"The front side of the document"},"additional":{"type":"string","format":"binary","description":"An additional document"},"document_type":{"$ref":"#/components/schemas/ScreeningsManualVerificationPostRequestBodyContentMultipartFormDataSchemaDocumentType","description":"The type of document to be verified"},"operation_type":{"$ref":"#/components/schemas/ScreeningsManualVerificationPostRequestBodyContentMultipartFormDataSchemaOperationType","description":"The type of KYC operation to perform"},"selfie_with_id":{"type":"string","format":"binary","description":"A selfie of the user holding the ID document"},"document_country":{"type":"string","description":"The issuing country code of the document to be verified (ISO 3166-1 alpha-2)"},"proof_of_residence":{"type":"string","format":"binary","description":"A proof of residence document"},"translation_required":{"type":"boolean","description":"Indicates whether the document requires translation"}},"required":["front","document_type","operation_type","selfie_with_id","translation_required"]}}}}}},"/veriff/session":{"post":{"operationId":"create-veriff-session","summary":"Create Veriff session","description":"Create Veriff session\n **Token scopes**: `screenings:write`, `worker:write`","tags":["subpackage_screenings"],"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/screenings_createVeriffSession_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/VeriffSessionPostRequestBodyContentApplicationJsonSchemaData"}},"required":["data"]}}}}}},"/screenings/aml/{entity_type}/{entity_id}":{"get":{"operationId":"get-aml-details","summary":"Get entity screening details","description":"Get the latest screening for an entity.\n **Token scopes**: `screenings:read`","tags":["subpackage_screenings"],"parameters":[{"name":"entity_type","in":"path","description":"The type of entity to screen. Only 'profile', 'hris_profile', 'legal_entity' are accepted.","required":true,"schema":{"$ref":"#/components/schemas/ScreeningsAmlEntityTypeEntityIdGetParametersEntityType"}},{"name":"entity_id","in":"path","description":"UUID v4 of the entity","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":"Details of the screening request for the specified entity type and ID.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/screenings_getAMLDetails_Response_200"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AmlApiForWhitelabelDataRetrieval-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":"Entity not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AmlApiForWhitelabelDataRetrieval-v2026-01-01RequestNotFoundError"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}}}},"/screenings/verification-method":{"get":{"operationId":"get-verification-method","summary":"Get verification method","description":"Get verification method by provided country and document type\n **Token scopes**: `screenings:read`, `worker:read`","tags":["subpackage_screenings"],"parameters":[{"name":"country","in":"query","description":"The document's issuing country code (ISO 3166-1 alpha-2)","required":true,"schema":{"type":"string"}},{"name":"document_type","in":"query","description":"The document to be provided during KYC","required":true,"schema":{"$ref":"#/components/schemas/ScreeningsVerificationMethodGetParametersDocumentType"}},{"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/screenings_getVerificationMethod_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"}}}}}}},"/screenings/kyc/details":{"get":{"operationId":"get-kyc-details","summary":"Get worker's KYC details","description":"This endpoint allows organizations managing workers on Deel to retrieve detailed KYC verification data using the worker’s profile ID. It provides comprehensive information including verification status, document type, submission, approval, rejection, and expiry dates, supporting compliance monitoring and onboarding workflows\n **Token scopes**: `screenings:read`","tags":["subpackage_screenings"],"parameters":[{"name":"worker_profile_id","in":"query","description":"Worker's HRIS profile public ID client requests to fetch KYC details for. This parameter is mutually exclusive with profile_id","required":false,"schema":{"type":"string","format":"uuid"}},{"name":"contract_id","in":"query","description":"Worker's contract ID. This parameter is required in case there are multiple profiles associated to the target worker. For example, when worker used to work for the former company he had another profile ID. So we need contract ID to properly resolve profile's KYC details.  In case this parameter is not provided and multiple associated profiles are found, exception with 409 status code will be thrown","required":false,"schema":{"type":"string"}},{"name":"profile_id","in":"query","description":"Worker's profile public ID client requests to fetch KYC details for, This parameter is mutually exclusive with worker_profile_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":"KYC details retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/screenings_getKYCDetails_Response_200"}}}},"400":{"description":"Bad request - Invalid worker profile ID","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetWorkersKycDetailsRequestBadRequestError"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Forbidden - User not authorized to access this resource","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetWorkersKycDetailsRequestForbiddenError"}}}},"404":{"description":"Not Found - We could not extract any profile by the provided hris profile","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetWorkersKycDetailsRequestNotFoundError"}}}},"409":{"description":"Conflict - We found multiple profiles for the provided worker ID. Please provide the contract id to resolve KYC details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetWorkersKycDetailsRequestConflictError"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}}}},"/screenings/kyc/external":{"post":{"operationId":"submit-external-kyc","summary":"Submit external KYC","description":"The endpoint standardizes identity verification and compliance processes, combining automated Live ID verification (IDV) and manual review workflows\n **Token scopes**: `worker:write`","tags":["subpackage_screenings"],"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":"KYC data successfully received","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Screenings_submitExternalKyc_Response_201"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitExternalKycRequestBadRequestError"}}}},"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":{"multipart/form-data":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ScreeningsKycExternalPostRequestBodyContentMultipartFormDataSchemaData"}},"required":["data"]}}}}}},"/ServiceProviderConfig":{"get":{"operationId":"get-service-provider-config","summary":"Get service provider config","tags":["subpackage_serviceProviderConfig"],"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/ServiceProviderConfig"}}}}}}},"/contracts/{contract_id}/tasks":{"post":{"operationId":"create-contract-task","summary":"Create a new task","description":"Create a new task for a contractor associated with a specific Deel contract. A task can include details like amount, description, submission date.\n **Token scopes**: `contracts:write`","tags":["subpackage_tasks"],"parameters":[{"name":"contract_id","in":"path","description":"The unique Deel contract ID associated with the task.","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":{"201":{"description":"The task was successfully created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tasks_createContractTask_Response_201"}}}},"400":{"description":"Bad request. Missing required fields or invalid data format.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateANewTaskRequestBadRequestError"}}}},"401":{"description":"Unauthorized. Authentication credentials are missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateANewTaskRequestUnauthorizedError"}}}},"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. An unexpected error occurred while processing the request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateANewTaskRequestInternalServerError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ContractsContractIdTasksPostRequestBodyContentApplicationJsonSchemaData"}}}}}}},"get":{"operationId":"get-contract-tasks","summary":"List of tasks","description":"Retrieve a list of tasks associated with a specific contract. Each task contains details such as its ID, amount, submission date, status, and description. This endpoint is useful for tracking the progress and status of tasks related to contracts.\n **Token scopes**: `contracts:read`","tags":["subpackage_tasks"],"parameters":[{"name":"contract_id","in":"path","description":"The unique identifier for the Deel contract.","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. A list of tasks associated with the specified contract.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tasks_getContractTasks_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}/tasks/{task_id}":{"delete":{"operationId":"delete-contract-task","summary":"Delete task","description":"Delete a specific task associated with the contract. Optionally, a reason can be provided for auditing or documentation purposes.\n **Token scopes**: `contracts:write`","tags":["subpackage_tasks"],"parameters":[{"name":"contract_id","in":"path","description":"The unique identifier of the Deel contract.","required":true,"schema":{"type":"string"}},{"name":"task_id","in":"path","description":"The unique identifier of the task to be deleted.","required":true,"schema":{"type":"string"}},{"name":"reason","in":"query","description":"The reason for deleting the task. This can be used for auditing purposes.","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":"The task was successfully deleted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tasks_deleteContractTask_Response_200"}}}},"400":{"description":"Invalid request. For example, missing required parameters or invalid format.","content":{"application/json":{"schema":{"description":"Any type"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Permission denied. The user does not have the required access to delete the task.","content":{"application/json":{"schema":{"description":"Any type"}}}},"404":{"description":"The specified task or contract was not found.","content":{"application/json":{"schema":{"description":"Any type"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}}}},"/contracts/{contract_id}/tasks/{task_id}/reviews":{"post":{"operationId":"create-contract-task-review","summary":"Review a single task","description":"Review a specific task associated with a Deel contract to approve or decline the submitted work. The review includes the status (approved or declined) and an optional reason if declined.\n **Token scopes**: `contracts:write`","tags":["subpackage_tasks"],"parameters":[{"name":"contract_id","in":"path","description":"The unique Deel contract ID associated with the task.","required":true,"schema":{"type":"string"}},{"name":"task_id","in":"path","description":"The unique ID of the task to be reviewed.","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":{"201":{"description":"The task review was successfully processed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/tasks_createContractTaskReview_Response_201"}}}},"400":{"description":"Bad request. Missing required fields or invalid data format.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReviewASingleTaskRequestBadRequestError"}}}},"401":{"description":"Unauthorized. Authentication credentials are missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReviewASingleTaskRequestUnauthorizedError"}}}},"403":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"404":{"description":"Not found. The specified task or contract was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReviewASingleTaskRequestNotFoundError"}}}},"500":{"description":"Internal server error. An unexpected error occurred while processing the request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReviewASingleTaskRequestInternalServerError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ContractsContractIdTasksTaskIdReviewsPostRequestBodyContentApplicationJsonSchemaData"}}}}}}}},"/contracts/{contract_id}/tasks/many/reviews":{"post":{"operationId":"review-multiple-tasks","summary":"Review multiple tasks","description":"Review multiple tasks associated with a Deel contract to approve or decline the submitted work. The review includes a status (approved or declined) for each task and an optional reason for declined tasks.\n **Token scopes**: `contracts:write`","tags":["subpackage_tasks"],"parameters":[{"name":"contract_id","in":"path","description":"The unique Deel contract ID associated with the tasks.","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":{"201":{"description":"The task reviews were successfully processed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Tasks_reviewMultipleTasks_Response_201"}}}},"400":{"description":"Bad request. Missing required fields or invalid data format.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReviewMultipleTasksRequestBadRequestError"}}}},"401":{"description":"Unauthorized. Authentication credentials are missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReviewMultipleTasksRequestUnauthorizedError"}}}},"403":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"404":{"description":"Not found. One or more specified tasks or the contract was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReviewMultipleTasksRequestNotFoundError"}}}},"500":{"description":"Internal server error. An unexpected error occurred while processing the request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReviewMultipleTasksRequestInternalServerError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ContractsContractIdTasksManyReviewsPostRequestBodyContentApplicationJsonSchemaData"}}}}}}}},"/tasks/{task_id}":{"patch":{"operationId":"update-task-by-id","summary":"Update Task By ID","description":"Updates a task by id, returns whether the update was successful or not.\n **Token scopes**: `tasks:write`","tags":["subpackage_tasks"],"parameters":[{"name":"task_id","in":"path","description":"The id of an existing task","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":"The task was successfully updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Tasks_updateTaskById_Response_200"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateTaskByIdRequestBadRequestError"}}}},"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/UpdateTaskByIdRequestInternalServerError"}}}}},"requestBody":{"description":"Task update object containing fields to modify.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/TasksTaskIdPatchRequestBodyContentApplicationJsonSchemaData"}},"required":["data"]}}}}}},"/contracts/{contract_id}/terminations":{"delete":{"operationId":"delete-contract-termination","summary":"Delete Contract Termination Request","description":"Cancels a pending contract termination request for the specified contract.\n **Token scopes**: `contracts:write`","tags":["subpackage_terminations"],"parameters":[{"name":"contract_id","in":"path","description":"Unique identifier for the contract","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/terminations_deleteContractTermination_Response_204"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteContractTerminationRequestRequestBadRequestError"}}}},"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/DeleteContractTerminationRequestRequestInternalServerError"}}}}}},"post":{"operationId":"create-contract-termination","summary":"Terminate contract","description":"Terminate contract.\n **Token scopes**: `contracts:write`","tags":["subpackage_terminations"],"parameters":[{"name":"contract_id","in":"path","description":"The unique identifier of the contractor contract","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":{"201":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/terminations_createContractTermination_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/ContractsContractIdTerminationsPostRequestBodyContentApplicationJsonSchemaData","description":"Termination data. At minimum, you must provide either terminate_now: true (for immediate termination) OR completion_date (for scheduled termination)."}},"required":["data"]}}}}}},"/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"}}}}}}},"get":{"operationId":"list-time-off-requests-for-organization","summary":"List time-off requests for Organization","description":"List time-off requests for Organization\n **Token scopes**: `time-off:read`","tags":["subpackage_timeOff"],"parameters":[{"name":"status","in":"query","description":"Time off status","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/TimeOffsGetParametersStatusSchemaItems"}}},{"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_listTimeOffRequestsForOrganization_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/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"}}}}}}}},"/time_tracking/shift_rates":{"post":{"operationId":"create-time-tracking-shift-rate","summary":"Create a New Shift Rate","description":"Create a new shift rate with the specified attributes such as name, type, value, and a unique external identifier.\n **Token scopes**: `time-tracking:write`","tags":["subpackage_timeTracking"],"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":"Shift rate created successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/time-tracking_createTimeTrackingShiftRate_Response_201"}}}},"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"}}}}},"requestBody":{"description":"Details of the shift rate to create.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/TimeTrackingShiftRatesPostRequestBodyContentApplicationJsonSchemaData"}},"required":["data"]}}}}},"get":{"operationId":"get-time-tracking-shift-rates","summary":"Retrieve a Paginated List of Shift Rates","description":"Retrieve a paginated list of shift rates, including details such as rate name, type, value, and timestamps. Pagination parameters can be used to control the size and position of the result set.\n **Token scopes**: `time-tracking:read`","tags":["subpackage_timeTracking"],"parameters":[{"name":"limit","in":"query","description":"The maximum number of records to return per page. For example, '10' to return up to 10 records.","required":false,"schema":{"type":"string"}},{"name":"offset","in":"query","description":"The starting index for the records to retrieve. For example, '0' for the first page or '10' for the second page when limit=10.","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":"Paginated list of shift rates retrieved successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/time-tracking_getTimeTrackingShiftRates_Response_200"}}}},"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"}}}}}}},"/time_tracking/shift_rates/{external_id}":{"delete":{"operationId":"delete-time-tracking-shift-rate-by-external-id","summary":"Delete a Shift Rate by external ID","description":"Delete a Shift Rate using its external ID, which is the custom ID provided when the shift rate is created. A ShiftRate can only be deleted if it is not currently associated with any active shift.\n **Token scopes**: `time-tracking:write`","tags":["subpackage_timeTracking"],"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":{"204":{"description":"Successfully deleted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/time-tracking_deleteTimeTrackingShiftRateByExternalId_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"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}}},"get":{"operationId":"get-time-tracking-shift-rate-by-external-id","summary":"Retrieve a Shift Rate by External ID","description":"Retrieve details of a specific shift rate using its external ID. The response includes information such as the name, type, value, and unique identifier of the shift rate.\n **Token scopes**: `time-tracking:read`","tags":["subpackage_timeTracking"],"parameters":[{"name":"external_id","in":"path","description":"The unique external identifier of the shift rate to retrieve.","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":"Shift rate retrieved successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/time-tracking_getTimeTrackingShiftRateByExternalId_Response_200"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}}},"patch":{"operationId":"update-time-tracking-shift-rate-by-external-id","summary":"Update a shift rate","description":"Update specific fields of an existing shift rate.\n **Token scopes**: `time-tracking:write`","tags":["subpackage_timeTracking"],"parameters":[{"name":"external_id","in":"path","description":"Unique identifier of the shift rate to be updated.","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":"Shift rate updated successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/time-tracking_updateTimeTrackingShiftRateByExternalId_Response_200"}}}},"400":{"description":"Invalid request payload","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAShiftRateRequestBadRequestError"}}}},"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/TimeTrackingShiftRatesExternalIdPatchRequestBodyContentApplicationJsonSchemaData"}},"required":["data"]}}}}}},"/time-tracking/timesheets/upload-url":{"post":{"operationId":"get-time-tracking-timesheets-upload-url","summary":"Generate timesheet upload url","description":"Receives timesheet file metadata and generates a link to upload timesheet file. Please note that this endpoint supports EOR contracts as of now\n **Token scopes**: `time-tracking:write`","tags":["subpackage_timeTracking"],"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":"Timesheet created successfully. Returns upload URL, upload form fields, and timesheet ID.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/time-tracking_getTimeTrackingTimesheetsUploadUrl_Response_201"}}}},"400":{"description":"Bad request. Validation or business rule violation (e.g., non-EOR contract, invalid date range).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerateTimesheetUploadUrl-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":"Resource not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerateTimesheetUploadUrl-v2026-01-01RequestNotFoundError"}}}},"422":{"description":"Unprocessable entity. Business logic constraint violation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerateTimesheetUploadUrl-v2026-01-01RequestUnprocessableEntityError"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}},"requestBody":{"description":"timesheet information needed for uploading timesheet file","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/TimeTrackingTimesheetsUploadUrlPostRequestBodyContentApplicationJsonSchemaData"}},"required":["data"]}}}}}},"/time-tracking/timesheets/{timesheet_id}":{"get":{"operationId":"get-time-tracking-timesheet-by-id","summary":"Retrieve a timesheet","description":"Retrieves a timesheet by ID, including its submission, review, and processing status. When expand=file_data is provided, the response also includes file-related details such as the file name, download URL.\n **Token scopes**: `time-tracking:read`","tags":["subpackage_timeTracking"],"parameters":[{"name":"timesheet_id","in":"path","description":"ID of the timesheet to fetch file for","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"extend","in":"query","description":"Optional list of fields to extend in the response. Currently only `file_data` is supported, which includes file details (file_id, file_name) and download URL.","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":"Timesheet retrieved successfully. Returns timesheet details including validation errors if applicable. When extend=file_data, also includes file_data object with file details and download URL.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/time-tracking_getTimeTrackingTimesheetById_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":"Timesheet not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveATimesheet-v2026-01-01RequestNotFoundError"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}}}},"/time-tracking/timesheets/{timesheet_id}/review":{"post":{"operationId":"review-time-tracking-timesheet","summary":"Review a submitted timesheet","description":"Review a successfully submitted timesheet. Only PENDING_REVIEW timesheets can be reviewed, and all associated hours will be approved/rejected at once.\n **Token scopes**: `time-tracking:write`","tags":["subpackage_timeTracking"],"parameters":[{"name":"timesheet_id","in":"path","description":"ID of the timesheet to review","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":{"201":{"description":"Timesheet reviewed successfully. Returns updated timesheet details with review status and review timestamp.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/time-tracking_reviewTimeTrackingTimesheet_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":"Timesheet not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReviewASubmittedTimesheetRequestNotFoundError"}}}},"422":{"description":"Unprocessable entity. Timesheet cannot be reviewed in its current state.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReviewASubmittedTimesheetRequestUnprocessableEntityError"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}},"requestBody":{"description":"Review information for the timesheet. review_reason is required when review_status is REJECTED.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/TimeTrackingTimesheetsTimesheetIdReviewPostRequestBodyContentApplicationJsonSchemaData"}},"required":["data"]}}}}}},"/time_tracking/shifts/raw":{"post":{"operationId":"create-time-tracking-shifts-raw","summary":"Create raw time tracking shifts","description":"Create raw shifts for the specified contract ID. “Raw shifts” refers to uncategorized entries—simply submit the clock-in and clock-out times. The classification of those hours (e.g., regular or overtime) will be handled by the Deel platform.\n **Token scopes**: `time-tracking:write`","tags":["subpackage_timeTrackingShifts"],"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/time-tracking-shifts_createTimeTrackingShiftsRaw_Response_201"}}}},"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":"Request body to create time tracking raw shifts.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/TimeTrackingShiftsRawPostRequestBodyContentApplicationJsonSchemaData","description":"Request data containing contract ID and shifts to be created."}},"required":["data"]}}}}}},"/time_tracking/shifts":{"post":{"operationId":"create-time-tracking-shifts","summary":"Create shifts","description":"Creates multiple time tracking shifts for a contract, supporting both regular shift submissions and corrections that adjust hours for previously processed shifts.\n **Token scopes**: `time-tracking:write`","tags":["subpackage_timeTrackingShifts"],"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/time-tracking-shifts_createTimeTrackingShifts_Response_201"}}}},"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":"Request body to create time tracking shifts supporting regular shifts and correction shifts.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaData","description":"Request data containing contract ID and shifts to be created."}},"required":["data"]}}}}},"get":{"operationId":"get-time-tracking-shifts","summary":"List of shifts","description":"Retrieve a paginated list of shifts with details such as start and end times, breaks, metadata, and summary metrics. Supports pagination through `limit` and `offset` query parameters and filtering by `contractId`, date range (`fromDate` and `toDate`).\n **Token scopes**: `time-tracking:read`","tags":["subpackage_timeTrackingShifts"],"parameters":[{"name":"limit","in":"query","description":"Maximum number of records to return.","required":false,"schema":{"type":"string"}},{"name":"offset","in":"query","description":"Offset/index of record for the next page of records to return.","required":false,"schema":{"type":"string"}},{"name":"from_date","in":"query","description":"Filter shifts from this date (YYYY-MM-DD).","required":false,"schema":{"type":"string","format":"date"}},{"name":"to_date","in":"query","description":"Filter shifts until this date (YYYY-MM-DD).","required":false,"schema":{"type":"string","format":"date"}},{"name":"contract_id[]","in":"query","description":"Filter shifts by one or more contract IDs.","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 response with paginated shifts.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/time-tracking-shifts_getTimeTrackingShifts_Response_200"}}}},"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_tracking/shifts/{external_id}":{"delete":{"operationId":"delete-time-tracking-shift-by-external-id","summary":"Delete a Shift by External ID","description":"This endpoint deletes a shift using its external ID. Once deleted, the shift will no longer be retrievable or editable.\n **Token scopes**: `time-tracking:write`","tags":["subpackage_timeTrackingShifts"],"parameters":[{"name":"external_id","in":"path","description":"The unique external identifier of the shift to be deleted.","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":"Shift deleted successfully. No content is returned.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/time-tracking-shifts_deleteTimeTrackingShiftByExternalId_Response_204"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}}},"get":{"operationId":"get-time-tracking-shift-by-external-id","summary":"Get shift details","description":"Retrieve details of a specific shift by external ID.\n **Token scopes**: `time-tracking:read`","tags":["subpackage_timeTrackingShifts"],"parameters":[{"name":"external_id","in":"path","description":"Unique identifier of the shift to retrieve.","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":"Shift details retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/time-tracking-shifts_getTimeTrackingShiftByExternalId_Response_200"}}}},"400":{"description":"Invalid request parameters","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetShiftDetailsRequestBadRequestError"}}}},"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-tracking-shift-by-external-id","summary":"Update a shift","description":"Update specific fields of an existing shift by its unique `external_id`. This includes shift summary details, description etc.\n **Token scopes**: `time-tracking:write`","tags":["subpackage_timeTrackingShifts"],"parameters":[{"name":"external_id","in":"path","description":"Unique identifier of the shift to be updated.","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":"Shift updated successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/time-tracking-shifts_updateTimeTrackingShiftByExternalId_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"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/TimeTrackingShiftsExternalIdPatchRequestBodyContentApplicationJsonSchemaData","description":"Shift update request data."}},"required":["data"]}}}}}},"/time_tracking/shifts/bulk-delete":{"post":{"operationId":"delete-multiple-shifts-by-external-id","summary":"Delete multiple shifts by External ID","description":"This endpoint deletes shifts using external IDs. Once deleted, the shifts will no longer be retrievable or editable.\n **Token scopes**: `time-tracking:write`","tags":["subpackage_timeTrackingShifts"],"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":"Shifts deleted successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Time Tracking Shifts_deleteMultipleShiftsByExternalId_Response_200"}}}},"401":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"403":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}},"requestBody":{"description":"Request body to bulk delete shifts by their external IDs.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/TimeTrackingShiftsBulkDeletePostRequestBodyContentApplicationJsonSchemaData","description":"Request data containing the external IDs of shifts to be deleted."}},"required":["data"]}}}}}},"/timesheets":{"post":{"operationId":"create-timesheet","summary":"Create a timesheet entry","description":"Submit work for a contractor.\n **Token scopes**: `timesheets:write`","tags":["subpackage_timesheets"],"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/timesheets_createTimesheet_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":{"description":"Timesheet object that needs to be created","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/TimesheetsPostRequestBodyContentApplicationJsonSchemaData","description":"Details of the timesheet to create. Both a client or a contractor may create a timesheet."}},"required":["data"]}}}}},"get":{"operationId":"get-timesheets","summary":"List of timesheets","description":"Retrieve a list of timesheets in your Deel account. You can filter the list by providing additional paramters e.g. contract_id, contract_type etc.\n **Token scopes**: `timesheets:read`","tags":["subpackage_timesheets"],"parameters":[{"name":"contract_id","in":"query","description":"Id of an Deel contract.","required":false,"schema":{"type":"string"}},{"name":"contract_types","in":"query","description":"types of contracts to filter","required":false,"schema":{"$ref":"#/components/schemas/TimesheetsGetParametersContractTypes"}},{"name":"statuses","in":"query","required":false,"schema":{"$ref":"#/components/schemas/TimesheetsGetParametersStatuses"}},{"name":"reporter_id","in":"query","required":false,"schema":{"type":"string","format":"uuid"}},{"name":"date_from","in":"query","required":false,"schema":{"type":"string","format":"date"}},{"name":"date_to","in":"query","required":false,"schema":{"type":"string","format":"date"}},{"name":"limit","in":"query","required":false,"schema":{"type":"string"}},{"name":"offset","in":"query","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.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/timesheets_getTimesheets_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"}}}}}}},"/timesheets/{id}":{"delete":{"operationId":"delete-timesheet-by-id","summary":"Delete a timesheet entry","description":"Delete a single timesheet entry.\n **Token scopes**: `timesheets:write`","tags":["subpackage_timesheets"],"parameters":[{"name":"id","in":"path","description":"ID of an existing timesheet","required":true,"schema":{"type":"string"}},{"name":"reason","in":"query","description":"Reason for deleting an existing task","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.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Timesheets_deleteTimesheetById_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-timesheet-by-id","summary":"Retrieve a single timesheet entry","description":"Retrieve a single timesheet entry by Id.\n **Token scopes**: `timesheets:read`","tags":["subpackage_timesheets"],"parameters":[{"name":"id","in":"path","description":"ID of an existing timesheet","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/timesheets_getTimesheetById_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-timesheet","summary":"Update a timesheet entry","description":"Use this endpoint to update an existing timesheet entry by its id when correcting logged hours or refining the work note. Send a PATCH request to /timesheets/:id with a data object containing fields to change, such as quantity, description, or hourly_report_preset_id. Both clients and contractors can perform this update.\n **Token scopes**: `timesheets:write`","tags":["subpackage_timesheets"],"parameters":[{"name":"id","in":"path","description":"ID of an existing timesheet.","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":{"201":{"description":"Successful operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/timesheets_updateTimesheet_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/TimesheetsIdPatchRequestBodyContentApplicationJsonSchemaData"}},"required":["data"]}}}}}},"/contracts/{contract_id}/timesheets":{"get":{"operationId":"get-contract-timesheets","summary":"List of timesheets by contract","description":"Retrieve a list of timesheets found for a contract.\n **Token scopes**: `timesheets:read`","tags":["subpackage_timesheets"],"parameters":[{"name":"contract_id","in":"path","description":"Deel contract id.","required":true,"schema":{"type":"string"}},{"name":"contract_types","in":"query","description":"Types of contracts to filter.","required":false,"schema":{"$ref":"#/components/schemas/ContractsContractIdTimesheetsGetParametersContractTypes"}},{"name":"statuses","in":"query","description":"Statuses of timesheets to filter.","required":false,"schema":{"$ref":"#/components/schemas/ContractsContractIdTimesheetsGetParametersStatuses"}},{"name":"reporter_id","in":"query","description":"ID of an existing profile","required":false,"schema":{"type":"string","format":"uuid"}},{"name":"date_from","in":"query","description":"Filtered results will include records created on or after the provided date. Short date in format ISO-8601 (YYYY-MM-DD). For example: 2022-12-31.","required":false,"schema":{"type":"string","format":"date"}},{"name":"date_to","in":"query","description":"Filtered results will include records created before the provided date. Short date in format ISO-8601 (YYYY-MM-DD). For example: 2022-12-31.","required":false,"schema":{"type":"string","format":"date"}},{"name":"limit","in":"query","description":"Return a page of results with given number of records; NOTE: technically ALL query parameters are strings or array of strings","required":false,"schema":{"type":"string"}},{"name":"offset","in":"query","description":"Return a page of results after given index of row","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.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/timesheets_getContractTimesheets_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"}}}}}}},"/timesheets/{id}/reviews":{"post":{"operationId":"create-timesheet-review","summary":"Review a single timesheet","description":"Review a timesheet to approve or decline submitted work.\n **Token scopes**: `timesheets:write`","tags":["subpackage_timesheets"],"parameters":[{"name":"id","in":"path","description":"ID of an existing timesheet","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":{"201":{"description":"Successful operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/timesheets_createTimesheetReview_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/TimesheetsIdReviewsPostRequestBodyContentApplicationJsonSchemaData"}}}}}}}},"/accounts-payable/vendor-bills":{"post":{"operationId":"create-vendor-bill-v-2026-01-01","summary":"Create Vendor Bill","description":"Creates vendor bills from structured invoice data submitted by an external invoice provider integration.\n **Token scopes**: `treasury-vendorbill:write`","tags":["subpackage_treasury"],"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":"Vendor bill created successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Treasury_createVendorBill-v2026-01-01_Response_201"}}}},"400":{"description":"Bad request - validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateVendorBill-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"}}}},"409":{"description":"Conflict - duplicate reference","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateVendorBill-v2026-01-01RequestConflictError"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateVendorBill-v2026-01-01RequestInternalServerError"}}}}},"requestBody":{"description":"Create vendor bills from external invoice provider data","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AccountsPayableVendorBillsPostRequestBodyContentApplicationJsonSchemaData"}},"required":["data"]}}}}}},"/accounts-payable/vendor-bills/{vendor_bill_id}/attachments":{"post":{"operationId":"upload-vendor-bill-attachment","summary":"Upload Vendor Bill Attachment","description":"Use this endpoint to attach a PDF invoice file to an existing vendor bill entity. Submit the file via multipart/form-data with the file in the request body.\n **Token scopes**: `treasury-vendorbill:write`","tags":["subpackage_treasury"],"parameters":[{"name":"vendor_bill_id","in":"path","description":"Vendor bill id to attach the file to","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":{"201":{"description":"File uploaded successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Treasury_uploadVendorBillAttachment_Response_201"}}}},"400":{"description":"Bad request - validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UploadVendorBillAttachmentRequestBadRequestError"}}}},"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":"Vendor bill not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UploadVendorBillAttachmentRequestNotFoundError"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UploadVendorBillAttachmentRequestInternalServerError"}}}}},"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AccountsPayableVendorBillsVendorBillIdAttachmentsPostRequestBodyContentMultipartFormDataSchemaData"}},"required":["data"]}}}}}},"/Users/{hris_profile_id}":{"get":{"operationId":"retrieve-a-single-user-v-2026-01-01","summary":"Retrieve a single User","description":"Retrieve a single user by id.\n **Token scopes**: `Users:read`","tags":["subpackage_user"],"parameters":[{"name":"hris_profile_id","in":"path","description":"The unique identifier (OID) of the HRIS profile to retrieve.","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/User_retrieveASingleUser-v2026-01-01_Response_200"}}}},"404":{"description":"Resource not found - The provided hrisProfileOid does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveASingleUser-v2026-01-01RequestNotFoundError"}}}}}}},"/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"}}}}}},"/webhooks":{"post":{"operationId":"create-webhook","summary":"Create a webhook","description":"Create a new webhooks subscription.","tags":["subpackage_webhooks"],"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/WebhookItemResponse"}}}},"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"}}}},"405":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"429":{"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":{"$ref":"#/components/schemas/CreateWebhookRequest"}}}}},"get":{"operationId":"get-webhooks","summary":"List of webhooks","description":"Retrieve a list of webhook subscriptions.","tags":["subpackage_webhooks"],"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/WebhookListResponse"}}}},"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"}}}},"405":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"429":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}}}},"/webhooks/{id}":{"delete":{"operationId":"delete-webhook","summary":"Delete a webhook","description":"Delete a webhook subscription.","tags":["subpackage_webhooks"],"parameters":[{"name":"id","in":"path","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/GenericResultDeleted"}}}},"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"}}}},"405":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"429":{"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-webhook","summary":"Edit a webhook","description":"Edit a webhook subscription.","tags":["subpackage_webhooks"],"parameters":[{"name":"id","in":"path","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/WebhookItemResponse"}}}},"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"}}}},"405":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"429":{"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":{"$ref":"#/components/schemas/PatchWebhookRequest"}}}}},"get":{"operationId":"get-webhook","summary":"Retrieve a single webhook","description":"Retrieve a single webhook subscription.","tags":["subpackage_webhooks"],"parameters":[{"name":"id","in":"path","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/WebhookItemResponse"}}}},"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"}}}},"405":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"429":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}}}},"/webhooks/events/types":{"get":{"operationId":"get-webhook-events","summary":"List of webhook event types","description":"Retrieve a list of webhook event types.","tags":["subpackage_webhooks"],"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/WebhookEventTypeListResponse"}}}},"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"}}}},"405":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"429":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}}}},"/escalations/workers/me/hrx":{"get":{"operationId":"get-hrx-manager-for-worker","summary":"Get HRX manager for worker","description":"Use this endpoint to retrieve details of the Human Resource Experience (HRX) Manager assigned to a worker. This can be used to display contact and scheduling information for the HRX representative. Only accessible to employees with appropriate permissions.\n **Token scopes**: `worker:read`","tags":["subpackage_workerHr"],"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. Returns HRX representative information for the worker based on their country.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Worker HR_getHrxManagerForWorker_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":"Forbidden - user is not authorized to access this resource. Only employees can access HRX information.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetHrxManagerForWorkerRequestForbiddenError"}}}},"404":{"description":"Not Found - There is no assignment of HRX Manager against this worker","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetHrxManagerForWorkerRequestNotFoundError"}}}},"500":{"description":"Internal server error - unexpected error occurred while processing the request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetHrxManagerForWorkerRequestInternalServerError"}}}}}}},"/gp/workers/{worker_id}/banks":{"post":{"operationId":"create-gp-worker-bank","summary":"Add bank account","description":"Add a new bank account for an employee.\n **Token scopes**: `people:write`","tags":["subpackage_workerInformation"],"parameters":[{"name":"worker_id","in":"path","description":"Unique identifier for a worker in UUID format.","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":{"201":{"description":"Successful operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/worker-information_createGPWorkerBank_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":{"description":"Request body containing the details of the bank account to be added.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/GpWorkersWorkerIdBanksPostRequestBodyContentApplicationJsonSchemaData"}},"required":["data"]}}}}},"get":{"operationId":"get-gp-worker-banks","summary":"Retrieve bank accounts","description":"Retrieve all bank accounts for an employee.\n **Token scopes**: `people:read`","tags":["subpackage_workerInformation"],"parameters":[{"name":"worker_id","in":"path","description":"Unique identifier for a worker.","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/worker-information_getGPWorkerBanks_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"}}}}}}},"/gp/workers/contracts/{contract_id}/additional-information":{"post":{"operationId":"create-gp-worker-additional-information","summary":"Add GP Workers Additional Information","description":"Use this endpoint to add additional information to a GP worker's contract. Provide the extra fields in the request body under 'data' for the contract identified by 'contract_id'.\n **Token scopes**: `people:write`","tags":["subpackage_workerInformation"],"parameters":[{"name":"contract_id","in":"path","description":"The unique public identifier of the contract.","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":{"201":{"description":"Operation successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/worker-information_createGPWorkerAdditionalInformation_Response_201"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddGpWorkersAdditionalInformationRequestBadRequestError"}}}},"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/AddGpWorkersAdditionalInformationRequestInternalServerError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/GpWorkersContractsContractIdAdditionalInformationPostRequestBodyContentApplicationJsonSchemaData"}}},"required":["data"]}}}}},"patch":{"operationId":"get-gp-worker-additional-information","summary":"Update GP Workers Additional Information","description":"Use this endpoint to update additional information for a GP worker's contract.  Provide the extra fields in the request body under 'data' for the contract identified by 'contract_id'.\n **Token scopes**: `people:write`","tags":["subpackage_workerInformation"],"parameters":[{"name":"contract_id","in":"path","description":"The unique public identifier of the contract.","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":"Operation successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/worker-information_getGPWorkerAdditionalInformation_Response_204"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateGpWorkersAdditionalInformationRequestBadRequestError"}}}},"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/UpdateGpWorkersAdditionalInformationRequestInternalServerError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/GpWorkersContractsContractIdAdditionalInformationPatchRequestBodyContentApplicationJsonSchemaData"}}},"required":["data"]}}}}}},"/gp/workers/{worker_id}/banks/{bank_id}":{"patch":{"operationId":"update-gp-worker-bank","summary":"Modify bank account","description":"Modify bank account for an employee.\n **Token scopes**: `people:write`","tags":["subpackage_workerInformation"],"parameters":[{"name":"worker_id","in":"path","description":"Unique identifier for a worker in UUID format.","required":true,"schema":{"type":"string","format":"uuid"}},{"name":"bank_id","in":"path","description":"Unique identifier for the bank account in UUID format.","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-information_updateGPWorkerBank_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":{"description":"Request body to modify an existing bank account for an employee.","content":{"application/json":{"schema":{"type":"object","properties":{"city":{"type":"string","description":"The city of the user's address."},"iban":{"type":"string","description":"The International Bank Account Number (IBAN)."},"email":{"type":"string","description":"The user's email address."},"phone":{"type":"string","description":"The user's phone number."},"postal":{"type":"string","description":"The user's postal or ZIP code."},"tax_id":{"type":"string","description":"The user's tax identification number."},"bank_code":{"type":"string","description":"The bank code."},"bank_name":{"type":"string","description":"Name of the user's bank."},"full_name":{"type":"string","description":"Full name of the user."},"swift_bic":{"type":"string","description":"SWIFT/BIC code for the bank."},"rib_number":{"type":"string","description":"The RIB (Relevé d'Identité Bancaire)."},"branch_code":{"type":"string","description":"The branch code of the user's bank."},"account_type":{"type":"string","description":"Bank account type."},"country_code":{"type":"string","description":"The country code of the user's address."},"address_line1":{"type":"string","description":"The primary address line."},"address_line2":{"type":"string","description":"The secondary address line."},"currency_code":{"type":"string","description":"The currency code for transactions."},"original_name":{"type":"string","description":"The original name of the user."},"account_number":{"type":"string","description":"The user's bank account number."},"province_state":{"type":"string","description":"The state or province of the user's address."},"bank_branch_name":{"type":"string","description":"The name of the user's bank branch."},"bank_country_code":{"type":"string","description":"The country code where the bank is located."},"ach_routing_number":{"type":"string","description":"The ACH (Automated Clearing House) Routing Number."}}}}}}}},"/gp/workers/{worker_id}/banks/guide":{"get":{"operationId":"get-gp-worker-bank-guide","summary":"Retrieve bank guide","description":"Retrieve the bank form guide for an employee.\n **Token scopes**: `people:read`","tags":["subpackage_workerInformation"],"parameters":[{"name":"worker_id","in":"path","description":"Unique identifier for a worker in UUID format.","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-information_getGPWorkerBankGuide_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"}}}}}}},"/gp/workers/{worker_id}/address":{"patch":{"operationId":"update-gp-worker-address","summary":"Update address","description":"Update the address of a Global Payroll employee.\n **Token scopes**: `people:write`","tags":["subpackage_workerInformation"],"parameters":[{"name":"worker_id","in":"path","description":"Unique identifier for a worker in UUID format.","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":{"201":{"description":"Successful operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/worker-information_updateGPWorkerAddress_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":{"description":"The desired address of the Global Payroll employee","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/GpWorkersWorkerIdAddressPatchRequestBodyContentApplicationJsonSchemaData"}},"required":["data"]}}}}}},"/gp/workers/{worker_id}/compensation":{"patch":{"operationId":"update-gp-worker-compensation","summary":"Update compensation","description":"Update the compensation of a Global Payroll employee. Returns the full compensation history including the update.\n **Token scopes**: `people:write`","tags":["subpackage_workerInformation"],"parameters":[{"name":"worker_id","in":"path","description":"Unique identifier for a worker in UUID format.","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-information_updateGPWorkerCompensation_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":{"description":"Request body containing the data to update the compensation of the employee.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/GpWorkersWorkerIdCompensationPatchRequestBodyContentApplicationJsonSchemaData"}},"required":["data"]}}}}}},"/gp/workers/{worker_id}/employee-information":{"patch":{"operationId":"update-gp-worker-employee-information","summary":"Update employee information","description":"Update employee number identifier used for integration\n **Token scopes**: `people:write`","tags":["subpackage_workerInformation"],"parameters":[{"name":"worker_id","in":"path","description":"Unique identifier for a worker in UUID format.","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":{"202":{"description":"Successful operation.","content":{"application/json":{"schema":{"description":"Any type"}}}},"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/GpWorkersWorkerIdEmployeeInformationPatchRequestBodyContentApplicationJsonSchemaData"}},"required":["data"]}}}}}},"/gp/workers/{worker_id}/pto-policy":{"patch":{"operationId":"update-gp-worker-pto-policy","summary":"Update PTO policy","description":"Update the PTO policy of a Global Payroll employee.\n **Token scopes**: `people:write`","tags":["subpackage_workerInformation"],"parameters":[{"name":"worker_id","in":"path","description":"Unique identifier for a worker in UUID format.","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-information_updateGPWorkerPTOPolicy_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":{"description":"Contract object that needs to be amended.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/GpWorkersWorkerIdPtoPolicyPatchRequestBodyContentApplicationJsonSchemaData"}},"required":["data"]}}}}}},"/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/external/{profile_id}/parent":{"put":{"operationId":"create-a-parent-worker-relation-with-external-id-v-2026-01-01","summary":"Create a parent worker relation with external id","description":"Sets or replaces the parent relationship for the specified HRIS profile, using external identifiers. Pass null as parent_profile_external_id to remove the existing parent relationship.\n **Token scopes**: `profile:write`","tags":["subpackage_workerRelations"],"parameters":[{"name":"profile_id","in":"path","description":"HrisProfile external 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_createAParentWorkerRelationWithExternalId-v2026-01-01_Response_204"}}}},"400":{"description":"Bad request - The request body is invalid or missing required fields.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAParentWorkerRelationWithExternalId-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 HRIS profile, relationship type, or parent profile was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAParentWorkerRelationWithExternalId-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/HrisWorkerRelationsProfileExternalProfileIdParentPutRequestBodyContentApplicationJsonSchemaData","description":"The request payload containing parent relationship details."}}}}}}}},"/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/{hris_profile_oid}/child":{"put":{"operationId":"create-child-worker-relation-v-2026-01-01","summary":"Create child worker relation","description":"Replaces all child relationships of a given type for the specified HRIS profile. Any existing child relationships of that type not included in the request will be removed.\n **Token scopes**: `profile:write`","tags":["subpackage_workerRelations"],"parameters":[{"name":"hris_profile_oid","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_createChildWorkerRelation-v2026-01-01_Response_204"}}}},"400":{"description":"Bad request - The request body is invalid or missing required fields.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateChildWorkerRelation-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 HRIS profile or relationship type was not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateChildWorkerRelation-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/HrisWorkerRelationsProfileHrisProfileOidChildPutRequestBodyContentApplicationJsonSchemaData"}}}}}}}},"/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/{type_id}":{"delete":{"operationId":"delete-a-worker-relation-type-v-2026-01-01","summary":"Delete a worker relation type","description":"Deletes an existing worker relationship type.\n **Token scopes**: `organizations:write`","tags":["subpackage_workerRelations"],"parameters":[{"name":"type_id","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":"Successfully deleted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Worker Relations_deleteAWorkerRelationType-v2026-01-01_Response_204"}}}},"400":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteAWorkerRelationType-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/DeleteAWorkerRelationType-v2026-01-01RequestInternalServerError"}}}}}}},"/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"}}}}}}}},"/hris/worker_relations/profile/external/{profile_id}":{"get":{"operationId":"fetch-worker-relations-of-a-given-hris-profile-by-external-id-v-2026-01-01","summary":"Fetch Worker Relations of a given HrisProfile by external id","description":"Retrieves all worker relationships for a given HRIS profile identified by its external identifier, including parent and child relationships.\n **Token scopes**: `profile:read`","tags":["subpackage_workerRelations"],"parameters":[{"name":"profile_id","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":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Worker Relations_fetchWorkerRelationsOfAGivenHrisProfileByExternalId-v2026-01-01_Response_200"}}}},"400":{"description":"Bad request - The provided profileId parameter is invalid or missing.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FetchWorkerRelationsOfAGivenHrisProfileByExternalId-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 - No HRIS profile exists for the provided externalId.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FetchWorkerRelationsOfAGivenHrisProfileByExternalId-v2026-01-01RequestNotFoundError"}}}},"500":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}}}}},"/workers/session":{"post":{"operationId":"create-worker-access-token","summary":"Create worker access token","description":"Creates a worker access token\n **Token scopes**: `admin:worker`","tags":["subpackage_workerSession"],"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 Session_createWorkerAccessToken_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/WorkersSessionPostRequestBodyContentApplicationJsonSchemaData"}},"required":["data"]}}}}}},"/workers/{worker_id}/session":{"delete":{"operationId":"delete-worker-access-token","summary":"Delete worker access token","description":"Deletes the worker access token\n **Token scopes**: `admin:worker`","tags":["subpackage_workerSession"],"parameters":[{"name":"worker_id","in":"path","description":"The ID of the worker whose access token you want to delete.","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 Session_deleteWorkerAccessToken_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"}}}}}}},"/ic/workers/invoices/{invoice_id}/pdf":{"get":{"operationId":"ic-workers-invoices-invoice-id-pdf-v-2026-04-20","summary":"/ic/workers/invoices/:invoice_id/pdf","description":"This endpoint provides embedded worker flows access to download a pdf of a specific invoice while using a worker:PAT token.\n **Token scopes**: `accounting:read`","tags":["subpackage_workers"],"parameters":[{"name":"invoice_id","in":"path","description":"Public invoice identifier (UUID) for the invoice whose PDF URL is returned.","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":"Signed PDF URL for download.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Workers_icWorkersInvoicesInvoiceIdPdf-v2026-04-20_Response_200"}}}},"400":{"description":"Bad request (invalid query parameters).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IcWorkersInvoicesInvoiceIdPdf-v2026-04-20RequestBadRequestError"}}}},"401":{"description":"Unauthorized (missing or invalid worker token).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IcWorkersInvoicesInvoiceIdPdf-v2026-04-20RequestUnauthorizedError"}}}},"403":{"description":"Forbidden (invoice not found or not accessible to this worker).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IcWorkersInvoicesInvoiceIdPdf-v2026-04-20RequestForbiddenError"}}}},"404":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"412":{"description":"Precondition failed (e.g. icEmbeddedWorkerSetup is not enabled for the organization).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IcWorkersInvoicesInvoiceIdPdf-v2026-04-20RequestPreconditionFailedError"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IcWorkersInvoicesInvoiceIdPdf-v2026-04-20RequestInternalServerError"}}}}}}},"/worker":{"post":{"operationId":"create-worker","summary":"Create a new worker","description":"Creates a new worker account with the specified profile type","tags":["subpackage_workers"],"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":"Worker created successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Workers_createWorker_Response_201"}}}},"400":{"description":"Validation error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateWorkerRequestBadRequestError"}}}},"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/CreateWorkerRequestInternalServerError"}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/WorkerPostRequestBodyContentApplicationJsonSchemaData"}},"required":["data"]}}}}}},"/ic/workers/invoices/{invoice_id}":{"get":{"operationId":"get-invoice-details-by-id-v-2026-04-27","summary":"Get invoice details by ID","description":"This endpoint retrieves invoice information by ID. Use it to access detailed invoice data for reference or verification.\n **Token scopes**: `worker:read`","tags":["subpackage_workers"],"parameters":[{"name":"invoice_id","in":"path","description":"Public invoice id for the invoice to return.","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":"Invoice detail","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Workers_getInvoiceDetailsById-v2026-04-27_Response_200"}}}},"400":{"description":"Bad request (invalid query or path parameters).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetInvoiceDetailsById-v2026-04-27RequestBadRequestError"}}}},"401":{"description":"Unauthorized (missing or invalid worker token).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetInvoiceDetailsById-v2026-04-27RequestUnauthorizedError"}}}},"403":{"description":"Forbidden (invoice not found or not accessible to this worker).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetInvoiceDetailsById-v2026-04-27RequestForbiddenError"}}}},"404":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"412":{"description":"Precondition failed (e.g. `icEmbeddedWorkerSetup` is not enabled for the organization).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetInvoiceDetailsById-v2026-04-27RequestPreconditionFailedError"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetInvoiceDetailsById-v2026-04-27RequestInternalServerError"}}}}}}},"/workers/compliance-documents":{"get":{"operationId":"list-of-worker-compliance-documents-v-2026-04-23","summary":"List of worker compliance documents","description":"Retrieve the list of compliance document requirements for a worker, grouped by country. Returns all required and optional documents with their current submission status. Applicable for both independent contractors and EOR employees.\n **Token scopes**: `worker:read`","tags":["subpackage_workers"],"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/Workers_listOfWorkerComplianceDocuments-v2026-04-23_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":"Forbidden. The caller does not have the required profile type (employee or contractor).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListOfWorkerComplianceDocuments-v2026-04-23RequestForbiddenError"}}}},"404":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListOfWorkerComplianceDocuments-v2026-04-23RequestInternalServerError"}}}}}}},"/ic/workers/transactions":{"get":{"operationId":"retrieve-worker-transaction-history-v-2026-04-30","summary":"Retrieve worker transaction history","description":"Use this endpoint to access a worker's transaction history quickly. This integration works with white-label clients and ensures compliance by not following the generic contractor route\n **Token scopes**: `worker:read`","tags":["subpackage_workers"],"parameters":[{"name":"limit","in":"query","description":"Maximum number of transactions to return in this page (page size).","required":false,"schema":{"type":"integer","default":100}},{"name":"filter","in":"query","description":"Subset of transactions by processing state. Public enum is UPPER_SNAKE; the server lowercases for validation (legacy lowercase query values are still accepted).","required":false,"schema":{"$ref":"#/components/schemas/IcWorkersTransactionsGetParametersFilter"}},{"name":"from","in":"query","description":"Lower bound on transaction `created_at` (inclusive), ISO-8601 date-time.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"to","in":"query","description":"Upper bound on transaction `created_at` (inclusive), ISO-8601 date-time.","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"cursor","in":"query","description":"Opaque pagination cursor from the previous response field `next_cursor`. Omit on the first page; pass the last `next_cursor` value as `cursor` to fetch the next page.","required":false,"schema":{"type":"string"}},{"name":"statuses","in":"query","description":"Filter listed transactions to these mapped status values (applied after fetch; may affect how rows align with `total_count`).","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"amount_from","in":"query","description":"Minimum transaction amount to include.","required":false,"schema":{"type":"number","format":"double"}},{"name":"amount_to","in":"query","description":"Maximum transaction amount to include.","required":false,"schema":{"type":"number","format":"double"}},{"name":"currencies","in":"query","description":"Only include transactions in one of these currency codes.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"transaction_type","in":"query","description":"Restrict to pay-in or pay-out. Public enum is UPPER_SNAKE; the server lowercases for validation (legacy lowercase query values are still accepted).","required":false,"schema":{"$ref":"#/components/schemas/IcWorkersTransactionsGetParametersTransactionType"}},{"name":"withdrawal_methods","in":"query","description":"Filter by withdrawal / payout method identifiers.","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"last_days","in":"query","description":"Only include transactions created in the last N days.","required":false,"schema":{"type":"integer"}},{"name":"type","in":"query","description":"Additional transaction type filter (backend-specific string).","required":false,"schema":{"type":"string"}},{"name":"include_running_total","in":"query","description":"When true, each row may include a running total over the result set.","required":false,"schema":{"type":"boolean","default":false}},{"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 — paginated contractor transactions.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Workers_retrieveWorkerTransactionHistory-v2026-04-30_Response_200"}}}},"400":{"description":"Bad request (invalid query parameters).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveWorkerTransactionHistory-v2026-04-30RequestBadRequestError"}}}},"401":{"description":"Unauthorized (missing or invalid worker token).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveWorkerTransactionHistory-v2026-04-30RequestUnauthorizedError"}}}},"403":{"description":"Forbidden (not allowed for this worker or token).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveWorkerTransactionHistory-v2026-04-30RequestForbiddenError"}}}},"404":{"description":"Operation failed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiErrorContainer"}}}},"412":{"description":"Precondition failed (e.g. icEmbeddedWorkerSetup is not enabled for the organization).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveWorkerTransactionHistory-v2026-04-30RequestPreconditionFailedError"}}}},"500":{"description":"Internal server error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrieveWorkerTransactionHistory-v2026-04-30RequestInternalServerError"}}}}}}}},"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":{"InvoicesIdDownloadGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the invoice."},"url":{"type":["string","null"],"description":"URL to the requested invoice for download. This URL may expire after a certain duration."},"expires_at":{"type":"string","format":"date-time","description":"The expiration date and time of the download URL, after which the URL will no longer be accessible."}},"required":["url"],"title":"InvoicesIdDownloadGetResponsesContentApplicationJsonSchemaData"},"Accounting_getBillingInvoiceDownloadLink_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/InvoicesIdDownloadGetResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"Accounting_getBillingInvoiceDownloadLink_Response_200"},"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"},"InvoicesInvoiceIdGetResponsesContentApplicationJsonSchemaDataStatus":{"type":"string","enum":["open","pending","skipped","preprocessing","processing","credited","processed","paid","failed","cancelled","refunded","unpayable","awaiting_payment"],"description":"Current payment status of the invoice.","title":"InvoicesInvoiceIdGetResponsesContentApplicationJsonSchemaDataStatus"},"InvoicesInvoiceIdGetResponsesContentApplicationJsonSchemaDataLineItemsItemsType":{"type":"string","enum":["AI_WORKFORCE_MONTHLY_FEE","ANON_REPORT_FEE","ANYTIME_PAY_GP_RESERVE","ASO_FEE","ASO_PAYROLL_FUNDING","ATS_LINKEDIN_PREMIUM_FEE","BACKGROUND_CHECK_FEE","BANK_ACCOUNT_OPENING_FEE","BANK_FILE_FEE","BENEFITS_ADMIN_MONTHLY_PLATFORM_FEE","CLIENT_PREFUNDING_AMOUNT","COR_LOCAL_COLLECTION_FEE","COR_START_DELAY","CUSTOM_DOMAIN_FEE","CUSTOM_ONE_OFF_COST","CUSTOM_ONE_OFF_FEE","DEEL_ATS_SUBSCRIPTIONS","DEEL_COMPENSATION_FEE","DEEL_ENGAGE_ATS_FEE","DEEL_ENGAGE_MONTHLY_SUBSCRIPTION_FEE","DEEL_FIELD_SERVICES_EOR_FEES","DEEL_FIELD_SERVICES_PASSTHROUGH_FEES","DEEL_FIELD_SERVICES_SWM_FEES","DEEL_HR_FEE","DEEL_HRIS_FEE","DEEL_IT_ACCESSORY_REPLACEMENT","DEEL_IT_APP_RESALE","DEEL_IT_ASSEMBLED_DELIVERY","DEEL_IT_BYOD_ACTIVATION_FEE","DEEL_IT_BYOD_STORAGE_FEE","DEEL_IT_CANCELLATION","DEEL_IT_CERTIFIED_DATA_ERASURE","DEEL_IT_CLEARANCE","DEEL_IT_CUSTOM_SHIPPING","DEEL_IT_CUSTOM_SOURCING","DEEL_IT_DEVICE_UNLOCK_FEE","DEEL_IT_ENDPOINT_PROTECTION_FEES","DEEL_IT_ENDPOINT_PROTECTION_FEES_OVERAGES","DEEL_IT_END_OF_CONTRACT_PURCHASE","DEEL_IT_EXPRESS_SHIPPING","DEEL_IT_EXTENDED_WARRANTY","DEEL_IT_IDENTITY_FEES","DEEL_IT_IDENTITY_FEES_OVERAGES","DEEL_IT_IT_SEAT","DEEL_IT_IT_SERVICE_DESK","DEEL_IT_JC_PLATFORM_FEES","DEEL_IT_JC_PLATFORM_FEES_OVERAGES","DEEL_IT_JC_PLATFORMPRIME_FEES","DEEL_IT_JC_PLATFORMPRIME_FEES_OVERAGES","DEEL_IT_LAPTOP_CONFIG","DEEL_IT_LOANER","DEEL_IT_MDM","DEEL_IT_MDM_OVERAGES","DEEL_IT_NON_DEEL_IT_DEVICE_CHARGE","DEEL_IT_PACKAGING","DEEL_IT_PURCHASE","DEEL_IT_REDISTRIBUTION_FEE","DEEL_IT_RENTAL","DEEL_IT_REPAIR","DEEL_IT_REPAIR_WITH_PARTS","DEEL_IT_REPLACEMENT","DEEL_IT_SAAS","DEEL_IT_SERVICE","DEEL_IT_SERVICE_BUNDLE","DEEL_IT_SHIPPING","DEEL_IT_SINGLE_ITEM_FEE","DEEL_IT_STOREFRONT_FEE","DEEL_IT_STORE_AND_REUSE_CUSTOMER_OWNED_FEE","DEEL_IT_STORE_AND_REUSE_CUSTOMER_OWNED_STORAGE_FEE","DEEL_IT_STORE_AND_REUSE_FEE","DEEL_IT_VAT","DEEL_IT_WELCOME_PACK","DEEL_MAINTENANCE_FEE","DEEL_TALENT_CLIENT_SAAS_FEE_ONE_OFF","DEEL_TALENT_CLIENT_SAAS_FEE_RECURRING","DEEL_TALENT_TP_SAAS_FEE_ONE_OFF","DEEL_TALENT_TP_SAAS_FEE_RECURRING","DEEL_WORKFORCE_PLANNING_SUBSCRIPTIONS","DEPOSIT_REFUND","DISCOUNT","DPA_AGREEMENT_FEE","EMPLOYEE_NAVIGATOR_IMPLEMENTATION_FEE","EMPLOYEE_NAVIGATOR_PEPM_FEE","ENGAGE_HR_SUITE_SUBSCRIPTION_FEE","ENGAGE_PLUGINS_SUBSCRIPTION_FEE","ENGAGE_ZAVVY_LEGACY_SUBSCRIPTION_FEE","ENTITY_MANAGEMENT_PLATFORM_FEE","ENTITY_SETUP_FEE","EOR_13_TH_14_TH_MONTH_SALARY","EOR_13_TH_MONTH_SALARY","EOR_ACCIDENT_AND_DISABILITY","EOR_ACCIDENT_AND_DISABILITY_FEE","EOR_ACCRUED_HOLIDAY","EOR_ADDITIONAL_FEE","EOR_ALLOWANCE","EOR_ANYTIME_PAYROLL_FEE","EOR_BENEFIT_IN_KIND_WITHHELD_AMOUNT","EOR_BONUS","EOR_COMPANY_DOCTOR_COST","EOR_DEDUCTION","EOR_DEPOSIT","EOR_EARLY_INVOICING_FUNDING_AMOUNT","EOR_EMPLOYER_COST","EOR_EQUITY_TAX_WITHHELD","EOR_EXPENSE","EOR_EXTERNAL_LEGAL_ADVISORY_COST","EOR_FERTILITY","EOR_FERTILITY_FEE","EOR_FERTILITY_PLAN_COST","EOR_FOREIGN_CURRENCY_CONTRACT_FEE","EOR_FOREIGN_CURRENCY_FEE","EOR_HEALTH_ALLOWANCE","EOR_HEALTH_ALLOWANCE_PLAN_COST","EOR_HEALTH_AND_SAFETY_TRAINING_COST","EOR_HEALTH_BENEFIT","EOR_HEALTH_BENEFIT_PLAN_COST","EOR_HEALTH_INSURANCE_FEE","EOR_LEGAL_FEE","EOR_LEGAL_SETTLEMENT_PAYOUT","EOR_LIFE_INSURANCE","EOR_LIFE_INSURANCE_FEE","EOR_LIFE_INSURANCE_PLAN_COST","EOR_LOCAL_COLLECTION_FEE","EOR_MANAGEMENT_FEE","EOR_MEAL_VOUCHER","EOR_MEAL_VOUCHER_FEE","EOR_MEAL_VOUCHER_PLAN_COST","EOR_MEDICAL_ONBOARDING_COST","EOR_MENTAL_HEALTH","EOR_MENTAL_HEALTH_FEE","EOR_MENTAL_HEALTH_PLAN_COST","EOR_NON_STATUTORY_EMPLOYER_COST","EOR_OFFCYCLE","EOR_OFF_BOARDING_FEE","EOR_OTHER","EOR_PENSION","EOR_PENSION_FEE","EOR_PENSION_PLAN_COST","EOR_QES_FEE","EOR_SALARY_ADVANCE","EOR_SETUP_FEE","EOR_SEVERANCE","EOR_SIGNING_BONUS","EOR_SIGNING_BONUS_DEDUCTION","EOR_SIGNING_BONUS_EMPLOYER_COST","EOR_SIGNING_BONUS_EMPLOYER_COST_DEDUCTION","EOR_SINGLE_TERMINATION_FEE","EOR_START_DELAY","EOR_STUDY_FUND","EOR_STUDY_FUND_FEE","EOR_STUDY_FUND_PLAN_COST","EOR_TAX_RULING","EOR_TAX_VAT","EOR_TIME_OFF","EOR_TRAVEL_INSURANCE_ANNUAL_SUBSCRIPTION_FEE","EOR_TRAVEL_INSURANCE_MONTHLY_SUBSCRIPTION_FEE","EOR_VISA_MANAGEMENT_FEE","EOR_WET_INK_FEE","EOR_WORK","EQUITY_ANNUAL_SUBSCRIPTION_FEE","EQUITY_EOR_PER_HEAD_FEE","EQUITY_IMPLEMENTATION_FEE","EQUITY_MAINTENANCE_FEE","EXPENSE_CARD","EXPENSE_CARD_FEE","G2N_BENEFITS","G2N_BENEFIT_IN_KIND","G2N_EMPLOYER_CONTRIBUTIONS","G2N_EOR_NET_PAY_WITHOUT_EXPENSES","G2N_GROSS_DEDUCTIONS","G2N_GROSS_TAXABLE","G2N_NET_ADDITIONS","G2N_NET_DEDUCTIONS","G2N_NET_PAY","G2N_ODP_OFFSET","G2N_ON_CALL_OVERTIME","G2N_OTHER_ADJUSTMENTS","G2N_PAY_RATE","G2N_SEVERANCE","G2N_TOTAL_EXPENSES","G2N_VACATION_PAYOUT","G2N_WAGE_ADDITIONS","G2N_WORKER_TAX_AND_CONTRIBUTIONS","GLOBAL_HR_CONSULTING_ANNUAL_SUBSCRIPTION_FEE","GLOBAL_HR_CONSULTING_EOR_MASS_TERMINATION_FEE","GLOBAL_HR_CONSULTING_MANAGED_HR_MONTHLY_SUBSCRIPTION_FEE","GLOBAL_HR_CONSULTING_MONTHLY_SUBSCRIPTION_FEE","GLOBAL_HR_CONSULTING_PROJECT_FEE","GLOBAL_HR_DPO_AS_A_SERVICE_ANNUAL_SUBSCRIPTION_FEE","GLOBAL_HR_EU_UK_REPRESENTATIVE_SERVICE_ANNUAL_SUBSCRIPTION_FEE","GLOBAL_HR_PRIVACY_CONSULTING_SERVICES_ANNUAL_SUBSCRIPTION_FEE","GLOBAL_HR_PRIVACY_SERVICES_ANNUAL_SUBSCRIPTION_FEE","GL_CUSTOM_CONFIGURATION","GP_ADD_ON_FEE","GP_ADVANCE_PAYMENTS_FEE","GP_BANK_ACCOUNTS_OPENED","GP_CHINA_DECLARATIONS","GP_DEEL_LIABILITY","GP_DEPOSIT","GP_EARLY_TERMINATION_FEE","GP_ELECTRONIC_SAFE_PAYSLIPS","GP_EMPLOYEE_AGREEMENTS_EFE","GP_EMPLOYEE_FUNDING","GP_EXCEPTIONAL_MATTERS_HOURS_FEE","GP_EXPENSES_FEE","GP_GB_PENSION_FUND_MANAGEMENT","GP_GLOBAL_RERUN_OF_PAYROLL_REPORTS_FEE","GP_LEGAL_CONTROL_ASSISTANCE_HOURS_FEE","GP_MEAL_VOUCHERS","GP_MEDICAL_VISITS","GP_NEW_BRANCH_CREATION_ASSISTANCES","GP_NEW_REPORTS_AND_MODIFICATIONS_FEE","GP_NON_AUTOMATED_LODGEMENTS_FEE","GP_OFFCYCLE_MODIFICATIONS_OR_RERUN_FEE","GP_PARALLEL_RUN_FEE","GP_PAYROLL_CONNECT_FEE","GP_PAYROLL_CONNECT_SETUP_ENTITY_FEE_FLAT","GP_PAYROLL_EMPLOYEE_FEE","GP_PAYROLL_EMPLOYEE_SERVICE_FEE","GP_PAYROLL_ENTITY_SETUP_FEE","GP_PAYROLL_FEE","GP_PAYROLL_FEE_PER_COUNTRY","GP_PAYROLL_FUNDING_FEE","GP_PAYROLL_OFFBOARDING_FEE","GP_PAYROLL_ONBOARDING_FEE","GP_PAYROLL_SOFTWARE_FEE","GP_START_DELAY","GP_VAT_TAX","GP_WORK_VISAS","GP_YEARLY_CLOSING_FEE","HEALTH_INSURANCE_ANNUAL_SUBSCRIPTION_FEE","HEALTH_INSURANCE_FEE","HEALTH_INSURANCE_MONTHLY_SUBSCRIPTION_FEE","HOFY_EQUIPMENT_MONTHLY_SUBSCRIPTION_FEE","HOFY_EQUIPMENT_SEMIANNUAL_SUBSCRIPTION_FEE","HOFY_EQUIPMENT_SERVICE","HOFY_EQUIPMENT_TERMINATION_FEE","IC_BONUS","IC_COMMISSION","IC_DEDUCTION","IC_DEEL_PERCENTAGE_FEE","IC_DEEL_PREMIUM","IC_EXPENSE","IC_MILESTONE","IC_OFFCYCLE","IC_OTHER","IC_OVERTIME","IC_PRO_RATA","IC_SAAS_FLAT","IC_SAAS_MISSING_FEES","IC_SAAS_PER_CONTRACT","IC_START_DELAY","IC_TASK","IC_TAX_VAT","IC_TIME_OFF","IC_WITHHOLDING_TAX","IC_WORK","INTEGRATION_HRIS_FEE","INTERCOMPANY_MARKUP_SALARY_EXPENSES","INTERCOMPANY_OTHER_FINANCIAL_EXPENSES","INTERCOMPANY_OTHER_FINANCIAL_INCOME","INTERCOMPANY_PAYMENTS_LEASE_SERVICES","INTERCOMPANY_PAYMENTS_MARKET_PENETRATION","INTERCOMPANY_PAYMENT_EOR_GP_SERVICES","INTERCOMPANY_PAYMENT_EOR_SERVICES","INTERCOMPANY_PAYMENT_GP_SERVICES","INTERCOMPANY_PAYMENT_TECHNOLOGY_BASED_SERVICES","INTERCOMPANY_PROVISION_COGS_SERVICES","INTERCOMPANY_PROVISION_G_AND_A_SERVICES","INTERCOMPANY_PROVISION_PRE_POST_SALES_SERVICES","INTERCOMPANY_PROVISION_R_AND_D_SERVICES","INTERCOMPANY_SALARY_EXPENSES_PARTICIPATION","LATE_PAYMENT_FEE","LOCAL_TAX_REIMBURSEMENT_FEE","MANAGED_HR_MONTHLY_SUBSCRIPTION_FEE","MOBILITY_BUSINESS_VISA_APPLICATION","MOBILITY_BUSINESS_VISA_DOCUMENT_PREPARATION","MOBILITY_BUSINESS_VISA_ISSUANCE","MOBILITY_BUSINESS_VISA_TRAVEL_LETTER","MOBILITY_DOCUMENTATION_FEE","MOBILITY_DOCUMENT_A_ONE_CERTIFICATE","MOBILITY_DOCUMENT_COLLECTION","MOBILITY_DOCUMENT_ISSUANCE","MOBILITY_DOCUMENT_MANAGEMENT","MOBILITY_DOCUMENT_PREPARATION","MOBILITY_DOCUMENT_REVIEW","MOBILITY_EXPENSE_GOVERNMENT_FEES","MOBILITY_EXPENSE_MAIL_TRANSPORTATION","MOBILITY_EXPENSE_OTHER","MOBILITY_EXPENSE_PRINTING","MOBILITY_EXPENSE_TRANSLATION","MOBILITY_GOVERNMENT_STATUTORY_LEGAL_FEE","MOBILITY_H1_B_LOTTERY","MOBILITY_IMMIGRATION_CONSULTATION","MOBILITY_IMMIGRATION_DEPENDANT","MOBILITY_IMMIGRATION_DEPENDANT_RENEWAL","MOBILITY_IMMIGRATION_EMPLOYER_TRANSFER","MOBILITY_IMMIGRATION_FAST_TRACK","MOBILITY_IMMIGRATION_PROCESSING_FEE","MOBILITY_IMMIGRATION_RENEWAL_EXTENSION","MOBILITY_IMMIGRATION_VISA_CANCELLATION","MOBILITY_IMMIGRATION_WORK_PERMIT","MOBILITY_NOTIFICATION_CHANGE_OF_EMPLOYER","MOBILITY_NOTIFICATION_GENERAL","MOBILITY_NOTIFICATION_PREFECTURE","MOBILITY_USCIS_PREMIUM_PROCESSING","NETX_FEE","OFFICE_SOLUTION_COST","OFFICE_SOLUTION_FEE","PAYGROUP_ASTUTE_CUSTOM_DEVELOPMENT_FEE","PAYGROUP_ASTUTE_FEE","PAYGROUP_ASTUTE_IMPLEMENTATION_FEE","PAYGROUP_ASTUTE_INTEGRATION_FEE","PAYGROUP_COR_CONTRACTOR_COST","PAYGROUP_COR_MANAGEMENT_FEE","PAYGROUP_EOR_DEPOSIT","PAYGROUP_EOR_EMPLOYEE_COST","PAYGROUP_EOR_MANAGEMENT_FEE","PAYGROUP_FLARE_REFERRAL_FEE","PAYGROUP_GP_ADDITIONAL_PROCESSING_FEE_OFFCYCLES","PAYGROUP_GP_ADDITIONAL_PROCESSING_FEE_ONBOARDING","PAYGROUP_GP_ADDITIONAL_PROCESSING_FEE_TERMINATIONS","PAYGROUP_GP_ANNUAL_LODGEMENT_PROCESSING_FEE","PAYGROUP_GP_ANNUAL_PAYMENT_SUMMARY_FEE","PAYGROUP_GP_EMPLOYEE_REPORT_FEE","PAYGROUP_GP_IMPLEMENTATION_FEE","PAYGROUP_GP_LODGEMENT_FEE","PAYGROUP_GP_TREASURY_FEE","PAYGROUP_HR_MANAGEMENT_FEE","PAYGROUP_HR_MANAGER_FEE","PAYGROUP_IWS_BAS_LODGEMENT_FEE","PAYGROUP_IWS_BOOKKEEPING_FEE","PAYGROUP_IWS_IMPLEMENTATION_FEE","PAYGROUP_IWS_ROSTERING_FEE","PAYGROUP_PAYROLL_PROCESSING_FEE","PAYGROUP_RECRUITMENT_FEE","PAYGROUP_SMS_FEE","PAYGROUP_TALENTOZ_ANNUAL_SUBSCRIPTION_FEE","PAYGROUP_TALENTOZ_IMPLEMENTATION_FEE","PAYGROUP_TAX_CGST","PAYGROUP_TAX_CONSUMPTION","PAYGROUP_TAX_GST","PAYGROUP_TAX_IGST","PAYGROUP_TAX_SGST","PAYGROUP_TAX_SST","PAYGROUP_TAX_VAT","PAYMENT_PROCESSING_FEE","PEO_CARROT_FERTILITY_JOURNEY_FEE","PEO_COBRA_CONTINUATION_FEE","PEO_EARLY_TERMINATION_FEE","PEO_EMPLOYEE_FUNDING","PEO_EXPENSES_FEE","PEO_FEE","PEO_LATE_PAYMENT_FEE","PEO_OFFCYCLE_FEE","PEO_NON_PEO_EE_MINERAL_ACCESS_FEE","PEO_PAYROLL_COST","PEO_POSTERS","PEO_RETIREMENT_PLAN_ADMIN_FEE","PEO_RETIREMENT_PLAN_ESTABLISHMENT_FEE","PEO_RETROACTIVE_FEE","PEO_TIMECO_FEE","PEO_WC_BILLING_ND","PEO_WC_BILLING_OH","PEO_WC_BILLING_WA","PEO_WC_BILLING_WY","PEO_DELIVERY_FEE","PEO_IMPLEMENTATION_FEE","POST_REGISTRATION_FEE","PREPAID_BILLING_CONTRACTOR","PREPAID_BILLING_EOR","PREPAID_BILLING_EXPIRED_CREDITS","PREPAID_BILLING_FUNDING_AMOUNT","PRE_REGISTRATION_FEE","REFUND","SAAS_PER_EQUIPMENT_FEE","SERVICE_REFUND","SHIELD_DEPOSIT","SHIELD_MANAGEMENT_FEE","SHIELD_PAYROLL_COSTS","SYSTEM_INTEGRATOR_FEE","TALENT_FEE","TAX_CUSTOM","TRAVEL_INSURANCE_ANNUAL_SUBSCRIPTION_FEE","TRAVEL_INSURANCE_FEE","TRAVEL_INSURANCE_MONTHLY_SUBSCRIPTION_FEE","UNSPECIFIED","US_OFFCYCLE_MODIFICATIONS_OR_RERUN_FEE","US_PAYROLL_CERTIFICATE_OF_GOOD_STANDING_FEE","US_PAYROLL_DUPLICATE_FILING_FEE","US_PAYROLL_EMPLOYEE_FEE","US_PAYROLL_EMPLOYEE_FUNDING","US_PAYROLL_EXPENSES_FEE","US_PAYROLL_FRANCHISE_REGISTRATION_SETUP_FEE","US_PAYROLL_FRANCHISE_REGISTRATION_STATE_FILING_FEE","US_PAYROLL_FUNDING_FEE","US_PAYROLL_MAILING_FEE","US_PAYROLL_OFFBOARDING_FEE","US_PAYROLL_ONBOARDING_FEE","US_PAYROLL_PAYROLL_REGISTRATION_SETUP_FEE","US_PAYROLL_PLATFORM_FEE","US_PAYROLL_REGISTERED_AGENT_ANNUAL_SUBSCRIPTION_FEE","VMS_TALENT_PARTNER_FEE","WEWORK_ACCESS_FEE","WITHHOLDING_TAX","EOR_HEALTH_AND_SAFETY_TRAINING_FEE"],"description":"The type of this line item","title":"InvoicesInvoiceIdGetResponsesContentApplicationJsonSchemaDataLineItemsItemsType"},"InvoicesInvoiceIdGetResponsesContentApplicationJsonSchemaDataLineItemsItems":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the line item"},"type":{"$ref":"#/components/schemas/InvoicesInvoiceIdGetResponsesContentApplicationJsonSchemaDataLineItemsItemsType","description":"The type of this line item"},"total":{"type":"string","description":"Total amount for this line item"},"fx_rate":{"type":"string","description":"Exchange rate used for this line item"},"quantity":{"type":"integer","description":"Quantity of units billed in this line item"},"tax_rate":{"type":"string","description":"Tax rate applied to this line item"},"tax_type":{"type":["string","null"],"description":"Type of tax applied (if any); can be null"},"description":{"type":"string","description":"Main description of the line item"},"price_per_unit":{"type":"number","format":"double","description":"Price charged per unit"},"sub_description":{"type":"string","description":"Optional additional description or detail"}},"title":"InvoicesInvoiceIdGetResponsesContentApplicationJsonSchemaDataLineItemsItems"},"InvoicesInvoiceIdGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the invoice"},"label":{"type":"string","description":"Human-readable label or reference number for the invoice"},"total":{"type":"string","description":"Total amount of the invoice"},"status":{"$ref":"#/components/schemas/InvoicesInvoiceIdGetResponsesContentApplicationJsonSchemaDataStatus","description":"Current payment status of the invoice."},"paid_at":{"type":"string","format":"date-time","description":"Date and time when the invoice was paid"},"currency":{"type":"string","description":"Currency code for the invoice total"},"due_date":{"type":"string","format":"date-time","description":"The due date for the invoice payment"},"issued_at":{"type":"string","format":"date-time","description":"Date and time when the invoice was issued"},"worker_id":{"type":"string","format":"uuid","description":"Unique identifier for the worker profile"},"created_at":{"type":"string","format":"date-time","description":"Timestamp of when the invoice was created in the system"},"line_items":{"type":"array","items":{"$ref":"#/components/schemas/InvoicesInvoiceIdGetResponsesContentApplicationJsonSchemaDataLineItemsItems"},"description":"The individual line items associated with the invoice"},"recipient_legal_entity_id":{"type":"string","format":"uuid","description":"Unique identifier for the recipient legal entity"}},"description":"The invoice resource returned","title":"InvoicesInvoiceIdGetResponsesContentApplicationJsonSchemaData"},"Accounting_getInvoiceById-v2026-01-01_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/InvoicesInvoiceIdGetResponsesContentApplicationJsonSchemaData","description":"The invoice resource returned"}},"title":"Accounting_getInvoiceById-v2026-01-01_Response_200"},"InvoicesInvoiceIdGetResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"message":{"type":"string","description":"Error response"}},"required":["message"],"title":"InvoicesInvoiceIdGetResponsesContentApplicationJsonSchemaErrorsItems"},"InvoicesInvoiceIdGetResponsesContentApplicationJsonSchemaRequest":{"type":"object","properties":{"method":{"type":"string","description":"Method of the API"},"status":{"type":"number","format":"double","description":"Status of API response"}},"description":"Error request details","title":"InvoicesInvoiceIdGetResponsesContentApplicationJsonSchemaRequest"},"GetInvoiceById-v2026-01-01RequestNotFoundError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/InvoicesInvoiceIdGetResponsesContentApplicationJsonSchemaErrorsItems"},"description":"Error messages"},"request":{"$ref":"#/components/schemas/InvoicesInvoiceIdGetResponsesContentApplicationJsonSchemaRequest","description":"Error request details"}},"required":["errors"],"title":"GetInvoiceById-v2026-01-01RequestNotFoundError"},"PaymentsPaymentIdBreakdownGetResponsesContentApplicationJsonSchemaDataItemsGroupId1":{"type":"string","enum":[""],"title":"PaymentsPaymentIdBreakdownGetResponsesContentApplicationJsonSchemaDataItemsGroupId1"},"PaymentsPaymentIdBreakdownGetResponsesContentApplicationJsonSchemaDataItemsGroupId":{"oneOf":[{"type":"string","format":"uuid"},{"$ref":"#/components/schemas/PaymentsPaymentIdBreakdownGetResponsesContentApplicationJsonSchemaDataItemsGroupId1"}],"description":"Unique identifier for the group associated with this payment. Empty for organization-level payments, individual payments, and standalone service fees that are not associated with a specific group.","title":"PaymentsPaymentIdBreakdownGetResponsesContentApplicationJsonSchemaDataItemsGroupId"},"PaymentsPaymentIdBreakdownGetResponsesContentApplicationJsonSchemaDataItemsFrequency":{"type":"string","enum":["hourly","daily","weekly","biweekly","semimonthly","monthly","custom",""],"description":"Work unit scale from the contractor's work statement. Indicates how work is measured and reported (hourly, daily, weekly, monthly, or custom units). Empty for contracts with fixed payments that don't require work quantity tracking, such as milestone-based contracts and consulting agreements.","title":"PaymentsPaymentIdBreakdownGetResponsesContentApplicationJsonSchemaDataItemsFrequency"},"PaymentsPaymentIdBreakdownGetResponsesContentApplicationJsonSchemaDataItemsApproveDate1":{"type":"string","enum":[""],"title":"PaymentsPaymentIdBreakdownGetResponsesContentApplicationJsonSchemaDataItemsApproveDate1"},"PaymentsPaymentIdBreakdownGetResponsesContentApplicationJsonSchemaDataItemsApproveDate":{"oneOf":[{"type":"string","format":"date-time"},{"$ref":"#/components/schemas/PaymentsPaymentIdBreakdownGetResponsesContentApplicationJsonSchemaDataItemsApproveDate1"}],"description":"Date when the work report was approved by designated approvers. Empty for payments that don't require work report approval, such as service fees, management fees, and automated payments.","title":"PaymentsPaymentIdBreakdownGetResponsesContentApplicationJsonSchemaDataItemsApproveDate"},"PaymentsPaymentIdBreakdownGetResponsesContentApplicationJsonSchemaDataItemsContractType":{"type":"string","enum":["milestones","time_based","ongoing_time_based","pay_as_you_go_time_based","commission","payg_milestones","payg_tasks","eor","peo","peo_csa","unknown","employee","global_payroll","shield_msa","gp_client_agreement","ep_client_agreement","power_of_attorney","debt_authorization","hris_direct_employee","hris_service_agreement","hofy_standalone_payment","wework_standalone_payment","travel_insurance_standalone_payment","health_insurance_standalone_payment","prepaid_billing","missing_saas_fees","one_off_service_fee","eor_management_fee","eor_one_off_management_fee","engage_monthly_subscription_fee","ats_subscription_fee","benefits_admin_monthly_platform_fee","contractor_outside_deel","late_payment_fee","background_check_standalone_payment","peo_service_fee","payment_processing_fee","deel_percentage_fee","netx_fee","prepaid_funding_statement","one_off_mobility_service_fee","prepaid_billing_expired_credits","implementation_delay","managed_hr_monthly_subscription_fee","expense_card","anon_report_fee","ic_maintenance_platform_fee"],"description":"Type of contract this payment relates to. Determines the nature of the work relationship and payment structure.","title":"PaymentsPaymentIdBreakdownGetResponsesContentApplicationJsonSchemaDataItemsContractType"},"PaymentsPaymentIdBreakdownGetResponsesContentApplicationJsonSchemaDataItemsContractStartDate1":{"type":"string","enum":[""],"title":"PaymentsPaymentIdBreakdownGetResponsesContentApplicationJsonSchemaDataItemsContractStartDate1"},"PaymentsPaymentIdBreakdownGetResponsesContentApplicationJsonSchemaDataItemsContractStartDate":{"oneOf":[{"type":"string","format":"date-time"},{"$ref":"#/components/schemas/PaymentsPaymentIdBreakdownGetResponsesContentApplicationJsonSchemaDataItemsContractStartDate1"}],"description":"Start date of the contract. Empty for service agreements and fee-related contracts (such as equipment payments, insurance payments, and management fees) that don't have traditional contract start dates.","title":"PaymentsPaymentIdBreakdownGetResponsesContentApplicationJsonSchemaDataItemsContractStartDate"},"PaymentsPaymentIdBreakdownGetResponsesContentApplicationJsonSchemaDataItemsContractorUniqueIdentifier1":{"type":"string","enum":[""],"title":"PaymentsPaymentIdBreakdownGetResponsesContentApplicationJsonSchemaDataItemsContractorUniqueIdentifier1"},"PaymentsPaymentIdBreakdownGetResponsesContentApplicationJsonSchemaDataItemsContractorUniqueIdentifier":{"oneOf":[{"type":"string","format":"uuid"},{"$ref":"#/components/schemas/PaymentsPaymentIdBreakdownGetResponsesContentApplicationJsonSchemaDataItemsContractorUniqueIdentifier1"}],"description":"Unique identifier for the worker. May be empty for certain contract types such as service agreements and fees.","title":"PaymentsPaymentIdBreakdownGetResponsesContentApplicationJsonSchemaDataItemsContractorUniqueIdentifier"},"PaymentsPaymentIdBreakdownGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"date":{"type":"string","format":"date-time","description":"Date associated with the payment breakdown."},"work":{"type":"string","description":"Base payment amount for work performed, including regular salary/wages and off-cycle payments."},"bonus":{"type":"string","description":"Additional bonus payment amount awarded to the worker."},"total":{"type":"string","description":"Total payment due for this breakdown item."},"others":{"type":"string","description":"Other payment amounts."},"currency":{"type":"string","description":"Currency code for this payment."},"expenses":{"type":"string","description":"Expenses related to the payment."},"group_id":{"$ref":"#/components/schemas/PaymentsPaymentIdBreakdownGetResponsesContentApplicationJsonSchemaDataItemsGroupId","description":"Unique identifier for the group associated with this payment. Empty for organization-level payments, individual payments, and standalone service fees that are not associated with a specific group."},"overtime":{"type":"string","description":"Overtime payment amount."},"pro_rata":{"type":"string","description":"Pro-rated payment amount."},"approvers":{"type":"string","description":"Comma-separated list of names of people who approved this payment. May be empty if no approvals were required or recorded."},"frequency":{"$ref":"#/components/schemas/PaymentsPaymentIdBreakdownGetResponsesContentApplicationJsonSchemaDataItemsFrequency","description":"Work unit scale from the contractor's work statement. Indicates how work is measured and reported (hourly, daily, weekly, monthly, or custom units). Empty for contracts with fixed payments that don't require work quantity tracking, such as milestone-based contracts and consulting agreements."},"adjustment":{"type":"string","description":"Adjustment amount for the payment."},"deductions":{"type":"string","description":"Deductions from the payment."},"invoice_id":{"type":"string","description":"Unique identifier of this resource."},"commissions":{"type":"string","description":"Commissions included in the payment."},"approve_date":{"$ref":"#/components/schemas/PaymentsPaymentIdBreakdownGetResponsesContentApplicationJsonSchemaDataItemsApproveDate","description":"Date when the work report was approved by designated approvers. Empty for payments that don't require work report approval, such as service fees, management fees, and automated payments."},"payment_date":{"type":"string","format":"date-time","description":"Date when the payment was made."},"contract_type":{"$ref":"#/components/schemas/PaymentsPaymentIdBreakdownGetResponsesContentApplicationJsonSchemaDataItemsContractType","description":"Type of contract this payment relates to. Determines the nature of the work relationship and payment structure."},"processing_fee":{"type":"string","description":"Processing fee amount applied to the payment."},"contract_country":{"type":"string","description":"Country where the contract is established."},"contractor_email":{"type":"string","description":"Email address of the worker."},"payment_currency":{"type":"string","description":"Currency in which the payment was processed."},"contract_start_date":{"$ref":"#/components/schemas/PaymentsPaymentIdBreakdownGetResponsesContentApplicationJsonSchemaDataItemsContractStartDate","description":"Start date of the contract. Empty for service agreements and fee-related contracts (such as equipment payments, insurance payments, and management fees) that don't have traditional contract start dates."},"general_ledger_account":{"type":"string","description":"General ledger account code or name for accounting purposes. May be configured at the group, company, or organization level. Empty if not configured."},"total_payment_currency":{"type":"string","description":"Total payment in the payment currency."},"contractor_employee_name":{"type":"string","description":"Name of the worker."},"contractor_unique_identifier":{"$ref":"#/components/schemas/PaymentsPaymentIdBreakdownGetResponsesContentApplicationJsonSchemaDataItemsContractorUniqueIdentifier","description":"Unique identifier for the worker. May be empty for certain contract types such as service agreements and fees."}},"title":"PaymentsPaymentIdBreakdownGetResponsesContentApplicationJsonSchemaDataItems"},"Accounting_retrieveAPaymentBreakdown-v2026-01-01_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/PaymentsPaymentIdBreakdownGetResponsesContentApplicationJsonSchemaDataItems"}}},"title":"Accounting_retrieveAPaymentBreakdown-v2026-01-01_Response_200"},"InvoicesDeelGetResponsesContentApplicationJsonSchemaDataItemsStatus":{"type":"string","enum":["pending","paid","processing","canceled","skipped","failed","refunded"],"description":"Current status of the invoice.","title":"InvoicesDeelGetResponsesContentApplicationJsonSchemaDataItemsStatus"},"InvoicesDeelGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the invoice."},"label":{"type":"string","description":"Label of the invoice."},"total":{"type":"string","description":"Total invoice amount including Fee and VAT."},"status":{"$ref":"#/components/schemas/InvoicesDeelGetResponsesContentApplicationJsonSchemaDataItemsStatus","description":"Current status of the invoice."},"currency":{"type":"string","description":"Currency code."},"created_at":{"type":["string","null"],"format":"date-time","description":"Long date-time format following ISO-8601"}},"required":["id","label","total","status","currency","created_at"],"title":"InvoicesDeelGetResponsesContentApplicationJsonSchemaDataItems"},"InvoicesDeelGetResponsesContentApplicationJsonSchemaPage":{"type":"object","properties":{"offset":{"type":"number","format":"double","description":"Offset"},"total_rows":{"type":"number","format":"double","description":"Total number of rows"},"items_per_page":{"type":"number","format":"double","description":"Number of items per page"}},"required":["offset","total_rows","items_per_page"],"title":"InvoicesDeelGetResponsesContentApplicationJsonSchemaPage"},"Accounting_retrieveDeelInvoices_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/InvoicesDeelGetResponsesContentApplicationJsonSchemaDataItems"}},"page":{"$ref":"#/components/schemas/InvoicesDeelGetResponsesContentApplicationJsonSchemaPage"}},"required":["data","page"],"title":"Accounting_retrieveDeelInvoices_Response_200"},"InvoicesGetParametersStatus":{"type":"string","enum":["all"],"title":"InvoicesGetParametersStatus"},"InvoicesGetParametersInclude":{"type":"string","enum":["cor"],"title":"InvoicesGetParametersInclude"},"InvoicesGetResponsesContentApplicationJsonSchemaDataItemsStatus":{"type":"string","enum":["pending","paid","processing","credited","refunded"],"description":"Current status of the invoice.","title":"InvoicesGetResponsesContentApplicationJsonSchemaDataItemsStatus"},"InvoicesGetResponsesContentApplicationJsonSchemaDataItemsPaidAt":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string"}],"description":"Date/time when the invoice was paid (ISO-8601). May be null or empty string.","title":"InvoicesGetResponsesContentApplicationJsonSchemaDataItemsPaidAt"},"InvoicesGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of this resource."},"label":{"type":"string","description":"Label or reference number of the invoice."},"total":{"type":"string","description":"Total invoice amount, including fees and VAT."},"amount":{"type":["string","null"],"description":"Billed amount of the invoice."},"status":{"$ref":"#/components/schemas/InvoicesGetResponsesContentApplicationJsonSchemaDataItemsStatus","description":"Current status of the invoice."},"vat_id":{"type":["string","null"],"description":"VAT identification number related to the invoice."},"paid_at":{"$ref":"#/components/schemas/InvoicesGetResponsesContentApplicationJsonSchemaDataItemsPaidAt","description":"Date/time when the invoice was paid (ISO-8601). May be null or empty string."},"currency":{"type":"string","description":"Three-letter currency code for the invoice."},"deel_fee":{"type":["string","null"],"description":"Fee charged by Deel."},"due_date":{"type":["string","null"],"format":"date-time","description":"Date and time when the invoice is due (ISO-8601 format)."},"issued_at":{"type":["string","null"],"format":"date-time","description":"Date and time when the invoice was issued (ISO-8601 format)."},"vat_total":{"type":["string","null"],"description":"Total amount of VAT charged on the invoice."},"created_at":{"type":"string","format":"date-time","description":"Date and time when the invoice was created (ISO-8601 format)."},"is_overdue":{"type":["boolean","null"],"description":"Indicates whether the invoice is overdue."},"contract_id":{"type":["string","null"],"description":"Unique identifier of the related contract."},"vat_percentage":{"type":["string","null"],"description":"Percentage of VAT charged on the invoice."},"recipient_legal_entity_id":{"type":"string","format":"uuid","description":"Unique identifier for the recipient legal entity"}},"required":["id","label","total","status","vat_id","paid_at","currency","due_date","issued_at","vat_total","created_at","is_overdue","contract_id","vat_percentage"],"title":"InvoicesGetResponsesContentApplicationJsonSchemaDataItems"},"InvoicesGetResponsesContentApplicationJsonSchemaPage":{"type":"object","properties":{"cursor":{"type":["string","null"],"description":"Cursor for paginated results."},"offset":{"type":"number","format":"double","description":"The starting position of the current page of results."},"total_rows":{"type":"number","format":"double","description":"Total number of rows available for the query."},"items_per_page":{"type":"number","format":"double","description":"Number of items displayed per page."}},"required":["offset","total_rows","items_per_page"],"title":"InvoicesGetResponsesContentApplicationJsonSchemaPage"},"Accounting_retrieveInvoices_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/InvoicesGetResponsesContentApplicationJsonSchemaDataItems"}},"page":{"$ref":"#/components/schemas/InvoicesGetResponsesContentApplicationJsonSchemaPage"}},"required":["data","page"],"title":"Accounting_retrieveInvoices_Response_200"},"InvoicesGetResponsesContentApplicationJsonSchemaItems":{"type":"object","properties":{"code":{"type":"string","description":"Machine readable error"},"message":{"type":"string","description":"Description of the returned error"}},"title":"InvoicesGetResponsesContentApplicationJsonSchemaItems"},"PaymentsGetParametersCurrencies":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}],"title":"PaymentsGetParametersCurrencies"},"PaymentsGetParametersEntitiesSchemaOneOf0Items":{"type":"string","enum":["individual","company"],"title":"PaymentsGetParametersEntitiesSchemaOneOf0Items"},"PaymentsGetParametersEntities0":{"type":"array","items":{"$ref":"#/components/schemas/PaymentsGetParametersEntitiesSchemaOneOf0Items"},"title":"PaymentsGetParametersEntities0"},"PaymentsGetParametersEntities1":{"type":"string","enum":["individual","company"],"title":"PaymentsGetParametersEntities1"},"PaymentsGetParametersEntities":{"oneOf":[{"$ref":"#/components/schemas/PaymentsGetParametersEntities0"},{"$ref":"#/components/schemas/PaymentsGetParametersEntities1"}],"title":"PaymentsGetParametersEntities"},"PaymentsGetParametersStatusesSchemaOneOf0Items":{"type":"string","enum":["paid","processing"],"title":"PaymentsGetParametersStatusesSchemaOneOf0Items"},"PaymentsGetParametersStatuses0":{"type":"array","items":{"$ref":"#/components/schemas/PaymentsGetParametersStatusesSchemaOneOf0Items"},"title":"PaymentsGetParametersStatuses0"},"PaymentsGetParametersStatuses1":{"type":"string","enum":["paid","processing"],"title":"PaymentsGetParametersStatuses1"},"PaymentsGetParametersStatuses":{"oneOf":[{"$ref":"#/components/schemas/PaymentsGetParametersStatuses0"},{"$ref":"#/components/schemas/PaymentsGetParametersStatuses1"}],"title":"PaymentsGetParametersStatuses"},"PaymentsGetResponsesContentApplicationJsonSchemaDataRowsItemsStatus":{"type":"string","enum":["paid","processing"],"description":"Status of the payment. Either 'paid' or 'processing'.","title":"PaymentsGetResponsesContentApplicationJsonSchemaDataRowsItemsStatus"},"PaymentsGetResponsesContentApplicationJsonSchemaDataRowsItemsWorkersItems":{"type":"object","properties":{"id":{"type":["string","null"],"format":"uuid","description":"Unique identifier for the worker."},"name":{"type":"string","default":"","description":"Full name of the worker."},"picUrl":{"type":["string","null"],"description":"URL to the worker's Deel avatar."},"contract_id":{"type":["string","null"],"description":"The unique identifier of the employee contract."}},"required":["picUrl"],"title":"PaymentsGetResponsesContentApplicationJsonSchemaDataRowsItemsWorkersItems"},"PaymentsGetResponsesContentApplicationJsonSchemaDataRowsItemsInvoicesItems":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the invoice."}},"required":["id"],"title":"PaymentsGetResponsesContentApplicationJsonSchemaDataRowsItemsInvoicesItems"},"PaymentsGetResponsesContentApplicationJsonSchemaDataRowsItemsPaymentMethodType":{"type":"string","enum":["stripe_bacs_debit","pay_pal","stripe_card","bt_card","stripe_ach","coinbase","go_cardless","brex","stripe_sepa_debit","transferwise","go_cardless_becs","bank_transfer","mercury_wire","bt_pay_pal","ach","client_balance","fee_credits","eor_funding_balance","alviere_ach","adyen_card"],"description":"Type of payment method used for the transaction.","title":"PaymentsGetResponsesContentApplicationJsonSchemaDataRowsItemsPaymentMethodType"},"PaymentsGetResponsesContentApplicationJsonSchemaDataRowsItemsPaymentMethod":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/PaymentsGetResponsesContentApplicationJsonSchemaDataRowsItemsPaymentMethodType","description":"Type of payment method used for the transaction."}},"description":"Payment method details for the transaction.","title":"PaymentsGetResponsesContentApplicationJsonSchemaDataRowsItemsPaymentMethod"},"PaymentsGetResponsesContentApplicationJsonSchemaDataRowsItemsGeneralFundsUsed":{"type":"object","properties":{"amount":{"type":"string","description":"Amount deducted from general funds, in the payment currency. '0.00' if not used."},"original_amount":{"type":["string","null"],"description":"Amount deducted from general funds, in the original currency it was held in. Null if not used."},"original_currency":{"type":["string","null"],"description":"Currency in which the general funds were held, following ISO 4217. Null if not used."}},"description":"Amount paid using the client's general balance funds.","title":"PaymentsGetResponsesContentApplicationJsonSchemaDataRowsItemsGeneralFundsUsed"},"PaymentsGetResponsesContentApplicationJsonSchemaDataRowsItemsDeelGrantedCreditsUsed":{"type":"object","properties":{"amount":{"type":"string","description":"Amount deducted from Deel-granted credits, in the payment currency. '0.00' if not used."},"original_amount":{"type":["string","null"],"description":"Amount deducted from Deel-granted credits, in the original currency they were held in. Null if not used."},"original_currency":{"type":["string","null"],"description":"Currency in which the Deel-granted credits were held, following ISO 4217. Null if not used."}},"description":"Amount paid using Deel-granted credits.","title":"PaymentsGetResponsesContentApplicationJsonSchemaDataRowsItemsDeelGrantedCreditsUsed"},"PaymentsGetResponsesContentApplicationJsonSchemaDataRowsItemsPrepaidBillingCreditsUsed":{"type":"object","properties":{"amount":{"type":"string","description":"Amount deducted from prepaid billing credits, in the payment currency. '0.00' if not used."},"original_amount":{"type":["string","null"],"description":"Amount deducted from prepaid billing credits, in the original currency they were held in. Null if not used."},"original_currency":{"type":["string","null"],"description":"Currency in which the prepaid billing credits were held, following ISO 4217. Null if not used."}},"description":"Amount paid using prepaid billing credits.","title":"PaymentsGetResponsesContentApplicationJsonSchemaDataRowsItemsPrepaidBillingCreditsUsed"},"PaymentsGetResponsesContentApplicationJsonSchemaDataRowsItemsEorEarlyInvoicingFundsUsed":{"type":"object","properties":{"amount":{"type":"string","description":"Amount deducted from EOR early invoicing funds, in the payment currency. '0.00' if not used."},"original_amount":{"type":["string","null"],"description":"Amount deducted from EOR early invoicing funds, in the original currency they were held in. Null if not used."},"original_currency":{"type":["string","null"],"description":"Currency in which the EOR early invoicing funds were held, following ISO 4217. Null if not used."}},"description":"Amount paid using EOR early invoicing funds.","title":"PaymentsGetResponsesContentApplicationJsonSchemaDataRowsItemsEorEarlyInvoicingFundsUsed"},"PaymentsGetResponsesContentApplicationJsonSchemaDataRowsItems":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the payment."},"label":{"type":"string","description":"A descriptive label for the payment."},"total":{"type":"string","description":"Original invoice total before any credits or balance were applied."},"status":{"$ref":"#/components/schemas/PaymentsGetResponsesContentApplicationJsonSchemaDataRowsItemsStatus","description":"Status of the payment. Either 'paid' or 'processing'."},"paid_at":{"type":"string","format":"date-time","description":"Date and time when the payment was completed, in ISO-8601 format."},"workers":{"type":"array","items":{"$ref":"#/components/schemas/PaymentsGetResponsesContentApplicationJsonSchemaDataRowsItemsWorkersItems"},"description":"Array of workers associated with this payment."},"invoices":{"type":"array","items":{"$ref":"#/components/schemas/PaymentsGetResponsesContentApplicationJsonSchemaDataRowsItemsInvoicesItems"},"description":"Array of invoices associated with this payment."},"timezone":{"type":"string","description":"Timezone offset in ISO 8601 format (e.g., +02:00, -05:00)."},"total_due":{"type":"string","description":"Amount due for the payment after applying any credits or balance. Equals 'total' when no credits were used."},"created_at":{"type":"string","format":"date-time","description":"Date and time when the payment was created, in ISO-8601 format."},"deel_reference":{"type":["string","null"],"description":"Deel reference identifier for the payment."},"payment_method":{"$ref":"#/components/schemas/PaymentsGetResponsesContentApplicationJsonSchemaDataRowsItemsPaymentMethod","description":"Payment method details for the transaction."},"payment_currency":{"type":"string","description":"Three-letter currency code for the payment, following ISO 4217."},"general_funds_used":{"$ref":"#/components/schemas/PaymentsGetResponsesContentApplicationJsonSchemaDataRowsItemsGeneralFundsUsed","description":"Amount paid using the client's general balance funds."},"deel_granted_credits_used":{"$ref":"#/components/schemas/PaymentsGetResponsesContentApplicationJsonSchemaDataRowsItemsDeelGrantedCreditsUsed","description":"Amount paid using Deel-granted credits."},"prepaid_billing_credits_used":{"$ref":"#/components/schemas/PaymentsGetResponsesContentApplicationJsonSchemaDataRowsItemsPrepaidBillingCreditsUsed","description":"Amount paid using prepaid billing credits."},"eor_early_invoicing_funds_used":{"$ref":"#/components/schemas/PaymentsGetResponsesContentApplicationJsonSchemaDataRowsItemsEorEarlyInvoicingFundsUsed","description":"Amount paid using EOR early invoicing funds."}},"title":"PaymentsGetResponsesContentApplicationJsonSchemaDataRowsItems"},"PaymentsGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"rows":{"type":"array","items":{"$ref":"#/components/schemas/PaymentsGetResponsesContentApplicationJsonSchemaDataRowsItems"},"description":"Array of payment receipts matching the query criteria."},"total":{"type":"number","format":"double","description":"The total number of payments matching the query."},"has_more":{"type":"boolean","description":"Inform if there are more entries to be fetched using next cursor,."},"next_cursor":{"type":["string","null"],"description":"A cursor for pagination. Use the value returned in the 'next_cursor' field to get the next page of results. If there are no more results, this will be null."},"total_count":{"type":"number","format":"double","description":"The total number of payments matching the query."}},"title":"PaymentsGetResponsesContentApplicationJsonSchemaData"},"Accounting_retrievePaymentReceipts-v2026-01-01_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PaymentsGetResponsesContentApplicationJsonSchemaData"}},"title":"Accounting_retrievePaymentReceipts-v2026-01-01_Response_200"},"PaymentsGetResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"title":"PaymentsGetResponsesContentApplicationJsonSchemaErrorsItems"},"RetrievePaymentReceipts-v2026-01-01RequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/PaymentsGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"RetrievePaymentReceipts-v2026-01-01RequestInternalServerError"},"AdjustmentsPostRequestBodyContentMultipartFormDataSchemaAmount":{"oneOf":[{"type":"string"},{"type":"number","format":"double"}],"description":"Amount of adjustment.","title":"AdjustmentsPostRequestBodyContentMultipartFormDataSchemaAmount"},"AdjustmentsPostResponsesContentApplicationJsonSchemaDataFile":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the file"},"name":{"type":"string","description":"The name of the file"},"fileType":{"type":"string","description":"The type of the file"}},"description":"'Adjustment attachement","title":"AdjustmentsPostResponsesContentApplicationJsonSchemaDataFile"},"AdjustmentsPostResponsesContentApplicationJsonSchemaDataStatus0":{"type":"string","enum":["OPEN","PENDING_APPROVAL","OVERWRITTEN","FAILED","SUCCESS","AI_CHECK_IN_PROGRESS"],"description":"Adjustment status (when contract type is GP)","title":"AdjustmentsPostResponsesContentApplicationJsonSchemaDataStatus0"},"AdjustmentsPostResponsesContentApplicationJsonSchemaDataStatus1":{"type":"string","enum":["DRAFT","PENDING","ERRORS_FOUND","APPROVED","DENIED","DISBURSE_SCHEDULED","REIMBURSED","UNDER_REVIEW","PENDING_DEEL_REVIEW"],"description":"Adjustment status (when contract type is EOR)","title":"AdjustmentsPostResponsesContentApplicationJsonSchemaDataStatus1"},"AdjustmentsPostResponsesContentApplicationJsonSchemaDataStatus":{"oneOf":[{"$ref":"#/components/schemas/AdjustmentsPostResponsesContentApplicationJsonSchemaDataStatus0"},{"$ref":"#/components/schemas/AdjustmentsPostResponsesContentApplicationJsonSchemaDataStatus1"}],"description":"The status of the adjustments","title":"AdjustmentsPostResponsesContentApplicationJsonSchemaDataStatus"},"AdjustmentsPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the adjustment"},"file":{"oneOf":[{"$ref":"#/components/schemas/AdjustmentsPostResponsesContentApplicationJsonSchemaDataFile"},{"type":"null"}],"description":"'Adjustment attachement"},"title":{"type":"string","description":"The title of the adjustment"},"amount":{"type":"string","description":"The amount of the adjustment"},"status":{"$ref":"#/components/schemas/AdjustmentsPostResponsesContentApplicationJsonSchemaDataStatus","description":"The status of the adjustments"},"created_at":{"type":"string","format":"date-time","description":"The date and time when the adjustment was created"},"updated_at":{"type":"string","format":"date-time","description":"The date and time when the adjustment was last updated"},"contract_id":{"type":"string","description":"The identifier of the contract associated with the adjustment"},"description":{"type":"string","description":"The description of the adjustment"},"cycle_reference":{"type":["string","null"],"description":"The reference to the cycle associated with the adjustment"},"move_next_cycle":{"type":"boolean","description":"If an adjustments can belong to another payroll cycle"},"date_of_adjustment":{"type":"string","format":"date-time","description":"The date of the adjustment"},"actual_end_cycle_date":{"type":"string","description":"The date of the actual end cycle date"},"adjustment_category_id":{"type":"string","description":"The identifier of the adjustment category associated with the adjustment"},"actual_start_cycle_date":{"type":"string","description":"The date of the actual start cycle date"}},"title":"AdjustmentsPostResponsesContentApplicationJsonSchemaData"},"adjustments_createContractAdjustment_Response_201":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AdjustmentsPostResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"adjustments_createContractAdjustment_Response_201"},"AdjustmentsPostResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"title":"AdjustmentsPostResponsesContentApplicationJsonSchemaErrorsItems"},"CreateANewAdjustment-v2026-01-01RequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/AdjustmentsPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"CreateANewAdjustment-v2026-01-01RequestBadRequestError"},"AdjustmentsIdDeleteResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"deleted":{"type":"boolean","description":"Confirms the deletion."}},"required":["deleted"],"title":"AdjustmentsIdDeleteResponsesContentApplicationJsonSchemaData"},"adjustments_deleteContractAdjustment_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AdjustmentsIdDeleteResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"adjustments_deleteContractAdjustment_Response_200"},"ContractsContractIdAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsFile":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the file"},"name":{"type":"string","description":"The name of the file"},"fileType":{"type":"string","description":"The type of the file"}},"description":"Info for the attachment of adjustment","title":"ContractsContractIdAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsFile"},"ContractsContractIdAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsStatus":{"type":"string","enum":["open","pending_approval","overwritten","failed","success","DRAFT","PENDING","APPROVED","DENIED","DISBURSE_SCHEDULED","REIMBURSED","UNDER_REVIEW","ERRORS_FOUND","PENDING_DEEL_REVIEW","AI_CHECK_IN_PROGRESS"],"description":"Adjustment status","title":"ContractsContractIdAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsStatus"},"ContractsContractIdAdjustmentsGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the adjustment"},"file":{"oneOf":[{"$ref":"#/components/schemas/ContractsContractIdAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsFile"},{"type":"null"}],"description":"Info for the attachment of adjustment"},"title":{"type":"string","description":"The title of the adjustment"},"amount":{"type":"string","description":"The amount of the adjustment"},"status":{"$ref":"#/components/schemas/ContractsContractIdAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsStatus","description":"Adjustment status"},"created_at":{"type":"string","format":"date-time","description":"The date and time when the adjustment was created"},"updated_at":{"type":"string","format":"date-time","description":"The date and time when the adjustment was last updated"},"contract_id":{"type":"string","description":"The identifier of the contract associated with the adjustment"},"description":{"type":"string","description":"The description of the adjustment"},"cycle_reference":{"type":["string","null"],"description":"The reference to the cycle associated with the adjustment"},"move_next_cycle":{"type":"boolean","description":"If an adjustments can belong to another payroll cycle"},"date_of_adjustment":{"type":["string","null"],"format":"date-time","description":"The date of the adjustment"},"actual_end_cycle_date":{"type":"string","description":"The date of the actual end cycle date"},"adjustment_category_id":{"type":"string","description":"The identifier of the adjustment category associated with the adjustment"},"actual_start_cycle_date":{"type":"string","description":"The date of the actual start cycle date"}},"title":"ContractsContractIdAdjustmentsGetResponsesContentApplicationJsonSchemaDataItems"},"adjustments_getContractAdjustments_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ContractsContractIdAdjustmentsGetResponsesContentApplicationJsonSchemaDataItems"}}},"required":["data"],"title":"adjustments_getContractAdjustments_Response_200"},"ContractsContractIdAdjustmentsGetResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"message":{"type":"string","description":"You must have access to the contract sent"}},"title":"ContractsContractIdAdjustmentsGetResponsesContentApplicationJsonSchemaErrorsItems"},"RetrieveAdjustmentsRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ContractsContractIdAdjustmentsGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"RetrieveAdjustmentsRequestBadRequestError"},"AdjustmentsIdGetResponsesContentApplicationJsonSchemaDataFile":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the file"},"name":{"type":"string","description":"The name of the file"},"fileType":{"type":"string","description":"The type of the file"}},"description":"Info about the attachment of adjustment","title":"AdjustmentsIdGetResponsesContentApplicationJsonSchemaDataFile"},"AdjustmentsIdGetResponsesContentApplicationJsonSchemaDataStatus":{"type":"string","enum":["open","pending_approval","overwritten","failed","success","DRAFT","PENDING","APPROVED","DENIED","DISBURSE_SCHEDULED","REIMBURSED","UNDER_REVIEW","ERRORS_FOUND","PENDING_DEEL_REVIEW","AI_CHECK_IN_PROGRESS"],"description":"Adjustment status","title":"AdjustmentsIdGetResponsesContentApplicationJsonSchemaDataStatus"},"AdjustmentsIdGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the adjustment"},"file":{"oneOf":[{"$ref":"#/components/schemas/AdjustmentsIdGetResponsesContentApplicationJsonSchemaDataFile"},{"type":"null"}],"description":"Info about the attachment of adjustment"},"title":{"type":"string","description":"The title of the adjustment"},"amount":{"type":"string","description":"The amount of the adjustment"},"status":{"$ref":"#/components/schemas/AdjustmentsIdGetResponsesContentApplicationJsonSchemaDataStatus","description":"Adjustment status"},"created_at":{"type":"string","format":"date-time","description":"The date and time when the adjustment was created"},"updated_at":{"type":"string","format":"date-time","description":"The date and time when the adjustment was last updated"},"contract_id":{"type":"string","description":"The identifier of the contract associated with the adjustment"},"description":{"type":"string","description":"The description of the adjustment"},"cycle_reference":{"type":["string","null"],"description":"The reference to the cycle associated with the adjustment"},"move_next_cycle":{"type":"boolean","description":"If an adjustments can belong to another payroll cycle"},"date_of_adjustment":{"type":"string","format":"date-time","description":"The date of the adjustment"},"actual_end_cycle_date":{"type":"string","description":"The date of the actual end cycle date"},"adjustment_category_id":{"type":"string","description":"The identifier of the adjustment category associated with the adjustment"},"actual_start_cycle_date":{"type":"string","description":"The date of the actual start cycle date"}},"title":"AdjustmentsIdGetResponsesContentApplicationJsonSchemaData"},"adjustments_getContractAdjustment_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AdjustmentsIdGetResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"adjustments_getContractAdjustment_Response_200"},"AdjustmentsIdGetResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"message":{"type":"string","description":"You must have access to the contract sent"}},"title":"AdjustmentsIdGetResponsesContentApplicationJsonSchemaErrorsItems"},"RetrieveAnAdjustmentRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/AdjustmentsIdGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"RetrieveAnAdjustmentRequestBadRequestError"},"AdjustmentsCategoriesGetParametersContractTypesSchemaItems":{"type":"string","enum":["peo","global_payroll","hris_direct_employee","eor","employee","independent_contractor"],"title":"AdjustmentsCategoriesGetParametersContractTypesSchemaItems"},"AdjustmentsCategoriesGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of an adjustment category."},"name":{"type":"string","description":"The name of the adjustment category."},"label":{"type":"string","description":"The label of the adjustment category."},"unit_type":{"type":"string","description":"The unit type of the adjustment category."}},"title":"AdjustmentsCategoriesGetResponsesContentApplicationJsonSchemaDataItems"},"adjustments_getAdjustmentCategories_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/AdjustmentsCategoriesGetResponsesContentApplicationJsonSchemaDataItems"}}},"required":["data"],"title":"adjustments_getAdjustmentCategories_Response_200"},"AdjustmentsIdPatchRequestBodyContentMultipartFormDataSchemaDataAmount":{"oneOf":[{"type":"string"},{"type":"number","format":"double"}],"description":"Amount of adjustment.","title":"AdjustmentsIdPatchRequestBodyContentMultipartFormDataSchemaDataAmount"},"AdjustmentsIdPatchRequestBodyContentMultipartFormDataSchemaData":{"type":"object","properties":{"file":{"type":"string","format":"binary","description":"File of adjustment."},"title":{"type":"string","description":"Title of adjustment."},"amount":{"$ref":"#/components/schemas/AdjustmentsIdPatchRequestBodyContentMultipartFormDataSchemaDataAmount","description":"Amount of adjustment."},"description":{"type":"string","description":"Description of adjustment."}},"description":"Details of adjustment to update","title":"AdjustmentsIdPatchRequestBodyContentMultipartFormDataSchemaData"},"AdjustmentsIdPatchResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"updated":{"type":"boolean"}},"required":["updated"],"title":"AdjustmentsIdPatchResponsesContentApplicationJsonSchemaData"},"adjustments_updateContractAdjustment_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AdjustmentsIdPatchResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"adjustments_updateContractAdjustment_Response_200"},"ItAssetsGetParametersLocation":{"type":"string","enum":["WITH_USER","AT_WAREHOUSE","DEEL_WAREHOUSE","ORGANIZATION_WAREHOUSE","CLEARANCE_WAREHOUSE","SUPPLIER","WITH_COURIER","WRITE_OFF"],"title":"ItAssetsGetParametersLocation"},"ItAssetsGetParametersCategory":{"type":"string","enum":["ADAPTER","CABLE","CHAIR","CHARGER","DESK","DESK_RISER","DESK_TIDY","DESKTOP","DOCKING_STATION","DONGLE","FOOTREST","HEADSET","KEYBOARD","LAPTOP","LAPTOP_STAND","MICE_TRACKPAD","MOBILE_DEVICE","MONITOR","MONITOR_ARM","OTHER","PRINTER","SHREDDER","STANDING_MAT","TABLET","TASK_LIGHT","WEBCAM","WIFI_RANGE_EXTENDER","WELCOME_PACK"],"title":"ItAssetsGetParametersCategory"},"ItAssetsGetParametersStatus":{"type":"string","enum":["ACTIVE","ARCHIVED"],"title":"ItAssetsGetParametersStatus"},"ItAssetsGetResponsesContentApplicationJsonSchemaDataItemsGrade":{"type":"string","enum":["NEW","A","B","C","D","F"],"description":"The condition grade of the asset","title":"ItAssetsGetResponsesContentApplicationJsonSchemaDataItemsGrade"},"ItAssetsGetResponsesContentApplicationJsonSchemaDataItemsStatus":{"type":"string","enum":["ACTIVE","SUPPLIER_RETURN","STOLEN","LOST_IN_TRANSIT","WAITING_FOR_CLEARANCE","CLEARED","BINNED","LEFT_WITH_USER","SHRINKAGE","DAMAGED_BY_USER","DAMAGED_IN_TRANSIT","DAMAGED_AT_WAREHOUSE","BEING_REPAIRED","BROKEN_BY_USER","BROKEN_IN_TRANSIT","BROKEN_AT_WAREHOUSE","ADDED_BY_MISTAKE","RETURNED_TO_DEEL"],"description":"Current state of the asset","title":"ItAssetsGetResponsesContentApplicationJsonSchemaDataItemsStatus"},"ItAssetsGetResponsesContentApplicationJsonSchemaDataItemsProductCategory":{"type":"string","enum":["ADAPTER","CABLE","CHAIR","CHARGER","DESK","DESK_RISER","DESK_TIDY","DESKTOP","DOCKING_STATION","DONGLE","FOOTREST","HEADSET","KEYBOARD","LAPTOP","LAPTOP_STAND","MICE_TRACKPAD","MOBILE_DEVICE","MONITOR","MONITOR_ARM","OTHER","PRINTER","SHREDDER","STANDING_MAT","TABLET","TASK_LIGHT","WEBCAM","WIFI_RANGE_EXTENDER","WELCOME_PACK"],"description":"Product category","title":"ItAssetsGetResponsesContentApplicationJsonSchemaDataItemsProductCategory"},"ItAssetsGetResponsesContentApplicationJsonSchemaDataItemsProduct":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the product"},"name":{"type":"string","description":"Product name"},"brand":{"type":"string","description":"Product brand"},"category":{"$ref":"#/components/schemas/ItAssetsGetResponsesContentApplicationJsonSchemaDataItemsProductCategory","description":"Product category"}},"description":"Product details","title":"ItAssetsGetResponsesContentApplicationJsonSchemaDataItemsProduct"},"ItAssetsGetResponsesContentApplicationJsonSchemaDataItemsLocation":{"type":"string","enum":["WITH_USER","AT_WAREHOUSE","DEEL_WAREHOUSE","ORGANIZATION_WAREHOUSE","CLEARANCE_WAREHOUSE","SUPPLIER","WITH_COURIER","WRITE_OFF"],"description":"Current location type of the asset","title":"ItAssetsGetResponsesContentApplicationJsonSchemaDataItemsLocation"},"ItAssetsGetResponsesContentApplicationJsonSchemaDataItemsOwnershipType":{"type":"string","enum":["DEEL","ORGANIZATION"],"description":"Asset owner type","title":"ItAssetsGetResponsesContentApplicationJsonSchemaDataItemsOwnershipType"},"ItAssetsGetResponsesContentApplicationJsonSchemaDataItemsOwnership":{"type":"object","properties":{"name":{"type":"string","description":"Asset owner name"},"type":{"$ref":"#/components/schemas/ItAssetsGetResponsesContentApplicationJsonSchemaDataItemsOwnershipType","description":"Asset owner type"}},"description":"Asset owner","title":"ItAssetsGetResponsesContentApplicationJsonSchemaDataItemsOwnership"},"ItAssetsGetResponsesContentApplicationJsonSchemaDataItemsAssignedUserAddressType":{"type":"string","enum":["PII","PARTIAL","DELIVERY","COLLECTION","ENTITY","SUPPLIER","BILLING"],"description":"Type of the address","title":"ItAssetsGetResponsesContentApplicationJsonSchemaDataItemsAssignedUserAddressType"},"ItAssetsGetResponsesContentApplicationJsonSchemaDataItemsAssignedUserAddressCountry":{"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","XK","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"],"description":"Country code","title":"ItAssetsGetResponsesContentApplicationJsonSchemaDataItemsAssignedUserAddressCountry"},"ItAssetsGetResponsesContentApplicationJsonSchemaDataItemsAssignedUserAddress":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the address"},"city":{"type":["string","null"],"description":"City name"},"type":{"$ref":"#/components/schemas/ItAssetsGetResponsesContentApplicationJsonSchemaDataItemsAssignedUserAddressType","description":"Type of the address"},"line1":{"type":["string","null"],"description":"Address line 1"},"line2":{"type":["string","null"],"description":"Address line 2"},"state":{"type":["string","null"],"description":"State code or name"},"country":{"$ref":"#/components/schemas/ItAssetsGetResponsesContentApplicationJsonSchemaDataItemsAssignedUserAddressCountry","description":"Country code"},"is_valid":{"type":"boolean","description":"Whether the address passes validation"},"post_code":{"type":["string","null"],"description":"Post code"},"phone_number":{"type":["string","null"],"description":"Phone number"},"date_of_birth":{"type":["string","null"],"format":"date","description":"Date of birth (applicable for some address types)"},"tax_id_number":{"type":["string","null"],"description":"Tax ID number (applicable for some address types)"},"passport_number":{"type":["string","null"],"description":"Passport number (applicable for some address types)"},"delivery_instructions":{"type":["string","null"],"description":"Special instructions for deliveries"}},"description":"User address details","title":"ItAssetsGetResponsesContentApplicationJsonSchemaDataItemsAssignedUserAddress"},"ItAssetsGetResponsesContentApplicationJsonSchemaDataItemsAssignedUser":{"type":"object","properties":{"emails":{"type":"array","items":{"type":"string","format":"email"},"description":"Array of user email addresses"},"address":{"$ref":"#/components/schemas/ItAssetsGetResponsesContentApplicationJsonSchemaDataItemsAssignedUserAddress","description":"User address details"},"last_name":{"type":"string","description":"Last name of the user"},"first_name":{"type":"string","description":"First name of the user"},"hris_profile_id":{"type":"string","format":"uuid","description":"The unique identifier of the HRIS profile of the assigned user"}},"description":"Details of the user with asset possession","title":"ItAssetsGetResponsesContentApplicationJsonSchemaDataItemsAssignedUser"},"ItAssetsGetResponsesContentApplicationJsonSchemaDataItemsPurchaseValueCurrency":{"type":"string","enum":["EUR","AED","AFN","XCD","ALL","AMD","AOA","ARS","USD","AUD","AWG","AZN","BAM","BDT","XOF","BGN","BHD","BIF","BMD","SGD","BOB","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","XAF","CHF","NZD","CLP","CNY","COP","CRC","CUC","CVE","ANG","CZK","DJF","DOP","DZD","EGP","MAD","ERN","ETB","FJD","FKP","DKK","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","WST","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MDL","MGA","MKD","MMK","MNT","MRU","MUR","MVR","MWK","MXN","MYR","MZN","NAD","XPF","NGN","NIO","NOK","NPR","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SHP","SLL","SOS","SRD","SSP","STD","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UYU","UZS","VEF","VND","VUV","YER","ZAR","ZMW","ZWD"],"description":"Three-letter currency code for the price","title":"ItAssetsGetResponsesContentApplicationJsonSchemaDataItemsPurchaseValueCurrency"},"ItAssetsGetResponsesContentApplicationJsonSchemaDataItemsPurchaseValue":{"type":"object","properties":{"amount":{"type":"string","description":"Amount"},"currency":{"$ref":"#/components/schemas/ItAssetsGetResponsesContentApplicationJsonSchemaDataItemsPurchaseValueCurrency","description":"Three-letter currency code for the price"}},"description":"Purchase value of the asset","title":"ItAssetsGetResponsesContentApplicationJsonSchemaDataItemsPurchaseValue"},"ItAssetsGetResponsesContentApplicationJsonSchemaDataItemsAssignedWarehouseAddressType":{"type":"string","enum":["PII","PARTIAL","DELIVERY","COLLECTION","ENTITY","SUPPLIER","BILLING"],"description":"Type of the address","title":"ItAssetsGetResponsesContentApplicationJsonSchemaDataItemsAssignedWarehouseAddressType"},"ItAssetsGetResponsesContentApplicationJsonSchemaDataItemsAssignedWarehouseAddressCountry":{"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","XK","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"],"description":"Country code","title":"ItAssetsGetResponsesContentApplicationJsonSchemaDataItemsAssignedWarehouseAddressCountry"},"ItAssetsGetResponsesContentApplicationJsonSchemaDataItemsAssignedWarehouseAddress":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the address"},"city":{"type":["string","null"],"description":"City name"},"type":{"$ref":"#/components/schemas/ItAssetsGetResponsesContentApplicationJsonSchemaDataItemsAssignedWarehouseAddressType","description":"Type of the address"},"line1":{"type":["string","null"],"description":"Address line 1"},"line2":{"type":["string","null"],"description":"Address line 2"},"state":{"type":["string","null"],"description":"State code or name"},"country":{"$ref":"#/components/schemas/ItAssetsGetResponsesContentApplicationJsonSchemaDataItemsAssignedWarehouseAddressCountry","description":"Country code"},"is_valid":{"type":"boolean","description":"Whether the address passes validation"},"post_code":{"type":["string","null"],"description":"Post code"},"phone_number":{"type":["string","null"],"description":"Phone number"},"date_of_birth":{"type":["string","null"],"format":"date","description":"Date of birth (applicable for some address types)"},"tax_id_number":{"type":["string","null"],"description":"Tax ID number (applicable for some address types)"},"passport_number":{"type":["string","null"],"description":"Passport number (applicable for some address types)"},"delivery_instructions":{"type":["string","null"],"description":"Special instructions for deliveries"}},"description":"Warehouse address details","title":"ItAssetsGetResponsesContentApplicationJsonSchemaDataItemsAssignedWarehouseAddress"},"ItAssetsGetResponsesContentApplicationJsonSchemaDataItemsAssignedWarehouseOwnership":{"type":"string","enum":["DEEL","ORGANIZATION"],"description":"Warehouse ownership type","title":"ItAssetsGetResponsesContentApplicationJsonSchemaDataItemsAssignedWarehouseOwnership"},"ItAssetsGetResponsesContentApplicationJsonSchemaDataItemsAssignedWarehouseWarehouseType":{"type":"string","enum":["DEEL","ORGANIZATION","CLEARANCE"],"description":"Warehouse type","title":"ItAssetsGetResponsesContentApplicationJsonSchemaDataItemsAssignedWarehouseWarehouseType"},"ItAssetsGetResponsesContentApplicationJsonSchemaDataItemsAssignedWarehouse":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the warehouse"},"name":{"type":"string","description":"Warehouse or storage location name"},"address":{"$ref":"#/components/schemas/ItAssetsGetResponsesContentApplicationJsonSchemaDataItemsAssignedWarehouseAddress","description":"Warehouse address details"},"ownership":{"$ref":"#/components/schemas/ItAssetsGetResponsesContentApplicationJsonSchemaDataItemsAssignedWarehouseOwnership","description":"Warehouse ownership type"},"warehouse_type":{"$ref":"#/components/schemas/ItAssetsGetResponsesContentApplicationJsonSchemaDataItemsAssignedWarehouseWarehouseType","description":"Warehouse type"}},"description":"Details of the warehouse with asset possession","title":"ItAssetsGetResponsesContentApplicationJsonSchemaDataItemsAssignedWarehouse"},"ItAssetsGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the item"},"grade":{"$ref":"#/components/schemas/ItAssetsGetResponsesContentApplicationJsonSchemaDataItemsGrade","description":"The condition grade of the asset"},"status":{"$ref":"#/components/schemas/ItAssetsGetResponsesContentApplicationJsonSchemaDataItemsStatus","description":"Current state of the asset"},"product":{"$ref":"#/components/schemas/ItAssetsGetResponsesContentApplicationJsonSchemaDataItemsProduct","description":"Product details"},"location":{"$ref":"#/components/schemas/ItAssetsGetResponsesContentApplicationJsonSchemaDataItemsLocation","description":"Current location type of the asset"},"ownership":{"$ref":"#/components/schemas/ItAssetsGetResponsesContentApplicationJsonSchemaDataItemsOwnership","description":"Asset owner"},"created_at":{"type":"string","format":"date-time","description":"Creation timestamp of the asset"},"updated_at":{"type":"string","format":"date-time","description":"Last update timestamp of the asset"},"assigned_user":{"oneOf":[{"$ref":"#/components/schemas/ItAssetsGetResponsesContentApplicationJsonSchemaDataItemsAssignedUser"},{"type":"null"}],"description":"Details of the user with asset possession"},"purchase_date":{"type":["string","null"],"format":"date","description":"Purchase date of the asset"},"serial_number":{"type":["string","null"],"description":"Asset serial number"},"purchase_value":{"oneOf":[{"$ref":"#/components/schemas/ItAssetsGetResponsesContentApplicationJsonSchemaDataItemsPurchaseValue"},{"type":"null"}],"description":"Purchase value of the asset"},"assigned_warehouse":{"oneOf":[{"$ref":"#/components/schemas/ItAssetsGetResponsesContentApplicationJsonSchemaDataItemsAssignedWarehouse"},{"type":"null"}],"description":"Details of the warehouse with asset possession"}},"title":"ItAssetsGetResponsesContentApplicationJsonSchemaDataItems"},"assets_getITAssets_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ItAssetsGetResponsesContentApplicationJsonSchemaDataItems"}},"has_more":{"type":"boolean","description":"Whether there are more results available"},"next_cursor":{"type":["string","null"],"description":"Cursor to the next page"},"total_count":{"type":"integer","description":"Total number of records"}},"title":"assets_getITAssets_Response_200"},"ItAssetsGetResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string","description":"Error code of the handler which produced the returned error"},"field":{"type":"string","description":"The field name where input validation failed"},"message":{"type":"string","description":"Description of the returned error"}},"title":"ItAssetsGetResponsesContentApplicationJsonSchemaErrorsItems"},"ListItAssetsRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ItAssetsGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"ListItAssetsRequestBadRequestError"},"ListItAssetsRequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ItAssetsGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"ListItAssetsRequestInternalServerError"},"ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataGrade":{"type":"string","enum":["NEW","A","B","C","D","F"],"description":"The condition grade of the asset","title":"ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataGrade"},"ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataStatus":{"type":"string","enum":["ACTIVE","SUPPLIER_RETURN","STOLEN","LOST_IN_TRANSIT","WAITING_FOR_CLEARANCE","CLEARED","BINNED","LEFT_WITH_USER","SHRINKAGE","DAMAGED_BY_USER","DAMAGED_IN_TRANSIT","DAMAGED_AT_WAREHOUSE","BEING_REPAIRED","BROKEN_BY_USER","BROKEN_IN_TRANSIT","BROKEN_AT_WAREHOUSE","ADDED_BY_MISTAKE","RETURNED_TO_DEEL"],"description":"Current state of the asset","title":"ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataStatus"},"ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataProductCategory":{"type":"string","enum":["ADAPTER","CABLE","CHAIR","CHARGER","DESK","DESK_RISER","DESK_TIDY","DESKTOP","DOCKING_STATION","DONGLE","FOOTREST","HEADSET","KEYBOARD","LAPTOP","LAPTOP_STAND","MICE_TRACKPAD","MOBILE_DEVICE","MONITOR","MONITOR_ARM","OTHER","PRINTER","SHREDDER","STANDING_MAT","TABLET","TASK_LIGHT","WEBCAM","WIFI_RANGE_EXTENDER","WELCOME_PACK"],"description":"Product category","title":"ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataProductCategory"},"ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataProductSpecificationsItems":{"type":"object","properties":{"name":{"type":"string","description":"Specification name"},"value":{"type":"string","description":"Specification value"}},"title":"ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataProductSpecificationsItems"},"ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataProduct":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the product"},"name":{"type":"string","description":"Product name"},"brand":{"type":"string","description":"Product brand"},"category":{"$ref":"#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataProductCategory","description":"Product category"},"specifications":{"type":"array","items":{"$ref":"#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataProductSpecificationsItems"},"description":"Specifications of the product"}},"description":"Product details","title":"ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataProduct"},"ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataLocation":{"type":"string","enum":["WITH_USER","AT_WAREHOUSE","DEEL_WAREHOUSE","ORGANIZATION_WAREHOUSE","CLEARANCE_WAREHOUSE","SUPPLIER","WITH_COURIER","WRITE_OFF"],"description":"Current location type of the asset","title":"ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataLocation"},"ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataOwnershipType":{"type":"string","enum":["DEEL","ORGANIZATION"],"description":"Asset owner type","title":"ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataOwnershipType"},"ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataOwnership":{"type":"object","properties":{"name":{"type":"string","description":"Asset owner name"},"type":{"$ref":"#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataOwnershipType","description":"Asset owner type"}},"description":"Asset owner","title":"ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataOwnership"},"ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataAssignedUserAddressType":{"type":"string","enum":["PII","PARTIAL","DELIVERY","COLLECTION","ENTITY","SUPPLIER","BILLING"],"description":"Type of the address","title":"ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataAssignedUserAddressType"},"ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataAssignedUserAddressCountry":{"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","XK","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"],"description":"Country code","title":"ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataAssignedUserAddressCountry"},"ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataAssignedUserAddress":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the address"},"city":{"type":["string","null"],"description":"City name"},"type":{"$ref":"#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataAssignedUserAddressType","description":"Type of the address"},"line1":{"type":["string","null"],"description":"Address line 1"},"line2":{"type":["string","null"],"description":"Address line 2"},"state":{"type":["string","null"],"description":"State code or name"},"country":{"$ref":"#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataAssignedUserAddressCountry","description":"Country code"},"is_valid":{"type":"boolean","description":"Whether the address passes validation"},"post_code":{"type":["string","null"],"description":"Post code"},"phone_number":{"type":["string","null"],"description":"Phone number"},"date_of_birth":{"type":["string","null"],"format":"date","description":"Date of birth (applicable for some address types)"},"tax_id_number":{"type":["string","null"],"description":"Tax ID number (applicable for some address types)"},"passport_number":{"type":["string","null"],"description":"Passport number (applicable for some address types)"},"delivery_instructions":{"type":["string","null"],"description":"Special instructions for deliveries"}},"description":"User address details","title":"ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataAssignedUserAddress"},"ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataAssignedUser":{"type":"object","properties":{"emails":{"type":"array","items":{"type":"string","format":"email"},"description":"Array of user email addresses"},"address":{"$ref":"#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataAssignedUserAddress","description":"User address details"},"last_name":{"type":"string","description":"Last name of the user"},"first_name":{"type":"string","description":"First name of the user"},"hris_profile_id":{"type":"string","format":"uuid","description":"The unique identifier of the HRIS profile of the assigned user"}},"description":"Details of the user with asset possession","title":"ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataAssignedUser"},"ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataPurchaseValueCurrency":{"type":"string","enum":["EUR","AED","AFN","XCD","ALL","AMD","AOA","ARS","USD","AUD","AWG","AZN","BAM","BDT","XOF","BGN","BHD","BIF","BMD","SGD","BOB","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","XAF","CHF","NZD","CLP","CNY","COP","CRC","CUC","CVE","ANG","CZK","DJF","DOP","DZD","EGP","MAD","ERN","ETB","FJD","FKP","DKK","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","WST","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MDL","MGA","MKD","MMK","MNT","MRU","MUR","MVR","MWK","MXN","MYR","MZN","NAD","XPF","NGN","NIO","NOK","NPR","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SHP","SLL","SOS","SRD","SSP","STD","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UYU","UZS","VEF","VND","VUV","YER","ZAR","ZMW","ZWD"],"description":"Three-letter currency code for the price","title":"ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataPurchaseValueCurrency"},"ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataPurchaseValue":{"type":"object","properties":{"amount":{"type":"string","description":"Amount"},"currency":{"$ref":"#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataPurchaseValueCurrency","description":"Three-letter currency code for the price"}},"description":"Purchase value of the asset","title":"ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataPurchaseValue"},"ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataAssignedWarehouseAddressType":{"type":"string","enum":["PII","PARTIAL","DELIVERY","COLLECTION","ENTITY","SUPPLIER","BILLING"],"description":"Type of the address","title":"ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataAssignedWarehouseAddressType"},"ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataAssignedWarehouseAddressCountry":{"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","XK","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"],"description":"Country code","title":"ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataAssignedWarehouseAddressCountry"},"ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataAssignedWarehouseAddress":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the address"},"city":{"type":["string","null"],"description":"City name"},"type":{"$ref":"#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataAssignedWarehouseAddressType","description":"Type of the address"},"line1":{"type":["string","null"],"description":"Address line 1"},"line2":{"type":["string","null"],"description":"Address line 2"},"state":{"type":["string","null"],"description":"State code or name"},"country":{"$ref":"#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataAssignedWarehouseAddressCountry","description":"Country code"},"is_valid":{"type":"boolean","description":"Whether the address passes validation"},"post_code":{"type":["string","null"],"description":"Post code"},"phone_number":{"type":["string","null"],"description":"Phone number"},"date_of_birth":{"type":["string","null"],"format":"date","description":"Date of birth (applicable for some address types)"},"tax_id_number":{"type":["string","null"],"description":"Tax ID number (applicable for some address types)"},"passport_number":{"type":["string","null"],"description":"Passport number (applicable for some address types)"},"delivery_instructions":{"type":["string","null"],"description":"Special instructions for deliveries"}},"description":"Warehouse address details","title":"ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataAssignedWarehouseAddress"},"ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataAssignedWarehouseOwnership":{"type":"string","enum":["DEEL","ORGANIZATION"],"description":"Warehouse ownership type","title":"ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataAssignedWarehouseOwnership"},"ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataAssignedWarehouseWarehouseType":{"type":"string","enum":["DEEL","ORGANIZATION","CLEARANCE"],"description":"Warehouse type","title":"ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataAssignedWarehouseWarehouseType"},"ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataAssignedWarehouse":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the warehouse"},"name":{"type":"string","description":"Warehouse or storage location name"},"address":{"$ref":"#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataAssignedWarehouseAddress","description":"Warehouse address details"},"ownership":{"$ref":"#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataAssignedWarehouseOwnership","description":"Warehouse ownership type"},"warehouse_type":{"$ref":"#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataAssignedWarehouseWarehouseType","description":"Warehouse type"}},"description":"Details of the warehouse with asset possession","title":"ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataAssignedWarehouse"},"ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the item"},"grade":{"$ref":"#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataGrade","description":"The condition grade of the asset"},"status":{"$ref":"#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataStatus","description":"Current state of the asset"},"product":{"$ref":"#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataProduct","description":"Product details"},"location":{"$ref":"#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataLocation","description":"Current location type of the asset"},"ownership":{"$ref":"#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataOwnership","description":"Asset owner"},"created_at":{"type":"string","format":"date-time","description":"Creation timestamp of the asset"},"updated_at":{"type":"string","format":"date-time","description":"Last update timestamp of the asset"},"assigned_user":{"oneOf":[{"$ref":"#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataAssignedUser"},{"type":"null"}],"description":"Details of the user with asset possession"},"purchase_date":{"type":["string","null"],"format":"date","description":"Purchase date of the asset"},"serial_number":{"type":["string","null"],"description":"Asset serial number"},"purchase_value":{"oneOf":[{"$ref":"#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataPurchaseValue"},{"type":"null"}],"description":"Purchase value of the asset"},"assigned_warehouse":{"oneOf":[{"$ref":"#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaDataAssignedWarehouse"},{"type":"null"}],"description":"Details of the warehouse with asset possession"}},"title":"ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaData"},"assets_getITAssetById_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaData"}},"title":"assets_getITAssetById_Response_200"},"ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string","description":"Error code of the handler which produced the returned error"},"field":{"type":"string","description":"The field name where input validation failed"},"message":{"type":"string","description":"Description of the returned error"}},"title":"ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaErrorsItems"},"RetrieveAnItAssetRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"RetrieveAnItAssetRequestBadRequestError"},"RetrieveAnItAssetRequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ItAssetsAssetIdGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"RetrieveAnItAssetRequestInternalServerError"},"AtsApplicationsApplicationIdNotesPostRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"author_id":{"type":"string","format":"uuid","description":"The UUID of the HRIS organization user creating the note"},"richtext_content":{"type":"string","description":"The content of the note in rich text HTML format"}},"required":["author_id","richtext_content"],"title":"AtsApplicationsApplicationIdNotesPostRequestBodyContentApplicationJsonSchemaData"},"AtsApplicationsApplicationIdNotesPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the application note"},"created_at":{"type":"string","format":"date-time","description":"The timestamp when the application note was created"},"updated_at":{"type":"string","format":"date-time","description":"The timestamp when the application note was last updated"}},"required":["id","created_at","updated_at"],"title":"AtsApplicationsApplicationIdNotesPostResponsesContentApplicationJsonSchemaData"},"ATS_addNoteToAnApplication-v2026-01-01_Response_201":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AtsApplicationsApplicationIdNotesPostResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"ATS_addNoteToAnApplication-v2026-01-01_Response_201"},"AtsApplicationsApplicationIdNotesPostResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code"},"message":{"type":"string","description":"Human-readable explanation of the error"}},"title":"AtsApplicationsApplicationIdNotesPostResponsesContentApplicationJsonSchemaErrorsItems"},"AddNoteToAnApplication-v2026-01-01RequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/AtsApplicationsApplicationIdNotesPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"AddNoteToAnApplication-v2026-01-01RequestBadRequestError"},"AddNoteToAnApplication-v2026-01-01RequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/AtsApplicationsApplicationIdNotesPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"AddNoteToAnApplication-v2026-01-01RequestInternalServerError"},"AtsApplicationsApplicationIdInterviewPlanStagesPostRequestBodyContentApplicationJsonSchemaDataDelayUnit":{"type":"string","enum":["hours","days","weeks"],"description":"The unit of time for the delay. Must be provided together with delay_amount. Cannot be used together with scheduled_send_at.","title":"AtsApplicationsApplicationIdInterviewPlanStagesPostRequestBodyContentApplicationJsonSchemaDataDelayUnit"},"AtsApplicationsApplicationIdInterviewPlanStagesPostRequestBodyContentApplicationJsonSchemaDataApplicableJobActivitiesItemsParticipantsItemsRoleSlug":{"type":"string","enum":["REVIEWER","INTERVIEWER"],"description":"The role of the participant in the activity","title":"AtsApplicationsApplicationIdInterviewPlanStagesPostRequestBodyContentApplicationJsonSchemaDataApplicableJobActivitiesItemsParticipantsItemsRoleSlug"},"AtsApplicationsApplicationIdInterviewPlanStagesPostRequestBodyContentApplicationJsonSchemaDataApplicableJobActivitiesItemsParticipantsItems":{"type":"object","properties":{"role_slug":{"$ref":"#/components/schemas/AtsApplicationsApplicationIdInterviewPlanStagesPostRequestBodyContentApplicationJsonSchemaDataApplicableJobActivitiesItemsParticipantsItemsRoleSlug","description":"The role of the participant in the activity"},"participant_hris_organization_user_id":{"type":"string","format":"uuid","description":"The HRIS organization user ID of the participant"}},"required":["role_slug","participant_hris_organization_user_id"],"title":"AtsApplicationsApplicationIdInterviewPlanStagesPostRequestBodyContentApplicationJsonSchemaDataApplicableJobActivitiesItemsParticipantsItems"},"AtsApplicationsApplicationIdInterviewPlanStagesPostRequestBodyContentApplicationJsonSchemaDataApplicableJobActivitiesItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The ID of the job activity to trigger"},"participants":{"type":"array","items":{"$ref":"#/components/schemas/AtsApplicationsApplicationIdInterviewPlanStagesPostRequestBodyContentApplicationJsonSchemaDataApplicableJobActivitiesItemsParticipantsItems"},"description":"Optional array of custom participants for this activity. If not provided, the default participants from the job activity template will be used."},"candidate_self_scheduling_email_template_id":{"type":"string","format":"uuid","description":"Optional custom email template ID for candidate self-scheduling (only applicable for interview scheduling activities)"}},"required":["id"],"title":"AtsApplicationsApplicationIdInterviewPlanStagesPostRequestBodyContentApplicationJsonSchemaDataApplicableJobActivitiesItems"},"AtsApplicationsApplicationIdInterviewPlanStagesPostRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"creator_id":{"type":"string","format":"uuid","description":"HRIS Organization User ID of the user creating the resource"},"delay_unit":{"$ref":"#/components/schemas/AtsApplicationsApplicationIdInterviewPlanStagesPostRequestBodyContentApplicationJsonSchemaDataDelayUnit","description":"The unit of time for the delay. Must be provided together with delay_amount. Cannot be used together with scheduled_send_at."},"delay_amount":{"type":"integer","description":"The amount of time to delay the archivation email. Must be provided together with delay_unit. Cannot be used together with scheduled_send_at."},"is_current_stage":{"type":"boolean","description":"When true, sets this stage as the application's current stage in the hiring workflow. When false, creates a historical record without changing the application's current stage."},"scheduled_send_at":{"type":"string","format":"date-time","description":"The exact future datetime to send the archivation email. Cannot be used together with delay_amount/delay_unit."},"interview_plan_stage_id":{"type":"string","format":"uuid","description":"The ID of the interview plan stage to associate with the application"},"applicable_job_activities":{"type":"array","items":{"$ref":"#/components/schemas/AtsApplicationsApplicationIdInterviewPlanStagesPostRequestBodyContentApplicationJsonSchemaDataApplicableJobActivitiesItems"},"description":"Optional array of job activities to trigger when associating the application with this stage. If not provided, all activities will be triggered. If an empty array is provided, no activities will be triggered."},"candidate_archivation_reason_id":{"type":"string","format":"uuid","description":"Optional ID of the archivation reason if the candidate is being archived"},"candidate_archivation_email_template_id":{"type":"string","format":"uuid","description":"Optional ID of the rejection email template if the candidate is being archived"}},"required":["creator_id","is_current_stage","interview_plan_stage_id"],"title":"AtsApplicationsApplicationIdInterviewPlanStagesPostRequestBodyContentApplicationJsonSchemaData"},"AtsApplicationsApplicationIdInterviewPlanStagesPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the created application interview plan stage record"},"created_at":{"type":"string","format":"date-time","description":"The timestamp when the record was created"},"updated_at":{"type":"string","format":"date-time","description":"The timestamp when the record was last updated"}},"required":["id","created_at","updated_at"],"description":"The created application interview plan stage record","title":"AtsApplicationsApplicationIdInterviewPlanStagesPostResponsesContentApplicationJsonSchemaData"},"ATS_associateApplicationWithAnInterviewPlanStage-v2026-01-01_Response_201":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AtsApplicationsApplicationIdInterviewPlanStagesPostResponsesContentApplicationJsonSchemaData","description":"The created application interview plan stage record"}},"required":["data"],"title":"ATS_associateApplicationWithAnInterviewPlanStage-v2026-01-01_Response_201"},"AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataNotesItems":{"type":"object","properties":{"richtext_content":{"type":"string","description":"The richtext content of the note"}},"required":["richtext_content"],"title":"AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataNotesItems"},"AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItemsOneOf0Type":{"type":"string","enum":["FREETEXT"],"description":"The type of the question","title":"AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItemsOneOf0Type"},"AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems0":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItemsOneOf0Type","description":"The type of the question"},"answer":{"type":"string","description":"The answer text"},"question_id":{"type":"string","description":"The unique identifier of the question"}},"required":["type","answer","question_id"],"title":"AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems0"},"AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItemsOneOf1Type":{"type":"string","enum":["PARAGRAPH"],"description":"The type of the question","title":"AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItemsOneOf1Type"},"AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems1":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItemsOneOf1Type","description":"The type of the question"},"answer":{"type":"string","description":"The paragraph answer text"},"question_id":{"type":"string","description":"The unique identifier of the question"}},"required":["type","answer","question_id"],"title":"AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems1"},"AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItemsOneOf2Type":{"type":"string","enum":["SINGLESELECTION"],"description":"The type of the question","title":"AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItemsOneOf2Type"},"AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems2":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItemsOneOf2Type","description":"The type of the question"},"question_id":{"type":"string","description":"The unique identifier of the question"},"selected_option_id":{"type":"string","description":"The ID of the selected option"}},"required":["type","question_id","selected_option_id"],"title":"AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems2"},"AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItemsOneOf3Type":{"type":"string","enum":["MULTISELECTION"],"description":"The type of the question","title":"AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItemsOneOf3Type"},"AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems3":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItemsOneOf3Type","description":"The type of the question"},"question_id":{"type":"string","description":"The unique identifier of the question"},"selected_option_ids":{"type":"array","items":{"type":"string"},"description":"Array of selected option IDs"}},"required":["type","question_id","selected_option_ids"],"title":"AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems3"},"AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItemsOneOf4Type":{"type":"string","enum":["DOCUMENTUPLOAD"],"description":"The type of the question","title":"AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItemsOneOf4Type"},"AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems4":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItemsOneOf4Type","description":"The type of the question"},"question_id":{"type":"string","description":"The unique identifier of the question"},"document_ids":{"type":"array","items":{"type":"string"},"description":"Array of uploaded document IDs"}},"required":["type","question_id","document_ids"],"title":"AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems4"},"AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItemsOneOf5Type":{"type":"string","enum":["PRESETDROPDOWN"],"description":"The type of the question","title":"AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItemsOneOf5Type"},"AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems5":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItemsOneOf5Type","description":"The type of the question"},"preset":{"type":"string","description":"The preset used"},"question_id":{"type":"string","description":"The unique identifier of the question"},"selected_options":{"type":"array","items":{"type":"string"},"description":"Array of selected options"}},"required":["type","preset","question_id","selected_options"],"title":"AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems5"},"AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItemsOneOf6Type":{"type":"string","enum":["CUSTOMDROPDOWN"],"description":"The type of the question","title":"AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItemsOneOf6Type"},"AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems6":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItemsOneOf6Type","description":"The type of the question"},"question_id":{"type":"string","description":"The unique identifier of the question"},"selected_option_ids":{"type":"array","items":{"type":"string"},"description":"Array of selected option IDs"}},"required":["type","question_id","selected_option_ids"],"title":"AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems6"},"AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItemsOneOf7Type":{"type":"string","enum":["NUMBER"],"description":"The type of the question","title":"AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItemsOneOf7Type"},"AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems7":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItemsOneOf7Type","description":"The type of the question"},"value":{"type":"string","description":"The numeric answer value"},"question_id":{"type":"string","description":"The unique identifier of the question"}},"required":["type","value","question_id"],"title":"AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems7"},"AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItemsOneOf8Type":{"type":"string","enum":["DATEPICKER"],"description":"The type of the question","title":"AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItemsOneOf8Type"},"AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems8":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItemsOneOf8Type","description":"The type of the question"},"end_date":{"type":"string","description":"The end date selected (for ranges)"},"start_date":{"type":"string","description":"The start date selected"},"question_id":{"type":"string","description":"The unique identifier of the question"}},"required":["type","question_id"],"title":"AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems8"},"AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItemsOneOf9Type":{"type":"string","enum":["ADDRESS"],"description":"The type of the question","title":"AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItemsOneOf9Type"},"AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems9":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItemsOneOf9Type","description":"The type of the question"},"question_id":{"type":"string","description":"The unique identifier of the question"},"address_city":{"type":"string","description":"City"},"address_state":{"type":"string","description":"State"},"address_number":{"type":"string","description":"Street number"},"address_street":{"type":"string","description":"Street name"},"address_country":{"type":"string","description":"Country"},"address_zip_code":{"type":"string","description":"ZIP code"}},"required":["type","question_id","address_city","address_state","address_number","address_street","address_country","address_zip_code"],"title":"AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems9"},"AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItemsOneOf10Type":{"type":"string","enum":["PHONENUMBER"],"description":"The type of the question","title":"AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItemsOneOf10Type"},"AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems10":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItemsOneOf10Type","description":"The type of the question"},"question_id":{"type":"string","description":"The unique identifier of the question"},"phone_number":{"type":"string","description":"The phone number"}},"required":["type","question_id","phone_number"],"title":"AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems10"},"AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItemsOneOf11Type":{"type":"string","enum":["EMAIL"],"description":"The type of the question","title":"AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItemsOneOf11Type"},"AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems11":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItemsOneOf11Type","description":"The type of the question"},"email":{"type":"string","format":"email","description":"The email address"},"question_id":{"type":"string","description":"The unique identifier of the question"}},"required":["type","email","question_id"],"title":"AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems11"},"AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems":{"oneOf":[{"$ref":"#/components/schemas/AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems0"},{"$ref":"#/components/schemas/AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems1"},{"$ref":"#/components/schemas/AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems2"},{"$ref":"#/components/schemas/AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems3"},{"$ref":"#/components/schemas/AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems4"},{"$ref":"#/components/schemas/AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems5"},{"$ref":"#/components/schemas/AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems6"},{"$ref":"#/components/schemas/AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems7"},{"$ref":"#/components/schemas/AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems8"},{"$ref":"#/components/schemas/AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems9"},{"$ref":"#/components/schemas/AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems10"},{"$ref":"#/components/schemas/AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems11"}],"title":"AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems"},"AtsApplicationsPostRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"notes":{"type":["array","null"],"items":{"$ref":"#/components/schemas/AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataNotesItems"},"description":"Array of notes to attach to the application"},"job_id":{"type":"string","format":"uuid","description":"The ID of the job for this application"},"candidate_id":{"type":"string","format":"uuid","description":"The ID of the candidate applying"},"job_posting_id":{"type":["string","null"],"format":"uuid","description":"The ID of the job posting (optional)"},"job_employment_type_id":{"type":"string","format":"uuid","description":"The ID of the employment type for this job"},"application_form_submission_data":{"type":["array","null"],"items":{"$ref":"#/components/schemas/AtsApplicationsPostRequestBodyContentApplicationJsonSchemaDataApplicationFormSubmissionDataItems"},"description":"Array of form submission answers"}},"required":["job_id","candidate_id","job_employment_type_id"],"title":"AtsApplicationsPostRequestBodyContentApplicationJsonSchemaData"},"AtsApplicationsPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the application"},"job_id":{"type":"string","format":"uuid","description":"Unique identifier for the job"},"created_at":{"type":"string","format":"date-time","description":"Timestamp when the application was created"},"numeric_id":{"type":"integer","description":"Numeric identifier for the application"},"updated_at":{"type":"string","format":"date-time","description":"Timestamp when the application was last updated"},"candidate_id":{"type":"string","format":"uuid","description":"Unique identifier for the candidate"},"job_posting_id":{"type":["string","null"],"format":"uuid","description":"Unique identifier for the job posting"},"job_employment_type_id":{"type":["string","null"],"format":"uuid","description":"Unique identifier for the job employment type"},"moved_to_current_stage_at":{"type":["string","null"],"format":"date-time","description":"Timestamp when the application was moved to the current stage"},"current_application_interview_plan_stage_id":{"type":["string","null"],"format":"uuid","description":"Unique identifier for the current application interview plan stage"}},"required":["id","job_id","created_at","numeric_id","updated_at","candidate_id","job_posting_id","job_employment_type_id","moved_to_current_stage_at","current_application_interview_plan_stage_id"],"title":"AtsApplicationsPostResponsesContentApplicationJsonSchemaData"},"ATS_createAtsApplication-v2026-01-01_Response_201":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AtsApplicationsPostResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"ATS_createAtsApplication-v2026-01-01_Response_201"},"AtsApplicationsPostResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code"},"message":{"type":"string","description":"Human-readable explanation of the error"}},"title":"AtsApplicationsPostResponsesContentApplicationJsonSchemaErrorsItems"},"CreateAtsApplication-v2026-01-01RequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/AtsApplicationsPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"CreateAtsApplication-v2026-01-01RequestBadRequestError"},"CreateAtsApplication-v2026-01-01RequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/AtsApplicationsPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"CreateAtsApplication-v2026-01-01RequestInternalServerError"},"AtsCandidatesPostRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"email":{"type":"string","format":"email","description":"The candidate's email address"},"pic_url":{"type":["string","null"],"format":"uri","description":"The candidate's picture URL"},"last_name":{"type":"string","description":"The candidate's last name"},"first_name":{"type":"string","description":"The candidate's first name"},"phone_number":{"type":["string","null"],"description":"The candidate's phone number"},"linkedin_profile_url":{"type":["string","null"],"format":"uri","description":"The candidate's LinkedIn profile URL"}},"required":["email","last_name","first_name"],"title":"AtsCandidatesPostRequestBodyContentApplicationJsonSchemaData"},"AtsCandidatesPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the candidate"},"email":{"type":"string","format":"email","description":"Email address of the candidate"},"source":{"type":["string","null"],"description":"Source of the candidate"},"pic_url":{"type":["string","null"],"description":"Profile picture URL of the candidate"},"last_name":{"type":"string","description":"Last name of the candidate"},"created_at":{"type":"string","format":"date-time","description":"Timestamp when the candidate was created"},"first_name":{"type":"string","description":"First name of the candidate"},"numeric_id":{"type":"integer","description":"Numeric identifier for the candidate"},"updated_at":{"type":"string","format":"date-time","description":"Timestamp when the candidate was last updated"},"imported_id":{"type":["string","null"],"description":"Imported identifier"},"phone_number":{"type":["string","null"],"description":"Phone number of the candidate"},"anonymized_at":{"type":["string","null"],"format":"date-time","description":"Timestamp when the candidate was anonymized"},"import_session_id":{"type":["string","null"],"description":"Import session identifier"},"final_archivation_at":{"type":["string","null"],"format":"date-time","description":"Timestamp when the candidate was finally archived"},"linkedin_profile_url":{"type":["string","null"],"description":"LinkedIn profile URL of the candidate"}},"required":["id","email","last_name","created_at","first_name","numeric_id","updated_at"],"title":"AtsCandidatesPostResponsesContentApplicationJsonSchemaData"},"ATS_createAtsCandidate-v2026-01-01_Response_201":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AtsCandidatesPostResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"ATS_createAtsCandidate-v2026-01-01_Response_201"},"AtsCandidatesPostResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code"},"message":{"type":"string","description":"Human-readable explanation of the error"}},"title":"AtsCandidatesPostResponsesContentApplicationJsonSchemaErrorsItems"},"CreateAtsCandidate-v2026-01-01RequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/AtsCandidatesPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"CreateAtsCandidate-v2026-01-01RequestBadRequestError"},"CreateAtsCandidate-v2026-01-01RequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/AtsCandidatesPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"CreateAtsCandidate-v2026-01-01RequestInternalServerError"},"AtsJobsPostRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"title":{"type":"string","description":"The job title"},"team_ids":{"type":"array","items":{"type":"string","format":"uuid"},"description":"Array of team IDs (at least one required)"},"location_ids":{"type":"array","items":{"type":"string","format":"uuid"},"description":"Array of location IDs"},"department_ids":{"type":"array","items":{"type":"string","format":"uuid"},"description":"Array of department IDs (optional)"},"is_confidential":{"type":"boolean","default":false,"description":"Whether the job posting is confidential"},"interview_plan_id":{"type":"string","format":"uuid","description":"Interview Plan ID must be a valid UUID"},"employment_type_ids":{"type":"array","items":{"type":"string","format":"uuid"},"description":"Array of employment type IDs (at least one required)"},"richtext_description":{"type":["string","null"],"description":"Rich text description of the job"}},"required":["title","team_ids","location_ids","employment_type_ids"],"title":"AtsJobsPostRequestBodyContentApplicationJsonSchemaData"},"AtsJobsPostResponsesContentApplicationJsonSchemaDataStatus":{"type":"string","enum":["DRAFT","WAITING_FOR_APPROVAL","APPROVED","NOT_APPROVED","OPEN","CLOSED","ARCHIVED"],"description":"Current status of the job","title":"AtsJobsPostResponsesContentApplicationJsonSchemaDataStatus"},"AtsJobsPostResponsesContentApplicationJsonSchemaDataJobTeamsItemsTeam":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Team ID"},"name":{"type":"string","description":"Team name"}},"required":["id","name"],"title":"AtsJobsPostResponsesContentApplicationJsonSchemaDataJobTeamsItemsTeam"},"AtsJobsPostResponsesContentApplicationJsonSchemaDataJobTeamsItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Job team relationship ID"},"team":{"$ref":"#/components/schemas/AtsJobsPostResponsesContentApplicationJsonSchemaDataJobTeamsItemsTeam"}},"required":["id","team"],"title":"AtsJobsPostResponsesContentApplicationJsonSchemaDataJobTeamsItems"},"AtsJobsPostResponsesContentApplicationJsonSchemaDataJobLocationsItemsLocation":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Location ID"},"name":{"type":"string","description":"Location name"}},"required":["id","name"],"title":"AtsJobsPostResponsesContentApplicationJsonSchemaDataJobLocationsItemsLocation"},"AtsJobsPostResponsesContentApplicationJsonSchemaDataJobLocationsItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Job location relationship ID"},"location":{"$ref":"#/components/schemas/AtsJobsPostResponsesContentApplicationJsonSchemaDataJobLocationsItemsLocation"}},"required":["id","location"],"title":"AtsJobsPostResponsesContentApplicationJsonSchemaDataJobLocationsItems"},"AtsJobsPostResponsesContentApplicationJsonSchemaDataJobDepartmentsItemsDepartment":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Department ID"},"name":{"type":"string","description":"Department name"}},"required":["id","name"],"title":"AtsJobsPostResponsesContentApplicationJsonSchemaDataJobDepartmentsItemsDepartment"},"AtsJobsPostResponsesContentApplicationJsonSchemaDataJobDepartmentsItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Job department relationship ID"},"department":{"oneOf":[{"$ref":"#/components/schemas/AtsJobsPostResponsesContentApplicationJsonSchemaDataJobDepartmentsItemsDepartment"},{"type":"null"}]}},"required":["id","department"],"title":"AtsJobsPostResponsesContentApplicationJsonSchemaDataJobDepartmentsItems"},"AtsJobsPostResponsesContentApplicationJsonSchemaDataJobEmploymentTypesItemsEmploymentType":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Employment type ID"},"name":{"type":"string","description":"Employment type name"}},"required":["id","name"],"title":"AtsJobsPostResponsesContentApplicationJsonSchemaDataJobEmploymentTypesItemsEmploymentType"},"AtsJobsPostResponsesContentApplicationJsonSchemaDataJobEmploymentTypesItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Job employment type relationship ID"},"employment_type":{"$ref":"#/components/schemas/AtsJobsPostResponsesContentApplicationJsonSchemaDataJobEmploymentTypesItemsEmploymentType"}},"required":["id","employment_type"],"title":"AtsJobsPostResponsesContentApplicationJsonSchemaDataJobEmploymentTypesItems"},"AtsJobsPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the created job"},"title":{"type":"string","description":"The job title"},"status":{"$ref":"#/components/schemas/AtsJobsPostResponsesContentApplicationJsonSchemaDataStatus","description":"Current status of the job"},"job_teams":{"type":"array","items":{"$ref":"#/components/schemas/AtsJobsPostResponsesContentApplicationJsonSchemaDataJobTeamsItems"},"description":"Teams associated with the job"},"created_at":{"type":"string","format":"date-time","description":"Timestamp when the job was created"},"updated_at":{"type":"string","format":"date-time","description":"Timestamp when the job was last updated"},"job_locations":{"type":"array","items":{"$ref":"#/components/schemas/AtsJobsPostResponsesContentApplicationJsonSchemaDataJobLocationsItems"},"description":"Locations associated with the job"},"is_confidential":{"type":"boolean","description":"Whether the job posting is confidential"},"job_departments":{"type":["array","null"],"items":{"$ref":"#/components/schemas/AtsJobsPostResponsesContentApplicationJsonSchemaDataJobDepartmentsItems"},"description":"Departments associated with the job"},"approval_rule_id":{"type":["string","null"],"format":"uuid","description":"ID of the approval rule applied to this job"},"approval_request_id":{"type":["string","null"],"format":"uuid","description":"ID of the approval request for this job"},"job_employment_types":{"type":"array","items":{"$ref":"#/components/schemas/AtsJobsPostResponsesContentApplicationJsonSchemaDataJobEmploymentTypesItems"},"description":"Employment types associated with the job"},"richtext_description":{"type":["string","null"],"description":"Rich text description of the job"},"created_by_hris_organization_user_id":{"type":["string","null"],"format":"uuid","description":"ID of the user who created the job"}},"required":["id","title","status","job_teams","job_locations","is_confidential","approval_rule_id","approval_request_id","job_employment_types","created_by_hris_organization_user_id"],"title":"AtsJobsPostResponsesContentApplicationJsonSchemaData"},"ATS_createAtsJob_Response_201":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AtsJobsPostResponsesContentApplicationJsonSchemaData"}},"title":"ATS_createAtsJob_Response_201"},"AtsJobsPostResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string"},"field":{"type":"string"},"message":{"type":"string"}},"title":"AtsJobsPostResponsesContentApplicationJsonSchemaErrorsItems"},"CreateAtsJobRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/AtsJobsPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"CreateAtsJobRequestBadRequestError"},"AtsCandidatesCandidateIdTagsPostResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the candidate-tag association."},"tag_id":{"type":"string","format":"uuid","description":"Unique identifier of the tag."},"created_at":{"type":"string","format":"date-time","description":"When the association was created."},"candidate_id":{"type":"string","format":"uuid","description":"Unique identifier of the candidate."}},"title":"AtsCandidatesCandidateIdTagsPostResponsesContentApplicationJsonSchemaDataItems"},"ATS_createCandidateTags-v2026-02-27_Response_201":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/AtsCandidatesCandidateIdTagsPostResponsesContentApplicationJsonSchemaDataItems"},"description":"List of created candidate-tag associations."}},"required":["data"],"title":"ATS_createCandidateTags-v2026-02-27_Response_201"},"AtsCandidatesCandidateIdTagsPostResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string","description":"Error code"},"field":{"type":"string","description":"Request field related to the error, if applicable"},"message":{"type":"string","description":"Human-readable error message"}},"required":["code","field","message"],"title":"AtsCandidatesCandidateIdTagsPostResponsesContentApplicationJsonSchemaErrorsItems"},"CreateCandidateTags-v2026-02-27RequestBadRequestError":{"type":"object","properties":{"path":{"type":"string","description":"Request URL path"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/AtsCandidatesCandidateIdTagsPostResponsesContentApplicationJsonSchemaErrorsItems"},"description":"List of error objects"},"timestamp":{"type":"string","format":"date-time","description":"Time when the error occurred"},"status_code":{"type":"integer","description":"HTTP status code"}},"required":["path","errors","timestamp","status_code"],"title":"CreateCandidateTags-v2026-02-27RequestBadRequestError"},"CreateCandidateTags-v2026-02-27RequestInternalServerError":{"type":"object","properties":{"path":{"type":"string","description":"Request URL path"},"timestamp":{"type":"string","format":"date-time","description":"Time when the error occurred"},"status_code":{"type":"integer","description":"HTTP status code"}},"required":["path","timestamp","status_code"],"title":"CreateCandidateTags-v2026-02-27RequestInternalServerError"},"AtsTagsGetParametersTagGroupSlug":{"type":"string","enum":["CANDIDATE"],"title":"AtsTagsGetParametersTagGroupSlug"},"AtsTagsGetParametersIncludeCounts":{"type":"string","enum":["true","false"],"default":"false","title":"AtsTagsGetParametersIncludeCounts"},"AtsTagsGetResponsesContentApplicationJsonSchemaDataItemsTagGroupSlug":{"type":"string","enum":["CANDIDATE"],"description":"Tag group. Use CANDIDATE for candidate tags.","title":"AtsTagsGetResponsesContentApplicationJsonSchemaDataItemsTagGroupSlug"},"AtsTagsGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the tag."},"label":{"type":"string","description":"Display name of the tag."},"created_at":{"type":"string","format":"date-time","description":"When the tag was created."},"updated_at":{"type":"string","format":"date-time","description":"When the tag was last updated."},"tag_group_slug":{"$ref":"#/components/schemas/AtsTagsGetResponsesContentApplicationJsonSchemaDataItemsTagGroupSlug","description":"Tag group. Use CANDIDATE for candidate tags."},"candidates_count":{"type":["integer","null"],"description":"Number of candidates with this tag. Present only when includeCounts=true."},"created_by_hris_organization_user_id":{"type":["string","null"],"format":"uuid","description":"ID of the user who created the tag, if any."},"updated_by_hris_organization_user_id":{"type":["string","null"],"format":"uuid","description":"ID of the user who last updated the tag, if any."}},"required":["id","created_at","updated_at"],"title":"AtsTagsGetResponsesContentApplicationJsonSchemaDataItems"},"ATS_listTags-v2026-02-27_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/AtsTagsGetResponsesContentApplicationJsonSchemaDataItems"},"description":"List of tags."},"has_more":{"type":"boolean","description":"Whether more results exist (pagination)."},"next_cursor":{"type":["string","null"],"description":"Cursor for the next page of results, or null if none."},"total_count":{"type":"integer","description":"Total number of tags returned."}},"required":["data","has_more","next_cursor","total_count"],"title":"ATS_listTags-v2026-02-27_Response_200"},"AtsTagsGetResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string","description":"Error code"},"field":{"type":"string","description":"Request field related to the error, if applicable"},"message":{"type":"string","description":"Human-readable error message"}},"required":["code","field","message"],"title":"AtsTagsGetResponsesContentApplicationJsonSchemaErrorsItems"},"ListTags-v2026-02-27RequestBadRequestError":{"type":"object","properties":{"path":{"type":"string","description":"Request URL path"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/AtsTagsGetResponsesContentApplicationJsonSchemaErrorsItems"},"description":"List of error objects"},"timestamp":{"type":"string","format":"date-time","description":"Time when the error occurred"},"status_code":{"type":"integer","description":"HTTP status code"}},"required":["path","errors","timestamp","status_code"],"title":"ListTags-v2026-02-27RequestBadRequestError"},"ListTags-v2026-02-27RequestInternalServerError":{"type":"object","properties":{"path":{"type":"string","description":"Request URL path"},"timestamp":{"type":"string","format":"date-time","description":"Time when the error occurred"},"status_code":{"type":"integer","description":"HTTP status code"}},"required":["path","timestamp","status_code"],"title":"ListTags-v2026-02-27RequestInternalServerError"},"AtsApplicationSourcesGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Application source unique identifier"},"slug":{"type":"string","description":"Application source slug"},"created_at":{"type":"string","format":"date-time","description":"Timestamp of when the application source was created"},"updated_at":{"type":"string","format":"date-time","description":"Timestamp of when the application source was last updated"}},"required":["id","slug","created_at","updated_at"],"title":"AtsApplicationSourcesGetResponsesContentApplicationJsonSchemaDataItems"},"ATS_retrieveAListOfAtsApplicationSources_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/AtsApplicationSourcesGetResponsesContentApplicationJsonSchemaDataItems"}},"has_more":{"type":"boolean","description":"Indicates if there are more application sources to fetch"},"next_cursor":{"type":["string","null"],"description":"Cursor for the next page of results"},"total_count":{"type":"integer","description":"Total number of application sources available"}},"required":["data","has_more","next_cursor","total_count"],"title":"ATS_retrieveAListOfAtsApplicationSources_Response_200"},"AtsApplicationsGetParametersJobCriteriasMatchingsSchemaItemsIsMatched":{"type":"string","enum":["MATCHED","NOT_MATCHED","UNDECIDED"],"description":"The matching state for the job criteria","title":"AtsApplicationsGetParametersJobCriteriasMatchingsSchemaItemsIsMatched"},"AtsApplicationsGetParametersJobCriteriasMatchingsSchemaItems":{"type":"object","properties":{"is_matched":{"$ref":"#/components/schemas/AtsApplicationsGetParametersJobCriteriasMatchingsSchemaItemsIsMatched","description":"The matching state for the job criteria"},"job_criteria_id":{"type":"string","format":"uuid","description":"The job criteria ID to filter by"}},"required":["is_matched","job_criteria_id"],"title":"AtsApplicationsGetParametersJobCriteriasMatchingsSchemaItems"},"AtsApplicationsGetParametersSortBy":{"type":"string","enum":["APPLICATION_CREATION_DATE","STAGE_CREATION_DATE"],"title":"AtsApplicationsGetParametersSortBy"},"AtsApplicationsGetParametersSortOrder":{"type":"string","enum":["ASC","DESC"],"title":"AtsApplicationsGetParametersSortOrder"},"AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsJob":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Job unique identifier"},"title":{"type":"string","description":"Job title"}},"required":["id","title"],"description":"Job information for the application","title":"AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsJob"},"AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsCandidateCandidateTagsItemsTag":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Tag unique identifier"},"label":{"type":"string","description":"Tag label"}},"required":["id","label"],"title":"AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsCandidateCandidateTagsItemsTag"},"AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsCandidateCandidateTagsItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Candidate tag unique identifier"},"tag":{"$ref":"#/components/schemas/AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsCandidateCandidateTagsItemsTag"}},"required":["id","tag"],"title":"AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsCandidateCandidateTagsItems"},"AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsCandidate":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Candidate unique identifier"},"email":{"type":"string","format":"email","description":"Candidate email address"},"pic_url":{"type":["string","null"],"description":"Candidate profile picture URL"},"last_name":{"type":"string","description":"Candidate last name"},"first_name":{"type":"string","description":"Candidate first name"},"phone_number":{"type":["string","null"],"description":"Candidate phone number (may be empty string or null)"},"candidate_tags":{"type":"array","items":{"$ref":"#/components/schemas/AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsCandidateCandidateTagsItems"},"description":"Tags associated with the candidate"}},"required":["id","email","pic_url","last_name","first_name","phone_number","candidate_tags"],"description":"Candidate information associated with the application","title":"AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsCandidate"},"AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsJobPosting":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Job posting unique identifier"},"title":{"type":"string","description":"Job posting title"}},"required":["id","title"],"description":"Job posting information (if application came through a posting)","title":"AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsJobPosting"},"AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsSourceSlug":{"type":"string","enum":["SOURCED_INTERNALLY","EXTERNAL_CAREER_PAGE","LINKEDIN_PREMIUM","LINKEDIN_BASIC","INTERNAL_CAREER_PAGE","INTERNAL_REFERRAL","BULK_IMPORTED"],"description":"Source of the application","title":"AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsSourceSlug"},"AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsJobEmploymentTypeEmploymentType":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Employment type unique identifier"},"name":{"type":"string","description":"Employment type name"}},"required":["id","name"],"title":"AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsJobEmploymentTypeEmploymentType"},"AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsJobEmploymentType":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Job employment type unique identifier"},"employment_type":{"$ref":"#/components/schemas/AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsJobEmploymentTypeEmploymentType"}},"required":["id","employment_type"],"description":"Employment type information for the job","title":"AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsJobEmploymentType"},"AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsApplicationFormSubmissionAnswersItemsAnswer":{"oneOf":[{"type":"string"},{"type":"number","format":"double"}],"title":"AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsApplicationFormSubmissionAnswersItemsAnswer"},"AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsApplicationFormSubmissionAnswersItemsQuestionType":{"type":"string","enum":["FREETEXT","PARAGRAPH","SINGLESELECTION","MULTISELECTION","DOCUMENTUPLOAD","PRESETDROPDOWN","CUSTOMDROPDOWN","NUMBER","DATEPICKER","ADDRESS","PHONENUMBER","EMAIL"],"description":"Type of the question (uppercase)","title":"AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsApplicationFormSubmissionAnswersItemsQuestionType"},"AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsApplicationFormSubmissionAnswersItems":{"type":"object","properties":{"answer":{"$ref":"#/components/schemas/AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsApplicationFormSubmissionAnswersItemsAnswer"},"question_text":{"type":"string","description":"Text of the question"},"question_type":{"$ref":"#/components/schemas/AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsApplicationFormSubmissionAnswersItemsQuestionType","description":"Type of the question (uppercase)"},"data_binding_id":{"type":"string","format":"uuid","description":"Data binding identifier for the question"}},"required":["answer","question_text","question_type","data_binding_id"],"description":"Parsed form submission answer","title":"AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsApplicationFormSubmissionAnswersItems"},"AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsApplicationFormSubmission":{"type":"object","properties":{"id":{"type":["string","null"],"format":"uuid","description":"Identifier of the application form submission"},"answers":{"type":["array","null"],"items":{"$ref":"#/components/schemas/AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsApplicationFormSubmissionAnswersItems"},"description":"Array of parsed form submission answers"}},"required":["id","answers"],"description":"Application form submission data with parsed answers","title":"AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsApplicationFormSubmission"},"AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsApplicationJobCriteriasMatchingsItemsIsMatched":{"type":"string","enum":["MATCHED","NOT_MATCHED","UNDECIDED"],"description":"Whether the criteria is matched","title":"AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsApplicationJobCriteriasMatchingsItemsIsMatched"},"AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsApplicationJobCriteriasMatchingsItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Job criteria matching unique identifier"},"is_matched":{"$ref":"#/components/schemas/AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsApplicationJobCriteriasMatchingsItemsIsMatched","description":"Whether the criteria is matched"},"description":{"type":"string","description":"Job criteria matching description"},"job_criteria_id":{"type":"string","format":"uuid","description":"Job criteria unique identifier"}},"required":["id","is_matched","description","job_criteria_id"],"title":"AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsApplicationJobCriteriasMatchingsItems"},"AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsCurrentApplicationInterviewPlanStageInterviewPlanStage":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Interview plan stage unique identifier"},"name":{"type":"string","description":"Interview plan stage name"},"default_type_slug":{"type":["string","null"],"description":"Interview plan stage default type slug"},"category_type_slug":{"type":"string","description":"Interview plan stage category type"}},"required":["id","name","default_type_slug","category_type_slug"],"title":"AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsCurrentApplicationInterviewPlanStageInterviewPlanStage"},"AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsCurrentApplicationInterviewPlanStage":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Application interview plan stage unique identifier"},"application_id":{"type":"string","format":"uuid","description":"Application unique identifier"},"interview_plan_stage":{"$ref":"#/components/schemas/AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsCurrentApplicationInterviewPlanStageInterviewPlanStage"},"interview_plan_stage_id":{"type":"string","format":"uuid","description":"Interview plan stage unique identifier"}},"required":["id","application_id","interview_plan_stage","interview_plan_stage_id"],"description":"Current interview plan stage information for the application","title":"AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsCurrentApplicationInterviewPlanStage"},"AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Application unique identifier"},"job":{"$ref":"#/components/schemas/AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsJob","description":"Job information for the application"},"candidate":{"$ref":"#/components/schemas/AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsCandidate","description":"Candidate information associated with the application"},"created_at":{"type":"string","format":"date-time","description":"Timestamp of when the application was created"},"numeric_id":{"type":"integer","description":"Application numeric identifier"},"job_posting":{"oneOf":[{"$ref":"#/components/schemas/AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsJobPosting"},{"type":"null"}],"description":"Job posting information (if application came through a posting)"},"source_slug":{"oneOf":[{"$ref":"#/components/schemas/AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsSourceSlug"},{"type":"null"}],"description":"Source of the application"},"job_employment_type":{"$ref":"#/components/schemas/AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsJobEmploymentType","description":"Employment type information for the job"},"moved_to_current_stage_at":{"type":"string","format":"date-time","description":"Timestamp of when the application moved to current stage"},"application_form_submission":{"oneOf":[{"$ref":"#/components/schemas/AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsApplicationFormSubmission"},{"type":"null"}],"description":"Application form submission data with parsed answers"},"application_job_criterias_matchings":{"type":"array","items":{"$ref":"#/components/schemas/AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsApplicationJobCriteriasMatchingsItems"},"description":"AI-generated job criteria matching results for the application"},"created_by_hris_organization_user_id":{"type":["string","null"],"format":"uuid","description":"User who created the application"},"current_application_interview_plan_stage":{"$ref":"#/components/schemas/AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItemsCurrentApplicationInterviewPlanStage","description":"Current interview plan stage information for the application"},"current_application_interview_plan_stage_id":{"type":["string","null"],"format":"uuid","description":"Current interview plan stage unique identifier"},"application_form_form_builder_form_submission_id":{"type":["string","null"],"format":"uuid","description":"Application form submission unique identifier"}},"required":["id","created_at","numeric_id","moved_to_current_stage_at"],"title":"AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItems"},"ATS_retrieveAListOfAtsApplications-v2026-01-01_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/AtsApplicationsGetResponsesContentApplicationJsonSchemaDataItems"}},"has_more":{"type":"boolean","description":"Indicates if there are more applications to fetch"},"next_cursor":{"type":["string","null"],"description":"Cursor for the next page of results"},"total_count":{"type":"integer","description":"Total number of applications available"}},"required":["data","has_more","next_cursor","total_count"],"title":"ATS_retrieveAListOfAtsApplications-v2026-01-01_Response_200"},"AtsApplicationsGetResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code"},"message":{"type":"string","description":"Human-readable explanation of the error"}},"title":"AtsApplicationsGetResponsesContentApplicationJsonSchemaErrorsItems"},"RetrieveAListOfAtsApplications-v2026-01-01RequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/AtsApplicationsGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"RetrieveAListOfAtsApplications-v2026-01-01RequestBadRequestError"},"RetrieveAListOfAtsApplications-v2026-01-01RequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/AtsApplicationsGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"RetrieveAListOfAtsApplications-v2026-01-01RequestInternalServerError"},"AtsDepartmentsGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the department"},"name":{"type":"string","description":"Name of the department"},"created_at":{"type":"string","format":"date-time","description":"Timestamp when the department was created"},"updated_at":{"type":"string","format":"date-time","description":"Timestamp when the department was last updated"}},"required":["id","name","created_at","updated_at"],"title":"AtsDepartmentsGetResponsesContentApplicationJsonSchemaDataItems"},"ATS_retrieveAListOfAtsDepartments_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/AtsDepartmentsGetResponsesContentApplicationJsonSchemaDataItems"}},"has_more":{"type":"boolean","description":"Indicates if there are more departments available"},"next_cursor":{"type":["string","null"],"description":"Cursor for pagination to get the next set of results"},"total_count":{"type":"integer","description":"Total number of departments available"}},"required":["data","has_more","next_cursor","total_count"],"title":"ATS_retrieveAListOfAtsDepartments_Response_200"},"AtsDepartmentsGetResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string"},"field":{"type":"string"},"message":{"type":"string"}},"title":"AtsDepartmentsGetResponsesContentApplicationJsonSchemaErrorsItems"},"RetrieveAListOfAtsDepartmentsRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/AtsDepartmentsGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"RetrieveAListOfAtsDepartmentsRequestBadRequestError"},"AtsEmploymentTypesGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the employment type"},"name":{"type":"string","description":"Name of the employment type"},"created_at":{"type":"string","format":"date-time","description":"Timestamp when the employment type was created"},"updated_at":{"type":"string","format":"date-time","description":"Timestamp when the employment type was last updated"}},"required":["id","name","created_at","updated_at"],"title":"AtsEmploymentTypesGetResponsesContentApplicationJsonSchemaDataItems"},"ATS_retrieveAListOfAtsEmploymentTypes_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/AtsEmploymentTypesGetResponsesContentApplicationJsonSchemaDataItems"}},"has_more":{"type":"boolean","description":"Indicates if there are more employment types available"},"next_cursor":{"type":["string","null"],"description":"Cursor for pagination to get the next set of results"},"total_count":{"type":"integer","description":"Total number of employment types available"}},"required":["data","has_more","next_cursor","total_count"],"title":"ATS_retrieveAListOfAtsEmploymentTypes_Response_200"},"AtsEmploymentTypesGetResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string"},"field":{"type":"string"},"message":{"type":"string"}},"title":"AtsEmploymentTypesGetResponsesContentApplicationJsonSchemaErrorsItems"},"RetrieveAListOfAtsEmploymentTypesRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/AtsEmploymentTypesGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"RetrieveAListOfAtsEmploymentTypesRequestBadRequestError"},"AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobTeamsItemsTeam":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the team"},"name":{"type":"string","description":"Team name"}},"required":["id","name"],"description":"Details for the team assigned to the job","title":"AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobTeamsItemsTeam"},"AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobTeamsItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the job team"},"team":{"$ref":"#/components/schemas/AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobTeamsItemsTeam","description":"Details for the team assigned to the job"}},"required":["id","team"],"title":"AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobTeamsItems"},"AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobCompensation":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the compensation record"},"max_amount":{"type":["number","null"],"format":"double","description":"Maximum compensation amount"},"min_amount":{"type":["number","null"],"format":"double","description":"Minimum compensation amount"},"currency_iso_code":{"type":"string","description":"Currency ISO code for the compensation"}},"required":["id","currency_iso_code"],"description":"Compensation information for the job","title":"AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobCompensation"},"AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobLocationsItemsLocation":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the location"},"name":{"type":"string","description":"Location name"}},"required":["id","name"],"description":"Details for the location assigned to the job","title":"AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobLocationsItemsLocation"},"AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobLocationsItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the job location"},"location":{"$ref":"#/components/schemas/AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobLocationsItemsLocation","description":"Details for the location assigned to the job"}},"required":["id","location"],"title":"AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobLocationsItems"},"AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobDepartmentsItemsDepartment":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the department"},"name":{"type":"string","description":"Department name"}},"description":"Details for the department associated with the job","title":"AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobDepartmentsItemsDepartment"},"AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobDepartmentsItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the job department"},"department":{"oneOf":[{"$ref":"#/components/schemas/AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobDepartmentsItemsDepartment"},{"type":"null"}],"description":"Details for the department associated with the job"}},"required":["id"],"title":"AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobDepartmentsItems"},"AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobEmploymentTypesItemsEmploymentType":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the employment type"},"name":{"type":"string","description":"Employment type name"}},"required":["id","name"],"description":"Details for the employment type assigned to the job","title":"AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobEmploymentTypesItemsEmploymentType"},"AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobEmploymentTypesItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the job employment type"},"employment_type":{"$ref":"#/components/schemas/AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobEmploymentTypesItemsEmploymentType","description":"Details for the employment type assigned to the job"}},"required":["id","employment_type"],"title":"AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobEmploymentTypesItems"},"AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJob":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the job"},"job_teams":{"type":["array","null"],"items":{"$ref":"#/components/schemas/AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobTeamsItems"},"description":"Teams associated with the job"},"compensation":{"oneOf":[{"$ref":"#/components/schemas/AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobCompensation"},{"type":"null"}],"description":"Compensation information for the job"},"job_locations":{"type":"array","items":{"$ref":"#/components/schemas/AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobLocationsItems"},"description":"Locations associated with the job"},"job_departments":{"type":["array","null"],"items":{"$ref":"#/components/schemas/AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobDepartmentsItems"},"description":"Departments associated with the job"},"job_employment_types":{"type":"array","items":{"$ref":"#/components/schemas/AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobEmploymentTypesItems"},"description":"Employment types associated with the job"}},"required":["id","compensation","job_locations","job_employment_types"],"description":"Associated job information","title":"AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJob"},"AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsPublicationsItemsJobBoard":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the job board"}},"required":["id"],"description":"Job board where the posting is published","title":"AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsPublicationsItemsJobBoard"},"AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsPublicationsItemsCurrentStateStateSlug":{"type":"string","enum":["PUBLISHED_BASIC","PUBLISHED_PREMIUM","UNPUBLISHED","EXPIRED","IN_PROGRESS","FAILED"],"description":"Current publication state","title":"AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsPublicationsItemsCurrentStateStateSlug"},"AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsPublicationsItemsCurrentState":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the publication state"},"created_at":{"type":"string","format":"date-time","description":"Timestamp when the publication was created"},"created_by":{"type":["string","null"],"format":"uuid","description":"User who created the publication"},"state_slug":{"$ref":"#/components/schemas/AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsPublicationsItemsCurrentStateStateSlug","description":"Current publication state"},"error_message":{"type":["string","null"],"description":"Error message if publication failed"}},"required":["id","created_at","state_slug"],"description":"Current publication state details","title":"AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsPublicationsItemsCurrentState"},"AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsPublicationsItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the job posting publication"},"job_board":{"$ref":"#/components/schemas/AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsPublicationsItemsJobBoard","description":"Job board where the posting is published"},"current_state":{"$ref":"#/components/schemas/AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsPublicationsItemsCurrentState","description":"Current publication state details"}},"required":["id","job_board","current_state"],"title":"AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsPublicationsItems"},"AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsApplicationForm":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the application form"},"title":{"type":"string","description":"Title of the application form"}},"required":["id","title"],"description":"Application form assigned to the job posting","title":"AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsApplicationForm"},"AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the job posting"},"job":{"$ref":"#/components/schemas/AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJob","description":"Associated job information"},"title":{"type":"string","description":"Job posting title"},"created_at":{"type":"string","format":"date-time","description":"Creation timestamp"},"updated_at":{"type":"string","format":"date-time","description":"Last update timestamp"},"publications":{"type":"array","items":{"$ref":"#/components/schemas/AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsPublicationsItems"},"description":"Publication information for different job boards"},"application_form":{"oneOf":[{"$ref":"#/components/schemas/AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsApplicationForm"},{"type":"null"}],"description":"Application form assigned to the job posting"},"richtext_description":{"type":["string","null"],"description":"Rich text description of the job posting"},"is_compensation_visible":{"type":"boolean","description":"Indicates if compensation details are visible to candidates"}},"required":["id","job","title","created_at","updated_at","publications","richtext_description","is_compensation_visible"],"title":"AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItems"},"ATS_retrieveAListOfAtsJobPostings_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaDataItems"}},"has_more":{"type":"boolean","description":"Indicates if there are more results available"},"next_cursor":{"type":["string","null"],"description":"Cursor for the next page of results"},"total_count":{"type":"integer","description":"Total number of job postings"}},"title":"ATS_retrieveAListOfAtsJobPostings_Response_200"},"AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaItems":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code"},"message":{"type":"string","description":"A description of the returned error"}},"title":"AtsJobBoardsJobBoardIdJobPostingsGetResponsesContentApplicationJsonSchemaItems"},"AtsJobsGetParametersStatusSchemaItems":{"type":"string","enum":["OPEN","CLOSED","DRAFT","WAITING_FOR_APPROVAL","APPROVED","NOT_APPROVED","ARCHIVED"],"title":"AtsJobsGetParametersStatusSchemaItems"},"AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsStatus":{"type":"string","enum":["OPEN","CLOSED","DRAFT","WAITING_FOR_APPROVAL","APPROVED","NOT_APPROVED","ARCHIVED"],"description":"Job status","title":"AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsStatus"},"AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsJobTeamsItemsTeam":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the team"},"name":{"type":"string","description":"Team name"}},"description":"Team associated with the job","title":"AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsJobTeamsItemsTeam"},"AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsJobTeamsItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the job team"},"team":{"$ref":"#/components/schemas/AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsJobTeamsItemsTeam","description":"Team associated with the job"}},"title":"AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsJobTeamsItems"},"AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsJobLocationsItemsLocation":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the location"},"name":{"type":"string","description":"Location name"}},"description":"Location associated with the job","title":"AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsJobLocationsItemsLocation"},"AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsJobLocationsItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the job location"},"location":{"$ref":"#/components/schemas/AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsJobLocationsItemsLocation","description":"Location associated with the job"}},"title":"AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsJobLocationsItems"},"AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsHiringMembersItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the hiring member"},"hris_organization_user_id":{"type":"string","format":"uuid","description":"Unique identifier for the HRIS organization user"}},"title":"AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsHiringMembersItems"},"AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsJobDepartmentsItemsDepartment":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the department"},"name":{"type":"string","description":"Department name"}},"description":"Department associated with the job","title":"AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsJobDepartmentsItemsDepartment"},"AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsJobDepartmentsItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the job department"},"department":{"oneOf":[{"$ref":"#/components/schemas/AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsJobDepartmentsItemsDepartment"},{"type":"null"}],"description":"Department associated with the job"}},"title":"AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsJobDepartmentsItems"},"AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsCurrentCompensationPeriodSlug":{"type":"string","enum":["ANNUALLY","MONTHLY","SEMIMONTHLY","BIWEEKLY","WEEKLY","DAILY","HOURLY"],"description":"Compensation period","title":"AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsCurrentCompensationPeriodSlug"},"AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsCurrentCompensation":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the compensation"},"job_id":{"type":"string","format":"uuid","description":"Job ID associated with the compensation"},"max_amount":{"type":["number","null"],"format":"double","description":"Maximum compensation amount"},"min_amount":{"type":["number","null"],"format":"double","description":"Minimum compensation amount"},"period_slug":{"$ref":"#/components/schemas/AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsCurrentCompensationPeriodSlug","description":"Compensation period"},"currency_iso_code":{"type":"string","description":"ISO code of the currency"}},"description":"Current compensation details","title":"AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsCurrentCompensation"},"AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsJobEmploymentTypesItemsEmploymentType":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the employment type"},"name":{"type":"string","description":"Employment type name"}},"description":"Employment type associated with the job","title":"AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsJobEmploymentTypesItemsEmploymentType"},"AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsJobEmploymentTypesItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the job employment type"},"employment_type":{"$ref":"#/components/schemas/AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsJobEmploymentTypesItemsEmploymentType","description":"Employment type associated with the job"}},"title":"AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsJobEmploymentTypesItems"},"AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsInterviewPlanStagesItemsCategoryTypeSlug":{"type":"string","enum":["LEAD","ACTIVE","COMPLETED"],"description":"Category type of the interview plan stage","title":"AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsInterviewPlanStagesItemsCategoryTypeSlug"},"AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsInterviewPlanStagesItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the interview plan stage"},"name":{"type":"string","description":"Interview plan stage name"},"position_number":{"type":["integer","null"],"description":"Position number of the stage in the interview plan"},"default_type_slug":{"type":["string","null"],"description":"Default type slug of the interview plan stage"},"interview_plan_id":{"type":"string","format":"uuid","description":"Interview plan ID associated with this stage"},"category_type_slug":{"$ref":"#/components/schemas/AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsInterviewPlanStagesItemsCategoryTypeSlug","description":"Category type of the interview plan stage"}},"title":"AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsInterviewPlanStagesItems"},"AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsHiringMemberJobPermissionsByTypeSlug":{"type":"object","properties":{"hiring_team":{"type":"string","description":"Hiring team permissions"},"job_posting":{"type":"string","description":"Job posting permissions"},"compensation":{"type":"string","description":"Compensation permissions"},"interview_plan":{"type":"string","description":"Interview plan permissions"},"application_form_submission":{"type":"string","description":"Application form submission permissions"},"application_form_submission_sensitive_fields":{"type":"string","description":"Application form submission sensitive fields permissions"}},"description":"Hiring member job permissions by type slug","title":"AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsHiringMemberJobPermissionsByTypeSlug"},"AtsJobsGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the job"},"title":{"type":"string","description":"Job title"},"status":{"$ref":"#/components/schemas/AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsStatus","description":"Job status"},"job_teams":{"type":["array","null"],"items":{"$ref":"#/components/schemas/AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsJobTeamsItems"},"description":"Teams associated with the job"},"created_at":{"type":"string","format":"date-time","description":"Timestamp when the job was created"},"updated_at":{"type":"string","format":"date-time","description":"Timestamp when the job was last updated"},"job_locations":{"type":"array","items":{"$ref":"#/components/schemas/AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsJobLocationsItems"},"description":"Locations associated with the job"},"hiring_members":{"type":["array","null"],"items":{"$ref":"#/components/schemas/AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsHiringMembersItems"},"description":"Hiring members associated with the job"},"is_confidential":{"type":"boolean","description":"Indicates if the job is confidential"},"job_departments":{"type":["array","null"],"items":{"$ref":"#/components/schemas/AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsJobDepartmentsItems"},"description":"Departments associated with the job"},"approval_rule_id":{"type":["string","null"],"format":"uuid","description":"Unique identifier for the approval rule"},"applications_count":{"type":["integer","null"],"description":"Number of applications for the job"},"approval_request_id":{"type":["string","null"],"format":"uuid","description":"Unique identifier for the approval request"},"current_compensation":{"oneOf":[{"$ref":"#/components/schemas/AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsCurrentCompensation"},{"type":"null"}],"description":"Current compensation details"},"job_employment_types":{"type":"array","items":{"$ref":"#/components/schemas/AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsJobEmploymentTypesItems"},"description":"Employment types associated with the job"},"richtext_description":{"type":["string","null"],"description":"Rich text description of the job"},"interview_plan_stages":{"type":["array","null"],"items":{"$ref":"#/components/schemas/AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsInterviewPlanStagesItems"},"description":"Interview plan stages"},"approval_request_stringified":{"type":["string","null"],"description":"Stringified approval request"},"created_by_hris_organization_user_id":{"type":["string","null"],"format":"uuid","description":"Unique identifier of the user who created the job"},"hiring_member_job_permissions_by_type_slug":{"oneOf":[{"$ref":"#/components/schemas/AtsJobsGetResponsesContentApplicationJsonSchemaDataItemsHiringMemberJobPermissionsByTypeSlug"},{"type":"null"}],"description":"Hiring member job permissions by type slug"}},"title":"AtsJobsGetResponsesContentApplicationJsonSchemaDataItems"},"ATS_retrieveAListOfAtsJobs_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/AtsJobsGetResponsesContentApplicationJsonSchemaDataItems"}},"has_more":{"type":"boolean","description":"Indicates if there are more items to fetch."},"next_cursor":{"type":["string","null"],"description":"Cursor for the next page of results"},"total_count":{"type":"integer","description":"Total number of jobs"}},"title":"ATS_retrieveAListOfAtsJobs_Response_200"},"AtsJobsGetResponsesContentApplicationJsonSchemaItems":{"type":"object","properties":{"code":{"type":"string","description":"Error code of the handler which produced the returned error"},"field":{"type":"string","description":"The field name where input validation failed"},"message":{"type":"string","description":"Description of the returned error"}},"title":"AtsJobsGetResponsesContentApplicationJsonSchemaItems"},"AtsLocationsGetResponsesContentApplicationJsonSchemaDataItemsLocationGroup":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the location group"},"name":{"type":"string","description":"Name of the location group"}},"description":"Location group information","title":"AtsLocationsGetResponsesContentApplicationJsonSchemaDataItemsLocationGroup"},"AtsLocationsGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the location"},"city":{"type":["string","null"],"description":"City name"},"name":{"type":"string","description":"Name of the location/country"},"is_remote":{"type":"boolean","description":"Indicates if this is a remote location"},"created_at":{"type":"string","format":"date-time","description":"Timestamp when the location was created"},"updated_at":{"type":"string","format":"date-time","description":"Timestamp when the location was last updated"},"country_code":{"type":["string","null"],"description":"ISO country code"},"location_group":{"oneOf":[{"$ref":"#/components/schemas/AtsLocationsGetResponsesContentApplicationJsonSchemaDataItemsLocationGroup"},{"type":"null"}],"description":"Location group information"},"province_or_region_text":{"type":["string","null"],"description":"Province or region text"}},"required":["id","name","created_at","updated_at"],"title":"AtsLocationsGetResponsesContentApplicationJsonSchemaDataItems"},"ATS_retrieveAListOfAtsLocations-v2026-01-01_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/AtsLocationsGetResponsesContentApplicationJsonSchemaDataItems"}},"has_more":{"type":"boolean","description":"Indicates if there are more locations available"},"next_cursor":{"type":["string","null"],"description":"Cursor for pagination to get the next set of results"},"total_count":{"type":"integer","description":"Total number of locations available"}},"required":["data","has_more","next_cursor","total_count"],"title":"ATS_retrieveAListOfAtsLocations-v2026-01-01_Response_200"},"AtsLocationsGetResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string"},"field":{"type":"string"},"message":{"type":"string"}},"title":"AtsLocationsGetResponsesContentApplicationJsonSchemaErrorsItems"},"RetrieveAListOfAtsLocations-v2026-01-01RequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/AtsLocationsGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"RetrieveAListOfAtsLocations-v2026-01-01RequestBadRequestError"},"AtsOffersGetResponsesContentApplicationJsonSchemaDataItemsEmail":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the email"},"body":{"type":"string","description":"Email body"},"subject":{"type":"string","description":"Email subject"},"sender_name":{"type":"string","description":"Sender name"},"recipient_cc":{"type":["string","null"],"format":"email","description":"Carbon-copy recipient email address"},"recipient_to":{"type":"string","format":"email","description":"Primary recipient email address"},"recipient_bcc":{"type":["string","null"],"format":"email","description":"Blind-carbon-copy recipient email address"}},"description":"Email details","title":"AtsOffersGetResponsesContentApplicationJsonSchemaDataItemsEmail"},"AtsOffersGetResponsesContentApplicationJsonSchemaDataItemsWorkerType":{"type":"string","enum":["CONTRACTOR","DIRECT_EMPLOYEE","EOR_EMPLOYEE","GLOBAL_PAYROLL_EMPLOYEE","PEO_EMPLOYEE","UNKNOWN"],"description":"Worker type","title":"AtsOffersGetResponsesContentApplicationJsonSchemaDataItemsWorkerType"},"AtsOffersGetResponsesContentApplicationJsonSchemaDataItemsOfferStatus":{"type":"string","enum":["CREATED","WAITING_FOR_APPROVAL","APPROVED","NOT_APPROVED","SENT","ACCEPTED","REJECTED"],"description":"Offer status","title":"AtsOffersGetResponsesContentApplicationJsonSchemaDataItemsOfferStatus"},"AtsOffersGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier"},"email":{"oneOf":[{"$ref":"#/components/schemas/AtsOffersGetResponsesContentApplicationJsonSchemaDataItemsEmail"},{"type":"null"}],"description":"Email details"},"job_title":{"type":"string","description":"Job title"},"created_at":{"type":"string","format":"date-time","description":"Timestamp when the offer was created"},"start_date":{"type":"string","format":"date","description":"Start date"},"updated_at":{"type":"string","format":"date-time","description":"Timestamp when the offer was last updated"},"worker_type":{"$ref":"#/components/schemas/AtsOffersGetResponsesContentApplicationJsonSchemaDataItemsWorkerType","description":"Worker type"},"country_code":{"type":"string","format":"country-code","description":"Country code"},"offer_status":{"$ref":"#/components/schemas/AtsOffersGetResponsesContentApplicationJsonSchemaDataItemsOfferStatus","description":"Offer status"},"attachment_id":{"type":["string","null"],"format":"uuid","description":"Attachment identifier"},"approval_rule_id":{"type":["string","null"],"format":"uuid","description":"Approval rule identifier"},"approval_request_id":{"type":["string","null"],"format":"uuid","description":"Approval request identifier"},"compensation_amount":{"type":"number","format":"double","description":"Compensation amount"},"rejection_reason_id":{"type":["string","null"],"format":"uuid","description":"Rejection reason identifier"},"compensation_currency":{"type":"string","description":"Compensation currency"},"application_interview_plan_stage_id":{"type":"string","format":"uuid","description":"Application interview plan stage identifier"}},"title":"AtsOffersGetResponsesContentApplicationJsonSchemaDataItems"},"ATS_retrieveAListOfAtsOffers-v2026-01-01_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/AtsOffersGetResponsesContentApplicationJsonSchemaDataItems"}},"has_more":{"type":"boolean","description":"Indicates if there are more items to fetch."},"next_cursor":{"type":["string","null"],"description":"Cursor for the next page of results"},"total_count":{"type":"number","format":"double","description":"Total number of offers"}},"title":"ATS_retrieveAListOfAtsOffers-v2026-01-01_Response_200"},"RetrieveAListOfAtsOffers-v2026-01-01RequestBadRequestError":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code"},"message":{"type":"string","description":"A description of the returned error"}},"title":"RetrieveAListOfAtsOffers-v2026-01-01RequestBadRequestError"},"AtsEmailTemplatesGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Email template unique identifier"},"title":{"type":"string","description":"Email template title"},"created_at":{"type":"string","format":"date-time","description":"Timestamp of when the email template was created"},"updated_at":{"type":"string","format":"date-time","description":"Timestamp of when the email template was last updated"}},"required":["id","title","created_at","updated_at"],"title":"AtsEmailTemplatesGetResponsesContentApplicationJsonSchemaDataItems"},"ATS_retrieveAListOfPublishedAtsEmailTemplates-v2026-02-11_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/AtsEmailTemplatesGetResponsesContentApplicationJsonSchemaDataItems"}},"has_more":{"type":"boolean","description":"Indicates if there are more email templates to fetch"},"next_cursor":{"type":["string","null"],"description":"Cursor for the next page of results"},"total_count":{"type":"integer","description":"Total number of email templates available"}},"required":["data","has_more","next_cursor","total_count"],"title":"ATS_retrieveAListOfPublishedAtsEmailTemplates-v2026-02-11_Response_200"},"AtsEmailTemplatesGetResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code"},"field":{"type":"string","description":"Name of the field causing the error (for validation issues)"},"message":{"type":"string","description":"Human-readable explanation of the error"}},"title":"AtsEmailTemplatesGetResponsesContentApplicationJsonSchemaErrorsItems"},"RetrieveAListOfPublishedAtsEmailTemplates-v2026-02-11RequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/AtsEmailTemplatesGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"RetrieveAListOfPublishedAtsEmailTemplates-v2026-02-11RequestInternalServerError"},"AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataJob":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the job"},"title":{"type":"string","description":"Title of the job"}},"required":["id","title"],"description":"Job details","title":"AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataJob"},"AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataNotesItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the note"},"created_at":{"type":"string","format":"date-time","description":"Timestamp when the note was created"},"created_by":{"type":"string","format":"uuid","description":"Unique identifier for the user who created the note"},"updated_at":{"type":"string","format":"date-time","description":"Timestamp when the note was last updated"},"richtext_content":{"type":"string","description":"Rich text content of the note"}},"required":["id","created_at","created_by","updated_at","richtext_content"],"description":"Note associated with the application","title":"AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataNotesItems"},"AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataCandidateAttachmentsItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the attachment"},"ai_summary":{"type":["string","null"],"description":"AI-generated summary of the attachment content"}},"required":["id","ai_summary"],"title":"AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataCandidateAttachmentsItems"},"AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataCandidateCandidateTagsItemsTag":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the tag"},"label":{"type":"string","description":"Label of the tag"}},"required":["id","label"],"description":"Tag details","title":"AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataCandidateCandidateTagsItemsTag"},"AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataCandidateCandidateTagsItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the candidate tag"},"tag":{"$ref":"#/components/schemas/AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataCandidateCandidateTagsItemsTag","description":"Tag details"}},"required":["id","tag"],"description":"Candidate tag","title":"AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataCandidateCandidateTagsItems"},"AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataCandidate":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the candidate"},"email":{"type":"string","description":"Email address of the candidate"},"last_name":{"type":"string","description":"Last name of the candidate"},"first_name":{"type":"string","description":"First name of the candidate"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataCandidateAttachmentsItems"},"description":"Array of attachments associated with the candidate (e.g., resume, cover letter)"},"phone_number":{"type":["string","null"],"description":"Phone number of the candidate"},"candidate_tags":{"type":"array","items":{"$ref":"#/components/schemas/AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataCandidateCandidateTagsItems"},"description":"Tags associated with the candidate"},"import_session_id":{"type":["string","null"],"description":"Import session identifier if the candidate was bulk imported"},"profile_picture_url":{"type":["string","null"],"description":"Profile picture URL of the candidate"}},"required":["id","email","last_name","first_name","attachments","phone_number","candidate_tags","import_session_id","profile_picture_url"],"description":"Candidate details","title":"AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataCandidate"},"AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataJobBoardType":{"type":"string","enum":["INTERNAL_CAREER_PAGE","EXTERNAL_CAREER_PAGE","LINKEDIN"],"description":"Type of job board","title":"AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataJobBoardType"},"AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataJobBoard":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the job board"},"type":{"$ref":"#/components/schemas/AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataJobBoardType","description":"Type of job board"}},"required":["id","type"],"description":"Job board details where the application originated","title":"AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataJobBoard"},"AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataJobPosting":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the job posting"},"title":{"type":"string","description":"Title of the job posting"}},"required":["id","title"],"description":"Job posting details","title":"AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataJobPosting"},"AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataSourceSlug":{"type":"string","enum":["SOURCED_INTERNALLY","EXTERNAL_CAREER_PAGE","LINKEDIN_PREMIUM","LINKEDIN_BASIC","INTERNAL_CAREER_PAGE","INTERNAL_REFERRAL","BULK_IMPORTED"],"description":"Source of the application","title":"AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataSourceSlug"},"AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataJobEmploymentTypeEmploymentType":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Identifier of the employment type"},"name":{"type":"string","description":"Human readable employment type"}},"required":["id","name"],"description":"Employment type metadata","title":"AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataJobEmploymentTypeEmploymentType"},"AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataJobEmploymentType":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Identifier of the job employment type record"},"employment_type":{"$ref":"#/components/schemas/AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataJobEmploymentTypeEmploymentType","description":"Employment type metadata"}},"required":["id","employment_type"],"description":"Employment type associated with the application","title":"AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataJobEmploymentType"},"AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataJobPostingPublication":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the job posting publication"}},"required":["id"],"description":"Job posting publication details","title":"AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataJobPostingPublication"},"AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataReferralFormSubmission":{"type":"object","properties":{"id":{"type":["string","null"],"format":"uuid","description":"Identifier of the referral form submission"},"form_builder_stringified":{"type":["string","null"],"description":"Stringified JSON data for the referral form submission"}},"required":["id","form_builder_stringified"],"description":"Referral form submission metadata","title":"AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataReferralFormSubmission"},"AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataApplicationFormSubmissionAnswersItemsAnswer":{"oneOf":[{"type":"string"},{"type":"number","format":"double"}],"description":"The answer value","title":"AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataApplicationFormSubmissionAnswersItemsAnswer"},"AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataApplicationFormSubmissionAnswersItemsQuestionType":{"type":"string","enum":["FREETEXT","PARAGRAPH","SINGLESELECTION","MULTISELECTION","DOCUMENTUPLOAD","PRESETDROPDOWN","CUSTOMDROPDOWN","NUMBER","DATEPICKER","ADDRESS","PHONENUMBER","EMAIL"],"description":"Type of the question (uppercase)","title":"AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataApplicationFormSubmissionAnswersItemsQuestionType"},"AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataApplicationFormSubmissionAnswersItems":{"type":"object","properties":{"answer":{"$ref":"#/components/schemas/AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataApplicationFormSubmissionAnswersItemsAnswer","description":"The answer value"},"question_text":{"type":"string","description":"Text of the question"},"question_type":{"$ref":"#/components/schemas/AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataApplicationFormSubmissionAnswersItemsQuestionType","description":"Type of the question (uppercase)"},"data_binding_id":{"type":"string","description":"Data binding identifier for the question"}},"required":["answer","question_text","question_type","data_binding_id"],"title":"AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataApplicationFormSubmissionAnswersItems"},"AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataApplicationFormSubmission":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Identifier of the application form submission"},"answers":{"type":"array","items":{"$ref":"#/components/schemas/AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataApplicationFormSubmissionAnswersItems"},"description":"Array of question answers with parsed data"}},"required":["id","answers"],"description":"Application form submission data with mapped answers","title":"AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataApplicationFormSubmission"},"AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataJobPostingPublicationStateStateSlug":{"type":"string","enum":["PUBLISHED_BASIC","PUBLISHED_PREMIUM","UNPUBLISHED","EXPIRED","IN_PROGRESS","FAILED"],"description":"State of the job posting publication","title":"AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataJobPostingPublicationStateStateSlug"},"AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataJobPostingPublicationState":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the job posting publication state"},"state_slug":{"$ref":"#/components/schemas/AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataJobPostingPublicationStateStateSlug","description":"State of the job posting publication"}},"required":["id","state_slug"],"description":"Current state of the job posting publication","title":"AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataJobPostingPublicationState"},"AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataApplicationJobCriteriasMatchingsItemsIsMatched":{"type":"string","enum":["MATCHED","NOT_MATCHED","UNDECIDED"],"description":"Whether the candidate matches this job criteria","title":"AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataApplicationJobCriteriasMatchingsItemsIsMatched"},"AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataApplicationJobCriteriasMatchingsItemsJobCriteria":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the job criteria"},"title":{"type":"string","description":"Title of the job criteria"},"description":{"type":"string","description":"Description of the job criteria"}},"required":["id","title","description"],"description":"Job criteria details","title":"AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataApplicationJobCriteriasMatchingsItemsJobCriteria"},"AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataApplicationJobCriteriasMatchingsItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the job criteria matching"},"is_matched":{"$ref":"#/components/schemas/AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataApplicationJobCriteriasMatchingsItemsIsMatched","description":"Whether the candidate matches this job criteria"},"description":{"type":"string","description":"Description of how the candidate matches the criteria"},"job_criteria":{"$ref":"#/components/schemas/AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataApplicationJobCriteriasMatchingsItemsJobCriteria","description":"Job criteria details"}},"required":["id","is_matched","description","job_criteria"],"title":"AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataApplicationJobCriteriasMatchingsItems"},"AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataAllApplicationInterviewPlanStagesItemsOffersItemsEmail":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the email message"},"subject":{"type":"string","description":"Email subject line"},"body_html":{"type":"string","description":"HTML body of the email"},"from_string":{"type":"string","description":"Email sender address"},"recipients_cc":{"type":"array","items":{"type":"string"},"description":"Array of CC recipient email addresses"},"recipients_to":{"type":"array","items":{"type":"string"},"description":"Array of recipient email addresses"},"recipients_bcc":{"type":"array","items":{"type":"string"},"description":"Array of BCC recipient email addresses"}},"required":["id","subject","body_html","from_string","recipients_cc","recipients_to","recipients_bcc"],"description":"Email message associated with the offer","title":"AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataAllApplicationInterviewPlanStagesItemsOffersItemsEmail"},"AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataAllApplicationInterviewPlanStagesItemsOffersItemsWorkerTypeEnum":{"type":"string","enum":["CONTRACTOR","DIRECT_EMPLOYEE","EOR_EMPLOYEE","GLOBAL_PAYROLL_EMPLOYEE","PEO_EMPLOYEE","UNKNOWN"],"description":"Type of worker for the offer","title":"AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataAllApplicationInterviewPlanStagesItemsOffersItemsWorkerTypeEnum"},"AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataAllApplicationInterviewPlanStagesItemsOffersItemsOfferStatusEnum":{"type":"string","enum":["CREATED","WAITING_FOR_APPROVAL","APPROVED","NOT_APPROVED","SENT","ACCEPTED","REJECTED"],"description":"Status of the offer","title":"AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataAllApplicationInterviewPlanStagesItemsOffersItemsOfferStatusEnum"},"AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataAllApplicationInterviewPlanStagesItemsOffersItemsCompensationPeriodSlug":{"type":"string","enum":["ANNUALLY","MONTHLY","SEMIMONTHLY","BIWEEKLY","WEEKLY","DAILY","HOURLY"],"description":"Compensation period","title":"AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataAllApplicationInterviewPlanStagesItemsOffersItemsCompensationPeriodSlug"},"AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataAllApplicationInterviewPlanStagesItemsOffersItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the offer"},"email":{"oneOf":[{"$ref":"#/components/schemas/AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataAllApplicationInterviewPlanStagesItemsOffersItemsEmail"},{"type":"null"}],"description":"Email message associated with the offer"},"job_title":{"type":"string","description":"Job title for the offer"},"created_at":{"type":"string","format":"date-time","description":"Timestamp when the offer was created"},"start_date":{"type":"string","format":"date-time","description":"Start date for the position"},"updated_at":{"type":"string","format":"date-time","description":"Timestamp when the offer was last updated"},"country_code":{"type":"string","description":"Country code (ISO 3166-1 alpha-2)"},"attachment_id":{"type":["string","null"],"format":"uuid","description":"Unique identifier for the offer attachment"},"approval_rule_id":{"type":["string","null"],"format":"uuid","description":"Unique identifier for the approval rule"},"worker_type_enum":{"$ref":"#/components/schemas/AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataAllApplicationInterviewPlanStagesItemsOffersItemsWorkerTypeEnum","description":"Type of worker for the offer"},"offer_status_enum":{"$ref":"#/components/schemas/AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataAllApplicationInterviewPlanStagesItemsOffersItemsOfferStatusEnum","description":"Status of the offer"},"approval_request_id":{"type":["string","null"],"format":"uuid","description":"Unique identifier for the approval request"},"compensation_amount":{"type":"number","format":"double","description":"Compensation amount"},"rejection_reason_id":{"type":["string","null"],"format":"uuid","description":"Unique identifier for the rejection reason (if rejected)"},"compensation_currency":{"type":"string","description":"Currency code for compensation (ISO 4217)"},"compensation_period_slug":{"oneOf":[{"$ref":"#/components/schemas/AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataAllApplicationInterviewPlanStagesItemsOffersItemsCompensationPeriodSlug"},{"type":"null"}],"description":"Compensation period"},"application_interview_plan_stage_id":{"type":"string","format":"uuid","description":"Unique identifier for the application interview plan stage"}},"required":["id","email","job_title","created_at","start_date","updated_at","country_code","attachment_id","approval_rule_id","worker_type_enum","offer_status_enum","approval_request_id","compensation_amount","rejection_reason_id","compensation_currency","compensation_period_slug","application_interview_plan_stage_id"],"title":"AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataAllApplicationInterviewPlanStagesItemsOffersItems"},"AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataAllApplicationInterviewPlanStagesItemsInterviewPlanStage":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the interview plan stage"},"name":{"type":"string","description":"Name of the interview plan stage"},"default_type_slug":{"type":["string","null"],"description":"Default type slug of the interview plan stage"},"category_type_slug":{"type":"string","description":"Interview plan stage category type"}},"required":["id","name","default_type_slug","category_type_slug"],"description":"Interview plan stage details","title":"AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataAllApplicationInterviewPlanStagesItemsInterviewPlanStage"},"AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataAllApplicationInterviewPlanStagesItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the application interview plan stage"},"offers":{"type":"array","items":{"$ref":"#/components/schemas/AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataAllApplicationInterviewPlanStagesItemsOffersItems"},"description":"Array of offers associated with this stage"},"updated_at":{"type":["string","null"],"format":"date-time","description":"Timestamp when the stage was last updated"},"interview_plan_stage":{"oneOf":[{"$ref":"#/components/schemas/AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataAllApplicationInterviewPlanStagesItemsInterviewPlanStage"},{"type":"null"}],"description":"Interview plan stage details"}},"required":["id","offers","updated_at","interview_plan_stage"],"title":"AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataAllApplicationInterviewPlanStagesItems"},"AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataApplicationAutomationRuleExecutionsItemsActionTypeEnum":{"type":"string","enum":["ADD_CANDIDATE_TAG","TRANSITION_APPLICATION"],"description":"Type of action performed by the automation rule","title":"AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataApplicationAutomationRuleExecutionsItemsActionTypeEnum"},"AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataApplicationAutomationRuleExecutionsItemsEvaluationResultItemsOperatorEnum":{"type":"string","enum":["EQUALS","NOT_EQUALS","CONTAINS","DOES_NOT_CONTAIN","IS_EMPTY","IS_NOT_EMPTY","GREATER_THAN","GREATER_THAN_OR_EQUAL","LESS_THAN","LESS_THAN_OR_EQUAL"],"description":"Comparison operator used in the evaluation","title":"AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataApplicationAutomationRuleExecutionsItemsEvaluationResultItemsOperatorEnum"},"AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataApplicationAutomationRuleExecutionsItemsEvaluationResultItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the evaluation result"},"group_id":{"type":"integer","description":"Group ID for logical grouping of conditions"},"operator_enum":{"$ref":"#/components/schemas/AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataApplicationAutomationRuleExecutionsItemsEvaluationResultItemsOperatorEnum","description":"Comparison operator used in the evaluation"},"comparison_value":{"type":"string","description":"Value used for comparison in the evaluation"},"is_condition_met":{"type":"boolean","description":"Whether the condition was met"},"form_builder_question_data_binding_id":{"type":"string","description":"Data binding ID for the form builder question"}},"required":["id","group_id","operator_enum","comparison_value","is_condition_met","form_builder_question_data_binding_id"],"title":"AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataApplicationAutomationRuleExecutionsItemsEvaluationResultItems"},"AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataApplicationAutomationRuleExecutionsItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the automation rule execution"},"action_type_enum":{"$ref":"#/components/schemas/AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataApplicationAutomationRuleExecutionsItemsActionTypeEnum","description":"Type of action performed by the automation rule"},"evaluation_result":{"type":"array","items":{"$ref":"#/components/schemas/AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataApplicationAutomationRuleExecutionsItemsEvaluationResultItems"},"description":"Array of condition evaluations for the automation rule"},"application_automation_rule_id":{"type":"string","format":"uuid","description":"Unique identifier for the application automation rule"}},"required":["id","action_type_enum","evaluation_result","application_automation_rule_id"],"title":"AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataApplicationAutomationRuleExecutionsItems"},"AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataCurrentApplicationInterviewPlanStageInterviewPlanStage":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Identifier of the interview plan stage"},"name":{"type":"string","description":"Name of the interview plan stage"},"default_type_slug":{"type":["string","null"],"description":"Default type slug of the interview plan stage"},"category_type_slug":{"type":"string","description":"Category type slug of the interview plan stage"}},"required":["id","name","default_type_slug","category_type_slug"],"description":"Details of the interview plan stage","title":"AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataCurrentApplicationInterviewPlanStageInterviewPlanStage"},"AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataCurrentApplicationInterviewPlanStage":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Identifier of the application interview plan stage record"},"interview_plan_stage":{"oneOf":[{"$ref":"#/components/schemas/AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataCurrentApplicationInterviewPlanStageInterviewPlanStage"},{"type":"null"}],"description":"Details of the interview plan stage"}},"required":["id","interview_plan_stage"],"description":"Current interview plan stage for the application","title":"AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataCurrentApplicationInterviewPlanStage"},"AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the application"},"job":{"$ref":"#/components/schemas/AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataJob","description":"Job details"},"notes":{"type":"array","items":{"$ref":"#/components/schemas/AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataNotesItems"},"description":"Array of notes associated with the application"},"candidate":{"$ref":"#/components/schemas/AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataCandidate","description":"Candidate details"},"job_board":{"oneOf":[{"$ref":"#/components/schemas/AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataJobBoard"},{"type":"null"}],"description":"Job board details where the application originated"},"created_at":{"type":"string","format":"date-time","description":"Timestamp when the application was created"},"created_by":{"type":["string","null"],"format":"uuid","description":"Unique identifier for the HRIS organization user who created the application"},"numeric_id":{"type":"integer","description":"Numeric identifier for the application"},"updated_at":{"type":"string","format":"date-time","description":"Timestamp when the application was last updated"},"job_posting":{"oneOf":[{"$ref":"#/components/schemas/AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataJobPosting"},{"type":"null"}],"description":"Job posting details"},"referred_by":{"type":["string","null"],"format":"uuid","description":"Unique identifier for the HRIS organization user who referred the candidate"},"source_slug":{"oneOf":[{"$ref":"#/components/schemas/AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataSourceSlug"},{"type":"null"}],"description":"Source of the application"},"job_employment_type":{"oneOf":[{"$ref":"#/components/schemas/AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataJobEmploymentType"},{"type":"null"}],"description":"Employment type associated with the application"},"job_posting_publication":{"oneOf":[{"$ref":"#/components/schemas/AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataJobPostingPublication"},{"type":"null"}],"description":"Job posting publication details"},"referral_form_submission":{"$ref":"#/components/schemas/AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataReferralFormSubmission","description":"Referral form submission metadata"},"moved_to_current_stage_at":{"type":"string","format":"date-time","description":"Timestamp when the application moved to the current stage"},"application_form_submission":{"oneOf":[{"$ref":"#/components/schemas/AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataApplicationFormSubmission"},{"type":"null"}],"description":"Application form submission data with mapped answers"},"job_posting_publication_state":{"oneOf":[{"$ref":"#/components/schemas/AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataJobPostingPublicationState"},{"type":"null"}],"description":"Current state of the job posting publication"},"application_job_criterias_matchings":{"type":"array","items":{"$ref":"#/components/schemas/AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataApplicationJobCriteriasMatchingsItems"},"description":"Array of job criteria matchings for the application"},"all_application_interview_plan_stages":{"type":"array","items":{"$ref":"#/components/schemas/AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataAllApplicationInterviewPlanStagesItems"},"description":"Array of all application interview plan stages"},"application_automation_rule_executions":{"type":"array","items":{"$ref":"#/components/schemas/AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataApplicationAutomationRuleExecutionsItems"},"description":"Array of automation rule executions for the application"},"current_application_interview_plan_stage":{"oneOf":[{"$ref":"#/components/schemas/AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaDataCurrentApplicationInterviewPlanStage"},{"type":"null"}],"description":"Current interview plan stage for the application"}},"required":["id","job","notes","candidate","job_board","created_at","created_by","numeric_id","updated_at","job_posting","referred_by","source_slug","job_employment_type","job_posting_publication","referral_form_submission","moved_to_current_stage_at","job_posting_publication_state","application_job_criterias_matchings","all_application_interview_plan_stages","application_automation_rule_executions","current_application_interview_plan_stage"],"title":"AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaData"},"ATS_retrieveAtsApplication-v2026-01-01_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"ATS_retrieveAtsApplication-v2026-01-01_Response_200"},"AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code"},"message":{"type":"string","description":"Human-readable explanation of the error"}},"title":"AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaErrorsItems"},"RetrieveAtsApplication-v2026-01-01RequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"RetrieveAtsApplication-v2026-01-01RequestBadRequestError"},"RetrieveAtsApplication-v2026-01-01RequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/AtsApplicationsApplicationIdGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"RetrieveAtsApplication-v2026-01-01RequestInternalServerError"},"AtsHiringMembersGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier"},"pic_url":{"type":["string","null"],"format":"uri","description":"URL to the user's profile picture"},"job_title":{"type":["string","null"],"description":"User's job title"},"last_name":{"type":"string","description":"User's last name"},"created_at":{"type":"string","format":"date-time","description":"Creation timestamp"},"first_name":{"type":"string","description":"User's first name"},"updated_at":{"type":["string","null"],"format":"date-time","description":"Last update timestamp"},"work_email":{"type":"string","format":"email","description":"User's work email address"},"hris_organization_user_id":{"type":"string","description":"Unique identifier for the HRIS organization user"}},"title":"AtsHiringMembersGetResponsesContentApplicationJsonSchemaDataItems"},"ATS_retrieveAtsHiringMembers_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/AtsHiringMembersGetResponsesContentApplicationJsonSchemaDataItems"}},"has_more":{"type":"boolean","description":"Indicates if there are more items to fetch."},"next_cursor":{"type":["string","null"],"description":"Cursor for the next page of results"},"total_count":{"type":"integer","description":"Total number of users"}},"title":"ATS_retrieveAtsHiringMembers_Response_200"},"AtsHiringMembersGetResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code"},"message":{"type":"string","description":"Human-readable explanation of the error"}},"title":"AtsHiringMembersGetResponsesContentApplicationJsonSchemaErrorsItems"},"RetrieveAtsHiringMembersRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/AtsHiringMembersGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"RetrieveAtsHiringMembersRequestBadRequestError"},"RetrieveAtsHiringMembersRequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/AtsHiringMembersGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"RetrieveAtsHiringMembersRequestInternalServerError"},"AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataJobJobTeamsItemsTeam":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the team"},"name":{"type":"string","description":"Team name"}},"required":["id","name"],"description":"Details for the team assigned to the job","title":"AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataJobJobTeamsItemsTeam"},"AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataJobJobTeamsItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the job team"},"team":{"$ref":"#/components/schemas/AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataJobJobTeamsItemsTeam","description":"Details for the team assigned to the job"}},"required":["id","team"],"title":"AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataJobJobTeamsItems"},"AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataJobCompensation":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the compensation record"},"max_amount":{"type":["number","null"],"format":"double","description":"Maximum compensation amount"},"min_amount":{"type":["number","null"],"format":"double","description":"Minimum compensation amount"},"currency_iso_code":{"type":"string","description":"Currency ISO code for the compensation"}},"required":["id","currency_iso_code"],"description":"Compensation information for the job","title":"AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataJobCompensation"},"AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataJobJobLocationsItemsLocation":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the location"},"name":{"type":"string","description":"Location name"}},"required":["id","name"],"description":"Details for the location assigned to the job","title":"AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataJobJobLocationsItemsLocation"},"AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataJobJobLocationsItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the job location"},"location":{"$ref":"#/components/schemas/AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataJobJobLocationsItemsLocation","description":"Details for the location assigned to the job"}},"required":["id","location"],"title":"AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataJobJobLocationsItems"},"AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataJobJobDepartmentsItemsDepartment":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the department"},"name":{"type":"string","description":"Department name"}},"description":"Details for the department associated with the job","title":"AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataJobJobDepartmentsItemsDepartment"},"AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataJobJobDepartmentsItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the job department"},"department":{"oneOf":[{"$ref":"#/components/schemas/AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataJobJobDepartmentsItemsDepartment"},{"type":"null"}],"description":"Details for the department associated with the job"}},"required":["id"],"title":"AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataJobJobDepartmentsItems"},"AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataJobJobEmploymentTypesItemsEmploymentType":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the employment type"},"name":{"type":"string","description":"Employment type name"}},"required":["id","name"],"description":"Details for the employment type assigned to the job","title":"AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataJobJobEmploymentTypesItemsEmploymentType"},"AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataJobJobEmploymentTypesItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the job employment type"},"employment_type":{"$ref":"#/components/schemas/AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataJobJobEmploymentTypesItemsEmploymentType","description":"Details for the employment type assigned to the job"}},"required":["id","employment_type"],"title":"AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataJobJobEmploymentTypesItems"},"AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataJob":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the job"},"job_teams":{"type":["array","null"],"items":{"$ref":"#/components/schemas/AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataJobJobTeamsItems"},"description":"Teams associated with the job"},"compensation":{"oneOf":[{"$ref":"#/components/schemas/AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataJobCompensation"},{"type":"null"}],"description":"Compensation information for the job"},"job_locations":{"type":"array","items":{"$ref":"#/components/schemas/AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataJobJobLocationsItems"},"description":"Locations associated with the job"},"job_departments":{"type":["array","null"],"items":{"$ref":"#/components/schemas/AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataJobJobDepartmentsItems"},"description":"Departments associated with the job"},"job_employment_types":{"type":"array","items":{"$ref":"#/components/schemas/AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataJobJobEmploymentTypesItems"},"description":"Employment types associated with the job"}},"required":["id","compensation","job_locations","job_employment_types"],"description":"Associated job information","title":"AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataJob"},"AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataPublicationsItemsJobBoard":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the job board"}},"required":["id"],"description":"Job board where the posting is published","title":"AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataPublicationsItemsJobBoard"},"AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataPublicationsItemsCurrentStateStateSlug":{"type":"string","enum":["PUBLISHED_BASIC","PUBLISHED_PREMIUM","UNPUBLISHED","EXPIRED","IN_PROGRESS","FAILED"],"description":"Current publication state","title":"AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataPublicationsItemsCurrentStateStateSlug"},"AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataPublicationsItemsCurrentState":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the publication state"},"created_at":{"type":"string","format":"date-time","description":"Timestamp when the publication was created"},"created_by":{"type":["string","null"],"format":"uuid","description":"User who created the publication"},"state_slug":{"$ref":"#/components/schemas/AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataPublicationsItemsCurrentStateStateSlug","description":"Current publication state"},"error_message":{"type":["string","null"],"description":"Error message if publication failed"}},"required":["id","created_at","state_slug"],"description":"Current publication state details","title":"AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataPublicationsItemsCurrentState"},"AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataPublicationsItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the job posting publication"},"job_board":{"$ref":"#/components/schemas/AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataPublicationsItemsJobBoard","description":"Job board where the posting is published"},"current_state":{"$ref":"#/components/schemas/AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataPublicationsItemsCurrentState","description":"Current publication state details"}},"required":["id","job_board","current_state"],"title":"AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataPublicationsItems"},"AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataApplicationForm":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the application form"},"title":{"type":"string","description":"Title of the application form"}},"required":["id","title"],"description":"Application form assigned to the job posting","title":"AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataApplicationForm"},"AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the job posting"},"job":{"$ref":"#/components/schemas/AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataJob","description":"Associated job information"},"title":{"type":"string","description":"Job posting title"},"created_at":{"type":"string","format":"date-time","description":"Creation timestamp"},"updated_at":{"type":"string","format":"date-time","description":"Last update timestamp"},"publications":{"type":"array","items":{"$ref":"#/components/schemas/AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataPublicationsItems"},"description":"Publication information for different job boards"},"application_form":{"oneOf":[{"$ref":"#/components/schemas/AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaDataApplicationForm"},{"type":"null"}],"description":"Application form assigned to the job posting"},"richtext_description":{"type":["string","null"],"description":"Rich text description of the job posting"},"is_compensation_visible":{"type":"boolean","description":"Indicates if compensation details are visible to candidates"}},"required":["id","job","title","created_at","updated_at","publications","richtext_description","is_compensation_visible"],"title":"AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaData"},"ATS_retrieveAtsJobPosting_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaData"}},"title":"ATS_retrieveAtsJobPosting_Response_200"},"AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaItems":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code"},"message":{"type":"string","description":"A description of the returned error"}},"title":"AtsJobPostingsJobPostingIdGetResponsesContentApplicationJsonSchemaItems"},"AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobTeamsItemsTeam":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Team identifier."},"name":{"type":"string","description":"Display name of the team."}},"description":"Team referenced by this association.","title":"AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobTeamsItemsTeam"},"AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobTeamsItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Job-team association row identifier."},"team":{"$ref":"#/components/schemas/AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobTeamsItemsTeam","description":"Team referenced by this association."}},"description":"Single job-team link with nested team details.","title":"AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobTeamsItems"},"AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobCompensation":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Compensation record identifier."},"max_amount":{"type":["number","null"],"format":"double","description":"Maximum compensation amount in the given currency, or null."},"min_amount":{"type":["number","null"],"format":"double","description":"Minimum compensation amount in the given currency, or null."},"currency_iso_code":{"type":"string","description":"ISO 4217 alphabetic currency code for the compensation amounts."}},"description":"Current compensation when visible on the posting; null when hidden or absent. Shape mirrors internal compensation mapping.","title":"AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobCompensation"},"AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobLocationsItemsLocation":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Location identifier."},"name":{"type":"string","description":"Display name of the location."}},"description":"Location entity for this association.","title":"AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobLocationsItemsLocation"},"AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobLocationsItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Job-location association row identifier."},"location":{"$ref":"#/components/schemas/AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobLocationsItemsLocation","description":"Location entity for this association."}},"description":"Single job-location link with nested location details.","title":"AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobLocationsItems"},"AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobDepartmentsItemsDepartment":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Department identifier."},"name":{"type":"string","description":"Display name of the department."}},"description":"Department for this association; null if unset.","title":"AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobDepartmentsItemsDepartment"},"AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobDepartmentsItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Job-department association row identifier."},"department":{"oneOf":[{"$ref":"#/components/schemas/AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobDepartmentsItemsDepartment"},{"type":"null"}],"description":"Department for this association; null if unset."}},"description":"Single job-department link with nested department details.","title":"AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobDepartmentsItems"},"AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobEmploymentTypesItemsEmploymentType":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Employment type identifier."},"name":{"type":"string","description":"Display name of the employment type."}},"description":"Employment type entity for this association.","title":"AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobEmploymentTypesItemsEmploymentType"},"AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobEmploymentTypesItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Job-employment-type association row identifier."},"employment_type":{"$ref":"#/components/schemas/AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobEmploymentTypesItemsEmploymentType","description":"Employment type entity for this association."}},"description":"Single job–employment-type link with nested employment type details.","title":"AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobEmploymentTypesItems"},"AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJob":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Job identifier."},"job_teams":{"type":["array","null"],"items":{"$ref":"#/components/schemas/AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobTeamsItems"},"description":"Job-to-team associations; null or omitted when not loaded or not applicable."},"compensation":{"oneOf":[{"$ref":"#/components/schemas/AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobCompensation"},{"type":"null"}],"description":"Current compensation when visible on the posting; null when hidden or absent. Shape mirrors internal compensation mapping."},"job_locations":{"type":"array","items":{"$ref":"#/components/schemas/AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobLocationsItems"},"description":"Work locations associated with the job."},"job_departments":{"type":["array","null"],"items":{"$ref":"#/components/schemas/AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobDepartmentsItems"},"description":"Job-to-department associations; null or omitted when not loaded."},"job_employment_types":{"type":"array","items":{"$ref":"#/components/schemas/AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJobJobEmploymentTypesItems"},"description":"Employment types associated with the job (e.g. full-time, contract)."}},"required":["id","compensation","job_locations","job_employment_types"],"description":"Nested job record: locations, employment types, optional teams/departments, and optional compensation when visible.","title":"AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJob"},"AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsPublicationsItemsJobBoard":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Job board identifier."}},"required":["id"],"description":"Job board this publication belongs to.","title":"AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsPublicationsItemsJobBoard"},"AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsPublicationsItemsCurrentStateStateSlug":{"type":"string","enum":["PUBLISHED_BASIC","PUBLISHED_PREMIUM","UNPUBLISHED","EXPIRED","IN_PROGRESS","FAILED"],"description":"Publication lifecycle state (uppercase slug).","title":"AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsPublicationsItemsCurrentStateStateSlug"},"AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsPublicationsItemsCurrentState":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Publication state row identifier."},"created_at":{"type":"string","format":"date-time","description":"ISO 8601 timestamp when this state was recorded."},"created_by":{"type":["string","null"],"format":"uuid","description":"HRIS organization user id who triggered or owns this state, when set."},"state_slug":{"$ref":"#/components/schemas/AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsPublicationsItemsCurrentStateStateSlug","description":"Publication lifecycle state (uppercase slug)."},"error_message":{"type":["string","null"],"description":"Error details when state is failed or otherwise errored; null if none."}},"required":["id","created_at","created_by","state_slug","error_message"],"description":"Latest known publication state for this board.","title":"AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsPublicationsItemsCurrentState"},"AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsPublicationsItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Job posting publication identifier."},"job_board":{"$ref":"#/components/schemas/AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsPublicationsItemsJobBoard","description":"Job board this publication belongs to."},"current_state":{"$ref":"#/components/schemas/AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsPublicationsItemsCurrentState","description":"Latest known publication state for this board."}},"required":["id","job_board","current_state"],"description":"Single publication of the job posting to a job board.","title":"AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsPublicationsItems"},"AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsApplicationForm":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Application form identifier."},"title":{"type":"string","description":"Human-readable application form title."}},"description":"Linked application form metadata when the posting uses an application form.","title":"AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsApplicationForm"},"AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the job posting."},"job":{"$ref":"#/components/schemas/AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsJob","description":"Nested job record: locations, employment types, optional teams/departments, and optional compensation when visible."},"title":{"type":"string","description":"Public title of the job posting."},"job_id":{"type":"string","format":"uuid","description":"Identifier of the underlying job this posting belongs to."},"created_at":{"type":"string","format":"date-time","description":"ISO 8601 timestamp when the posting was created, if present."},"updated_at":{"type":"string","format":"date-time","description":"ISO 8601 timestamp when the posting was last updated, if present."},"publications":{"type":"array","items":{"$ref":"#/components/schemas/AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsPublicationsItems"},"description":"Publication rows for this posting, one per job board integration, with current state."},"application_form":{"oneOf":[{"$ref":"#/components/schemas/AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItemsApplicationForm"},{"type":"null"}],"description":"Linked application form metadata when the posting uses an application form."},"richtext_description":{"type":["string","null"],"description":"Rich-text (HTML) job description for the posting, or null if not set."},"is_compensation_visible":{"type":"boolean","description":"Whether compensation details may be shown for this posting."}},"required":["id","job","title","job_id","publications","richtext_description","is_compensation_visible"],"title":"AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItems"},"ATS_retrieveAtsJobPostings-v2026-04-10_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/AtsJobPostingsGetResponsesContentApplicationJsonSchemaDataItems"},"description":"Job postings returned for this request (single page; pagination not yet implemented)."},"has_more":{"type":"boolean","description":"Whether additional pages exist; currently always false for this endpoint."},"next_cursor":{"type":["string","null"],"description":"Opaque cursor for the next page; currently always null until pagination is implemented."},"total_count":{"type":"integer","description":"Number of job postings included in `data` for this response."}},"required":["data","has_more","next_cursor","total_count"],"title":"ATS_retrieveAtsJobPostings-v2026-04-10_Response_200"},"AtsJobPostingsGetResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string","description":"Error code"},"field":{"type":"string","description":"Request field related to the error, if applicable"},"message":{"type":"string","description":"Human-readable error message"}},"required":["code","field","message"],"title":"AtsJobPostingsGetResponsesContentApplicationJsonSchemaErrorsItems"},"RetrieveAtsJobPostings-v2026-04-10RequestBadRequestError":{"type":"object","properties":{"path":{"type":"string","description":"Request URL path"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/AtsJobPostingsGetResponsesContentApplicationJsonSchemaErrorsItems"},"description":"List of error objects"},"timestamp":{"type":"string","format":"date-time","description":"Time when the error occurred"},"status_code":{"type":"integer","description":"HTTP status code"}},"required":["path","errors","timestamp","status_code"],"title":"RetrieveAtsJobPostings-v2026-04-10RequestBadRequestError"},"RetrieveAtsJobPostings-v2026-04-10RequestInternalServerError":{"type":"object","properties":{"path":{"type":"string","description":"Request URL path"},"timestamp":{"type":"string","format":"date-time","description":"Time when the error occurred"},"status_code":{"type":"integer","description":"HTTP status code"}},"required":["path","timestamp","status_code"],"title":"RetrieveAtsJobPostings-v2026-04-10RequestInternalServerError"},"AtsAttachmentsAttachableTypeSlugAttachableIdAttachmentTypeSlugGetParametersAttachmentTypeSlug":{"type":"string","enum":["CV","LOGO","OFFER_LETTER","OTHER"],"title":"AtsAttachmentsAttachableTypeSlugAttachableIdAttachmentTypeSlugGetParametersAttachmentTypeSlug"},"AtsAttachmentsAttachableTypeSlugAttachableIdAttachmentTypeSlugGetParametersAttachableTypeSlug":{"type":"string","enum":["CANDIDATE","CAREER_PAGE_SETTING","JOB_POSTING","NOTE","OFFER","SENT_CANDIDATE_EMAIL","EMAIL_MESSAGE","TEMPORARY","EMAIL_TEMPLATE","JOB_ACTIVITY"],"title":"AtsAttachmentsAttachableTypeSlugAttachableIdAttachmentTypeSlugGetParametersAttachableTypeSlug"},"AtsAttachmentsAttachableTypeSlugAttachableIdAttachmentTypeSlugGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the attachment"},"url":{"type":"string","format":"url","description":"URL of the attachment"},"file_name":{"type":"string","description":"Name of the file"},"ai_summary":{"type":["string","null"],"description":"AI-generated summary of the attachment"},"created_at":{"type":"string","format":"date-time","description":"Timestamp when the attachment was created"},"updated_at":{"type":"string","format":"date-time","description":"Timestamp when the attachment was last updated"},"attachable_id":{"type":"string","format":"uuid","description":"Unique identifier for the attachable entity"},"file_content_type":{"type":"string","description":"Content type of the file"},"attachable_type_slug":{"type":"string","description":"Type of the attachable entity"},"attachment_type_slug":{"type":"string","description":"Type of the attachment"},"created_by_hris_organization_user_id":{"type":["string","null"],"format":"uuid","description":"User ID who created the attachment"}},"required":["id","file_name","file_content_type","attachable_type_slug","attachment_type_slug"],"title":"AtsAttachmentsAttachableTypeSlugAttachableIdAttachmentTypeSlugGetResponsesContentApplicationJsonSchemaDataItems"},"ATS_retrievePaginatedListOfAtsAttachmentFiles-v2026-01-01_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/AtsAttachmentsAttachableTypeSlugAttachableIdAttachmentTypeSlugGetResponsesContentApplicationJsonSchemaDataItems"},"description":"Array of attachment objects"},"has_more":{"type":"boolean","description":"Indicates if there are more results available"},"next_cursor":{"type":["string","null"],"description":"Cursor for pagination to fetch next page"},"total_count":{"type":"number","format":"double","description":"Total count of attachments"}},"required":["data","has_more","next_cursor","total_count"],"title":"ATS_retrievePaginatedListOfAtsAttachmentFiles-v2026-01-01_Response_200"},"AtsAttachmentsAttachableTypeSlugAttachableIdAttachmentTypeSlugGetResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code"},"message":{"type":"string","description":"Human-readable explanation of the error"}},"title":"AtsAttachmentsAttachableTypeSlugAttachableIdAttachmentTypeSlugGetResponsesContentApplicationJsonSchemaErrorsItems"},"RetrievePaginatedListOfAtsAttachmentFiles-v2026-01-01RequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/AtsAttachmentsAttachableTypeSlugAttachableIdAttachmentTypeSlugGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"RetrievePaginatedListOfAtsAttachmentFiles-v2026-01-01RequestBadRequestError"},"RetrievePaginatedListOfAtsAttachmentFiles-v2026-01-01RequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/AtsAttachmentsAttachableTypeSlugAttachableIdAttachmentTypeSlugGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"RetrievePaginatedListOfAtsAttachmentFiles-v2026-01-01RequestInternalServerError"},"AtsCandidatesGetResponsesContentApplicationJsonSchemaDataItemsApplicationsItemsJob":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the job"},"title":{"type":"string","description":"Job title"}},"title":"AtsCandidatesGetResponsesContentApplicationJsonSchemaDataItemsApplicationsItemsJob"},"AtsCandidatesGetResponsesContentApplicationJsonSchemaDataItemsApplicationsItemsCurrentApplicationInterviewPlanStageStatus":{"type":"string","enum":["ACTIVE","COMPLETED","PENDING","REJECTED"],"description":"Status of the current application interview plan stage","title":"AtsCandidatesGetResponsesContentApplicationJsonSchemaDataItemsApplicationsItemsCurrentApplicationInterviewPlanStageStatus"},"AtsCandidatesGetResponsesContentApplicationJsonSchemaDataItemsApplicationsItemsCurrentApplicationInterviewPlanStageInterviewPlanStage":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the interview plan stage"},"name":{"type":"string","description":"Name of the interview plan stage"},"description":{"type":["string","null"],"description":"Description of the interview plan stage"},"stage_order":{"type":"number","format":"double","description":"Order of the stage in the interview plan"},"default_type_slug":{"type":["string","null"],"description":"Default type slug for the interview plan stage"},"interview_plan_id":{"type":"string","format":"uuid","description":"Unique identifier for the interview plan"},"category_type_slug":{"type":"string","description":"Category type slug for the interview plan stage"}},"title":"AtsCandidatesGetResponsesContentApplicationJsonSchemaDataItemsApplicationsItemsCurrentApplicationInterviewPlanStageInterviewPlanStage"},"AtsCandidatesGetResponsesContentApplicationJsonSchemaDataItemsApplicationsItemsCurrentApplicationInterviewPlanStage":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the current application interview plan stage"},"status":{"$ref":"#/components/schemas/AtsCandidatesGetResponsesContentApplicationJsonSchemaDataItemsApplicationsItemsCurrentApplicationInterviewPlanStageStatus","description":"Status of the current application interview plan stage"},"created_at":{"type":"string","format":"date-time","description":"Timestamp of when the current application interview plan stage was created"},"application_id":{"type":"string","format":"uuid","description":"Unique identifier for the application"},"interview_plan_stage":{"oneOf":[{"$ref":"#/components/schemas/AtsCandidatesGetResponsesContentApplicationJsonSchemaDataItemsApplicationsItemsCurrentApplicationInterviewPlanStageInterviewPlanStage"},{"type":"null"}]},"interview_plan_stage_id":{"type":"string","format":"uuid","description":"Unique identifier for the interview plan stage"}},"title":"AtsCandidatesGetResponsesContentApplicationJsonSchemaDataItemsApplicationsItemsCurrentApplicationInterviewPlanStage"},"AtsCandidatesGetResponsesContentApplicationJsonSchemaDataItemsApplicationsItems":{"type":"object","properties":{"id":{"type":["string","null"],"format":"uuid","description":"Unique identifier for the application"},"job":{"$ref":"#/components/schemas/AtsCandidatesGetResponsesContentApplicationJsonSchemaDataItemsApplicationsItemsJob"},"created_at":{"type":"string","format":"date-time","description":"Timestamp of when the application was created"},"current_application_interview_plan_stage":{"oneOf":[{"$ref":"#/components/schemas/AtsCandidatesGetResponsesContentApplicationJsonSchemaDataItemsApplicationsItemsCurrentApplicationInterviewPlanStage"},{"type":"null"}]}},"title":"AtsCandidatesGetResponsesContentApplicationJsonSchemaDataItemsApplicationsItems"},"AtsCandidatesGetResponsesContentApplicationJsonSchemaDataItemsCandidateTagsItemsTag":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the tag"},"label":{"type":"string","description":"Label for the tag"}},"title":"AtsCandidatesGetResponsesContentApplicationJsonSchemaDataItemsCandidateTagsItemsTag"},"AtsCandidatesGetResponsesContentApplicationJsonSchemaDataItemsCandidateTagsItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the candidate tag"},"tag":{"oneOf":[{"$ref":"#/components/schemas/AtsCandidatesGetResponsesContentApplicationJsonSchemaDataItemsCandidateTagsItemsTag"},{"type":"null"}]},"tag_id":{"type":"string","format":"uuid","description":"Unique identifier for the tag"},"candidate_id":{"type":"string","format":"uuid","description":"Unique identifier for the candidate"}},"title":"AtsCandidatesGetResponsesContentApplicationJsonSchemaDataItemsCandidateTagsItems"},"AtsCandidatesGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the candidate"},"email":{"type":"string","format":"email","description":"Candidate's email address"},"pic_url":{"type":["string","null"],"description":"URL of the candidate's profile picture"},"last_name":{"type":"string","description":"Candidate's last name"},"created_at":{"type":"string","format":"date-time","description":"Timestamp when the candidate was created"},"first_name":{"type":"string","description":"Candidate's first name"},"numeric_id":{"type":"number","format":"double","description":"Numeric identifier for the candidate"},"updated_at":{"type":"string","format":"date-time","description":"Timestamp when the candidate was last updated"},"applications":{"type":"array","items":{"$ref":"#/components/schemas/AtsCandidatesGetResponsesContentApplicationJsonSchemaDataItemsApplicationsItems"}},"phone_number":{"type":["string","null"],"description":"Candidate's phone number"},"candidate_tags":{"type":["array","null"],"items":{"$ref":"#/components/schemas/AtsCandidatesGetResponsesContentApplicationJsonSchemaDataItemsCandidateTagsItems"},"description":"Tags associated with the candidate"},"final_archivation_at":{"type":["string","null"],"format":"date-time","description":"Timestamp of when the candidate was finally archived"},"linkedin_profile_url":{"type":["string","null"],"description":"URL of the candidate's LinkedIn profile"},"total_applications_count":{"type":"number","format":"double","description":"Total number of applications the candidate has"}},"title":"AtsCandidatesGetResponsesContentApplicationJsonSchemaDataItems"},"ATS_retrievePaginatedListOfAtsCandidates-v2026-01-01_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/AtsCandidatesGetResponsesContentApplicationJsonSchemaDataItems"}},"has_more":{"type":"boolean","description":"Indicates if there are more items to fetch."},"next_cursor":{"type":["string","null"],"description":"Cursor for the next page of results"},"total_count":{"type":"integer","description":"Total number of candidates"}},"title":"ATS_retrievePaginatedListOfAtsCandidates-v2026-01-01_Response_200"},"RetrievePaginatedListOfAtsCandidates-v2026-01-01RequestBadRequestError":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code"},"message":{"type":"string","description":"A description of the returned error"}},"title":"RetrievePaginatedListOfAtsCandidates-v2026-01-01RequestBadRequestError"},"AtsCandidatesGetResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code"},"message":{"type":"string","description":"Human-readable explanation of the error"}},"title":"AtsCandidatesGetResponsesContentApplicationJsonSchemaErrorsItems"},"RetrievePaginatedListOfAtsCandidates-v2026-01-01RequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/AtsCandidatesGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"RetrievePaginatedListOfAtsCandidates-v2026-01-01RequestInternalServerError"},"AtsReasonsGetParametersReasonGroupSlug":{"type":"string","enum":["CANDIDATE_ARCHIVATION","OFFER_REJECTION","JOB_CLOSURE"],"title":"AtsReasonsGetParametersReasonGroupSlug"},"AtsReasonsGetParametersSubgroupSlug":{"type":"string","enum":["INTEREST","LOCATION","COMPENSATION","RESPONSIVENESS","QUALIFICATION","FIT","EXPERIENCE","STATUS","ROLE_CHANGE","BENEFITS","COUNTER_OFFER","REMOTE_WORK","PERSONAL","TIMING","BUDGET","BUSINESS_NEEDS","EXTERNAL_CANDIDATE","INTERNAL_TRANSFER","HIRING_FREEZE"],"title":"AtsReasonsGetParametersSubgroupSlug"},"AtsReasonsGetResponsesContentApplicationJsonSchemaDataItemsSubgroupSlug":{"type":"string","enum":["INTEREST","LOCATION","COMPENSATION","RESPONSIVENESS","QUALIFICATION","FIT","EXPERIENCE","STATUS","ROLE_CHANGE","BENEFITS","COUNTER_OFFER","REMOTE_WORK","PERSONAL","TIMING","BUDGET","BUSINESS_NEEDS","EXTERNAL_CANDIDATE","INTERNAL_TRANSFER","HIRING_FREEZE"],"description":"Reason subgroup slug","title":"AtsReasonsGetResponsesContentApplicationJsonSchemaDataItemsSubgroupSlug"},"AtsReasonsGetResponsesContentApplicationJsonSchemaDataItemsEmailTemplate":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Email template ID"},"title":{"type":"string","description":"Email template title"}},"required":["id","title"],"description":"Associated email template","title":"AtsReasonsGetResponsesContentApplicationJsonSchemaDataItemsEmailTemplate"},"AtsReasonsGetResponsesContentApplicationJsonSchemaDataItemsReasonGroupSlug":{"type":"string","enum":["CANDIDATE_ARCHIVATION","OFFER_REJECTION","JOB_CLOSURE"],"description":"Reason group slug","title":"AtsReasonsGetResponsesContentApplicationJsonSchemaDataItemsReasonGroupSlug"},"AtsReasonsGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the reason"},"label":{"type":"string","description":"Label of the reason"},"created_at":{"type":"string","format":"date-time","description":"Timestamp when the reason was created"},"jobs_count":{"type":["number","null"],"format":"double","description":"Number of jobs associated with this reason"},"updated_at":{"type":"string","format":"date-time","description":"Timestamp when the reason was last updated"},"subgroup_slug":{"oneOf":[{"$ref":"#/components/schemas/AtsReasonsGetResponsesContentApplicationJsonSchemaDataItemsSubgroupSlug"},{"type":"null"}],"description":"Reason subgroup slug"},"email_template":{"oneOf":[{"$ref":"#/components/schemas/AtsReasonsGetResponsesContentApplicationJsonSchemaDataItemsEmailTemplate"},{"type":"null"}],"description":"Associated email template"},"candidates_count":{"type":["number","null"],"format":"double","description":"Number of candidates associated with this reason"},"reason_group_slug":{"$ref":"#/components/schemas/AtsReasonsGetResponsesContentApplicationJsonSchemaDataItemsReasonGroupSlug","description":"Reason group slug"}},"required":["id","label","created_at","reason_group_slug"],"title":"AtsReasonsGetResponsesContentApplicationJsonSchemaDataItems"},"ATS_retrievePaginatedListOfAtsRejectionArchivationReasons-v2026-01-01_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/AtsReasonsGetResponsesContentApplicationJsonSchemaDataItems"},"description":"Array of reason objects"},"has_more":{"type":"boolean","description":"Indicates if there are more results available"},"next_cursor":{"type":["string","null"],"description":"Cursor for pagination to fetch next page"},"total_count":{"type":"number","format":"double","description":"Total count of reasons"}},"required":["data","has_more","next_cursor","total_count"],"title":"ATS_retrievePaginatedListOfAtsRejectionArchivationReasons-v2026-01-01_Response_200"},"AtsReasonsGetResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code"},"message":{"type":"string","description":"Human-readable explanation of the error"}},"title":"AtsReasonsGetResponsesContentApplicationJsonSchemaErrorsItems"},"RetrievePaginatedListOfAtsRejectionArchivationReasons-v2026-01-01RequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/AtsReasonsGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"RetrievePaginatedListOfAtsRejectionArchivationReasons-v2026-01-01RequestBadRequestError"},"RetrievePaginatedListOfAtsRejectionArchivationReasons-v2026-01-01RequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/AtsReasonsGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"RetrievePaginatedListOfAtsRejectionArchivationReasons-v2026-01-01RequestInternalServerError"},"CandidatesPostRequestBodyContentApplicationJsonSchemaDataStatus":{"type":"string","enum":["offer-accepted","offer-sent","offer-declined","offer-deleted"],"description":"Offer status","title":"CandidatesPostRequestBodyContentApplicationJsonSchemaDataStatus"},"CandidatesPostRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of candidate in your ATS."},"link":{"type":"string","description":"Link to candidate's profile in ATS."},"email":{"type":"string","format":"email","description":"Worker's work email address."},"state":{"type":"string","description":"Job location state."},"status":{"$ref":"#/components/schemas/CandidatesPostRequestBodyContentApplicationJsonSchemaDataStatus","description":"Offer status"},"country":{"type":"string","description":"Country code."},"job_title":{"type":"string","description":"Job Title."},"last_name":{"type":"string","description":"Candidate's last name."},"first_name":{"type":"string","description":"Candidate's first name."},"start_date":{"type":"string","format":"date","description":"Short date in format ISO-8601 (YYYY-MM-DD)."},"nationality":{"type":"string","description":"Nationality of the worker."},"personal_email":{"type":"string","format":"email","description":"Worker's personal email address."}},"required":["id","link","status","last_name","first_name","start_date"],"description":"Details of candidate to create","title":"CandidatesPostRequestBodyContentApplicationJsonSchemaData"},"CandidatesPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"created":{"type":"boolean","description":"Indicates if the candidate was created successfully."}},"required":["created"],"title":"CandidatesPostResponsesContentApplicationJsonSchemaData"},"Candidates_addCandidate_Response_201":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CandidatesPostResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"Candidates_addCandidate_Response_201"},"ConsentTokenPostRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"user_id":{"type":"string","description":"User ID"},"profile_id":{"type":"string","description":"Profile ID"},"contract_id":{"type":"string","description":"Contract ID"}},"required":["user_id","profile_id","contract_id"],"title":"ConsentTokenPostRequestBodyContentApplicationJsonSchemaData"},"ConsentTokenPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"created_at":{"type":"string","format":"date-time","description":"Token creation timestamp"},"expires_at":{"type":"string","format":"date-time","description":"Token expiration timestamp"},"updated_at":{"type":"string","format":"date-time","description":"Token last update timestamp"},"unique_consent_token":{"type":"string","description":"JWT token for consent"}},"required":["created_at","expires_at","updated_at","unique_consent_token"],"title":"ConsentTokenPostResponsesContentApplicationJsonSchemaData"},"Consent_createConsentToken_Response_201":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ConsentTokenPostResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"Consent_createConsentToken_Response_201"},"CreateConsentTokenRequestBadRequestError":{"type":"object","properties":{"error":{"type":"string"}},"title":"CreateConsentTokenRequestBadRequestError"},"CreateConsentTokenRequestInternalServerError":{"type":"object","properties":{"error":{"type":"string"}},"title":"CreateConsentTokenRequestInternalServerError"},"ContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataScale":{"type":"string","enum":["hourly","daily","weekly","monthly","biweekly","semimonthly","custom"],"description":"Defines the scale at which the amount is paid. For example, enter 'hourly' to define the amount per hour. This field can be excluded when creating a Pay-as-you-go task-based or Milestone contracts.","title":"ContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataScale"},"ContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataFrequency":{"type":"string","enum":["weekly","monthly","biweekly","semimonthly","calendar-month"],"description":"Scale of the invoice cycle.","title":"ContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataFrequency"},"ContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataJobTitleId":{"oneOf":[{"type":"string"},{"type":"integer","format":"int64"}],"title":"ContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataJobTitleId"},"ContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataSeniorityId":{"oneOf":[{"type":"string"},{"type":"integer","format":"int64"}],"title":"ContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataSeniorityId"},"ContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataCycleEndType":{"type":"string","enum":["DAY_OF_WEEK","DAY_OF_LAST_WEEK","DAY_OF_MONTH"],"description":"Cycle end can be weekly 1-7 (Monday = 1) or monthly 1-31.","title":"ContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataCycleEndType"},"ContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataPaymentDueType":{"type":"string","enum":["REGULAR","WITHIN_MONTH"],"default":"REGULAR","description":"Type of payment due. If the payment is due on the last day of month, enter 'WITHIN_MONTH'.","title":"ContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataPaymentDueType"},"ContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"scale":{"$ref":"#/components/schemas/ContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataScale","description":"Defines the scale at which the amount is paid. For example, enter 'hourly' to define the amount per hour. This field can be excluded when creating a Pay-as-you-go task-based or Milestone contracts."},"amount":{"type":"number","format":"double","description":"Amount to be paid per scale."},"cycle_end":{"type":"number","format":"double","description":"Day of the month when the cycle ends."},"frequency":{"$ref":"#/components/schemas/ContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataFrequency","description":"Scale of the invoice cycle."},"start_date":{"type":"string","format":"date","description":"The contract start date in ISO-8601 format (YYYY-MM-DD). Updates the contract's effective date."},"job_title_id":{"$ref":"#/components/schemas/ContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataJobTitleId"},"seniority_id":{"$ref":"#/components/schemas/ContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataSeniorityId"},"currency_code":{"type":"string","description":"Currency code in ISO 4217 format."},"first_payment":{"type":"number","format":"double","description":"Amount to be paid as the first payment."},"scope_of_work":{"type":"string","description":"Text to describe the scope of work of the contract."},"cycle_end_type":{"$ref":"#/components/schemas/ContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataCycleEndType","description":"Cycle end can be weekly 1-7 (Monday = 1) or monthly 1-31."},"effective_date":{"type":"string","format":"date","description":"Short date in format ISO-8601 (YYYY-MM-DD). For example: 2022-12-31."},"job_title_name":{"type":"string","description":"You can enter new job title."},"special_clause":{"type":"string","description":"Text to describe any special clause in contract."},"payment_due_days":{"type":"number","format":"double","description":"Number of days after the invoice is sent that the payment is due."},"payment_due_type":{"$ref":"#/components/schemas/ContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataPaymentDueType","description":"Type of payment due. If the payment is due on the last day of month, enter 'WITHIN_MONTH'."},"first_payment_date":{"type":"string","format":"date","description":"Short date in format ISO-8601 (YYYY-MM-DD). For example: 2022-12-31."},"pay_before_weekends":{"type":"boolean","description":"If the payment due is on a weekend, pay on Friday."}},"description":"You can specify any combination of data points that need changing.","title":"ContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaData"},"ContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataScale":{"type":"string","enum":["hourly","daily","weekly","monthly","biweekly","semimonthly","custom"],"description":"Payment scale for the amended work statement.","title":"ContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataScale"},"ContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataStatus":{"type":"string","enum":["initial","pending","active","outdated","approved","declined"],"description":"Status of the amended work statement.","title":"ContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataStatus"},"ContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the created amendment."},"rate":{"type":["number","null"],"format":"double","description":"Rate/amount for the amended work statement."},"scale":{"oneOf":[{"$ref":"#/components/schemas/ContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataScale"},{"type":"null"}],"description":"Payment scale for the amended work statement."},"status":{"$ref":"#/components/schemas/ContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataStatus","description":"Status of the amended work statement."},"created":{"type":"boolean","description":"Contract has been successfully amended."},"job_title":{"type":["string","null"],"description":"Job title for the amended work statement."},"worker_id":{"type":"string","format":"uuid","description":"The unique identifier of the worker."},"created_at":{"type":"string","format":"date-time","description":"Timestamp when the work statement was created."},"updated_at":{"type":"string","format":"date-time","description":"Timestamp when the work statement was last updated."},"currency_code":{"type":"string","description":"Currency code for the amended work statement."},"scope_of_work":{"type":["string","null"],"description":"Scope of work for the amended work statement."},"special_clause":{"type":["string","null"],"description":"Special clause for the amended work statement."},"termination_notice_days":{"type":"integer","description":"Number of days notice required for termination. Defaults to 10 if not provided."}},"required":["id","status","created","worker_id","created_at","updated_at"],"title":"ContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaData"},"contractor-amendments_createContractAmendment_Response_201":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"contractor-amendments_createContractAmendment_Response_201"},"ContractsContractIdAmendmentsGetParametersStatusesSchemaItems":{"type":"string","enum":["INITIAL","PENDING","ACTIVE","OUTDATED","APPROVED","DECLINED"],"title":"ContractsContractIdAmendmentsGetParametersStatusesSchemaItems"},"ContractsContractIdAmendmentsGetParametersSignStatusesSchemaItems":{"type":"string","enum":["PENDING","WAITING_FOR_APPROVAL","APPROVED","DECLINED"],"title":"ContractsContractIdAmendmentsGetParametersSignStatusesSchemaItems"},"ContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsScale":{"type":"string","enum":["hourly","daily","weekly","monthly","biweekly","semimonthly","custom"],"description":"Payment frequency/scale that defines how often the rate is paid.","title":"ContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsScale"},"ContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsStatus":{"type":"string","enum":["INITIAL","PENDING","ACTIVE","OUTDATED","APPROVED","DECLINED"],"description":"Current status of the work statement.","title":"ContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsStatus"},"ContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsSignStatus":{"type":"string","enum":["PENDING","WAITING_FOR_APPROVAL","APPROVED","DECLINED"],"description":"Current sign status of the work statement.","title":"ContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsSignStatus"},"ContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsContractType":{"type":"string","enum":["milestones","time_based","ongoing_time_based","pay_as_you_go_time_based","commission","payg_milestones","payg_tasks"],"description":"Type of the associated IC contract.","title":"ContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsContractType"},"ContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the work statement."},"rate":{"type":["number","null"],"format":"double","description":"Compensation rate per scale. The amount paid according to the specified scale (e.g., 5000 per month)."},"scale":{"oneOf":[{"$ref":"#/components/schemas/ContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsScale"},{"type":"null"}],"description":"Payment frequency/scale that defines how often the rate is paid."},"status":{"$ref":"#/components/schemas/ContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsStatus","description":"Current status of the work statement."},"created_at":{"type":"string","format":"date-time","description":"Timestamp when the work statement was created."},"updated_at":{"type":"string","format":"date-time","description":"Timestamp when the work statement was last updated."},"sign_status":{"$ref":"#/components/schemas/ContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsSignStatus","description":"Current sign status of the work statement."},"contract_name":{"type":["string","null"],"description":"Name of the associated contract."},"contract_type":{"oneOf":[{"$ref":"#/components/schemas/ContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsContractType"},{"type":"null"}],"description":"Type of the associated IC contract."},"currency_code":{"type":["string","null"],"description":"Currency code in ISO 4217 format (e.g., USD, EUR, GBP)."},"effective_date":{"type":["string","null"],"format":"date-time","description":"Effective date when the work statement becomes active."}},"required":["id","status","created_at","updated_at","sign_status"],"title":"ContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItems"},"contractor-amendments_getContractAmendments_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItems"},"description":"List of work statements (amendments)."},"cursor":{"type":["string","null"],"description":"Cursor for the next page of results."},"has_more":{"type":"boolean","description":"Indicates if there are more work statements available."},"total_count":{"type":"integer","description":"Total number of work statements matching the filters."}},"required":["data","cursor","has_more","total_count"],"title":"contractor-amendments_getContractAmendments_Response_200"},"ContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code"},"message":{"type":"string","description":"Human-readable explanation of the error"}},"title":"ContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaErrorsItems"},"ListContractAmendments-v2026-01-01RequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"ListContractAmendments-v2026-01-01RequestBadRequestError"},"ListContractAmendments-v2026-01-01RequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"ListContractAmendments-v2026-01-01RequestInternalServerError"},"ContractsContractIdDocumentsPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"key":{"type":"string","description":"You can call attachments end-point, get key and URL to upload your file."},"filename":{"type":"string","description":"Original filename you used to upload using attachments end-point."}},"required":["key","filename"],"description":"This object is used for linking file attachments to your records.","title":"ContractsContractIdDocumentsPostResponsesContentApplicationJsonSchemaData"},"contractor-hiring_createContractDocument_Response_201":{"type":"object","properties":{"data":{"oneOf":[{"$ref":"#/components/schemas/ContractsContractIdDocumentsPostResponsesContentApplicationJsonSchemaData"},{"type":"null"}],"description":"This object is used for linking file attachments to your records."}},"required":["data"],"title":"contractor-hiring_createContractDocument_Response_201"},"contractor-hiring_getContractInvite_Response_200":{"type":"object","properties":{"data":{"type":"string"}},"required":["data"],"title":"contractor-hiring_getContractInvite_Response_200"},"ContractsContractIdInvitationsDeleteResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"deleted":{"type":"boolean","description":"Confirms the deletion."}},"required":["deleted"],"title":"ContractsContractIdInvitationsDeleteResponsesContentApplicationJsonSchemaData"},"contractor-hiring_getContractInvitations_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ContractsContractIdInvitationsDeleteResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"contractor-hiring_getContractInvitations_Response_200"},"ContractsContractIdPaymentCyclesGetResponsesContentApplicationJsonSchemaDataItemsStatus":{"type":"string","enum":["active","upcoming","awaiting_payment","overdue"],"description":"The current status of the payment cycle.","title":"ContractsContractIdPaymentCyclesGetResponsesContentApplicationJsonSchemaDataItemsStatus"},"ContractsContractIdPaymentCyclesGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the payment."},"status":{"$ref":"#/components/schemas/ContractsContractIdPaymentCyclesGetResponsesContentApplicationJsonSchemaDataItemsStatus","description":"The current status of the payment cycle."},"due_date":{"type":"string","format":"date-time","description":"The date and time when the payment is due."}},"required":["id","status","due_date"],"title":"ContractsContractIdPaymentCyclesGetResponsesContentApplicationJsonSchemaDataItems"},"contractor-hiring_getContractPaymentCycles_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ContractsContractIdPaymentCyclesGetResponsesContentApplicationJsonSchemaDataItems"}}},"required":["data"],"title":"contractor-hiring_getContractPaymentCycles_Response_200"},"ContractsContractIdInvitationsPostRequestBodyContentApplicationJsonSchemaDataLocale":{"type":"string","enum":["en","es","fr","de","it","pt","pl","nn","nl","da","deAT","fi","sv","nlBE","ja"],"default":"en","description":"Locale of the email","title":"ContractsContractIdInvitationsPostRequestBodyContentApplicationJsonSchemaDataLocale"},"ContractsContractIdInvitationsPostRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"email":{"type":"string","format":"email","description":"Worker email"},"locale":{"$ref":"#/components/schemas/ContractsContractIdInvitationsPostRequestBodyContentApplicationJsonSchemaDataLocale","description":"Locale of the email"},"message":{"type":"string","description":"Message to the worker"}},"title":"ContractsContractIdInvitationsPostRequestBodyContentApplicationJsonSchemaData"},"ContractsContractIdInvitationsPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"created":{"type":"boolean"}},"required":["created"],"title":"ContractsContractIdInvitationsPostResponsesContentApplicationJsonSchemaData"},"contractor-hiring_createContractInvitation_Response_201":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ContractsContractIdInvitationsPostResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"contractor-hiring_createContractInvitation_Response_201"},"ContractsContractIdSignaturesPostRequestBodyContentApplicationJsonSchemaDataContractTemplateId":{"oneOf":[{"type":"number","format":"double"},{"type":"string"}],"description":"Please use null to use default Deel contract template; otherwise you can use the template you created and customized. If template ID is not in payload, template stays unchanged.","title":"ContractsContractIdSignaturesPostRequestBodyContentApplicationJsonSchemaDataContractTemplateId"},"ContractsContractIdSignaturesPostRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"client_signature":{"type":"string","description":"Signature of client."},"contract_template_id":{"$ref":"#/components/schemas/ContractsContractIdSignaturesPostRequestBodyContentApplicationJsonSchemaDataContractTemplateId","description":"Please use null to use default Deel contract template; otherwise you can use the template you created and customized. If template ID is not in payload, template stays unchanged."}},"required":["client_signature"],"title":"ContractsContractIdSignaturesPostRequestBodyContentApplicationJsonSchemaData"},"ContractsContractIdSignaturesPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"created":{"type":"boolean"}},"required":["created"],"title":"ContractsContractIdSignaturesPostResponsesContentApplicationJsonSchemaData"},"contractor-hiring_createContractSignature_Response_201":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ContractsContractIdSignaturesPostResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"contractor-hiring_createContractSignature_Response_201"},"ContractsContractIdPatchRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"external_id":{"type":["string","null"],"description":"A unique identifier for the object provided by an external system. Use or send null when you want to reset the external id."}},"required":["external_id"],"title":"ContractsContractIdPatchRequestBodyContentApplicationJsonSchemaData"},"ContractsContractIdPatchResponsesContentApplicationJsonSchemaType":{"type":"string","enum":["ongoing_time_based","milestones","time_based","pay_as_you_go_time_based","commission","payg_milestones","payg_tasks","contractor_outside_deel","eor","unknown","employee","global_payroll","shield_msa","hris_direct_employee","peo"],"description":"Type of a contract.","title":"ContractsContractIdPatchResponsesContentApplicationJsonSchemaType"},"ContractsContractIdPatchResponsesContentApplicationJsonSchemaQuoteBenefitsItems":{"type":"object","properties":{"fee":{"type":"number","format":"double","description":"Fee in local currency."},"name":{"type":"string","description":"Benefit's name."},"plan":{"type":"string","description":"Benefit's plan."},"price":{"type":"number","format":"double","description":"Price in local currency."},"fee_usd":{"type":"number","format":"double","description":"Fee in USD."},"currency":{"type":"string","description":"Currency code."},"price_usd":{"type":"number","format":"double","description":"Price in USD."}},"title":"ContractsContractIdPatchResponsesContentApplicationJsonSchemaQuoteBenefitsItems"},"ContractsContractIdPatchResponsesContentApplicationJsonSchemaQuote":{"type":"object","properties":{"benefits":{"type":"array","items":{"$ref":"#/components/schemas/ContractsContractIdPatchResponsesContentApplicationJsonSchemaQuoteBenefitsItems"},"description":"Array of benefits."},"currency":{"type":"string","description":"Currency used for the quote."}},"description":"EOR quote approved by Deel.","title":"ContractsContractIdPatchResponsesContentApplicationJsonSchemaQuote"},"ContractsContractIdPatchResponsesContentApplicationJsonSchemaClientTeamId":{"oneOf":[{"type":"string"},{"type":"number","format":"double"}],"description":"Unique identifier of this resource.","title":"ContractsContractIdPatchResponsesContentApplicationJsonSchemaClientTeamId"},"ContractsContractIdPatchResponsesContentApplicationJsonSchemaClientTeam":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ContractsContractIdPatchResponsesContentApplicationJsonSchemaClientTeamId","description":"Unique identifier of this resource."},"name":{"type":"string","description":"Name of a team."}},"required":["id","name"],"description":"Team information for the client organization.","title":"ContractsContractIdPatchResponsesContentApplicationJsonSchemaClientTeam"},"ContractsContractIdPatchResponsesContentApplicationJsonSchemaClientLegalEntity":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of this resource."},"name":{"type":"string","description":"Name of a team."},"type":{"type":["string","null"],"description":"Type of the legal entity."},"email":{"type":["string","null"],"description":"Email address of the legal entity."},"subtype":{"type":["string","null"],"description":"Sub-type of the legal entity."},"vat_number":{"type":["string","null"],"description":"VAT number of the legal entity."},"registration_number":{"type":["string","null"],"description":"Registration number of the legal entity."}},"description":"Legal entity details of the client.","title":"ContractsContractIdPatchResponsesContentApplicationJsonSchemaClientLegalEntity"},"ContractsContractIdPatchResponsesContentApplicationJsonSchemaClient":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of this resource."},"team":{"$ref":"#/components/schemas/ContractsContractIdPatchResponsesContentApplicationJsonSchemaClientTeam","description":"Team information for the client organization."},"email":{"type":["string","null"],"description":"User's email address. It can be an empty string when no email has been provided for the worker. This can happen for draft contracts or workers with incomplete onboarding."},"full_name":{"type":"string","description":"Full name of the client."},"legal_entity":{"oneOf":[{"$ref":"#/components/schemas/ContractsContractIdPatchResponsesContentApplicationJsonSchemaClientLegalEntity"},{"type":"null"}],"description":"Legal entity details of the client."}},"required":["team"],"description":"Client details associated with the contract.","title":"ContractsContractIdPatchResponsesContentApplicationJsonSchemaClient"},"ContractsContractIdPatchResponsesContentApplicationJsonSchemaStatus":{"type":"string","enum":["new","under_review","waiting_for_employee_contract","waiting_for_client_sign","processing_payment","waiting_for_contractor_sign","waiting_for_eor_sign","waiting_for_employee_sign","awaiting_deposit_payment","in_progress","completed","cancelled","user_cancelled","rejected","waiting_for_client_payment","onboarding","waiting_for_approval","onboarded"],"description":"Status of a contract in Deel workflow.","title":"ContractsContractIdPatchResponsesContentApplicationJsonSchemaStatus"},"ContractsContractIdPatchResponsesContentApplicationJsonSchemaWorkerDateOfBirth2":{"type":"string","enum":[""],"description":"Empty string for unknown/unset values.","title":"ContractsContractIdPatchResponsesContentApplicationJsonSchemaWorkerDateOfBirth2"},"ContractsContractIdPatchResponsesContentApplicationJsonSchemaWorkerDateOfBirth":{"oneOf":[{"type":"string","format":"date-time"},{"type":"string","format":"date"},{"$ref":"#/components/schemas/ContractsContractIdPatchResponsesContentApplicationJsonSchemaWorkerDateOfBirth2"}],"description":"Date of birth of the worker. Supports full date-time, date-only, or an empty string.","title":"ContractsContractIdPatchResponsesContentApplicationJsonSchemaWorkerDateOfBirth"},"ContractsContractIdPatchResponsesContentApplicationJsonSchemaWorkerAlternateEmailItems":{"type":"object","properties":{"email":{"type":"string","description":"Email address of the worker."},"isVerified":{"type":"boolean","description":"Indicates whether this alternate email address has been verified."}},"title":"ContractsContractIdPatchResponsesContentApplicationJsonSchemaWorkerAlternateEmailItems"},"ContractsContractIdPatchResponsesContentApplicationJsonSchemaWorker":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of this resource."},"email":{"type":["string","null"],"format":"email","description":"User's email address."},"country":{"type":["string","null"],"description":"Country of the worker."},"full_name":{"type":"string","description":"Full name of the client."},"last_name":{"type":"string","description":"Last name of the worker."},"first_name":{"type":"string","description":"First name of the worker."},"nationality":{"type":["string","null"],"description":"Nationality of the worker."},"date_of_birth":{"$ref":"#/components/schemas/ContractsContractIdPatchResponsesContentApplicationJsonSchemaWorkerDateOfBirth","description":"Date of birth of the worker. Supports full date-time, date-only, or an empty string."},"expected_email":{"type":"string","description":"Expected email address of the worker (e.g., invitation target email)."},"alternate_email":{"type":["array","null"],"items":{"$ref":"#/components/schemas/ContractsContractIdPatchResponsesContentApplicationJsonSchemaWorkerAlternateEmailItems"},"description":"List of alternate email addresses."}},"description":"Worker details associated with the contract.","title":"ContractsContractIdPatchResponsesContentApplicationJsonSchemaWorker"},"ContractsContractIdPatchResponsesContentApplicationJsonSchemaSeniority":{"type":"object","properties":{"id":{"type":["number","null"],"format":"double","description":"Unique identifier of this resource."},"name":{"type":["string","null"],"description":"Name of seniority level e.g. Mid (Individual Contributor Level 2)."},"level":{"type":["number","null"],"format":"double","description":"Level of seniority level e.g. 2."}},"description":"Seniority describes level of expertise at a job e.g. junior.","title":"ContractsContractIdPatchResponsesContentApplicationJsonSchemaSeniority"},"ContractsContractIdPatchResponsesContentApplicationJsonSchemaSignatures":{"type":"object","properties":{"signed_at":{"type":["string","null"],"format":"date-time","description":"Date and time when the contract was signed."},"client_signature":{"type":"string","description":"Client representative signature (typically a name)."},"client_signed_at":{"type":["string","null"],"format":"date-time","description":"Date and time when the client signed the contract."},"worker_signature":{"type":"string","description":"Worker signature (typically a name)."},"worker_signed_at":{"type":["string","null"],"format":"date-time","description":"Date and time when the worker signed the contract."}},"description":"Signature information for the contract parties.","title":"ContractsContractIdPatchResponsesContentApplicationJsonSchemaSignatures"},"ContractsContractIdPatchResponsesContentApplicationJsonSchemaInvitations":{"type":"object","properties":{"client_email":{"type":["string","null"],"description":"User's email address."},"worker_email":{"type":["string","null"],"description":"User's email address."}},"description":"Invitation email addresses for signing the contract.","title":"ContractsContractIdPatchResponsesContentApplicationJsonSchemaInvitations"},"ContractsContractIdPatchResponsesContentApplicationJsonSchemaCostCentersItems":{"type":"object","properties":{"name":{"type":"string","description":"Cost center name."},"number":{"type":"string","description":"Cost center number."},"allocation_percentage":{"type":"number","format":"double","description":"Percentage of the cost center allocation."}},"title":"ContractsContractIdPatchResponsesContentApplicationJsonSchemaCostCentersItems"},"ContractsContractIdPatchResponsesContentApplicationJsonSchemaCustomFieldsItems":{"type":"object","properties":{"name":{"type":"string","description":"Custom field property name."},"value":{"type":"string","description":"Custom field property value."}},"description":"Customized attributes on contracts (Employee ID, Project code, etc).","title":"ContractsContractIdPatchResponsesContentApplicationJsonSchemaCustomFieldsItems"},"ContractsContractIdPatchResponsesContentApplicationJsonSchemaWorkScheduleDaysItemsDay":{"type":"string","enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"],"description":"Day of the week","title":"ContractsContractIdPatchResponsesContentApplicationJsonSchemaWorkScheduleDaysItemsDay"},"ContractsContractIdPatchResponsesContentApplicationJsonSchemaWorkScheduleDaysItems":{"type":"object","properties":{"day":{"$ref":"#/components/schemas/ContractsContractIdPatchResponsesContentApplicationJsonSchemaWorkScheduleDaysItemsDay","description":"Day of the week"},"end":{"type":["string","null"],"format":"time","description":"End time for the work day (HH:MM:SS format)"},"start":{"type":"string","format":"time","description":"Start time for the work day (HH:MM:SS format)"},"work_hours":{"type":"number","format":"double","description":"Number of working hours for this day"}},"required":["day","end","start","work_hours"],"description":"Defines working hours for a specific day of the week","title":"ContractsContractIdPatchResponsesContentApplicationJsonSchemaWorkScheduleDaysItems"},"ContractsContractIdPatchResponsesContentApplicationJsonSchemaWorkScheduleWorkerTypesItems":{"type":"string","enum":["SALARIED_DIRECT_EMPLOYEE_PAYROLL","SALARIED_HRIS_DIRECT_EMPLOYEE","SALARIED_EOR_EMPLOYEE","HOURLY_EOR_EMPLOYEE","HOURLY_DIRECT_EMPLOYEE_PAYROLL"],"title":"ContractsContractIdPatchResponsesContentApplicationJsonSchemaWorkScheduleWorkerTypesItems"},"ContractsContractIdPatchResponsesContentApplicationJsonSchemaWorkScheduleEmploymentType":{"type":"string","enum":["FULL_TIME","PART_TIME","CONTRACT","TEMPORARY"],"description":"Type of employment arrangement","title":"ContractsContractIdPatchResponsesContentApplicationJsonSchemaWorkScheduleEmploymentType"},"ContractsContractIdPatchResponsesContentApplicationJsonSchemaWorkSchedule":{"type":"object","properties":{"days":{"type":"array","items":{"$ref":"#/components/schemas/ContractsContractIdPatchResponsesContentApplicationJsonSchemaWorkScheduleDaysItems"},"description":"Working days and hours configuration"},"name":{"type":"string","description":"Unique identifier or name for the work schedule"},"country":{"type":"string","description":"Country code where this work schedule applies (ISO 3166-1 alpha-2)"},"worker_types":{"type":"array","items":{"$ref":"#/components/schemas/ContractsContractIdPatchResponsesContentApplicationJsonSchemaWorkScheduleWorkerTypesItems"},"description":"List of worker types that can use this schedule"},"employment_type":{"oneOf":[{"$ref":"#/components/schemas/ContractsContractIdPatchResponsesContentApplicationJsonSchemaWorkScheduleEmploymentType"},{"type":"null"}],"description":"Type of employment arrangement"},"work_schedule_type":{"type":"string","description":"Work schedule type"},"work_hours_per_week":{"type":"integer","description":"Total number of working hours per week"}},"required":["days","name","country","worker_types","work_schedule_type","work_hours_per_week"],"description":"Defines a work schedule including working days, hours, and employment details","title":"ContractsContractIdPatchResponsesContentApplicationJsonSchemaWorkSchedule"},"ContractsContractIdPatchResponsesContentApplicationJsonSchemaEmploymentType":{"type":"string","enum":["FULL_TIME","PART_TIME"],"description":"Type of employment.","title":"ContractsContractIdPatchResponsesContentApplicationJsonSchemaEmploymentType"},"ContractsContractIdPatchResponsesContentApplicationJsonSchemaContractTemplate":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of a contract template."},"title":{"type":"string","description":"Title of a contract template"}},"description":"Contract template details.","title":"ContractsContractIdPatchResponsesContentApplicationJsonSchemaContractTemplate"},"ContractsContractIdPatchResponsesContentApplicationJsonSchemaEmploymentDetails":{"type":"object","properties":{"type":{"type":"string","description":"Type of employment."},"days_per_week":{"type":"number","format":"double","description":"Number of days per week."},"hours_per_day":{"type":"number","format":"double","description":"Number of hours per day."},"probation_period":{"type":["number","null"],"format":"double","description":"Probation period in days."},"paid_vacation_days":{"type":"number","format":"double","description":"Number of paid vacation days."}},"description":"Employment-related details for the contract.","title":"ContractsContractIdPatchResponsesContentApplicationJsonSchemaEmploymentDetails"},"ContractsContractIdPatchResponsesContentApplicationJsonSchemaCompensationDetailsCycleEndType":{"type":"string","enum":["DAY_OF_WEEK","DAY_OF_LAST_WEEK","DAY_OF_MONTH"],"description":" Cycle end type","title":"ContractsContractIdPatchResponsesContentApplicationJsonSchemaCompensationDetailsCycleEndType"},"ContractsContractIdPatchResponsesContentApplicationJsonSchemaCompensationDetails":{"type":"object","properties":{"scale":{"type":["string","null"],"description":"Scale of the payment."},"amount":{"type":["string","null"],"description":"Amount to be paid. This field can be excluded when creating a Pay-as-you-go task-based or Milestone contracts."},"cycle_end":{"type":["number","null"],"format":"double","description":"Day of the cycle end"},"frequency":{"type":"string","description":"Scale of the invoice cycle."},"currency_code":{"type":["string","null"],"description":"Currency code."},"first_payment":{"type":["string","null"],"description":"First payment amount."},"cycle_end_type":{"oneOf":[{"$ref":"#/components/schemas/ContractsContractIdPatchResponsesContentApplicationJsonSchemaCompensationDetailsCycleEndType"},{"type":"null"}],"description":" Cycle end type"},"first_payment_date":{"type":["string","null"],"description":"First payment date."},"gross_annual_salary":{"type":["string","null"],"description":"Gross annual salary."},"gross_signing_bonus":{"type":["string","null"],"description":"Gross signing bonus."},"gross_variable_bonus":{"type":["string","null"],"description":"Gross variable bonus."}},"description":"Compensation and payment configuration for the contract.","title":"ContractsContractIdPatchResponsesContentApplicationJsonSchemaCompensationDetails"},"contracts_updateICContract_Response_200":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the contract."},"type":{"$ref":"#/components/schemas/ContractsContractIdPatchResponsesContentApplicationJsonSchemaType","description":"Type of a contract."},"quote":{"$ref":"#/components/schemas/ContractsContractIdPatchResponsesContentApplicationJsonSchemaQuote","description":"EOR quote approved by Deel."},"title":{"type":"string","description":"Title of the contract."},"client":{"oneOf":[{"$ref":"#/components/schemas/ContractsContractIdPatchResponsesContentApplicationJsonSchemaClient"},{"type":"null"}],"description":"Client details associated with the contract."},"status":{"$ref":"#/components/schemas/ContractsContractIdPatchResponsesContentApplicationJsonSchemaStatus","description":"Status of a contract in Deel workflow."},"worker":{"oneOf":[{"$ref":"#/components/schemas/ContractsContractIdPatchResponsesContentApplicationJsonSchemaWorker"},{"type":"null"}],"description":"Worker details associated with the contract."},"job_title":{"type":"string","description":"Job title associated with the contract."},"seniority":{"oneOf":[{"$ref":"#/components/schemas/ContractsContractIdPatchResponsesContentApplicationJsonSchemaSeniority"},{"type":"null"}],"description":"Seniority describes level of expertise at a job e.g. junior."},"created_at":{"type":"string","format":"date-time","description":"Date and time when the contract was created."},"signatures":{"$ref":"#/components/schemas/ContractsContractIdPatchResponsesContentApplicationJsonSchemaSignatures","description":"Signature information for the contract parties."},"start_date":{"type":"string","format":"date-time","description":"Date and time when the contract starts."},"updated_at":{"type":"string","format":"date-time","description":"Date and time when the contract was updated."},"external_id":{"type":["string","null"],"description":"External identifier of the contract."},"invitations":{"$ref":"#/components/schemas/ContractsContractIdPatchResponsesContentApplicationJsonSchemaInvitations","description":"Invitation email addresses for signing the contract."},"is_archived":{"type":["boolean","null"],"description":"Flag to indicate if the contract is archived."},"who_reports":{"type":"string","description":"Who reports the hours."},"cost_centers":{"type":"array","items":{"$ref":"#/components/schemas/ContractsContractIdPatchResponsesContentApplicationJsonSchemaCostCentersItems"},"description":"List of cost centers associated with the contract."},"custom_fields":{"type":["array","null"],"items":{"$ref":"#/components/schemas/ContractsContractIdPatchResponsesContentApplicationJsonSchemaCustomFieldsItems"},"description":"List of custom fields attached to the contract."},"notice_period":{"type":["number","null"],"format":"double","description":"Notice period in days."},"scope_of_work":{"type":["string","null"],"description":"Scope of work of the contract."},"work_schedule":{"oneOf":[{"$ref":"#/components/schemas/ContractsContractIdPatchResponsesContentApplicationJsonSchemaWorkSchedule"},{"type":"null"}],"description":"Defines a work schedule including working days, hours, and employment details"},"special_clause":{"type":["string","null"],"description":"Special clause of the contract."},"employment_type":{"oneOf":[{"$ref":"#/components/schemas/ContractsContractIdPatchResponsesContentApplicationJsonSchemaEmploymentType"},{"type":"null"}],"description":"Type of employment."},"termination_date":{"type":["string","null"],"description":"Date and time when the contract ends."},"contract_template":{"oneOf":[{"$ref":"#/components/schemas/ContractsContractIdPatchResponsesContentApplicationJsonSchemaContractTemplate"},{"type":"null"}],"description":"Contract template details."},"work_statement_id":{"type":["string","null"],"description":"The unique identifier of the associated work statement."},"employment_details":{"$ref":"#/components/schemas/ContractsContractIdPatchResponsesContentApplicationJsonSchemaEmploymentDetails","description":"Employment-related details for the contract."},"compensation_details":{"$ref":"#/components/schemas/ContractsContractIdPatchResponsesContentApplicationJsonSchemaCompensationDetails","description":"Compensation and payment configuration for the contract."}},"required":["id","type","title","client","status","worker","created_at","signatures","start_date","updated_at","invitations","is_archived","special_clause","termination_date"],"title":"contracts_updateICContract_Response_200"},"ContractsContractIdPatchResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"message":{"type":"string","description":"Error response"}},"required":["message"],"title":"ContractsContractIdPatchResponsesContentApplicationJsonSchemaErrorsItems"},"ContractsContractIdPatchResponsesContentApplicationJsonSchemaRequest":{"type":"object","properties":{"method":{"type":"string","description":"Method of the API"},"status":{"type":"number","format":"double","description":"Status of API response"}},"description":"Error request details","title":"ContractsContractIdPatchResponsesContentApplicationJsonSchemaRequest"},"AddExternalIdRequestNotFoundError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ContractsContractIdPatchResponsesContentApplicationJsonSchemaErrorsItems"},"description":"Error messages"},"request":{"$ref":"#/components/schemas/ContractsContractIdPatchResponsesContentApplicationJsonSchemaRequest","description":"Error request details"}},"required":["errors"],"title":"AddExternalIdRequestNotFoundError"},"Contracts_approveAnEquityExercise-v2026-01-01_Response_200":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the equity exercise."},"status":{"type":"string","description":"The current status of the equity exercise, e.g., 'approved' or 'pending'."},"created_at":{"type":"string","format":"date","description":"The date when the equity exercise was created."},"updated_at":{"type":"string","format":"date","description":"The date when the equity exercise was last updated."},"employer_approval":{"type":"string","description":"Indicates whether the employer has approved the equity exercise. Valid values: 'approved', 'rejected'."}},"required":["id","status","created_at","updated_at","employer_approval"],"title":"Contracts_approveAnEquityExercise-v2026-01-01_Response_200"},"EquityExercisePublicIdPatchResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"message":{"type":"string","description":"General error description for logging and debugging."}},"required":["message"],"title":"EquityExercisePublicIdPatchResponsesContentApplicationJsonSchemaErrorsItems"},"ApproveAnEquityExercise-v2026-01-01RequestUnauthorizedError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EquityExercisePublicIdPatchResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"ApproveAnEquityExercise-v2026-01-01RequestUnauthorizedError"},"ApproveAnEquityExercise-v2026-01-01RequestForbiddenError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EquityExercisePublicIdPatchResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"ApproveAnEquityExercise-v2026-01-01RequestForbiddenError"},"ApproveAnEquityExercise-v2026-01-01RequestNotFoundError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EquityExercisePublicIdPatchResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"ApproveAnEquityExercise-v2026-01-01RequestNotFoundError"},"ApproveAnEquityExercise-v2026-01-01RequestTooManyRequestsError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EquityExercisePublicIdPatchResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"ApproveAnEquityExercise-v2026-01-01RequestTooManyRequestsError"},"ApproveAnEquityExercise-v2026-01-01RequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EquityExercisePublicIdPatchResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"ApproveAnEquityExercise-v2026-01-01RequestInternalServerError"},"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0Meta":{"type":"object","properties":{"is_main_income":{"type":"boolean","description":"Flag to indicate if the contract is the main income for the contractor."},"documents_required":{"type":"boolean","description":"Require the contractor to upload necessary compliance documents as per their country’s labor laws."}},"required":["documents_required"],"description":"Additional custom info about a contract","title":"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0Meta"},"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0ClientTeamId":{"oneOf":[{"type":"string"},{"type":"number","format":"double"}],"description":"Unique identifier of this resource.","title":"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0ClientTeamId"},"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0ClientTeam":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0ClientTeamId","description":"Unique identifier of this resource."}},"required":["id"],"description":"Choose the Deel team for this contract. Use teams endpoint to retrieve a list of teams in your organization.","title":"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0ClientTeam"},"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0ClientLegalEntityId":{"oneOf":[{"type":"string"},{"type":"number","format":"double"}],"description":"Unique identifier of this resource.","title":"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0ClientLegalEntityId"},"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0ClientLegalEntity":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0ClientLegalEntityId","description":"Unique identifier of this resource."}},"required":["id"],"description":"Choose the Deel legal entity for this contract. Use legal entity endpoint to retrieve a list of legal entities in your organization.","title":"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0ClientLegalEntity"},"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0Client":{"type":"object","properties":{"team":{"$ref":"#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0ClientTeam","description":"Choose the Deel team for this contract. Use teams endpoint to retrieve a list of teams in your organization."},"legal_entity":{"$ref":"#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0ClientLegalEntity","description":"Choose the Deel legal entity for this contract. Use legal entity endpoint to retrieve a list of legal entities in your organization."}},"required":["team","legal_entity"],"description":"Client details for the contract, including the legal entity and team.","title":"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0Client"},"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0Worker":{"type":"object","properties":{"last_name":{"type":["string","null"],"description":"Worker's last name"},"first_name":{"type":["string","null"],"description":"Worker's first name"},"work_email":{"type":["string","null"],"format":"email","description":"Worker's work email address."},"expected_email":{"type":["string","null"],"format":"email","description":"Worker's email address."}},"required":["first_name","expected_email"],"description":"Worker properties","title":"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0Worker"},"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0JobTitleId":{"oneOf":[{"type":"string"},{"type":"number","format":"double"}],"description":"Unique identifier of this resource.","title":"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0JobTitleId"},"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0JobTitle":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0JobTitleId","description":"Unique identifier of this resource."},"name":{"type":["string","null"],"description":"Job title. Please leave it blank when entering an Id."}},"description":"Worker's job title. You can enter a custom job title or use a pre-defined job title using the Id retrieved in job-titles endpoint.","title":"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0JobTitle"},"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0SeniorityId":{"oneOf":[{"type":"string"},{"type":"number","format":"double"}],"description":"Unique identifier of this resource.","title":"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0SeniorityId"},"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0Seniority":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0SeniorityId","description":"Unique identifier of this resource."}},"description":"Job seniority level. Please use the seniority levels endpoint to retrieve the list of seniority levels.","title":"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0Seniority"},"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0WhoReports":{"type":"string","enum":["both","client","contractor"],"description":"Flag to indicate who is supposed to provide regular reports","title":"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0WhoReports"},"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0Type":{"type":"string","enum":["pay_as_you_go_time_based"],"description":"Type of contract","title":"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0Type"},"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0CompensationDetailsFrequency":{"type":"string","enum":["weekly","monthly","biweekly","semimonthly","calendar-month"],"description":"Scale of the invoice cycle.","title":"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0CompensationDetailsFrequency"},"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0CompensationDetailsCycleEndType":{"type":"string","enum":["DAY_OF_WEEK","DAY_OF_LAST_WEEK","DAY_OF_MONTH"],"description":"Cycle end can be weekly 1-7 (Monday = 1) or monthly 1-31.","title":"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0CompensationDetailsCycleEndType"},"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0CompensationDetailsPaymentDueType":{"type":"string","enum":["REGULAR","WITHIN_MONTH","AFTER_MONTH","BEFORE_CYCLE_END"],"default":"REGULAR","description":"Type of payment due. If the payment is due on the last day of month, enter 'WITHIN_MONTH'. If the payment is due some days after the end of the month, enter 'AFTER_MONTH'. If the payment is due before the end of the invoice cycle, enter 'BEFORE_CYCLE_END'.","title":"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0CompensationDetailsPaymentDueType"},"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0CompensationDetailsScale":{"type":"string","enum":["hourly","daily","weekly","monthly","biweekly","semimonthly","custom"],"description":"Defines the scale at which the amount is paid. For example, enter 'hourly' to define the amount per hour. This field can be excluded when creating a Pay-as-you-go task-based or Milestone contracts.","title":"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0CompensationDetailsScale"},"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0CompensationDetails":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"Amount to be paid. This field can be excluded when creating a Pay-as-you-go task-based or Milestone contracts."},"cycle_end":{"type":"number","format":"double","description":"Date invoice cycle ends."},"frequency":{"$ref":"#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0CompensationDetailsFrequency","description":"Scale of the invoice cycle."},"currency_code":{"type":"string","description":"Currency code."},"first_payment":{"type":"number","format":"double","default":0,"description":"First payment amount."},"notice_period":{"type":"number","format":"double","default":10,"description":"Days before to notice the termination of contract for either party."},"cycle_end_type":{"$ref":"#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0CompensationDetailsCycleEndType","description":"Cycle end can be weekly 1-7 (Monday = 1) or monthly 1-31."},"payment_due_days":{"type":"number","format":"double","description":"Number of days to pay the invoice."},"payment_due_type":{"$ref":"#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0CompensationDetailsPaymentDueType","description":"Type of payment due. If the payment is due on the last day of month, enter 'WITHIN_MONTH'. If the payment is due some days after the end of the month, enter 'AFTER_MONTH'. If the payment is due before the end of the invoice cycle, enter 'BEFORE_CYCLE_END'."},"first_payment_date":{"type":["string","null"],"description":"Short date in format ISO-8601 (YYYY-MM-DD). For example: 2022-12-31."},"pay_before_weekends":{"type":"boolean","description":"If the payment due is on a weekend, pay on Friday."},"scale":{"$ref":"#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0CompensationDetailsScale","description":"Defines the scale at which the amount is paid. For example, enter 'hourly' to define the amount per hour. This field can be excluded when creating a Pay-as-you-go task-based or Milestone contracts."}},"required":["amount","cycle_end","frequency","currency_code","cycle_end_type","payment_due_days","payment_due_type","scale"],"title":"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0CompensationDetails"},"ContractsPostRequestBodyContentApplicationJsonSchemaData0":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0Meta","description":"Additional custom info about a contract"},"title":{"type":"string","description":"The title of the contract."},"client":{"$ref":"#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0Client","description":"Client details for the contract, including the legal entity and team."},"worker":{"oneOf":[{"$ref":"#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0Worker"},{"type":"null"}],"description":"Worker properties"},"job_title":{"$ref":"#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0JobTitle","description":"Worker's job title. You can enter a custom job title or use a pre-defined job title using the Id retrieved in job-titles endpoint."},"seniority":{"oneOf":[{"$ref":"#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0Seniority"},{"type":"null"}],"description":"Job seniority level. Please use the seniority levels endpoint to retrieve the list of seniority levels."},"state_code":{"type":["string","null"],"description":"The state or province code. Use country lookup endpoint to retrieve state codes."},"citizenship":{"type":["string","null"],"description":"ISO 3166-1 alpha-2 country code of the worker's citizenship."},"external_id":{"type":["string","null"],"description":"External Id."},"who_reports":{"$ref":"#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0WhoReports","description":"Flag to indicate who is supposed to provide regular reports"},"country_code":{"type":"string","description":"Country code."},"notice_period":{"type":"number","format":"double","default":10,"description":"Days before to notice the termination of contract for either party."},"scope_of_work":{"type":["string","null"],"description":"Describe the work to be performed."},"special_clause":{"type":["string","null"],"description":"Enter any special clause you may have."},"scope_of_work_id":{"type":["string","null"],"format":"uuid","description":"Existing scope of work public id"},"termination_date":{"type":["string","null"],"format":"date","description":"Short date in format ISO-8601 (YYYY-MM-DD). For example: 2022-12-31."},"contract_template_id":{"type":["string","null"],"description":"Contract Template Id."},"type":{"$ref":"#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0Type","description":"Type of contract"},"start_date":{"type":"string","format":"date","description":"Short date in format ISO-8601 (YYYY-MM-DD). For example: 2022-12-31."},"compensation_details":{"$ref":"#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf0CompensationDetails","description":"Compensation and invoicing configuration for the contract."}},"required":["meta","title","client","job_title","type","start_date","compensation_details"],"description":"Details of contract to create","title":"ContractsPostRequestBodyContentApplicationJsonSchemaData0"},"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf1Meta":{"type":"object","properties":{"is_main_income":{"type":"boolean","description":"Flag to indicate if the contract is the main income for the contractor."},"documents_required":{"type":"boolean","description":"Require the contractor to upload necessary compliance documents as per their country’s labor laws."}},"required":["documents_required"],"description":"Additional custom info about a contract","title":"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf1Meta"},"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf1ClientTeamId":{"oneOf":[{"type":"string"},{"type":"number","format":"double"}],"description":"Unique identifier of this resource.","title":"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf1ClientTeamId"},"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf1ClientTeam":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf1ClientTeamId","description":"Unique identifier of this resource."}},"required":["id"],"description":"Choose the Deel team for this contract. Use teams endpoint to retrieve a list of teams in your organization.","title":"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf1ClientTeam"},"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf1ClientLegalEntityId":{"oneOf":[{"type":"string"},{"type":"number","format":"double"}],"description":"Unique identifier of this resource.","title":"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf1ClientLegalEntityId"},"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf1ClientLegalEntity":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf1ClientLegalEntityId","description":"Unique identifier of this resource."}},"required":["id"],"description":"Choose the Deel legal entity for this contract. Use legal entity endpoint to retrieve a list of legal entities in your organization.","title":"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf1ClientLegalEntity"},"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf1Client":{"type":"object","properties":{"team":{"$ref":"#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf1ClientTeam","description":"Choose the Deel team for this contract. Use teams endpoint to retrieve a list of teams in your organization."},"legal_entity":{"$ref":"#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf1ClientLegalEntity","description":"Choose the Deel legal entity for this contract. Use legal entity endpoint to retrieve a list of legal entities in your organization."}},"required":["team","legal_entity"],"description":"Client details for the contract, including the legal entity and team.","title":"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf1Client"},"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf1Worker":{"type":"object","properties":{"last_name":{"type":["string","null"],"description":"Worker's last name"},"first_name":{"type":["string","null"],"description":"Worker's first name"},"work_email":{"type":["string","null"],"format":"email","description":"Worker's work email address."},"expected_email":{"type":["string","null"],"format":"email","description":"Worker's email address."}},"required":["first_name","expected_email"],"description":"Worker properties","title":"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf1Worker"},"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf1JobTitleId":{"oneOf":[{"type":"string"},{"type":"number","format":"double"}],"description":"Unique identifier of this resource.","title":"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf1JobTitleId"},"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf1JobTitle":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf1JobTitleId","description":"Unique identifier of this resource."},"name":{"type":["string","null"],"description":"Job title. Please leave it blank when entering an Id."}},"description":"Worker's job title. You can enter a custom job title or use a pre-defined job title using the Id retrieved in job-titles endpoint.","title":"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf1JobTitle"},"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf1SeniorityId":{"oneOf":[{"type":"string"},{"type":"number","format":"double"}],"description":"Unique identifier of this resource.","title":"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf1SeniorityId"},"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf1Seniority":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf1SeniorityId","description":"Unique identifier of this resource."}},"description":"Job seniority level. Please use the seniority levels endpoint to retrieve the list of seniority levels.","title":"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf1Seniority"},"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf1WhoReports":{"type":"string","enum":["both","client","contractor"],"description":"Flag to indicate who is supposed to provide regular reports","title":"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf1WhoReports"},"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf1Type":{"type":"string","enum":["payg_tasks"],"description":"Type of contract","title":"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf1Type"},"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf1CompensationDetailsFrequency":{"type":"string","enum":["weekly","monthly","biweekly","semimonthly","calendar-month"],"description":"Scale of the invoice cycle.","title":"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf1CompensationDetailsFrequency"},"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf1CompensationDetailsCycleEndType":{"type":"string","enum":["DAY_OF_WEEK","DAY_OF_LAST_WEEK","DAY_OF_MONTH"],"description":"Cycle end can be weekly 1-7 (Monday = 1) or monthly 1-31.","title":"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf1CompensationDetailsCycleEndType"},"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf1CompensationDetailsPaymentDueType":{"type":"string","enum":["REGULAR","WITHIN_MONTH","AFTER_MONTH","BEFORE_CYCLE_END"],"default":"REGULAR","description":"Type of payment due. If the payment is due on the last day of month, enter 'WITHIN_MONTH'. If the payment is due some days after the end of the month, enter 'AFTER_MONTH'. If the payment is due before the end of the invoice cycle, enter 'BEFORE_CYCLE_END'.","title":"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf1CompensationDetailsPaymentDueType"},"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf1CompensationDetails":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"Amount to be paid. This field can be excluded when creating a Pay-as-you-go task-based or Milestone contracts."},"cycle_end":{"type":"number","format":"double","description":"Date invoice cycle ends."},"frequency":{"$ref":"#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf1CompensationDetailsFrequency","description":"Scale of the invoice cycle."},"currency_code":{"type":"string","description":"Currency code."},"first_payment":{"type":"number","format":"double","default":0,"description":"First payment amount."},"notice_period":{"type":"number","format":"double","default":10,"description":"Days before to notice the termination of contract for either party."},"cycle_end_type":{"$ref":"#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf1CompensationDetailsCycleEndType","description":"Cycle end can be weekly 1-7 (Monday = 1) or monthly 1-31."},"payment_due_days":{"type":"number","format":"double","description":"Number of days to pay the invoice."},"payment_due_type":{"$ref":"#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf1CompensationDetailsPaymentDueType","description":"Type of payment due. If the payment is due on the last day of month, enter 'WITHIN_MONTH'. If the payment is due some days after the end of the month, enter 'AFTER_MONTH'. If the payment is due before the end of the invoice cycle, enter 'BEFORE_CYCLE_END'."},"first_payment_date":{"type":["string","null"],"description":"Short date in format ISO-8601 (YYYY-MM-DD). For example: 2022-12-31."},"pay_before_weekends":{"type":"boolean","description":"If the payment due is on a weekend, pay on Friday."}},"required":["cycle_end","frequency","currency_code","cycle_end_type","payment_due_days","payment_due_type"],"description":"Compensation and invoicing configuration for the contract.","title":"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf1CompensationDetails"},"ContractsPostRequestBodyContentApplicationJsonSchemaData1":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf1Meta","description":"Additional custom info about a contract"},"title":{"type":"string","description":"The title of the contract."},"client":{"$ref":"#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf1Client","description":"Client details for the contract, including the legal entity and team."},"worker":{"oneOf":[{"$ref":"#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf1Worker"},{"type":"null"}],"description":"Worker properties"},"job_title":{"$ref":"#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf1JobTitle","description":"Worker's job title. You can enter a custom job title or use a pre-defined job title using the Id retrieved in job-titles endpoint."},"seniority":{"oneOf":[{"$ref":"#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf1Seniority"},{"type":"null"}],"description":"Job seniority level. Please use the seniority levels endpoint to retrieve the list of seniority levels."},"state_code":{"type":["string","null"],"description":"The state or province code. Use country lookup endpoint to retrieve state codes."},"citizenship":{"type":["string","null"],"description":"ISO 3166-1 alpha-2 country code of the worker's citizenship."},"external_id":{"type":["string","null"],"description":"External Id."},"who_reports":{"$ref":"#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf1WhoReports","description":"Flag to indicate who is supposed to provide regular reports"},"country_code":{"type":"string","description":"Country code."},"notice_period":{"type":"number","format":"double","default":10,"description":"Days before to notice the termination of contract for either party."},"scope_of_work":{"type":["string","null"],"description":"Describe the work to be performed."},"special_clause":{"type":["string","null"],"description":"Enter any special clause you may have."},"scope_of_work_id":{"type":["string","null"],"format":"uuid","description":"Existing scope of work public id"},"termination_date":{"type":["string","null"],"format":"date","description":"Short date in format ISO-8601 (YYYY-MM-DD). For example: 2022-12-31."},"contract_template_id":{"type":["string","null"],"description":"Contract Template Id."},"type":{"$ref":"#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf1Type","description":"Type of contract"},"start_date":{"type":"string","format":"date","description":"Short date in format ISO-8601 (YYYY-MM-DD). For example: 2022-12-31."},"compensation_details":{"$ref":"#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf1CompensationDetails","description":"Compensation and invoicing configuration for the contract."}},"required":["meta","title","client","job_title","type","start_date","compensation_details"],"description":"Details of contract to create","title":"ContractsPostRequestBodyContentApplicationJsonSchemaData1"},"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2Meta":{"type":"object","properties":{"is_main_income":{"type":"boolean","description":"Flag to indicate if the contract is the main income for the contractor."},"documents_required":{"type":"boolean","description":"Require the contractor to upload necessary compliance documents as per their country’s labor laws."}},"required":["documents_required"],"description":"Additional custom info about a contract","title":"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2Meta"},"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2ClientTeamId":{"oneOf":[{"type":"string"},{"type":"number","format":"double"}],"description":"Unique identifier of this resource.","title":"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2ClientTeamId"},"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2ClientTeam":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2ClientTeamId","description":"Unique identifier of this resource."}},"required":["id"],"description":"Choose the Deel team for this contract. Use teams endpoint to retrieve a list of teams in your organization.","title":"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2ClientTeam"},"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2ClientLegalEntityId":{"oneOf":[{"type":"string"},{"type":"number","format":"double"}],"description":"Unique identifier of this resource.","title":"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2ClientLegalEntityId"},"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2ClientLegalEntity":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2ClientLegalEntityId","description":"Unique identifier of this resource."}},"required":["id"],"description":"Choose the Deel legal entity for this contract. Use legal entity endpoint to retrieve a list of legal entities in your organization.","title":"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2ClientLegalEntity"},"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2Client":{"type":"object","properties":{"team":{"$ref":"#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2ClientTeam","description":"Choose the Deel team for this contract. Use teams endpoint to retrieve a list of teams in your organization."},"legal_entity":{"$ref":"#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2ClientLegalEntity","description":"Choose the Deel legal entity for this contract. Use legal entity endpoint to retrieve a list of legal entities in your organization."}},"required":["team","legal_entity"],"description":"Client details for the contract, including the legal entity and team.","title":"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2Client"},"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2Worker":{"type":"object","properties":{"last_name":{"type":["string","null"],"description":"Worker's last name"},"first_name":{"type":["string","null"],"description":"Worker's first name"},"work_email":{"type":["string","null"],"format":"email","description":"Worker's work email address."},"expected_email":{"type":["string","null"],"format":"email","description":"Worker's email address."}},"required":["first_name","expected_email"],"description":"Worker properties","title":"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2Worker"},"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2JobTitleId":{"oneOf":[{"type":"string"},{"type":"number","format":"double"}],"description":"Unique identifier of this resource.","title":"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2JobTitleId"},"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2JobTitle":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2JobTitleId","description":"Unique identifier of this resource."},"name":{"type":["string","null"],"description":"Job title. Please leave it blank when entering an Id."}},"description":"Worker's job title. You can enter a custom job title or use a pre-defined job title using the Id retrieved in job-titles endpoint.","title":"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2JobTitle"},"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2SeniorityId":{"oneOf":[{"type":"string"},{"type":"number","format":"double"}],"description":"Unique identifier of this resource.","title":"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2SeniorityId"},"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2Seniority":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2SeniorityId","description":"Unique identifier of this resource."}},"description":"Job seniority level. Please use the seniority levels endpoint to retrieve the list of seniority levels.","title":"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2Seniority"},"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2WhoReports":{"type":"string","enum":["both","client","contractor"],"description":"Flag to indicate who is supposed to provide regular reports","title":"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2WhoReports"},"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2Type":{"type":"string","enum":["payg_milestones"],"description":"Type of contract","title":"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2Type"},"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2CompensationDetailsFrequency":{"type":"string","enum":["weekly","monthly","biweekly","semimonthly","calendar-month"],"description":"Scale of the invoice cycle.","title":"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2CompensationDetailsFrequency"},"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2CompensationDetailsCycleEndType":{"type":"string","enum":["DAY_OF_WEEK","DAY_OF_LAST_WEEK","DAY_OF_MONTH"],"description":"Cycle end can be weekly 1-7 (Monday = 1) or monthly 1-31.","title":"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2CompensationDetailsCycleEndType"},"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2CompensationDetailsPaymentDueType":{"type":"string","enum":["REGULAR","WITHIN_MONTH","AFTER_MONTH","BEFORE_CYCLE_END"],"default":"REGULAR","description":"Type of payment due. If the payment is due on the last day of month, enter 'WITHIN_MONTH'. If the payment is due some days after the end of the month, enter 'AFTER_MONTH'. If the payment is due before the end of the invoice cycle, enter 'BEFORE_CYCLE_END'.","title":"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2CompensationDetailsPaymentDueType"},"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2CompensationDetails":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"Amount to be paid. This field can be excluded when creating a Pay-as-you-go task-based or Milestone contracts."},"cycle_end":{"type":"number","format":"double","description":"Date invoice cycle ends."},"frequency":{"$ref":"#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2CompensationDetailsFrequency","description":"Scale of the invoice cycle."},"currency_code":{"type":"string","description":"Currency code."},"first_payment":{"type":"number","format":"double","default":0,"description":"First payment amount."},"notice_period":{"type":"number","format":"double","default":10,"description":"Days before to notice the termination of contract for either party."},"cycle_end_type":{"$ref":"#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2CompensationDetailsCycleEndType","description":"Cycle end can be weekly 1-7 (Monday = 1) or monthly 1-31."},"payment_due_days":{"type":"number","format":"double","description":"Number of days to pay the invoice."},"payment_due_type":{"$ref":"#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2CompensationDetailsPaymentDueType","description":"Type of payment due. If the payment is due on the last day of month, enter 'WITHIN_MONTH'. If the payment is due some days after the end of the month, enter 'AFTER_MONTH'. If the payment is due before the end of the invoice cycle, enter 'BEFORE_CYCLE_END'."},"first_payment_date":{"type":["string","null"],"description":"Short date in format ISO-8601 (YYYY-MM-DD). For example: 2022-12-31."},"pay_before_weekends":{"type":"boolean","description":"If the payment due is on a weekend, pay on Friday."}},"required":["cycle_end","frequency","currency_code","cycle_end_type","payment_due_days","payment_due_type"],"description":"Compensation and invoicing configuration for the contract.","title":"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2CompensationDetails"},"ContractsPostRequestBodyContentApplicationJsonSchemaData2":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2Meta","description":"Additional custom info about a contract"},"title":{"type":"string","description":"The title of the contract."},"client":{"$ref":"#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2Client","description":"Client details for the contract, including the legal entity and team."},"worker":{"oneOf":[{"$ref":"#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2Worker"},{"type":"null"}],"description":"Worker properties"},"job_title":{"$ref":"#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2JobTitle","description":"Worker's job title. You can enter a custom job title or use a pre-defined job title using the Id retrieved in job-titles endpoint."},"seniority":{"oneOf":[{"$ref":"#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2Seniority"},{"type":"null"}],"description":"Job seniority level. Please use the seniority levels endpoint to retrieve the list of seniority levels."},"state_code":{"type":["string","null"],"description":"The state or province code. Use country lookup endpoint to retrieve state codes."},"citizenship":{"type":["string","null"],"description":"ISO 3166-1 alpha-2 country code of the worker's citizenship."},"external_id":{"type":["string","null"],"description":"External Id."},"who_reports":{"$ref":"#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2WhoReports","description":"Flag to indicate who is supposed to provide regular reports"},"country_code":{"type":"string","description":"Country code."},"notice_period":{"type":"number","format":"double","default":10,"description":"Days before to notice the termination of contract for either party."},"scope_of_work":{"type":["string","null"],"description":"Describe the work to be performed."},"special_clause":{"type":["string","null"],"description":"Enter any special clause you may have."},"scope_of_work_id":{"type":["string","null"],"format":"uuid","description":"Existing scope of work public id"},"termination_date":{"type":["string","null"],"format":"date","description":"Short date in format ISO-8601 (YYYY-MM-DD). For example: 2022-12-31."},"contract_template_id":{"type":["string","null"],"description":"Contract Template Id."},"type":{"$ref":"#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2Type","description":"Type of contract"},"start_date":{"type":["string","null"],"format":"date","description":"Short date in format ISO-8601 (YYYY-MM-DD). For example: 2022-12-31."},"compensation_details":{"$ref":"#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf2CompensationDetails","description":"Compensation and invoicing configuration for the contract."}},"required":["meta","title","client","job_title","type","compensation_details"],"description":"Details of contract to create","title":"ContractsPostRequestBodyContentApplicationJsonSchemaData2"},"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3Meta":{"type":"object","properties":{"is_main_income":{"type":"boolean","description":"Flag to indicate if the contract is the main income for the contractor."},"documents_required":{"type":"boolean","description":"Require the contractor to upload necessary compliance documents as per their country’s labor laws."}},"required":["documents_required"],"description":"Additional custom info about a contract","title":"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3Meta"},"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3ClientTeamId":{"oneOf":[{"type":"string"},{"type":"number","format":"double"}],"description":"Unique identifier of this resource.","title":"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3ClientTeamId"},"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3ClientTeam":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3ClientTeamId","description":"Unique identifier of this resource."}},"required":["id"],"description":"Choose the Deel team for this contract. Use teams endpoint to retrieve a list of teams in your organization.","title":"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3ClientTeam"},"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3ClientLegalEntityId":{"oneOf":[{"type":"string"},{"type":"number","format":"double"}],"description":"Unique identifier of this resource.","title":"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3ClientLegalEntityId"},"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3ClientLegalEntity":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3ClientLegalEntityId","description":"Unique identifier of this resource."}},"required":["id"],"description":"Choose the Deel legal entity for this contract. Use legal entity endpoint to retrieve a list of legal entities in your organization.","title":"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3ClientLegalEntity"},"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3Client":{"type":"object","properties":{"team":{"$ref":"#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3ClientTeam","description":"Choose the Deel team for this contract. Use teams endpoint to retrieve a list of teams in your organization."},"legal_entity":{"$ref":"#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3ClientLegalEntity","description":"Choose the Deel legal entity for this contract. Use legal entity endpoint to retrieve a list of legal entities in your organization."}},"required":["team","legal_entity"],"description":"Client details for the contract, including the legal entity and team.","title":"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3Client"},"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3Worker":{"type":"object","properties":{"last_name":{"type":["string","null"],"description":"Worker's last name"},"first_name":{"type":["string","null"],"description":"Worker's first name"},"work_email":{"type":["string","null"],"format":"email","description":"Worker's work email address."},"expected_email":{"type":["string","null"],"format":"email","description":"Worker's email address."}},"required":["first_name","expected_email"],"description":"Worker properties","title":"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3Worker"},"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3JobTitleId":{"oneOf":[{"type":"string"},{"type":"number","format":"double"}],"description":"Unique identifier of this resource.","title":"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3JobTitleId"},"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3JobTitle":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3JobTitleId","description":"Unique identifier of this resource."},"name":{"type":["string","null"],"description":"Job title. Please leave it blank when entering an Id."}},"description":"Worker's job title. You can enter a custom job title or use a pre-defined job title using the Id retrieved in job-titles endpoint.","title":"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3JobTitle"},"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3SeniorityId":{"oneOf":[{"type":"string"},{"type":"number","format":"double"}],"description":"Unique identifier of this resource.","title":"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3SeniorityId"},"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3Seniority":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3SeniorityId","description":"Unique identifier of this resource."}},"description":"Job seniority level. Please use the seniority levels endpoint to retrieve the list of seniority levels.","title":"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3Seniority"},"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3WhoReports":{"type":"string","enum":["both","client","contractor"],"description":"Flag to indicate who is supposed to provide regular reports","title":"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3WhoReports"},"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3Type":{"type":"string","enum":["ongoing_time_based"],"description":"Type of contract","title":"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3Type"},"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3CompensationDetailsFrequency":{"type":"string","enum":["weekly","monthly","biweekly","semimonthly","calendar-month"],"description":"Scale of the invoice cycle.","title":"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3CompensationDetailsFrequency"},"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3CompensationDetailsCycleEndType":{"type":"string","enum":["DAY_OF_WEEK","DAY_OF_LAST_WEEK","DAY_OF_MONTH"],"description":"Cycle end can be weekly 1-7 (Monday = 1) or monthly 1-31.","title":"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3CompensationDetailsCycleEndType"},"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3CompensationDetailsPaymentDueType":{"type":"string","enum":["REGULAR","WITHIN_MONTH","AFTER_MONTH","BEFORE_CYCLE_END"],"default":"REGULAR","description":"Type of payment due. If the payment is due on the last day of month, enter 'WITHIN_MONTH'. If the payment is due some days after the end of the month, enter 'AFTER_MONTH'. If the payment is due before the end of the invoice cycle, enter 'BEFORE_CYCLE_END'.","title":"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3CompensationDetailsPaymentDueType"},"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3CompensationDetailsScale":{"type":"string","enum":["hourly","daily","weekly","monthly","biweekly","semimonthly","custom"],"description":"Defines the scale at which the amount is paid. For example, enter 'hourly' to define the amount per hour. This field can be excluded when creating a Pay-as-you-go task-based or Milestone contracts.","title":"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3CompensationDetailsScale"},"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3CompensationDetails":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"Amount to be paid. This field can be excluded when creating a Pay-as-you-go task-based or Milestone contracts."},"cycle_end":{"type":"number","format":"double","description":"Date invoice cycle ends."},"frequency":{"$ref":"#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3CompensationDetailsFrequency","description":"Scale of the invoice cycle."},"currency_code":{"type":"string","description":"Currency code."},"first_payment":{"type":"number","format":"double","default":0,"description":"First payment amount."},"notice_period":{"type":"number","format":"double","default":10,"description":"Days before to notice the termination of contract for either party."},"cycle_end_type":{"$ref":"#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3CompensationDetailsCycleEndType","description":"Cycle end can be weekly 1-7 (Monday = 1) or monthly 1-31."},"payment_due_days":{"type":"number","format":"double","description":"Number of days to pay the invoice."},"payment_due_type":{"$ref":"#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3CompensationDetailsPaymentDueType","description":"Type of payment due. If the payment is due on the last day of month, enter 'WITHIN_MONTH'. If the payment is due some days after the end of the month, enter 'AFTER_MONTH'. If the payment is due before the end of the invoice cycle, enter 'BEFORE_CYCLE_END'."},"first_payment_date":{"type":["string","null"],"description":"Short date in format ISO-8601 (YYYY-MM-DD). For example: 2022-12-31."},"pay_before_weekends":{"type":"boolean","description":"If the payment due is on a weekend, pay on Friday."},"scale":{"$ref":"#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3CompensationDetailsScale","description":"Defines the scale at which the amount is paid. For example, enter 'hourly' to define the amount per hour. This field can be excluded when creating a Pay-as-you-go task-based or Milestone contracts."}},"required":["amount","cycle_end","frequency","currency_code","cycle_end_type","payment_due_days","payment_due_type","scale"],"title":"ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3CompensationDetails"},"ContractsPostRequestBodyContentApplicationJsonSchemaData3":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3Meta","description":"Additional custom info about a contract"},"title":{"type":"string","description":"The title of the contract."},"client":{"$ref":"#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3Client","description":"Client details for the contract, including the legal entity and team."},"worker":{"oneOf":[{"$ref":"#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3Worker"},{"type":"null"}],"description":"Worker properties"},"job_title":{"$ref":"#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3JobTitle","description":"Worker's job title. You can enter a custom job title or use a pre-defined job title using the Id retrieved in job-titles endpoint."},"seniority":{"oneOf":[{"$ref":"#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3Seniority"},{"type":"null"}],"description":"Job seniority level. Please use the seniority levels endpoint to retrieve the list of seniority levels."},"state_code":{"type":["string","null"],"description":"The state or province code. Use country lookup endpoint to retrieve state codes."},"citizenship":{"type":["string","null"],"description":"ISO 3166-1 alpha-2 country code of the worker's citizenship."},"external_id":{"type":["string","null"],"description":"External Id."},"who_reports":{"$ref":"#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3WhoReports","description":"Flag to indicate who is supposed to provide regular reports"},"country_code":{"type":"string","description":"Country code."},"notice_period":{"type":"number","format":"double","default":10,"description":"Days before to notice the termination of contract for either party."},"scope_of_work":{"type":["string","null"],"description":"Describe the work to be performed."},"special_clause":{"type":["string","null"],"description":"Enter any special clause you may have."},"scope_of_work_id":{"type":["string","null"],"format":"uuid","description":"Existing scope of work public id"},"termination_date":{"type":["string","null"],"format":"date","description":"Short date in format ISO-8601 (YYYY-MM-DD). For example: 2022-12-31."},"contract_template_id":{"type":["string","null"],"description":"Contract Template Id."},"type":{"$ref":"#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3Type","description":"Type of contract"},"start_date":{"type":"string","format":"date","description":"Short date in format ISO-8601 (YYYY-MM-DD). For example: 2022-12-31."},"compensation_details":{"$ref":"#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaDataOneOf3CompensationDetails","description":"Compensation and invoicing configuration for the contract."}},"required":["meta","title","client","job_title","type","start_date","compensation_details"],"description":"Details of contract to create","title":"ContractsPostRequestBodyContentApplicationJsonSchemaData3"},"ContractsPostRequestBodyContentApplicationJsonSchemaData":{"oneOf":[{"$ref":"#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaData0"},{"$ref":"#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaData1"},{"$ref":"#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaData2"},{"$ref":"#/components/schemas/ContractsPostRequestBodyContentApplicationJsonSchemaData3"}],"title":"ContractsPostRequestBodyContentApplicationJsonSchemaData"},"ContractsPostResponsesContentApplicationJsonSchemaDataType":{"type":"string","enum":["ongoing_time_based","milestones","time_based","pay_as_you_go_time_based","commission","payg_milestones","payg_tasks","eor","unknown","employee","global_payroll","shield_msa","hris_direct_employee"],"description":"Type of a contract","title":"ContractsPostResponsesContentApplicationJsonSchemaDataType"},"ContractsPostResponsesContentApplicationJsonSchemaDataQuoteBenefitsItems":{"type":"object","properties":{"fee":{"type":"number","format":"double","description":"Fee in local currency"},"name":{"type":"string","description":"Benefit's name"},"plan":{"type":"string","description":"Benefit's plan"},"price":{"type":"number","format":"double","description":"Price in local currency"},"fee_usd":{"type":"number","format":"double","description":"Fee in USD"},"currency":{"type":"string","description":"Currency code."},"price_usd":{"type":"number","format":"double","description":"Price in USD"}},"title":"ContractsPostResponsesContentApplicationJsonSchemaDataQuoteBenefitsItems"},"ContractsPostResponsesContentApplicationJsonSchemaDataQuoteBreakdownCostsMonthlyCostsItems":{"type":"object","properties":{"name":{"type":"string","description":"Cost's name"},"total":{"type":"number","format":"double","description":"Total cost in local currency"},"currency":{"type":"string","description":"Currency code."},"total_usd":{"type":"number","format":"double","description":"Total cost in USD"}},"title":"ContractsPostResponsesContentApplicationJsonSchemaDataQuoteBreakdownCostsMonthlyCostsItems"},"ContractsPostResponsesContentApplicationJsonSchemaDataQuoteBreakdownCostsMonthly":{"type":"object","properties":{"costs":{"type":"array","items":{"$ref":"#/components/schemas/ContractsPostResponsesContentApplicationJsonSchemaDataQuoteBreakdownCostsMonthlyCostsItems"},"description":"List of individual monthly cost line items included in the quote."},"total":{"type":"number","format":"double","description":"Total costs in local currency"},"total_usd":{"type":"number","format":"double","description":"Total costs in USD"}},"description":"Monthly cost breakdown for the quote.","title":"ContractsPostResponsesContentApplicationJsonSchemaDataQuoteBreakdownCostsMonthly"},"ContractsPostResponsesContentApplicationJsonSchemaDataQuoteBreakdownCosts":{"type":"object","properties":{"monthly":{"$ref":"#/components/schemas/ContractsPostResponsesContentApplicationJsonSchemaDataQuoteBreakdownCostsMonthly","description":"Monthly cost breakdown for the quote."}},"description":"Cost breakdown for the quote, grouped by billing cadence (e.g., monthly).","title":"ContractsPostResponsesContentApplicationJsonSchemaDataQuoteBreakdownCosts"},"ContractsPostResponsesContentApplicationJsonSchemaDataQuote":{"type":"object","properties":{"benefits":{"type":"array","items":{"$ref":"#/components/schemas/ContractsPostResponsesContentApplicationJsonSchemaDataQuoteBenefitsItems"},"description":"Array of benefits"},"currency":{"type":"string","description":"Currency code."},"cba_total":{"type":"number","format":"double","description":"Total CBA in local currency"},"created_at":{"type":["string","null"],"format":"date","description":"Short date in format ISO-8601 (YYYY-MM-DD). For example: 2022-12-31."},"updated_at":{"type":["string","null"],"format":"date","description":"Short date in format ISO-8601 (YYYY-MM-DD). For example: 2022-12-31."},"salary_total":{"type":"number","format":"double","description":"Total salary in local currency"},"annual_salary":{"type":"number","format":"double","description":"Annual Salary in local currency"},"cba_total_usd":{"type":"number","format":"double","description":"Total CBA in USD"},"breakdown_costs":{"$ref":"#/components/schemas/ContractsPostResponsesContentApplicationJsonSchemaDataQuoteBreakdownCosts","description":"Cost breakdown for the quote, grouped by billing cadence (e.g., monthly)."},"salary_total_usd":{"type":"number","format":"double","description":"Total salary in USD"},"gross_salary_total":{"type":"number","format":"double","description":"Total gross salary in local currency"},"mobility_fee_total":{"type":"number","format":"double","description":"Total mobility fee in local currency"},"monthly_cost_total":{"type":"number","format":"double","description":"Total monthly cost in local currency"},"platform_fee_total":{"type":"number","format":"double","description":"Total platform fee in local currency"},"employer_cost_total":{"type":"number","format":"double","description":"Total employer cost in local currency"},"gross_salary_total_usd":{"type":"number","format":"double","description":"Total gross salary in USD"},"mobility_fee_total_usd":{"type":"number","format":"double","description":"Total mobility fee in USD"},"monthly_cost_total_usd":{"type":"number","format":"double","description":"Total monthly cost in USD"},"platform_fee_total_usd":{"type":"number","format":"double","description":"Total platform fee in USD"},"employer_cost_total_usd":{"type":"number","format":"double","description":"Total employer cost in USD"},"severance_accrual_total":{"type":"number","format":"double","description":"Total severance accrual in local currency"},"recurring_allowance_total":{"type":"number","format":"double","description":"Total recurring allowance in local currency"},"severance_accrual_total_usd":{"type":"number","format":"double","description":"Total severance accrual in USD"},"recurring_allowance_total_usd":{"type":"number","format":"double","description":"Total recurring allowance in USD"}},"description":"EOR quote approved by Deel","title":"ContractsPostResponsesContentApplicationJsonSchemaDataQuote"},"ContractsPostResponsesContentApplicationJsonSchemaDataClientTeam":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of this resource."},"name":{"type":"string","description":"Name of a team"}},"required":["id","name"],"description":"Team information for the client organization.","title":"ContractsPostResponsesContentApplicationJsonSchemaDataClientTeam"},"ContractsPostResponsesContentApplicationJsonSchemaDataClientLegalEntityType":{"type":"string","enum":["individual","company"],"description":"Type of a legal entity","title":"ContractsPostResponsesContentApplicationJsonSchemaDataClientLegalEntityType"},"ContractsPostResponsesContentApplicationJsonSchemaDataClientLegalEntity":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of this resource."},"name":{"type":"string","description":"Name of a legal entity"},"type":{"$ref":"#/components/schemas/ContractsPostResponsesContentApplicationJsonSchemaDataClientLegalEntityType","description":"Type of a legal entity"},"email":{"type":["string","null"],"description":"User's email address."},"subtype":{"type":"string","description":"Subtype of a legal entity"},"vat_number":{"type":"string","description":"VAT number of a legal entity"},"registration_number":{"type":"string","description":"Registration number of a legal entity"}},"required":["id","name","type","email","subtype","vat_number","registration_number"],"description":"Legal entity information for the client organization.","title":"ContractsPostResponsesContentApplicationJsonSchemaDataClientLegalEntity"},"ContractsPostResponsesContentApplicationJsonSchemaDataClient":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of this resource."},"team":{"$ref":"#/components/schemas/ContractsPostResponsesContentApplicationJsonSchemaDataClientTeam","description":"Team information for the client organization."},"email":{"type":["string","null"],"format":"email","description":"User's email address."},"full_name":{"type":"string","description":"User's full name."},"legal_entity":{"oneOf":[{"$ref":"#/components/schemas/ContractsPostResponsesContentApplicationJsonSchemaDataClientLegalEntity"},{"type":"null"}],"description":"Legal entity information for the client organization."}},"required":["team","legal_entity"],"description":"Client details associated with the contract.","title":"ContractsPostResponsesContentApplicationJsonSchemaDataClient"},"ContractsPostResponsesContentApplicationJsonSchemaDataStatus":{"type":"string","enum":["new","under_review","waiting_for_employee_contract","waiting_for_client_sign","processing_payment","waiting_for_contractor_sign","waiting_for_eor_sign","waiting_for_employee_sign","awaiting_deposit_payment","in_progress","completed","cancelled","user_cancelled","rejected","waiting_for_client_payment"],"description":"Status of a contract in Deel workflow","title":"ContractsPostResponsesContentApplicationJsonSchemaDataStatus"},"ContractsPostResponsesContentApplicationJsonSchemaDataWorkerLegalEntityType":{"type":"string","enum":["individual","company"],"description":"Type of a legal entity","title":"ContractsPostResponsesContentApplicationJsonSchemaDataWorkerLegalEntityType"},"ContractsPostResponsesContentApplicationJsonSchemaDataWorkerLegalEntity":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/ContractsPostResponsesContentApplicationJsonSchemaDataWorkerLegalEntityType","description":"Type of a legal entity"},"personal_name":{"type":"string","description":"Name of a legal entity"},"registration_number":{"type":"string","description":"Registration number of a legal entity"}},"required":["type","personal_name","registration_number"],"description":"Worker legal entity information, if applicable.","title":"ContractsPostResponsesContentApplicationJsonSchemaDataWorkerLegalEntity"},"ContractsPostResponsesContentApplicationJsonSchemaDataWorkerAlternateEmailItems":{"type":"object","properties":{"email":{"type":["string","null"],"format":"email","description":"User's email address."},"isVerified":{"type":"boolean","description":"True if email has been verified"}},"required":["email","isVerified"],"title":"ContractsPostResponsesContentApplicationJsonSchemaDataWorkerAlternateEmailItems"},"ContractsPostResponsesContentApplicationJsonSchemaDataWorker":{"type":"object","properties":{"id":{"type":["string","null"],"description":"A unique identifier for this resource."},"email":{"type":["string","null"],"format":"email","description":"User's email address."},"image":{"type":"string","format":"url","description":"URL to worker's image"},"country":{"type":["string","null"],"description":"Worker's country (location not nationality)"},"full_name":{"type":"string","description":"Worker's full name."},"last_name":{"type":["string","null"],"description":"Worker's last name"},"first_name":{"type":["string","null"],"description":"Worker's first name"},"nationality":{"type":["string","null"],"description":"Worker's nationality."},"legal_entity":{"$ref":"#/components/schemas/ContractsPostResponsesContentApplicationJsonSchemaDataWorkerLegalEntity","description":"Worker legal entity information, if applicable."},"date_of_birth":{"type":["string","null"],"format":"date-time","description":"Long date-time format following ISO-8601"},"expected_email":{"type":["string","null"],"format":"email","description":"Worker's email address."},"alternate_email":{"type":"array","items":{"$ref":"#/components/schemas/ContractsPostResponsesContentApplicationJsonSchemaDataWorkerAlternateEmailItems"},"description":"List of alternate email addresses."}},"description":"Worker details associated with the contract.","title":"ContractsPostResponsesContentApplicationJsonSchemaDataWorker"},"ContractsPostResponsesContentApplicationJsonSchemaDataSeniority":{"type":"object","properties":{"id":{"type":"number","format":"double","description":"Unique identifier of this resource."},"name":{"type":"string","description":"Name of seniority level e.g. Mid (Individual Contributor Level 2)"},"level":{"type":["number","null"],"format":"double","description":"Level of seniority level e.g. 2"}},"required":["id","name"],"description":"Seniority describes level of expertise at a job e.g. junior","title":"ContractsPostResponsesContentApplicationJsonSchemaDataSeniority"},"ContractsPostResponsesContentApplicationJsonSchemaDataSignatures":{"type":"object","properties":{"signed_at":{"type":["string","null"],"description":"Long date-time format following ISO-8601"},"client_signature":{"type":"string","description":"normally name of client is used as signature"},"client_signed_at":{"type":["string","null"],"description":"Long date-time format following ISO-8601"},"worker_signature":{"type":"string","description":"Signatures of client representative."},"worker_signed_at":{"type":["string","null"],"description":"Long date-time format following ISO-8601"}},"required":["signed_at","client_signature","client_signed_at","worker_signature","worker_signed_at"],"description":"List of signatures recorded for this contract.","title":"ContractsPostResponsesContentApplicationJsonSchemaDataSignatures"},"ContractsPostResponsesContentApplicationJsonSchemaDataInvitations":{"type":"object","properties":{"client_email":{"type":["string","null"],"description":"User's email address."},"worker_email":{"type":["string","null"],"description":"User's email address."}},"description":"List of signature invitations sent for this contract.","title":"ContractsPostResponsesContentApplicationJsonSchemaDataInvitations"},"ContractsPostResponsesContentApplicationJsonSchemaDataWhoReports":{"type":"string","enum":["both","client","contractor",""],"description":"Flag to indicate who is supposed to provide regular reports","title":"ContractsPostResponsesContentApplicationJsonSchemaDataWhoReports"},"ContractsPostResponsesContentApplicationJsonSchemaDataCustomFieldsItems":{"type":"object","properties":{"name":{"type":"string","description":"Custom field property name."},"value":{"type":"string","description":"Custom field property value."}},"description":"Customized attributes on contracts (Employee ID, Project code, etc).","title":"ContractsPostResponsesContentApplicationJsonSchemaDataCustomFieldsItems"},"ContractsPostResponsesContentApplicationJsonSchemaDataTerminationDate1":{"type":"string","enum":[""],"title":"ContractsPostResponsesContentApplicationJsonSchemaDataTerminationDate1"},"ContractsPostResponsesContentApplicationJsonSchemaDataTerminationDate":{"oneOf":[{"type":"string","format":"date-time"},{"$ref":"#/components/schemas/ContractsPostResponsesContentApplicationJsonSchemaDataTerminationDate1"}],"description":"Contract termination date. When present, it is a date-time string in ISO-8601 format.","title":"ContractsPostResponsesContentApplicationJsonSchemaDataTerminationDate"},"ContractsPostResponsesContentApplicationJsonSchemaDataEmploymentDetails":{"type":"object","properties":{"type":{"type":"string","description":"Employment type classification for the contract."},"state":{"type":["string","null"],"description":"State code."},"country":{"type":"string","description":"Country code."},"days_per_week":{"type":"number","format":"double","description":"Number of days per week"},"hours_per_day":{"type":"number","format":"double","description":"Number of hours per day"},"probation_period":{"type":["number","null"],"format":"double","description":"Number of days for probation period"},"paid_vacation_days":{"type":"number","format":"double","description":"Number of paid vacation days"}},"required":["type","days_per_week","hours_per_day","probation_period","paid_vacation_days"],"description":"Employment-related details for the contract, when applicable.","title":"ContractsPostResponsesContentApplicationJsonSchemaDataEmploymentDetails"},"ContractsPostResponsesContentApplicationJsonSchemaDataCompensationDetails":{"type":"object","properties":{"scale":{"type":"string","description":"Scale of compensation"},"amount":{"type":["string","null"],"description":"Amount of compensation"},"frequency":{"type":"string","description":"Frequency of compensation"},"currency_code":{"type":"string","description":"Currency code."},"first_payment":{"type":["string","null"],"description":"First payment"},"first_payment_date":{"type":["string","null"],"description":"Long date-time format following ISO-8601"},"gross_annual_salary":{"type":["string","null"],"description":"Gross annual salary"},"gross_signing_bonus":{"type":["string","null"],"description":"Gross signing bonus"},"gross_variable_bonus":{"type":["string","null"],"description":"Gross variable bonus"}},"required":["scale","amount","frequency","currency_code","first_payment","first_payment_date","gross_annual_salary","gross_signing_bonus","gross_variable_bonus"],"description":"Compensation configuration and payment schedule details for the contract.","title":"ContractsPostResponsesContentApplicationJsonSchemaDataCompensationDetails"},"ContractsPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","description":"The public id of the object"},"type":{"$ref":"#/components/schemas/ContractsPostResponsesContentApplicationJsonSchemaDataType","description":"Type of a contract"},"quote":{"$ref":"#/components/schemas/ContractsPostResponsesContentApplicationJsonSchemaDataQuote","description":"EOR quote approved by Deel"},"title":{"type":"string","description":"Title of a contract"},"client":{"oneOf":[{"$ref":"#/components/schemas/ContractsPostResponsesContentApplicationJsonSchemaDataClient"},{"type":"null"}],"description":"Client details associated with the contract."},"status":{"$ref":"#/components/schemas/ContractsPostResponsesContentApplicationJsonSchemaDataStatus","description":"Status of a contract in Deel workflow"},"worker":{"oneOf":[{"$ref":"#/components/schemas/ContractsPostResponsesContentApplicationJsonSchemaDataWorker"},{"type":"null"}],"description":"Worker details associated with the contract."},"job_title":{"type":"string","description":"Job title associated with the contract."},"seniority":{"oneOf":[{"$ref":"#/components/schemas/ContractsPostResponsesContentApplicationJsonSchemaDataSeniority"},{"type":"null"}],"description":"Seniority describes level of expertise at a job e.g. junior"},"created_at":{"type":["string","null"],"format":"date-time","description":"Long date-time format following ISO-8601"},"signatures":{"$ref":"#/components/schemas/ContractsPostResponsesContentApplicationJsonSchemaDataSignatures","description":"List of signatures recorded for this contract."},"start_date":{"type":["string","null"],"format":"date-time","description":"Long date-time format following ISO-8601"},"external_id":{"type":["string","null"],"description":"A unique identifier for the object provided by an external system."},"invitations":{"$ref":"#/components/schemas/ContractsPostResponsesContentApplicationJsonSchemaDataInvitations","description":"List of signature invitations sent for this contract."},"is_archived":{"type":"boolean","description":"Flag to indicate if the contract is archived"},"who_reports":{"$ref":"#/components/schemas/ContractsPostResponsesContentApplicationJsonSchemaDataWhoReports","description":"Flag to indicate who is supposed to provide regular reports"},"custom_fields":{"type":"array","items":{"$ref":"#/components/schemas/ContractsPostResponsesContentApplicationJsonSchemaDataCustomFieldsItems"},"description":"Custom fields attached to the contract."},"notice_period":{"type":"number","format":"double","default":10,"description":"Days before to notice the termination of contract for either party."},"scope_of_work":{"type":["string","null"],"description":"Scope of work for the contract"},"special_clause":{"type":"string","description":"Special clause for the contract"},"termination_date":{"$ref":"#/components/schemas/ContractsPostResponsesContentApplicationJsonSchemaDataTerminationDate","description":"Contract termination date. When present, it is a date-time string in ISO-8601 format."},"work_statement_id":{"type":"string","description":"The public unique identifier of the work statement"},"employment_details":{"$ref":"#/components/schemas/ContractsPostResponsesContentApplicationJsonSchemaDataEmploymentDetails","description":"Employment-related details for the contract, when applicable."},"compensation_details":{"$ref":"#/components/schemas/ContractsPostResponsesContentApplicationJsonSchemaDataCompensationDetails","description":"Compensation configuration and payment schedule details for the contract."}},"required":["id","type","title","client","status","worker","job_title","created_at","signatures","start_date","invitations","is_archived","special_clause","termination_date","work_statement_id","employment_details","compensation_details"],"title":"ContractsPostResponsesContentApplicationJsonSchemaData"},"contracts_createICContract_Response_201":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ContractsPostResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"contracts_createICContract_Response_201"},"ContractsPostResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"message":{"type":"string","description":"Error response"}},"required":["message"],"title":"ContractsPostResponsesContentApplicationJsonSchemaErrorsItems"},"ContractsPostResponsesContentApplicationJsonSchemaRequest":{"type":"object","properties":{"method":{"type":"string","description":"Method of the API"},"status":{"type":"number","format":"double","description":"Status of API response"}},"description":"Error request details","title":"ContractsPostResponsesContentApplicationJsonSchemaRequest"},"CreateANewContract-v2026-01-01RequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ContractsPostResponsesContentApplicationJsonSchemaErrorsItems"},"description":"Error messages"},"request":{"$ref":"#/components/schemas/ContractsPostResponsesContentApplicationJsonSchemaRequest","description":"Error request details"}},"required":["errors"],"title":"CreateANewContract-v2026-01-01RequestBadRequestError"},"EquityExercisePostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the equity exercise request."},"status":{"type":"string","description":"The initial status of the newly created equity exercise request."},"created_at":{"type":"string","format":"date-time","description":"ISO 8601 timestamp when the equity exercise request was created."},"updated_at":{"type":"string","format":"date-time","description":"ISO 8601 timestamp when the equity exercise request was last updated."}},"required":["id","status","created_at","updated_at"],"title":"EquityExercisePostResponsesContentApplicationJsonSchemaData"},"Contracts_createARequestToExerciseEquity-v2026-01-01_Response_201":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EquityExercisePostResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"Contracts_createARequestToExerciseEquity-v2026-01-01_Response_201"},"EquityExercisePostResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"message":{"type":"string","description":"General error description for logging and debugging."}},"required":["message"],"title":"EquityExercisePostResponsesContentApplicationJsonSchemaErrorsItems"},"CreateARequestToExerciseEquity-v2026-01-01RequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EquityExercisePostResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"CreateARequestToExerciseEquity-v2026-01-01RequestBadRequestError"},"CreateARequestToExerciseEquity-v2026-01-01RequestUnauthorizedError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EquityExercisePostResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"CreateARequestToExerciseEquity-v2026-01-01RequestUnauthorizedError"},"CreateARequestToExerciseEquity-v2026-01-01RequestForbiddenError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EquityExercisePostResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"CreateARequestToExerciseEquity-v2026-01-01RequestForbiddenError"},"CreateARequestToExerciseEquity-v2026-01-01RequestNotFoundError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EquityExercisePostResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"CreateARequestToExerciseEquity-v2026-01-01RequestNotFoundError"},"CreateARequestToExerciseEquity-v2026-01-01RequestUnprocessableEntityError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EquityExercisePostResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"CreateARequestToExerciseEquity-v2026-01-01RequestUnprocessableEntityError"},"CreateARequestToExerciseEquity-v2026-01-01RequestTooManyRequestsError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EquityExercisePostResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"CreateARequestToExerciseEquity-v2026-01-01RequestTooManyRequestsError"},"CreateARequestToExerciseEquity-v2026-01-01RequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EquityExercisePostResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"CreateARequestToExerciseEquity-v2026-01-01RequestInternalServerError"},"ContractsContractIdEquityWithholdingEstimateGetResponsesContentApplicationJsonSchemaDataBreakdownItems":{"type":"object","properties":{"name":{"type":"string","description":"Name of withholding component."},"rate":{"type":"string","description":"Withholding amount of component expressed as a percentage of event value."},"amount":{"type":"string","description":"Withholding amount of component."}},"title":"ContractsContractIdEquityWithholdingEstimateGetResponsesContentApplicationJsonSchemaDataBreakdownItems"},"ContractsContractIdEquityWithholdingEstimateGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"oid":{"type":"string","description":"Deel contract id."},"fx_rate":{"type":"string","description":"Exchange rate used to convert event currency to country of taxation currency."},"breakdown":{"type":"array","items":{"$ref":"#/components/schemas/ContractsContractIdEquityWithholdingEstimateGetResponsesContentApplicationJsonSchemaDataBreakdownItems"}},"event_value":{"type":"string","description":"Event value that user provided."},"event_currency":{"type":"string","description":"Event currency that user provided."},"withholding_currency":{"type":"string","description":"Country of taxation currency."},"aggregate_withholding_rate":{"type":"string","description":"Total withholding amount expressed as a percentage of event value."},"overall_withholding_amount":{"type":"string","description":"Total withholding amount denominated in country of taxation currency (withholding_currency)."}},"title":"ContractsContractIdEquityWithholdingEstimateGetResponsesContentApplicationJsonSchemaData"},"Contracts_getContractEquityWithholdingAmount_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ContractsContractIdEquityWithholdingEstimateGetResponsesContentApplicationJsonSchemaData"}},"title":"Contracts_getContractEquityWithholdingAmount_Response_200"},"GetContractEquityWithholdingAmountRequestBadRequestError":{"type":"object","properties":{},"title":"GetContractEquityWithholdingAmountRequestBadRequestError"},"GetContractEquityWithholdingAmountRequestNotFoundError":{"type":"object","properties":{},"title":"GetContractEquityWithholdingAmountRequestNotFoundError"},"ContractsGetParametersOrderDirection":{"type":"string","enum":["asc","desc"],"title":"ContractsGetParametersOrderDirection"},"ContractsGetParametersTypesSchemaItems":{"type":"string","enum":["ongoing_time_based","milestones","time_based","pay_as_you_go_time_based","commission","payg_milestones","payg_tasks","eor","peo","unknown","employee","global_payroll","shield_msa","hris_direct_employee","contractor_outside_deel"],"description":"Type of a contract.","title":"ContractsGetParametersTypesSchemaItems"},"ContractsGetParametersStatusesSchemaItems":{"type":"string","enum":["new","under_review","waiting_for_employee_contract","waiting_for_client_sign","processing_payment","waiting_for_contractor_sign","waiting_for_eor_sign","waiting_for_employee_sign","awaiting_deposit_payment","in_progress","completed","cancelled","user_cancelled","rejected","waiting_for_client_payment","onboarding","onboarded"],"description":"Status of a contract in Deel workflow.","title":"ContractsGetParametersStatusesSchemaItems"},"ContractsGetParametersCurrencies":{"oneOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}],"title":"ContractsGetParametersCurrencies"},"ContractsGetParametersSortBy":{"type":"string","enum":["contract_title","worker_name"],"title":"ContractsGetParametersSortBy"},"ContractsGetParametersExpand":{"type":"string","enum":["cost_centers"],"title":"ContractsGetParametersExpand"},"ContractsGetResponsesContentApplicationJsonSchemaDataItemsType":{"type":"string","enum":["ongoing_time_based","milestones","time_based","pay_as_you_go_time_based","commission","payg_milestones","payg_tasks","eor","unknown","peo","employee","global_payroll","shield_msa","hris_direct_employee","contractor_outside_deel"],"description":"Type of a contract.","title":"ContractsGetResponsesContentApplicationJsonSchemaDataItemsType"},"ContractsGetResponsesContentApplicationJsonSchemaDataItemsClientTeam":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of this resource."},"name":{"type":["string","null"],"description":"Name of a team."}},"required":["id","name"],"description":"Team information for the client.","title":"ContractsGetResponsesContentApplicationJsonSchemaDataItemsClientTeam"},"ContractsGetResponsesContentApplicationJsonSchemaDataItemsClient":{"type":"object","properties":{"team":{"$ref":"#/components/schemas/ContractsGetResponsesContentApplicationJsonSchemaDataItemsClientTeam","description":"Team information for the client."}},"description":"Client information associated with the contract.","title":"ContractsGetResponsesContentApplicationJsonSchemaDataItemsClient"},"ContractsGetResponsesContentApplicationJsonSchemaDataItemsStatus":{"type":"string","enum":["new","under_review","waiting_for_approval","waiting_for_employee_contract","waiting_for_client_sign","processing_payment","waiting_for_contractor_sign","waiting_for_eor_sign","waiting_for_employee_sign","waiting_for_hris_employee_sign","awaiting_deposit_payment","in_progress","completed","cancelled","user_cancelled","rejected","waiting_for_client_payment","onboarding","onboarded"],"description":"Status of a contract in Deel workflow.","title":"ContractsGetResponsesContentApplicationJsonSchemaDataItemsStatus"},"ContractsGetResponsesContentApplicationJsonSchemaDataItemsWorkerAlternateEmailItems":{"type":"object","properties":{"email":{"type":["string","null"],"format":"email","description":"User's email address."},"isVerified":{"type":"boolean","description":"Indicates whether the alternate email address is verified."}},"description":"Alternate email address object.","title":"ContractsGetResponsesContentApplicationJsonSchemaDataItemsWorkerAlternateEmailItems"},"ContractsGetResponsesContentApplicationJsonSchemaDataItemsWorker":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of this resource."},"email":{"type":["string","null"],"description":"User's email address."},"image":{"type":["string","null"],"format":"uri","description":"URL of the worker's profile image."},"full_name":{"type":"string","description":"Full name of the worker."},"alternate_email":{"type":"array","items":{"$ref":"#/components/schemas/ContractsGetResponsesContentApplicationJsonSchemaDataItemsWorkerAlternateEmailItems"},"description":"List of alternate email addresses."}},"required":["id"],"description":"Worker information associated with the contract.","title":"ContractsGetResponsesContentApplicationJsonSchemaDataItemsWorker"},"ContractsGetResponsesContentApplicationJsonSchemaDataItemsSignatures":{"type":"object","properties":{"client_signed_at":{"type":["string","null"],"format":"date-time","description":"Timestamp when the client signed the contract, in ISO-8601 format."},"worker_signature":{"type":["string","null"],"description":"Worker's signature."},"worker_signed_at":{"type":["string","null"],"format":"date-time","description":"Timestamp when the worker signed the contract, in ISO-8601 format."}},"required":["client_signed_at","worker_signature","worker_signed_at"],"description":"Signature information for the contract.","title":"ContractsGetResponsesContentApplicationJsonSchemaDataItemsSignatures"},"ContractsGetResponsesContentApplicationJsonSchemaDataItemsInvitations":{"type":"object","properties":{"client_email":{"type":["string","null"],"description":"Email address of the client to invite."},"worker_email":{"type":["string","null"],"description":"Email address of the worker to invite."}},"description":"Details of invitations sent for signing the contract.","title":"ContractsGetResponsesContentApplicationJsonSchemaDataItemsInvitations"},"ContractsGetResponsesContentApplicationJsonSchemaDataItemsWhoReports":{"type":"string","enum":["both","client","contractor"],"description":"Indicates who is responsible for providing regular reports.","title":"ContractsGetResponsesContentApplicationJsonSchemaDataItemsWhoReports"},"ContractsGetResponsesContentApplicationJsonSchemaDataItemsCostCentersItems":{"type":"object","properties":{"name":{"type":"string","description":"Cost center name."},"number":{"type":"string","description":"Cost center number."},"allocation_percentage":{"type":"number","format":"double","description":"Percentage of the cost center allocation."}},"description":"Cost center object.","title":"ContractsGetResponsesContentApplicationJsonSchemaDataItemsCostCentersItems"},"ContractsGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"id":{"type":"string","description":"UUID of the contract."},"type":{"$ref":"#/components/schemas/ContractsGetResponsesContentApplicationJsonSchemaDataItemsType","description":"Type of a contract."},"scale":{"type":["string","null"],"description":"The payment scale (e.g., hourly, weekly, monthly, etc.)."},"title":{"type":"string","description":"Title of the contract."},"client":{"$ref":"#/components/schemas/ContractsGetResponsesContentApplicationJsonSchemaDataItemsClient","description":"Client information associated with the contract."},"status":{"$ref":"#/components/schemas/ContractsGetResponsesContentApplicationJsonSchemaDataItemsStatus","description":"Status of a contract in Deel workflow."},"worker":{"oneOf":[{"$ref":"#/components/schemas/ContractsGetResponsesContentApplicationJsonSchemaDataItemsWorker"},{"type":"null"}],"description":"Worker information associated with the contract."},"created_at":{"type":["string","null"],"format":"date-time","description":"Timestamp when the contract was created, in ISO-8601 format."},"signatures":{"$ref":"#/components/schemas/ContractsGetResponsesContentApplicationJsonSchemaDataItemsSignatures","description":"Signature information for the contract."},"external_id":{"type":["string","null"],"description":"A unique identifier for the object provided by an external system."},"invitations":{"$ref":"#/components/schemas/ContractsGetResponsesContentApplicationJsonSchemaDataItemsInvitations","description":"Details of invitations sent for signing the contract."},"is_archived":{"type":"boolean","description":"Indicates whether the contract is archived."},"is_shielded":{"type":"boolean","description":"Indicates whether the contract is shielded."},"who_reports":{"$ref":"#/components/schemas/ContractsGetResponsesContentApplicationJsonSchemaDataItemsWhoReports","description":"Indicates who is responsible for providing regular reports."},"cost_centers":{"type":"array","items":{"$ref":"#/components/schemas/ContractsGetResponsesContentApplicationJsonSchemaDataItemsCostCentersItems"},"description":"List of cost centers associated with the contract."},"notice_period":{"type":"number","format":"double","default":0,"description":"Number of days required to give notice before terminating the contract."},"termination_date":{"type":["string","null"],"format":"date-time","description":"Date when the contract is terminated, in ISO-8601 format."}},"required":["id","type","title","client","status","created_at","signatures","invitations","is_archived","is_shielded","termination_date"],"title":"ContractsGetResponsesContentApplicationJsonSchemaDataItems"},"ContractsGetResponsesContentApplicationJsonSchemaPage":{"type":"object","properties":{"cursor":{"type":"string","description":"Cursor for paginated results."},"total_rows":{"type":"number","format":"double","description":"Total number of rows in the result set."}},"required":["cursor","total_rows"],"description":"Pagination information for the response.","title":"ContractsGetResponsesContentApplicationJsonSchemaPage"},"contracts_getContracts_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ContractsGetResponsesContentApplicationJsonSchemaDataItems"},"description":"Array of contract objects."},"page":{"$ref":"#/components/schemas/ContractsGetResponsesContentApplicationJsonSchemaPage","description":"Pagination information for the response."}},"required":["data","page"],"title":"contracts_getContracts_Response_200"},"ContractsGetResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"message":{"type":"string","description":"Error response"}},"required":["message"],"title":"ContractsGetResponsesContentApplicationJsonSchemaErrorsItems"},"ContractsGetResponsesContentApplicationJsonSchemaRequest":{"type":"object","properties":{"method":{"type":"string","description":"Method of the API"},"status":{"type":"number","format":"double","description":"Status of API response"}},"description":"Error request details","title":"ContractsGetResponsesContentApplicationJsonSchemaRequest"},"ListOfContractsRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ContractsGetResponsesContentApplicationJsonSchemaErrorsItems"},"description":"Error messages"},"request":{"$ref":"#/components/schemas/ContractsGetResponsesContentApplicationJsonSchemaRequest","description":"Error request details"}},"required":["errors"],"title":"ListOfContractsRequestBadRequestError"},"Contracts_rejectContract_Response_204":{"type":"object","properties":{},"description":"Empty response body","title":"Contracts_rejectContract_Response_204"},"WorkersContractsContractIdRejectPostResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code"},"message":{"type":"string","description":"Human-readable explanation of the error"}},"title":"WorkersContractsContractIdRejectPostResponsesContentApplicationJsonSchemaErrorsItems"},"RejectContractRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/WorkersContractsContractIdRejectPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"RejectContractRequestBadRequestError"},"RejectContractRequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/WorkersContractsContractIdRejectPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"RejectContractRequestInternalServerError"},"ContractsContractIdGetParametersExpand":{"type":"string","enum":["cost_centers"],"title":"ContractsContractIdGetParametersExpand"},"ContractsContractIdGetResponsesContentApplicationJsonSchemaDataType":{"type":"string","enum":["ongoing_time_based","milestones","time_based","pay_as_you_go_time_based","commission","payg_milestones","payg_tasks","contractor_outside_deel","eor","unknown","employee","global_payroll","shield_msa","hris_direct_employee","peo"],"description":"Type of a contract.","title":"ContractsContractIdGetResponsesContentApplicationJsonSchemaDataType"},"ContractsContractIdGetResponsesContentApplicationJsonSchemaDataQuoteBenefitsItems":{"type":"object","properties":{"fee":{"type":"number","format":"double","description":"Fee in local currency."},"name":{"type":"string","description":"Benefit's name."},"plan":{"type":"string","description":"Benefit's plan."},"price":{"type":"number","format":"double","description":"Price in local currency."},"fee_usd":{"type":"number","format":"double","description":"Fee in USD."},"currency":{"type":"string","description":"Currency code."},"price_usd":{"type":"number","format":"double","description":"Price in USD."}},"title":"ContractsContractIdGetResponsesContentApplicationJsonSchemaDataQuoteBenefitsItems"},"ContractsContractIdGetResponsesContentApplicationJsonSchemaDataQuote":{"type":"object","properties":{"benefits":{"type":"array","items":{"$ref":"#/components/schemas/ContractsContractIdGetResponsesContentApplicationJsonSchemaDataQuoteBenefitsItems"},"description":"Array of benefits."},"currency":{"type":"string","description":"Currency used for the quote."}},"description":"EOR quote approved by Deel.","title":"ContractsContractIdGetResponsesContentApplicationJsonSchemaDataQuote"},"ContractsContractIdGetResponsesContentApplicationJsonSchemaDataClientTeamId":{"oneOf":[{"type":"string"},{"type":"number","format":"double"}],"description":"Unique identifier of this resource.","title":"ContractsContractIdGetResponsesContentApplicationJsonSchemaDataClientTeamId"},"ContractsContractIdGetResponsesContentApplicationJsonSchemaDataClientTeam":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ContractsContractIdGetResponsesContentApplicationJsonSchemaDataClientTeamId","description":"Unique identifier of this resource."},"name":{"type":"string","description":"Name of a team."}},"required":["id","name"],"description":"Team information for the client organization.","title":"ContractsContractIdGetResponsesContentApplicationJsonSchemaDataClientTeam"},"ContractsContractIdGetResponsesContentApplicationJsonSchemaDataClientLegalEntity":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of this resource."},"name":{"type":"string","description":"Name of a team."},"type":{"type":["string","null"],"description":"Type of the legal entity."},"email":{"type":["string","null"],"description":"Email address of the legal entity."},"subtype":{"type":["string","null"],"description":"Sub-type of the legal entity."},"vat_number":{"type":["string","null"],"description":"VAT number of the legal entity."},"registration_number":{"type":["string","null"],"description":"Registration number of the legal entity."}},"description":"Legal entity details of the client.","title":"ContractsContractIdGetResponsesContentApplicationJsonSchemaDataClientLegalEntity"},"ContractsContractIdGetResponsesContentApplicationJsonSchemaDataClient":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of this resource."},"team":{"$ref":"#/components/schemas/ContractsContractIdGetResponsesContentApplicationJsonSchemaDataClientTeam","description":"Team information for the client organization."},"email":{"type":["string","null"],"format":"email","description":"User's email address."},"full_name":{"type":"string","description":"Full name of the client."},"legal_entity":{"oneOf":[{"$ref":"#/components/schemas/ContractsContractIdGetResponsesContentApplicationJsonSchemaDataClientLegalEntity"},{"type":"null"}],"description":"Legal entity details of the client."}},"required":["team"],"description":"Client details associated with the contract.","title":"ContractsContractIdGetResponsesContentApplicationJsonSchemaDataClient"},"ContractsContractIdGetResponsesContentApplicationJsonSchemaDataStatus":{"type":"string","enum":["new","under_review","waiting_for_employee_contract","waiting_for_client_sign","processing_payment","waiting_for_contractor_sign","waiting_for_eor_sign","waiting_for_employee_sign","awaiting_deposit_payment","in_progress","completed","cancelled","user_cancelled","rejected","waiting_for_client_payment","onboarding","waiting_for_approval","onboarded"],"description":"Status of a contract in Deel workflow.","title":"ContractsContractIdGetResponsesContentApplicationJsonSchemaDataStatus"},"ContractsContractIdGetResponsesContentApplicationJsonSchemaDataWorkerDateOfBirth":{"oneOf":[{"type":"string","format":"date"},{"type":"string"}],"title":"ContractsContractIdGetResponsesContentApplicationJsonSchemaDataWorkerDateOfBirth"},"ContractsContractIdGetResponsesContentApplicationJsonSchemaDataWorkerAlternateEmailItems":{"type":"object","properties":{"email":{"type":"string","description":"Email address of the worker."},"isVerified":{"type":"boolean","description":"Indicates whether this alternate email address has been verified."}},"title":"ContractsContractIdGetResponsesContentApplicationJsonSchemaDataWorkerAlternateEmailItems"},"ContractsContractIdGetResponsesContentApplicationJsonSchemaDataWorker":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of this resource."},"email":{"type":["string","null"],"format":"email","description":"User's email address."},"country":{"type":["string","null"],"description":"Country of the worker."},"full_name":{"type":"string","description":"Full name of the client."},"last_name":{"type":"string","description":"Last name of the worker."},"first_name":{"type":"string","description":"First name of the worker."},"nationality":{"type":["string","null"],"description":"Nationality of the worker."},"date_of_birth":{"$ref":"#/components/schemas/ContractsContractIdGetResponsesContentApplicationJsonSchemaDataWorkerDateOfBirth"},"expected_email":{"type":"string","description":"Expected email address of the worker (e.g., invitation target email)."},"alternate_email":{"type":["array","null"],"items":{"$ref":"#/components/schemas/ContractsContractIdGetResponsesContentApplicationJsonSchemaDataWorkerAlternateEmailItems"},"description":"List of alternate email addresses."}},"description":"Worker details associated with the contract.","title":"ContractsContractIdGetResponsesContentApplicationJsonSchemaDataWorker"},"ContractsContractIdGetResponsesContentApplicationJsonSchemaDataSeniority":{"type":"object","properties":{"id":{"type":["number","null"],"format":"double","description":"Unique identifier of this resource."},"name":{"type":["string","null"],"description":"Name of seniority level e.g. Mid (Individual Contributor Level 2)."},"level":{"type":["number","null"],"format":"double","description":"Level of seniority level e.g. 2."}},"description":"Seniority describes level of expertise at a job e.g. junior.","title":"ContractsContractIdGetResponsesContentApplicationJsonSchemaDataSeniority"},"ContractsContractIdGetResponsesContentApplicationJsonSchemaDataSignatures":{"type":"object","properties":{"signed_at":{"type":["string","null"],"format":"date-time","description":"Date and time when the contract was signed."},"client_signature":{"type":"string","description":"Client representative signature (typically a name)."},"client_signed_at":{"type":["string","null"],"format":"date-time","description":"Date and time when the client signed the contract."},"worker_signature":{"type":"string","description":"Worker signature (typically a name)."},"worker_signed_at":{"type":["string","null"],"format":"date-time","description":"Date and time when the worker signed the contract."}},"description":"Signature information for the contract parties.","title":"ContractsContractIdGetResponsesContentApplicationJsonSchemaDataSignatures"},"ContractsContractIdGetResponsesContentApplicationJsonSchemaDataInvitations":{"type":"object","properties":{"client_email":{"type":["string","null"],"description":"User's email address."},"worker_email":{"type":["string","null"],"description":"User's email address."}},"description":"Invitation email addresses for signing the contract.","title":"ContractsContractIdGetResponsesContentApplicationJsonSchemaDataInvitations"},"ContractsContractIdGetResponsesContentApplicationJsonSchemaDataCostCentersItems":{"type":"object","properties":{"name":{"type":"string","description":"Cost center name."},"number":{"type":"string","description":"Cost center number."},"allocation_percentage":{"type":"number","format":"double","description":"Percentage of the cost center allocation."}},"title":"ContractsContractIdGetResponsesContentApplicationJsonSchemaDataCostCentersItems"},"ContractsContractIdGetResponsesContentApplicationJsonSchemaDataCustomFieldsItems":{"type":"object","properties":{"id":{"type":["string","null"],"description":"Unique identifier of the custom field."},"name":{"type":"string","description":"Custom field property name."},"value":{"type":"string","description":"Custom field property value."}},"description":"Customized attributes on contracts (Employee ID, Project code, etc).","title":"ContractsContractIdGetResponsesContentApplicationJsonSchemaDataCustomFieldsItems"},"ContractsContractIdGetResponsesContentApplicationJsonSchemaDataWorkScheduleDaysItemsDay":{"type":"string","enum":["MONDAY","TUESDAY","WEDNESDAY","THURSDAY","FRIDAY","SATURDAY","SUNDAY"],"description":"Day of the week","title":"ContractsContractIdGetResponsesContentApplicationJsonSchemaDataWorkScheduleDaysItemsDay"},"ContractsContractIdGetResponsesContentApplicationJsonSchemaDataWorkScheduleDaysItems":{"type":"object","properties":{"day":{"$ref":"#/components/schemas/ContractsContractIdGetResponsesContentApplicationJsonSchemaDataWorkScheduleDaysItemsDay","description":"Day of the week"},"end":{"type":["string","null"],"format":"time","description":"End time for the work day (HH:MM:SS format)"},"start":{"type":"string","format":"time","description":"Start time for the work day (HH:MM:SS format)"},"work_hours":{"type":"number","format":"double","description":"Number of working hours for this day"}},"required":["day","end","start","work_hours"],"description":"Defines working hours for a specific day of the week","title":"ContractsContractIdGetResponsesContentApplicationJsonSchemaDataWorkScheduleDaysItems"},"ContractsContractIdGetResponsesContentApplicationJsonSchemaDataWorkScheduleWorkerTypesItems":{"type":"string","enum":["SALARIED_DIRECT_EMPLOYEE_PAYROLL","SALARIED_HRIS_DIRECT_EMPLOYEE","SALARIED_EOR_EMPLOYEE","HOURLY_EOR_EMPLOYEE","HOURLY_DIRECT_EMPLOYEE_PAYROLL"],"title":"ContractsContractIdGetResponsesContentApplicationJsonSchemaDataWorkScheduleWorkerTypesItems"},"ContractsContractIdGetResponsesContentApplicationJsonSchemaDataWorkScheduleEmploymentType":{"type":"string","enum":["FULL_TIME","PART_TIME","CONTRACT","TEMPORARY"],"description":"Type of employment arrangement","title":"ContractsContractIdGetResponsesContentApplicationJsonSchemaDataWorkScheduleEmploymentType"},"ContractsContractIdGetResponsesContentApplicationJsonSchemaDataWorkSchedule":{"type":"object","properties":{"days":{"type":"array","items":{"$ref":"#/components/schemas/ContractsContractIdGetResponsesContentApplicationJsonSchemaDataWorkScheduleDaysItems"},"description":"Working days and hours configuration"},"name":{"type":"string","description":"Unique identifier or name for the work schedule"},"country":{"type":"string","description":"Country code where this work schedule applies (ISO 3166-1 alpha-2)"},"worker_types":{"type":"array","items":{"$ref":"#/components/schemas/ContractsContractIdGetResponsesContentApplicationJsonSchemaDataWorkScheduleWorkerTypesItems"},"description":"List of worker types that can use this schedule"},"employment_type":{"oneOf":[{"$ref":"#/components/schemas/ContractsContractIdGetResponsesContentApplicationJsonSchemaDataWorkScheduleEmploymentType"},{"type":"null"}],"description":"Type of employment arrangement"},"work_schedule_type":{"type":"string","description":"Work schedule type"},"work_hours_per_week":{"type":"integer","description":"Total number of working hours per week"}},"required":["days","name","country","worker_types","work_schedule_type","work_hours_per_week"],"description":"Defines a work schedule including working days, hours, and employment details","title":"ContractsContractIdGetResponsesContentApplicationJsonSchemaDataWorkSchedule"},"ContractsContractIdGetResponsesContentApplicationJsonSchemaDataEmploymentType":{"type":"string","enum":["FULL_TIME","PART_TIME"],"description":"Type of employment.","title":"ContractsContractIdGetResponsesContentApplicationJsonSchemaDataEmploymentType"},"ContractsContractIdGetResponsesContentApplicationJsonSchemaDataContractTemplate":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of a contract template."},"title":{"type":"string","description":"Title of a contract template"}},"description":"Contract template details.","title":"ContractsContractIdGetResponsesContentApplicationJsonSchemaDataContractTemplate"},"ContractsContractIdGetResponsesContentApplicationJsonSchemaDataEmploymentDetails":{"type":"object","properties":{"type":{"type":"string","description":"Type of employment."},"days_per_week":{"type":"number","format":"double","description":"Number of days per week."},"hours_per_day":{"type":"number","format":"double","description":"Number of hours per day."},"probation_period":{"type":["number","null"],"format":"double","description":"Probation period in days."},"paid_vacation_days":{"type":"number","format":"double","description":"Number of paid vacation days."}},"description":"Employment-related details for the contract.","title":"ContractsContractIdGetResponsesContentApplicationJsonSchemaDataEmploymentDetails"},"ContractsContractIdGetResponsesContentApplicationJsonSchemaDataCompensationDetailsCycleEndType":{"type":"string","enum":["DAY_OF_WEEK","DAY_OF_LAST_WEEK","DAY_OF_MONTH"],"description":" Cycle end type","title":"ContractsContractIdGetResponsesContentApplicationJsonSchemaDataCompensationDetailsCycleEndType"},"ContractsContractIdGetResponsesContentApplicationJsonSchemaDataCompensationDetails":{"type":"object","properties":{"scale":{"type":["string","null"],"description":"Scale of the payment."},"amount":{"type":["string","null"],"description":"Amount to be paid. This field can be excluded when creating a Pay-as-you-go task-based or Milestone contracts."},"cycle_end":{"type":["number","null"],"format":"double","description":"Day of the cycle end"},"frequency":{"type":"string","description":"Scale of the invoice cycle."},"currency_code":{"type":["string","null"],"description":"Currency code."},"first_payment":{"type":["string","null"],"description":"First payment amount."},"cycle_end_type":{"oneOf":[{"$ref":"#/components/schemas/ContractsContractIdGetResponsesContentApplicationJsonSchemaDataCompensationDetailsCycleEndType"},{"type":"null"}],"description":" Cycle end type"},"first_payment_date":{"type":["string","null"],"description":"First payment date."},"gross_annual_salary":{"type":["string","null"],"description":"Gross annual salary."},"gross_signing_bonus":{"type":["string","null"],"description":"Gross signing bonus."},"gross_variable_bonus":{"type":["string","null"],"description":"Gross variable bonus."}},"description":"Compensation and payment configuration for the contract.","title":"ContractsContractIdGetResponsesContentApplicationJsonSchemaDataCompensationDetails"},"ContractsContractIdGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the contract."},"type":{"$ref":"#/components/schemas/ContractsContractIdGetResponsesContentApplicationJsonSchemaDataType","description":"Type of a contract."},"quote":{"$ref":"#/components/schemas/ContractsContractIdGetResponsesContentApplicationJsonSchemaDataQuote","description":"EOR quote approved by Deel."},"title":{"type":"string","description":"Title of the contract."},"client":{"oneOf":[{"$ref":"#/components/schemas/ContractsContractIdGetResponsesContentApplicationJsonSchemaDataClient"},{"type":"null"}],"description":"Client details associated with the contract."},"status":{"$ref":"#/components/schemas/ContractsContractIdGetResponsesContentApplicationJsonSchemaDataStatus","description":"Status of a contract in Deel workflow."},"worker":{"oneOf":[{"$ref":"#/components/schemas/ContractsContractIdGetResponsesContentApplicationJsonSchemaDataWorker"},{"type":"null"}],"description":"Worker details associated with the contract."},"location":{"type":["string","null"],"description":"Location name associated with the contract."},"job_title":{"type":"string","description":"Job title associated with the contract."},"seniority":{"oneOf":[{"$ref":"#/components/schemas/ContractsContractIdGetResponsesContentApplicationJsonSchemaDataSeniority"},{"type":"null"}],"description":"Seniority describes level of expertise at a job e.g. junior."},"created_at":{"type":"string","format":"date-time","description":"Date and time when the contract was created."},"signatures":{"$ref":"#/components/schemas/ContractsContractIdGetResponsesContentApplicationJsonSchemaDataSignatures","description":"Signature information for the contract parties."},"start_date":{"type":"string","format":"date-time","description":"Date and time when the contract starts."},"updated_at":{"type":"string","format":"date-time","description":"Date and time when the contract was updated."},"external_id":{"type":["string","null"],"description":"External identifier of the contract."},"invitations":{"$ref":"#/components/schemas/ContractsContractIdGetResponsesContentApplicationJsonSchemaDataInvitations","description":"Invitation email addresses for signing the contract."},"is_archived":{"type":["boolean","null"],"description":"Flag to indicate if the contract is archived."},"who_reports":{"type":"string","description":"Who reports the hours."},"cost_centers":{"type":"array","items":{"$ref":"#/components/schemas/ContractsContractIdGetResponsesContentApplicationJsonSchemaDataCostCentersItems"},"description":"List of cost centers associated with the contract."},"product_area":{"type":["number","null"],"format":"double","description":"Product area code associated with the contract."},"custom_fields":{"type":["array","null"],"items":{"$ref":"#/components/schemas/ContractsContractIdGetResponsesContentApplicationJsonSchemaDataCustomFieldsItems"},"description":"List of custom fields attached to the contract."},"notice_period":{"type":["number","null"],"format":"double","description":"Notice period in days."},"scope_of_work":{"type":["string","null"],"description":"Scope of work of the contract."},"work_schedule":{"oneOf":[{"$ref":"#/components/schemas/ContractsContractIdGetResponsesContentApplicationJsonSchemaDataWorkSchedule"},{"type":"null"}],"description":"Defines a work schedule including working days, hours, and employment details"},"special_clause":{"type":["string","null"],"description":"Special clause of the contract."},"employment_type":{"oneOf":[{"$ref":"#/components/schemas/ContractsContractIdGetResponsesContentApplicationJsonSchemaDataEmploymentType"},{"type":"null"}],"description":"Type of employment."},"termination_date":{"type":["string","null"],"description":"Date and time when the contract ends."},"contract_template":{"oneOf":[{"$ref":"#/components/schemas/ContractsContractIdGetResponsesContentApplicationJsonSchemaDataContractTemplate"},{"type":"null"}],"description":"Contract template details."},"work_statement_id":{"type":["string","null"],"description":"The unique identifier of the associated work statement."},"employment_details":{"$ref":"#/components/schemas/ContractsContractIdGetResponsesContentApplicationJsonSchemaDataEmploymentDetails","description":"Employment-related details for the contract."},"compensation_details":{"$ref":"#/components/schemas/ContractsContractIdGetResponsesContentApplicationJsonSchemaDataCompensationDetails","description":"Compensation and payment configuration for the contract."}},"required":["id","type","title","client","status","worker","created_at","signatures","start_date","updated_at","invitations","is_archived","special_clause","termination_date"],"title":"ContractsContractIdGetResponsesContentApplicationJsonSchemaData"},"contracts_getContract_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ContractsContractIdGetResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"contracts_getContract_Response_200"},"ContractsContractIdGetResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"message":{"type":"string","description":"Error response"}},"required":["message"],"title":"ContractsContractIdGetResponsesContentApplicationJsonSchemaErrorsItems"},"ContractsContractIdGetResponsesContentApplicationJsonSchemaRequest":{"type":"object","properties":{"method":{"type":"string","description":"Method of the API"},"status":{"type":"number","format":"double","description":"Status of API response"}},"description":"Error request details","title":"ContractsContractIdGetResponsesContentApplicationJsonSchemaRequest"},"RetrieveASingleContract-v2026-01-01RequestNotFoundError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ContractsContractIdGetResponsesContentApplicationJsonSchemaErrorsItems"},"description":"Error messages"},"request":{"$ref":"#/components/schemas/ContractsContractIdGetResponsesContentApplicationJsonSchemaRequest","description":"Error request details"}},"required":["errors"],"title":"RetrieveASingleContract-v2026-01-01RequestNotFoundError"},"WorkersContractsContractIdPdfGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"url":{"type":"string","format":"uri","description":"A pre-signed URL to download the PDF version of the specified contract"}},"required":["url"],"title":"WorkersContractsContractIdPdfGetResponsesContentApplicationJsonSchemaData"},"Contracts_retrieveContractPdfDownloadLink_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/WorkersContractsContractIdPdfGetResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"Contracts_retrieveContractPdfDownloadLink_Response_200"},"WorkersContractsContractIdPdfGetResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code"},"message":{"type":"string","description":"Human-readable explanation of the error"}},"title":"WorkersContractsContractIdPdfGetResponsesContentApplicationJsonSchemaErrorsItems"},"RetrieveContractPdfDownloadLinkRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/WorkersContractsContractIdPdfGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"RetrieveContractPdfDownloadLinkRequestBadRequestError"},"RetrieveContractPdfDownloadLinkRequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/WorkersContractsContractIdPdfGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"RetrieveContractPdfDownloadLinkRequestInternalServerError"},"ContractTemplatesGetResponsesContentApplicationJsonSchemaDataItemsId":{"oneOf":[{"type":"string"},{"type":"integer","format":"int64"}],"title":"ContractTemplatesGetResponsesContentApplicationJsonSchemaDataItemsId"},"ContractTemplatesGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ContractTemplatesGetResponsesContentApplicationJsonSchemaDataItemsId"},"title":{"type":"string","description":"The title of a contract template."}},"required":["id","title"],"title":"ContractTemplatesGetResponsesContentApplicationJsonSchemaDataItems"},"Contracts_getContractTemplates_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ContractTemplatesGetResponsesContentApplicationJsonSchemaDataItems"}}},"title":"Contracts_getContractTemplates_Response_200"},"WorkersAmendmentsAmendmentIdSignPostRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"contractor_signature":{"type":"string","description":"The signature of the worker signing the amendment."}},"required":["contractor_signature"],"title":"WorkersAmendmentsAmendmentIdSignPostRequestBodyContentApplicationJsonSchemaData"},"WorkersAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the signed amendment."},"is_signed":{"type":"boolean","description":"Indicates whether the amendment was successfully signed."}},"required":["id","is_signed"],"title":"WorkersAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaData"},"Contracts_signAmendment_Response_201":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/WorkersAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"Contracts_signAmendment_Response_201"},"WorkersAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaErrorsItems":{"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":"WorkersAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaErrorsItems"},"WorkersAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaRequest":{"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":"WorkersAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaRequest"},"SignAmendmentRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/WorkersAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaErrorsItems"}},"request":{"$ref":"#/components/schemas/WorkersAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaRequest"}},"title":"SignAmendmentRequestBadRequestError"},"WorkersContractsContractIdSignaturesPostRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"worker_signature":{"type":"string","description":"Signature of the worker for the contract"}},"required":["worker_signature"],"title":"WorkersContractsContractIdSignaturesPostRequestBodyContentApplicationJsonSchemaData"},"WorkersContractsContractIdSignaturesPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the signed contract."},"is_signed":{"type":"boolean","description":"Indicates whether the contract was successfully signed."},"created_at":{"type":"string","format":"date-time","description":"The timestamp when the contract was created."},"updated_at":{"type":"string","format":"date-time","description":"The timestamp when the contract was last updated."}},"required":["id","is_signed","created_at","updated_at"],"title":"WorkersContractsContractIdSignaturesPostResponsesContentApplicationJsonSchemaData"},"Contracts_signWorkerContract_Response_201":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/WorkersContractsContractIdSignaturesPostResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"Contracts_signWorkerContract_Response_201"},"WorkersContractsContractIdSignaturesPostResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code"},"message":{"type":"string","description":"Human-readable explanation of the error"}},"title":"WorkersContractsContractIdSignaturesPostResponsesContentApplicationJsonSchemaErrorsItems"},"SignWorkerContractRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/WorkersContractsContractIdSignaturesPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"SignWorkerContractRequestBadRequestError"},"SignWorkerContractRequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/WorkersContractsContractIdSignaturesPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"SignWorkerContractRequestInternalServerError"},"EorEmploymentCostPostRequestBodyContentApplicationJsonSchemaDataBenefitsItems":{"type":"object","properties":{"plan_id":{"type":["string","null"],"description":"The ID of the benefits plan, if applicable."},"provider_id":{"type":"string","description":"The ID of the benefits provider."}},"required":["provider_id"],"title":"EorEmploymentCostPostRequestBodyContentApplicationJsonSchemaDataBenefitsItems"},"EorEmploymentCostPostRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"state":{"type":"string","description":"The state or region within the country, if applicable."},"salary":{"type":"number","format":"double","description":"The base salary for the employee."},"country":{"type":"string","description":"The full name of the country where the employee is based."},"benefits":{"type":["array","null"],"items":{"$ref":"#/components/schemas/EorEmploymentCostPostRequestBodyContentApplicationJsonSchemaDataBenefitsItems"},"description":"A list of selected benefit plans for the employee."},"currency":{"type":"string","description":"The currency in which the costs are calculated."},"country_code":{"type":"string","description":"The two-letter country code where the employee is based."}},"required":["salary","country","currency"],"title":"EorEmploymentCostPostRequestBodyContentApplicationJsonSchemaData"},"EorEmploymentCostPostResponsesContentApplicationJsonSchemaCostsItems":{"type":"object","properties":{"name":{"type":"string","description":"Name of the cost item."},"amount":{"type":"string","description":"Cost amount."},"country":{"type":"string","description":"The country of the cost item."},"frequency":{"type":"string","description":"The frequency of the cost (e.g., monthly, annually)."},"country_code":{"type":"string","description":"ISO Alpha-2 code of the country."}},"title":"EorEmploymentCostPostResponsesContentApplicationJsonSchemaCostsItems"},"EorEmploymentCostPostResponsesContentApplicationJsonSchemaBenefitsDataItems":{"type":"object","properties":{"name":{"type":"string","description":"Benefit name."},"plan":{"type":"string","description":"Benefit plan."},"amount":{"type":"string","description":"Benefit cost."},"fee_amount":{"type":"string","description":"Fees associated with the benefit."}},"title":"EorEmploymentCostPostResponsesContentApplicationJsonSchemaBenefitsDataItems"},"EorEmploymentCostPostResponsesContentApplicationJsonSchemaAdditionalData":{"type":"object","properties":{"additional_notes":{"type":"array","items":{"type":"string"}}},"title":"EorEmploymentCostPostResponsesContentApplicationJsonSchemaAdditionalData"},"cost-calculator_getEmploymentCost_Response_200":{"type":"object","properties":{"costs":{"type":"array","items":{"$ref":"#/components/schemas/EorEmploymentCostPostResponsesContentApplicationJsonSchemaCostsItems"}},"salary":{"type":"string","description":"The base salary for the employee."},"country":{"type":"string","description":"The country where the employee is based."},"currency":{"type":"string","description":"The currency used for cost calculation."},"deel_fee":{"type":"string","description":"The Deel fee for managing the employee."},"frequency":{"type":"string","description":"Frequency of the salary payment (e.g., monthly)."},"total_costs":{"type":"string","description":"Total employment costs."},"country_code":{"type":"string","description":"ISO Alpha-2 code of the country."},"benefits_data":{"type":"array","items":{"$ref":"#/components/schemas/EorEmploymentCostPostResponsesContentApplicationJsonSchemaBenefitsDataItems"}},"employer_costs":{"type":"string","description":"Costs incurred by the employer."},"additional_data":{"$ref":"#/components/schemas/EorEmploymentCostPostResponsesContentApplicationJsonSchemaAdditionalData"},"severance_accural":{"type":"string","description":"Severance accrual costs."}},"title":"cost-calculator_getEmploymentCost_Response_200"},"ContractsContractIdCostCentersPostRequestBodyContentApplicationJsonSchemaDataValueItems":{"type":"object","properties":{"cost_center_id":{"type":"integer","format":"int64","description":"Cost center id"},"allocation_percentage":{"type":"number","format":"double","description":"Cost center allocation for this employment, between 0 (none) and 1 (100%)"}},"required":["cost_center_id","allocation_percentage"],"title":"ContractsContractIdCostCentersPostRequestBodyContentApplicationJsonSchemaDataValueItems"},"ContractsContractIdCostCentersPostRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"value":{"type":"array","items":{"$ref":"#/components/schemas/ContractsContractIdCostCentersPostRequestBodyContentApplicationJsonSchemaDataValueItems"}},"effective_date":{"type":"string","format":"date","description":"Allocation start date"}},"required":["value","effective_date"],"title":"ContractsContractIdCostCentersPostRequestBodyContentApplicationJsonSchemaData"},"ContractsContractIdCostCentersPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","description":"Updated employment term id"}},"title":"ContractsContractIdCostCentersPostResponsesContentApplicationJsonSchemaData"},"Cost Centers_assignCostCentersToAnEmploymentContract-v2026-01-01_Response_201":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ContractsContractIdCostCentersPostResponsesContentApplicationJsonSchemaData"}},"title":"Cost Centers_assignCostCentersToAnEmploymentContract-v2026-01-01_Response_201"},"ContractsContractIdCostCentersPostResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"error":{"type":"string","description":"A description of the returned error"}},"title":"ContractsContractIdCostCentersPostResponsesContentApplicationJsonSchemaErrorsItems"},"ContractsContractIdCostCentersPostResponsesContentApplicationJsonSchemaRequest":{"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":"ContractsContractIdCostCentersPostResponsesContentApplicationJsonSchemaRequest"},"AssignCostCentersToAnEmploymentContract-v2026-01-01RequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ContractsContractIdCostCentersPostResponsesContentApplicationJsonSchemaErrorsItems"}},"request":{"$ref":"#/components/schemas/ContractsContractIdCostCentersPostResponsesContentApplicationJsonSchemaRequest"}},"title":"AssignCostCentersToAnEmploymentContract-v2026-01-01RequestBadRequestError"},"LegalEntitiesLegalEntityIdCostCentersGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"Cost center Id"},"created_at":{"type":"string","format":"date-time","description":"Cost center date of registration on Deel"},"updated_at":{"type":"string","format":"date-time","description":"Cost center date of most recent update on Deel"},"cost_center_name":{"type":"string","description":"Cost center name to be displayed"},"cost_center_number":{"type":"string","description":"Cost center code"}},"title":"LegalEntitiesLegalEntityIdCostCentersGetResponsesContentApplicationJsonSchemaDataItems"},"cost-centers_getLegalEntityCostCenters_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/LegalEntitiesLegalEntityIdCostCentersGetResponsesContentApplicationJsonSchemaDataItems"}}},"title":"cost-centers_getLegalEntityCostCenters_Response_200"},"LegalEntitiesLegalEntityIdCostCentersGetResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"number","format":"double","description":"The code of the source handler which produced the returned error"},"message":{"type":"string","description":"A description of the returned error"}},"title":"LegalEntitiesLegalEntityIdCostCentersGetResponsesContentApplicationJsonSchemaErrorsItems"},"LegalEntitiesLegalEntityIdCostCentersGetResponsesContentApplicationJsonSchemaRequest":{"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":"LegalEntitiesLegalEntityIdCostCentersGetResponsesContentApplicationJsonSchemaRequest"},"GetCostCentersByLegalEntityRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/LegalEntitiesLegalEntityIdCostCentersGetResponsesContentApplicationJsonSchemaErrorsItems"}},"request":{"$ref":"#/components/schemas/LegalEntitiesLegalEntityIdCostCentersGetResponsesContentApplicationJsonSchemaRequest"}},"title":"GetCostCentersByLegalEntityRequestBadRequestError"},"LegalEntitiesLegalEntityIdCostCentersSynchronizePostRequestBodyContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"cost_center_name":{"type":"string","description":"Cost center name to be displayed"},"cost_center_number":{"type":"string","description":"Cost center code"}},"required":["cost_center_name","cost_center_number"],"title":"LegalEntitiesLegalEntityIdCostCentersSynchronizePostRequestBodyContentApplicationJsonSchemaDataItems"},"LegalEntitiesLegalEntityIdCostCentersSynchronizePostResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"Cost center id"},"created_at":{"type":"string","format":"date-time","description":"Cost center date of registration on Deel. Long date-time format following ISO-8601"},"updated_at":{"type":"string","format":"date-time","description":"Cost center date of most recent update on Deel. Long date-time format following ISO-8601"},"cost_center_name":{"type":"string","description":"Cost center name to be displayed"},"cost_center_number":{"type":"string","description":"Cost center code"}},"title":"LegalEntitiesLegalEntityIdCostCentersSynchronizePostResponsesContentApplicationJsonSchemaDataItems"},"Cost Centers_syncCostCentersForLegalEntity-v2026-01-01_Response_201":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/LegalEntitiesLegalEntityIdCostCentersSynchronizePostResponsesContentApplicationJsonSchemaDataItems"}}},"title":"Cost Centers_syncCostCentersForLegalEntity-v2026-01-01_Response_201"},"LegalEntitiesLegalEntityIdCostCentersSynchronizePostResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"error":{"type":"string","description":"A description of the returned error"}},"title":"LegalEntitiesLegalEntityIdCostCentersSynchronizePostResponsesContentApplicationJsonSchemaErrorsItems"},"LegalEntitiesLegalEntityIdCostCentersSynchronizePostResponsesContentApplicationJsonSchemaRequest":{"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":"LegalEntitiesLegalEntityIdCostCentersSynchronizePostResponsesContentApplicationJsonSchemaRequest"},"SyncCostCentersForLegalEntity-v2026-01-01RequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/LegalEntitiesLegalEntityIdCostCentersSynchronizePostResponsesContentApplicationJsonSchemaErrorsItems"}},"request":{"$ref":"#/components/schemas/LegalEntitiesLegalEntityIdCostCentersSynchronizePostResponsesContentApplicationJsonSchemaRequest"}},"title":"SyncCostCentersForLegalEntity-v2026-01-01RequestBadRequestError"},"SyncCostCentersForLegalEntity-v2026-01-01RequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/LegalEntitiesLegalEntityIdCostCentersSynchronizePostResponsesContentApplicationJsonSchemaErrorsItems"}},"request":{"$ref":"#/components/schemas/LegalEntitiesLegalEntityIdCostCentersSynchronizePostResponsesContentApplicationJsonSchemaRequest"}},"title":"SyncCostCentersForLegalEntity-v2026-01-01RequestInternalServerError"},"custom-fields-contracts_deleteContractCustomField_Response_204":{"type":"object","properties":{},"description":"Empty response body","title":"custom-fields-contracts_deleteContractCustomField_Response_204"},"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"},"DaasPayslipsGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the payslip record."},"to":{"type":"string","format":"date-time","description":"End date of the payment period."},"url":{"type":"string","description":"URL"},"from":{"type":"string","format":"date-time","description":"Start date of the payment period."},"status":{"type":"string","description":"Status of the payslip (e.g., 'Pending', 'Processed')."},"created_at":{"type":"string","format":"date-time","description":"Creation date"},"updated_at":{"type":"string","format":"date-time","description":"Last update date"},"rejected_at":{"type":"string","format":"date-time","description":"Rejection date"},"uploaded_at":{"type":"string","format":"date-time","description":"Upload date"},"published_at":{"type":"string","format":"date-time","description":"Publish date"},"reject_reason":{"type":"string","description":"Rejection reason"},"schedule_publishing_date":{"type":"string","format":"date-time","description":"Scheduled for publishing date"}},"required":["id","to","url","from","status","created_at","updated_at","rejected_at","uploaded_at","published_at","reject_reason","schedule_publishing_date"],"title":"DaasPayslipsGetResponsesContentApplicationJsonSchemaDataItems"},"Deel As a Service_getEorEmployeePayslips_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/DaasPayslipsGetResponsesContentApplicationJsonSchemaDataItems"}}},"required":["data"],"title":"Deel As a Service_getEorEmployeePayslips_Response_200"},"DaasBanksBankIdPatchRequestBodyContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"key":{"type":"string","description":"The key of the bank account properties."},"value":{"type":"string","description":"The value for that key property."}},"required":["key","value"],"title":"DaasBanksBankIdPatchRequestBodyContentApplicationJsonSchemaDataItems"},"DaasBanksBankIdPatchResponsesContentApplicationJsonSchemaDataStatus":{"type":"string","enum":["new","pending","approved","failed"],"description":"Bank Account status","title":"DaasBanksBankIdPatchResponsesContentApplicationJsonSchemaDataStatus"},"DaasBanksBankIdPatchResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","description":"ID of Bank Account."},"status":{"$ref":"#/components/schemas/DaasBanksBankIdPatchResponsesContentApplicationJsonSchemaDataStatus","description":"Bank Account status"},"created_at":{"type":"string","format":"date-time","description":"Long date-time format following ISO-8601"},"updated_at":{"type":"string","format":"date-time","description":"Long date-time format following ISO-8601"}},"title":"DaasBanksBankIdPatchResponsesContentApplicationJsonSchemaData"},"Deel As a Service_patchEORBankAccount_Response_201":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/DaasBanksBankIdPatchResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"Deel As a Service_patchEORBankAccount_Response_201"},"EmployeeInfoContractTypesTypeCountriesCountryGetParametersType":{"type":"string","enum":["eor","gp"],"title":"EmployeeInfoContractTypesTypeCountriesCountryGetParametersType"},"EmployeeInfoContractTypesTypeCountriesCountryGetResponsesContentApplicationJsonSchemaDataItemsDependenciesItems":{"type":"object","properties":{"id":{"type":"string","description":"ID of the dependency"},"value":{"type":"string","description":"Value of the dependency"}},"title":"EmployeeInfoContractTypesTypeCountriesCountryGetResponsesContentApplicationJsonSchemaDataItemsDependenciesItems"},"EmployeeInfoContractTypesTypeCountriesCountryGetResponsesContentApplicationJsonSchemaDataItemsInputConfigurationFormat":{"type":"object","properties":{"pattern":{"type":"string","description":"Date format pattern"},"separator":{"type":"string","description":"Separator character for the format"}},"description":"Format configuration for the input","title":"EmployeeInfoContractTypesTypeCountriesCountryGetResponsesContentApplicationJsonSchemaDataItemsInputConfigurationFormat"},"EmployeeInfoContractTypesTypeCountriesCountryGetResponsesContentApplicationJsonSchemaDataItemsInputConfiguration":{"type":"object","properties":{"type":{"type":"string","description":"The configuration type matching the input type"},"format":{"$ref":"#/components/schemas/EmployeeInfoContractTypesTypeCountriesCountryGetResponsesContentApplicationJsonSchemaDataItemsInputConfigurationFormat","description":"Format configuration for the input"}},"description":"Configuration object for the input field. Present for input types that require additional format or display configuration, such as date fields.","title":"EmployeeInfoContractTypesTypeCountriesCountryGetResponsesContentApplicationJsonSchemaDataItemsInputConfiguration"},"EmployeeInfoContractTypesTypeCountriesCountryGetResponsesContentApplicationJsonSchemaDataItemsDependencyConditionMatchMode":{"type":"string","enum":["ALL","ANY"],"description":"Condition match mode for dependencies","title":"EmployeeInfoContractTypesTypeCountriesCountryGetResponsesContentApplicationJsonSchemaDataItemsDependencyConditionMatchMode"},"EmployeeInfoContractTypesTypeCountriesCountryGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the field"},"name":{"type":"string","description":"Name of the field"},"alias":{"type":"string","description":"Alias for the field"},"label":{"type":"string","description":"Label for the field"},"options":{"type":["array","null"],"items":{"type":"string"},"description":"Options for select input type"},"footnote":{"type":["string","null"],"description":"Footnote for the field"},"input_type":{"type":"string","description":"Type of input for the field"},"local_name":{"type":["string","null"],"description":"Local name for the field"},"description":{"type":["string","null"],"description":"Description of the field"},"is_optional":{"type":"boolean","description":"Indicates if the field is optional"},"required_by":{"type":"string","description":"Specifies when the field is required"},"dependencies":{"type":["array","null"],"items":{"$ref":"#/components/schemas/EmployeeInfoContractTypesTypeCountriesCountryGetResponsesContentApplicationJsonSchemaDataItemsDependenciesItems"},"description":"Dependencies for the field"},"display_order":{"type":["string","null"],"description":"Display order of the field"},"how_to_obtain":{"type":["string","null"],"description":"Instructions on how to obtain the field value"},"can_be_skipped":{"type":["boolean","null"],"description":"Indicates if the field can be skipped"},"link_to_obtain":{"type":["string","null"],"description":"Link to obtain the field value"},"validation_rule":{"type":["string","null"],"description":"Validation rule for the field"},"input_configuration":{"oneOf":[{"$ref":"#/components/schemas/EmployeeInfoContractTypesTypeCountriesCountryGetResponsesContentApplicationJsonSchemaDataItemsInputConfiguration"},{"type":"null"}],"description":"Configuration object for the input field. Present for input types that require additional format or display configuration, such as date fields."},"link_to_obtain_label":{"type":["string","null"],"description":"Label for the link to obtain the field value"},"validation_error_message":{"type":["string","null"],"description":"Validation error message for the field"},"dependency_condition_match_mode":{"oneOf":[{"$ref":"#/components/schemas/EmployeeInfoContractTypesTypeCountriesCountryGetResponsesContentApplicationJsonSchemaDataItemsDependencyConditionMatchMode"},{"type":"null"}],"description":"Condition match mode for dependencies"}},"title":"EmployeeInfoContractTypesTypeCountriesCountryGetResponsesContentApplicationJsonSchemaDataItems"},"Employee Information_employeeAdditionalInfoTemplate-v2026-01-01_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeInfoContractTypesTypeCountriesCountryGetResponsesContentApplicationJsonSchemaDataItems"}}},"title":"Employee Information_employeeAdditionalInfoTemplate-v2026-01-01_Response_200"},"EmployeeAdditionalInfoTemplate-v2026-01-01RequestBadRequestError":{"type":"object","properties":{},"title":"EmployeeAdditionalInfoTemplate-v2026-01-01RequestBadRequestError"},"EmployeeInfoContractTypesTypeCountriesCountryGetResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"message":{"type":"string","description":"Use this message for logging and debugging purposes. Contains a general error description."}},"required":["message"],"title":"EmployeeInfoContractTypesTypeCountriesCountryGetResponsesContentApplicationJsonSchemaErrorsItems"},"EmployeeAdditionalInfoTemplate-v2026-01-01RequestUnauthorizedError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeInfoContractTypesTypeCountriesCountryGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"EmployeeAdditionalInfoTemplate-v2026-01-01RequestUnauthorizedError"},"EmployeeAdditionalInfoTemplate-v2026-01-01RequestForbiddenError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeInfoContractTypesTypeCountriesCountryGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"EmployeeAdditionalInfoTemplate-v2026-01-01RequestForbiddenError"},"EmployeeAdditionalInfoTemplate-v2026-01-01RequestNotFoundError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeInfoContractTypesTypeCountriesCountryGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"EmployeeAdditionalInfoTemplate-v2026-01-01RequestNotFoundError"},"EmployeeAdditionalInfoTemplate-v2026-01-01RequestTooManyRequestsError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeInfoContractTypesTypeCountriesCountryGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"EmployeeAdditionalInfoTemplate-v2026-01-01RequestTooManyRequestsError"},"EmployeeAdditionalInfoTemplate-v2026-01-01RequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EmployeeInfoContractTypesTypeCountriesCountryGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"EmployeeAdditionalInfoTemplate-v2026-01-01RequestInternalServerError"},"BenefitsLegalEntitiesIdEmployeesEmployeeIdGetResponsesContentApplicationJsonSchemaPhonesItems":{"type":"object","properties":{"type":{"type":"string","description":"The type of phone number, e.g., mobile, home."},"dial_code":{"type":"string","description":"The international dial code."},"phone_number":{"type":"string","description":"The phone number."}},"title":"BenefitsLegalEntitiesIdEmployeesEmployeeIdGetResponsesContentApplicationJsonSchemaPhonesItems"},"BenefitsLegalEntitiesIdEmployeesEmployeeIdGetResponsesContentApplicationJsonSchemaAddressesItems":{"type":"object","properties":{"zip":{"type":["string","null"],"description":"The ZIP or postal code part of the address."},"city":{"type":["string","null"],"description":"The city part of the address."},"type":{"type":"string","description":"The type of address, e.g., home, work."},"state":{"type":["string","null"],"description":"The state part of the address."},"street":{"type":["string","null"],"description":"The street part of the address."},"country":{"type":"string","description":"The country part of the address."}},"title":"BenefitsLegalEntitiesIdEmployeesEmployeeIdGetResponsesContentApplicationJsonSchemaAddressesItems"},"BenefitsLegalEntitiesIdEmployeesEmployeeIdGetResponsesContentApplicationJsonSchemaContractsItemsCompensationsItemsType":{"type":"string","enum":["MAIN","VARIABLE"],"description":"The type of compensation, either MAIN or VARIABLE.","title":"BenefitsLegalEntitiesIdEmployeesEmployeeIdGetResponsesContentApplicationJsonSchemaContractsItemsCompensationsItemsType"},"BenefitsLegalEntitiesIdEmployeesEmployeeIdGetResponsesContentApplicationJsonSchemaContractsItemsCompensationsItemsVariableCompensationType":{"type":"string","enum":["FIXED","PERCENTAGE"],"description":"The type of variable compensation, either FIXED or PERCENTAGE.","title":"BenefitsLegalEntitiesIdEmployeesEmployeeIdGetResponsesContentApplicationJsonSchemaContractsItemsCompensationsItemsVariableCompensationType"},"BenefitsLegalEntitiesIdEmployeesEmployeeIdGetResponsesContentApplicationJsonSchemaContractsItemsCompensationsItems":{"type":"object","properties":{"rate":{"type":"number","format":"double","description":"The rate of compensation."},"type":{"$ref":"#/components/schemas/BenefitsLegalEntitiesIdEmployeesEmployeeIdGetResponsesContentApplicationJsonSchemaContractsItemsCompensationsItemsType","description":"The type of compensation, either MAIN or VARIABLE."},"scale":{"type":["string","null"],"description":"The scale of the compensation."},"currency":{"type":"string","description":"The currency of the compensation."},"cycle_scale":{"type":["string","null"],"description":"The cycle scale of the compensation."},"variable_compensation_type":{"oneOf":[{"$ref":"#/components/schemas/BenefitsLegalEntitiesIdEmployeesEmployeeIdGetResponsesContentApplicationJsonSchemaContractsItemsCompensationsItemsVariableCompensationType"},{"type":"null"}],"description":"The type of variable compensation, either FIXED or PERCENTAGE."}},"description":"Details about the compensations.","title":"BenefitsLegalEntitiesIdEmployeesEmployeeIdGetResponsesContentApplicationJsonSchemaContractsItemsCompensationsItems"},"BenefitsLegalEntitiesIdEmployeesEmployeeIdGetResponsesContentApplicationJsonSchemaContractsItemsContractType":{"type":"string","enum":["direct_employee","contractor"],"description":"The type of contract.","title":"BenefitsLegalEntitiesIdEmployeesEmployeeIdGetResponsesContentApplicationJsonSchemaContractsItemsContractType"},"BenefitsLegalEntitiesIdEmployeesEmployeeIdGetResponsesContentApplicationJsonSchemaContractsItemsEmploymentType":{"type":"string","enum":["full_time","part_time"],"description":"The employment type, e.g., full-time or part-time.","title":"BenefitsLegalEntitiesIdEmployeesEmployeeIdGetResponsesContentApplicationJsonSchemaContractsItemsEmploymentType"},"BenefitsLegalEntitiesIdEmployeesEmployeeIdGetResponsesContentApplicationJsonSchemaContractsItems":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the contract."},"flsa":{"type":"boolean","description":"Indicates if the contract is compliant with the Fair Labor Standards Act."},"status":{"type":"string","description":"The contract status."},"end_date":{"type":"string","description":"The end date of the contract, if applicable."},"job_title":{"type":"string","description":"Job title or name of the contract."},"start_date":{"type":"string","description":"The start date of the contract."},"compensations":{"type":"array","items":{"$ref":"#/components/schemas/BenefitsLegalEntitiesIdEmployeesEmployeeIdGetResponsesContentApplicationJsonSchemaContractsItemsCompensationsItems"},"description":"List of compensations associated with the contract."},"contract_type":{"$ref":"#/components/schemas/BenefitsLegalEntitiesIdEmployeesEmployeeIdGetResponsesContentApplicationJsonSchemaContractsItemsContractType","description":"The type of contract."},"employment_type":{"$ref":"#/components/schemas/BenefitsLegalEntitiesIdEmployeesEmployeeIdGetResponsesContentApplicationJsonSchemaContractsItemsEmploymentType","description":"The employment type, e.g., full-time or part-time."},"estimated_week_working_hours":{"type":"number","format":"double","description":"Estimated number of working hours per week."}},"title":"BenefitsLegalEntitiesIdEmployeesEmployeeIdGetResponsesContentApplicationJsonSchemaContractsItems"},"BenefitsLegalEntitiesIdEmployeesEmployeeIdGetResponsesContentApplicationJsonSchemaMaritalStatus":{"type":"string","enum":["Common Law","Divorced","Married","Registered Partnership","Separated","Single","Widowed"],"description":"The marital status of the employee.","title":"BenefitsLegalEntitiesIdEmployeesEmployeeIdGetResponsesContentApplicationJsonSchemaMaritalStatus"},"Employees_getEmployeeFromOrganizationIntegratedWithExternalBenefitsVendor-v2026-01-01_Response_200":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the employee."},"phones":{"type":"array","items":{"$ref":"#/components/schemas/BenefitsLegalEntitiesIdEmployeesEmployeeIdGetResponsesContentApplicationJsonSchemaPhonesItems"},"description":"List of phone numbers associated with the employee."},"status":{"type":"string","description":"The employee status given his contracts."},"addresses":{"type":"array","items":{"$ref":"#/components/schemas/BenefitsLegalEntitiesIdEmployeesEmployeeIdGetResponsesContentApplicationJsonSchemaAddressesItems"},"description":"List of addresses associated with the employee."},"contracts":{"type":"array","items":{"$ref":"#/components/schemas/BenefitsLegalEntitiesIdEmployeesEmployeeIdGetResponsesContentApplicationJsonSchemaContractsItems"},"description":"List of contracts associated with the employee."},"hire_date":{"type":["string","null"],"description":"Employee date of first contract."},"work_email":{"type":["string","null"],"description":"Employee work email address."},"date_of_birth":{"type":["string","null"],"description":"Employee date of birth."},"marital_status":{"$ref":"#/components/schemas/BenefitsLegalEntitiesIdEmployeesEmployeeIdGetResponsesContentApplicationJsonSchemaMaritalStatus","description":"The marital status of the employee."},"personal_email":{"type":["string","null"],"description":"Employee personal email address."},"document_number":{"type":"string","description":"Document number of employee identification document."},"legal_last_name":{"type":"string","description":"Employee legal last name."},"legal_first_name":{"type":"string","description":"Employee legal first name."},"legal_middle_name":{"type":["string","null"],"description":"Employee legal middle name."},"takes_owners_draw":{"type":"boolean","description":"Indicates if the employee takes an owner draw."},"ownership_percentage":{"type":"number","format":"double","description":"The percentage of business ownership by the employee."}},"title":"Employees_getEmployeeFromOrganizationIntegratedWithExternalBenefitsVendor-v2026-01-01_Response_200"},"BenefitsLegalEntitiesLegalEntityIdContractsContractIdPlansPlanIdPostRequestBodyContentApplicationJsonSchemaType":{"type":"string","enum":["ROTH","TRAD","LOAN","NEC"],"description":"Type of the contribution for 401k.","title":"BenefitsLegalEntitiesLegalEntityIdContractsContractIdPlansPlanIdPostRequestBodyContentApplicationJsonSchemaType"},"BenefitsLegalEntitiesLegalEntityIdContractsContractIdPlansPlanIdPostRequestBodyContentApplicationJsonSchemaDetails":{"type":"object","properties":{"key":{"type":"string","description":"A key-value pair providing additional details about the enrollment."}},"description":"Object containing additional information about the enrollment.","title":"BenefitsLegalEntitiesLegalEntityIdContractsContractIdPlansPlanIdPostRequestBodyContentApplicationJsonSchemaDetails"},"BenefitsLegalEntitiesLegalEntityIdContractsContractIdPlansPlanIdPostRequestBodyContentApplicationJsonSchemaContributionType":{"type":"string","enum":["PERCENTAGE","FIXED_AMOUNT"],"description":"Type of contribution.","title":"BenefitsLegalEntitiesLegalEntityIdContractsContractIdPlansPlanIdPostRequestBodyContentApplicationJsonSchemaContributionType"},"BenefitsLegalEntitiesLegalEntityIdContractsContractIdPlansPlanIdPostResponsesContentApplicationJsonSchemaDataType":{"type":"string","enum":["ROTH","TRAD","LOAN","NEC"],"description":"Type of the contribution for 401k.","title":"BenefitsLegalEntitiesLegalEntityIdContractsContractIdPlansPlanIdPostResponsesContentApplicationJsonSchemaDataType"},"BenefitsLegalEntitiesLegalEntityIdContractsContractIdPlansPlanIdPostResponsesContentApplicationJsonSchemaDataDetails":{"type":"object","properties":{"key":{"type":"string","description":"A key-value pair providing additional details about the enrollment."}},"description":"Object containing additional information about the enrollment.","title":"BenefitsLegalEntitiesLegalEntityIdContractsContractIdPlansPlanIdPostResponsesContentApplicationJsonSchemaDataDetails"},"BenefitsLegalEntitiesLegalEntityIdContractsContractIdPlansPlanIdPostResponsesContentApplicationJsonSchemaDataContributionType":{"type":"string","enum":["PERCENTAGE","FIXED_AMOUNT"],"description":"Type of contribution.","title":"BenefitsLegalEntitiesLegalEntityIdContractsContractIdPlansPlanIdPostResponsesContentApplicationJsonSchemaDataContributionType"},"BenefitsLegalEntitiesLegalEntityIdContractsContractIdPlansPlanIdPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","description":"Enrollment id."},"type":{"$ref":"#/components/schemas/BenefitsLegalEntitiesLegalEntityIdContractsContractIdPlansPlanIdPostResponsesContentApplicationJsonSchemaDataType","description":"Type of the contribution for 401k."},"details":{"$ref":"#/components/schemas/BenefitsLegalEntitiesLegalEntityIdContractsContractIdPlansPlanIdPostResponsesContentApplicationJsonSchemaDataDetails","description":"Object containing additional information about the enrollment."},"contribution_type":{"$ref":"#/components/schemas/BenefitsLegalEntitiesLegalEntityIdContractsContractIdPlansPlanIdPostResponsesContentApplicationJsonSchemaDataContributionType","description":"Type of contribution."},"contribution_limit":{"type":"number","format":"double","description":"Maximum limit of contribution."},"contribution_value":{"type":"number","format":"double","description":"Value of the contribution."}},"title":"BenefitsLegalEntitiesLegalEntityIdContractsContractIdPlansPlanIdPostResponsesContentApplicationJsonSchemaData"},"Enrollments_enrollAnEmployeeInA401KPlan-v2026-01-01_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BenefitsLegalEntitiesLegalEntityIdContractsContractIdPlansPlanIdPostResponsesContentApplicationJsonSchemaData"}},"title":"Enrollments_enrollAnEmployeeInA401KPlan-v2026-01-01_Response_200"},"BenefitsLegalEntitiesLegalEntityIdContractsContractIdPlansPlanIdGetResponsesContentApplicationJsonSchemaDataItemsType":{"type":"string","enum":["ROTH","TRAD","LOAN","NEC"],"description":"Type of the contribution for 401k.","title":"BenefitsLegalEntitiesLegalEntityIdContractsContractIdPlansPlanIdGetResponsesContentApplicationJsonSchemaDataItemsType"},"BenefitsLegalEntitiesLegalEntityIdContractsContractIdPlansPlanIdGetResponsesContentApplicationJsonSchemaDataItemsDetails":{"type":"object","properties":{"key":{"type":"string","description":"A key-value pair providing additional details about the enrollment."}},"description":"Object containing additional information about the enrollment.","title":"BenefitsLegalEntitiesLegalEntityIdContractsContractIdPlansPlanIdGetResponsesContentApplicationJsonSchemaDataItemsDetails"},"BenefitsLegalEntitiesLegalEntityIdContractsContractIdPlansPlanIdGetResponsesContentApplicationJsonSchemaDataItemsContributionType":{"type":"string","enum":["PERCENTAGE","FIXED_AMOUNT"],"description":"Type of contribution.","title":"BenefitsLegalEntitiesLegalEntityIdContractsContractIdPlansPlanIdGetResponsesContentApplicationJsonSchemaDataItemsContributionType"},"BenefitsLegalEntitiesLegalEntityIdContractsContractIdPlansPlanIdGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"id":{"type":"string","description":"Enrollment id."},"type":{"$ref":"#/components/schemas/BenefitsLegalEntitiesLegalEntityIdContractsContractIdPlansPlanIdGetResponsesContentApplicationJsonSchemaDataItemsType","description":"Type of the contribution for 401k."},"details":{"oneOf":[{"$ref":"#/components/schemas/BenefitsLegalEntitiesLegalEntityIdContractsContractIdPlansPlanIdGetResponsesContentApplicationJsonSchemaDataItemsDetails"},{"type":"null"}],"description":"Object containing additional information about the enrollment."},"contribution_type":{"$ref":"#/components/schemas/BenefitsLegalEntitiesLegalEntityIdContractsContractIdPlansPlanIdGetResponsesContentApplicationJsonSchemaDataItemsContributionType","description":"Type of contribution."},"contribution_limit":{"type":"number","format":"double","description":"Maximum limit of contribution."},"contribution_value":{"type":"string","description":"Value of the contribution."}},"title":"BenefitsLegalEntitiesLegalEntityIdContractsContractIdPlansPlanIdGetResponsesContentApplicationJsonSchemaDataItems"},"Enrollments_getEnrollmentSettingsFromAnEmployeeInA401KPlan-v2026-01-01_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/BenefitsLegalEntitiesLegalEntityIdContractsContractIdPlansPlanIdGetResponsesContentApplicationJsonSchemaDataItems"}}},"title":"Enrollments_getEnrollmentSettingsFromAnEmployeeInA401KPlan-v2026-01-01_Response_200"},"EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataType":{"type":"string","enum":["INSTANT","OPS","LEGAL","DISABLED","CUSTOM","AUTOMATED"],"description":"Type of amendment","title":"EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataType"},"EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataItemsItemsType":{"type":"string","enum":["INSTANT","OPS","LEGAL","DISABLED","CUSTOM","AUTOMATED"],"description":"Type of amendment","title":"EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataItemsItemsType"},"EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataItemsItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Id of amendment item"},"item":{"type":"string","description":"Amendment item"},"type":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataItemsItemsType","description":"Type of amendment"},"new_value":{"type":"string","description":"The new valid value after the attempted change."},"data_point":{"type":"string","description":"The field that is selected for amendment."},"previous_value":{"type":"string","description":"The previous valid value before the attempted change."}},"title":"EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataItemsItems"},"EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataSource":{"type":"string","enum":["APP","PUBLIC_API","APP_BULK_AMENDMENT"],"description":"Source of amendment flow creation.","title":"EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataSource"},"EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataCustomItemsItemsStatus":{"type":"string","enum":["REJECTED","APPROVED","PENDING_REVIEW","PENDING_LEGAL"],"description":"Current status of the custom amendment item","title":"EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataCustomItemsItemsStatus"},"EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataCustomItemsItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the custom amendment item"},"type":{"type":"string","description":"Type/context of the custom amendment item"},"status":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataCustomItemsItemsStatus","description":"Current status of the custom amendment item"},"description":{"type":["string","null"],"description":"Detailed description of the custom amendment item"},"rejection_reason":{"type":["string","null"],"description":"Reason for rejection if the item was rejected"}},"required":["id","type","status"],"title":"EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataCustomItemsItems"},"EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataDocumentType":{"type":"string","enum":["EA","SOW","SOW_EA"],"description":"Amendment document type","title":"EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataDocumentType"},"EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataLegalContextStatus":{"type":"string","enum":["REQUEST_LEGAL_REVIEW","WAITING_FOR_ANOTHER_TEAM","WAITING_FOR_HRX_ACTION","DECLINED","SOLVED"],"description":"Current status of the legal review process","title":"EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataLegalContextStatus"},"EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataLegalContext":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataLegalContextStatus","description":"Current status of the legal review process"},"details":{"type":"string","description":"Details regarding the legal request"},"jira_ticket":{"type":"string","description":"Jira ticket identifier linked to the legal context"},"jira_web_url":{"type":"string","format":"uri","description":"Link to the Jira ticket for tracking"},"requested_at":{"type":"string","format":"date-time","description":"Timestamp when legal review was requested"}},"description":"Additional details needed for legal input","title":"EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataLegalContext"},"EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataTimeOffType":{"type":"string","enum":["STANDARD","SPECIFIC","PRORATED"],"description":"Type of time off.","title":"EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataTimeOffType"},"EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataEmploymentType":{"type":"string","enum":["FULL_TIME","PART_TIME"],"description":"Type of employment.","title":"EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataEmploymentType"},"EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataFixedAdjustmentsItemsStatus":{"type":"string","enum":["WAITING_FOR_SIGNING","ACTIVE","OUTDATED","CANCELLED"],"description":"Current status of the fixed adjustment.","title":"EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataFixedAdjustmentsItemsStatus"},"EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataFixedAdjustmentsItems":{"type":"object","properties":{"id":{"type":"string","description":"System-generated unique identifier for the fixed adjustment record in an amendment request."},"value":{"type":"string","description":"Value of the fixed adjustment."},"status":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataFixedAdjustmentsItemsStatus","description":"Current status of the fixed adjustment."},"created_at":{"type":"string","format":"date-time","description":"Timestamp when the fixed adjustment was created."},"is_amended":{"type":"boolean","description":"Whether this fixed adjustment was amended from a previous one."},"is_deleted":{"type":"boolean","description":"True if the fixed adjustment was deleted as part of the amendment; otherwise false."},"updated_at":{"type":"string","format":"date-time","description":"Timestamp when the fixed adjustment was last updated."},"description":{"type":"string","description":"Description of the fixed adjustment."},"is_recurring":{"type":"boolean","description":"Whether the fixed adjustment is recurring. If set to false, it will be treated as a one-time fixed allowance."},"is_country_specific":{"type":"boolean","description":"Whether this fixed adjustment applies only to a specific country."},"parent_fixed_adjustment_id":{"type":["string","null"],"description":"Reference to the parent fixed adjustment, if applicable."}},"required":["id","value","status","created_at","is_amended","updated_at","description","is_recurring","is_country_specific"],"title":"EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataFixedAdjustmentsItems"},"EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataRejectionContext":{"type":"object","properties":{"rejected_at":{"type":"string","format":"date-time","description":"Timestamp of when the rejection occurred"}},"description":"Additional details containing rejection reason","title":"EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataRejectionContext"},"EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataAmendmentStatusesItemsAmendmentFlowStatus":{"type":"object","properties":{"created_at":{"type":"string","format":"date-time","description":"The timestamp when this amendment status was created."}},"description":"Metadata about the amendment status, including when it was created.","title":"EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataAmendmentStatusesItemsAmendmentFlowStatus"},"EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataAmendmentStatusesItems":{"type":"object","properties":{"name":{"type":"string","description":"Logical, system-oriented identifier of the amendment status. Can be used to group statuses under a parent category and subgroup them for more granular state tracking. The structure typically follows a dot-separated hierarchy (e.g., 'PARENT','PARENT.CHILD', 'PARENT.CHILD.CHILD.CHILD', ...), which allows logical grouping and filtering of related statuses."},"friendly_name":{"type":"string","description":"Human-readable label of the amendment status (e.g., DRAFT, PENDING, APPROVED)."},"amendment_flow_status":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataAmendmentStatusesItemsAmendmentFlowStatus","description":"Metadata about the amendment status, including when it was created."}},"description":"Details of a specific amendment status in the lifecycle of the amendment.","title":"EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataAmendmentStatusesItems"},"EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataNoticePeriodType":{"type":"string","enum":["STANDARD","CUSTOM"],"description":"Type of notice period.","title":"EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataNoticePeriodType"},"EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataVoidDeadlineType":{"type":"string","enum":["CUTOFF","START_DATE","END_DATE","EXPIRY"],"description":"Type of void deadline","title":"EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataVoidDeadlineType"},"EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataVariableCompensationType":{"type":"string","enum":["FIXED","PERCENTAGE"],"description":"The way the compensation is calculated. `FIXED` means a fixed amount (like $1000). `PERCENTAGE` means it’s based on a percentage of the salary.","title":"EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataVariableCompensationType"},"EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataVariableCompensationTimeline":{"type":"string","enum":["MONTHLY","QUARTERLY","ANNUALLY","BIANNUALLY"],"description":"How often the compensation is paid — for example monthly, quarterly, annually, or twice a year.","title":"EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataVariableCompensationTimeline"},"EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataVariableCompensationIncentivePlan":{"type":"object","properties":{"details":{"type":"string","description":"Extra details about the incentive plan, if any."},"employee_signature":{"type":"string","description":"The employee’s signature for the incentive plan, if collected."},"employee_signed_at":{"type":"string","format":"date-time","description":"The date and time when the employee signed the incentive plan. Empty if not signed."}},"description":"Details of the incentive plan linked to this compensation, if any.","title":"EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataVariableCompensationIncentivePlan"},"EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataVariableCompensation":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID assigned by the system to this variable compensation record."},"type":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataVariableCompensationType","description":"The way the compensation is calculated. `FIXED` means a fixed amount (like $1000). `PERCENTAGE` means it’s based on a percentage of the salary."},"title":{"type":"string","description":"Title or name of the variable compensation."},"amount":{"type":"string","format":"decimal","description":"The value of the compensation. Shown as a string to keep the exact number of decimals."},"timeline":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataVariableCompensationTimeline","description":"How often the compensation is paid — for example monthly, quarterly, annually, or twice a year."},"parent_id":{"type":["string","null"],"description":"Reference to the parent variable compensation, if applicable. Null if this compensation is not linked to any compensation."},"created_at":{"type":"string","format":"date-time","description":"The date and time when this record was first created in the system."},"is_amended":{"type":"boolean","description":"Shows whether this compensation has been changed as part of an amendment."},"is_deleted":{"type":"boolean","description":"Shows whether this compensation has been deleted."},"updated_at":{"type":"string","format":"date-time","description":"The date and time when this record was last updated."},"effective_date":{"type":"string","format":"date-time","description":"The date when this compensation starts being valid."},"incentive_plan":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataVariableCompensationIncentivePlan","description":"Details of the incentive plan linked to this compensation, if any."}},"required":["id","type","title","amount","timeline","parent_id","created_at","updated_at","effective_date"],"description":"Represents a variable compensation record (such as a bonus, commission, or incentive) within a contract. It contains details like the amount, type, frequency, and whether it is part of an incentive plan. The record also tracks when it was created, updated, and whether it has been amended.","title":"EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataVariableCompensation"},"EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataNoticePeriodTimeUnit":{"type":"string","enum":["DAY","WEEK","MONTH"],"description":"Notice period time unit.","title":"EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataNoticePeriodTimeUnit"},"EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataProbationPeriodTypeForDefinite":{"type":"string","enum":["STANDARD","CUSTOM"],"description":"Type of probation period for definite contracts.","title":"EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataProbationPeriodTypeForDefinite"},"EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Id of amendment"},"type":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataType"},{"type":"null"}],"description":"Type of amendment"},"items":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataItemsItems"},"description":"Items of amendment"},"scope":{"type":"string","description":"Scope of the amendment."},"salary":{"type":"string","description":"Salary for the amendment."},"source":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataSource"},{"type":"null"}],"description":"Source of amendment flow creation."},"currency":{"type":"string","description":"Contract currency."},"end_date":{"type":["string","null"],"format":"date-time","description":"End date of the employment."},"holidays":{"type":["integer","null"],"description":"Number of holidays."},"job_code":{"type":["string","null"],"description":"Job code associated with the job title."},"job_title":{"type":"string","description":"Job title associated with the amendment."},"created_at":{"type":"string","format":"date-time","description":"Creation date of the amendment."},"start_date":{"type":"string","format":"date-time","description":"Start date of the employment."},"updated_at":{"type":"string","format":"date-time","description":"Date when amendment is updated"},"hourly_rate":{"type":["string","null"],"description":"Hourly rate of the amendment"},"custom_items":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataCustomItemsItems"},"description":"Custom amendment items associated with the amendment flow"},"job_category":{"type":["string","null"],"description":"Job category associated with the job title."},"requested_by":{"type":["string","null"],"description":"Profile name of the user who requested the change"},"seniority_id":{"type":["string","null"],"format":"uuid","description":"Seniority level identifier."},"document_type":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataDocumentType"},{"type":"null"}],"description":"Amendment document type"},"legal_context":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataLegalContext"},{"type":"null"}],"description":"Additional details needed for legal input"},"time_off_type":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataTimeOffType","description":"Type of time off."},"void_deadline":{"type":["string","null"],"format":"date-time","description":"Deadline this SOW to be voided"},"effective_date":{"type":["string","null"],"format":"date-time","description":"Effective date of the amendment."},"seniority_date":{"type":["string","null"],"format":"date","description":"The seniority date represents the employee’s original start date with a previous employer. It is used to preserve employment tenure when the employee transfers to this company. Can be null if not applicable."},"employment_type":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataEmploymentType","description":"Type of employment."},"sick_leave_days":{"type":["integer","null"],"description":"Number of sick leave days"},"employment_state":{"type":["string","null"],"description":"State of employment."},"probation_period":{"type":["integer","null"],"description":"Duration of the probation period."},"work_schedule_id":{"type":["string","null"],"format":"uuid","description":"Work schedule id"},"fixed_adjustments":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataFixedAdjustmentsItems"},"description":"List of fixed adjustments associated with the amendment request."},"rejection_context":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataRejectionContext"},{"type":"null"}],"description":"Additional details containing rejection reason"},"amendment_statuses":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataAmendmentStatusesItems"},"description":"List of amendment statuses representing the history and progression of an amendment."},"notice_period_type":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataNoticePeriodType"},{"type":"null"}],"description":"Type of notice period."},"void_deadline_type":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataVoidDeadlineType"},{"type":"null"}],"description":"Type of void deadline"},"work_hours_per_week":{"type":"string","description":"Number of work hours per week."},"employee_nationality":{"type":"string","description":"Nationality of the employee."},"is_hrx_action_needed":{"type":"boolean","description":"Is HRX action needed."},"variable_compensation":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataVariableCompensation","description":"Represents a variable compensation record (such as a bonus, commission, or incentive) within a contract. It contains details like the amount, type, frequency, and whether it is part of an incentive plan. The record also tracks when it was created, updated, and whether it has been amended."},"notice_period_time_unit":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataNoticePeriodTimeUnit"},{"type":"null"}],"description":"Notice period time unit."},"is_effective_date_updated":{"type":"boolean","description":"Is Effective Date updated."},"work_schedule_rules_version":{"type":["string","null"],"description":"Work schedule rule version."},"notice_period_after_probation":{"type":["string","null"],"description":"Notice period after probation."},"notice_period_during_probation":{"type":["string","null"],"description":"Notice period during probation."},"probation_period_type_for_definite":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaDataProbationPeriodTypeForDefinite"},{"type":"null"}],"description":"Type of probation period for definite contracts."}},"title":"EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaData"},"eor-amendments_acceptContractAmendment_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaData"}},"title":"eor-amendments_acceptContractAmendment_Response_200"},"EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"title":"EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaErrorsItems"},"AcceptAContractAmendmentOnBehalfOfTheClientRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"AcceptAContractAmendmentOnBehalfOfTheClientRequestBadRequestError"},"AcceptAContractAmendmentOnBehalfOfTheClientRequestNotFoundError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"AcceptAContractAmendmentOnBehalfOfTheClientRequestNotFoundError"},"AcceptAContractAmendmentOnBehalfOfTheClientRequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdAcceptPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"AcceptAContractAmendmentOnBehalfOfTheClientRequestInternalServerError"},"EorContractsContractIdAmendmentsAmendmentIdDeleteResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"success":{"type":"boolean"}},"required":["success"],"title":"EorContractsContractIdAmendmentsAmendmentIdDeleteResponsesContentApplicationJsonSchemaData"},"eor-amendments_deleteContractAmendment_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdDeleteResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"eor-amendments_deleteContractAmendment_Response_200"},"EorContractsContractIdAmendmentsAmendmentIdDeleteResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"title":"EorContractsContractIdAmendmentsAmendmentIdDeleteResponsesContentApplicationJsonSchemaErrorsItems"},"CancelAmendmentRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdDeleteResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"CancelAmendmentRequestBadRequestError"},"CancelAmendmentRequestNotFoundError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdDeleteResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"CancelAmendmentRequestNotFoundError"},"CancelAmendmentRequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdDeleteResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"CancelAmendmentRequestInternalServerError"},"EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataType":{"type":"string","enum":["INSTANT","OPS","LEGAL","DISABLED","CUSTOM","AUTOMATED"],"description":"Type of amendment","title":"EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataType"},"EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataItemsItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Id of amendment item"},"item":{"type":"string","description":"Amendment item"},"type":{"type":"string","description":"Type of amendment"},"new_value":{"type":"string","description":"The new valid value after the attempted change."},"data_point":{"type":"string","description":"The field that is selected for amendment."},"previous_value":{"type":"string","description":"The previous valid value before the attempted change."}},"title":"EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataItemsItems"},"EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataSource":{"type":"string","enum":["APP","PUBLIC_API","APP_BULK_AMENDMENT"],"description":"Source of amendment flow creation.","title":"EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataSource"},"EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataCustomItemsItemsStatus":{"type":"string","enum":["REJECTED","APPROVED","PENDING_REVIEW","PENDING_LEGAL"],"description":"Current status of the custom amendment item","title":"EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataCustomItemsItemsStatus"},"EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataCustomItemsItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the custom amendment item"},"type":{"type":"string","description":"Type/context of the custom amendment item"},"status":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataCustomItemsItemsStatus","description":"Current status of the custom amendment item"},"description":{"type":["string","null"],"description":"Detailed description of the custom amendment item"},"rejection_reason":{"type":["string","null"],"description":"Reason for rejection if the item was rejected"}},"required":["id","type","status"],"title":"EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataCustomItemsItems"},"EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataDocumentType":{"type":"string","enum":["EA","SOW","SOW_EA"],"description":"Amendment document type","title":"EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataDocumentType"},"EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataLegalContextStatus":{"type":"string","enum":["REQUEST_LEGAL_REVIEW","WAITING_FOR_ANOTHER_TEAM","WAITING_FOR_HRX_ACTION","DECLINED","SOLVED"],"description":"Current status of the legal review process","title":"EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataLegalContextStatus"},"EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataLegalContext":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataLegalContextStatus","description":"Current status of the legal review process"},"details":{"type":"string","description":"Details regarding the legal request"},"jira_ticket":{"type":"string","description":"Jira ticket identifier linked to the legal context"},"jira_web_url":{"type":"string","format":"uri","description":"Link to the Jira ticket for tracking"},"requested_at":{"type":"string","format":"date-time","description":"Timestamp when legal review was requested"}},"description":"Additional details needed for legal input","title":"EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataLegalContext"},"EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataTimeOffType":{"type":"string","enum":["STANDARD","SPECIFIC","PRORATED"],"description":"Type of time off.","title":"EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataTimeOffType"},"EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataEmploymentType":{"type":"string","enum":["FULL_TIME","PART_TIME"],"description":"Type of employment.","title":"EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataEmploymentType"},"EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataFixedAdjustmentsItemsStatus":{"type":"string","enum":["WAITING_FOR_SIGNING","ACTIVE","OUTDATED","CANCELLED"],"description":"Current status of the fixed adjustment.","title":"EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataFixedAdjustmentsItemsStatus"},"EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataFixedAdjustmentsItems":{"type":"object","properties":{"id":{"type":"string","description":"System-generated unique identifier for the fixed adjustment record in an amendment request."},"value":{"type":"string","description":"Value of the fixed adjustment."},"status":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataFixedAdjustmentsItemsStatus","description":"Current status of the fixed adjustment."},"created_at":{"type":"string","format":"date-time","description":"Timestamp when the fixed adjustment was created."},"is_amended":{"type":"boolean","description":"Whether this fixed adjustment was amended from a previous one."},"is_deleted":{"type":"boolean","description":"True if the fixed adjustment was deleted as part of the amendment; otherwise false."},"updated_at":{"type":"string","format":"date-time","description":"Timestamp when the fixed adjustment was last updated."},"description":{"type":"string","description":"Description of the fixed adjustment."},"is_recurring":{"type":"boolean","description":"Whether the fixed adjustment is recurring. If set to false, it will be treated as a one-time fixed allowance."},"is_country_specific":{"type":"boolean","description":"Whether this fixed adjustment applies only to a specific country."},"parent_fixed_adjustment_id":{"type":["string","null"],"description":"Reference to the parent fixed adjustment, if applicable."}},"required":["id","value","status","created_at","is_amended","updated_at","description","is_recurring","is_country_specific"],"title":"EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataFixedAdjustmentsItems"},"EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataRejectionContext":{"type":"object","properties":{"rejected_at":{"type":"string","format":"date-time","description":"Timestamp of when the rejection occurred"}},"description":"Additional details containing rejection reason","title":"EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataRejectionContext"},"EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataAmendmentStatusesItemsAmendmentFlowStatus":{"type":"object","properties":{"created_at":{"type":"string","format":"date-time","description":"Creation date"}},"description":"Metadata about the amendment status, including when it was created.","title":"EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataAmendmentStatusesItemsAmendmentFlowStatus"},"EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataAmendmentStatusesItems":{"type":"object","properties":{"name":{"type":"string","description":"Logical, system-oriented identifier of the amendment status. Can be used to group statuses under a parent category and subgroup them for more granular state tracking. The structure typically follows a dot-separated hierarchy (e.g., 'PARENT','PARENT.CHILD', 'PARENT.CHILD.CHILD.CHILD', ...), which allows logical grouping and filtering of related statuses."},"friendly_name":{"type":"string","description":"Friendly name of amendment status"},"amendment_flow_status":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataAmendmentStatusesItemsAmendmentFlowStatus","description":"Metadata about the amendment status, including when it was created."}},"title":"EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataAmendmentStatusesItems"},"EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataNoticePeriodType":{"type":"string","enum":["STANDARD","CUSTOM"],"description":"Type of notice period.","title":"EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataNoticePeriodType"},"EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataVoidDeadlineType":{"type":"string","enum":["CUTOFF","START_DATE","END_DATE","EXPIRY"],"description":"Type of void deadline","title":"EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataVoidDeadlineType"},"EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataVariableCompensationType":{"type":"string","enum":["FIXED","PERCENTAGE"],"description":"The way the compensation is calculated. `FIXED` means a fixed amount (like $1000). `PERCENTAGE` means it’s based on a percentage of the salary.","title":"EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataVariableCompensationType"},"EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataVariableCompensationTimeline":{"type":"string","enum":["MONTHLY","QUARTERLY","ANNUALLY","BIANNUALLY"],"description":"How often the compensation is paid — for example monthly, quarterly, annually, or twice a year.","title":"EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataVariableCompensationTimeline"},"EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataVariableCompensationIncentivePlan":{"type":"object","properties":{"details":{"type":"string","description":"Extra details about the incentive plan, if any."},"employee_signature":{"type":"string","description":"The employee’s signature for the incentive plan, if collected."},"employee_signed_at":{"type":"string","format":"date-time","description":"The date and time when the employee signed the incentive plan. Empty if not signed."}},"description":"Details of the incentive plan linked to this compensation, if any.","title":"EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataVariableCompensationIncentivePlan"},"EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataVariableCompensation":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID assigned by the system to this variable compensation record."},"type":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataVariableCompensationType","description":"The way the compensation is calculated. `FIXED` means a fixed amount (like $1000). `PERCENTAGE` means it’s based on a percentage of the salary."},"title":{"type":"string","description":"Title or name of the variable compensation."},"amount":{"type":"string","format":"decimal","description":"The value of the compensation. Shown as a string to keep the exact number of decimals."},"timeline":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataVariableCompensationTimeline","description":"How often the compensation is paid — for example monthly, quarterly, annually, or twice a year."},"parent_id":{"type":["string","null"],"description":"Reference to the parent variable compensation, if applicable. Null if this compensation is not linked to any compensation."},"created_at":{"type":"string","format":"date-time","description":"The date and time when this record was first created in the system."},"is_amended":{"type":"boolean","description":"Shows whether this compensation has been changed as part of an amendment."},"is_deleted":{"type":"boolean","description":"Shows whether this compensation has been deleted."},"updated_at":{"type":"string","format":"date-time","description":"The date and time when this record was last updated."},"effective_date":{"type":"string","format":"date-time","description":"The date when this compensation starts being valid."},"incentive_plan":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataVariableCompensationIncentivePlan","description":"Details of the incentive plan linked to this compensation, if any."}},"required":["id","type","title","amount","timeline","parent_id","created_at","updated_at","effective_date"],"description":"Represents a variable compensation record (such as a bonus, commission, or incentive) within a contract. It contains details like the amount, type, frequency, and whether it is part of an incentive plan. The record also tracks when it was created, updated, and whether it has been amended.","title":"EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataVariableCompensation"},"EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataNoticePeriodTimeUnit":{"type":"string","enum":["DAY","WEEK","MONTH"],"description":"Notice period time unit.","title":"EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataNoticePeriodTimeUnit"},"EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataProbationPeriodTypeForDefinite":{"type":"string","enum":["STANDARD","CUSTOM"],"description":"Type of probation period for definite contracts.","title":"EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataProbationPeriodTypeForDefinite"},"EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Id of amendment"},"type":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataType"},{"type":"null"}],"description":"Type of amendment"},"items":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataItemsItems"},"description":"Items of amendment"},"scope":{"type":"string","description":"Scope of the amendment."},"salary":{"type":"string","description":"Salary for the amendment."},"source":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataSource"},{"type":"null"}],"description":"Source of amendment flow creation."},"currency":{"type":"string","description":"Contract currency."},"end_date":{"type":["string","null"],"format":"date-time","description":"End date of the employment."},"holidays":{"type":["integer","null"],"description":"Number of holidays."},"job_code":{"type":["string","null"],"description":"Job code associated with the job title."},"job_title":{"type":"string","description":"Job title associated with the amendment."},"created_at":{"type":"string","format":"date-time","description":"Creation date of the amendment."},"start_date":{"type":"string","format":"date-time","description":"Start date of the employment."},"updated_at":{"type":"string","format":"date-time","description":"Date when amendment is updated"},"hourly_rate":{"type":["string","null"],"description":"Hourly rate of the amendment"},"custom_items":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataCustomItemsItems"},"description":"Custom amendment items associated with the amendment flow"},"job_category":{"type":["string","null"],"description":"Job category associated with the job title."},"requested_by":{"type":["string","null"],"description":"Profile name of the user who requested the change"},"seniority_id":{"type":["string","null"],"format":"uuid","description":"Seniority level identifier."},"document_type":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataDocumentType"},{"type":"null"}],"description":"Amendment document type"},"legal_context":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataLegalContext"},{"type":"null"}],"description":"Additional details needed for legal input"},"time_off_type":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataTimeOffType","description":"Type of time off."},"void_deadline":{"type":["string","null"],"format":"date","description":"Deadline this SOW to be voided"},"effective_date":{"type":["string","null"],"format":"date-time","description":"Effective date of the amendment."},"seniority_date":{"type":["string","null"],"format":"date-time","description":"The seniority date represents the employee’s original start date with a previous employer. It is used to preserve employment tenure when the employee transfers to this company. Can be null if not applicable."},"employment_type":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataEmploymentType","description":"Type of employment."},"sick_leave_days":{"type":["integer","null"],"description":"Number of sick leave days"},"employment_state":{"type":["string","null"],"description":"State of employment."},"probation_period":{"type":["integer","null"],"description":"Duration of the probation period."},"work_schedule_id":{"type":["string","null"],"format":"uuid","description":"Work schedule id"},"fixed_adjustments":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataFixedAdjustmentsItems"},"description":"List of fixed adjustments associated with the amendment request."},"rejection_context":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataRejectionContext"},{"type":"null"}],"description":"Additional details containing rejection reason"},"amendment_statuses":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataAmendmentStatusesItems"},"description":"List of amendment statuses representing the history and progression of an amendment."},"notice_period_type":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataNoticePeriodType"},{"type":"null"}],"description":"Type of notice period."},"void_deadline_type":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataVoidDeadlineType"},{"type":"null"}],"description":"Type of void deadline"},"work_hours_per_week":{"type":"string","description":"Number of work hours per week."},"employee_nationality":{"type":"string","description":"Nationality of the employee."},"is_hrx_action_needed":{"type":"boolean","description":"Is HRX action needed."},"variable_compensation":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataVariableCompensation","description":"Represents a variable compensation record (such as a bonus, commission, or incentive) within a contract. It contains details like the amount, type, frequency, and whether it is part of an incentive plan. The record also tracks when it was created, updated, and whether it has been amended."},"notice_period_time_unit":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataNoticePeriodTimeUnit"},{"type":"null"}],"description":"Notice period time unit."},"is_effective_date_updated":{"type":"boolean","description":"Is Effective Date updated."},"work_schedule_rules_version":{"type":["string","null"],"description":"Work schedule rule version."},"notice_period_after_probation":{"type":["string","null"],"description":"Notice period after probation."},"notice_period_during_probation":{"type":["string","null"],"description":"Notice period during probation."},"probation_period_type_for_definite":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaDataProbationPeriodTypeForDefinite"},{"type":"null"}],"description":"Type of probation period for definite contracts."}},"title":"EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaData"},"eor-amendments_confirmContractAmendment_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaData"}},"title":"eor-amendments_confirmContractAmendment_Response_200"},"EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"title":"EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaErrorsItems"},"ConfirmAnExistingContractAmendment-v2026-01-01RequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"ConfirmAnExistingContractAmendment-v2026-01-01RequestBadRequestError"},"ConfirmAnExistingContractAmendment-v2026-01-01RequestNotFoundError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"ConfirmAnExistingContractAmendment-v2026-01-01RequestNotFoundError"},"ConfirmAnExistingContractAmendment-v2026-01-01RequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdConfirmPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"ConfirmAnExistingContractAmendment-v2026-01-01RequestInternalServerError"},"EorContractsContractIdAmendmentsAmendmentIdPdfGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"url":{"type":"string","format":"uri","description":"Pre-signed URL to download the exported PDF (valid for 15 minutes)."}},"title":"EorContractsContractIdAmendmentsAmendmentIdPdfGetResponsesContentApplicationJsonSchemaData"},"eor-amendments_getContractAmendmentPdf_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPdfGetResponsesContentApplicationJsonSchemaData"}},"title":"eor-amendments_getContractAmendmentPdf_Response_200"},"EorContractsContractIdAmendmentsAmendmentIdPdfGetResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"title":"EorContractsContractIdAmendmentsAmendmentIdPdfGetResponsesContentApplicationJsonSchemaErrorsItems"},"GetEorContractAmendmentPdfDownloadLinkForClientAndEmployeeRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPdfGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"GetEorContractAmendmentPdfDownloadLinkForClientAndEmployeeRequestBadRequestError"},"GetEorContractAmendmentPdfDownloadLinkForClientAndEmployeeRequestNotFoundError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPdfGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"GetEorContractAmendmentPdfDownloadLinkForClientAndEmployeeRequestNotFoundError"},"GetEorContractAmendmentPdfDownloadLinkForClientAndEmployeeRequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPdfGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"GetEorContractAmendmentPdfDownloadLinkForClientAndEmployeeRequestInternalServerError"},"EorContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataCustomItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"An optional identifier for the custom object."},"type":{"type":"string","description":"The type of the custom object. Must be one of the valid custom types."},"description":{"type":"string","description":"A required description for the custom object."}},"required":["type","description"],"title":"EorContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataCustomItems"},"EorContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataTimeOffType":{"type":"string","enum":["STANDARD","SPECIFIC","PRORATED"],"description":"Type of time off.","title":"EorContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataTimeOffType"},"EorContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataAdditionalInfo":{"type":"object","properties":{"ai_scope_check_public_id":{"type":"string","format":"uuid","description":"Identifier or flag for AI scope validation check"},"job_categorization_log_id":{"type":"string","format":"uuid","description":"Identifier for job categorisation log"}},"description":"Additional metadata related to job validation and categorisation","title":"EorContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataAdditionalInfo"},"EorContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataEmploymentType":{"type":"string","enum":["FULL_TIME","PART_TIME"],"description":"Type of employment.","title":"EorContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataEmploymentType"},"EorContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataFixedAdjustmentsItems":{"type":"object","properties":{"id":{"type":"string","description":"The ID of an existing active fixed adjustment to update or delete. Include this in the request only if you are updating or deleting an existing adjustment. Do not include it when creating a new one."},"value":{"type":"string","description":"Value of the fixed adjustment. Must be a positive number, not zero."},"is_deleted":{"type":"boolean","description":"Flag to mark the fixed adjustment as deleted. Required only when the fixed adjustment needs to be removed; omit it otherwise."},"description":{"type":"string","description":"Description of the fixed adjustment."},"is_recurring":{"type":"boolean","description":"Whether the fixed adjustment is recurring. If set to false, it will be treated as a one-time fixed allowance."}},"required":["value","description","is_recurring"],"title":"EorContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataFixedAdjustmentsItems"},"EorContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataNoticePeriodType":{"type":"string","enum":["STANDARD","CUSTOM"],"description":"Type of notice period.","title":"EorContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataNoticePeriodType"},"EorContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataVariableCompensationType":{"type":"string","enum":["PERCENTAGE","FIXED"],"description":"Type of variable compensation.","title":"EorContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataVariableCompensationType"},"EorContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataVariableCompensationTimeline":{"type":"string","enum":["MONTHLY","QUARTERLY","ANNUALLY","BIANNUALLY"],"description":"How often this compensation occurs. Required when creating a new compensation. Forbidden when updating an existing compensation.","title":"EorContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataVariableCompensationTimeline"},"EorContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataVariableCompensation":{"type":"object","properties":{"id":{"type":"string","description":"The ID of an existing active variable compensation to update or delete. Include this in the request only if you are updating or deleting an existing compensation. Do not include it when creating a new one."},"type":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataVariableCompensationType","description":"Type of variable compensation."},"title":{"type":"string","description":"The title of the compensation. Required when creating a new compensation. Optional when updating an existing compensation."},"amount":{"type":"number","format":"double","description":"Positive amount for the variable compensation."},"timeline":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataVariableCompensationTimeline","description":"How often this compensation occurs. Required when creating a new compensation. Forbidden when updating an existing compensation."},"is_deleted":{"type":"boolean","description":"Flag to mark the variable compensation as deleted. Required only when the variable compensation needs to be removed; omit it otherwise"},"effective_date":{"type":"string","format":"date","description":"The date when this compensation starts or becomes effective. Required when creating a new compensation. Optional when updating an existing compensation."}},"required":["type","amount"],"description":"Represents a change to an employee’s variable compensation (e.g., bonus or commission). This schema is used for creating new variable compensation items or updating existing ones. Some fields are required when creating, optional when updating, and forbidden when updating, as specified in each field description.","title":"EorContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataVariableCompensation"},"EorContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataProbationPeriodTypeForDefinite":{"type":"string","enum":["STANDARD","CUSTOM"],"description":"Type of probation period for definite contracts.","title":"EorContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataProbationPeriodTypeForDefinite"},"EorContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"scope":{"type":"string","description":"Scope of the amendment."},"custom":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataCustomItems"},"description":"An optional array of custom objects."},"salary":{"type":"number","format":"double","description":"Salary for the amendment."},"end_date":{"type":"string","format":"date","description":"End date of the employment."},"holidays":{"type":"number","format":"double","description":"Number of holidays."},"job_title":{"type":"string","description":"Job title associated with the amendment."},"start_date":{"type":"string","format":"date","description":"Start date of the employment."},"hourly_rate":{"type":"number","format":"double","description":"Hourly rate of the amendment. The max value supported is 1e19"},"seniority_id":{"type":"string","format":"uuid","description":"Public Id of the seniority level."},"time_off_type":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataTimeOffType","description":"Type of time off."},"effective_date":{"type":"string","format":"date","description":"Effective date for the amendment."},"seniority_date":{"type":["string","null"],"format":"date","description":"The seniority date represents the employee’s original start date with a previous employer. It is used to preserve employment tenure when the employee transfers to this company. Can be null if not applicable."},"additional_info":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataAdditionalInfo"},{"type":"null"}],"description":"Additional metadata related to job validation and categorisation"},"employment_type":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataEmploymentType","description":"Type of employment."},"employment_state":{"type":"string","description":"State of employment."},"probation_period":{"type":"number","format":"double","description":"Duration of the probation period."},"fixed_adjustments":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataFixedAdjustmentsItems"},"description":"Array of fixed adjustments to be submitted for the amendment request."},"notice_period_type":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataNoticePeriodType","description":"Type of notice period."},"work_hours_per_week":{"type":"number","format":"double","description":"Number of work hours per week."},"variable_compensation":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataVariableCompensation","description":"Represents a change to an employee’s variable compensation (e.g., bonus or commission). This schema is used for creating new variable compensation items or updating existing ones. Some fields are required when creating, optional when updating, and forbidden when updating, as specified in each field description."},"notice_period_after_probation":{"type":"number","format":"double","description":"Notice period after probation."},"notice_period_during_probation":{"type":"number","format":"double","description":"Notice period during probation."},"probation_period_type_for_definite":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaDataProbationPeriodTypeForDefinite","description":"Type of probation period for definite contracts."}},"title":"EorContractsContractIdAmendmentsPostRequestBodyContentApplicationJsonSchemaData"},"EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataType":{"type":"string","enum":["INSTANT","OPS","LEGAL","DISABLED","CUSTOM","AUTOMATED"],"description":"Type of amendment","title":"EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataType"},"EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataItemsItemsType":{"type":"string","enum":["INSTANT","OPS","LEGAL","DISABLED","CUSTOM","AUTOMATED"],"description":"Type of amendment","title":"EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataItemsItemsType"},"EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataItemsItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Id of amendment item"},"item":{"type":"string","description":"Amendment item"},"type":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataItemsItemsType","description":"Type of amendment"},"new_value":{"type":"string","description":"The new valid value after the attempted change."},"data_point":{"type":"string","description":"The field that is selected for amendment."},"previous_value":{"type":"string","description":"The previous valid value before the attempted change."}},"title":"EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataItemsItems"},"EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataSource":{"type":"string","enum":["APP","PUBLIC_API","APP_BULK_AMENDMENT"],"description":"Source of amendment flow creation.","title":"EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataSource"},"EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataCustomItemsItemsStatus":{"type":"string","enum":["REJECTED","APPROVED","PENDING_REVIEW","PENDING_LEGAL"],"description":"Current status of the custom amendment item","title":"EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataCustomItemsItemsStatus"},"EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataCustomItemsItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the custom amendment item"},"type":{"type":"string","description":"Type/context of the custom amendment item"},"status":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataCustomItemsItemsStatus","description":"Current status of the custom amendment item"},"description":{"type":["string","null"],"description":"Detailed description of the custom amendment item"},"rejection_reason":{"type":["string","null"],"description":"Reason for rejection if the item was rejected"}},"required":["id","type","status"],"title":"EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataCustomItemsItems"},"EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataDocumentType":{"type":"string","enum":["EA","SOW","SOW_EA"],"description":"Amendment document type","title":"EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataDocumentType"},"EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataLegalContextStatus":{"type":"string","enum":["REQUEST_LEGAL_REVIEW","WAITING_FOR_ANOTHER_TEAM","WAITING_FOR_HRX_ACTION","DECLINED","SOLVED"],"description":"Current status of the legal review process","title":"EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataLegalContextStatus"},"EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataLegalContext":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataLegalContextStatus","description":"Current status of the legal review process"},"details":{"type":"string","description":"Details regarding the legal request"},"jira_ticket":{"type":"string","description":"Jira ticket identifier linked to the legal context"},"jira_web_url":{"type":"string","format":"uri","description":"Link to the Jira ticket for tracking"},"requested_at":{"type":"string","format":"date-time","description":"Timestamp when legal review was requested"}},"description":"Additional details needed for legal input","title":"EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataLegalContext"},"EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataTimeOffType":{"type":"string","enum":["STANDARD","SPECIFIC","PRORATED"],"description":"Type of time off.","title":"EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataTimeOffType"},"EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataEmploymentType":{"type":"string","enum":["FULL_TIME","PART_TIME"],"description":"Type of employment.","title":"EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataEmploymentType"},"EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataFixedAdjustmentsItemsStatus":{"type":"string","enum":["WAITING_FOR_SIGNING","ACTIVE","OUTDATED","CANCELLED"],"description":"Current status of the fixed adjustment.","title":"EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataFixedAdjustmentsItemsStatus"},"EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataFixedAdjustmentsItems":{"type":"object","properties":{"id":{"type":"string","description":"System-generated unique identifier for the fixed adjustment record in an amendment request."},"value":{"type":"string","description":"Value of the fixed adjustment."},"status":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataFixedAdjustmentsItemsStatus","description":"Current status of the fixed adjustment."},"created_at":{"type":"string","format":"date-time","description":"Timestamp when the fixed adjustment was created."},"is_amended":{"type":"boolean","description":"Whether this fixed adjustment was amended from a previous one."},"is_deleted":{"type":"boolean","description":"True if the fixed adjustment was deleted as part of the amendment; otherwise false."},"updated_at":{"type":"string","format":"date-time","description":"Timestamp when the fixed adjustment was last updated."},"description":{"type":"string","description":"Description of the fixed adjustment."},"is_recurring":{"type":"boolean","description":"Whether the fixed adjustment is recurring. If set to false, it will be treated as a one-time fixed allowance."},"is_country_specific":{"type":"boolean","description":"Whether this fixed adjustment applies only to a specific country."},"parent_fixed_adjustment_id":{"type":["string","null"],"description":"Reference to the parent fixed adjustment, if applicable."}},"required":["id","value","status","created_at","is_amended","updated_at","description","is_recurring","is_country_specific"],"title":"EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataFixedAdjustmentsItems"},"EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataRejectionContext":{"type":"object","properties":{"rejected_at":{"type":"string","format":"date-time","description":"Timestamp of when the rejection occurred"}},"description":"Additional details containing rejection reason","title":"EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataRejectionContext"},"EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataAmendmentStatusesItemsAmendmentFlowStatus":{"type":"object","properties":{"created_at":{"type":"string","format":"date-time","description":"Creation date"}},"description":"Metadata about the amendment status, including when it was created.","title":"EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataAmendmentStatusesItemsAmendmentFlowStatus"},"EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataAmendmentStatusesItems":{"type":"object","properties":{"name":{"type":"string","description":"Logical, system-oriented identifier of the amendment status. Can be used to group statuses under a parent category and subgroup them for more granular state tracking. The structure typically follows a dot-separated hierarchy (e.g., 'PARENT','PARENT.CHILD', 'PARENT.CHILD.CHILD.CHILD', ...), which allows logical grouping and filtering of related statuses."},"friendly_name":{"type":"string","description":"Friendly name of amendment status"},"amendment_flow_status":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataAmendmentStatusesItemsAmendmentFlowStatus","description":"Metadata about the amendment status, including when it was created."}},"title":"EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataAmendmentStatusesItems"},"EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataNoticePeriodType":{"type":"string","enum":["STANDARD","CUSTOM"],"description":"Type of notice period.","title":"EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataNoticePeriodType"},"EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataVoidDeadlineType":{"type":"string","enum":["CUTOFF","START_DATE","END_DATE","EXPIRY"],"description":"Type of void deadline","title":"EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataVoidDeadlineType"},"EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataVariableCompensationType":{"type":"string","enum":["FIXED","PERCENTAGE"],"description":"The way the compensation is calculated. `FIXED` means a fixed amount (like $1000). `PERCENTAGE` means it’s based on a percentage of the salary.","title":"EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataVariableCompensationType"},"EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataVariableCompensationTimeline":{"type":"string","enum":["MONTHLY","QUARTERLY","ANNUALLY","BIANNUALLY"],"description":"How often the compensation is paid — for example monthly, quarterly, annually, or twice a year.","title":"EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataVariableCompensationTimeline"},"EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataVariableCompensationIncentivePlan":{"type":"object","properties":{"details":{"type":"string","description":"Extra details about the incentive plan, if any."},"employee_signature":{"type":"string","description":"The employee’s signature for the incentive plan, if collected."},"employee_signed_at":{"type":"string","format":"date-time","description":"The date and time when the employee signed the incentive plan. Empty if not signed."}},"description":"Details of the incentive plan linked to this compensation, if any.","title":"EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataVariableCompensationIncentivePlan"},"EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataVariableCompensation":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID assigned by the system to this variable compensation record."},"type":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataVariableCompensationType","description":"The way the compensation is calculated. `FIXED` means a fixed amount (like $1000). `PERCENTAGE` means it’s based on a percentage of the salary."},"title":{"type":"string","description":"Title or name of the variable compensation."},"amount":{"type":"string","format":"decimal","description":"The value of the compensation. Shown as a string to keep the exact number of decimals."},"timeline":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataVariableCompensationTimeline","description":"How often the compensation is paid — for example monthly, quarterly, annually, or twice a year."},"parent_id":{"type":["string","null"],"description":"Reference to the parent variable compensation, if applicable. Null if this compensation is not linked to any compensation."},"created_at":{"type":"string","format":"date-time","description":"The date and time when this record was first created in the system."},"is_amended":{"type":"boolean","description":"Shows whether this compensation has been changed as part of an amendment."},"is_deleted":{"type":"boolean","description":"Shows whether this compensation has been deleted."},"updated_at":{"type":"string","format":"date-time","description":"The date and time when this record was last updated."},"effective_date":{"type":"string","format":"date-time","description":"The date when this compensation starts being valid."},"incentive_plan":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataVariableCompensationIncentivePlan","description":"Details of the incentive plan linked to this compensation, if any."}},"required":["id","type","title","amount","timeline","parent_id","created_at","updated_at","effective_date"],"description":"Represents a variable compensation record (such as a bonus, commission, or incentive) within a contract. It contains details like the amount, type, frequency, and whether it is part of an incentive plan. The record also tracks when it was created, updated, and whether it has been amended.","title":"EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataVariableCompensation"},"EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataNoticePeriodTimeUnit":{"type":"string","enum":["DAY","WEEK","MONTH"],"description":"Notice period time unit.","title":"EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataNoticePeriodTimeUnit"},"EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataProbationPeriodTypeForDefinite":{"type":"string","enum":["STANDARD","CUSTOM"],"description":"Type of probation period for definite contracts.","title":"EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataProbationPeriodTypeForDefinite"},"EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Id of amendment"},"type":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataType"},{"type":"null"}],"description":"Type of amendment"},"items":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataItemsItems"},"description":"Items of amendment"},"scope":{"type":"string","description":"Scope of the amendment."},"salary":{"type":"string","description":"Salary for the amendment."},"source":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataSource"},{"type":"null"}],"description":"Source of amendment flow creation."},"currency":{"type":"string","description":"Contract currency."},"end_date":{"type":["string","null"],"format":"date-time","description":"End date of the employment."},"holidays":{"type":["integer","null"],"description":"Number of holidays."},"job_code":{"type":["string","null"],"description":"Job code associated with the job title."},"job_title":{"type":"string","description":"Job title associated with the amendment."},"created_at":{"type":"string","format":"date-time","description":"Creation date of the amendment."},"start_date":{"type":"string","format":"date-time","description":"Start date of the employment."},"updated_at":{"type":"string","format":"date-time","description":"Date when amendment is updated"},"hourly_rate":{"type":["string","null"],"description":"Hourly rate of the amendment"},"custom_items":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataCustomItemsItems"},"description":"Custom amendment items associated with the amendment flow"},"job_category":{"type":["string","null"],"description":"Job category associated with the job title."},"requested_by":{"type":["string","null"],"description":"Profile name of the user who requested the change"},"seniority_id":{"type":["string","null"],"format":"uuid","description":"Seniority level identifier."},"document_type":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataDocumentType"},{"type":"null"}],"description":"Amendment document type"},"legal_context":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataLegalContext"},{"type":"null"}],"description":"Additional details needed for legal input"},"time_off_type":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataTimeOffType","description":"Type of time off."},"void_deadline":{"type":["string","null"],"format":"date-time","description":"Deadline this SOW to be voided"},"effective_date":{"type":["string","null"],"format":"date-time","description":"Effective date of the amendment."},"seniority_date":{"oneOf":[{"description":"Any type"},{"type":"null"}],"description":"The seniority date represents the employee’s original start date with a previous employer. It is used to preserve employment tenure when the employee transfers to this company. Can be null if not applicable."},"employment_type":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataEmploymentType","description":"Type of employment."},"sick_leave_days":{"type":["integer","null"],"description":"Number of sick leave days"},"employment_state":{"type":["string","null"],"description":"State of employment."},"probation_period":{"type":["integer","null"],"description":"Duration of the probation period."},"work_schedule_id":{"type":["string","null"],"format":"uuid","description":"Work schedule id"},"fixed_adjustments":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataFixedAdjustmentsItems"},"description":"List of fixed adjustments associated with the amendment request."},"rejection_context":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataRejectionContext"},{"type":"null"}],"description":"Additional details containing rejection reason"},"amendment_statuses":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataAmendmentStatusesItems"},"description":"List of amendment statuses representing the history and progression of an amendment."},"notice_period_type":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataNoticePeriodType"},{"type":"null"}],"description":"Type of notice period."},"void_deadline_type":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataVoidDeadlineType"},{"type":"null"}],"description":"Type of void deadline"},"work_hours_per_week":{"type":"string","description":"Number of work hours per week."},"employee_nationality":{"type":"string","description":"Nationality of the employee."},"is_hrx_action_needed":{"type":"boolean","description":"Is HRX action needed."},"variable_compensation":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataVariableCompensation","description":"Represents a variable compensation record (such as a bonus, commission, or incentive) within a contract. It contains details like the amount, type, frequency, and whether it is part of an incentive plan. The record also tracks when it was created, updated, and whether it has been amended."},"notice_period_time_unit":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataNoticePeriodTimeUnit"},{"type":"null"}],"description":"Notice period time unit."},"is_effective_date_updated":{"type":"boolean","description":"Is Effective Date updated."},"work_schedule_rules_version":{"type":["string","null"],"description":"Work schedule rule version."},"notice_period_after_probation":{"type":["string","null"],"description":"Notice period after probation."},"notice_period_during_probation":{"type":["string","null"],"description":"Notice period during probation."},"probation_period_type_for_definite":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaDataProbationPeriodTypeForDefinite"},{"type":"null"}],"description":"Type of probation period for definite contracts."}},"title":"EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaData"},"eor-amendments_createContractAmendment_Response_201":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaData"}},"title":"eor-amendments_createContractAmendment_Response_201"},"EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"title":"EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaErrorsItems"},"CreateAnEorContractAmendment-v2026-01-01RequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"CreateAnEorContractAmendment-v2026-01-01RequestBadRequestError"},"CreateAnEorContractAmendment-v2026-01-01RequestNotFoundError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"CreateAnEorContractAmendment-v2026-01-01RequestNotFoundError"},"CreateAnEorContractAmendment-v2026-01-01RequestConflictError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"CreateAnEorContractAmendment-v2026-01-01RequestConflictError"},"CreateAnEorContractAmendment-v2026-01-01RequestUnprocessableEntityError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaErrorsItems"},"description":"List of validation or business rule errors."}},"required":["errors"],"title":"CreateAnEorContractAmendment-v2026-01-01RequestUnprocessableEntityError"},"CreateAnEorContractAmendment-v2026-01-01RequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"CreateAnEorContractAmendment-v2026-01-01RequestInternalServerError"},"EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataType":{"type":"string","enum":["INSTANT","OPS","LEGAL","DISABLED","CUSTOM","AUTOMATED"],"description":"Type of amendment","title":"EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataType"},"EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataItemsItemsType":{"type":"string","enum":["INSTANT","OPS","LEGAL","DISABLED","CUSTOM","AUTOMATED"],"description":"Type of amendment","title":"EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataItemsItemsType"},"EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataItemsItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Id of amendment item"},"item":{"type":"string","description":"Amendment item"},"type":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataItemsItemsType","description":"Type of amendment"},"new_value":{"type":"string","description":"The new valid value after the attempted change."},"data_point":{"type":"string","description":"The field that is selected for amendment."},"previous_value":{"type":"string","description":"The previous valid value before the attempted change."}},"title":"EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataItemsItems"},"EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataSource":{"type":"string","enum":["APP","PUBLIC_API","APP_BULK_AMENDMENT"],"description":"Source of amendment flow creation.","title":"EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataSource"},"EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataCustomItemsItemsStatus":{"type":"string","enum":["REJECTED","APPROVED","PENDING_REVIEW","PENDING_LEGAL"],"description":"Current status of the custom amendment item","title":"EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataCustomItemsItemsStatus"},"EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataCustomItemsItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the custom amendment item"},"type":{"type":"string","description":"Type/context of the custom amendment item"},"status":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataCustomItemsItemsStatus","description":"Current status of the custom amendment item"},"description":{"type":["string","null"],"description":"Detailed description of the custom amendment item"},"rejection_reason":{"type":["string","null"],"description":"Reason for rejection if the item was rejected"}},"required":["id","type","status"],"title":"EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataCustomItemsItems"},"EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataDocumentType":{"type":"string","enum":["EA","SOW","SOW_EA"],"description":"Amendment document type","title":"EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataDocumentType"},"EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataLegalContextStatus":{"type":"string","enum":["REQUEST_LEGAL_REVIEW","WAITING_FOR_ANOTHER_TEAM","WAITING_FOR_HRX_ACTION","DECLINED","SOLVED"],"description":"Current status of the legal review process","title":"EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataLegalContextStatus"},"EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataLegalContext":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataLegalContextStatus","description":"Current status of the legal review process"},"details":{"type":"string","description":"Details regarding the legal request"},"jira_ticket":{"type":"string","description":"Jira ticket identifier linked to the legal context"},"jira_web_url":{"type":"string","format":"uri","description":"Link to the Jira ticket for tracking"},"requested_at":{"type":"string","format":"date-time","description":"Timestamp when legal review was requested"}},"description":"Additional details needed for legal input","title":"EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataLegalContext"},"EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataTimeOffType":{"type":"string","enum":["STANDARD","SPECIFIC","PRORATED"],"description":"Type of time off.","title":"EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataTimeOffType"},"EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataEmploymentType":{"type":"string","enum":["FULL_TIME","PART_TIME"],"description":"Type of employment.","title":"EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataEmploymentType"},"EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataFixedAdjustmentsItemsStatus":{"type":"string","enum":["WAITING_FOR_SIGNING","ACTIVE","OUTDATED","CANCELLED"],"description":"Current status of the fixed adjustment.","title":"EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataFixedAdjustmentsItemsStatus"},"EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataFixedAdjustmentsItems":{"type":"object","properties":{"id":{"type":"string","description":"System-generated unique identifier for the fixed adjustment record in an amendment request."},"value":{"type":"string","description":"Value of the fixed adjustment."},"status":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataFixedAdjustmentsItemsStatus","description":"Current status of the fixed adjustment."},"created_at":{"type":"string","format":"date-time","description":"Timestamp when the fixed adjustment was created."},"is_amended":{"type":"boolean","description":"Whether this fixed adjustment was amended from a previous one."},"is_deleted":{"type":"boolean","description":"True if the fixed adjustment was deleted as part of the amendment; otherwise false."},"updated_at":{"type":"string","format":"date-time","description":"Timestamp when the fixed adjustment was last updated."},"description":{"type":"string","description":"Description of the fixed adjustment."},"is_recurring":{"type":"boolean","description":"Whether the fixed adjustment is recurring. If set to false, it will be treated as a one-time fixed allowance."},"is_country_specific":{"type":"boolean","description":"Whether this fixed adjustment applies only to a specific country."},"parent_fixed_adjustment_id":{"type":["string","null"],"description":"Reference to the parent fixed adjustment, if applicable."}},"required":["id","value","status","created_at","is_amended","updated_at","description","is_recurring","is_country_specific"],"title":"EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataFixedAdjustmentsItems"},"EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataRejectionContext":{"type":"object","properties":{"rejected_at":{"type":"string","format":"date-time","description":"Timestamp of when the rejection occurred"}},"description":"Additional details containing rejection reason","title":"EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataRejectionContext"},"EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataAmendmentStatusesItemsAmendmentFlowStatus":{"type":"object","properties":{"created_at":{"type":"string","format":"date-time","description":"The timestamp when this amendment status was created."}},"description":"Metadata about the amendment status, including when it was created.","title":"EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataAmendmentStatusesItemsAmendmentFlowStatus"},"EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataAmendmentStatusesItems":{"type":"object","properties":{"name":{"type":"string","description":"Logical, system-oriented identifier of the amendment status. Can be used to group statuses under a parent category and subgroup them for more granular state tracking. The structure typically follows a dot-separated hierarchy (e.g., 'PARENT','PARENT.CHILD', 'PARENT.CHILD.CHILD.CHILD', ...), which allows logical grouping and filtering of related statuses."},"friendly_name":{"type":"string","description":"Human-readable label of the amendment status (e.g., DRAFT, PENDING, APPROVED)."},"amendment_flow_status":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataAmendmentStatusesItemsAmendmentFlowStatus","description":"Metadata about the amendment status, including when it was created."}},"description":"Details of a specific amendment status in the lifecycle of the amendment.","title":"EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataAmendmentStatusesItems"},"EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataNoticePeriodType":{"type":"string","enum":["STANDARD","CUSTOM"],"description":"Type of notice period.","title":"EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataNoticePeriodType"},"EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataVoidDeadlineType":{"type":"string","enum":["CUTOFF","START_DATE","END_DATE","EXPIRY"],"description":"Type of void deadline","title":"EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataVoidDeadlineType"},"EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataVariableCompensationType":{"type":"string","enum":["FIXED","PERCENTAGE"],"description":"The way the compensation is calculated. `FIXED` means a fixed amount (like $1000). `PERCENTAGE` means it’s based on a percentage of the salary.","title":"EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataVariableCompensationType"},"EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataVariableCompensationTimeline":{"type":"string","enum":["MONTHLY","QUARTERLY","ANNUALLY","BIANNUALLY"],"description":"How often the compensation is paid — for example monthly, quarterly, annually, or twice a year.","title":"EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataVariableCompensationTimeline"},"EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataVariableCompensationIncentivePlan":{"type":"object","properties":{"details":{"type":"string","description":"Extra details about the incentive plan, if any."},"employee_signature":{"type":"string","description":"The employee’s signature for the incentive plan, if collected."},"employee_signed_at":{"type":"string","format":"date-time","description":"The date and time when the employee signed the incentive plan. Empty if not signed."}},"description":"Details of the incentive plan linked to this compensation, if any.","title":"EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataVariableCompensationIncentivePlan"},"EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataVariableCompensation":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID assigned by the system to this variable compensation record."},"type":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataVariableCompensationType","description":"The way the compensation is calculated. `FIXED` means a fixed amount (like $1000). `PERCENTAGE` means it’s based on a percentage of the salary."},"title":{"type":"string","description":"Title or name of the variable compensation."},"amount":{"type":"string","format":"decimal","description":"The value of the compensation. Shown as a string to keep the exact number of decimals."},"timeline":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataVariableCompensationTimeline","description":"How often the compensation is paid — for example monthly, quarterly, annually, or twice a year."},"parent_id":{"type":["string","null"],"description":"Reference to the parent variable compensation, if applicable. Null if this compensation is not linked to any compensation."},"created_at":{"type":"string","format":"date-time","description":"The date and time when this record was first created in the system."},"is_amended":{"type":"boolean","description":"Shows whether this compensation has been changed as part of an amendment."},"is_deleted":{"type":"boolean","description":"Shows whether this compensation has been deleted."},"updated_at":{"type":"string","format":"date-time","description":"The date and time when this record was last updated."},"effective_date":{"type":"string","format":"date-time","description":"The date when this compensation starts being valid."},"incentive_plan":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataVariableCompensationIncentivePlan","description":"Details of the incentive plan linked to this compensation, if any."}},"required":["id","type","title","amount","timeline","parent_id","created_at","updated_at","effective_date"],"description":"Represents a variable compensation record (such as a bonus, commission, or incentive) within a contract. It contains details like the amount, type, frequency, and whether it is part of an incentive plan. The record also tracks when it was created, updated, and whether it has been amended.","title":"EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataVariableCompensation"},"EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataNoticePeriodTimeUnit":{"type":"string","enum":["DAY","WEEK","MONTH"],"description":"Notice period time unit.","title":"EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataNoticePeriodTimeUnit"},"EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataProbationPeriodTypeForDefinite":{"type":"string","enum":["STANDARD","CUSTOM"],"description":"Type of probation period for definite contracts.","title":"EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataProbationPeriodTypeForDefinite"},"EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Id of amendment"},"type":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataType"},{"type":"null"}],"description":"Type of amendment"},"items":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataItemsItems"},"description":"Items of amendment"},"scope":{"type":"string","description":"Scope of the amendment."},"salary":{"type":"string","description":"Salary for the amendment."},"source":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataSource"},{"type":"null"}],"description":"Source of amendment flow creation."},"currency":{"type":"string","description":"Contract currency."},"end_date":{"type":["string","null"],"format":"date-time","description":"End date of the employment."},"holidays":{"type":["integer","null"],"description":"Number of holidays."},"job_code":{"type":["string","null"],"description":"Job code associated with the job title."},"job_title":{"type":"string","description":"Job title associated with the amendment."},"created_at":{"type":"string","format":"date-time","description":"Creation date of the amendment."},"start_date":{"type":"string","format":"date-time","description":"Start date of the employment."},"updated_at":{"type":"string","format":"date-time","description":"Date when amendment is updated"},"hourly_rate":{"type":["string","null"],"description":"Hourly rate of the amendment"},"custom_items":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataCustomItemsItems"},"description":"Custom amendment items associated with the amendment flow"},"job_category":{"type":["string","null"],"description":"Job category associated with the job title."},"requested_by":{"type":["string","null"],"description":"Profile name of the user who requested the change"},"seniority_id":{"type":["string","null"],"format":"uuid","description":"Seniority level identifier."},"document_type":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataDocumentType"},{"type":"null"}],"description":"Amendment document type"},"legal_context":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataLegalContext"},{"type":"null"}],"description":"Additional details needed for legal input"},"time_off_type":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataTimeOffType","description":"Type of time off."},"void_deadline":{"type":["string","null"],"format":"date-time","description":"Deadline this SOW to be voided"},"effective_date":{"type":["string","null"],"format":"date-time","description":"Effective date of the amendment."},"seniority_date":{"type":["string","null"],"format":"date","description":"The seniority date represents the employee’s original start date with a previous employer. It is used to preserve employment tenure when the employee transfers to this company. Can be null if not applicable."},"employment_type":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataEmploymentType","description":"Type of employment."},"sick_leave_days":{"type":["integer","null"],"description":"Number of sick leave days"},"employment_state":{"type":["string","null"],"description":"State of employment."},"probation_period":{"type":["integer","null"],"description":"Duration of the probation period."},"work_schedule_id":{"type":["string","null"],"format":"uuid","description":"Work schedule id"},"fixed_adjustments":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataFixedAdjustmentsItems"},"description":"List of fixed adjustments associated with the amendment request."},"rejection_context":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataRejectionContext"},{"type":"null"}],"description":"Additional details containing rejection reason"},"amendment_statuses":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataAmendmentStatusesItems"},"description":"List of amendment statuses representing the history and progression of an amendment."},"notice_period_type":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataNoticePeriodType"},{"type":"null"}],"description":"Type of notice period."},"void_deadline_type":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataVoidDeadlineType"},{"type":"null"}],"description":"Type of void deadline"},"work_hours_per_week":{"type":"string","description":"Number of work hours per week."},"employee_nationality":{"type":"string","description":"Nationality of the employee."},"is_hrx_action_needed":{"type":"boolean","description":"Is HRX action needed."},"variable_compensation":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataVariableCompensation","description":"Represents a variable compensation record (such as a bonus, commission, or incentive) within a contract. It contains details like the amount, type, frequency, and whether it is part of an incentive plan. The record also tracks when it was created, updated, and whether it has been amended."},"notice_period_time_unit":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataNoticePeriodTimeUnit"},{"type":"null"}],"description":"Notice period time unit."},"is_effective_date_updated":{"type":"boolean","description":"Is Effective Date updated."},"work_schedule_rules_version":{"type":["string","null"],"description":"Work schedule rule version."},"notice_period_after_probation":{"type":["string","null"],"description":"Notice period after probation."},"notice_period_during_probation":{"type":["string","null"],"description":"Notice period during probation."},"probation_period_type_for_definite":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaDataProbationPeriodTypeForDefinite"},{"type":"null"}],"description":"Type of probation period for definite contracts."}},"title":"EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaData"},"eor-amendments_getContractAmendmentById_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaData"}},"title":"eor-amendments_getContractAmendmentById_Response_200"},"EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"title":"EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaErrorsItems"},"ViewInformationAboutAmendmentRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"ViewInformationAboutAmendmentRequestBadRequestError"},"ViewInformationAboutAmendmentRequestNotFoundError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"ViewInformationAboutAmendmentRequestNotFoundError"},"ViewInformationAboutAmendmentRequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"ViewInformationAboutAmendmentRequestInternalServerError"},"EorContractsContractIdAmendmentsValidationSettingsGetResponsesContentApplicationJsonSchemaDataItemsRulesItemsRequires":{"type":"object","properties":{},"description":"Contract conditions that must be met for this rule to be applied.","title":"EorContractsContractIdAmendmentsValidationSettingsGetResponsesContentApplicationJsonSchemaDataItemsRulesItemsRequires"},"EorContractsContractIdAmendmentsValidationSettingsGetResponsesContentApplicationJsonSchemaDataItemsRulesItemsAdditionalDetailsRule":{"type":"string","enum":["ONE_QUARTER_OF_CONTRACT_DURATION","ONE_THIRD_OF_CONTRACT_DURATION","HALF_OF_CONTRACT_DURATION"],"description":"Specific rule that applies for probation period.","title":"EorContractsContractIdAmendmentsValidationSettingsGetResponsesContentApplicationJsonSchemaDataItemsRulesItemsAdditionalDetailsRule"},"EorContractsContractIdAmendmentsValidationSettingsGetResponsesContentApplicationJsonSchemaDataItemsRulesItemsAdditionalDetailsTimeUnit":{"type":"string","enum":["WEEK","MONTH","DAY"],"description":"The unit of time applicable to notice period.","title":"EorContractsContractIdAmendmentsValidationSettingsGetResponsesContentApplicationJsonSchemaDataItemsRulesItemsAdditionalDetailsTimeUnit"},"EorContractsContractIdAmendmentsValidationSettingsGetResponsesContentApplicationJsonSchemaDataItemsRulesItemsAdditionalDetails":{"type":"object","properties":{"cap":{"type":["number","null"],"format":"double","description":"The maximum limit imposed for probation period for definite contract when specific calculation is used, it will be in additional_details.rule."},"note":{"type":["string","null"],"description":"Additional explanation or notes related to this rule."},"rule":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsValidationSettingsGetResponsesContentApplicationJsonSchemaDataItemsRulesItemsAdditionalDetailsRule"},{"type":"null"}],"description":"Specific rule that applies for probation period."},"time_unit":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsValidationSettingsGetResponsesContentApplicationJsonSchemaDataItemsRulesItemsAdditionalDetailsTimeUnit"},{"type":"null"}],"description":"The unit of time applicable to notice period."}},"description":"Optional additional information for rules, if applicable.","title":"EorContractsContractIdAmendmentsValidationSettingsGetResponsesContentApplicationJsonSchemaDataItemsRulesItemsAdditionalDetails"},"EorContractsContractIdAmendmentsValidationSettingsGetResponsesContentApplicationJsonSchemaDataItemsRulesItemsTenureBasedRulesItemsEmploymentDurationType":{"type":"string","enum":["DAY","WEEK","MONTH","YEAR"],"description":"The unit of measurement for the employment duration.","title":"EorContractsContractIdAmendmentsValidationSettingsGetResponsesContentApplicationJsonSchemaDataItemsRulesItemsTenureBasedRulesItemsEmploymentDurationType"},"EorContractsContractIdAmendmentsValidationSettingsGetResponsesContentApplicationJsonSchemaDataItemsRulesItemsTenureBasedRulesItems":{"type":"object","properties":{"notice_value":{"type":["integer","null"],"description":"The required notice period for this range of employment duration."},"max_employment_duration":{"type":["integer","null"],"description":"The maximum duration of employment for this rule to apply."},"min_employment_duration":{"type":["integer","null"],"description":"The minimum duration of employment for this rule to apply."},"employment_duration_type":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsValidationSettingsGetResponsesContentApplicationJsonSchemaDataItemsRulesItemsTenureBasedRulesItemsEmploymentDurationType"},{"type":"null"}],"description":"The unit of measurement for the employment duration."}},"title":"EorContractsContractIdAmendmentsValidationSettingsGetResponsesContentApplicationJsonSchemaDataItemsRulesItemsTenureBasedRulesItems"},"EorContractsContractIdAmendmentsValidationSettingsGetResponsesContentApplicationJsonSchemaDataItemsRulesItems":{"type":"object","properties":{"max":{"type":"number","format":"double","description":"The maximum allowable value for numerical data points."},"min":{"type":["number","null"],"format":"double","description":"The minimum allowable value for numerical data points."},"max_date":{"type":["string","null"],"format":"date","description":"The latest allowable date for date-type data points."},"min_date":{"type":["string","null"],"format":"date","description":"The earliest allowable date for date-type data points."},"nullable":{"type":"boolean","description":"Indicates whether the data point can be null."},"requires":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsValidationSettingsGetResponsesContentApplicationJsonSchemaDataItemsRulesItemsRequires","description":"Contract conditions that must be met for this rule to be applied."},"is_editable":{"type":"boolean","description":"Indicates whether the data point can be updated."},"possible_options":{"type":"array","items":{"type":"string"},"description":"A list of possible values the data point can have. Unique for each data point."},"additional_details":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsValidationSettingsGetResponsesContentApplicationJsonSchemaDataItemsRulesItemsAdditionalDetails","description":"Optional additional information for rules, if applicable."},"tenure_based_rules":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsValidationSettingsGetResponsesContentApplicationJsonSchemaDataItemsRulesItemsTenureBasedRulesItems"},"description":"Defines notice period rules based on the duration of employment."},"external_validation":{"type":"boolean","description":"Indicates whether external validation/fetching is required for this data point. If yes, the information for this data point must be retrieved using another endpoint."}},"title":"EorContractsContractIdAmendmentsValidationSettingsGetResponsesContentApplicationJsonSchemaDataItemsRulesItems"},"EorContractsContractIdAmendmentsValidationSettingsGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"rules":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsValidationSettingsGetResponsesContentApplicationJsonSchemaDataItemsRulesItems"},"description":"The rules for the data point."},"data_point":{"type":"string","description":"The name of the data point being configured."}},"title":"EorContractsContractIdAmendmentsValidationSettingsGetResponsesContentApplicationJsonSchemaDataItems"},"eor-amendments_getContractAmendmentsValidationSettings_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsValidationSettingsGetResponsesContentApplicationJsonSchemaDataItems"}}},"title":"eor-amendments_getContractAmendmentsValidationSettings_Response_200"},"EorContractsContractIdAmendmentsValidationSettingsGetResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"title":"EorContractsContractIdAmendmentsValidationSettingsGetResponsesContentApplicationJsonSchemaErrorsItems"},"GetAmendmentValidationSettingsForAnEorContractRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsValidationSettingsGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"GetAmendmentValidationSettingsForAnEorContractRequestBadRequestError"},"GetAmendmentValidationSettingsForAnEorContractRequestNotFoundError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsValidationSettingsGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"GetAmendmentValidationSettingsForAnEorContractRequestNotFoundError"},"GetAmendmentValidationSettingsForAnEorContractRequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsValidationSettingsGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"GetAmendmentValidationSettingsForAnEorContractRequestInternalServerError"},"EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsType":{"type":"string","enum":["INSTANT","OPS","LEGAL","DISABLED","CUSTOM","AUTOMATED"],"description":"Type of amendment","title":"EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsType"},"EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsItemsItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Id of amendment item"},"item":{"type":"string","description":"Amendment item"},"type":{"type":"string","description":"Type of amendment"},"new_value":{"type":"string","description":"The new valid value after the attempted change."},"data_point":{"type":"string","description":"The field that is selected for amendment."},"previous_value":{"type":"string","description":"The previous valid value before the attempted change."}},"title":"EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsItemsItems"},"EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsSource":{"type":"string","enum":["APP","PUBLIC_API","APP_BULK_AMENDMENT"],"description":"Source of amendment flow creation.","title":"EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsSource"},"EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsCustomItemsItemsStatus":{"type":"string","enum":["REJECTED","APPROVED","PENDING_REVIEW","PENDING_LEGAL"],"description":"Current status of the custom amendment item","title":"EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsCustomItemsItemsStatus"},"EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsCustomItemsItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the custom amendment item"},"type":{"type":"string","description":"Type/context of the custom amendment item"},"status":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsCustomItemsItemsStatus","description":"Current status of the custom amendment item"},"description":{"type":["string","null"],"description":"Detailed description of the custom amendment item"},"rejection_reason":{"type":["string","null"],"description":"Reason for rejection if the item was rejected"}},"required":["id","type","status"],"title":"EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsCustomItemsItems"},"EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsDocumentType":{"type":"string","enum":["EA","SOW","SOW_EA"],"description":"Amendment document type","title":"EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsDocumentType"},"EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsLegalContextStatus":{"type":"string","enum":["REQUEST_LEGAL_REVIEW","WAITING_FOR_ANOTHER_TEAM","WAITING_FOR_HRX_ACTION","DECLINED","SOLVED","SOLVE_LEGAL","LEGAL_JIRA_REOPENED"],"description":"Current status of the legal review process","title":"EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsLegalContextStatus"},"EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsLegalContext":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsLegalContextStatus","description":"Current status of the legal review process"},"details":{"type":"string","description":"Details regarding the legal request"},"jira_ticket":{"type":"string","description":"Jira ticket identifier linked to the legal context"},"jira_web_url":{"type":"string","format":"uri","description":"Link to the Jira ticket for tracking"},"requested_at":{"type":"string","format":"date-time","description":"Timestamp when legal review was requested"}},"description":"Additional details needed for legal input","title":"EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsLegalContext"},"EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsTimeOffType":{"type":"string","enum":["STANDARD","SPECIFIC","PRORATED"],"description":"Type of time off.","title":"EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsTimeOffType"},"EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsEmploymentType":{"type":"string","enum":["FULL_TIME","PART_TIME"],"description":"Type of employment.","title":"EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsEmploymentType"},"EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsFixedAdjustmentsItemsStatus":{"type":"string","enum":["WAITING_FOR_SIGNING","ACTIVE","OUTDATED","CANCELLED"],"description":"Current status of the fixed adjustment.","title":"EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsFixedAdjustmentsItemsStatus"},"EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsFixedAdjustmentsItems":{"type":"object","properties":{"id":{"type":"string","description":"System-generated unique identifier for the fixed adjustment record in an amendment request."},"value":{"type":"string","description":"Value of the fixed adjustment."},"status":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsFixedAdjustmentsItemsStatus","description":"Current status of the fixed adjustment."},"created_at":{"type":"string","format":"date-time","description":"Timestamp when the fixed adjustment was created."},"is_amended":{"type":"boolean","description":"Whether this fixed adjustment was amended from a previous one."},"is_deleted":{"type":"boolean","description":"True if the fixed adjustment was deleted as part of the amendment; otherwise false."},"updated_at":{"type":"string","format":"date-time","description":"Timestamp when the fixed adjustment was last updated."},"description":{"type":"string","description":"Description of the fixed adjustment."},"is_recurring":{"type":"boolean","description":"Whether the fixed adjustment is recurring. If set to false, it will be treated as a one-time fixed allowance."},"is_country_specific":{"type":"boolean","description":"Whether this fixed adjustment applies only to a specific country."},"parent_fixed_adjustment_id":{"type":["string","null"],"description":"Reference to the parent fixed adjustment, if applicable."}},"required":["id","value","status","created_at","is_amended","updated_at","description","is_recurring","is_country_specific"],"title":"EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsFixedAdjustmentsItems"},"EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsRejectionContext":{"type":"object","properties":{"rejected_at":{"type":"string","format":"date-time","description":"Timestamp of when the rejection occurred"}},"description":"Additional details containing rejection reason","title":"EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsRejectionContext"},"EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsAmendmentStatusesItemsAmendmentFlowStatus":{"type":"object","properties":{"created_at":{"type":"string","format":"date-time","description":"Creation date"}},"description":"Metadata about the amendment status, including when it was created.","title":"EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsAmendmentStatusesItemsAmendmentFlowStatus"},"EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsAmendmentStatusesItems":{"type":"object","properties":{"name":{"type":"string","description":"Logical, system-oriented identifier of the amendment status. Can be used to group statuses under a parent category and subgroup them for more granular state tracking. The structure typically follows a dot-separated hierarchy (e.g., 'PARENT','PARENT.CHILD', 'PARENT.CHILD.CHILD.CHILD', ...), which allows logical grouping and filtering of related statuses."},"friendly_name":{"type":"string","description":"Friendly name of amendment status"},"amendment_flow_status":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsAmendmentStatusesItemsAmendmentFlowStatus","description":"Metadata about the amendment status, including when it was created."}},"title":"EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsAmendmentStatusesItems"},"EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsNoticePeriodType":{"type":"string","enum":["STANDARD","CUSTOM"],"description":"Type of notice period.","title":"EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsNoticePeriodType"},"EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsVoidDeadlineType":{"type":"string","enum":["CUTOFF","START_DATE","END_DATE","EXPIRY"],"description":"Type of void deadline","title":"EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsVoidDeadlineType"},"EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsVariableCompensationType":{"type":"string","enum":["FIXED","PERCENTAGE"],"description":"The way the compensation is calculated. `FIXED` means a fixed amount (like $1000). `PERCENTAGE` means it’s based on a percentage of the salary.","title":"EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsVariableCompensationType"},"EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsVariableCompensationTimeline":{"type":"string","enum":["MONTHLY","QUARTERLY","ANNUALLY","BIANNUALLY"],"description":"How often the compensation is paid — for example monthly, quarterly, annually, or twice a year.","title":"EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsVariableCompensationTimeline"},"EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsVariableCompensationIncentivePlan":{"type":"object","properties":{"details":{"type":"string","description":"Extra details about the incentive plan, if any."},"employee_signature":{"type":"string","description":"The employee’s signature for the incentive plan, if collected."},"employee_signed_at":{"type":"string","format":"date-time","description":"The date and time when the employee signed the incentive plan. Empty if not signed."}},"description":"Details of the incentive plan linked to this compensation, if any.","title":"EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsVariableCompensationIncentivePlan"},"EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsVariableCompensation":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID assigned by the system to this variable compensation record."},"type":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsVariableCompensationType","description":"The way the compensation is calculated. `FIXED` means a fixed amount (like $1000). `PERCENTAGE` means it’s based on a percentage of the salary."},"title":{"type":"string","description":"Title or name of the variable compensation."},"amount":{"type":"string","format":"decimal","description":"The value of the compensation. Shown as a string to keep the exact number of decimals."},"timeline":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsVariableCompensationTimeline","description":"How often the compensation is paid — for example monthly, quarterly, annually, or twice a year."},"parent_id":{"type":["string","null"],"description":"Reference to the parent variable compensation, if applicable. Null if this compensation is not linked to any compensation."},"created_at":{"type":"string","format":"date-time","description":"The date and time when this record was first created in the system."},"is_amended":{"type":"boolean","description":"Shows whether this compensation has been changed as part of an amendment."},"is_deleted":{"type":"boolean","description":"Shows whether this compensation has been deleted."},"updated_at":{"type":"string","format":"date-time","description":"The date and time when this record was last updated."},"effective_date":{"type":"string","format":"date-time","description":"The date when this compensation starts being valid."},"incentive_plan":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsVariableCompensationIncentivePlan","description":"Details of the incentive plan linked to this compensation, if any."}},"required":["id","type","title","amount","timeline","parent_id","created_at","updated_at","effective_date"],"description":"Represents a variable compensation record (such as a bonus, commission, or incentive) within a contract. It contains details like the amount, type, frequency, and whether it is part of an incentive plan. The record also tracks when it was created, updated, and whether it has been amended.","title":"EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsVariableCompensation"},"EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsNoticePeriodTimeUnit":{"type":"string","enum":["DAY","WEEK","MONTH"],"description":"Notice period time unit.","title":"EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsNoticePeriodTimeUnit"},"EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsProbationPeriodTypeForDefinite":{"type":"string","enum":["STANDARD","CUSTOM"],"description":"Type of probation period for definite contracts.","title":"EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsProbationPeriodTypeForDefinite"},"EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Id of amendment"},"type":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsType"},{"type":"null"}],"description":"Type of amendment"},"items":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsItemsItems"},"description":"Items of amendment"},"scope":{"type":"string","description":"Scope of the amendment."},"salary":{"type":"string","description":"Salary for the amendment."},"source":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsSource"},{"type":"null"}],"description":"Source of amendment flow creation."},"currency":{"type":"string","description":"Contract currency."},"end_date":{"type":["string","null"],"format":"date-time","description":"End date of the employment."},"holidays":{"type":["integer","null"],"description":"Number of holidays."},"job_code":{"type":["string","null"],"description":"Job code associated with the job title."},"job_title":{"type":"string","description":"Job title associated with the amendment."},"created_at":{"type":"string","format":"date-time","description":"Creation date of the amendment."},"start_date":{"type":"string","format":"date-time","description":"Start date of the employment."},"updated_at":{"type":"string","format":"date-time","description":"Date when amendment is updated"},"hourly_rate":{"type":["string","null"],"description":"Hourly rate of the amendment"},"custom_items":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsCustomItemsItems"},"description":"Custom amendment items associated with the amendment flow"},"job_category":{"type":["string","null"],"description":"Job category associated with the job title."},"requested_by":{"type":["string","null"],"description":"Profile name of the user who requested the change"},"seniority_id":{"type":["string","null"],"format":"uuid","description":"New seniority level identifier."},"document_type":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsDocumentType"},{"type":"null"}],"description":"Amendment document type"},"legal_context":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsLegalContext"},{"type":"null"}],"description":"Additional details needed for legal input"},"time_off_type":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsTimeOffType","description":"Type of time off."},"void_deadline":{"type":["string","null"],"format":"date-time","description":"Deadline this SOW to be voided"},"effective_date":{"type":["string","null"],"format":"date-time","description":"Effective date of the amendment."},"seniority_date":{"type":["string","null"],"format":"date-time","description":"The seniority date represents the employee’s original start date with a previous employer. It is used to preserve employment tenure when the employee transfers to this company. Can be null if not applicable."},"employment_type":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsEmploymentType","description":"Type of employment."},"sick_leave_days":{"type":["integer","null"],"description":"Number of sick leave days"},"employment_state":{"type":["string","null"],"description":"State of employment."},"probation_period":{"type":["integer","null"],"description":"Duration of the probation period."},"work_schedule_id":{"type":["string","null"],"format":"uuid","description":"Work schedule id"},"fixed_adjustments":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsFixedAdjustmentsItems"},"description":"List of fixed adjustments associated with the amendment request."},"rejection_context":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsRejectionContext"},{"type":"null"}],"description":"Additional details containing rejection reason"},"amendment_statuses":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsAmendmentStatusesItems"},"description":"List of amendment statuses representing the history and progression of an amendment."},"notice_period_type":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsNoticePeriodType"},{"type":"null"}],"description":"Type of notice period."},"void_deadline_type":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsVoidDeadlineType"},{"type":"null"}],"description":"Type of void deadline"},"work_hours_per_week":{"type":"string","description":"Number of work hours per week."},"employee_nationality":{"type":"string","description":"Nationality of the employee."},"is_hrx_action_needed":{"type":"boolean","description":"Is HRX action needed."},"variable_compensation":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsVariableCompensation","description":"Represents a variable compensation record (such as a bonus, commission, or incentive) within a contract. It contains details like the amount, type, frequency, and whether it is part of an incentive plan. The record also tracks when it was created, updated, and whether it has been amended."},"notice_period_time_unit":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsNoticePeriodTimeUnit"},{"type":"null"}],"description":"Notice period time unit."},"is_effective_date_updated":{"type":"boolean","description":"Is Effective Date updated."},"work_schedule_rules_version":{"type":["string","null"],"description":"Work schedule rule version."},"notice_period_after_probation":{"type":["string","null"],"description":"Notice period after probation."},"notice_period_during_probation":{"type":["string","null"],"description":"Notice period during probation."},"probation_period_type_for_definite":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItemsProbationPeriodTypeForDefinite"},{"type":"null"}],"description":"Type of probation period for definite contracts."}},"title":"EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItems"},"eor-amendments_getContractAmendments_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaDataItems"}}},"title":"eor-amendments_getContractAmendments_Response_200"},"EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"title":"EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaErrorsItems"},"ListAllAmendmentsForAnEorContract-v2026-01-01RequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"ListAllAmendmentsForAnEorContract-v2026-01-01RequestBadRequestError"},"ListAllAmendmentsForAnEorContract-v2026-01-01RequestNotFoundError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"ListAllAmendmentsForAnEorContract-v2026-01-01RequestNotFoundError"},"ListAllAmendmentsForAnEorContract-v2026-01-01RequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"ListAllAmendmentsForAnEorContract-v2026-01-01RequestInternalServerError"},"EorContractsContractIdAmendmentsAmendmentIdEffectiveDateLimitationsGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"message":{"type":"string","description":"Optional human-readable additional explanation on effective date limitation"},"is_hidden":{"type":"boolean","description":"Indicates if the effective date field should be hidden."},"is_disabled":{"type":"boolean","description":"Indicates if the effective date field is disabled"},"max_effective_date":{"type":["string","null"],"format":"date","description":"The latest valid effective date"},"min_effective_date":{"type":["string","null"],"format":"date-time","description":"The earliest valid effective date"},"default_effective_date":{"type":["string","null"],"format":"date-time","description":"A default effective date suggested by the system"}},"title":"EorContractsContractIdAmendmentsAmendmentIdEffectiveDateLimitationsGetResponsesContentApplicationJsonSchemaData"},"eor-amendments_getContractAmendmentEffectiveDateLimitations_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdEffectiveDateLimitationsGetResponsesContentApplicationJsonSchemaData"}},"title":"eor-amendments_getContractAmendmentEffectiveDateLimitations_Response_200"},"EorContractsContractIdAmendmentsAmendmentIdEffectiveDateLimitationsGetResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"title":"EorContractsContractIdAmendmentsAmendmentIdEffectiveDateLimitationsGetResponsesContentApplicationJsonSchemaErrorsItems"},"RetrieveEffectiveDateLimitationsRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdEffectiveDateLimitationsGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"RetrieveEffectiveDateLimitationsRequestBadRequestError"},"RetrieveEffectiveDateLimitationsRequestNotFoundError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdEffectiveDateLimitationsGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"RetrieveEffectiveDateLimitationsRequestNotFoundError"},"RetrieveEffectiveDateLimitationsRequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdEffectiveDateLimitationsGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"RetrieveEffectiveDateLimitationsRequestInternalServerError"},"EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataType":{"type":"string","enum":["INSTANT","OPS","LEGAL","DISABLED","CUSTOM","AUTOMATED"],"description":"Type of amendment","title":"EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataType"},"EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataItemsItemsType":{"type":"string","enum":["INSTANT","OPS","LEGAL","DISABLED","CUSTOM","AUTOMATED"],"description":"Type of amendment","title":"EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataItemsItemsType"},"EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataItemsItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Id of amendment item"},"item":{"type":"string","description":"Amendment item"},"type":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataItemsItemsType","description":"Type of amendment"},"new_value":{"type":"string","description":"The new valid value after the attempted change."},"data_point":{"type":"string","description":"The field that is selected for amendment."},"previous_value":{"type":"string","description":"The previous valid value before the attempted change."}},"title":"EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataItemsItems"},"EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataSource":{"type":"string","enum":["APP","PUBLIC_API","APP_BULK_AMENDMENT"],"description":"Source of amendment flow creation.","title":"EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataSource"},"EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataCustomItemsItemsStatus":{"type":"string","enum":["REJECTED","APPROVED","PENDING_REVIEW","PENDING_LEGAL"],"description":"Current status of the custom amendment item","title":"EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataCustomItemsItemsStatus"},"EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataCustomItemsItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the custom amendment item"},"type":{"type":"string","description":"Type/context of the custom amendment item"},"status":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataCustomItemsItemsStatus","description":"Current status of the custom amendment item"},"description":{"type":["string","null"],"description":"Detailed description of the custom amendment item"},"rejection_reason":{"type":["string","null"],"description":"Reason for rejection if the item was rejected"}},"required":["id","type","status"],"title":"EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataCustomItemsItems"},"EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataDocumentType":{"type":"string","enum":["EA","SOW","SOW_EA"],"description":"Amendment document type","title":"EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataDocumentType"},"EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataLegalContextStatus":{"type":"string","enum":["REQUEST_LEGAL_REVIEW","WAITING_FOR_ANOTHER_TEAM","WAITING_FOR_HRX_ACTION","DECLINED","SOLVED"],"description":"Current status of the legal review process","title":"EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataLegalContextStatus"},"EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataLegalContext":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataLegalContextStatus","description":"Current status of the legal review process"},"details":{"type":"string","description":"Details regarding the legal request"},"jira_ticket":{"type":"string","description":"Jira ticket identifier linked to the legal context"},"jira_web_url":{"type":"string","format":"uri","description":"Link to the Jira ticket for tracking"},"requested_at":{"type":"string","format":"date-time","description":"Timestamp when legal review was requested"}},"description":"Additional details needed for legal input","title":"EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataLegalContext"},"EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataTimeOffType":{"type":"string","enum":["STANDARD","SPECIFIC","PRORATED"],"description":"Type of time off.","title":"EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataTimeOffType"},"EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataEmploymentType":{"type":"string","enum":["FULL_TIME","PART_TIME"],"description":"Type of employment.","title":"EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataEmploymentType"},"EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataFixedAdjustmentsItemsStatus":{"type":"string","enum":["WAITING_FOR_SIGNING","ACTIVE","OUTDATED","CANCELLED"],"description":"Current status of the fixed adjustment.","title":"EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataFixedAdjustmentsItemsStatus"},"EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataFixedAdjustmentsItems":{"type":"object","properties":{"id":{"type":"string","description":"System-generated unique identifier for the fixed adjustment record in an amendment request."},"value":{"type":"string","description":"Value of the fixed adjustment."},"status":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataFixedAdjustmentsItemsStatus","description":"Current status of the fixed adjustment."},"created_at":{"type":"string","format":"date-time","description":"Timestamp when the fixed adjustment was created."},"is_amended":{"type":"boolean","description":"Whether this fixed adjustment was amended from a previous one."},"is_deleted":{"type":"boolean","description":"True if the fixed adjustment was deleted as part of the amendment; otherwise false."},"updated_at":{"type":"string","format":"date-time","description":"Timestamp when the fixed adjustment was last updated."},"description":{"type":"string","description":"Description of the fixed adjustment."},"is_recurring":{"type":"boolean","description":"Whether the fixed adjustment is recurring. If set to false, it will be treated as a one-time fixed allowance."},"is_country_specific":{"type":"boolean","description":"Whether this fixed adjustment applies only to a specific country."},"parent_fixed_adjustment_id":{"type":["string","null"],"description":"Reference to the parent fixed adjustment, if applicable."}},"required":["id","value","status","created_at","is_amended","updated_at","description","is_recurring","is_country_specific"],"title":"EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataFixedAdjustmentsItems"},"EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataRejectionContext":{"type":"object","properties":{"rejected_at":{"type":"string","format":"date-time","description":"Timestamp of when the rejection occurred"}},"description":"Additional details containing rejection reason","title":"EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataRejectionContext"},"EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataAmendmentStatusesItemsAmendmentFlowStatus":{"type":"object","properties":{"created_at":{"type":"string","format":"date-time","description":"Creation date"}},"description":"Metadata about the amendment status, including when it was created.","title":"EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataAmendmentStatusesItemsAmendmentFlowStatus"},"EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataAmendmentStatusesItems":{"type":"object","properties":{"name":{"type":"string","description":"Logical, system-oriented identifier of the amendment status. Can be used to group statuses under a parent category and subgroup them for more granular state tracking. The structure typically follows a dot-separated hierarchy (e.g., 'PARENT','PARENT.CHILD', 'PARENT.CHILD.CHILD.CHILD', ...), which allows logical grouping and filtering of related statuses."},"friendly_name":{"type":"string","description":"Friendly name of amendment status"},"amendment_flow_status":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataAmendmentStatusesItemsAmendmentFlowStatus","description":"Metadata about the amendment status, including when it was created."}},"title":"EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataAmendmentStatusesItems"},"EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataNoticePeriodType":{"type":"string","enum":["STANDARD","CUSTOM"],"description":"Type of notice period.","title":"EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataNoticePeriodType"},"EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataVoidDeadlineType":{"type":"string","enum":["CUTOFF","START_DATE","END_DATE","EXPIRY"],"description":"Type of void deadline","title":"EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataVoidDeadlineType"},"EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataVariableCompensationType":{"type":"string","enum":["FIXED","PERCENTAGE"],"description":"The way the compensation is calculated. `FIXED` means a fixed amount (like $1000). `PERCENTAGE` means it’s based on a percentage of the salary.","title":"EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataVariableCompensationType"},"EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataVariableCompensationTimeline":{"type":"string","enum":["MONTHLY","QUARTERLY","ANNUALLY","BIANNUALLY"],"description":"How often the compensation is paid — for example monthly, quarterly, annually, or twice a year.","title":"EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataVariableCompensationTimeline"},"EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataVariableCompensationIncentivePlan":{"type":"object","properties":{"details":{"type":"string","description":"Extra details about the incentive plan, if any."},"employee_signature":{"type":"string","description":"The employee’s signature for the incentive plan, if collected."},"employee_signed_at":{"type":"string","format":"date-time","description":"The date and time when the employee signed the incentive plan. Empty if not signed."}},"description":"Details of the incentive plan linked to this compensation, if any.","title":"EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataVariableCompensationIncentivePlan"},"EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataVariableCompensation":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID assigned by the system to this variable compensation record."},"type":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataVariableCompensationType","description":"The way the compensation is calculated. `FIXED` means a fixed amount (like $1000). `PERCENTAGE` means it’s based on a percentage of the salary."},"title":{"type":"string","description":"Title or name of the variable compensation."},"amount":{"type":"string","format":"decimal","description":"The value of the compensation. Shown as a string to keep the exact number of decimals."},"timeline":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataVariableCompensationTimeline","description":"How often the compensation is paid — for example monthly, quarterly, annually, or twice a year."},"parent_id":{"type":["string","null"],"description":"Reference to the parent variable compensation, if applicable. Null if this compensation is not linked to any compensation."},"created_at":{"type":"string","format":"date-time","description":"The date and time when this record was first created in the system."},"is_amended":{"type":"boolean","description":"Shows whether this compensation has been changed as part of an amendment."},"is_deleted":{"type":"boolean","description":"Shows whether this compensation has been deleted."},"updated_at":{"type":"string","format":"date-time","description":"The date and time when this record was last updated."},"effective_date":{"type":"string","format":"date-time","description":"The date when this compensation starts being valid."},"incentive_plan":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataVariableCompensationIncentivePlan","description":"Details of the incentive plan linked to this compensation, if any."}},"required":["id","type","title","amount","timeline","parent_id","created_at","updated_at","effective_date"],"description":"Represents a variable compensation record (such as a bonus, commission, or incentive) within a contract. It contains details like the amount, type, frequency, and whether it is part of an incentive plan. The record also tracks when it was created, updated, and whether it has been amended.","title":"EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataVariableCompensation"},"EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataNoticePeriodTimeUnit":{"type":"string","enum":["DAY","WEEK","MONTH"],"description":"Notice period time unit.","title":"EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataNoticePeriodTimeUnit"},"EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataProbationPeriodTypeForDefinite":{"type":"string","enum":["STANDARD","CUSTOM"],"description":"Type of probation period for definite contracts.","title":"EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataProbationPeriodTypeForDefinite"},"EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Id of amendment"},"type":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataType"},{"type":"null"}],"description":"Type of amendment"},"items":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataItemsItems"},"description":"Items of amendment"},"scope":{"type":"string","description":"Scope of the amendment."},"salary":{"type":"string","description":"Salary for the amendment."},"source":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataSource"},{"type":"null"}],"description":"Source of amendment flow creation."},"currency":{"type":"string","description":"Contract currency."},"end_date":{"type":["string","null"],"format":"date-time","description":"End date of the employment."},"holidays":{"type":["integer","null"],"description":"Number of holidays."},"job_code":{"type":["string","null"],"description":"Job code associated with the job title."},"job_title":{"type":"string","description":"Job title associated with the amendment."},"created_at":{"type":"string","format":"date-time","description":"Creation date of the amendment."},"start_date":{"type":"string","format":"date-time","description":"Start date of the employment."},"updated_at":{"type":"string","format":"date-time","description":"Date when amendment is updated"},"hourly_rate":{"type":["string","null"],"description":"Hourly rate of the amendment"},"custom_items":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataCustomItemsItems"},"description":"Custom amendment items associated with the amendment flow"},"job_category":{"type":["string","null"],"description":"Job category associated with the job title."},"requested_by":{"type":["string","null"],"description":"Profile name of the user who requested the change"},"seniority_id":{"type":["string","null"],"format":"uuid","description":"Seniority level identifier."},"document_type":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataDocumentType"},{"type":"null"}],"description":"Amendment document type"},"legal_context":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataLegalContext"},{"type":"null"}],"description":"Additional details needed for legal input"},"time_off_type":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataTimeOffType","description":"Type of time off."},"void_deadline":{"type":["string","null"],"format":"date-time","description":"Deadline this SOW to be voided"},"effective_date":{"type":["string","null"],"format":"date-time","description":"Effective date of the amendment."},"seniority_date":{"type":["string","null"],"format":"date","description":"The seniority date represents the employee’s original start date with a previous employer. It is used to preserve employment tenure when the employee transfers to this company. Can be null if not applicable."},"employment_type":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataEmploymentType","description":"Type of employment."},"sick_leave_days":{"type":["integer","null"],"description":"Number of sick leave days"},"employment_state":{"type":["string","null"],"description":"State of employment."},"probation_period":{"type":["integer","null"],"description":"Duration of the probation period."},"work_schedule_id":{"type":["string","null"],"format":"uuid","description":"Work schedule id"},"fixed_adjustments":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataFixedAdjustmentsItems"},"description":"List of fixed adjustments associated with the amendment request."},"rejection_context":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataRejectionContext"},{"type":"null"}],"description":"Additional details containing rejection reason"},"amendment_statuses":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataAmendmentStatusesItems"},"description":"List of amendment statuses representing the history and progression of an amendment."},"notice_period_type":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataNoticePeriodType"},{"type":"null"}],"description":"Type of notice period."},"void_deadline_type":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataVoidDeadlineType"},{"type":"null"}],"description":"Type of void deadline"},"work_hours_per_week":{"type":"string","description":"Number of work hours per week."},"employee_nationality":{"type":"string","description":"Nationality of the employee."},"is_hrx_action_needed":{"type":"boolean","description":"Is HRX action needed."},"variable_compensation":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataVariableCompensation","description":"Represents a variable compensation record (such as a bonus, commission, or incentive) within a contract. It contains details like the amount, type, frequency, and whether it is part of an incentive plan. The record also tracks when it was created, updated, and whether it has been amended."},"notice_period_time_unit":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataNoticePeriodTimeUnit"},{"type":"null"}],"description":"Notice period time unit."},"is_effective_date_updated":{"type":"boolean","description":"Is Effective Date updated."},"work_schedule_rules_version":{"type":["string","null"],"description":"Work schedule rule version."},"notice_period_after_probation":{"type":["string","null"],"description":"Notice period after probation."},"notice_period_during_probation":{"type":["string","null"],"description":"Notice period during probation."},"probation_period_type_for_definite":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaDataProbationPeriodTypeForDefinite"},{"type":"null"}],"description":"Type of probation period for definite contracts."}},"title":"EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaData"},"eor-amendments_signEORAmendment_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaData"}},"title":"eor-amendments_signEORAmendment_Response_200"},"EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"title":"EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaErrorsItems"},"SignAContractAmendmentEmployeeRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"SignAContractAmendmentEmployeeRequestBadRequestError"},"SignAContractAmendmentEmployeeRequestNotFoundError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"SignAContractAmendmentEmployeeRequestNotFoundError"},"SignAContractAmendmentEmployeeRequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdSignPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"SignAContractAmendmentEmployeeRequestInternalServerError"},"EorContractsContractIdAmendmentsAmendmentIdPatchRequestBodyContentApplicationJsonSchemaDataCustomItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"An optional identifier for the custom object."},"type":{"type":"string","description":"The type of the custom object. Must be one of the valid custom types."},"description":{"type":"string","description":"A required description for the custom object."}},"required":["type","description"],"title":"EorContractsContractIdAmendmentsAmendmentIdPatchRequestBodyContentApplicationJsonSchemaDataCustomItems"},"EorContractsContractIdAmendmentsAmendmentIdPatchRequestBodyContentApplicationJsonSchemaDataTimeOffType":{"type":"string","enum":["STANDARD","SPECIFIC","PRORATED"],"description":"Type of time off.","title":"EorContractsContractIdAmendmentsAmendmentIdPatchRequestBodyContentApplicationJsonSchemaDataTimeOffType"},"EorContractsContractIdAmendmentsAmendmentIdPatchRequestBodyContentApplicationJsonSchemaDataAdditionalInfo":{"type":"object","properties":{"ai_scope_check_public_id":{"type":"string","format":"uuid","description":"Identifier or flag for AI scope validation check"},"job_categorization_log_id":{"type":"string","format":"uuid","description":"Identifier for job categorisation log"}},"description":"Additional metadata related to job validation and categorisation","title":"EorContractsContractIdAmendmentsAmendmentIdPatchRequestBodyContentApplicationJsonSchemaDataAdditionalInfo"},"EorContractsContractIdAmendmentsAmendmentIdPatchRequestBodyContentApplicationJsonSchemaDataEmploymentType":{"type":"string","enum":["FULL_TIME","PART_TIME"],"description":"Type of employment.","title":"EorContractsContractIdAmendmentsAmendmentIdPatchRequestBodyContentApplicationJsonSchemaDataEmploymentType"},"EorContractsContractIdAmendmentsAmendmentIdPatchRequestBodyContentApplicationJsonSchemaDataFixedAdjustmentsItems":{"type":"object","properties":{"id":{"type":"string","description":"The ID of an existing active fixed adjustment to update or delete. Include this in the request only if you are updating or deleting an existing adjustment. Do not include it when creating a new one."},"value":{"type":"string","description":"Value of the fixed adjustment. Must be a positive number, not zero."},"is_deleted":{"type":"boolean","description":"Flag to mark the fixed adjustment as deleted. Required only when the fixed adjustment needs to be removed; omit it otherwise."},"description":{"type":"string","description":"Description of the fixed adjustment."},"is_recurring":{"type":"boolean","description":"Whether the fixed adjustment is recurring. If set to false, it will be treated as a one-time fixed allowance."}},"required":["value","description","is_recurring"],"title":"EorContractsContractIdAmendmentsAmendmentIdPatchRequestBodyContentApplicationJsonSchemaDataFixedAdjustmentsItems"},"EorContractsContractIdAmendmentsAmendmentIdPatchRequestBodyContentApplicationJsonSchemaDataNoticePeriodType":{"type":"string","enum":["STANDARD","CUSTOM"],"description":"Type of notice period.","title":"EorContractsContractIdAmendmentsAmendmentIdPatchRequestBodyContentApplicationJsonSchemaDataNoticePeriodType"},"EorContractsContractIdAmendmentsAmendmentIdPatchRequestBodyContentApplicationJsonSchemaDataVariableCompensationType":{"type":"string","enum":["PERCENTAGE","FIXED"],"description":"Type of variable compensation.","title":"EorContractsContractIdAmendmentsAmendmentIdPatchRequestBodyContentApplicationJsonSchemaDataVariableCompensationType"},"EorContractsContractIdAmendmentsAmendmentIdPatchRequestBodyContentApplicationJsonSchemaDataVariableCompensationTimeline":{"type":"string","enum":["MONTHLY","QUARTERLY","ANNUALLY","BIANNUALLY"],"description":"How often this compensation occurs. Required when creating a new compensation. Forbidden when updating an existing compensation.","title":"EorContractsContractIdAmendmentsAmendmentIdPatchRequestBodyContentApplicationJsonSchemaDataVariableCompensationTimeline"},"EorContractsContractIdAmendmentsAmendmentIdPatchRequestBodyContentApplicationJsonSchemaDataVariableCompensation":{"type":"object","properties":{"id":{"type":"string","description":"The ID of an existing active variable compensation to update or delete. Include this in the request only if you are updating or deleting an existing compensation. Do not include it when creating a new one."},"type":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPatchRequestBodyContentApplicationJsonSchemaDataVariableCompensationType","description":"Type of variable compensation."},"title":{"type":"string","description":"The title of the compensation. Required when creating a new compensation. Optional when updating an existing compensation."},"amount":{"type":"number","format":"double","description":"Positive amount for the variable compensation."},"timeline":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPatchRequestBodyContentApplicationJsonSchemaDataVariableCompensationTimeline","description":"How often this compensation occurs. Required when creating a new compensation. Forbidden when updating an existing compensation."},"is_deleted":{"type":"boolean","description":"Flag to mark the variable compensation as deleted. Required only when the variable compensation needs to be removed; omit it otherwise"},"effective_date":{"type":"string","format":"date","description":"The date when this compensation starts or becomes effective. Required when creating a new compensation. Optional when updating an existing compensation."}},"required":["type","amount"],"description":"Represents a change to an employee’s variable compensation (e.g., bonus or commission). This schema is used for creating new variable compensation items or updating existing ones. Some fields are required when creating, optional when updating, and forbidden when updating, as specified in each field description.","title":"EorContractsContractIdAmendmentsAmendmentIdPatchRequestBodyContentApplicationJsonSchemaDataVariableCompensation"},"EorContractsContractIdAmendmentsAmendmentIdPatchRequestBodyContentApplicationJsonSchemaDataProbationPeriodTypeForDefinite":{"type":"string","enum":["STANDARD","CUSTOM"],"description":"Type of probation period for definite contracts.","title":"EorContractsContractIdAmendmentsAmendmentIdPatchRequestBodyContentApplicationJsonSchemaDataProbationPeriodTypeForDefinite"},"EorContractsContractIdAmendmentsAmendmentIdPatchRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"scope":{"type":"string","description":"Scope of the amendment."},"custom":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPatchRequestBodyContentApplicationJsonSchemaDataCustomItems"},"description":"An optional array of custom objects."},"salary":{"type":"number","format":"double","description":"Salary for the amendment."},"end_date":{"type":"string","format":"date","description":"End date of the employment."},"holidays":{"type":"number","format":"double","description":"Number of holidays."},"job_title":{"type":"string","description":"Job title associated with the amendment."},"start_date":{"type":"string","format":"date","description":"Start date of the employment."},"hourly_rate":{"type":"number","format":"double","description":"Hourly rate of the amendment. The max value supported is 1e19"},"seniority_id":{"type":"string","format":"uuid","description":"Public Id of the seniority level."},"time_off_type":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPatchRequestBodyContentApplicationJsonSchemaDataTimeOffType","description":"Type of time off."},"effective_date":{"type":"string","format":"date","description":"Effective date for the amendment."},"seniority_date":{"type":["string","null"],"format":"date","description":"The seniority date represents the employee’s original start date with a previous employer. It is used to preserve employment tenure when the employee transfers to this company. Can be null if not applicable."},"additional_info":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPatchRequestBodyContentApplicationJsonSchemaDataAdditionalInfo"},{"type":"null"}],"description":"Additional metadata related to job validation and categorisation"},"employment_type":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPatchRequestBodyContentApplicationJsonSchemaDataEmploymentType","description":"Type of employment."},"employment_state":{"type":"string","description":"State of employment."},"probation_period":{"type":"number","format":"double","description":"Duration of the probation period."},"fixed_adjustments":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPatchRequestBodyContentApplicationJsonSchemaDataFixedAdjustmentsItems"},"description":"Array of fixed adjustments to be submitted for the amendment request."},"notice_period_type":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPatchRequestBodyContentApplicationJsonSchemaDataNoticePeriodType","description":"Type of notice period."},"work_hours_per_week":{"type":"number","format":"double","description":"Number of work hours per week."},"variable_compensation":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPatchRequestBodyContentApplicationJsonSchemaDataVariableCompensation","description":"Represents a change to an employee’s variable compensation (e.g., bonus or commission). This schema is used for creating new variable compensation items or updating existing ones. Some fields are required when creating, optional when updating, and forbidden when updating, as specified in each field description."},"notice_period_after_probation":{"type":"number","format":"double","description":"Notice period after probation."},"notice_period_during_probation":{"type":"number","format":"double","description":"Notice period during probation."},"probation_period_type_for_definite":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPatchRequestBodyContentApplicationJsonSchemaDataProbationPeriodTypeForDefinite","description":"Type of probation period for definite contracts."}},"title":"EorContractsContractIdAmendmentsAmendmentIdPatchRequestBodyContentApplicationJsonSchemaData"},"EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataType":{"type":"string","enum":["INSTANT","OPS","LEGAL","DISABLED","CUSTOM","AUTOMATED"],"description":"Type of amendment","title":"EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataType"},"EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataItemsItemsType":{"type":"string","enum":["INSTANT","OPS","LEGAL","DISABLED","CUSTOM","AUTOMATED"],"description":"Type of amendment","title":"EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataItemsItemsType"},"EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataItemsItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Id of amendment item"},"item":{"type":"string","description":"Amendment item"},"type":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataItemsItemsType","description":"Type of amendment"},"new_value":{"type":"string","description":"The new valid value after the attempted change."},"data_point":{"type":"string","description":"The field that is selected for amendment."},"previous_value":{"type":"string","description":"The previous valid value before the attempted change."}},"title":"EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataItemsItems"},"EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataSource":{"type":"string","enum":["APP","PUBLIC_API","APP_BULK_AMENDMENT"],"description":"Source of amendment flow creation.","title":"EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataSource"},"EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataCustomItemsItemsStatus":{"type":"string","enum":["REJECTED","APPROVED","PENDING_REVIEW","PENDING_LEGAL"],"description":"Current status of the custom amendment item","title":"EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataCustomItemsItemsStatus"},"EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataCustomItemsItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the custom amendment item"},"type":{"type":"string","description":"Type/context of the custom amendment item"},"status":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataCustomItemsItemsStatus","description":"Current status of the custom amendment item"},"description":{"type":["string","null"],"description":"Detailed description of the custom amendment item"},"rejection_reason":{"type":["string","null"],"description":"Reason for rejection if the item was rejected"}},"required":["id","type","status"],"title":"EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataCustomItemsItems"},"EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataDocumentType":{"type":"string","enum":["EA","SOW","SOW_EA"],"description":"Amendment document type","title":"EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataDocumentType"},"EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataLegalContextStatus":{"type":"string","enum":["REQUEST_LEGAL_REVIEW","WAITING_FOR_ANOTHER_TEAM","WAITING_FOR_HRX_ACTION","DECLINED","SOLVED"],"description":"Current status of the legal review process","title":"EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataLegalContextStatus"},"EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataLegalContext":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataLegalContextStatus","description":"Current status of the legal review process"},"details":{"type":"string","description":"Details regarding the legal request"},"jira_ticket":{"type":"string","description":"Jira ticket identifier linked to the legal context"},"jira_web_url":{"type":"string","format":"uri","description":"Link to the Jira ticket for tracking"},"requested_at":{"type":"string","format":"date-time","description":"Timestamp when legal review was requested"}},"description":"Additional details needed for legal input","title":"EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataLegalContext"},"EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataTimeOffType":{"type":"string","enum":["STANDARD","SPECIFIC","PRORATED"],"description":"Type of time off.","title":"EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataTimeOffType"},"EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataEmploymentType":{"type":"string","enum":["FULL_TIME","PART_TIME"],"description":"Type of employment.","title":"EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataEmploymentType"},"EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataFixedAdjustmentsItemsStatus":{"type":"string","enum":["WAITING_FOR_SIGNING","ACTIVE","OUTDATED","CANCELLED"],"description":"Current status of the fixed adjustment.","title":"EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataFixedAdjustmentsItemsStatus"},"EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataFixedAdjustmentsItems":{"type":"object","properties":{"id":{"type":"string","description":"System-generated unique identifier for the fixed adjustment record in an amendment request."},"value":{"type":"string","description":"Value of the fixed adjustment."},"status":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataFixedAdjustmentsItemsStatus","description":"Current status of the fixed adjustment."},"created_at":{"type":"string","format":"date-time","description":"Timestamp when the fixed adjustment was created."},"is_amended":{"type":"boolean","description":"Whether this fixed adjustment was amended from a previous one."},"is_deleted":{"type":"boolean","description":"True if the fixed adjustment was deleted as part of the amendment; otherwise false."},"updated_at":{"type":"string","format":"date-time","description":"Timestamp when the fixed adjustment was last updated."},"description":{"type":"string","description":"Description of the fixed adjustment."},"is_recurring":{"type":"boolean","description":"Whether the fixed adjustment is recurring. If set to false, it will be treated as a one-time fixed allowance."},"is_country_specific":{"type":"boolean","description":"Whether this fixed adjustment applies only to a specific country."},"parent_fixed_adjustment_id":{"type":["string","null"],"description":"Reference to the parent fixed adjustment, if applicable."}},"required":["id","value","status","created_at","is_amended","updated_at","description","is_recurring","is_country_specific"],"title":"EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataFixedAdjustmentsItems"},"EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataRejectionContext":{"type":"object","properties":{"rejected_at":{"type":"string","format":"date-time","description":"Timestamp of when the rejection occurred"}},"description":"Additional details containing rejection reason","title":"EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataRejectionContext"},"EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataAmendmentStatusesItemsAmendmentFlowStatus":{"type":"object","properties":{"created_at":{"type":"string","format":"date-time","description":"Creation date"}},"description":"Metadata about the amendment status, including when it was created.","title":"EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataAmendmentStatusesItemsAmendmentFlowStatus"},"EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataAmendmentStatusesItems":{"type":"object","properties":{"name":{"type":"string","description":"Logical, system-oriented identifier of the amendment status. Can be used to group statuses under a parent category and subgroup them for more granular state tracking. The structure typically follows a dot-separated hierarchy (e.g., 'PARENT','PARENT.CHILD', 'PARENT.CHILD.CHILD.CHILD', ...), which allows logical grouping and filtering of related statuses."},"friendly_name":{"type":"string","description":"Friendly name of amendment status"},"amendment_flow_status":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataAmendmentStatusesItemsAmendmentFlowStatus","description":"Metadata about the amendment status, including when it was created."}},"title":"EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataAmendmentStatusesItems"},"EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataNoticePeriodType":{"type":"string","enum":["STANDARD","CUSTOM"],"description":"Type of notice period.","title":"EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataNoticePeriodType"},"EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataVoidDeadlineType":{"type":"string","enum":["CUTOFF","START_DATE","END_DATE","EXPIRY"],"description":"Type of void deadline","title":"EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataVoidDeadlineType"},"EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataVariableCompensationType":{"type":"string","enum":["FIXED","PERCENTAGE"],"description":"The way the compensation is calculated. `FIXED` means a fixed amount (like $1000). `PERCENTAGE` means it’s based on a percentage of the salary.","title":"EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataVariableCompensationType"},"EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataVariableCompensationTimeline":{"type":"string","enum":["MONTHLY","QUARTERLY","ANNUALLY","BIANNUALLY"],"description":"How often the compensation is paid — for example monthly, quarterly, annually, or twice a year.","title":"EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataVariableCompensationTimeline"},"EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataVariableCompensationIncentivePlan":{"type":"object","properties":{"details":{"type":"string","description":"Extra details about the incentive plan, if any."},"employee_signature":{"type":"string","description":"The employee’s signature for the incentive plan, if collected."},"employee_signed_at":{"type":"string","format":"date-time","description":"The date and time when the employee signed the incentive plan. Empty if not signed."}},"description":"Details of the incentive plan linked to this compensation, if any.","title":"EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataVariableCompensationIncentivePlan"},"EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataVariableCompensation":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID assigned by the system to this variable compensation record."},"type":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataVariableCompensationType","description":"The way the compensation is calculated. `FIXED` means a fixed amount (like $1000). `PERCENTAGE` means it’s based on a percentage of the salary."},"title":{"type":"string","description":"Title or name of the variable compensation."},"amount":{"type":"string","format":"decimal","description":"The value of the compensation. Shown as a string to keep the exact number of decimals."},"timeline":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataVariableCompensationTimeline","description":"How often the compensation is paid — for example monthly, quarterly, annually, or twice a year."},"parent_id":{"type":["string","null"],"description":"Reference to the parent variable compensation, if applicable. Null if this compensation is not linked to any compensation."},"created_at":{"type":"string","format":"date-time","description":"The date and time when this record was first created in the system."},"is_amended":{"type":"boolean","description":"Shows whether this compensation has been changed as part of an amendment."},"is_deleted":{"type":"boolean","description":"Shows whether this compensation has been deleted."},"updated_at":{"type":"string","format":"date-time","description":"The date and time when this record was last updated."},"effective_date":{"type":"string","format":"date-time","description":"The date when this compensation starts being valid."},"incentive_plan":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataVariableCompensationIncentivePlan","description":"Details of the incentive plan linked to this compensation, if any."}},"required":["id","type","title","amount","timeline","parent_id","created_at","updated_at","effective_date"],"description":"Represents a variable compensation record (such as a bonus, commission, or incentive) within a contract. It contains details like the amount, type, frequency, and whether it is part of an incentive plan. The record also tracks when it was created, updated, and whether it has been amended.","title":"EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataVariableCompensation"},"EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataNoticePeriodTimeUnit":{"type":"string","enum":["DAY","WEEK","MONTH"],"description":"Notice period time unit.","title":"EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataNoticePeriodTimeUnit"},"EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataProbationPeriodTypeForDefinite":{"type":"string","enum":["STANDARD","CUSTOM"],"description":"Type of probation period for definite contracts.","title":"EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataProbationPeriodTypeForDefinite"},"EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Id of amendment"},"type":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataType"},{"type":"null"}],"description":"Type of amendment"},"items":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataItemsItems"},"description":"Items of amendment"},"scope":{"type":"string","description":"Scope of the amendment."},"salary":{"type":"string","description":"Salary for the amendment."},"source":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataSource"},{"type":"null"}],"description":"Source of amendment flow creation."},"currency":{"type":"string","description":"Contract currency."},"end_date":{"type":["string","null"],"format":"date-time","description":"End date of the employment."},"holidays":{"type":["integer","null"],"description":"Number of holidays."},"job_code":{"type":["string","null"],"description":"Job code associated with the job title."},"job_title":{"type":"string","description":"Job title associated with the amendment."},"created_at":{"type":"string","format":"date-time","description":"Creation date of the amendment."},"start_date":{"type":"string","format":"date-time","description":"Start date of the employment."},"updated_at":{"type":"string","format":"date-time","description":"Date when amendment is updated"},"hourly_rate":{"type":["string","null"],"description":"Hourly rate of the amendment"},"custom_items":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataCustomItemsItems"},"description":"Custom amendment items associated with the amendment flow"},"job_category":{"type":["string","null"],"description":"Job category associated with the job title."},"requested_by":{"type":["string","null"],"description":"Profile name of the user who requested the change"},"seniority_id":{"type":["string","null"],"format":"uuid","description":"Seniority level identifier."},"document_type":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataDocumentType"},{"type":"null"}],"description":"Amendment document type"},"legal_context":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataLegalContext"},{"type":"null"}],"description":"Additional details needed for legal input"},"time_off_type":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataTimeOffType","description":"Type of time off."},"void_deadline":{"type":["string","null"],"format":"date-time","description":"Deadline this SOW to be voided"},"effective_date":{"type":["string","null"],"format":"date-time","description":"Effective date of the amendment."},"seniority_date":{"type":["string","null"],"format":"date","description":"The seniority date represents the employee’s original start date with a previous employer. It is used to preserve employment tenure when the employee transfers to this company. Can be null if not applicable."},"employment_type":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataEmploymentType","description":"Type of employment."},"sick_leave_days":{"type":["integer","null"],"description":"Number of sick leave days"},"employment_state":{"type":["string","null"],"description":"State of employment."},"probation_period":{"type":["integer","null"],"description":"Duration of the probation period."},"work_schedule_id":{"type":["string","null"],"format":"uuid","description":"Work schedule id"},"fixed_adjustments":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataFixedAdjustmentsItems"},"description":"List of fixed adjustments associated with the amendment request."},"rejection_context":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataRejectionContext"},{"type":"null"}],"description":"Additional details containing rejection reason"},"amendment_statuses":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataAmendmentStatusesItems"},"description":"List of amendment statuses representing the history and progression of an amendment."},"notice_period_type":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataNoticePeriodType"},{"type":"null"}],"description":"Type of notice period."},"void_deadline_type":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataVoidDeadlineType"},{"type":"null"}],"description":"Type of void deadline"},"work_hours_per_week":{"type":"string","description":"Number of work hours per week."},"employee_nationality":{"type":"string","description":"Nationality of the employee."},"is_hrx_action_needed":{"type":"boolean","description":"Is HRX action needed."},"variable_compensation":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataVariableCompensation","description":"Represents a variable compensation record (such as a bonus, commission, or incentive) within a contract. It contains details like the amount, type, frequency, and whether it is part of an incentive plan. The record also tracks when it was created, updated, and whether it has been amended."},"notice_period_time_unit":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataNoticePeriodTimeUnit"},{"type":"null"}],"description":"Notice period time unit."},"is_effective_date_updated":{"type":"boolean","description":"Is Effective Date updated."},"work_schedule_rules_version":{"type":["string","null"],"description":"Work schedule rule version."},"notice_period_after_probation":{"type":["string","null"],"description":"Notice period after probation."},"notice_period_during_probation":{"type":["string","null"],"description":"Notice period during probation."},"probation_period_type_for_definite":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaDataProbationPeriodTypeForDefinite"},{"type":"null"}],"description":"Type of probation period for definite contracts."}},"title":"EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaData"},"eor-amendments_updateContractAmendment_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaData"}},"title":"eor-amendments_updateContractAmendment_Response_200"},"EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"title":"EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaErrorsItems"},"UpdateASpecificEorContractAmendmentRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"UpdateASpecificEorContractAmendmentRequestBadRequestError"},"UpdateASpecificEorContractAmendmentRequestNotFoundError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"UpdateASpecificEorContractAmendmentRequestNotFoundError"},"UpdateASpecificEorContractAmendmentRequestConflictError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"UpdateASpecificEorContractAmendmentRequestConflictError"},"UpdateASpecificEorContractAmendmentRequestUnprocessableEntityError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaErrorsItems"},"description":"List of validation or business rule errors."}},"required":["errors"],"title":"UpdateASpecificEorContractAmendmentRequestUnprocessableEntityError"},"UpdateASpecificEorContractAmendmentRequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsAmendmentIdPatchResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"UpdateASpecificEorContractAmendmentRequestInternalServerError"},"EorContractsContractIdAmendmentsValidatePostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"valid":{"type":["boolean","null"]},"message":{"type":["string","null"]}},"title":"EorContractsContractIdAmendmentsValidatePostResponsesContentApplicationJsonSchemaData"},"eor-amendments_validateEORAmendments_Response_200":{"type":"object","properties":{"data":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsValidatePostResponsesContentApplicationJsonSchemaData"},"description":"Validation results keyed by amendment field"}},"title":"eor-amendments_validateEORAmendments_Response_200"},"EorContractsContractIdAmendmentsValidatePostResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"title":"EorContractsContractIdAmendmentsValidatePostResponsesContentApplicationJsonSchemaErrorsItems"},"ValidateAmendmentDataPointsRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsValidatePostResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"ValidateAmendmentDataPointsRequestBadRequestError"},"ValidateAmendmentDataPointsRequestNotFoundError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsValidatePostResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"ValidateAmendmentDataPointsRequestNotFoundError"},"ValidateAmendmentDataPointsRequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdAmendmentsValidatePostResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"ValidateAmendmentDataPointsRequestInternalServerError"},"EorContractIdBenefitsGetResponsesContentApplicationJsonSchemaDataItemsPlan":{"type":"object","properties":{"name":{"type":"string","description":"The name of the associated plan."}},"title":"EorContractIdBenefitsGetResponsesContentApplicationJsonSchemaDataItemsPlan"},"EorContractIdBenefitsGetResponsesContentApplicationJsonSchemaDataItemsProvider":{"type":"object","properties":{"name":{"type":"string","description":"The name of the benefit provider."}},"title":"EorContractIdBenefitsGetResponsesContentApplicationJsonSchemaDataItemsProvider"},"EorContractIdBenefitsGetResponsesContentApplicationJsonSchemaDataItemsOfferStatus":{"type":"string","enum":["Offered","Not offered"],"description":"Indicates whether the benefit is offered.","title":"EorContractIdBenefitsGetResponsesContentApplicationJsonSchemaDataItemsOfferStatus"},"EorContractIdBenefitsGetResponsesContentApplicationJsonSchemaDataItemsEnrollmentDetailsPlan":{"type":"object","properties":{"name":{"type":"string","description":"The name of the enrolled plan."}},"title":"EorContractIdBenefitsGetResponsesContentApplicationJsonSchemaDataItemsEnrollmentDetailsPlan"},"EorContractIdBenefitsGetResponsesContentApplicationJsonSchemaDataItemsEnrollmentDetailsStandard":{"type":"object","properties":{"monthly_cost":{"type":["string","null"],"description":"The standard monthly cost of the benefit."},"employee_monthly_contribution":{"type":["string","null"],"description":"The standard monthly employer contribution."}},"title":"EorContractIdBenefitsGetResponsesContentApplicationJsonSchemaDataItemsEnrollmentDetailsStandard"},"EorContractIdBenefitsGetResponsesContentApplicationJsonSchemaDataItemsEnrollmentDetailsCurrentCycle":{"type":"object","properties":{"monthly_cost":{"type":"string","description":"The monthly cost of the current enrollment."},"employee_monthly_contribution":{"type":"string","description":"The employer's monthly contribution for the current enrollment."}},"title":"EorContractIdBenefitsGetResponsesContentApplicationJsonSchemaDataItemsEnrollmentDetailsCurrentCycle"},"EorContractIdBenefitsGetResponsesContentApplicationJsonSchemaDataItemsEnrollmentDetails":{"type":"object","properties":{"plan":{"$ref":"#/components/schemas/EorContractIdBenefitsGetResponsesContentApplicationJsonSchemaDataItemsEnrollmentDetailsPlan"},"status":{"type":"string","description":"The current enrollment status of the benefit."},"standard":{"$ref":"#/components/schemas/EorContractIdBenefitsGetResponsesContentApplicationJsonSchemaDataItemsEnrollmentDetailsStandard"},"current_cycle":{"$ref":"#/components/schemas/EorContractIdBenefitsGetResponsesContentApplicationJsonSchemaDataItemsEnrollmentDetailsCurrentCycle"}},"title":"EorContractIdBenefitsGetResponsesContentApplicationJsonSchemaDataItemsEnrollmentDetails"},"EorContractIdBenefitsGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the benefit."},"name":{"type":"string","description":"The name of the benefit."},"plan":{"$ref":"#/components/schemas/EorContractIdBenefitsGetResponsesContentApplicationJsonSchemaDataItemsPlan"},"provider":{"$ref":"#/components/schemas/EorContractIdBenefitsGetResponsesContentApplicationJsonSchemaDataItemsProvider"},"offer_status":{"$ref":"#/components/schemas/EorContractIdBenefitsGetResponsesContentApplicationJsonSchemaDataItemsOfferStatus","description":"Indicates whether the benefit is offered."},"enrollment_details":{"$ref":"#/components/schemas/EorContractIdBenefitsGetResponsesContentApplicationJsonSchemaDataItemsEnrollmentDetails"}},"title":"EorContractIdBenefitsGetResponsesContentApplicationJsonSchemaDataItems"},"eor-benefits_getEORBenefitsByContractId_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/EorContractIdBenefitsGetResponsesContentApplicationJsonSchemaDataItems"}}},"title":"eor-benefits_getEORBenefitsByContractId_Response_200"},"EorPostRequestBodyContentApplicationJsonSchemaDataClientTeamId":{"oneOf":[{"type":"string"},{"type":"integer","format":"int64"}],"description":"Team identifying information.","title":"EorPostRequestBodyContentApplicationJsonSchemaDataClientTeamId"},"EorPostRequestBodyContentApplicationJsonSchemaDataClientTeam":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/EorPostRequestBodyContentApplicationJsonSchemaDataClientTeamId","description":"Team identifying information."}},"required":["id"],"title":"EorPostRequestBodyContentApplicationJsonSchemaDataClientTeam"},"EorPostRequestBodyContentApplicationJsonSchemaDataClientLegalEntityId":{"oneOf":[{"type":"string"},{"type":"integer","format":"int64"}],"description":"Legal entity reference for the client.","title":"EorPostRequestBodyContentApplicationJsonSchemaDataClientLegalEntityId"},"EorPostRequestBodyContentApplicationJsonSchemaDataClientLegalEntity":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/EorPostRequestBodyContentApplicationJsonSchemaDataClientLegalEntityId","description":"Legal entity reference for the client."}},"title":"EorPostRequestBodyContentApplicationJsonSchemaDataClientLegalEntity"},"EorPostRequestBodyContentApplicationJsonSchemaDataClient":{"type":"object","properties":{"team":{"$ref":"#/components/schemas/EorPostRequestBodyContentApplicationJsonSchemaDataClientTeam"},"legal_entity":{"$ref":"#/components/schemas/EorPostRequestBodyContentApplicationJsonSchemaDataClientLegalEntity"}},"required":["team"],"description":"Client details for the contract.","title":"EorPostRequestBodyContentApplicationJsonSchemaDataClient"},"EorPostRequestBodyContentApplicationJsonSchemaDataPension":{"type":"object","properties":{"id":{"type":"string","description":"Pension provider id. You can see available pension providers in the country guide endpoint."},"contribution":{"type":"string","description":"Enter the value of pension contribution. You should send this value only if the contribution object is available in the country guide endpoint and the value should be there between minimum and maximum values indicated."}},"description":"Some countries required a pension benefit.","title":"EorPostRequestBodyContentApplicationJsonSchemaDataPension"},"EorPostRequestBodyContentApplicationJsonSchemaDataBenefitsItems":{"type":"object","properties":{"plan_id":{"type":"string","description":"The ID of a benefits plan to include in the calculation."},"cover_all":{"type":"boolean","description":"Flag indicating if benefit will fully cover the employee."},"provider_id":{"type":"string","description":"The ID of a benefits provider to include in the calculation."},"contribution":{"type":"number","format":"double","description":"The amount the client will contribute for the benefit in the currency of the contract. Only taken into account if cover_all is set to false. For Unisure provider contribution is always in USD."},"cover_dependents":{"type":"boolean","description":"Flag indicating if benefit will cover dependents. Only needed if cover_all is set to true."}},"description":"List of additional benefits to include in the calculation","title":"EorPostRequestBodyContentApplicationJsonSchemaDataBenefitsItems"},"EorPostRequestBodyContentApplicationJsonSchemaDataEmployeeAddress":{"type":"object","properties":{"zip":{"type":"string","description":"Zip code."},"city":{"type":"string","description":"City name."},"state":{"type":["string","null"],"description":"State code."},"street":{"type":"string","description":"Street and number."},"country":{"type":"string","description":"Country code."}},"title":"EorPostRequestBodyContentApplicationJsonSchemaDataEmployeeAddress"},"EorPostRequestBodyContentApplicationJsonSchemaDataEmployeePfDeductions":{"type":"string","enum":["12% of Basic","12% of Rs 15,000 (Rs 1,800)"],"description":"Employee's PF deductions. Required only for India contracts.","title":"EorPostRequestBodyContentApplicationJsonSchemaDataEmployeePfDeductions"},"EorPostRequestBodyContentApplicationJsonSchemaDataEmployee":{"type":"object","properties":{"email":{"type":"string","description":"Employee's email address."},"address":{"oneOf":[{"$ref":"#/components/schemas/EorPostRequestBodyContentApplicationJsonSchemaDataEmployeeAddress"},{"type":"null"}]},"last_name":{"type":"string","description":"Employee's last name."},"first_name":{"type":"string","description":"Employee's first name."},"external_id":{"type":"string","description":"External identifier of the employee."},"nationality":{"type":"string","description":"Employee's nationality."},"pf_deductions":{"$ref":"#/components/schemas/EorPostRequestBodyContentApplicationJsonSchemaDataEmployeePfDeductions","description":"Employee's PF deductions. Required only for India contracts."}},"required":["last_name","first_name","nationality"],"title":"EorPostRequestBodyContentApplicationJsonSchemaDataEmployee"},"EorPostRequestBodyContentApplicationJsonSchemaDataSeniorityId":{"oneOf":[{"type":"string"},{"type":"integer","format":"int64"}],"description":"Identifier for the seniority level (string or numeric ID).","title":"EorPostRequestBodyContentApplicationJsonSchemaDataSeniorityId"},"EorPostRequestBodyContentApplicationJsonSchemaDataSeniority":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/EorPostRequestBodyContentApplicationJsonSchemaDataSeniorityId","description":"Identifier for the seniority level (string or numeric ID)."}},"description":"Seniority selection for the role.","title":"EorPostRequestBodyContentApplicationJsonSchemaDataSeniority"},"EorPostRequestBodyContentApplicationJsonSchemaDataEmploymentType":{"type":"string","enum":["Full-time","Part-time"],"description":"Is it a full-time contract or a part-time contract?","title":"EorPostRequestBodyContentApplicationJsonSchemaDataEmploymentType"},"EorPostRequestBodyContentApplicationJsonSchemaDataEmploymentScopeOfWork1":{"type":"object","properties":{"scope_template_id":{"type":"string","format":"uuid","description":"Scope template UUID."}},"title":"EorPostRequestBodyContentApplicationJsonSchemaDataEmploymentScopeOfWork1"},"EorPostRequestBodyContentApplicationJsonSchemaDataEmploymentScopeOfWork2":{"type":"object","properties":{"scope_validation_id":{"type":"string","format":"uuid","description":"Scope validation UUID."}},"title":"EorPostRequestBodyContentApplicationJsonSchemaDataEmploymentScopeOfWork2"},"EorPostRequestBodyContentApplicationJsonSchemaDataEmploymentScopeOfWork":{"oneOf":[{"type":"string"},{"$ref":"#/components/schemas/EorPostRequestBodyContentApplicationJsonSchemaDataEmploymentScopeOfWork1"},{"$ref":"#/components/schemas/EorPostRequestBodyContentApplicationJsonSchemaDataEmploymentScopeOfWork2"}],"description":"Scope of work; either a string with full text or an object referencing a template/validation UUID.","title":"EorPostRequestBodyContentApplicationJsonSchemaDataEmploymentScopeOfWork"},"EorPostRequestBodyContentApplicationJsonSchemaDataEmploymentTimeOffType":{"type":"string","enum":["STANDARD","SPECIFIC"],"description":"If you want to use standard number of holidays for this employee, choose \"STANDARD\". If you want to enter a specific number of holidays, choose \"SPECIFIC\" and enter the number of days in the holidays field.","title":"EorPostRequestBodyContentApplicationJsonSchemaDataEmploymentTimeOffType"},"EorPostRequestBodyContentApplicationJsonSchemaDataEmploymentNoticePeriodType":{"type":"string","enum":["STANDARD","CUSTOM"],"description":"Type of notice period.","title":"EorPostRequestBodyContentApplicationJsonSchemaDataEmploymentNoticePeriodType"},"EorPostRequestBodyContentApplicationJsonSchemaDataEmploymentProbationPeriodTimeUnit":{"type":"string","enum":["DAY","WEEK","MONTH"],"description":"Time unit of probation period.","title":"EorPostRequestBodyContentApplicationJsonSchemaDataEmploymentProbationPeriodTimeUnit"},"EorPostRequestBodyContentApplicationJsonSchemaDataEmploymentProbationPeriodTypeForDefinite":{"type":"string","enum":["STANDARD","CUSTOM"],"description":"Type of probation period for definite contracts.","title":"EorPostRequestBodyContentApplicationJsonSchemaDataEmploymentProbationPeriodTypeForDefinite"},"EorPostRequestBodyContentApplicationJsonSchemaDataEmploymentNoticePeriodAfterProbationTimeUnit":{"type":"string","enum":["DAY","WEEK","MONTH"],"description":"Time unit of notice period after probation.","title":"EorPostRequestBodyContentApplicationJsonSchemaDataEmploymentNoticePeriodAfterProbationTimeUnit"},"EorPostRequestBodyContentApplicationJsonSchemaDataEmploymentNoticePeriodDuringProbationTimeUnit":{"type":"string","enum":["DAY","WEEK","MONTH"],"description":"Time unit of notice period during probation.","title":"EorPostRequestBodyContentApplicationJsonSchemaDataEmploymentNoticePeriodDuringProbationTimeUnit"},"EorPostRequestBodyContentApplicationJsonSchemaDataEmployment":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/EorPostRequestBodyContentApplicationJsonSchemaDataEmploymentType","description":"Is it a full-time contract or a part-time contract?"},"state":{"type":["string","null"],"description":"State code of the state/province where the this person will be employed."},"country":{"type":"string","description":"Country code of employment."},"end_date":{"type":["string","null"],"format":"date","description":"End date in ISO-8601 format (YYYY-MM-DD)."},"holidays":{"type":["number","null"],"format":"double","description":"Enter the number of holidays. Leave this field blank if you are choosing \"STANDARD\" time_off_type."},"is_hourly":{"type":"boolean","description":"Is the employee contract hourly instead of salaried?"},"start_date":{"type":"string","format":"date","description":"Start date in ISO-8601 format (YYYY-MM-DD)."},"scope_of_work":{"$ref":"#/components/schemas/EorPostRequestBodyContentApplicationJsonSchemaDataEmploymentScopeOfWork","description":"Scope of work; either a string with full text or an object referencing a template/validation UUID."},"time_off_type":{"$ref":"#/components/schemas/EorPostRequestBodyContentApplicationJsonSchemaDataEmploymentTimeOffType","description":"If you want to use standard number of holidays for this employee, choose \"STANDARD\". If you want to enter a specific number of holidays, choose \"SPECIFIC\" and enter the number of days in the holidays field."},"seniority_date":{"type":"string","format":"date","description":"Seniority date"},"sick_leave_days":{"type":"integer","description":"Number of sick leave days"},"probation_period":{"type":["number","null"],"format":"double","description":"Number of probation days."},"notice_period_type":{"$ref":"#/components/schemas/EorPostRequestBodyContentApplicationJsonSchemaDataEmploymentNoticePeriodType","description":"Type of notice period."},"work_visa_required":{"type":"boolean","default":false,"description":"Do you require Deel to apply for work visa for this person?"},"work_hours_per_week":{"type":"number","format":"double","description":"Employee's work hours per week. Required only if contract is set as hourly."},"probation_period_time_unit":{"$ref":"#/components/schemas/EorPostRequestBodyContentApplicationJsonSchemaDataEmploymentProbationPeriodTimeUnit","description":"Time unit of probation period."},"notice_period_after_probation":{"type":["number","null"],"format":"double","description":"Notice period after probation required when type is CUSTOM."},"notice_period_during_probation":{"type":["number","null"],"format":"double","description":"Notice period during probation required when type is CUSTOM."},"employee_completed_past_probation":{"type":"boolean","default":false,"description":"Whether the employee has previously passed the probation period."},"probation_period_type_for_definite":{"$ref":"#/components/schemas/EorPostRequestBodyContentApplicationJsonSchemaDataEmploymentProbationPeriodTypeForDefinite","description":"Type of probation period for definite contracts."},"notice_period_after_probation_time_unit":{"$ref":"#/components/schemas/EorPostRequestBodyContentApplicationJsonSchemaDataEmploymentNoticePeriodAfterProbationTimeUnit","description":"Time unit of notice period after probation."},"notice_period_during_probation_time_unit":{"$ref":"#/components/schemas/EorPostRequestBodyContentApplicationJsonSchemaDataEmploymentNoticePeriodDuringProbationTimeUnit","description":"Time unit of notice period during probation."}},"required":["country","start_date","scope_of_work","work_visa_required"],"description":"Employment contract specific details.","title":"EorPostRequestBodyContentApplicationJsonSchemaDataEmployment"},"EorPostRequestBodyContentApplicationJsonSchemaDataCompensationDetailsFixedAdjustmentsItems":{"type":"object","properties":{"name":{"type":"string","description":"Adjustment name."},"value":{"type":"number","format":"double","description":"Adjustment value."},"opt_out":{"type":"boolean","description":"Whether the adjustment is being opted out of."},"optional":{"type":"boolean","description":"Whether the adjustment is optional."},"description":{"type":"string","description":"Adjustment description."},"is_recurring":{"type":"boolean","description":"Whether the adjustment is paid recurring monthly or one-time on employee's first payroll."},"rule_cost_id":{"type":"string","description":"Identifier of the rule cost associated with the adjustment."},"is_country_specific":{"type":"boolean","description":"Whether this adjustment is country-specific."},"skipping_confirmation_text":{"type":"string","description":"Optional skipping confirmation text shown to the user."}},"title":"EorPostRequestBodyContentApplicationJsonSchemaDataCompensationDetailsFixedAdjustmentsItems"},"EorPostRequestBodyContentApplicationJsonSchemaDataCompensationDetailsSigningBonusPayoutType":{"type":"string","enum":["FIRST_CYCLE","AFTER_PROBATION","AFTER_FIRST_CONTRACT_ANNIVERSARY"],"description":"Should be set only if signing_bonus is set. It defines when the bonus is paid.","title":"EorPostRequestBodyContentApplicationJsonSchemaDataCompensationDetailsSigningBonusPayoutType"},"EorPostRequestBodyContentApplicationJsonSchemaDataCompensationDetailsVariableCompensationType":{"type":"string","enum":["PERCENTAGE","FIXED"],"description":"Should be set only if variable_compensation is set. It can be PERCENTAGE or FIXED.","title":"EorPostRequestBodyContentApplicationJsonSchemaDataCompensationDetailsVariableCompensationType"},"EorPostRequestBodyContentApplicationJsonSchemaDataCompensationDetailsVariableCompensationTimeline":{"type":"string","enum":["ANNUALLY","BIANNUALLY","QUARTERLY","MONTHLY"],"description":"Variable compensation timeline.","title":"EorPostRequestBodyContentApplicationJsonSchemaDataCompensationDetailsVariableCompensationTimeline"},"EorPostRequestBodyContentApplicationJsonSchemaDataCompensationDetails":{"type":"object","properties":{"salary":{"type":"number","format":"double","description":"Employee's gross annual salary. Required only if contract is salaried."},"currency":{"type":"string","description":"Salary currency."},"hourly_rate":{"type":"number","format":"double","description":"Employee's hourly rate. Required only if contract is set as hourly."},"signing_bonus":{"type":["number","null"],"format":"double","description":"Signing bonus amount."},"fixed_adjustments":{"type":"array","items":{"$ref":"#/components/schemas/EorPostRequestBodyContentApplicationJsonSchemaDataCompensationDetailsFixedAdjustmentsItems"}},"variable_compensation":{"type":["number","null"],"format":"double","description":"Variable compensation. For example, if the person will earn 5% of the gross annual salary as the variable compensation, enter 5."},"signing_bonus_payout_type":{"oneOf":[{"$ref":"#/components/schemas/EorPostRequestBodyContentApplicationJsonSchemaDataCompensationDetailsSigningBonusPayoutType"},{"type":"null"}],"description":"Should be set only if signing_bonus is set. It defines when the bonus is paid."},"variable_compensation_type":{"oneOf":[{"$ref":"#/components/schemas/EorPostRequestBodyContentApplicationJsonSchemaDataCompensationDetailsVariableCompensationType"},{"type":"null"}],"description":"Should be set only if variable_compensation is set. It can be PERCENTAGE or FIXED."},"variable_compensation_title":{"type":"string","description":"Variable compensation title."},"variable_compensation_timeline":{"oneOf":[{"$ref":"#/components/schemas/EorPostRequestBodyContentApplicationJsonSchemaDataCompensationDetailsVariableCompensationTimeline"},{"type":"null"}],"description":"Variable compensation timeline."},"variable_compensation_effective_date":{"type":"string","format":"date","description":"Variable compensation effective date."}},"required":["currency"],"title":"EorPostRequestBodyContentApplicationJsonSchemaDataCompensationDetails"},"EorPostRequestBodyContentApplicationJsonSchemaDataQuoteAdditionalFieldsWorkerType":{"type":"string","enum":["Skilled","Unskilled"],"description":"Type of worker.","title":"EorPostRequestBodyContentApplicationJsonSchemaDataQuoteAdditionalFieldsWorkerType"},"EorPostRequestBodyContentApplicationJsonSchemaDataQuoteAdditionalFields":{"type":"object","properties":{"dob":{"type":"string","description":"Employee's date of birth."},"gender":{"type":"string","description":"Employee's gender."},"worker_type":{"$ref":"#/components/schemas/EorPostRequestBodyContentApplicationJsonSchemaDataQuoteAdditionalFieldsWorkerType","description":"Type of worker."}},"description":"Some countries require additional employee information for employment contracts.","title":"EorPostRequestBodyContentApplicationJsonSchemaDataQuoteAdditionalFields"},"EorPostRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"client":{"$ref":"#/components/schemas/EorPostRequestBodyContentApplicationJsonSchemaDataClient","description":"Client details for the contract."},"pension":{"$ref":"#/components/schemas/EorPostRequestBodyContentApplicationJsonSchemaDataPension","description":"Some countries required a pension benefit."},"benefits":{"type":"array","items":{"$ref":"#/components/schemas/EorPostRequestBodyContentApplicationJsonSchemaDataBenefitsItems"}},"employee":{"$ref":"#/components/schemas/EorPostRequestBodyContentApplicationJsonSchemaDataEmployee"},"job_title":{"type":"string","description":"Employee's job title."},"seniority":{"$ref":"#/components/schemas/EorPostRequestBodyContentApplicationJsonSchemaDataSeniority","description":"Seniority selection for the role."},"employment":{"$ref":"#/components/schemas/EorPostRequestBodyContentApplicationJsonSchemaDataEmployment","description":"Employment contract specific details."},"health_plan_id":{"type":"string","description":"Healthcare plan id. You can see available healthcare plans in the country guide endpoint."},"compensation_details":{"$ref":"#/components/schemas/EorPostRequestBodyContentApplicationJsonSchemaDataCompensationDetails"},"quote_additional_fields":{"oneOf":[{"$ref":"#/components/schemas/EorPostRequestBodyContentApplicationJsonSchemaDataQuoteAdditionalFields"},{"type":"null"}],"description":"Some countries require additional employee information for employment contracts."}},"required":["client","employee","job_title","seniority","employment","compensation_details"],"title":"EorPostRequestBodyContentApplicationJsonSchemaData"},"EorPostResponsesContentApplicationJsonSchemaDataType":{"type":"string","enum":["ongoing_time_based","milestones","time_based","pay_as_you_go_time_based","commission","payg_milestones","payg_tasks","eor","unknown","employee","global_payroll","shield_msa","hris_direct_employee","peo"],"description":"Type of the contract.","title":"EorPostResponsesContentApplicationJsonSchemaDataType"},"EorPostResponsesContentApplicationJsonSchemaDataCostsSummaryTotalsFormattedItems":{"type":"object","properties":{"title":{"type":"string","description":"Display title for the total (e.g., 'Monthly Total')."},"total":{"type":"string","description":"Formatted amount in local currency."},"frequency":{"type":"string","description":"Time period for the total (e.g., monthly, annual)."},"total_supporting":{"type":"string","description":"Formatted amount in supporting currency."}},"title":"EorPostResponsesContentApplicationJsonSchemaDataCostsSummaryTotalsFormattedItems"},"EorPostResponsesContentApplicationJsonSchemaDataCostsSummary":{"type":"object","properties":{"salary":{"type":"string","description":"Annual gross salary in local currency."},"currency":{"type":"string","description":"Local currency code (e.g., BRL, PLN)."},"exchange_rate":{"type":"string","description":"Exchange rate used to convert from local to supporting currency."},"totals_formatted":{"type":"array","items":{"$ref":"#/components/schemas/EorPostResponsesContentApplicationJsonSchemaDataCostsSummaryTotalsFormattedItems"},"description":"Formatted summary totals in both local and supporting currencies."},"supporting_currency":{"type":"string","description":"Reference or secondary currency (e.g., USD) used for reporting totals."}},"description":"Top-level overview of costs, including key totals and currency metadata.","title":"EorPostResponsesContentApplicationJsonSchemaDataCostsSummary"},"EorPostResponsesContentApplicationJsonSchemaDataCostsSectionsItemsGroupsItemsCostsItemsTotalsItems":{"type":"object","properties":{"total":{"type":"string","description":"Total cost amount in local currency."},"frequency":{"type":"string","description":"How often this cost occurs (e.g., monthly, annual, one-time)."},"total_supporting":{"type":"string","description":"Total cost amount in the supporting currency."}},"title":"EorPostResponsesContentApplicationJsonSchemaDataCostsSectionsItemsGroupsItemsCostsItemsTotalsItems"},"EorPostResponsesContentApplicationJsonSchemaDataCostsSectionsItemsGroupsItemsCostsItems":{"type":"object","properties":{"label":{"type":"string","description":"Name of the specific cost item (e.g., Salary, Meal Voucher)."},"totals":{"type":"array","items":{"$ref":"#/components/schemas/EorPostResponsesContentApplicationJsonSchemaDataCostsSectionsItemsGroupsItemsCostsItemsTotalsItems"},"description":"Monthly and annual totals for the cost item in local and supporting currencies."}},"title":"EorPostResponsesContentApplicationJsonSchemaDataCostsSectionsItemsGroupsItemsCostsItems"},"EorPostResponsesContentApplicationJsonSchemaDataCostsSectionsItemsGroupsItemsTotalsItems":{"type":"object","properties":{"total":{"type":"string","description":"Group total in local currency."},"frequency":{"type":"string","description":"How often the total is calculated (e.g., monthly, annual)."},"total_supporting":{"type":"string","description":"Group total in supporting currency."}},"title":"EorPostResponsesContentApplicationJsonSchemaDataCostsSectionsItemsGroupsItemsTotalsItems"},"EorPostResponsesContentApplicationJsonSchemaDataCostsSectionsItemsGroupsItems":{"type":"object","properties":{"name":{"type":"string","description":"Internal identifier for the group."},"costs":{"type":"array","items":{"$ref":"#/components/schemas/EorPostResponsesContentApplicationJsonSchemaDataCostsSectionsItemsGroupsItemsCostsItems"},"description":"Individual cost items within the group."},"label":{"type":"string","description":"Display name for the group (e.g., Gross Salary, Employer Cost)."},"totals":{"type":"array","items":{"$ref":"#/components/schemas/EorPostResponsesContentApplicationJsonSchemaDataCostsSectionsItemsGroupsItemsTotalsItems"},"description":"Aggregated totals for all items within the group."},"has_breakdown":{"type":"boolean","description":"Indicates if the group contains multiple detailed cost items to be expanded."}},"title":"EorPostResponsesContentApplicationJsonSchemaDataCostsSectionsItemsGroupsItems"},"EorPostResponsesContentApplicationJsonSchemaDataCostsSectionsItemsTotalsItems":{"type":"object","properties":{"total":{"type":"string","description":"Total cost for the section in local currency."},"frequency":{"type":"string","description":"How often the total is calculated (e.g., monthly, annual)."},"total_supporting":{"type":"string","description":"Total cost for the section in supporting currency."}},"title":"EorPostResponsesContentApplicationJsonSchemaDataCostsSectionsItemsTotalsItems"},"EorPostResponsesContentApplicationJsonSchemaDataCostsSectionsItemsStandaloneItemsItemsTotalsItems":{"type":"object","properties":{"total":{"type":"string","description":"Standalone cost amount in local currency."},"frequency":{"type":"string","description":"How often this cost occurs (e.g., monthly, annual, one-time)."},"total_supporting":{"type":"string","description":"Standalone cost amount in the supporting currency."}},"title":"EorPostResponsesContentApplicationJsonSchemaDataCostsSectionsItemsStandaloneItemsItemsTotalsItems"},"EorPostResponsesContentApplicationJsonSchemaDataCostsSectionsItemsStandaloneItemsItems":{"type":"object","properties":{"name":{"type":"string","description":"Internal identifier for the standalone cost item."},"label":{"type":"string","description":"Display name for the standalone cost item."},"totals":{"type":"array","items":{"$ref":"#/components/schemas/EorPostResponsesContentApplicationJsonSchemaDataCostsSectionsItemsStandaloneItemsItemsTotalsItems"},"description":"Monthly and annual totals for the standalone item in local and supporting currencies."}},"title":"EorPostResponsesContentApplicationJsonSchemaDataCostsSectionsItemsStandaloneItemsItems"},"EorPostResponsesContentApplicationJsonSchemaDataCostsSectionsItems":{"type":"object","properties":{"name":{"type":"string","description":"Internal identifier for the cost section (e.g., MONTHLY_EMPLOYMENT_BREAKDOWN)."},"label":{"type":"string","description":"Display name for the cost section."},"groups":{"type":"array","items":{"$ref":"#/components/schemas/EorPostResponsesContentApplicationJsonSchemaDataCostsSectionsItemsGroupsItems"},"description":"Collections of related costs grouped under a common label."},"totals":{"type":"array","items":{"$ref":"#/components/schemas/EorPostResponsesContentApplicationJsonSchemaDataCostsSectionsItemsTotalsItems"},"description":"Overall totals for the section, summing all groups and standalone items."},"is_summarized":{"type":"boolean","description":"Indicates whether the section is presented in summarized form."},"standalone_items":{"type":"array","items":{"$ref":"#/components/schemas/EorPostResponsesContentApplicationJsonSchemaDataCostsSectionsItemsStandaloneItemsItems"},"description":"Cost items that do not belong to regular groups, often irregular or one-off costs."}},"title":"EorPostResponsesContentApplicationJsonSchemaDataCostsSectionsItems"},"EorPostResponsesContentApplicationJsonSchemaDataCostsAdditionalData":{"type":"object","properties":{"annual_notes":{"type":"array","items":{"type":"string"},"description":"Notes or assumptions specifically relevant to annual cost calculations."},"monthly_notes":{"type":"array","items":{"type":"string"},"description":"Notes or assumptions specifically relevant to monthly cost calculations."},"once_off_notes":{"type":"array","items":{"type":"string"},"description":"Notes regarding one-time costs or irregular payments in the quote."},"additional_notes":{"type":"array","items":{"type":"string"},"description":"General conditions, assumptions, or fees that may apply to the quote."}},"description":"Supplementary notes and contextual information relevant to the cost quote.","title":"EorPostResponsesContentApplicationJsonSchemaDataCostsAdditionalData"},"EorPostResponsesContentApplicationJsonSchemaDataCosts":{"type":"object","properties":{"summary":{"$ref":"#/components/schemas/EorPostResponsesContentApplicationJsonSchemaDataCostsSummary","description":"Top-level overview of costs, including key totals and currency metadata."},"sections":{"type":"array","items":{"$ref":"#/components/schemas/EorPostResponsesContentApplicationJsonSchemaDataCostsSectionsItems"},"description":"Detailed and categorized cost sections including grouped and standalone items."},"additional_data":{"$ref":"#/components/schemas/EorPostResponsesContentApplicationJsonSchemaDataCostsAdditionalData","description":"Supplementary notes and contextual information relevant to the cost quote."}},"description":"Detailed breakdown of employment costs including summary totals, sectioned cost groups, and additional context notes.","title":"EorPostResponsesContentApplicationJsonSchemaDataCosts"},"EorPostResponsesContentApplicationJsonSchemaDataClientLegalEntity":{"type":"object","properties":{"name":{"type":"string","description":"Legal entity name"}},"title":"EorPostResponsesContentApplicationJsonSchemaDataClientLegalEntity"},"EorPostResponsesContentApplicationJsonSchemaDataClient":{"type":"object","properties":{"legal_entity":{"$ref":"#/components/schemas/EorPostResponsesContentApplicationJsonSchemaDataClientLegalEntity"}},"description":"Client information for the contract.","title":"EorPostResponsesContentApplicationJsonSchemaDataClient"},"EorPostResponsesContentApplicationJsonSchemaDataStatus":{"type":"string","enum":["new","under_review","waiting_for_employee_contract","waiting_for_client_sign","processing_payment","waiting_for_contractor_sign","waiting_for_eor_sign","waiting_for_employee_sign","awaiting_deposit_payment","in_progress","completed","cancelled","user_cancelled","rejected","waiting_for_client_payment","onboarding"],"description":"Current status of the contract.","title":"EorPostResponsesContentApplicationJsonSchemaDataStatus"},"EorPostResponsesContentApplicationJsonSchemaDataEmployee":{"type":"object","properties":{"email":{"type":"string","description":"Employee's email"},"last_name":{"type":"string","description":"Employee's last name"},"first_name":{"type":"string","description":"Employee's first name"},"legal_name":{"type":"string","description":"Employee's legal name"}},"title":"EorPostResponsesContentApplicationJsonSchemaDataEmployee"},"EorPostResponsesContentApplicationJsonSchemaDataSeniority":{"type":"object","properties":{"id":{"type":"integer","description":"Seniority level ID"},"name":{"type":"string","description":"Seniority level name"}},"required":["id","name"],"description":"Seniority level of the employee","title":"EorPostResponsesContentApplicationJsonSchemaDataSeniority"},"EorPostResponsesContentApplicationJsonSchemaDataEmployment":{"type":"object","properties":{"state":{"type":["string","null"],"description":"State or province of employment"},"country":{"type":"string","description":"Country of employment"},"end_date":{"type":["string","null"],"format":"date-time","description":"Employment end date"},"start_date":{"type":"string","format":"date-time","description":"Employment start date"},"scope_of_work":{"type":"string","description":"Scope of work description."},"time_off_type":{"type":"string","description":"Type of time off for the employee"},"probation_period":{"type":["integer","null"],"description":"Number of probation days"},"work_visa_required":{"type":"boolean","description":"If a work visa is required"},"calculated_holidays":{"type":"string","description":"Number of calculated holidays"}},"description":"Employment contract specific details.","title":"EorPostResponsesContentApplicationJsonSchemaDataEmployment"},"EorPostResponsesContentApplicationJsonSchemaDataHealthPlan":{"type":"object","properties":{"id":{"type":"string","description":"Health plan ID"},"name":{"type":"string","description":"Health plan name"}},"title":"EorPostResponsesContentApplicationJsonSchemaDataHealthPlan"},"EorPostResponsesContentApplicationJsonSchemaDataCompensationDetails":{"type":"object","properties":{"salary":{"type":"string","description":"Gross annual salary"},"currency":{"type":"string","description":"Currency of the salary"},"variable_compensation":{"type":"string","description":"Variable compensation account or percentage"},"variable_compensation_type":{"type":["string","null"],"description":"Type of variable compensation"}},"title":"EorPostResponsesContentApplicationJsonSchemaDataCompensationDetails"},"EorPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","description":"ID of the created contract quote."},"type":{"$ref":"#/components/schemas/EorPostResponsesContentApplicationJsonSchemaDataType","description":"Type of the contract."},"costs":{"$ref":"#/components/schemas/EorPostResponsesContentApplicationJsonSchemaDataCosts","description":"Detailed breakdown of employment costs including summary totals, sectioned cost groups, and additional context notes."},"client":{"$ref":"#/components/schemas/EorPostResponsesContentApplicationJsonSchemaDataClient","description":"Client information for the contract."},"status":{"$ref":"#/components/schemas/EorPostResponsesContentApplicationJsonSchemaDataStatus","description":"Current status of the contract."},"employee":{"$ref":"#/components/schemas/EorPostResponsesContentApplicationJsonSchemaDataEmployee"},"job_title":{"type":"string","description":"Employee's job title"},"seniority":{"$ref":"#/components/schemas/EorPostResponsesContentApplicationJsonSchemaDataSeniority","description":"Seniority level of the employee"},"created_at":{"type":"string","format":"date-time","description":"Contract creation timestamp"},"employment":{"$ref":"#/components/schemas/EorPostResponsesContentApplicationJsonSchemaDataEmployment","description":"Employment contract specific details."},"health_plan":{"oneOf":[{"$ref":"#/components/schemas/EorPostResponsesContentApplicationJsonSchemaDataHealthPlan"},{"type":"null"}]},"compensation_details":{"$ref":"#/components/schemas/EorPostResponsesContentApplicationJsonSchemaDataCompensationDetails"}},"title":"EorPostResponsesContentApplicationJsonSchemaData"},"eor-contract_createEORContract_Response_201":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorPostResponsesContentApplicationJsonSchemaData"}},"title":"eor-contract_createEORContract_Response_201"},"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaTeam":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the team."},"name":{"type":"string","description":"The name of the team."}},"title":"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaTeam"},"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaStatus":{"type":"string","enum":["under_review","waiting_for_employee_contract","waiting_for_client_sign","waiting_for_eor_sign","waiting_for_employee_sign","awaiting_deposit_payment","in_progress","completed","cancelled","user_cancelled","rejected"],"description":"The current status of the contract.","title":"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaStatus"},"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaCreator":{"type":"object","properties":{"name":{"type":"string","description":"The name of the contract creator."},"email":{"type":"string","description":"The email address of the contract creator."},"firstname":{"type":"string","description":"The first name of the contract creator."}},"title":"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaCreator"},"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmployee":{"type":"object","properties":{"email":{"type":"string","description":"The email of the employee."},"pic_url":{"type":["string","null"],"description":"URL to employee's picture."},"last_name":{"type":"string","description":"The last name of the employee."},"first_name":{"type":"string","description":"The first name of the employee."},"legal_name":{"type":"string","description":"The legal name of the employee."},"nationality":{"type":"string","description":"Two letter country code of the employee nationality."}},"description":"Employee details","title":"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmployee"},"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaSeniority":{"type":"object","properties":{"id":{"type":"number","format":"double","description":"The unique identifier for the seniority level."},"name":{"type":"string","description":"The name of the seniority level."}},"title":"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaSeniority"},"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaSickDays":{"type":"object","properties":{"max":{"type":["string","null"],"description":"Maximum number of sick days allowed."},"min":{"type":["string","null"],"description":"Minimum number of sick days allowed."}},"description":"Allowed sick days range.","title":"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaSickDays"},"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaPayrollType":{"type":"string","enum":["BIMONTHLY","MONTHLY"],"description":"Payroll frequency for the contract","title":"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaPayrollType"},"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaCanAdjustOn":{"type":"object","properties":{"end":{"type":"string","description":"End of the period when adjustments can be made."},"start":{"type":"string","description":"Start of the period when adjustments can be made."}},"description":"Time frame when adjustments can be made.","title":"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaCanAdjustOn"},"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaContractType":{"type":"string","enum":["eor"],"description":"The type of contract.","title":"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaContractType"},"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaTimeOffType":{"type":"string","enum":["STANDARD","SPECIFIC","PRORATED"],"description":"Type of time off policy.","title":"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaTimeOffType"},"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmploymentType":{"type":"string","enum":["Full-time","Part-time"],"description":"The type of employment.","title":"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmploymentType"},"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmploymentCostsSummaryTotalsFormattedItems":{"type":"object","properties":{"title":{"type":"string","description":"Display title for the total (e.g., 'Monthly Total')."},"total":{"type":"string","description":"Formatted amount in local currency."},"frequency":{"type":"string","description":"Time period for the total (e.g., monthly, annual)."},"total_supporting":{"type":"string","description":"Formatted amount in supporting currency."}},"title":"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmploymentCostsSummaryTotalsFormattedItems"},"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmploymentCostsSummary":{"type":"object","properties":{"salary":{"type":"string","description":"Annual gross salary in local currency."},"currency":{"type":"string","description":"Local currency code (e.g., BRL, PLN)."},"exchange_rate":{"type":"string","description":"Exchange rate used to convert from local to supporting currency."},"totals_formatted":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmploymentCostsSummaryTotalsFormattedItems"},"description":"Formatted summary totals in both local and supporting currencies."},"supporting_currency":{"type":"string","description":"Reference or secondary currency (e.g., USD) used for reporting totals."}},"description":"Top-level overview of costs, including key totals and currency metadata.","title":"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmploymentCostsSummary"},"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmploymentCostsSectionsItemsGroupsItemsCostsItemsTotalsItems":{"type":"object","properties":{"total":{"type":"string","description":"Total cost amount in local currency."},"frequency":{"type":"string","description":"How often this cost occurs (e.g., monthly, annual, one-time)."},"total_supporting":{"type":"string","description":"Total cost amount in the supporting currency."}},"title":"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmploymentCostsSectionsItemsGroupsItemsCostsItemsTotalsItems"},"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmploymentCostsSectionsItemsGroupsItemsCostsItems":{"type":"object","properties":{"label":{"type":"string","description":"Name of the specific cost item (e.g., Salary, Meal Voucher)."},"totals":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmploymentCostsSectionsItemsGroupsItemsCostsItemsTotalsItems"},"description":"Monthly and annual totals for the cost item in local and supporting currencies."}},"title":"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmploymentCostsSectionsItemsGroupsItemsCostsItems"},"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmploymentCostsSectionsItemsGroupsItemsTotalsItems":{"type":"object","properties":{"total":{"type":"string","description":"Group total in local currency."},"frequency":{"type":"string","description":"How often the total is calculated (e.g., monthly, annual)."},"total_supporting":{"type":"string","description":"Group total in supporting currency."}},"title":"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmploymentCostsSectionsItemsGroupsItemsTotalsItems"},"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmploymentCostsSectionsItemsGroupsItems":{"type":"object","properties":{"name":{"type":"string","description":"Internal identifier for the group."},"costs":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmploymentCostsSectionsItemsGroupsItemsCostsItems"},"description":"Individual cost items within the group."},"label":{"type":"string","description":"Display name for the group (e.g., Gross Salary, Employer Cost)."},"totals":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmploymentCostsSectionsItemsGroupsItemsTotalsItems"},"description":"Aggregated totals for all items within the group."},"has_breakdown":{"type":"boolean","description":"Indicates if the group contains multiple detailed cost items to be expanded."}},"title":"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmploymentCostsSectionsItemsGroupsItems"},"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmploymentCostsSectionsItemsTotalsItems":{"type":"object","properties":{"total":{"type":"string","description":"Total cost for the section in local currency."},"frequency":{"type":"string","description":"How often the total is calculated (e.g., monthly, annual)."},"total_supporting":{"type":"string","description":"Total cost for the section in supporting currency."}},"title":"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmploymentCostsSectionsItemsTotalsItems"},"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmploymentCostsSectionsItemsStandaloneItemsItemsTotalsItems":{"type":"object","properties":{"total":{"type":"string","description":"Standalone cost amount in local currency."},"frequency":{"type":"string","description":"How often this cost occurs (e.g., monthly, annual, one-time)."},"total_supporting":{"type":"string","description":"Standalone cost amount in the supporting currency."}},"title":"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmploymentCostsSectionsItemsStandaloneItemsItemsTotalsItems"},"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmploymentCostsSectionsItemsStandaloneItemsItems":{"type":"object","properties":{"name":{"type":"string","description":"Internal identifier for the standalone cost item."},"label":{"type":"string","description":"Display name for the standalone cost item."},"totals":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmploymentCostsSectionsItemsStandaloneItemsItemsTotalsItems"},"description":"Monthly and annual totals for the standalone item in local and supporting currencies."}},"title":"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmploymentCostsSectionsItemsStandaloneItemsItems"},"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmploymentCostsSectionsItems":{"type":"object","properties":{"name":{"type":"string","description":"Internal identifier for the cost section (e.g., MONTHLY_EMPLOYMENT_BREAKDOWN)."},"label":{"type":"string","description":"Display name for the cost section."},"groups":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmploymentCostsSectionsItemsGroupsItems"},"description":"Collections of related costs grouped under a common label."},"totals":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmploymentCostsSectionsItemsTotalsItems"},"description":"Overall totals for the section, summing all groups and standalone items."},"is_summarized":{"type":"boolean","description":"Indicates whether the section is presented in summarized form."},"standalone_items":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmploymentCostsSectionsItemsStandaloneItemsItems"},"description":"Cost items that do not belong to regular groups, often irregular or one-off costs."}},"title":"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmploymentCostsSectionsItems"},"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmploymentCostsAdditionalData":{"type":"object","properties":{"annual_notes":{"type":"array","items":{"type":"string"},"description":"Notes or assumptions specifically relevant to annual cost calculations."},"monthly_notes":{"type":"array","items":{"type":"string"},"description":"Notes or assumptions specifically relevant to monthly cost calculations."},"once_off_notes":{"type":"array","items":{"type":"string"},"description":"Notes regarding one-time costs or irregular payments in the quote."},"additional_notes":{"type":"array","items":{"type":"string"},"description":"General conditions, assumptions, or fees that may apply to the quote."}},"description":"Supplementary notes and contextual information relevant to the cost quote.","title":"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmploymentCostsAdditionalData"},"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmploymentCosts":{"type":"object","properties":{"summary":{"$ref":"#/components/schemas/EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmploymentCostsSummary","description":"Top-level overview of costs, including key totals and currency metadata."},"sections":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmploymentCostsSectionsItems"},"description":"Detailed and categorized cost sections including grouped and standalone items."},"additional_data":{"$ref":"#/components/schemas/EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmploymentCostsAdditionalData","description":"Supplementary notes and contextual information relevant to the cost quote."}},"description":"Detailed breakdown of employment costs including summary totals, sectioned cost groups, and additional context notes.","title":"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmploymentCosts"},"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaHiringObjectiveType":{"type":"string","enum":["EXPANDING_TO_NEW_COUNTRY","TEMP_EOR_OPENING_ENTITY","ONE_OFF_HIRE","CONVERTING_CONTRACTOR","OTHER"],"title":"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaHiringObjectiveType"},"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaHiringObjective":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaHiringObjectiveType"},"extra_info":{"type":["string","null"]}},"description":"Information about the hiring objective.","title":"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaHiringObjective"},"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaNoticePeriodType":{"type":"string","enum":["STANDARD","CUSTOM"],"description":"Type of notice period if applicable.","title":"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaNoticePeriodType"},"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaLastQuoteRejectionRejectedBy":{"type":"object","properties":{"name":{"type":"string","description":"Full name of the rejecting person."},"profile_public_id":{"type":"string","format":"uuid","description":"Public identifier for the rejecting person's profile."}},"description":"Details of the person who rejected.","title":"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaLastQuoteRejectionRejectedBy"},"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaLastQuoteRejectionRejectionType":{"type":"string","enum":["CLIENT","EOR_AGENT"],"description":"Type of rejection.","title":"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaLastQuoteRejectionRejectionType"},"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaLastQuoteRejectionRejectionReason":{"type":"string","enum":["TOO_EXPENSIVE","DECIDED_AGAINST_EMPLOYING_EOR","TEST_QUOTE","NOT_SATISFIED_WITH_DEEL","INACCURATE_INFO_JOB_TITLE","INACCURATE_INFO_JOB_DESCRIPTION","INACCURATE_INFO_JOB_DUTIES_SCOPE_OF_WORK","OTHER"],"description":"Reason why the rejection occurred.","title":"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaLastQuoteRejectionRejectionReason"},"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaLastQuoteRejection":{"type":"object","properties":{"created_at":{"type":"string","description":"Timestamp of when the rejection was made."},"rejected_by":{"$ref":"#/components/schemas/EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaLastQuoteRejectionRejectedBy","description":"Details of the person who rejected."},"rejection_type":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaLastQuoteRejectionRejectionType"},{"type":"null"}],"description":"Type of rejection."},"rejection_reason":{"$ref":"#/components/schemas/EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaLastQuoteRejectionRejectionReason","description":"Reason why the rejection occurred."},"rejection_message":{"type":["string","null"],"description":"Optional message explaining the rejection."}},"description":"Timestamp of last quote rejection.","title":"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaLastQuoteRejection"},"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaWorkScheduleAssignmentSettings":{"type":"string","enum":["NOT_AVAILABLE","SPECIFIC_SCHEDULES","GENERAL_SCHEDULES","ONE_TIME_AMENDMENT"],"description":"Work schedule assignment setting.","title":"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaWorkScheduleAssignmentSettings"},"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaProbationPeriodTypeForDefinite":{"type":"string","enum":["STANDARD","CUSTOM"],"description":"Probation period type for definite contracts.","title":"EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaProbationPeriodTypeForDefinite"},"eor-contract_getEORContractDetails_Response_200":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the Deel contract."},"name":{"type":"string","description":"Contract name"},"team":{"$ref":"#/components/schemas/EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaTeam"},"salary":{"type":"string","description":"Annual salary as a string to preserve decimal precision."},"status":{"$ref":"#/components/schemas/EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaStatus","description":"The current status of the contract."},"creator":{"$ref":"#/components/schemas/EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaCreator"},"currency":{"type":"string","description":"The currency used in the contract."},"employee":{"$ref":"#/components/schemas/EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmployee","description":"Employee details"},"end_date":{"type":["string","null"],"format":"date-time","description":"The end date of the contract, if applicable."},"timezone":{"type":"string","description":"The timezone of the contract."},"seniority":{"$ref":"#/components/schemas/EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaSeniority"},"sick_days":{"$ref":"#/components/schemas/EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaSickDays","description":"Allowed sick days range."},"work_visa":{"type":"boolean","description":"Indicates if a work visa is required."},"created_at":{"type":"string","format":"date-time","description":"The date and time when the contract was created."},"start_date":{"type":"string","format":"date-time","description":"The start date of the contract."},"updated_at":{"type":"string","format":"date-time","description":"The date and time when the contract was last updated."},"description":{"type":"string","description":"Contract description"},"signed_date":{"type":["string","null"],"format":"date-time","description":"The date and time when the contract was signed by both parties."},"cancelled_at":{"type":["string","null"],"format":"date-time","description":"The date and time when the contract was cancelled."},"completed_at":{"type":["string","null"],"format":"date-time","description":"The date and time when the contract was completed."},"payroll_type":{"$ref":"#/components/schemas/EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaPayrollType","description":"Payroll frequency for the contract"},"can_adjust_on":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaCanAdjustOn"},{"type":"null"}],"description":"Time frame when adjustments can be made."},"contract_type":{"$ref":"#/components/schemas/EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaContractType","description":"The type of contract."},"scope_of_work":{"type":"string","description":"Description of job scope and responsibilities."},"signing_bonus":{"type":["string","null"],"description":"One-time bonus paid at contract sign."},"time_off_type":{"$ref":"#/components/schemas/EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaTimeOffType","description":"Type of time off policy."},"deposit_months":{"type":["string","null"],"description":"Number of deposit months required."},"effective_date":{"type":"string","format":"date-time","description":"The date and time when the contract is effective."},"job_title_name":{"type":["string","null"],"description":"The contract's job title."},"completion_date":{"type":["string","null"],"format":"date-time","description":"The completion date of the contract."},"employment_type":{"$ref":"#/components/schemas/EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmploymentType","description":"The type of employment."},"client_signature":{"type":["string","null"],"description":"The signature of the client."},"client_signed_at":{"type":["string","null"],"format":"date-time","description":"The date and time when the client signed the contract."},"employment_costs":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaEmploymentCosts"},{"type":"null"}],"description":"Detailed breakdown of employment costs including summary totals, sectioned cost groups, and additional context notes."},"employment_state":{"type":["string","null"],"description":"The state of the employment."},"hiring_objective":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaHiringObjective"},{"type":"null"}],"description":"Information about the hiring objective."},"probation_period":{"type":"integer","description":"Number of days in the probation period."},"employee_signed_at":{"type":["string","null"],"format":"date-time","description":"Date and time when the employee signed."},"employment_country":{"type":"string","description":"Two letter country code of the employment country."},"notice_period_type":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaNoticePeriodType"},{"type":"null"}],"description":"Type of notice period if applicable."},"original_start_date":{"type":"string","format":"date-time","description":"The originally planned start date."},"work_hours_per_week":{"type":"string","description":"Number of work hours per week."},"contractor_signature":{"type":["string","null"],"description":"The signature of the EOR entity representative."},"contractor_signed_at":{"type":["string","null"],"format":"date-time","description":"The date and time when the contractor signed the contract."},"effective_plain_date":{"type":"string","format":"date","description":"The effective date in plain format."},"fixed_adjustment_ids":{"type":["array","null"],"items":{"type":"string"},"description":"List of fixed adjustment ids."},"invited_client_email":{"type":["string","null"],"description":"The email address of the invited client."},"last_quote_rejection":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaLastQuoteRejection"},{"type":"null"}],"description":"Timestamp of last quote rejection."},"completion_plain_date":{"type":["string","null"],"format":"date","description":"The completion date of the contract in plain contract."},"is_onboarding_on_hold":{"type":"boolean","description":"Whether onboarding is currently on hold or not."},"monthly_employer_cost":{"type":"string","description":"Monthly cost to the employer."},"employee_late_sign_start":{"type":["string","null"],"format":"date-time","description":"Date when employee signed late, if applicable."},"is_early_invoice_enabled":{"type":"boolean","description":"Whether early invoicing is enabled or not."},"onboarding_step_duration":{"type":["integer","null"],"description":"Duration of onboarding steps in days."},"variable_compensation_ids":{"type":"array","items":{"type":"string"},"description":"List of variable compensation IDs."},"can_remind_employee_to_sign":{"type":"boolean","description":"Whether reminders to sign the employee resignation can be sent to the employee or not."},"initial_effective_plain_date":{"type":"string","format":"date","description":"The initial effective date in plain format."},"is_foreign_currency_contract":{"type":"boolean","description":"Whether the contract uses foreign currency or not."},"is_employee_onboarding_delayed":{"type":"boolean","description":"Determines if the invite for employee onboarding should be dispatch manually."},"monthly_eor_management_fee_usd":{"type":"string","description":"Monthly EOR management fee in USD."},"work_schedule_assignment_settings":{"$ref":"#/components/schemas/EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaWorkScheduleAssignmentSettings","description":"Work schedule assignment setting."},"probation_period_type_for_definite":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdDetailsGetResponsesContentApplicationJsonSchemaProbationPeriodTypeForDefinite"},{"type":"null"}],"description":"Probation period type for definite contracts."}},"title":"eor-contract_getEORContractDetails_Response_200"},"RetrieveEorContractDetails-v2026-01-01RequestForbiddenError":{"type":"object","properties":{"error":{"type":"string","description":"Contract is not accessible to the user/organization"}},"title":"RetrieveEorContractDetails-v2026-01-01RequestForbiddenError"},"EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataScope1":{"type":"object","properties":{"scope_template_id":{"type":"string","format":"uuid","description":"Scope template UUID."},"scope_validation_id":{"type":"string","format":"uuid","description":"Scope validation UUID."}},"title":"EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataScope1"},"EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataScope":{"oneOf":[{"type":"string"},{"$ref":"#/components/schemas/EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataScope1"}],"title":"EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataScope"},"EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataBenefitsItems":{"type":"object","properties":{"plan_id":{"type":["string","null"],"description":"Benefit plan ID"},"cover_all":{"type":"boolean","description":"Indicates if benefit covers all"},"provider_id":{"type":["string","null"],"description":"Benefit provider ID"},"contribution":{"type":["number","null"],"format":"double","description":"Contribution amount"},"cover_dependents":{"type":"boolean","description":"Indicates if benefit covers dependents"}},"description":"Benefit plan details","title":"EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataBenefitsItems"},"EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataTimeOffType":{"type":"string","enum":["STANDARD","SPECIFIC","PRORATED"],"description":"Type of time off","title":"EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataTimeOffType"},"EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataEmploymentType":{"type":"string","enum":["Full-time","Part-time"],"description":"Type of employment","title":"EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataEmploymentType"},"EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataEmployeeAddress":{"type":"object","properties":{"zip":{"type":"string","description":"ZIP/Postal code"},"city":{"type":"string","description":"City of residence"},"phone":{"type":"string","description":"Phone number"},"state":{"type":"string","description":"State of residence"},"street":{"type":"string","description":"Street address"},"country":{"type":"string","description":"Country of residence (can be country code or name)"},"province":{"type":"string","description":"Province of residence"},"calling_code":{"type":"string","description":"Country calling code"}},"required":["city","street","country"],"description":"Employee's address information","title":"EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataEmployeeAddress"},"EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataHiringObjective":{"type":"string","enum":["EXPANDING_TO_NEW_COUNTRY","TEMP_EOR_OPENING_ENTITY","ONE_OFF_HIRE","CONVERTING_CONTRACTOR","OTHER"],"description":"Objective for hiring","title":"EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataHiringObjective"},"EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataWorkArrangement":{"type":"string","enum":["REMOTE","ON_SITE_OR_HYBRID"],"description":"Work arrangement type","title":"EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataWorkArrangement"},"EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataWorkEligibility":{"type":"object","properties":{"key":{"type":"string","description":"Unique identifier for the work eligibility document"},"file_name":{"type":"string","description":"Name of the work eligibility document file"}},"required":["key","file_name"],"description":"Work eligibility documentation","title":"EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataWorkEligibility"},"EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataContractTermType":{"type":"string","enum":["DEFINITE","INDEFINITE"],"description":"Type of contract term","title":"EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataContractTermType"},"EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataNoticePeriodType":{"type":"string","enum":["STANDARD","CUSTOM"],"description":"Type of notice period","title":"EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataNoticePeriodType"},"EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataReasonForFixedTerm":{"type":"string","enum":["SEASONAL_OR_TEMPORARY_WORK","PROJECT_BASED_EMPLOYMENT","REPLACEMENT_FOR_PERMANENT_STAFF","TRIAL_PERIODS_FOR_NEW_ROLES_OR_BUSINESSES"],"description":"Reason for fixed-term contract","title":"EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataReasonForFixedTerm"},"EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataQuoteAdditionalFieldsEmployeeType":{"type":"string","enum":["Employee","Manager"],"description":"Type of employee","title":"EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataQuoteAdditionalFieldsEmployeeType"},"EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataQuoteAdditionalFields":{"type":"object","properties":{"employee_type":{"$ref":"#/components/schemas/EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataQuoteAdditionalFieldsEmployeeType","description":"Type of employee"},"qualifications":{"type":"string","description":"Required qualifications"},"scope_german_translation":{"type":"string","description":"German translation of scope"},"qualifications_german_translation":{"type":"string","description":"German translation of qualifications"}},"description":"Additional quote-specific information","title":"EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataQuoteAdditionalFields"},"EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataSigningBonusPayoutType":{"type":"string","enum":["FIRST_CYCLE","AFTER_PROBATION","AFTER_FIRST_CONTRACT_ANNIVERSARY"],"default":"FIRST_CYCLE","description":"Determines when the signing bonus will be paid out","title":"EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataSigningBonusPayoutType"},"EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataProbationPeriodTypeForDefinite":{"type":"string","enum":["CUSTOM","STANDARD"],"description":"Unit of time for probation period","title":"EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataProbationPeriodTypeForDefinite"},"EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"scope":{"$ref":"#/components/schemas/EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataScope"},"salary":{"type":"number","format":"double","description":"Annual salary amount"},"benefits":{"type":["array","null"],"items":{"$ref":"#/components/schemas/EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataBenefitsItems"},"description":"Array of employee benefits"},"currency":{"type":"string","description":"Currency code for salary and benefits"},"end_date":{"type":["string","null"],"format":"date","description":"Employment end date"},"holidays":{"type":["number","null"],"format":"double","description":"Number of holiday days per year"},"is_hourly":{"type":["boolean","null"],"description":"Indicates if compensation is hourly"},"job_title":{"type":"string","description":"Job title (cannot be C-level position)"},"work_visa":{"type":["boolean","null"],"description":"Indicates if work visa is required"},"start_date":{"type":"string","format":"date","description":"Employment start date"},"employee_id":{"type":"string","description":"Employee's unique identifier"},"hourly_rate":{"type":["number","null"],"format":"double","description":"Hourly rate (required if is_hourly is true)"},"is_resubmit":{"type":["boolean","null"],"description":"Indicates if this is a resubmission"},"schedule_id":{"type":["string","null"],"description":"Unique identifier for the employee's work schedule"},"seniority_id":{"type":"number","format":"double","description":"Seniority level identifier"},"work_pension":{"type":["boolean","null"],"description":"Indicates if work pension is included"},"signing_bonus":{"type":["number","null"],"format":"double","description":"Signing bonus amount"},"time_off_type":{"$ref":"#/components/schemas/EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataTimeOffType","description":"Type of time off"},"employee_email":{"type":"string","format":"email","description":"Employee's email address"},"seniority_date":{"type":"string","format":"date","description":"Employee seniority date"},"employment_type":{"$ref":"#/components/schemas/EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataEmploymentType","description":"Type of employment"},"sick_leave_days":{"type":["number","null"],"format":"double","description":"Number of sick leave days per year"},"employee_address":{"$ref":"#/components/schemas/EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataEmployeeAddress","description":"Employee's address information"},"employment_state":{"type":["string","null"],"description":"State/Province of employment"},"hiring_objective":{"$ref":"#/components/schemas/EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataHiringObjective","description":"Objective for hiring"},"probation_period":{"type":["number","null"],"format":"double","description":"Probation period duration"},"work_arrangement":{"oneOf":[{"$ref":"#/components/schemas/EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataWorkArrangement"},{"type":"null"}],"description":"Work arrangement type"},"work_eligibility":{"$ref":"#/components/schemas/EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataWorkEligibility","description":"Work eligibility documentation"},"medical_insurance":{"type":"boolean","description":"Medical insurance coverage"},"contract_term_type":{"$ref":"#/components/schemas/EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataContractTermType","description":"Type of contract term"},"employee_last_name":{"type":"string","description":"Employee's last name"},"employment_country":{"type":"string","description":"Country of employment"},"notice_period_type":{"$ref":"#/components/schemas/EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataNoticePeriodType","description":"Type of notice period"},"employee_first_name":{"type":"string","description":"Employee's first name"},"work_hours_per_week":{"type":"number","format":"double","description":"Working hours per week"},"employee_nationality":{"type":"string","description":"Employee's nationality"},"reason_for_fixed_term":{"oneOf":[{"$ref":"#/components/schemas/EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataReasonForFixedTerm"},{"type":"null"}],"description":"Reason for fixed-term contract"},"quote_additional_fields":{"$ref":"#/components/schemas/EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataQuoteAdditionalFields","description":"Additional quote-specific information"},"signing_bonus_payout_type":{"oneOf":[{"$ref":"#/components/schemas/EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataSigningBonusPayoutType"},{"type":"null"}],"description":"Determines when the signing bonus will be paid out"},"hiring_objective_extra_info":{"type":["string","null"],"description":"Additional information about hiring objective"},"notice_period_after_probation":{"type":"number","format":"double","description":"Notice period after probation (days)"},"notice_period_during_probation":{"type":"number","format":"double","description":"Notice period during probation (days)"},"is_auto_quote_validation_passed":{"type":["boolean","null"],"description":"Auto quote validation status"},"probation_period_type_for_definite":{"$ref":"#/components/schemas/EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaDataProbationPeriodTypeForDefinite","description":"Unit of time for probation period"},"allow_consultant_equipment_reimbursement":{"type":"boolean","description":"Allow equipment reimbursement for consultants"}},"required":["salary","job_title","start_date","employee_email","employment_type","employee_last_name","employment_country","employee_first_name"],"title":"EorContractContractIdPatchRequestBodyContentApplicationJsonSchemaData"},"EorContractContractIdPatchResponsesContentApplicationJsonSchemaStatus":{"type":"string","enum":["new","under_review","waiting_for_client_sign","waiting_for_eor_sign","waiting_for_employee_sign","awaiting_deposit_payment","rejected"],"description":"Current status of the contract","title":"EorContractContractIdPatchResponsesContentApplicationJsonSchemaStatus"},"eor-contract_updateEORContract_Response_200":{"type":"object","properties":{"oid":{"type":"string","description":"The unique identifier of the employee contract."},"status":{"$ref":"#/components/schemas/EorContractContractIdPatchResponsesContentApplicationJsonSchemaStatus","description":"Current status of the contract"},"scope_of_work":{"type":"string","description":"Scope of work description."}},"required":["oid","status"],"title":"eor-contract_updateEORContract_Response_200"},"EorContractContractIdPatchResponsesContentApplicationJsonSchemaError":{"type":"object","properties":{"code":{"type":"string","description":"Error code identifier"},"status":{"type":"integer","description":"HTTP status code"},"message":{"type":"string","description":"Error message details"}},"title":"EorContractContractIdPatchResponsesContentApplicationJsonSchemaError"},"UpdateEorContractRequestBadRequestError":{"type":"object","properties":{"error":{"$ref":"#/components/schemas/EorContractContractIdPatchResponsesContentApplicationJsonSchemaError"}},"required":["error"],"title":"UpdateEorContractRequestBadRequestError"},"UpdateEorContractRequestForbiddenError":{"type":"object","properties":{"error":{"$ref":"#/components/schemas/EorContractContractIdPatchResponsesContentApplicationJsonSchemaError"}},"required":["error"],"title":"UpdateEorContractRequestForbiddenError"},"UpdateEorContractRequestNotFoundError":{"type":"object","properties":{"error":{"$ref":"#/components/schemas/EorContractContractIdPatchResponsesContentApplicationJsonSchemaError"}},"required":["error"],"title":"UpdateEorContractRequestNotFoundError"},"UpdateEorContractRequestInternalServerError":{"type":"object","properties":{"error":{"$ref":"#/components/schemas/EorContractContractIdPatchResponsesContentApplicationJsonSchemaError"}},"required":["error"],"title":"UpdateEorContractRequestInternalServerError"},"EorContractsContractIdDocumentsGetResponsesContentApplicationJsonSchemaDataItemsDocumentType":{"type":"string","enum":["FRAMEWORK_AGREEMENT"],"description":"The type of document. Currently only FRAMEWORK_AGREEMENT is supported.","title":"EorContractsContractIdDocumentsGetResponsesContentApplicationJsonSchemaDataItemsDocumentType"},"EorContractsContractIdDocumentsGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"signature":{"type":["string","null"],"description":"The signature of the client if the document is signed."},"signed_at":{"type":["string","null"],"format":"date-time","description":"The date and time the client signed the document if it is signed."},"document_type":{"$ref":"#/components/schemas/EorContractsContractIdDocumentsGetResponsesContentApplicationJsonSchemaDataItemsDocumentType","description":"The type of document. Currently only FRAMEWORK_AGREEMENT is supported."},"eor_signature":{"type":["string","null"],"description":"The signature of the EOR if the document is signed."},"eor_signed_at":{"type":["string","null"],"format":"date-time","description":"The date and time the EOR signed the document if it is signed."},"client_job_title":{"type":["string","null"],"description":"The job title of the client if the document is signed."}},"required":["document_type"],"title":"EorContractsContractIdDocumentsGetResponsesContentApplicationJsonSchemaDataItems"},"eor-contract-documents_getEORContractDocuments_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdDocumentsGetResponsesContentApplicationJsonSchemaDataItems"}}},"required":["data"],"title":"eor-contract-documents_getEORContractDocuments_Response_200"},"EorContractsContractIdDocumentsGetResponsesContentApplicationJsonSchemaErrorsItems":{"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":"EorContractsContractIdDocumentsGetResponsesContentApplicationJsonSchemaErrorsItems"},"EorContractsContractIdDocumentsGetResponsesContentApplicationJsonSchemaRequest":{"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":"EorContractsContractIdDocumentsGetResponsesContentApplicationJsonSchemaRequest"},"FetchEorContractDocumentsRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdDocumentsGetResponsesContentApplicationJsonSchemaErrorsItems"}},"request":{"$ref":"#/components/schemas/EorContractsContractIdDocumentsGetResponsesContentApplicationJsonSchemaRequest"}},"title":"FetchEorContractDocumentsRequestBadRequestError"},"EorContractOidCancelPostRequestBodyContentApplicationJsonSchemaDataCancellationReason":{"type":"string","enum":["INTERNAL_DECISION","UNSATISFACTORY_EXPERIENCE","EXPLORING_ALTERNATIVE","OFFER_CHANGES"],"description":"Reason for contract termination","title":"EorContractOidCancelPostRequestBodyContentApplicationJsonSchemaDataCancellationReason"},"EorContractOidCancelPostRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"cancellation_reason":{"$ref":"#/components/schemas/EorContractOidCancelPostRequestBodyContentApplicationJsonSchemaDataCancellationReason","description":"Reason for contract termination"},"cancellation_message":{"type":"string","description":"Message for contract termination"}},"required":["cancellation_reason"],"title":"EorContractOidCancelPostRequestBodyContentApplicationJsonSchemaData"},"eor-hiring_cancelContract_Response_204":{"type":"object","properties":{},"description":"Empty response body","title":"eor-hiring_cancelContract_Response_204"},"CancelEorContractRequestBadRequestError":{"type":"object","properties":{"error":{"type":"string","description":"Error message details"}},"title":"CancelEorContractRequestBadRequestError"},"CancelEorContractRequestNotFoundError":{"type":"object","properties":{"error":{"type":"string","description":"Error message details"}},"title":"CancelEorContractRequestNotFoundError"},"EorContractOidDelayOnboardingPatchRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"is_employee_onboarding_delayed":{"type":"boolean","description":"Indicates if the employee onboarding is delayed"}},"required":["is_employee_onboarding_delayed"],"title":"EorContractOidDelayOnboardingPatchRequestBodyContentApplicationJsonSchemaData"},"eor-hiring_delayOnboarding_Response_200":{"type":"object","properties":{"success":{"type":"boolean","description":"Operation success status"},"contractOid":{"type":"string","description":"Contract OID"},"is_employee_onboarding_delayed":{"type":"boolean","description":"Current onboarding delay status"}},"required":["success"],"title":"eor-hiring_delayOnboarding_Response_200"},"DelayEorEmployeeOnboardingRequestBadRequestError":{"type":"object","properties":{"error":{"type":"string","description":"Error message"}},"required":["error"],"title":"DelayEorEmployeeOnboardingRequestBadRequestError"},"FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsType":{"type":"string","enum":["FreeText","Paragraph","SingleSelection","MultiSelection","Address","PhoneNumber","DocumentUpload","Number","Dropdown","DatePicker","Email","CustomDropdown","PresetDropdown","Nested"],"description":"Type of the question.","title":"FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsType"},"FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsRulesItemsSource":{"type":"object","properties":{"url":{"type":"string","description":"API endpoint providing dynamic options."},"definition":{"type":"string","description":"Reference URL for API documentation."},"description":{"type":"string","description":"Description of the data source."}},"description":"Defines dynamic data source for the question.","title":"FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsRulesItemsSource"},"FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsRulesItemsOptionsItems":{"type":"object","properties":{"title":{"type":"string","description":"Display text for the option."},"value":{"type":["string","null"],"description":"Value associated with the option."}},"title":"FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsRulesItemsOptionsItems"},"FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsRulesItemsRequiresItemsValue":{"oneOf":[{"type":"string"},{"type":"number","format":"double"},{"type":"boolean"}],"description":"Expected value for the condition.","title":"FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsRulesItemsRequiresItemsValue"},"FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsRulesItemsRequiresItems":{"type":"object","properties":{"key":{"type":"string","description":"Key of the dependent field."},"value":{"$ref":"#/components/schemas/FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsRulesItemsRequiresItemsValue","description":"Expected value for the condition."},"operator":{"type":["string","null"],"description":"Comparison operator (e.g., 'eq', 'ne')."},"compare_key":{"type":["string","null"],"description":"Key of the field to compare against."}},"title":"FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsRulesItemsRequiresItems"},"FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsRulesItemsMaxValue":{"oneOf":[{"type":"string"},{"type":"number","format":"double"}],"description":"Maximum value allowed.","title":"FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsRulesItemsMaxValue"},"FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsRulesItemsMinValue":{"oneOf":[{"type":"string"},{"type":"number","format":"double"}],"description":"Minimum value allowed.","title":"FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsRulesItemsMinValue"},"FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsRulesItemsDefaultValue":{"oneOf":[{"type":"string"},{"type":"number","format":"double"},{"type":"boolean"}],"description":"Default value to pre-fill in the form.","title":"FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsRulesItemsDefaultValue"},"FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsRulesItems":{"type":"object","properties":{"title":{"type":"string","description":"Title of the question."},"source":{"oneOf":[{"$ref":"#/components/schemas/FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsRulesItemsSource"},{"type":"null"}],"description":"Defines dynamic data source for the question."},"options":{"type":["array","null"],"items":{"$ref":"#/components/schemas/FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsRulesItemsOptionsItems"},"description":"List of selectable options for selection-type questions. Value may be of any type."},"is_range":{"type":"boolean","description":"Specifies whether a date picker allows range selection."},"requires":{"type":"array","items":{"$ref":"#/components/schemas/FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsRulesItemsRequiresItems"},"description":"List of conditions that must be met for this rule to apply."},"max_value":{"$ref":"#/components/schemas/FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsRulesItemsMaxValue","description":"Maximum value allowed."},"min_value":{"$ref":"#/components/schemas/FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsRulesItemsMinValue","description":"Minimum value allowed."},"max_length":{"type":["integer","null"],"description":"Maximum character length for text responses."},"min_length":{"type":["integer","null"],"description":"Minimum character length for text responses."},"helper_text":{"type":["string","null"],"description":"Additional information to assist the user."},"is_disabled":{"type":"boolean","description":"If true, the field is disabled and cannot be edited."},"is_required":{"type":"boolean","description":"Indicates if the question is required."},"number_type":{"type":"string","description":"Used for number fields to define the unit or representation."},"default_value":{"$ref":"#/components/schemas/FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsRulesItemsDefaultValue","description":"Default value to pre-fill in the form."},"is_only_digits":{"type":"boolean","description":"Restricts input to numeric characters only, for FreeText questions."},"date_limitation":{"type":["string","null"],"description":"Limits date selection (e.g., blocking past dates). Will always be 'BLOCK_PAST' for now."},"is_multiple_selection":{"type":"boolean","description":"Indicates if the user can select multiple values."},"must_request_validation":{"type":"boolean","description":"Whether additional validation should be triggered for this field."}},"title":"FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsRulesItems"},"FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsSource":{"type":"object","properties":{"url":{"type":"string","description":"API endpoint providing dynamic options."},"definition":{"type":"string","description":"Reference URL for API documentation."},"description":{"type":"string","description":"Description of the data source."}},"description":"Defines dynamic data source for the question.","title":"FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsSource"},"FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsOptionsItems":{"type":"object","properties":{"title":{"type":"string","description":"Display text for the option."},"value":{"type":["string","null"],"description":"Value associated with the option."}},"title":"FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsOptionsItems"},"FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsMaxValue":{"oneOf":[{"type":"string"},{"type":"number","format":"double"}],"description":"Maximum value allowed.","title":"FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsMaxValue"},"FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsMinValue":{"oneOf":[{"type":"string"},{"type":"number","format":"double"}],"description":"Minimum value allowed.","title":"FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsMinValue"},"FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsDefaultValue":{"oneOf":[{"type":"string"},{"type":"number","format":"double"},{"type":"boolean"}],"description":"Default value to pre-fill in the form.","title":"FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsDefaultValue"},"FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItems":{"type":"object","properties":{"key":{"type":"string","description":"Unique key identifier for the question."},"type":{"$ref":"#/components/schemas/FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsType","description":"Type of the question."},"rules":{"type":["array","null"],"items":{"$ref":"#/components/schemas/FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsRulesItems"},"description":"Validation rules for the question."},"title":{"type":"string","description":"Title of the question."},"source":{"oneOf":[{"$ref":"#/components/schemas/FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsSource"},{"type":"null"}],"description":"Defines dynamic data source for the question."},"options":{"type":["array","null"],"items":{"$ref":"#/components/schemas/FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsOptionsItems"},"description":"List of selectable options for selection-type questions. Value may be of any type."},"is_range":{"type":"boolean","description":"Specifies whether a date picker allows range selection."},"max_value":{"$ref":"#/components/schemas/FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsMaxValue","description":"Maximum value allowed."},"min_value":{"$ref":"#/components/schemas/FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsMinValue","description":"Minimum value allowed."},"max_length":{"type":["integer","null"],"description":"Maximum character length for text responses."},"min_length":{"type":["integer","null"],"description":"Minimum character length for text responses."},"helper_text":{"type":["string","null"],"description":"Additional information to assist the user."},"is_disabled":{"type":"boolean","description":"If true, the field is disabled and cannot be edited."},"is_required":{"type":"boolean","description":"Indicates if the question is required."},"number_type":{"type":"string","description":"Used for number fields to define the unit or representation."},"default_value":{"$ref":"#/components/schemas/FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItemsDefaultValue","description":"Default value to pre-fill in the form."},"is_only_digits":{"type":"boolean","description":"Restricts input to numeric characters only, for FreeText questions."},"date_limitation":{"type":["string","null"],"description":"Limits date selection (e.g., blocking past dates). Will always be 'BLOCK_PAST' for now."},"is_multiple_selection":{"type":"boolean","description":"Indicates if the user can select multiple values."},"must_request_validation":{"type":"boolean","description":"Whether additional validation should be triggered for this field."}},"required":["key","type","title"],"title":"FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItems"},"FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItems":{"type":"object","properties":{"title":{"type":"string","description":"Title of the section."},"subtitle":{"type":"string","description":"Additional information shown at the top of the section."},"questions":{"type":"array","items":{"$ref":"#/components/schemas/FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItemsQuestionsItems"},"description":"List of questions within the section."}},"required":["title","questions"],"title":"FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItems"},"FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItems":{"type":"object","properties":{"title":{"type":"string","description":"Title of the form page."},"sections":{"type":"array","items":{"$ref":"#/components/schemas/FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItemsSectionsItems"},"description":"Sections within the page."}},"required":["title","sections"],"title":"FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItems"},"FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"pages":{"type":"array","items":{"$ref":"#/components/schemas/FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaDataPagesItems"},"description":"List of pages in the form."}},"required":["pages"],"title":"FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaData"},"eor-hiring_getCreateContractForm_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"eor-hiring_getCreateContractForm_Response_200"},"FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaErrorsItems":{"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":"FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaErrorsItems"},"FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaRequest":{"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":"FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaRequest"},"FetchEorContractFormRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaErrorsItems"}},"request":{"$ref":"#/components/schemas/FormsEorCreateContractCountryCodeGetResponsesContentApplicationJsonSchemaRequest"}},"title":"FetchEorContractFormRequestBadRequestError"},"EorStartDateGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"min_start_date":{"type":"string","format":"date-time","description":"The earliest possible employment start date"},"start_date_buffer":{"type":"integer","description":"Number of business days to buffer from today"},"first_payroll_lock":{"type":"integer","description":"Day of month when payroll gets locked"},"is_same_month_payment_country":{"type":"boolean","description":"Whether the employment country requires start date within the same month"}},"required":["min_start_date","start_date_buffer","first_payroll_lock","is_same_month_payment_country"],"title":"EorStartDateGetResponsesContentApplicationJsonSchemaData"},"eor-hiring_getStartDate_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorStartDateGetResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"eor-hiring_getStartDate_Response_200"},"EorStartDateGetResponsesContentApplicationJsonSchemaErrorsItems":{"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":"EorStartDateGetResponsesContentApplicationJsonSchemaErrorsItems"},"EorStartDateGetResponsesContentApplicationJsonSchemaRequest":{"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":"EorStartDateGetResponsesContentApplicationJsonSchemaRequest"},"FetchStartDateForEorContractsRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorStartDateGetResponsesContentApplicationJsonSchemaErrorsItems"}},"request":{"$ref":"#/components/schemas/EorStartDateGetResponsesContentApplicationJsonSchemaRequest"}},"title":"FetchStartDateForEorContractsRequestBadRequestError"},"EorAdditionalCostsCountryGetResponsesContentApplicationJsonSchemaDataAllowancesItems":{"type":"object","properties":{"name":{"type":"string","description":"Allowance name."},"value":{"type":"number","format":"double","description":"Allowance value."},"optional":{"type":"boolean","description":"Indicates if the allowance is optional."},"description":{"type":"string","description":"Allowance description."},"is_recurring":{"type":"boolean","description":"Indicates if the allowance is recurring."},"rule_cost_id":{"type":"string","description":"Unique identifier for the allowance."},"use_contract_currency":{"type":"boolean","description":"Indicates if the allowance uses the contract currency."},"skipping_confirmation_text":{"type":["string","null"],"description":"Confirmation text for opting out of the allowance."}},"title":"EorAdditionalCostsCountryGetResponsesContentApplicationJsonSchemaDataAllowancesItems"},"EorAdditionalCostsCountryGetResponsesContentApplicationJsonSchemaDataNonStatutoryItems":{"type":"object","properties":{"name":{"type":"string","description":"Allowance name."},"value":{"type":"number","format":"double","description":"Allowance value."},"currency":{"type":"string","description":"Currency"},"description":{"type":"string","description":"Allowance description."},"is_recurring":{"type":"boolean","description":"Indicates if the allowance is recurring."},"rule_cost_id":{"type":"string","description":"Unique identifier for the allowance."},"use_contract_currency":{"type":"boolean","description":"Indicates if the allowance uses the contract currency."}},"title":"EorAdditionalCostsCountryGetResponsesContentApplicationJsonSchemaDataNonStatutoryItems"},"EorAdditionalCostsCountryGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"allowances":{"type":"array","items":{"$ref":"#/components/schemas/EorAdditionalCostsCountryGetResponsesContentApplicationJsonSchemaDataAllowancesItems"}},"non_statutory":{"type":"array","items":{"$ref":"#/components/schemas/EorAdditionalCostsCountryGetResponsesContentApplicationJsonSchemaDataNonStatutoryItems"}}},"title":"EorAdditionalCostsCountryGetResponsesContentApplicationJsonSchemaData"},"eor-hiring_getAdditionalCosts_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorAdditionalCostsCountryGetResponsesContentApplicationJsonSchemaData"}},"title":"eor-hiring_getAdditionalCosts_Response_200"},"EorAdditionalCostsCountryGetResponsesContentApplicationJsonSchemaErrorsItems":{"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":"EorAdditionalCostsCountryGetResponsesContentApplicationJsonSchemaErrorsItems"},"EorAdditionalCostsCountryGetResponsesContentApplicationJsonSchemaRequest":{"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":"EorAdditionalCostsCountryGetResponsesContentApplicationJsonSchemaRequest"},"GetEorAdditionalCostsRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorAdditionalCostsCountryGetResponsesContentApplicationJsonSchemaErrorsItems"}},"request":{"$ref":"#/components/schemas/EorAdditionalCostsCountryGetResponsesContentApplicationJsonSchemaRequest"}},"title":"GetEorAdditionalCostsRequestBadRequestError"},"EorBenefitsGetParametersEmploymentType":{"type":"string","enum":["Full-time","Part-time"],"title":"EorBenefitsGetParametersEmploymentType"},"EorBenefitsGetResponsesContentApplicationJsonSchemaDataItemsProvidersItemsPlansItemsAttachmentsItems":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the attachment."},"url":{"type":"string","description":"The url of the attachment."},"label":{"type":"string","description":"The label of the attachment."}},"required":["id","url","label"],"title":"EorBenefitsGetResponsesContentApplicationJsonSchemaDataItemsProvidersItemsPlansItemsAttachmentsItems"},"EorBenefitsGetResponsesContentApplicationJsonSchemaDataItemsProvidersItemsPlansItems":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the plan."},"name":{"type":"string","description":"The name of the plan."},"price":{"type":"number","format":"double","description":"The price of the plan."},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/EorBenefitsGetResponsesContentApplicationJsonSchemaDataItemsProvidersItemsPlansItemsAttachmentsItems"}}},"required":["id","name","price","attachments"],"title":"EorBenefitsGetResponsesContentApplicationJsonSchemaDataItemsProvidersItemsPlansItems"},"EorBenefitsGetResponsesContentApplicationJsonSchemaDataItemsProvidersItemsAttachmentsItems":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of the attachment."},"url":{"type":"string","description":"The url of the attachment."},"label":{"type":"string","description":"The label of the attachment."}},"required":["id","url","label"],"title":"EorBenefitsGetResponsesContentApplicationJsonSchemaDataItemsProvidersItemsAttachmentsItems"},"EorBenefitsGetResponsesContentApplicationJsonSchemaDataItemsProvidersItemsContributionOptionsItems":{"type":"object","properties":{"id":{"type":"string","description":"Unique ID of the contribution."},"amount":{"type":"number","format":"double","description":"Amount."}},"required":["id","amount"],"title":"EorBenefitsGetResponsesContentApplicationJsonSchemaDataItemsProvidersItemsContributionOptionsItems"},"EorBenefitsGetResponsesContentApplicationJsonSchemaDataItemsProvidersItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID of the benefit provider."},"name":{"type":"string","description":"The name of the benefit provider."},"type":{"type":"string","description":"Benefit type."},"plans":{"type":"array","items":{"$ref":"#/components/schemas/EorBenefitsGetResponsesContentApplicationJsonSchemaDataItemsProvidersItemsPlansItems"}},"country":{"type":"string","description":"Country code."},"currency":{"type":"string","description":"Currency."},"is_unisure":{"type":"boolean","description":"Indicates if Unisure."},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/EorBenefitsGetResponsesContentApplicationJsonSchemaDataItemsProvidersItemsAttachmentsItems"}},"client_info":{"type":["string","null"],"description":"Client information."},"employee_info":{"type":["string","null"],"description":"Employee information."},"home_page_url":{"type":"string","description":"The home page URL of the benefit provider."},"max_contribution":{"type":["number","null"],"format":"double","description":"Maximum contribution."},"min_contribution":{"type":["number","null"],"format":"double","description":"Minimum contribution."},"contribution_options":{"type":"array","items":{"$ref":"#/components/schemas/EorBenefitsGetResponsesContentApplicationJsonSchemaDataItemsProvidersItemsContributionOptionsItems"}}},"required":["id","name","type","plans","country","currency","is_unisure","attachments","home_page_url","contribution_options"],"title":"EorBenefitsGetResponsesContentApplicationJsonSchemaDataItemsProvidersItems"},"EorBenefitsGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"name":{"type":"string","description":"The name of the benefit."},"providers":{"type":"array","items":{"$ref":"#/components/schemas/EorBenefitsGetResponsesContentApplicationJsonSchemaDataItemsProvidersItems"}},"description":{"type":"string","description":"The description of the benefit."},"is_mandatory":{"type":"boolean","description":"Indicates if the benefit is mandatory."},"is_discriminatory":{"type":"boolean","description":"Indicates if the benefit is discriminatory."}},"required":["name","providers","description","is_mandatory","is_discriminatory"],"title":"EorBenefitsGetResponsesContentApplicationJsonSchemaDataItems"},"eor-hiring_getBenefits_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/EorBenefitsGetResponsesContentApplicationJsonSchemaDataItems"}}},"required":["data"],"title":"eor-hiring_getBenefits_Response_200"},"EorBenefitsGetResponsesContentApplicationJsonSchemaErrorsItems":{"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":"EorBenefitsGetResponsesContentApplicationJsonSchemaErrorsItems"},"EorBenefitsGetResponsesContentApplicationJsonSchemaRequest":{"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":"EorBenefitsGetResponsesContentApplicationJsonSchemaRequest"},"RetrieveBenefitsByCountryRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorBenefitsGetResponsesContentApplicationJsonSchemaErrorsItems"}},"request":{"$ref":"#/components/schemas/EorBenefitsGetResponsesContentApplicationJsonSchemaRequest"}},"title":"RetrieveBenefitsByCountryRequestBadRequestError"},"EorValidationsCountryCodeGetResponsesContentApplicationJsonSchemaDataSalaryFrequency":{"type":"string","enum":["monthly","quarterly","annually","specific_month","specific_date"],"description":"Frequency of the salary payment.","title":"EorValidationsCountryCodeGetResponsesContentApplicationJsonSchemaDataSalaryFrequency"},"EorValidationsCountryCodeGetResponsesContentApplicationJsonSchemaDataSalary":{"type":"object","properties":{"max":{"type":["string","null"],"description":"Maximum salary."},"min":{"type":["string","null"],"description":"Minimum salary."},"frequency":{"$ref":"#/components/schemas/EorValidationsCountryCodeGetResponsesContentApplicationJsonSchemaDataSalaryFrequency","description":"Frequency of the salary payment."}},"title":"EorValidationsCountryCodeGetResponsesContentApplicationJsonSchemaDataSalary"},"EorValidationsCountryCodeGetResponsesContentApplicationJsonSchemaDataHoliday":{"type":"object","properties":{"max":{"type":["string","null"],"description":"Maximum holidays."},"min":{"type":["string","null"],"description":"Minimum holidays."},"mostCommon":{"type":["string","null"],"description":"Most common holiday period."}},"title":"EorValidationsCountryCodeGetResponsesContentApplicationJsonSchemaDataHoliday"},"EorValidationsCountryCodeGetResponsesContentApplicationJsonSchemaDataProbation":{"type":"object","properties":{"max":{"type":["number","null"],"format":"double","description":"Maximum probation period."},"min":{"type":["number","null"],"format":"double","description":"Minimum probation period."}},"title":"EorValidationsCountryCodeGetResponsesContentApplicationJsonSchemaDataProbation"},"EorValidationsCountryCodeGetResponsesContentApplicationJsonSchemaDataHealthInsuranceStatus":{"type":"string","enum":["REQUIRED","ENABLED","DISABLED"],"description":"Health insurance status.","title":"EorValidationsCountryCodeGetResponsesContentApplicationJsonSchemaDataHealthInsuranceStatus"},"EorValidationsCountryCodeGetResponsesContentApplicationJsonSchemaDataHealthInsuranceProvidersItems":{"type":"object","properties":{"id":{"type":"string","description":"Provider ID."},"name":{"type":"string","description":"Provider name."}},"title":"EorValidationsCountryCodeGetResponsesContentApplicationJsonSchemaDataHealthInsuranceProvidersItems"},"EorValidationsCountryCodeGetResponsesContentApplicationJsonSchemaDataHealthInsurance":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/EorValidationsCountryCodeGetResponsesContentApplicationJsonSchemaDataHealthInsuranceStatus","description":"Health insurance status."},"providers":{"type":"array","items":{"$ref":"#/components/schemas/EorValidationsCountryCodeGetResponsesContentApplicationJsonSchemaDataHealthInsuranceProvidersItems"}}},"title":"EorValidationsCountryCodeGetResponsesContentApplicationJsonSchemaDataHealthInsurance"},"EorValidationsCountryCodeGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"salary":{"$ref":"#/components/schemas/EorValidationsCountryCodeGetResponsesContentApplicationJsonSchemaDataSalary"},"holiday":{"$ref":"#/components/schemas/EorValidationsCountryCodeGetResponsesContentApplicationJsonSchemaDataHoliday"},"currency":{"type":"string","description":"Country currency."},"probation":{"$ref":"#/components/schemas/EorValidationsCountryCodeGetResponsesContentApplicationJsonSchemaDataProbation"},"health_insurance":{"oneOf":[{"$ref":"#/components/schemas/EorValidationsCountryCodeGetResponsesContentApplicationJsonSchemaDataHealthInsurance"},{"type":"null"}]}},"title":"EorValidationsCountryCodeGetResponsesContentApplicationJsonSchemaData"},"eor-hiring_getEORHiringGuideByCountry_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorValidationsCountryCodeGetResponsesContentApplicationJsonSchemaData"}},"title":"eor-hiring_getEORHiringGuideByCountry_Response_200"},"EorContractsContractIdDocumentsTypeSignPostParametersType":{"type":"string","enum":["FRAMEWORK_AGREEMENT"],"title":"EorContractsContractIdDocumentsTypeSignPostParametersType"},"EorContractsContractIdDocumentsTypeSignPostRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"signature":{"type":"string","description":"The signature of the client signing the document."},"client_job_title":{"type":"string","description":"The job title of the client signing the document."}},"required":["signature","client_job_title"],"title":"EorContractsContractIdDocumentsTypeSignPostRequestBodyContentApplicationJsonSchemaData"},"EorContractsContractIdDocumentsTypeSignPostResponsesContentApplicationJsonSchemaDataDocumentType":{"type":"string","enum":["FRAMEWORK_AGREEMENT"],"description":"The type of document. Currently only FRAMEWORK_AGREEMENT is supported.","title":"EorContractsContractIdDocumentsTypeSignPostResponsesContentApplicationJsonSchemaDataDocumentType"},"EorContractsContractIdDocumentsTypeSignPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"signature":{"type":["string","null"],"description":"The signature of the client if the document is signed."},"signed_at":{"type":["string","null"],"format":"date-time","description":"The date and time the client signed the document if it is signed."},"document_type":{"$ref":"#/components/schemas/EorContractsContractIdDocumentsTypeSignPostResponsesContentApplicationJsonSchemaDataDocumentType","description":"The type of document. Currently only FRAMEWORK_AGREEMENT is supported."},"eor_signature":{"type":["string","null"],"description":"The signature of the EOR if the document is signed."},"eor_signed_at":{"type":["string","null"],"format":"date-time","description":"The date and time the EOR signed the document if it is signed."},"client_job_title":{"type":["string","null"],"description":"The job title of the client if the document is signed."}},"required":["document_type"],"title":"EorContractsContractIdDocumentsTypeSignPostResponsesContentApplicationJsonSchemaData"},"eor-hiring_signContractDocument_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorContractsContractIdDocumentsTypeSignPostResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"eor-hiring_signContractDocument_Response_200"},"EorContractsContractIdDocumentsTypeSignPostResponsesContentApplicationJsonSchemaErrorsItems":{"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":"EorContractsContractIdDocumentsTypeSignPostResponsesContentApplicationJsonSchemaErrorsItems"},"EorContractsContractIdDocumentsTypeSignPostResponsesContentApplicationJsonSchemaRequest":{"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":"EorContractsContractIdDocumentsTypeSignPostResponsesContentApplicationJsonSchemaRequest"},"SignEorContractDocumentRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdDocumentsTypeSignPostResponsesContentApplicationJsonSchemaErrorsItems"}},"request":{"$ref":"#/components/schemas/EorContractsContractIdDocumentsTypeSignPostResponsesContentApplicationJsonSchemaRequest"}},"title":"SignEorContractDocumentRequestBadRequestError"},"EorContractsContractIdEmployeeInformationPatchRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"employee_last_name":{"type":"string","description":"The last name of the employee."},"employee_first_name":{"type":"string","description":"The first name of the employee."}},"title":"EorContractsContractIdEmployeeInformationPatchRequestBodyContentApplicationJsonSchemaData"},"EorContractsContractIdEmployeeInformationPatchResponsesContentApplicationJsonSchemaDataStatus":{"type":"string","enum":["new","under_review","waiting_for_client_sign","waiting_for_eor_sign","waiting_for_employee_contract","waiting_for_employee_sign","awaiting_deposit_payment","rejected"],"description":"Current status of the contract","title":"EorContractsContractIdEmployeeInformationPatchResponsesContentApplicationJsonSchemaDataStatus"},"EorContractsContractIdEmployeeInformationPatchResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the employee contract."},"status":{"$ref":"#/components/schemas/EorContractsContractIdEmployeeInformationPatchResponsesContentApplicationJsonSchemaDataStatus","description":"Current status of the contract"},"scope_of_work":{"type":"string","description":"Scope of work description."},"employee_last_name":{"type":"string","description":"The last name of the contract employee."},"employee_first_name":{"type":"string","description":"The first name of the contract employee."}},"required":["id","status"],"title":"EorContractsContractIdEmployeeInformationPatchResponsesContentApplicationJsonSchemaData"},"eor-hiring_updateContractEmployeeInformation_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorContractsContractIdEmployeeInformationPatchResponsesContentApplicationJsonSchemaData"}},"title":"eor-hiring_updateContractEmployeeInformation_Response_200"},"EorContractsContractIdEmployeeInformationPatchResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code"},"message":{"type":"string","description":"Human-readable explanation of the error"}},"title":"EorContractsContractIdEmployeeInformationPatchResponsesContentApplicationJsonSchemaErrorsItems"},"UpdateEmployeeInformationForEorContractRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdEmployeeInformationPatchResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"UpdateEmployeeInformationForEorContractRequestBadRequestError"},"UpdateEmployeeInformationForEorContractRequestNotFoundError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdEmployeeInformationPatchResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"UpdateEmployeeInformationForEorContractRequestNotFoundError"},"UpdateEmployeeInformationForEorContractRequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdEmployeeInformationPatchResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"UpdateEmployeeInformationForEorContractRequestInternalServerError"},"EorJobScopesGetResponsesContentApplicationJsonSchemaItemsTeam":{"type":"object","properties":{"id":{"type":["string","null"],"description":"Unique identifier of the associated team, if any"},"name":{"type":["string","null"],"description":"Name of the team associated with the job scope, if any"}},"title":"EorJobScopesGetResponsesContentApplicationJsonSchemaItemsTeam"},"EorJobScopesGetResponsesContentApplicationJsonSchemaItemsCreatedBy":{"type":"object","properties":{"id":{"type":["string","null"],"description":"Unique identifier of the user who created the job scope"},"name":{"type":["string","null"],"description":"Name of the user who created the job scope"}},"title":"EorJobScopesGetResponsesContentApplicationJsonSchemaItemsCreatedBy"},"EorJobScopesGetResponsesContentApplicationJsonSchemaItemsUpdatedBy":{"type":"object","properties":{"id":{"type":["string","null"],"description":"Unique identifier of the user who last updated the job scope"},"name":{"type":["string","null"],"description":"Name of the user who last updated the job scope"}},"title":"EorJobScopesGetResponsesContentApplicationJsonSchemaItemsUpdatedBy"},"EorJobScopesGetResponsesContentApplicationJsonSchemaItemsSourceType":{"type":"string","enum":["MANUAL","AI"],"description":"Source of the job scope data","title":"EorJobScopesGetResponsesContentApplicationJsonSchemaItemsSourceType"},"EorJobScopesGetResponsesContentApplicationJsonSchemaItems":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the job scope"},"team":{"$ref":"#/components/schemas/EorJobScopesGetResponsesContentApplicationJsonSchemaItemsTeam"},"title":{"type":"string","description":"Title or name of the job scope"},"content":{"type":"string","description":"Detailed description of the job scope"},"personal":{"type":["string","null"],"description":"Identifier from the team or the profile, whichever is available"},"created_at":{"type":"string","description":"Timestamp of when the job scope was created"},"created_by":{"$ref":"#/components/schemas/EorJobScopesGetResponsesContentApplicationJsonSchemaItemsCreatedBy"},"updated_at":{"type":"string","description":"Timestamp of when the job scope was last updated"},"updated_by":{"$ref":"#/components/schemas/EorJobScopesGetResponsesContentApplicationJsonSchemaItemsUpdatedBy"},"source_type":{"$ref":"#/components/schemas/EorJobScopesGetResponsesContentApplicationJsonSchemaItemsSourceType","description":"Source of the job scope data"},"organization_id":{"type":["string","null"],"description":"Identifier of the associated organization, if any"}},"title":"EorJobScopesGetResponsesContentApplicationJsonSchemaItems"},"EorJobScopesGetResponsesContentApplicationJsonSchemaError":{"type":"string","enum":["No organization is linked with the profile","No teams found for this organization"],"description":"Error message indicating the missing entity","title":"EorJobScopesGetResponsesContentApplicationJsonSchemaError"},"ListOfJobScopeTemplatesForEorContractsRequestNotFoundError":{"type":"object","properties":{"error":{"$ref":"#/components/schemas/EorJobScopesGetResponsesContentApplicationJsonSchemaError","description":"Error message indicating the missing entity"}},"title":"ListOfJobScopeTemplatesForEorContractsRequestNotFoundError"},"EorJobScopesValidatePostRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"team_id":{"type":"string","format":"uuid","description":"The ID of the team."},"job_scope":{"type":"string","description":"The scope of the job."},"job_title":{"type":"string","description":"The title of the job."},"work_visa":{"type":"boolean","description":"Indicates if a work visa is required."},"client_name":{"type":"string","description":"Optional client name. The validation refuses a job scope if it includes the client name. If not provided, it will be inferred from the legal entity instead."},"employee_name":{"type":"string","description":"The name of the employee."},"special_job_id":{"type":["string","null"],"format":"uuid","description":"The ID of the special job."},"employment_state":{"type":["string","null"],"description":"The state of employment."},"employment_country":{"type":"string","description":"The country of employment."},"employee_nationality":{"type":"string","description":"The nationality of the employee."},"client_legal_entity_id":{"type":"string","format":"uuid","description":"The ID of the client's legal entity."}},"required":["team_id","job_scope","job_title","employee_name","employment_country","client_legal_entity_id"],"description":"details of job scope","title":"EorJobScopesValidatePostRequestBodyContentApplicationJsonSchemaData"},"EorJobScopesValidatePostResponsesContentApplicationJsonSchemaErrorsItems":{"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":"EorJobScopesValidatePostResponsesContentApplicationJsonSchemaErrorsItems"},"EorJobScopesValidatePostResponsesContentApplicationJsonSchemaDataForCorrectedJobScopeEndpointErrorsForCorrectJobScopeItems":{"type":"object","properties":{"message":{"type":"string","description":"Message with error description"}},"title":"EorJobScopesValidatePostResponsesContentApplicationJsonSchemaDataForCorrectedJobScopeEndpointErrorsForCorrectJobScopeItems"},"EorJobScopesValidatePostResponsesContentApplicationJsonSchemaDataForCorrectedJobScopeEndpoint":{"type":"object","properties":{"anonymized_job_scope":{"type":["string","null"],"description":"Anonymized job scope."},"errors_for_correct_job_scope":{"type":"array","items":{"$ref":"#/components/schemas/EorJobScopesValidatePostResponsesContentApplicationJsonSchemaDataForCorrectedJobScopeEndpointErrorsForCorrectJobScopeItems"},"description":"List of errors for corrected job scope."},"must_create_correct_job_scope":{"type":"boolean","description":"Indicates if a corrected job scope is required."}},"description":"Data for corrected job scope endpoint.","title":"EorJobScopesValidatePostResponsesContentApplicationJsonSchemaDataForCorrectedJobScopeEndpoint"},"eor-job-scopes_validateJobScope_Response_200":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorJobScopesValidatePostResponsesContentApplicationJsonSchemaErrorsItems"},"description":"List of validation errors, if empty the validation was successfully."},"quote_validation_log_public_id":{"type":"string","description":"Id from validation request."},"data_for_corrected_job_scope_endpoint":{"$ref":"#/components/schemas/EorJobScopesValidatePostResponsesContentApplicationJsonSchemaDataForCorrectedJobScopeEndpoint","description":"Data for corrected job scope endpoint."}},"title":"eor-job-scopes_validateJobScope_Response_200"},"EorJobScopesValidatePostResponsesContentApplicationJsonSchemaRequest":{"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":"EorJobScopesValidatePostResponsesContentApplicationJsonSchemaRequest"},"RequestJobScopeValidation-v2026-01-01RequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorJobScopesValidatePostResponsesContentApplicationJsonSchemaErrorsItems"}},"request":{"$ref":"#/components/schemas/EorJobScopesValidatePostResponsesContentApplicationJsonSchemaRequest"}},"title":"RequestJobScopeValidation-v2026-01-01RequestBadRequestError"},"EorContractsContractIdOffboardingReviewClientSignOffsPostRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"reviewer_feedback":{"type":["string","null"],"description":"Feedback from the reviewer when the termination is not approved. Required if has_client_approved is false, otherwise optional."},"has_client_approved":{"type":"boolean","description":"Indicates if the client has approved the termination request"},"has_employee_been_notified":{"type":["boolean","null"],"description":"Indicates if the employee has been notified about the termiantion"}},"required":["has_client_approved"],"title":"EorContractsContractIdOffboardingReviewClientSignOffsPostRequestBodyContentApplicationJsonSchemaData"},"EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsSupportingItems":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the file"},"name":{"type":"string","description":"The name of the file"},"type":{"type":"string","description":"The type/extension of the file"},"created_at":{"type":"string","format":"date-time","description":"The date and time the file was created"},"updated_at":{"type":"string","format":"date-time","description":"The date and time the file was updated"},"is_additional_supporting_document":{"type":"boolean","description":"Indicates if this is an additional supporting document added after the initial submission"}},"required":["id","name","type","created_at","updated_at","is_additional_supporting_document"],"title":"EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsSupportingItems"},"EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsFilesItems":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the file"},"name":{"type":"string","description":"The name of the file"},"type":{"type":"string","description":"The type/extension of the file"},"created_at":{"type":"string","format":"date-time","description":"The date and time the file was created"},"updated_at":{"type":"string","format":"date-time","description":"The date and time the file was updated"}},"required":["id","name","type","created_at"],"title":"EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsFilesItems"},"EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsStatus":{"type":"string","enum":["AWAITING_REVIEW","AWAITING_FEEDBACK","FEEDBACK_PROVIDED","APPROVED","CHANGES_REQUESTED_BY_CLIENT","CHANGES_REQUESTED_BY_EMPLOYEE","WAIVED_REVIEW","NOT_RESPONDED","CANCELLED"],"description":"The current status of the document review","title":"EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsStatus"},"EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsReviewerType":{"type":"string","enum":["CLIENT","EMPLOYEE"],"description":"The type of reviewer for this document","title":"EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsReviewerType"},"EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the document set shared with the employee."},"files":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsFilesItems"}},"status":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsStatus","description":"The current status of the document review"},"created_at":{"type":"string","format":"date-time","description":"The date and time the document set was created"},"updated_at":{"type":"string","format":"date-time","description":"The date and time the document set was updated"},"reviewed_at":{"type":["string","null"],"format":"date-time","description":"The date and time when the document was reviewed"},"reviewed_by":{"type":["string","null"],"description":"The name of the reviewer for this document. If the reviewer is not an employee, it will be the name of the client"},"reviewer_type":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsReviewerType","description":"The type of reviewer for this document"},"reviewer_feedback":{"type":["string","null"],"description":"Feedback provided by the reviewer"},"notification_instructions":{"type":["string","null"],"description":"HTML instructions for the reviewer notification"},"is_employee_notification_required":{"type":"boolean","description":"Indicates if the employee should be notified about this document review"}},"required":["files","status","reviewer_type","is_employee_notification_required"],"title":"EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItems"},"EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsResignationLetter":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the resignation letter"},"signature":{"type":["string","null"],"description":"The signature of the resignation letter"},"signed_at":{"type":["string","null"],"format":"date-time","description":"The date and time when the resignation letter was signed"},"created_at":{"type":"string","format":"date-time","description":"The date and time the resignation letter was created"},"updated_at":{"type":"string","format":"date-time","description":"The date and time the resignation letter was updated"}},"title":"EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsResignationLetter"},"EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataDocuments":{"type":"object","properties":{"supporting":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsSupportingItems"}},"offboarding":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItems"},"description":"Document set shared that requires client or employee review"},"resignation_letter":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsResignationLetter"},{"type":"null"}]}},"required":["supporting","offboarding"],"description":"Document management structure for termination workflow including review processes and supporting documents","title":"EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataDocuments"},"EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataReason":{"type":"string","enum":["STATUS_CHANGE","RELOCATION","COMPENSATION","RETIREMENT","JOB_ABANDONMENT","WORK_RELATED","PERSONAL","OTHER_OPPORTUNITY","NON_RENEWAL","PROBATION","ASSIGNMENT_ENDED","POSITION_ELIMINATION","FORCE_REDUCTION","DEATH","FOR_CAUSE","PERFORMANCE","MEDICAL","PERFORMANCE_ISSUES","ATTENDANCE_ISSUES","REORGANIZATION_DOWNSIZING_BUDGET_OR_REDUCTION_OF_WORKFORCE","ROLE_BECAME_REDUNDANT_OR_ROLE_CHANGED","OFFER_WAS_REVOKED","EXITING_THE_MARKET","NO_LONGER_WISH_TO_WORK_WITH_DEEL","COMPANY_ACQUIRED","STEALING","MISCONDUCT","FALSIFYING","HARASSMENT","VIOLENCE","REORGANIZATION_DOWNSIZING_BUDGET_OR_REDUCTION_OF_WORKFORCE_OR_ROLE_BECAME_REDUNDANT_OR_ROLE_CHANGED","UNAUTHORIZED_ABSENCES_OR_LACK_OF_ATTENDANCE","STANDARD_RESELLER_PRACTICE","MOVING_EMPLOYEE_TO_INTERNAL_ENTITY","MOVING_EMPLOYEE_TO_DEEL_PEO","OTHER"],"description":"The reason for the termination","title":"EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataReason"},"EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsUnit":{"type":"string","enum":["BUSINESS_DAY","CALENDAR_DAY","HOUR"],"description":"The unit of measurement for time off tracking","title":"EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsUnit"},"EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsTrackingPeriodsItems":{"type":"object","properties":{"used":{"type":"number","format":"double","description":"The amount of time off used in this tracking period"},"end_date":{"type":"string","format":"date-time","description":"The end date of the tracking period"},"start_date":{"type":"string","format":"date-time","description":"The start date of the tracking period"}},"required":["used","end_date","start_date"],"title":"EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsTrackingPeriodsItems"},"EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItems":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsUnit","description":"The unit of measurement for time off tracking"},"policy_type":{"type":"string","description":"The type of time-off policy"},"tracking_periods":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsTrackingPeriodsItems"}},"scheduled_until_end_date":{"type":"number","format":"double","description":"The amount of time off scheduled until the end date of the current tracking period"}},"required":["unit","policy_type","tracking_periods","scheduled_until_end_date"],"title":"EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItems"},"EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffAdditionalDetails":{"type":"object","properties":{"notes":{"type":["string","null"],"description":"Additional notes or comments about the time-off data"},"updated_by":{"type":["string","null"],"description":"The person or system that last updated the time-off data"},"last_updated_at":{"type":["string","null"],"format":"date-time","description":"The date and time when the time-off data was last updated"}},"title":"EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffAdditionalDetails"},"EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOff":{"type":"object","properties":{"time_offs":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItems"}},"additional_details":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffAdditionalDetails"},{"type":"null"}]},"is_deel_pto_confirmed":{"type":"boolean","description":"Indicates whether the PTO allocation has been confirmed by Deel's system"}},"required":["time_offs","is_deel_pto_confirmed"],"description":"Time-off usage data including policy information and tracking periods","title":"EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOff"},"EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataEligibleForRehire":{"type":"string","enum":["YES","NO","DONT_KNOW"],"description":"Parameter to inform whether it would be possible for the client to hire the employee again","title":"EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataEligibleForRehire"},"EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataRequestData":{"type":"object","properties":{"reason":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataReason","description":"The reason for the termination"},"end_date":{"type":["string","null"],"format":"date-time","description":"The definitive contract end date"},"reason_detail":{"type":["string","null"],"description":"Optional field to describe the reason behind the resignation request"},"used_time_off":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOff","description":"Time-off usage data including policy information and tracking periods"},"desired_end_date":{"type":["string","null"],"format":"date","description":"The desired end date. If the date is not provided, it will be selected by HRX the closest date possible"},"eligible_for_rehire":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataEligibleForRehire"},{"type":"null"}],"description":"Parameter to inform whether it would be possible for the client to hire the employee again"},"eligible_for_rehire_reason":{"type":["string","null"],"description":"Describe if the option DONT_KNOW was selected on eligible_for_rehire"}},"title":"EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataRequestData"},"EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the offboarding request"},"end_date":{"type":["string","null"],"format":"date-time","description":"The definitive contract end date"},"documents":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataDocuments","description":"Document management structure for termination workflow including review processes and supporting documents"},"created_at":{"type":"string","format":"date-time","description":"The date and time the offboarding request was created"},"updated_at":{"type":"string","format":"date-time","description":"The date and time the offboarding request was updated"},"contract_id":{"type":"string","description":"The unique identifier of the employee contract."},"is_sensitive":{"type":"boolean","description":"Indicates if the offboarding request is sensitive. This is used to restrict access to the request only to the requester and the HRX team."},"request_data":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaDataRequestData"},{"type":"null"}]},"desired_end_date":{"type":["string","null"],"format":"date-time","description":"The desired end date. If the date is not provided, it will be selected by HRX the closest date possible"}},"title":"EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaData"},"eor-offboarding_createEOROffboardingClientSignOff_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"eor-offboarding_createEOROffboardingClientSignOff_Response_200"},"EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string","description":"Error code of the handler which produced the returned error"},"field":{"type":"string","description":"The field name where error occurred (null for server errors)"},"message":{"type":"string","description":"Description of the returned error"}},"title":"EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaErrorsItems"},"ReviewApproveOrRequestChangesToEorOffboardingDocumentsRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"ReviewApproveOrRequestChangesToEorOffboardingDocumentsRequestBadRequestError"},"ReviewApproveOrRequestChangesToEorOffboardingDocumentsRequestUnauthorizedError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"ReviewApproveOrRequestChangesToEorOffboardingDocumentsRequestUnauthorizedError"},"ReviewApproveOrRequestChangesToEorOffboardingDocumentsRequestForbiddenError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"ReviewApproveOrRequestChangesToEorOffboardingDocumentsRequestForbiddenError"},"ReviewApproveOrRequestChangesToEorOffboardingDocumentsRequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingReviewClientSignOffsPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"ReviewApproveOrRequestChangesToEorOffboardingDocumentsRequestInternalServerError"},"EorContractsContractIdOffboardingRequiredInformationGetResponsesContentApplicationJsonSchemaDataQuestionsItems":{"type":"object","properties":{"text":{"type":"string","description":"Specifies the text of additional questions that the client must answer when requesting a termination"},"is_optional":{"type":"boolean","description":"Indicates whether answering the question is optional. If false, client must provide an answer."}},"title":"EorContractsContractIdOffboardingRequiredInformationGetResponsesContentApplicationJsonSchemaDataQuestionsItems"},"EorContractsContractIdOffboardingRequiredInformationGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"documents":{"type":["string","null"],"description":"If not null, specifies the documents that the client must upload when requesting a termination"},"questions":{"type":["array","null"],"items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingRequiredInformationGetResponsesContentApplicationJsonSchemaDataQuestionsItems"},"description":"A list of additional questions that the client must answer when requesting a termination. Some questions are mandatory, while others are optional."}},"description":"Specifies the text of additional questions that the client must answer when requesting a termination","title":"EorContractsContractIdOffboardingRequiredInformationGetResponsesContentApplicationJsonSchemaData"},"eor-offboarding_getEORContractOffboardingRequiredInformation_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingRequiredInformationGetResponsesContentApplicationJsonSchemaData","description":"Specifies the text of additional questions that the client must answer when requesting a termination"}},"required":["data"],"title":"eor-offboarding_getEORContractOffboardingRequiredInformation_Response_200"},"EorContractsContractIdOffboardingRequiredInformationGetResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string","description":"Error code of the handler which produced the returned error"},"field":{"type":"string","description":"The field name where error occurred (null for server errors)"},"message":{"type":"string","description":"Description of the returned error"}},"title":"EorContractsContractIdOffboardingRequiredInformationGetResponsesContentApplicationJsonSchemaErrorsItems"},"GetAdditionalInformationRequiredToRequestEmployeeTerminationRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingRequiredInformationGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"GetAdditionalInformationRequiredToRequestEmployeeTerminationRequestBadRequestError"},"GetAdditionalInformationRequiredToRequestEmployeeTerminationRequestUnauthorizedError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingRequiredInformationGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"GetAdditionalInformationRequiredToRequestEmployeeTerminationRequestUnauthorizedError"},"GetAdditionalInformationRequiredToRequestEmployeeTerminationRequestForbiddenError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingRequiredInformationGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"GetAdditionalInformationRequiredToRequestEmployeeTerminationRequestForbiddenError"},"GetAdditionalInformationRequiredToRequestEmployeeTerminationRequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingRequiredInformationGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"GetAdditionalInformationRequiredToRequestEmployeeTerminationRequestInternalServerError"},"EorContractsContractIdOffboardingTimeOffsGetResponsesContentApplicationJsonSchemaDataEntitlementsItemsEntitlementUnit":{"type":"string","enum":["BUSINESS_DAY","CALENDAR_DAY","HOUR","WEEK","MONTH","YEAR"],"description":"Unit of time measurement","title":"EorContractsContractIdOffboardingTimeOffsGetResponsesContentApplicationJsonSchemaDataEntitlementsItemsEntitlementUnit"},"EorContractsContractIdOffboardingTimeOffsGetResponsesContentApplicationJsonSchemaDataEntitlementsItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The entitlement ID"},"used":{"type":"number","format":"double","description":"Amount of time off used in this period"},"requests":{"type":"integer","description":"Number of time off requests in this period"},"created_at":{"type":"string","format":"date-time","description":"When the entitlement was created"},"updated_at":{"type":"string","format":"date-time","description":"When the entitlement was updated"},"tracking_period":{"type":"string","format":"date","description":"The tracking period start date"},"entitlement_unit":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingTimeOffsGetResponsesContentApplicationJsonSchemaDataEntitlementsItemsEntitlementUnit","description":"Unit of time measurement"},"tracking_period_end_date":{"type":"string","format":"date","description":"The tracking period end date"}},"required":["id","used","requests","created_at","updated_at","tracking_period","entitlement_unit","tracking_period_end_date"],"title":"EorContractsContractIdOffboardingTimeOffsGetResponsesContentApplicationJsonSchemaDataEntitlementsItems"},"EorContractsContractIdOffboardingTimeOffsGetResponsesContentApplicationJsonSchemaDataTrackingType":{"type":"string","enum":["OFF_PLATFORM","ON_PLATFORM"],"description":"The time off tracking type","title":"EorContractsContractIdOffboardingTimeOffsGetResponsesContentApplicationJsonSchemaDataTrackingType"},"EorContractsContractIdOffboardingTimeOffsGetResponsesContentApplicationJsonSchemaDataPolicySettings":{"type":"object","properties":{"entitlement_unit":{"type":"string","description":"The entitlement unit for the policy"},"is_accrued_days_available":{"type":"boolean","description":"Whether accrued days are available"},"is_estimated_payout_available":{"type":"boolean","description":"Whether estimated payout is available"}},"required":["entitlement_unit","is_accrued_days_available","is_estimated_payout_available"],"description":"Policy configuration settings for time off calculations","title":"EorContractsContractIdOffboardingTimeOffsGetResponsesContentApplicationJsonSchemaDataPolicySettings"},"EorContractsContractIdOffboardingTimeOffsGetResponsesContentApplicationJsonSchemaDataUpcomingTimeOffsItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Time off request ID"},"amount":{"type":"number","format":"double","description":"Amount of time off requested"},"status":{"type":"string","description":"Status of the time off request"},"end_date":{"type":"string","format":"date-time","description":"End date of the time off"},"created_at":{"type":"string","format":"date-time","description":"When the time off request was created"},"start_date":{"type":"string","format":"date-time","description":"Start date of the time off"},"updated_at":{"type":"string","format":"date-time","description":"When the time off request was updated"},"approved_at":{"type":"string","format":"date-time","description":"When the time off was approved"},"requested_at":{"type":"string","format":"date-time","description":"When the time off was requested"}},"required":["id","amount","status","end_date","created_at","start_date","updated_at","approved_at","requested_at"],"title":"EorContractsContractIdOffboardingTimeOffsGetResponsesContentApplicationJsonSchemaDataUpcomingTimeOffsItems"},"EorContractsContractIdOffboardingTimeOffsGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"contract_id":{"type":"string","description":"The unique identifier of the employee contract"},"entitlements":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingTimeOffsGetResponsesContentApplicationJsonSchemaDataEntitlementsItems"},"description":"List of entitlement periods sorted by tracking period (descending)"},"tracking_type":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingTimeOffsGetResponsesContentApplicationJsonSchemaDataTrackingType","description":"The time off tracking type"},"policy_settings":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingTimeOffsGetResponsesContentApplicationJsonSchemaDataPolicySettings","description":"Policy configuration settings for time off calculations"},"remaining_balance":{"type":["number","null"],"format":"double","description":"Remaining time off balance"},"upcoming_time_offs":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingTimeOffsGetResponsesContentApplicationJsonSchemaDataUpcomingTimeOffsItems"},"description":"List of upcoming time off requests"},"has_external_integration":{"type":"boolean","description":"Whether the contract has external integration"}},"required":["contract_id","entitlements","tracking_type","policy_settings","upcoming_time_offs","has_external_integration"],"title":"EorContractsContractIdOffboardingTimeOffsGetResponsesContentApplicationJsonSchemaData"},"eor-offboarding_getContractOffboardingTimeOffs_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingTimeOffsGetResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"eor-offboarding_getContractOffboardingTimeOffs_Response_200"},"EorContractsContractIdOffboardingTimeOffsGetResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string","description":"Error code of the handler which produced the returned error"},"field":{"type":"string","description":"The field name where error occurred (null for server errors)"},"message":{"type":"string","description":"Description of the returned error"}},"title":"EorContractsContractIdOffboardingTimeOffsGetResponsesContentApplicationJsonSchemaErrorsItems"},"RetrieveEmployeeTimeOffDataForOffboardingRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingTimeOffsGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"RetrieveEmployeeTimeOffDataForOffboardingRequestBadRequestError"},"RetrieveEmployeeTimeOffDataForOffboardingRequestUnauthorizedError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingTimeOffsGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"RetrieveEmployeeTimeOffDataForOffboardingRequestUnauthorizedError"},"RetrieveEmployeeTimeOffDataForOffboardingRequestForbiddenError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingTimeOffsGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"RetrieveEmployeeTimeOffDataForOffboardingRequestForbiddenError"},"RetrieveEmployeeTimeOffDataForOffboardingRequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingTimeOffsGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"RetrieveEmployeeTimeOffDataForOffboardingRequestInternalServerError"},"EorContractsContractIdOffboardingAttachmentsAttachmentIdGetResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string","description":"Error code of the handler which produced the returned error"},"field":{"type":"string","description":"The field name where error occurred (null for server errors)"},"message":{"type":"string","description":"Description of the returned error"}},"title":"EorContractsContractIdOffboardingAttachmentsAttachmentIdGetResponsesContentApplicationJsonSchemaErrorsItems"},"RetrieveOffboardingAttachmentRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingAttachmentsAttachmentIdGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"RetrieveOffboardingAttachmentRequestBadRequestError"},"RetrieveOffboardingAttachmentRequestUnauthorizedError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingAttachmentsAttachmentIdGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"RetrieveOffboardingAttachmentRequestUnauthorizedError"},"RetrieveOffboardingAttachmentRequestForbiddenError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingAttachmentsAttachmentIdGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"RetrieveOffboardingAttachmentRequestForbiddenError"},"RetrieveOffboardingAttachmentRequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingAttachmentsAttachmentIdGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"RetrieveOffboardingAttachmentRequestInternalServerError"},"EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataDocumentsSupportingItems":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the file"},"name":{"type":"string","description":"The name of the file"},"type":{"type":"string","description":"The type/extension of the file"},"created_at":{"type":"string","format":"date-time","description":"The date and time the file was created"},"updated_at":{"type":"string","format":"date-time","description":"The date and time the file was updated"},"is_additional_supporting_document":{"type":"boolean","description":"Indicates if this is an additional supporting document added after the initial submission"}},"required":["id","name","type","created_at","updated_at","is_additional_supporting_document"],"title":"EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataDocumentsSupportingItems"},"EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsFilesItems":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the file"},"name":{"type":"string","description":"The name of the file"},"type":{"type":"string","description":"The type/extension of the file"},"created_at":{"type":"string","format":"date-time","description":"The date and time the file was created"},"updated_at":{"type":"string","format":"date-time","description":"The date and time the file was updated"}},"required":["id","name","type","created_at"],"title":"EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsFilesItems"},"EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsStatus":{"type":"string","enum":["AWAITING_REVIEW","AWAITING_FEEDBACK","FEEDBACK_PROVIDED","APPROVED","CHANGES_REQUESTED_BY_CLIENT","CHANGES_REQUESTED_BY_EMPLOYEE","WAIVED_REVIEW","NOT_RESPONDED","CANCELLED"],"description":"The current status of the document review","title":"EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsStatus"},"EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsReviewerType":{"type":"string","enum":["CLIENT","EMPLOYEE"],"description":"The type of reviewer for this document","title":"EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsReviewerType"},"EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the document set shared with the employee."},"files":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsFilesItems"}},"status":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsStatus","description":"The current status of the document review"},"created_at":{"type":"string","format":"date-time","description":"The date and time the document set was created"},"updated_at":{"type":"string","format":"date-time","description":"The date and time the document set was updated"},"reviewed_at":{"type":["string","null"],"format":"date-time","description":"The date and time when the document was reviewed"},"reviewed_by":{"type":["string","null"],"description":"The name of the reviewer for this document. If the reviewer is not an employee, it will be the name of the client"},"reviewer_type":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsReviewerType","description":"The type of reviewer for this document"},"reviewer_feedback":{"type":["string","null"],"description":"Feedback provided by the reviewer"},"notification_instructions":{"type":["string","null"],"description":"HTML instructions for the reviewer notification"},"is_employee_notification_required":{"type":"boolean","description":"Indicates if the employee should be notified about this document review"}},"required":["files","status","reviewer_type","is_employee_notification_required"],"title":"EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItems"},"EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataDocuments":{"type":"object","properties":{"supporting":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataDocumentsSupportingItems"}},"offboarding":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItems"},"description":"Document set shared that requires client or employee review"}},"required":["supporting","offboarding"],"description":"Document management structure for termination workflow including review processes and supporting documents","title":"EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataDocuments"},"EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataRequestDataReason":{"type":"string","enum":["STATUS_CHANGE","RELOCATION","COMPENSATION","RETIREMENT","JOB_ABANDONMENT","WORK_RELATED","PERSONAL","OTHER_OPPORTUNITY","NON_RENEWAL","PROBATION","ASSIGNMENT_ENDED","POSITION_ELIMINATION","FORCE_REDUCTION","DEATH","FOR_CAUSE","PERFORMANCE","MEDICAL","PERFORMANCE_ISSUES","ATTENDANCE_ISSUES","REORGANIZATION_DOWNSIZING_BUDGET_OR_REDUCTION_OF_WORKFORCE","ROLE_BECAME_REDUNDANT_OR_ROLE_CHANGED","OFFER_WAS_REVOKED","EXITING_THE_MARKET","NO_LONGER_WISH_TO_WORK_WITH_DEEL","COMPANY_ACQUIRED","STEALING","MISCONDUCT","FALSIFYING","HARASSMENT","VIOLENCE","REORGANIZATION_DOWNSIZING_BUDGET_OR_REDUCTION_OF_WORKFORCE_OR_ROLE_BECAME_REDUNDANT_OR_ROLE_CHANGED","UNAUTHORIZED_ABSENCES_OR_LACK_OF_ATTENDANCE","STANDARD_RESELLER_PRACTICE","MOVING_EMPLOYEE_TO_INTERNAL_ENTITY","MOVING_EMPLOYEE_TO_DEEL_PEO","OTHER"],"description":"The reason for the termination","title":"EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataRequestDataReason"},"EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsUnit":{"type":"string","enum":["BUSINESS_DAY","CALENDAR_DAY","HOUR"],"description":"The unit of measurement for time off tracking","title":"EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsUnit"},"EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsTrackingPeriodsItems":{"type":"object","properties":{"used":{"type":"number","format":"double","description":"The amount of time off used in this tracking period"},"end_date":{"type":"string","format":"date-time","description":"The end date of the tracking period"},"start_date":{"type":"string","format":"date-time","description":"The start date of the tracking period"}},"required":["used","end_date","start_date"],"title":"EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsTrackingPeriodsItems"},"EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItems":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsUnit","description":"The unit of measurement for time off tracking"},"policy_type":{"type":"string","description":"The type of time-off policy"},"tracking_periods":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsTrackingPeriodsItems"}},"scheduled_until_end_date":{"type":"number","format":"double","description":"The amount of time off scheduled until the end date of the current tracking period"}},"required":["unit","policy_type","tracking_periods","scheduled_until_end_date"],"title":"EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItems"},"EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffAdditionalDetails":{"type":"object","properties":{"notes":{"type":["string","null"],"description":"Additional notes or comments about the time-off data"},"updated_by":{"type":["string","null"],"description":"The person or system that last updated the time-off data"},"last_updated_at":{"type":["string","null"],"format":"date-time","description":"The date and time when the time-off data was last updated"}},"title":"EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffAdditionalDetails"},"EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOff":{"type":"object","properties":{"time_offs":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItems"}},"additional_details":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffAdditionalDetails"},{"type":"null"}]},"is_deel_pto_confirmed":{"type":"boolean","description":"Indicates whether the PTO allocation has been confirmed by Deel's system"}},"required":["time_offs","is_deel_pto_confirmed"],"description":"Time-off usage data including policy information and tracking periods","title":"EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOff"},"EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataRequestDataEligibleForRehire":{"type":"string","enum":["YES","NO","DONT_KNOW"],"description":"Parameter to inform whether it would be possible for the client to hire the employee again","title":"EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataRequestDataEligibleForRehire"},"EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataRequestData":{"type":"object","properties":{"reason":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataRequestDataReason","description":"The reason for the termination"},"end_date":{"type":["string","null"],"format":"date-time","description":"The definitive contract end date"},"reason_detail":{"type":["string","null"],"description":"Optional field to describe the reason behind the resignation request"},"used_time_off":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOff","description":"Time-off usage data including policy information and tracking periods"},"desired_end_date":{"type":["string","null"],"format":"date","description":"The desired end date. If the date is not provided, it will be selected by HRX the closest date possible"},"eligible_for_rehire":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataRequestDataEligibleForRehire"},{"type":"null"}],"description":"Parameter to inform whether it would be possible for the client to hire the employee again"},"eligible_for_rehire_reason":{"type":["string","null"],"description":"Describe if the option DONT_KNOW was selected on eligible_for_rehire"}},"title":"EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataRequestData"},"EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the offboarding request"},"end_date":{"type":["string","null"],"format":"date-time","description":"The definitive contract end date"},"documents":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataDocuments","description":"Document management structure for termination workflow including review processes and supporting documents"},"created_at":{"type":"string","format":"date-time","description":"The date and time the offboarding request was created"},"updated_at":{"type":"string","format":"date-time","description":"The date and time the offboarding request was updated"},"contract_id":{"type":"string","description":"The unique identifier of the employee contract."},"is_sensitive":{"type":"boolean","description":"Indicates if the offboarding request is sensitive. This is used to restrict access to the request only to the requester and the HRX team."},"request_data":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaDataRequestData"},{"type":"null"}]},"desired_end_date":{"type":["string","null"],"format":"date-time","description":"The desired end date. If the date is not provided, it will be selected by HRX the closest date possible"}},"title":"EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaData"},"eor-offboarding_getContractOffboarding_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"eor-offboarding_getContractOffboarding_Response_200"},"EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string","description":"Error code of the handler which produced the returned error"},"field":{"type":"string","description":"The field name where error occurred (null for server errors)"},"message":{"type":"string","description":"Description of the returned error"}},"title":"EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaErrorsItems"},"RetrieveOffboardingRequestRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"RetrieveOffboardingRequestRequestBadRequestError"},"RetrieveOffboardingRequestRequestUnauthorizedError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"RetrieveOffboardingRequestRequestUnauthorizedError"},"RetrieveOffboardingRequestRequestForbiddenError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"RetrieveOffboardingRequestRequestForbiddenError"},"RetrieveOffboardingRequestRequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"RetrieveOffboardingRequestRequestInternalServerError"},"EorContractsContractIdOffboardingRestrictedDatesGetParametersTerminationType":{"type":"string","enum":["TERMINATION","RESIGNATION"],"title":"EorContractsContractIdOffboardingRestrictedDatesGetParametersTerminationType"},"EorContractsContractIdOffboardingRestrictedDatesGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"restricted_dates":{"type":"array","items":{"type":"string","format":"date-time"},"description":"Dates that are not enabled for selection."},"earliest_available_end_date":{"type":"string","format":"date-time","description":"The earliest date that can be selected as the end date."},"is_out_work_scheduled_allowed":{"type":"boolean","description":"Whether scheduling out of work is allowed."},"is_end_date_allowed_on_holidays":{"type":"boolean","description":"Whether end date selection is allowed on holidays."}},"required":["restricted_dates","earliest_available_end_date","is_out_work_scheduled_allowed","is_end_date_allowed_on_holidays"],"title":"EorContractsContractIdOffboardingRestrictedDatesGetResponsesContentApplicationJsonSchemaData"},"eor-offboarding_getContractOffboardingRestrictedDates_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingRestrictedDatesGetResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"eor-offboarding_getContractOffboardingRestrictedDates_Response_200"},"EorContractsContractIdOffboardingRestrictedDatesGetResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string","description":"Error code of the handler which produced the returned error"},"field":{"type":"string","description":"The field name where error occurred (null for server errors)"},"message":{"type":"string","description":"Description of the returned error"}},"title":"EorContractsContractIdOffboardingRestrictedDatesGetResponsesContentApplicationJsonSchemaErrorsItems"},"RetrieveRestrictedOffboardingDatesRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingRestrictedDatesGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"RetrieveRestrictedOffboardingDatesRequestBadRequestError"},"RetrieveRestrictedOffboardingDatesRequestUnauthorizedError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingRestrictedDatesGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"RetrieveRestrictedOffboardingDatesRequestUnauthorizedError"},"RetrieveRestrictedOffboardingDatesRequestForbiddenError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingRestrictedDatesGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"RetrieveRestrictedOffboardingDatesRequestForbiddenError"},"RetrieveRestrictedOffboardingDatesRequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingRestrictedDatesGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"RetrieveRestrictedOffboardingDatesRequestInternalServerError"},"EorContractsContractIdOffboardingResignationsReviewPtoPostRequestBodyContentApplicationJsonSchemaDataUsedTimeOffTrackingType":{"type":"string","enum":["ON_PLATFORM","OFF_PLATFORM"],"description":"Type of time off tracking - whether it's tracked on Deel platform or off platform","title":"EorContractsContractIdOffboardingResignationsReviewPtoPostRequestBodyContentApplicationJsonSchemaDataUsedTimeOffTrackingType"},"EorContractsContractIdOffboardingResignationsReviewPtoPostRequestBodyContentApplicationJsonSchemaDataUsedTimeOffOffPlatformUsedTimeOffEntitlementsItems":{"type":"object","properties":{"used":{"type":"number","format":"double","description":"Amount of time off used in the period"},"tracking_period":{"type":"string","format":"date","description":"Start date of the tracking period"},"tracking_period_end_date":{"type":"string","format":"date","description":"End date of the tracking period"}},"required":["used","tracking_period","tracking_period_end_date"],"title":"EorContractsContractIdOffboardingResignationsReviewPtoPostRequestBodyContentApplicationJsonSchemaDataUsedTimeOffOffPlatformUsedTimeOffEntitlementsItems"},"EorContractsContractIdOffboardingResignationsReviewPtoPostRequestBodyContentApplicationJsonSchemaDataUsedTimeOffOffPlatformUsedTimeOffEntitlementUnit":{"type":"string","enum":["BUSINESS_DAY","CALENDAR_DAY","HOUR","WEEK","MONTH","YEAR"],"description":"Unit of measurement for the time off entitlements","title":"EorContractsContractIdOffboardingResignationsReviewPtoPostRequestBodyContentApplicationJsonSchemaDataUsedTimeOffOffPlatformUsedTimeOffEntitlementUnit"},"EorContractsContractIdOffboardingResignationsReviewPtoPostRequestBodyContentApplicationJsonSchemaDataUsedTimeOffOffPlatformUsedTimeOff":{"type":"object","properties":{"entitlements":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingResignationsReviewPtoPostRequestBodyContentApplicationJsonSchemaDataUsedTimeOffOffPlatformUsedTimeOffEntitlementsItems"},"description":"Array of time off entitlements for different tracking periods"},"total_scheduled":{"type":"number","format":"double","description":"Total amount of time off scheduled until the end date"},"entitlement_unit":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingResignationsReviewPtoPostRequestBodyContentApplicationJsonSchemaDataUsedTimeOffOffPlatformUsedTimeOffEntitlementUnit","description":"Unit of measurement for the time off entitlements"}},"required":["entitlements","total_scheduled","entitlement_unit"],"description":"Required when tracking_type is OFF_PLATFORM, null otherwise","title":"EorContractsContractIdOffboardingResignationsReviewPtoPostRequestBodyContentApplicationJsonSchemaDataUsedTimeOffOffPlatformUsedTimeOff"},"EorContractsContractIdOffboardingResignationsReviewPtoPostRequestBodyContentApplicationJsonSchemaDataUsedTimeOff":{"type":"object","properties":{"tracking_type":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingResignationsReviewPtoPostRequestBodyContentApplicationJsonSchemaDataUsedTimeOffTrackingType","description":"Type of time off tracking - whether it's tracked on Deel platform or off platform"},"off_platform_used_time_off":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdOffboardingResignationsReviewPtoPostRequestBodyContentApplicationJsonSchemaDataUsedTimeOffOffPlatformUsedTimeOff"},{"type":"null"}],"description":"Required when tracking_type is OFF_PLATFORM, null otherwise"}},"description":"Time-off usage data including policy information and tracking periods","title":"EorContractsContractIdOffboardingResignationsReviewPtoPostRequestBodyContentApplicationJsonSchemaDataUsedTimeOff"},"EorContractsContractIdOffboardingResignationsReviewPtoPostRequestBodyContentApplicationJsonSchemaDataDeclineReason":{"type":"string","enum":["NOT_AGREE_WITH_END_DATE","NOT_A_RESIGNATION_BUT_TERMINATION","EMPLOYEE_UNDER_REVIEW_OR_INVESTIGATION_FOR_DISCIPLINARY_ACTIONS","OTHER"],"description":"Reason for declining the resignation request","title":"EorContractsContractIdOffboardingResignationsReviewPtoPostRequestBodyContentApplicationJsonSchemaDataDeclineReason"},"EorContractsContractIdOffboardingResignationsReviewPtoPostRequestBodyContentApplicationJsonSchemaDataSeveranceType":{"type":"string","enum":["DAYS","WEEKS","MONTHS","CASH"],"description":"Type of severance offered to the employee","title":"EorContractsContractIdOffboardingResignationsReviewPtoPostRequestBodyContentApplicationJsonSchemaDataSeveranceType"},"EorContractsContractIdOffboardingResignationsReviewPtoPostRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"used_time_off":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingResignationsReviewPtoPostRequestBodyContentApplicationJsonSchemaDataUsedTimeOff","description":"Time-off usage data including policy information and tracking periods"},"decline_reason":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingResignationsReviewPtoPostRequestBodyContentApplicationJsonSchemaDataDeclineReason","description":"Reason for declining the resignation request"},"severance_type":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingResignationsReviewPtoPostRequestBodyContentApplicationJsonSchemaDataSeveranceType","description":"Type of severance offered to the employee"},"severance_amount":{"type":"number","format":"double","description":"Amount of severance offered to the employee"},"decline_reason_detail":{"type":"string","description":"Detailed explanation for declining the resignation request"},"has_client_accepted_resignation_request":{"type":"boolean","description":"Indicates whether the client has accepted the resignation request"}},"title":"EorContractsContractIdOffboardingResignationsReviewPtoPostRequestBodyContentApplicationJsonSchemaData"},"EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataDocumentsSupportingItems":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the file"},"name":{"type":"string","description":"The name of the file"},"type":{"type":"string","description":"The type/extension of the file"},"created_at":{"type":"string","format":"date-time","description":"The date and time the file was created"},"updated_at":{"type":"string","format":"date-time","description":"The date and time the file was updated"},"is_additional_supporting_document":{"type":"boolean","description":"Indicates if this is an additional supporting document added after the initial submission"}},"required":["id","name","type","created_at","updated_at","is_additional_supporting_document"],"title":"EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataDocumentsSupportingItems"},"EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsFilesItems":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the file"},"name":{"type":"string","description":"The name of the file"},"type":{"type":"string","description":"The type/extension of the file"},"created_at":{"type":"string","format":"date-time","description":"The date and time the file was created"},"updated_at":{"type":"string","format":"date-time","description":"The date and time the file was updated"}},"required":["id","name","type","created_at"],"title":"EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsFilesItems"},"EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsStatus":{"type":"string","enum":["AWAITING_REVIEW","AWAITING_FEEDBACK","FEEDBACK_PROVIDED","APPROVED","CHANGES_REQUESTED_BY_CLIENT","CHANGES_REQUESTED_BY_EMPLOYEE","WAIVED_REVIEW","NOT_RESPONDED","CANCELLED"],"description":"The current status of the document review","title":"EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsStatus"},"EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsReviewerType":{"type":"string","enum":["CLIENT","EMPLOYEE"],"description":"The type of reviewer for this document","title":"EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsReviewerType"},"EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the document set shared with the employee."},"files":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsFilesItems"}},"status":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsStatus","description":"The current status of the document review"},"created_at":{"type":"string","format":"date-time","description":"The date and time the document set was created"},"updated_at":{"type":"string","format":"date-time","description":"The date and time the document set was updated"},"reviewed_at":{"type":["string","null"],"format":"date-time","description":"The date and time when the document was reviewed"},"reviewed_by":{"type":["string","null"],"description":"The name of the reviewer for this document. If the reviewer is not an employee, it will be the name of the client"},"reviewer_type":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsReviewerType","description":"The type of reviewer for this document"},"reviewer_feedback":{"type":["string","null"],"description":"Feedback provided by the reviewer"},"notification_instructions":{"type":["string","null"],"description":"HTML instructions for the reviewer notification"},"is_employee_notification_required":{"type":"boolean","description":"Indicates if the employee should be notified about this document review"}},"required":["files","status","reviewer_type","is_employee_notification_required"],"title":"EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItems"},"EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataDocuments":{"type":"object","properties":{"supporting":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataDocumentsSupportingItems"}},"offboarding":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItems"},"description":"Document set shared that requires client or employee review"}},"required":["supporting","offboarding"],"description":"Document management structure for termination workflow including review processes and supporting documents","title":"EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataDocuments"},"EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataRequestDataReason":{"type":"string","enum":["STATUS_CHANGE","RELOCATION","COMPENSATION","RETIREMENT","JOB_ABANDONMENT","WORK_RELATED","PERSONAL","OTHER_OPPORTUNITY","NON_RENEWAL","PROBATION","ASSIGNMENT_ENDED","POSITION_ELIMINATION","FORCE_REDUCTION","DEATH","FOR_CAUSE","PERFORMANCE","MEDICAL","PERFORMANCE_ISSUES","ATTENDANCE_ISSUES","REORGANIZATION_DOWNSIZING_BUDGET_OR_REDUCTION_OF_WORKFORCE","ROLE_BECAME_REDUNDANT_OR_ROLE_CHANGED","OFFER_WAS_REVOKED","EXITING_THE_MARKET","NO_LONGER_WISH_TO_WORK_WITH_DEEL","COMPANY_ACQUIRED","STEALING","MISCONDUCT","FALSIFYING","HARASSMENT","VIOLENCE","REORGANIZATION_DOWNSIZING_BUDGET_OR_REDUCTION_OF_WORKFORCE_OR_ROLE_BECAME_REDUNDANT_OR_ROLE_CHANGED","UNAUTHORIZED_ABSENCES_OR_LACK_OF_ATTENDANCE","STANDARD_RESELLER_PRACTICE","MOVING_EMPLOYEE_TO_INTERNAL_ENTITY","MOVING_EMPLOYEE_TO_DEEL_PEO","OTHER"],"description":"The reason for the termination","title":"EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataRequestDataReason"},"EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsUnit":{"type":"string","enum":["BUSINESS_DAY","CALENDAR_DAY","HOUR"],"description":"The unit of measurement for time off tracking","title":"EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsUnit"},"EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsTrackingPeriodsItems":{"type":"object","properties":{"used":{"type":"number","format":"double","description":"The amount of time off used in this tracking period"},"end_date":{"type":"string","format":"date-time","description":"The end date of the tracking period"},"start_date":{"type":"string","format":"date-time","description":"The start date of the tracking period"}},"required":["used","end_date","start_date"],"title":"EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsTrackingPeriodsItems"},"EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItems":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsUnit","description":"The unit of measurement for time off tracking"},"policy_type":{"type":"string","description":"The type of time-off policy"},"tracking_periods":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsTrackingPeriodsItems"}},"scheduled_until_end_date":{"type":"number","format":"double","description":"The amount of time off scheduled until the end date of the current tracking period"}},"required":["unit","policy_type","tracking_periods","scheduled_until_end_date"],"title":"EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItems"},"EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffAdditionalDetails":{"type":"object","properties":{"notes":{"type":["string","null"],"description":"Additional notes or comments about the time-off data"},"updated_by":{"type":["string","null"],"description":"The person or system that last updated the time-off data"},"last_updated_at":{"type":["string","null"],"format":"date-time","description":"The date and time when the time-off data was last updated"}},"title":"EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffAdditionalDetails"},"EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOff":{"type":"object","properties":{"time_offs":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItems"}},"additional_details":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffAdditionalDetails"},{"type":"null"}]},"is_deel_pto_confirmed":{"type":"boolean","description":"Indicates whether the PTO allocation has been confirmed by Deel's system"}},"required":["time_offs","is_deel_pto_confirmed"],"description":"Time-off usage data including policy information and tracking periods","title":"EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOff"},"EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataRequestDataEligibleForRehire":{"type":"string","enum":["YES","NO","DONT_KNOW"],"description":"Parameter to inform whether it would be possible for the client to hire the employee again","title":"EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataRequestDataEligibleForRehire"},"EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataRequestData":{"type":"object","properties":{"reason":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataRequestDataReason","description":"The reason for the termination"},"end_date":{"type":["string","null"],"format":"date-time","description":"The definitive contract end date"},"reason_detail":{"type":["string","null"],"description":"Optional field to describe the reason behind the resignation request"},"used_time_off":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOff","description":"Time-off usage data including policy information and tracking periods"},"desired_end_date":{"type":["string","null"],"format":"date","description":"The desired end date. If the date is not provided, it will be selected by HRX the closest date possible"},"eligible_for_rehire":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataRequestDataEligibleForRehire"},{"type":"null"}],"description":"Parameter to inform whether it would be possible for the client to hire the employee again"},"eligible_for_rehire_reason":{"type":["string","null"],"description":"Describe if the option DONT_KNOW was selected on eligible_for_rehire"}},"title":"EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataRequestData"},"EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the offboarding request"},"end_date":{"type":["string","null"],"format":"date-time","description":"The definitive contract end date"},"documents":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataDocuments","description":"Document management structure for termination workflow including review processes and supporting documents"},"created_at":{"type":"string","format":"date-time","description":"The date and time the offboarding request was created"},"updated_at":{"type":"string","format":"date-time","description":"The date and time the offboarding request was updated"},"contract_id":{"type":"string","description":"The unique identifier of the employee contract."},"is_sensitive":{"type":"boolean","description":"Indicates if the offboarding request is sensitive. This is used to restrict access to the request only to the requester and the HRX team."},"request_data":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaDataRequestData"},{"type":"null"}]},"desired_end_date":{"type":["string","null"],"format":"date-time","description":"The desired end date. If the date is not provided, it will be selected by HRX the closest date possible"}},"title":"EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaData"},"eor-offboarding_reviewEOROffboardingPTO_Response_201":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"eor-offboarding_reviewEOROffboardingPTO_Response_201"},"EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string","description":"Error code of the handler which produced the returned error"},"field":{"type":"string","description":"The field name where error occurred (null for server errors)"},"message":{"type":"string","description":"Description of the returned error"}},"title":"EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaErrorsItems"},"SubmitEmployeeResignationPtoReviewRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"SubmitEmployeeResignationPtoReviewRequestBadRequestError"},"SubmitEmployeeResignationPtoReviewRequestUnauthorizedError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"SubmitEmployeeResignationPtoReviewRequestUnauthorizedError"},"SubmitEmployeeResignationPtoReviewRequestForbiddenError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"SubmitEmployeeResignationPtoReviewRequestForbiddenError"},"SubmitEmployeeResignationPtoReviewRequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingResignationsReviewPtoPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"SubmitEmployeeResignationPtoReviewRequestInternalServerError"},"EorContractsContractIdOffboardingReviewEmployeeSignOffsPostRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"approved":{"type":"boolean","description":"Indicates if the employee has approved the sign-off review"},"requested_changes":{"type":["string","null"],"description":"Details of requested changes if the review is not approved"},"reviewer_signature":{"type":["string","null"],"description":"Signature of the reviewer if the review is approved"}},"required":["approved","requested_changes","reviewer_signature"],"title":"EorContractsContractIdOffboardingReviewEmployeeSignOffsPostRequestBodyContentApplicationJsonSchemaData"},"EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsSupportingItems":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the file"},"name":{"type":"string","description":"The name of the file"},"type":{"type":"string","description":"The type/extension of the file"},"created_at":{"type":"string","format":"date-time","description":"The date and time the file was created"},"updated_at":{"type":"string","format":"date-time","description":"The date and time the file was updated"},"is_additional_supporting_document":{"type":"boolean","description":"Indicates if this is an additional supporting document added after the initial submission"}},"required":["id","name","type","created_at","updated_at","is_additional_supporting_document"],"title":"EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsSupportingItems"},"EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsFilesItems":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the file"},"name":{"type":"string","description":"The name of the file"},"type":{"type":"string","description":"The type/extension of the file"},"created_at":{"type":"string","format":"date-time","description":"The date and time the file was created"},"updated_at":{"type":"string","format":"date-time","description":"The date and time the file was updated"}},"required":["id","name","type","created_at"],"title":"EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsFilesItems"},"EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsStatus":{"type":"string","enum":["AWAITING_REVIEW","AWAITING_FEEDBACK","FEEDBACK_PROVIDED","APPROVED","CHANGES_REQUESTED_BY_CLIENT","CHANGES_REQUESTED_BY_EMPLOYEE","WAIVED_REVIEW","NOT_RESPONDED","CANCELLED"],"description":"The current status of the document review","title":"EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsStatus"},"EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsReviewerType":{"type":"string","enum":["CLIENT","EMPLOYEE"],"description":"The type of reviewer for this document","title":"EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsReviewerType"},"EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the document set shared with the employee."},"files":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsFilesItems"}},"status":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsStatus","description":"The current status of the document review"},"created_at":{"type":"string","format":"date-time","description":"The date and time the document set was created"},"updated_at":{"type":"string","format":"date-time","description":"The date and time the document set was updated"},"reviewed_at":{"type":["string","null"],"format":"date-time","description":"The date and time when the document was reviewed"},"reviewed_by":{"type":["string","null"],"description":"The name of the reviewer for this document. If the reviewer is not an employee, it will be the name of the client"},"reviewer_type":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsReviewerType","description":"The type of reviewer for this document"},"reviewer_feedback":{"type":["string","null"],"description":"Feedback provided by the reviewer"},"notification_instructions":{"type":["string","null"],"description":"HTML instructions for the reviewer notification"},"is_employee_notification_required":{"type":"boolean","description":"Indicates if the employee should be notified about this document review"}},"required":["files","status","reviewer_type","is_employee_notification_required"],"title":"EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItems"},"EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsResignationLetter":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the resignation letter"},"signature":{"type":["string","null"],"description":"The signature of the resignation letter"},"signed_at":{"type":["string","null"],"format":"date-time","description":"The date and time when the resignation letter was signed"},"created_at":{"type":"string","format":"date-time","description":"The date and time the resignation letter was created"},"updated_at":{"type":"string","format":"date-time","description":"The date and time the resignation letter was updated"}},"title":"EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsResignationLetter"},"EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataDocuments":{"type":"object","properties":{"supporting":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsSupportingItems"}},"offboarding":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItems"},"description":"Document set shared that requires client or employee review"},"resignation_letter":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataDocumentsResignationLetter"},{"type":"null"}]}},"required":["supporting","offboarding"],"description":"Document management structure for termination workflow including review processes and supporting documents","title":"EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataDocuments"},"EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataReason":{"type":"string","enum":["STATUS_CHANGE","RELOCATION","COMPENSATION","RETIREMENT","JOB_ABANDONMENT","WORK_RELATED","PERSONAL","OTHER_OPPORTUNITY","NON_RENEWAL","PROBATION","ASSIGNMENT_ENDED","POSITION_ELIMINATION","FORCE_REDUCTION","DEATH","FOR_CAUSE","PERFORMANCE","MEDICAL","PERFORMANCE_ISSUES","ATTENDANCE_ISSUES","REORGANIZATION_DOWNSIZING_BUDGET_OR_REDUCTION_OF_WORKFORCE","ROLE_BECAME_REDUNDANT_OR_ROLE_CHANGED","OFFER_WAS_REVOKED","EXITING_THE_MARKET","NO_LONGER_WISH_TO_WORK_WITH_DEEL","COMPANY_ACQUIRED","STEALING","MISCONDUCT","FALSIFYING","HARASSMENT","VIOLENCE","REORGANIZATION_DOWNSIZING_BUDGET_OR_REDUCTION_OF_WORKFORCE_OR_ROLE_BECAME_REDUNDANT_OR_ROLE_CHANGED","UNAUTHORIZED_ABSENCES_OR_LACK_OF_ATTENDANCE","STANDARD_RESELLER_PRACTICE","MOVING_EMPLOYEE_TO_INTERNAL_ENTITY","MOVING_EMPLOYEE_TO_DEEL_PEO","OTHER"],"description":"The reason for the termination","title":"EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataReason"},"EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsUnit":{"type":"string","enum":["BUSINESS_DAY","CALENDAR_DAY","HOUR"],"description":"The unit of measurement for time off tracking","title":"EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsUnit"},"EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsTrackingPeriodsItems":{"type":"object","properties":{"used":{"type":"number","format":"double","description":"The amount of time off used in this tracking period"},"end_date":{"type":"string","format":"date-time","description":"The end date of the tracking period"},"start_date":{"type":"string","format":"date-time","description":"The start date of the tracking period"}},"required":["used","end_date","start_date"],"title":"EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsTrackingPeriodsItems"},"EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItems":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsUnit","description":"The unit of measurement for time off tracking"},"policy_type":{"type":"string","description":"The type of time-off policy"},"tracking_periods":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsTrackingPeriodsItems"}},"scheduled_until_end_date":{"type":"number","format":"double","description":"The amount of time off scheduled until the end date of the current tracking period"}},"required":["unit","policy_type","tracking_periods","scheduled_until_end_date"],"title":"EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItems"},"EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffAdditionalDetails":{"type":"object","properties":{"notes":{"type":["string","null"],"description":"Additional notes or comments about the time-off data"},"updated_by":{"type":["string","null"],"description":"The person or system that last updated the time-off data"},"last_updated_at":{"type":["string","null"],"format":"date-time","description":"The date and time when the time-off data was last updated"}},"title":"EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffAdditionalDetails"},"EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOff":{"type":"object","properties":{"time_offs":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItems"}},"additional_details":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffAdditionalDetails"},{"type":"null"}]},"is_deel_pto_confirmed":{"type":"boolean","description":"Indicates whether the PTO allocation has been confirmed by Deel's system"}},"required":["time_offs","is_deel_pto_confirmed"],"description":"Time-off usage data including policy information and tracking periods","title":"EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOff"},"EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataEligibleForRehire":{"type":"string","enum":["YES","NO","DONT_KNOW"],"description":"Parameter to inform whether it would be possible for the client to hire the employee again","title":"EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataEligibleForRehire"},"EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataRequestData":{"type":"object","properties":{"reason":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataReason","description":"The reason for the termination"},"end_date":{"type":["string","null"],"format":"date-time","description":"The definitive contract end date"},"reason_detail":{"type":["string","null"],"description":"Optional field to describe the reason behind the resignation request"},"used_time_off":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOff","description":"Time-off usage data including policy information and tracking periods"},"desired_end_date":{"type":["string","null"],"format":"date","description":"The desired end date. If the date is not provided, it will be selected by HRX the closest date possible"},"eligible_for_rehire":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataRequestDataEligibleForRehire"},{"type":"null"}],"description":"Parameter to inform whether it would be possible for the client to hire the employee again"},"eligible_for_rehire_reason":{"type":["string","null"],"description":"Describe if the option DONT_KNOW was selected on eligible_for_rehire"}},"title":"EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataRequestData"},"EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the offboarding request"},"end_date":{"type":["string","null"],"format":"date-time","description":"The definitive contract end date"},"documents":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataDocuments","description":"Document management structure for termination workflow including review processes and supporting documents"},"created_at":{"type":"string","format":"date-time","description":"The date and time the offboarding request was created"},"updated_at":{"type":"string","format":"date-time","description":"The date and time the offboarding request was updated"},"contract_id":{"type":"string","description":"The unique identifier of the employee contract."},"is_sensitive":{"type":"boolean","description":"Indicates if the offboarding request is sensitive. This is used to restrict access to the request only to the requester and the HRX team."},"request_data":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaDataRequestData"},{"type":"null"}]},"desired_end_date":{"type":["string","null"],"format":"date-time","description":"The desired end date. If the date is not provided, it will be selected by HRX the closest date possible"}},"title":"EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaData"},"eor-offboarding_reviewEOROffboardingEmployeeSignOffs_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"eor-offboarding_reviewEOROffboardingEmployeeSignOffs_Response_200"},"EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string","description":"Error code of the handler which produced the returned error"},"field":{"type":"string","description":"The field name where error occurred (null for server errors)"},"message":{"type":"string","description":"Description of the returned error"}},"title":"EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaErrorsItems"},"SubmitEmployeeSignOffReviewForOffboardingDocumentsRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"SubmitEmployeeSignOffReviewForOffboardingDocumentsRequestBadRequestError"},"SubmitEmployeeSignOffReviewForOffboardingDocumentsRequestUnauthorizedError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"SubmitEmployeeSignOffReviewForOffboardingDocumentsRequestUnauthorizedError"},"SubmitEmployeeSignOffReviewForOffboardingDocumentsRequestForbiddenError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"SubmitEmployeeSignOffReviewForOffboardingDocumentsRequestForbiddenError"},"SubmitEmployeeSignOffReviewForOffboardingDocumentsRequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingReviewEmployeeSignOffsPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"SubmitEmployeeSignOffReviewForOffboardingDocumentsRequestInternalServerError"},"EorWorkersWorkerIdPayslipsGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the payslip record."},"to":{"type":["string","null"],"format":"date","description":"End date of the payment period."},"from":{"type":"string","format":"date","description":"Start date of the payment period."},"status":{"type":"string","description":"Status of the payslip (e.g., 'Pending', 'Processed')."}},"required":["id","to","from","status"],"title":"EorWorkersWorkerIdPayslipsGetResponsesContentApplicationJsonSchemaDataItems"},"eor-payslips_getWorkerPayslips_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersWorkerIdPayslipsGetResponsesContentApplicationJsonSchemaDataItems"}}},"required":["data"],"title":"eor-payslips_getWorkerPayslips_Response_200"},"EorContractsContractIdProjectAssignmentAcceptPostRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"version":{"type":"string","description":"This field is to ensure that the latest version of the project assignment PDF matches the version received from the webhook. If it is not sent, the version validation is not performed and the endpoint returns the PDF. If it is sent, it is checked whether the current version is equal to the version sent; if not, a 409 error occurs, otherwise, the PDF is returned."}},"title":"EorContractsContractIdProjectAssignmentAcceptPostRequestBodyContentApplicationJsonSchemaData"},"eor-project-assignment_acceptProjectAssignment_Response_204":{"type":"object","properties":{},"description":"Empty response body","title":"eor-project-assignment_acceptProjectAssignment_Response_204"},"EorContractsContractIdProjectAssignmentAcceptPostResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code"},"message":{"type":"string","description":"Human-readable explanation of the error"}},"required":["code","message"],"title":"EorContractsContractIdProjectAssignmentAcceptPostResponsesContentApplicationJsonSchemaErrorsItems"},"AcceptEorProjectAssignmentAsClientRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdProjectAssignmentAcceptPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"AcceptEorProjectAssignmentAsClientRequestBadRequestError"},"AcceptEorProjectAssignmentAsClientRequestConflictError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdProjectAssignmentAcceptPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"AcceptEorProjectAssignmentAsClientRequestConflictError"},"AcceptEorProjectAssignmentAsClientRequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdProjectAssignmentAcceptPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"AcceptEorProjectAssignmentAsClientRequestInternalServerError"},"EorContractsContractIdProjectAssignmentGetResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code"},"message":{"type":"string","description":"Human-readable explanation of the error"}},"required":["code","message"],"title":"EorContractsContractIdProjectAssignmentGetResponsesContentApplicationJsonSchemaErrorsItems"},"FetchEorProjectAssignmentPdfRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdProjectAssignmentGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"FetchEorProjectAssignmentPdfRequestBadRequestError"},"FetchEorProjectAssignmentPdfRequestConflictError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdProjectAssignmentGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"FetchEorProjectAssignmentPdfRequestConflictError"},"FetchEorProjectAssignmentPdfRequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdProjectAssignmentGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"FetchEorProjectAssignmentPdfRequestInternalServerError"},"EorContractsContractIdProjectAssignmentCheckinGetResponsesContentApplicationJsonSchemaDataSectionsItemsQuestionsItemsType":{"type":"string","enum":["FreeText","Paragraph","SingleSelection","MultiSelection","Address","PhoneNumber","DocumentUpload","Number","Dropdown","DatePicker","Email"],"description":"Type of the question.","title":"EorContractsContractIdProjectAssignmentCheckinGetResponsesContentApplicationJsonSchemaDataSectionsItemsQuestionsItemsType"},"EorContractsContractIdProjectAssignmentCheckinGetResponsesContentApplicationJsonSchemaDataSectionsItemsQuestionsItemsOptionsItems":{"type":"object","properties":{"title":{"type":"string","description":"Display text for the option."},"value":{"type":["string","null"],"description":"Value associated with the option."}},"title":"EorContractsContractIdProjectAssignmentCheckinGetResponsesContentApplicationJsonSchemaDataSectionsItemsQuestionsItemsOptionsItems"},"EorContractsContractIdProjectAssignmentCheckinGetResponsesContentApplicationJsonSchemaDataSectionsItemsQuestionsItemsDefaultValue":{"oneOf":[{"type":"string"},{"type":"number","format":"double"},{"type":"boolean"}],"description":"Default value to pre-fill in the form.","title":"EorContractsContractIdProjectAssignmentCheckinGetResponsesContentApplicationJsonSchemaDataSectionsItemsQuestionsItemsDefaultValue"},"EorContractsContractIdProjectAssignmentCheckinGetResponsesContentApplicationJsonSchemaDataSectionsItemsQuestionsItems":{"type":"object","properties":{"key":{"type":"string","description":"Unique key identifier for the question."},"type":{"$ref":"#/components/schemas/EorContractsContractIdProjectAssignmentCheckinGetResponsesContentApplicationJsonSchemaDataSectionsItemsQuestionsItemsType","description":"Type of the question."},"title":{"type":"string","description":"Title of the question."},"options":{"type":["array","null"],"items":{"$ref":"#/components/schemas/EorContractsContractIdProjectAssignmentCheckinGetResponsesContentApplicationJsonSchemaDataSectionsItemsQuestionsItemsOptionsItems"},"description":"List of selectable options for selection-type questions. Value may be of any type."},"is_required":{"type":"boolean","description":"Indicates if the question is required."},"default_value":{"$ref":"#/components/schemas/EorContractsContractIdProjectAssignmentCheckinGetResponsesContentApplicationJsonSchemaDataSectionsItemsQuestionsItemsDefaultValue","description":"Default value to pre-fill in the form."},"is_only_digits":{"type":"boolean","description":"Restricts input to numeric characters only, for FreeText questions."}},"required":["key","type","title"],"title":"EorContractsContractIdProjectAssignmentCheckinGetResponsesContentApplicationJsonSchemaDataSectionsItemsQuestionsItems"},"EorContractsContractIdProjectAssignmentCheckinGetResponsesContentApplicationJsonSchemaDataSectionsItems":{"type":"object","properties":{"title":{"type":"string","description":"Title of the section."},"subtitle":{"type":"string","description":"Additional information shown at the top of the section."},"questions":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdProjectAssignmentCheckinGetResponsesContentApplicationJsonSchemaDataSectionsItemsQuestionsItems"},"description":"List of questions within the section."}},"required":["title","questions"],"title":"EorContractsContractIdProjectAssignmentCheckinGetResponsesContentApplicationJsonSchemaDataSectionsItems"},"EorContractsContractIdProjectAssignmentCheckinGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the resource"},"sections":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdProjectAssignmentCheckinGetResponsesContentApplicationJsonSchemaDataSectionsItems"},"description":"Sections of questions"},"created_at":{"type":"string","format":"date-time","description":"Timestamp indicating when the resource was created (ISO 8601)."},"updated_at":{"type":"string","format":"date-time","description":"Timestamp indicating when the resource was last updated (ISO 8601)."}},"required":["id","sections","created_at","updated_at"],"title":"EorContractsContractIdProjectAssignmentCheckinGetResponsesContentApplicationJsonSchemaData"},"eor-project-assignment_getProjectAssignmentCheckin_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorContractsContractIdProjectAssignmentCheckinGetResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"eor-project-assignment_getProjectAssignmentCheckin_Response_200"},"EorContractsContractIdProjectAssignmentCheckinGetResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code"},"message":{"type":"string","description":"Human-readable explanation of the error"}},"title":"EorContractsContractIdProjectAssignmentCheckinGetResponsesContentApplicationJsonSchemaErrorsItems"},"FetchProjectAssignmentCheckinQuestionnaireDataRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdProjectAssignmentCheckinGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"FetchProjectAssignmentCheckinQuestionnaireDataRequestBadRequestError"},"FetchProjectAssignmentCheckinQuestionnaireDataRequestConflictError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdProjectAssignmentCheckinGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"FetchProjectAssignmentCheckinQuestionnaireDataRequestConflictError"},"FetchProjectAssignmentCheckinQuestionnaireDataRequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdProjectAssignmentCheckinGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"FetchProjectAssignmentCheckinQuestionnaireDataRequestInternalServerError"},"EorContractsContractIdProjectAssignmentCheckinPostRequestBodyContentApplicationJsonSchemaDataType":{"type":"string","enum":["EMPLOYEE","CLIENT"],"description":"Indicates who is submitting the form. Can be either 'EMPLOYEE' or 'CLIENT'.","title":"EorContractsContractIdProjectAssignmentCheckinPostRequestBodyContentApplicationJsonSchemaDataType"},"EorContractsContractIdProjectAssignmentCheckinPostRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/EorContractsContractIdProjectAssignmentCheckinPostRequestBodyContentApplicationJsonSchemaDataType","description":"Indicates who is submitting the form. Can be either 'EMPLOYEE' or 'CLIENT'."},"version":{"type":"string","description":"Optional version identifier of the form or schema."},"questions_with_answers":{"type":"object","additionalProperties":{"type":"string"},"description":"Map of question IDs to their corresponding answers."}},"required":["type","questions_with_answers"],"description":"Form submission payload containing respondent type, question answers, and optional version.","title":"EorContractsContractIdProjectAssignmentCheckinPostRequestBodyContentApplicationJsonSchemaData"},"eor-project-assignment_checkinProjectAssignment_Response_204":{"type":"object","properties":{},"description":"Empty response body","title":"eor-project-assignment_checkinProjectAssignment_Response_204"},"EorContractsContractIdProjectAssignmentCheckinPostResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code"},"message":{"type":"string","description":"Human-readable explanation of the error"}},"title":"EorContractsContractIdProjectAssignmentCheckinPostResponsesContentApplicationJsonSchemaErrorsItems"},"SubmitProjectAssignmentCheckinQuestionnaireDataRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdProjectAssignmentCheckinPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"SubmitProjectAssignmentCheckinQuestionnaireDataRequestBadRequestError"},"SubmitProjectAssignmentCheckinQuestionnaireDataRequestConflictError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdProjectAssignmentCheckinPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"SubmitProjectAssignmentCheckinQuestionnaireDataRequestConflictError"},"SubmitProjectAssignmentCheckinQuestionnaireDataRequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdProjectAssignmentCheckinPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"SubmitProjectAssignmentCheckinQuestionnaireDataRequestInternalServerError"},"EorOidTerminationsTerminationIdGetResponsesContentApplicationJsonSchemaRequestDataTerminationImpact":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"title":{"type":"string","description":"Termination impact title"},"description":{"type":"string","description":"Termination impact description"}},"description":"Custom termination impact data if there is some configured on HR module","title":"EorOidTerminationsTerminationIdGetResponsesContentApplicationJsonSchemaRequestDataTerminationImpact"},"EorOidTerminationsTerminationIdGetResponsesContentApplicationJsonSchemaRequestDataEligibleForRehire":{"type":"string","enum":["YES","NO","DONT_KNOW"],"description":"Parameter to inform whether it would be possible for the client to hire the employee again","title":"EorOidTerminationsTerminationIdGetResponsesContentApplicationJsonSchemaRequestDataEligibleForRehire"},"EorOidTerminationsTerminationIdGetResponsesContentApplicationJsonSchemaRequestData":{"type":"object","properties":{"reason":{"type":["string","null"]},"end_date":{"type":["string","null"],"format":"date-time","description":"The definitive contract end date"},"reason_detail":{"type":["string","null"],"description":"Optional field to describe the reason behind the resignation request"},"desired_end_date":{"type":["string","null"],"format":"date-time","description":"The desired end date. If the date is not provided, it will be selected by HRX the closest date possible"},"termination_impact":{"oneOf":[{"$ref":"#/components/schemas/EorOidTerminationsTerminationIdGetResponsesContentApplicationJsonSchemaRequestDataTerminationImpact"},{"type":"null"}],"description":"Custom termination impact data if there is some configured on HR module"},"eligible_for_rehire":{"oneOf":[{"$ref":"#/components/schemas/EorOidTerminationsTerminationIdGetResponsesContentApplicationJsonSchemaRequestDataEligibleForRehire"},{"type":"null"}],"description":"Parameter to inform whether it would be possible for the client to hire the employee again"},"eligible_for_rehire_reason":{"type":["string","null"],"description":"Describe if the option DONT_KNOW was selected on eligibleForRehire"},"custom_termination_reason_id":{"type":["number","null"],"format":"double","description":"Custom termination reason ID. A custom termination reason can be added on Client HR module"}},"title":"EorOidTerminationsTerminationIdGetResponsesContentApplicationJsonSchemaRequestData"},"eor-terminations_getTermination_Response_200":{"type":"object","properties":{"id":{"type":"number","format":"double"},"end_date":{"type":["string","null"],"format":"date-time","description":"The definitive contract end date"},"contract_id":{"type":"string","description":"Public contract oid"},"request_data":{"oneOf":[{"$ref":"#/components/schemas/EorOidTerminationsTerminationIdGetResponsesContentApplicationJsonSchemaRequestData"},{"type":"null"}]},"desired_end_date":{"type":["string","null"],"format":"date-time","description":"The desired end date. If the date is not provided, it will be selected by HRX the closest date possible"}},"title":"eor-terminations_getTermination_Response_200"},"EorOidTerminationsTerminationIdGetResponsesContentApplicationJsonSchemaItems":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"title":"EorOidTerminationsTerminationIdGetResponsesContentApplicationJsonSchemaItems"},"EorContractsContractIdOffboardingTerminationPostRequestBodyContentMultipartFormDataSchemaDataReason":{"type":"string","enum":["DEEL_COLLECTIONS","STATUS_CHANGE","RELOCATION","COMPENSATION","RETIREMENT","JOB_ABANDONMENT","WORK_RELATED","PERSONAL","OTHER_OPPORTUNITY","NON_RENEWAL","PROBATION","ASSIGNMENT_ENDED","POSITION_ELIMINATION","FORCE_REDUCTION","DEATH","FOR_CAUSE","PERFORMANCE","MEDICAL","PERFORMANCE_ISSUES","ATTENDANCE_ISSUES","REORGANIZATION_DOWNSIZING_BUDGET_OR_REDUCTION_OF_WORKFORCE","ROLE_BECAME_REDUNDANT_OR_ROLE_CHANGED","OFFER_WAS_REVOKED","EXITING_THE_MARKET","NO_LONGER_WISH_TO_WORK_WITH_DEEL","COMPANY_ACQUIRED","STEALING","MISCONDUCT","FALSIFYING","HARASSMENT","VIOLENCE","REORGANIZATION_DOWNSIZING_BUDGET_OR_REDUCTION_OF_WORKFORCE_OR_ROLE_BECAME_REDUNDANT_OR_ROLE_CHANGED","UNAUTHORIZED_ABSENCES_OR_LACK_OF_ATTENDANCE","STANDARD_RESELLER_PRACTICE","MOVING_EMPLOYEE_TO_INTERNAL_ENTITY","MOVING_EMPLOYEE_TO_DEEL_PEO","OTHER"],"description":"Reason why the contract is being terminated","title":"EorContractsContractIdOffboardingTerminationPostRequestBodyContentMultipartFormDataSchemaDataReason"},"EorContractsContractIdOffboardingTerminationPostRequestBodyContentMultipartFormDataSchemaDataUsedTimeOffTrackingType":{"type":"string","enum":["ON_PLATFORM","OFF_PLATFORM"],"description":"Type of time off tracking - whether it's tracked on Deel platform or off platform","title":"EorContractsContractIdOffboardingTerminationPostRequestBodyContentMultipartFormDataSchemaDataUsedTimeOffTrackingType"},"EorContractsContractIdOffboardingTerminationPostRequestBodyContentMultipartFormDataSchemaDataUsedTimeOffOffPlatformUsedTimeOffEntitlementsItems":{"type":"object","properties":{"used":{"type":"number","format":"double","description":"Amount of time off used in the period"},"tracking_period":{"type":"string","format":"date","description":"Start date of the tracking period"},"tracking_period_end_date":{"type":"string","format":"date","description":"End date of the tracking period"}},"required":["used","tracking_period","tracking_period_end_date"],"title":"EorContractsContractIdOffboardingTerminationPostRequestBodyContentMultipartFormDataSchemaDataUsedTimeOffOffPlatformUsedTimeOffEntitlementsItems"},"EorContractsContractIdOffboardingTerminationPostRequestBodyContentMultipartFormDataSchemaDataUsedTimeOffOffPlatformUsedTimeOffEntitlementUnit":{"type":"string","enum":["BUSINESS_DAY","CALENDAR_DAY","HOUR","WEEK","MONTH","YEAR"],"description":"Unit of measurement for the time off entitlements","title":"EorContractsContractIdOffboardingTerminationPostRequestBodyContentMultipartFormDataSchemaDataUsedTimeOffOffPlatformUsedTimeOffEntitlementUnit"},"EorContractsContractIdOffboardingTerminationPostRequestBodyContentMultipartFormDataSchemaDataUsedTimeOffOffPlatformUsedTimeOff":{"type":"object","properties":{"entitlements":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingTerminationPostRequestBodyContentMultipartFormDataSchemaDataUsedTimeOffOffPlatformUsedTimeOffEntitlementsItems"},"description":"Array of time off entitlements for different tracking periods"},"total_scheduled":{"type":"number","format":"double","description":"Total amount of time off scheduled until the end date"},"entitlement_unit":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingTerminationPostRequestBodyContentMultipartFormDataSchemaDataUsedTimeOffOffPlatformUsedTimeOffEntitlementUnit","description":"Unit of measurement for the time off entitlements"}},"required":["entitlements","total_scheduled","entitlement_unit"],"description":"Required when tracking_type is OFF_PLATFORM, null otherwise","title":"EorContractsContractIdOffboardingTerminationPostRequestBodyContentMultipartFormDataSchemaDataUsedTimeOffOffPlatformUsedTimeOff"},"EorContractsContractIdOffboardingTerminationPostRequestBodyContentMultipartFormDataSchemaDataUsedTimeOff":{"type":"object","properties":{"tracking_type":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingTerminationPostRequestBodyContentMultipartFormDataSchemaDataUsedTimeOffTrackingType","description":"Type of time off tracking - whether it's tracked on Deel platform or off platform"},"off_platform_used_time_off":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdOffboardingTerminationPostRequestBodyContentMultipartFormDataSchemaDataUsedTimeOffOffPlatformUsedTimeOff"},{"type":"null"}],"description":"Required when tracking_type is OFF_PLATFORM, null otherwise"}},"title":"EorContractsContractIdOffboardingTerminationPostRequestBodyContentMultipartFormDataSchemaDataUsedTimeOff"},"EorContractsContractIdOffboardingTerminationPostRequestBodyContentMultipartFormDataSchemaDataSeveranceType":{"type":"string","enum":["DAYS","WEEKS","MONTHS","CASH"],"description":"The type of severance selected by the client. It's an optional field","title":"EorContractsContractIdOffboardingTerminationPostRequestBodyContentMultipartFormDataSchemaDataSeveranceType"},"EorContractsContractIdOffboardingTerminationPostRequestBodyContentMultipartFormDataSchemaDataAdditionalReason":{"type":"string","enum":["DISSATISFIED_WITH_DEEL_SERVICE","DISSATISFIED_WITH_DEEL_PRICING","DISSATISFIED_WITH_DEEL_PRODUCT"],"description":"An additional reason can be provided in case the reason selected is NO_LONGER_WISH_TO_WORK_WITH_DEEL","title":"EorContractsContractIdOffboardingTerminationPostRequestBodyContentMultipartFormDataSchemaDataAdditionalReason"},"EorContractsContractIdOffboardingTerminationPostRequestBodyContentMultipartFormDataSchemaDataEligibleForRehire":{"type":"string","enum":["YES","NO","DONT_KNOW"],"description":"Parameter to inform whether it would be possible for the client to hire the employee again","title":"EorContractsContractIdOffboardingTerminationPostRequestBodyContentMultipartFormDataSchemaDataEligibleForRehire"},"EorContractsContractIdOffboardingTerminationPostRequestBodyContentMultipartFormDataSchemaDataRequiredInformationItems":{"type":"object","properties":{"answer":{"type":["boolean","null"],"description":"The answer to the question"},"question":{"type":"string","description":"The question to be answered"}},"required":["answer","question"],"title":"EorContractsContractIdOffboardingTerminationPostRequestBodyContentMultipartFormDataSchemaDataRequiredInformationItems"},"EorContractsContractIdOffboardingTerminationPostRequestBodyContentMultipartFormDataSchemaData":{"type":"object","properties":{"reason":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingTerminationPostRequestBodyContentMultipartFormDataSchemaDataReason","description":"Reason why the contract is being terminated"},"attachments":{"type":"string","format":"binary","description":"This field allows for uploading multiple files at once. Attach any document that is important for the request to terminate the contract. Includes common image formats (JPG, JPEG, PNG, HEIC) and PDF documents."},"is_sensitive":{"type":"boolean","description":"Defines whether the termination is sensitive. In this case, only the person requesting the termination will be able to view the termination, receive emails or notifications."},"reason_detail":{"type":"string","description":"Field to better explain how communication with the employee will be and/or their reaction to the communication, or other necessary information"},"used_time_off":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingTerminationPostRequestBodyContentMultipartFormDataSchemaDataUsedTimeOff"},"severance_type":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingTerminationPostRequestBodyContentMultipartFormDataSchemaDataSeveranceType","description":"The type of severance selected by the client. It's an optional field"},"desired_end_date":{"type":"string","format":"date","description":"The desired end date of the contract. If the date is not provided, Deel HRX team will select the nearest possible date."},"severance_amount":{"type":"integer","description":"The amount of severance needed"},"additional_reason":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdOffboardingTerminationPostRequestBodyContentMultipartFormDataSchemaDataAdditionalReason"},{"type":"null"}],"description":"An additional reason can be provided in case the reason selected is NO_LONGER_WISH_TO_WORK_WITH_DEEL"},"termination_notes":{"type":"array","items":{"type":"string"},"description":"Additional notes can be provided regarding the termination for Deel, like questions and doubts"},"eligible_for_rehire":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdOffboardingTerminationPostRequestBodyContentMultipartFormDataSchemaDataEligibleForRehire"},{"type":"null"}],"description":"Parameter to inform whether it would be possible for the client to hire the employee again"},"is_employee_notified":{"type":"boolean","description":"Defines if employee was informed by client or not before the termination"},"required_information":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingTerminationPostRequestBodyContentMultipartFormDataSchemaDataRequiredInformationItems"},"description":"For some countries some data is needed to help to process the termination. The questions comes from another endpoint to get the required information. See GET /eor/:oid/offboarding/required-information to get the questions."},"termination_impact_id":{"type":"string","format":"uuid","description":"Termination impact data if there is some configured on HR module"},"employee_notification_detail":{"type":["string","null"],"description":"If it's an termination contract ending and employee was already informed, should detail the notification to the employee"},"additional_supporting_documents":{"type":"string","format":"binary","description":"This field allows for uploading multiple files at once. Any proof such as correspondence, documentation of previous warnings or attendance records for the reason select above. Includes common image formats (JPG, JPEG, PNG, HEIC) and PDF documents."}},"required":["reason","reason_detail","used_time_off","is_employee_notified"],"title":"EorContractsContractIdOffboardingTerminationPostRequestBodyContentMultipartFormDataSchemaData"},"EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataDocumentsSupportingItems":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the file"},"name":{"type":"string","description":"The name of the file"},"type":{"type":"string","description":"The type/extension of the file"},"created_at":{"type":"string","format":"date-time","description":"The date and time the file was created"},"updated_at":{"type":"string","format":"date-time","description":"The date and time the file was updated"},"is_additional_supporting_document":{"type":"boolean","description":"Indicates if this is an additional supporting document added after the initial submission"}},"required":["id","name","type","created_at","updated_at","is_additional_supporting_document"],"title":"EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataDocumentsSupportingItems"},"EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsFilesItems":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the file"},"name":{"type":"string","description":"The name of the file"},"type":{"type":"string","description":"The type/extension of the file"},"created_at":{"type":"string","format":"date-time","description":"The date and time the file was created"},"updated_at":{"type":"string","format":"date-time","description":"The date and time the file was updated"}},"required":["id","name","type","created_at"],"title":"EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsFilesItems"},"EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsStatus":{"type":"string","enum":["AWAITING_REVIEW","AWAITING_FEEDBACK","FEEDBACK_PROVIDED","APPROVED","CHANGES_REQUESTED_BY_CLIENT","CHANGES_REQUESTED_BY_EMPLOYEE","WAIVED_REVIEW","NOT_RESPONDED","CANCELLED"],"description":"The current status of the document review","title":"EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsStatus"},"EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsReviewerType":{"type":"string","enum":["CLIENT","EMPLOYEE"],"description":"The type of reviewer for this document","title":"EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsReviewerType"},"EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the document set shared with the employee."},"files":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsFilesItems"}},"status":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsStatus","description":"The current status of the document review"},"created_at":{"type":"string","format":"date-time","description":"The date and time the document set was created"},"updated_at":{"type":"string","format":"date-time","description":"The date and time the document set was updated"},"reviewed_at":{"type":["string","null"],"format":"date-time","description":"The date and time when the document was reviewed"},"reviewed_by":{"type":["string","null"],"description":"The name of the reviewer for this document. If the reviewer is not an employee, it will be the name of the client"},"reviewer_type":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsReviewerType","description":"The type of reviewer for this document"},"reviewer_feedback":{"type":["string","null"],"description":"Feedback provided by the reviewer"},"notification_instructions":{"type":["string","null"],"description":"HTML instructions for the reviewer notification"},"is_employee_notification_required":{"type":"boolean","description":"Indicates if the employee should be notified about this document review"}},"required":["files","status","reviewer_type","is_employee_notification_required"],"title":"EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItems"},"EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataDocuments":{"type":"object","properties":{"supporting":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataDocumentsSupportingItems"}},"offboarding":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItems"},"description":"Document set shared that requires client or employee review"}},"required":["supporting","offboarding"],"description":"Document management structure for termination workflow including review processes and supporting documents","title":"EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataDocuments"},"EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataRequestDataReason":{"type":"string","enum":["STATUS_CHANGE","RELOCATION","COMPENSATION","RETIREMENT","JOB_ABANDONMENT","WORK_RELATED","PERSONAL","OTHER_OPPORTUNITY","NON_RENEWAL","PROBATION","ASSIGNMENT_ENDED","POSITION_ELIMINATION","FORCE_REDUCTION","DEATH","FOR_CAUSE","PERFORMANCE","MEDICAL","PERFORMANCE_ISSUES","ATTENDANCE_ISSUES","REORGANIZATION_DOWNSIZING_BUDGET_OR_REDUCTION_OF_WORKFORCE","ROLE_BECAME_REDUNDANT_OR_ROLE_CHANGED","OFFER_WAS_REVOKED","EXITING_THE_MARKET","NO_LONGER_WISH_TO_WORK_WITH_DEEL","COMPANY_ACQUIRED","STEALING","MISCONDUCT","FALSIFYING","HARASSMENT","VIOLENCE","REORGANIZATION_DOWNSIZING_BUDGET_OR_REDUCTION_OF_WORKFORCE_OR_ROLE_BECAME_REDUNDANT_OR_ROLE_CHANGED","UNAUTHORIZED_ABSENCES_OR_LACK_OF_ATTENDANCE","STANDARD_RESELLER_PRACTICE","MOVING_EMPLOYEE_TO_INTERNAL_ENTITY","MOVING_EMPLOYEE_TO_DEEL_PEO","OTHER"],"description":"The reason for the termination","title":"EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataRequestDataReason"},"EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsUnit":{"type":"string","enum":["BUSINESS_DAY","CALENDAR_DAY","HOUR"],"description":"The unit of measurement for time off tracking","title":"EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsUnit"},"EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsTrackingPeriodsItems":{"type":"object","properties":{"used":{"type":"number","format":"double","description":"The amount of time off used in this tracking period"},"end_date":{"type":"string","format":"date-time","description":"The end date of the tracking period"},"start_date":{"type":"string","format":"date-time","description":"The start date of the tracking period"}},"required":["used","end_date","start_date"],"title":"EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsTrackingPeriodsItems"},"EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItems":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsUnit","description":"The unit of measurement for time off tracking"},"policy_type":{"type":"string","description":"The type of time-off policy"},"tracking_periods":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsTrackingPeriodsItems"}},"scheduled_until_end_date":{"type":"number","format":"double","description":"The amount of time off scheduled until the end date of the current tracking period"}},"required":["unit","policy_type","tracking_periods","scheduled_until_end_date"],"title":"EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItems"},"EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffAdditionalDetails":{"type":"object","properties":{"notes":{"type":["string","null"],"description":"Additional notes or comments about the time-off data"},"updated_by":{"type":["string","null"],"description":"The person or system that last updated the time-off data"},"last_updated_at":{"type":["string","null"],"format":"date-time","description":"The date and time when the time-off data was last updated"}},"title":"EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffAdditionalDetails"},"EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOff":{"type":"object","properties":{"time_offs":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItems"}},"additional_details":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffAdditionalDetails"},{"type":"null"}]},"is_deel_pto_confirmed":{"type":"boolean","description":"Indicates whether the PTO allocation has been confirmed by Deel's system"}},"required":["time_offs","is_deel_pto_confirmed"],"description":"Time-off usage data including policy information and tracking periods","title":"EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOff"},"EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataRequestDataEligibleForRehire":{"type":"string","enum":["YES","NO","DONT_KNOW"],"description":"Parameter to inform whether it would be possible for the client to hire the employee again","title":"EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataRequestDataEligibleForRehire"},"EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataRequestData":{"type":"object","properties":{"reason":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataRequestDataReason","description":"The reason for the termination"},"end_date":{"type":["string","null"],"format":"date-time","description":"The definitive contract end date"},"reason_detail":{"type":["string","null"],"description":"Optional field to describe the reason behind the resignation request"},"used_time_off":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOff","description":"Time-off usage data including policy information and tracking periods"},"desired_end_date":{"type":["string","null"],"format":"date","description":"The desired end date. If the date is not provided, it will be selected by HRX the closest date possible"},"eligible_for_rehire":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataRequestDataEligibleForRehire"},{"type":"null"}],"description":"Parameter to inform whether it would be possible for the client to hire the employee again"},"eligible_for_rehire_reason":{"type":["string","null"],"description":"Describe if the option DONT_KNOW was selected on eligible_for_rehire"}},"title":"EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataRequestData"},"EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the offboarding request"},"end_date":{"type":["string","null"],"format":"date-time","description":"The definitive contract end date"},"documents":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataDocuments","description":"Document management structure for termination workflow including review processes and supporting documents"},"created_at":{"type":"string","format":"date-time","description":"The date and time the offboarding request was created"},"updated_at":{"type":"string","format":"date-time","description":"The date and time the offboarding request was updated"},"contract_id":{"type":"string","description":"The unique identifier of the employee contract."},"is_sensitive":{"type":"boolean","description":"Indicates if the offboarding request is sensitive. This is used to restrict access to the request only to the requester and the HRX team."},"request_data":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaDataRequestData"},{"type":"null"}]},"desired_end_date":{"type":["string","null"],"format":"date-time","description":"The desired end date. If the date is not provided, it will be selected by HRX the closest date possible"}},"title":"EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaData"},"eor-terminations_createOffboardingTermination_Response_201":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"eor-terminations_createOffboardingTermination_Response_201"},"EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string","description":"Error code of the handler which produced the returned error"},"field":{"type":"string","description":"The field name where error occurred (null for server errors)"},"message":{"type":"string","description":"Description of the returned error"}},"title":"EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaErrorsItems"},"InitiateEorContractTerminationRequestRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"InitiateEorContractTerminationRequestRequestBadRequestError"},"InitiateEorContractTerminationRequestRequestUnauthorizedError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"InitiateEorContractTerminationRequestRequestUnauthorizedError"},"InitiateEorContractTerminationRequestRequestForbiddenError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"InitiateEorContractTerminationRequestRequestForbiddenError"},"InitiateEorContractTerminationRequestRequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingTerminationPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"InitiateEorContractTerminationRequestRequestInternalServerError"},"EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaDataDataReason":{"type":"string","enum":["EMPLOYEE_IS_MOVING_TO_ANOTHER_COUNTRY","MOVING_EMPLOYEE_TO_INTERNAL_ENTITY","MOVING_EMPLOYEE_TO_DEEL_PEO","EMPLOYEE_FOUND_ANOTHER_JOB","EMPLOYEE_NOT_HAPPY_WITH_BENEFITS","EMPLOYEE_NOT_HAPPY_WITH_SALARY","EMPLOYEE_NOT_HAPPY_WITH_THE_ROLE","EMPLOYEE_NOT_HAPPY_WITH_COMPANY_CULTURE","EMPLOYEE_NOT_HAPPY_WITH_DEEL","EMPLOYEE_PROJECT_ENDED","EMPLOYEE_SWITCHING_TO_OTHER_EOR_PROVIDER","EMPLOYEE_LEFT_ROLE_FOR_PERSONAL_MATTERS","EMPLOYEE_MOVING_FROM_EOR_TO_CONTRACTOR_OR_FREELANCE","WORKER_TYPE_CHANGE","DEEL_COLLECTIONS","EMPLOYEE_DID_NOT_TAKE_THE_OFFER","EMPLOYEE_PROVIDED_NO_REASON","OTHER_BUSINESS_REASONS"],"description":"Reason why the contract is being terminated","title":"EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaDataDataReason"},"EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaDataDataAttachmentsItems":{"type":"object","properties":{"key":{"type":"string"},"file_name":{"type":"string"}},"required":["key"],"title":"EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaDataDataAttachmentsItems"},"EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaDataDataUsedTimeOffTimeOffsItemsUnit":{"type":"string","enum":["BUSINESS_DAY","CALENDAR_DAY","HOUR","WEEK","MONTH","YEAR"],"description":"Time off unit","title":"EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaDataDataUsedTimeOffTimeOffsItemsUnit"},"EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaDataDataUsedTimeOffTimeOffsItemsPolicyType":{"type":"string","enum":["Vacation","Sick leave","Maternity leave","Paternity leave","Parental leave","Bereavement leave","Childcare leave","Civic/public duty leave","Personal leave","Adoption leave","Blood donation leave","Childbirth leave","Disability leave","Doctor's appointment leave","Family & domestic violence leave","Hajj leave","Marriage/wedding leave","Military leave","Moving leave","Pregnancy leave","Study leave","Volunteer leave","Unpaid leave","Paid leave","Other leave","RTT","Regional holiday","Breastfeeding leave","Advanced vacation","Supplementary Leave","Floating Holiday Allowance"],"description":"Time off policy type","title":"EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaDataDataUsedTimeOffTimeOffsItemsPolicyType"},"EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaDataDataUsedTimeOffTimeOffsItemsTrackingPeriodsItems":{"type":"object","properties":{"used":{"type":"number","format":"double","description":"Time off used in the period"},"end_date":{"type":"string","format":"date-time","description":"Time off start period"},"start_date":{"type":"string","format":"date-time","description":"Time off end period"}},"required":["used"],"title":"EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaDataDataUsedTimeOffTimeOffsItemsTrackingPeriodsItems"},"EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaDataDataUsedTimeOffTimeOffsItems":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaDataDataUsedTimeOffTimeOffsItemsUnit","description":"Time off unit"},"policy_type":{"$ref":"#/components/schemas/EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaDataDataUsedTimeOffTimeOffsItemsPolicyType","description":"Time off policy type"},"tracking_periods":{"type":"array","items":{"$ref":"#/components/schemas/EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaDataDataUsedTimeOffTimeOffsItemsTrackingPeriodsItems"}},"scheduled_until_end_date":{"type":"number","format":"double","description":"Time off escheduled until contract end date"}},"required":["unit"],"title":"EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaDataDataUsedTimeOffTimeOffsItems"},"EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaDataDataUsedTimeOff":{"type":"object","properties":{"time_offs":{"type":"array","items":{"$ref":"#/components/schemas/EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaDataDataUsedTimeOffTimeOffsItems"},"description":"All time-off used by the employee during contract period"},"additional_details":{"type":["string","null"],"description":"Any additional details regarding time off that HRX should know"},"is_deel_pto_confirmed":{"type":"boolean","description":"Defines whether the client agrees with the time off values that are registered in Deel. If false, it means that the client changed the values."}},"title":"EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaDataDataUsedTimeOff"},"EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaDataDataSeveranceType":{"type":"string","enum":["DAYS","WEEKS","MONTHS","CASH"],"description":"The type of severance selected by the client. It's an optional field","title":"EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaDataDataSeveranceType"},"EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaDataDataAdditionalReason":{"type":"string","enum":["MOVING_TO_INTERNAL_ENTITY_WITH_DEEL_GLOBAL_PAYROLL","MOVING_TO_INTERNAL_ENTITY_WITH_OTHER_PROVIDER"],"description":"An additional reason can be provided in case the reason selected is MOVING_EMPLOYEE_TO_INTERNAL_ENTITY","title":"EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaDataDataAdditionalReason"},"EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaDataDataEligibleForRehire":{"type":"string","enum":["YES","NO","DONT_KNOW"],"description":"Parameter to inform whether it would be possible for the client to hire the employee again","title":"EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaDataDataEligibleForRehire"},"EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaDataData":{"type":"object","properties":{"reason":{"$ref":"#/components/schemas/EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaDataDataReason","description":"Reason why the contract is being terminated"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaDataDataAttachmentsItems"},"description":"Any document that is important for the request to terminate the contract"},"is_sensitive":{"type":"boolean","description":"Defines whether the termination is sensitive. In this case, only the person requesting the termination will be able to view the termination, receive emails or notifications."},"reason_detail":{"type":"string","description":"Optional field to describe the reason behind the resignation request"},"used_time_off":{"$ref":"#/components/schemas/EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaDataDataUsedTimeOff"},"severance_type":{"$ref":"#/components/schemas/EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaDataDataSeveranceType","description":"The type of severance selected by the client. It's an optional field"},"desired_end_date":{"type":"string","description":"The desired end date. If the date is not provided, it will be selected by HRX the closest date possible"},"severance_amount":{"type":"number","format":"double","description":"The amount of severance needed"},"additional_reason":{"oneOf":[{"$ref":"#/components/schemas/EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaDataDataAdditionalReason"},{"type":"null"}],"description":"An additional reason can be provided in case the reason selected is MOVING_EMPLOYEE_TO_INTERNAL_ENTITY"},"termination_notes":{"type":"array","items":{"type":"string"},"description":"Additional notes can be provided regarding the termination for Deel, like questions and doubts"},"eligible_for_rehire":{"oneOf":[{"$ref":"#/components/schemas/EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaDataDataEligibleForRehire"},{"type":"null"}],"description":"Parameter to inform whether it would be possible for the client to hire the employee again"},"termination_impact_id":{"type":"string","format":"uuid","description":"Termination impact data if there is some configured on HR module"},"eligible_for_rehire_reason":{"type":["string","null"],"description":"Describe if the option DONT_KNOW was selected on eligibleForRehire"},"custom_termination_reason_id":{"type":["string","null"],"format":"uuid","description":"Custom termination reason ID. A custom termination reason can be added on Client HR module"},"is_employee_staying_with_deel":{"type":["boolean","null"],"description":"Defines if employee will keep using Deel as provider"}},"required":["reason","used_time_off","is_employee_staying_with_deel"],"title":"EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaDataData"},"EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaDataData"}},"required":["data"],"title":"EorOidTerminationsResignationPostRequestBodyContentApplicationJsonSchemaData"},"EorOidTerminationsResignationPostResponsesContentApplicationJsonSchemaDataRequestDataTerminationImpact":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"title":{"type":"string","description":"Termination impact title"},"description":{"type":"string","description":"Termination impact description"}},"description":"Custom termination impact data if there is some configured on HR module","title":"EorOidTerminationsResignationPostResponsesContentApplicationJsonSchemaDataRequestDataTerminationImpact"},"EorOidTerminationsResignationPostResponsesContentApplicationJsonSchemaDataRequestDataEligibleForRehire":{"type":"string","enum":["YES","NO","DONT_KNOW"],"description":"Parameter to inform whether it would be possible for the client to hire the employee again","title":"EorOidTerminationsResignationPostResponsesContentApplicationJsonSchemaDataRequestDataEligibleForRehire"},"EorOidTerminationsResignationPostResponsesContentApplicationJsonSchemaDataRequestData":{"type":"object","properties":{"reason":{"type":["string","null"]},"end_date":{"type":["string","null"],"format":"date-time","description":"The definitive contract end date"},"reason_detail":{"type":["string","null"],"description":"Optional field to describe the reason behind the resignation request"},"desired_end_date":{"type":["string","null"],"format":"date-time","description":"The desired end date. If the date is not provided, it will be selected by HRX the closest date possible"},"termination_impact":{"oneOf":[{"$ref":"#/components/schemas/EorOidTerminationsResignationPostResponsesContentApplicationJsonSchemaDataRequestDataTerminationImpact"},{"type":"null"}],"description":"Custom termination impact data if there is some configured on HR module"},"eligible_for_rehire":{"oneOf":[{"$ref":"#/components/schemas/EorOidTerminationsResignationPostResponsesContentApplicationJsonSchemaDataRequestDataEligibleForRehire"},{"type":"null"}],"description":"Parameter to inform whether it would be possible for the client to hire the employee again"},"eligible_for_rehire_reason":{"type":["string","null"],"description":"Describe if the option DONT_KNOW was selected on eligibleForRehire"},"custom_termination_reason_id":{"type":["number","null"],"format":"double","description":"Custom termination reason ID. A custom termination reason can be added on Client HR module"}},"title":"EorOidTerminationsResignationPostResponsesContentApplicationJsonSchemaDataRequestData"},"EorOidTerminationsResignationPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"number","format":"double"},"end_date":{"type":["string","null"],"format":"date-time","description":"The definitive contract end date"},"contract_id":{"type":"string","description":"Public contract oid"},"request_data":{"oneOf":[{"$ref":"#/components/schemas/EorOidTerminationsResignationPostResponsesContentApplicationJsonSchemaDataRequestData"},{"type":"null"}]},"desired_end_date":{"type":["string","null"],"format":"date-time","description":"The desired end date. If the date is not provided, it will be selected by HRX the closest date possible"}},"title":"EorOidTerminationsResignationPostResponsesContentApplicationJsonSchemaData"},"eor-terminations_createResignation_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorOidTerminationsResignationPostResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"eor-terminations_createResignation_Response_200"},"EorOidTerminationsResignationPostResponsesContentApplicationJsonSchemaItems":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"title":"EorOidTerminationsResignationPostResponsesContentApplicationJsonSchemaItems"},"EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaDataReason":{"type":"string","enum":["DEEL_COLLECTIONS","STATUS_CHANGE","RELOCATION","COMPENSATION","RETIREMENT","JOB_ABANDONMENT","WORK_RELATED","PERSONAL","OTHER_OPPORTUNITY","NON_RENEWAL","PROBATION","ASSIGNMENT_ENDED","POSITION_ELIMINATION","FORCE_REDUCTION","DEATH","FOR_CAUSE","PERFORMANCE","MEDICAL","PERFORMANCE_ISSUES","ATTENDANCE_ISSUES","REORGANIZATION_DOWNSIZING_BUDGET_OR_REDUCTION_OF_WORKFORCE","ROLE_BECAME_REDUNDANT_OR_ROLE_CHANGED","OFFER_WAS_REVOKED","EXITING_THE_MARKET","NO_LONGER_WISH_TO_WORK_WITH_DEEL","COMPANY_ACQUIRED","STEALING","MISCONDUCT","FALSIFYING","HARASSMENT","VIOLENCE","REORGANIZATION_DOWNSIZING_BUDGET_OR_REDUCTION_OF_WORKFORCE_OR_ROLE_BECAME_REDUNDANT_OR_ROLE_CHANGED","UNAUTHORIZED_ABSENCES_OR_LACK_OF_ATTENDANCE","STANDARD_RESELLER_PRACTICE","MOVING_EMPLOYEE_TO_INTERNAL_ENTITY","MOVING_EMPLOYEE_TO_DEEL_PEO","OTHER"],"description":"Reason why the contract is being terminated","title":"EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaDataReason"},"EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaDataAttachmentsItems":{"type":"object","properties":{"key":{"type":"string"},"file_name":{"type":"string"}},"required":["key"],"title":"EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaDataAttachmentsItems"},"EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaDataUsedTimeOffTimeOffsItemsUnit":{"type":"string","enum":["BUSINESS_DAY","CALENDAR_DAY","HOUR","WEEK","MONTH","YEAR"],"description":"Time off unit","title":"EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaDataUsedTimeOffTimeOffsItemsUnit"},"EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaDataUsedTimeOffTimeOffsItemsPolicyType":{"type":"string","enum":["Vacation","Sick leave","Maternity leave","Paternity leave","Parental leave","Bereavement leave","Childcare leave","Civic/public duty leave","Personal leave","Adoption leave","Blood donation leave","Childbirth leave","Disability leave","Doctor's appointment leave","Family & domestic violence leave","Hajj leave","Marriage/wedding leave","Military leave","Moving leave","Pregnancy leave","Study leave","Volunteer leave","Unpaid leave","Paid leave","Other leave","RTT","Regional holiday","Breastfeeding leave","Advanced vacation","Supplementary Leave","Floating Holiday Allowance"],"description":"Time off policy type","title":"EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaDataUsedTimeOffTimeOffsItemsPolicyType"},"EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaDataUsedTimeOffTimeOffsItemsTrackingPeriodsItems":{"type":"object","properties":{"used":{"type":"number","format":"double","description":"Time off used in the period"},"end_date":{"type":"string","format":"date-time","description":"Time off start period"},"start_date":{"type":"string","format":"date-time","description":"Time off end period"}},"required":["used"],"title":"EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaDataUsedTimeOffTimeOffsItemsTrackingPeriodsItems"},"EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaDataUsedTimeOffTimeOffsItems":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaDataUsedTimeOffTimeOffsItemsUnit","description":"Time off unit"},"policy_type":{"$ref":"#/components/schemas/EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaDataUsedTimeOffTimeOffsItemsPolicyType","description":"Time off policy type"},"tracking_periods":{"type":"array","items":{"$ref":"#/components/schemas/EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaDataUsedTimeOffTimeOffsItemsTrackingPeriodsItems"}},"scheduled_until_end_date":{"type":"number","format":"double","description":"Time off escheduled until contract end date"}},"required":["unit"],"title":"EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaDataUsedTimeOffTimeOffsItems"},"EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaDataUsedTimeOff":{"type":"object","properties":{"time_offs":{"type":"array","items":{"$ref":"#/components/schemas/EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaDataUsedTimeOffTimeOffsItems"},"description":"All time-off used by the employee during contract period"},"additional_details":{"type":["string","null"],"description":"Any additional details regarding time off that HRX should know"},"is_deel_pto_confirmed":{"type":"boolean","description":"Defines whether the client agrees with the time off values ​​that are registered in Deel. If false, it means that the client changed the values."}},"title":"EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaDataUsedTimeOff"},"EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaDataSeveranceType":{"type":"string","enum":["DAYS","WEEKS","MONTHS","CASH"],"description":"The type of severance selected by the client. It's an optional field","title":"EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaDataSeveranceType"},"EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaDataAdditionalReason":{"type":"string","enum":["DISSATISFIED_WITH_DEEL_SERVICE","DISSATISFIED_WITH_DEEL_PRICING","DISSATISFIED_WITH_DEEL_PRODUCT"],"description":"An additional reason can be provided in case the reason selected is NO_LONGER_WISH_TO_WORK_WITH_DEEL","title":"EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaDataAdditionalReason"},"EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaDataEligibleForRehire":{"type":"string","enum":["YES","NO","DONT_KNOW"],"description":"Parameter to inform whether it would be possible for the client to hire the employee again","title":"EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaDataEligibleForRehire"},"EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaDataAdditionalCountryDataItems":{"type":"object","properties":{"answer":{"type":["boolean","null"]},"question":{"type":"string"}},"required":["answer","question"],"title":"EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaDataAdditionalCountryDataItems"},"EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaDataAdditionalSupportingDocumentsItems":{"type":"object","properties":{"key":{"type":"string"},"file_name":{"type":"string"}},"required":["key"],"title":"EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaDataAdditionalSupportingDocumentsItems"},"EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"reason":{"$ref":"#/components/schemas/EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaDataReason","description":"Reason why the contract is being terminated"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaDataAttachmentsItems"},"description":"Any document that is important for the request to terminate the contract"},"is_sensitive":{"type":"boolean","description":"Defines whether the termination is sensitive. In this case, only the person requesting the termination will be able to view the termination, receive emails or notifications."},"reason_detail":{"type":"string","description":"Field to better explain how communication with the employee will be and/or their reaction to the communication, or other necessary information"},"used_time_off":{"$ref":"#/components/schemas/EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaDataUsedTimeOff"},"severance_type":{"$ref":"#/components/schemas/EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaDataSeveranceType","description":"The type of severance selected by the client. It's an optional field"},"desired_end_date":{"type":"string","description":"The desired end date. If the date is not provided, it will be selected by HRX the closest date possible"},"severance_amount":{"type":"number","format":"double","description":"The amount of severance needed"},"additional_reason":{"oneOf":[{"$ref":"#/components/schemas/EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaDataAdditionalReason"},{"type":"null"}],"description":"An additional reason can be provided in case the reason selected is NO_LONGER_WISH_TO_WORK_WITH_DEEL"},"termination_notes":{"type":"array","items":{"type":"string"},"description":"Additional notes can be provided regarding the termination for Deel, like questions and doubts"},"eligible_for_rehire":{"oneOf":[{"$ref":"#/components/schemas/EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaDataEligibleForRehire"},{"type":"null"}],"description":"Parameter to inform whether it would be possible for the client to hire the employee again"},"eor_country_data_id":{"type":"number","format":"double","description":"The current country data id"},"is_employee_notified":{"type":"boolean","description":"Defines if employee was informed by client or not before the termination"},"termination_impact_id":{"type":"string","format":"uuid","description":"Termination impact data if there is some configured on HR module"},"additional_country_data":{"type":"array","items":{"$ref":"#/components/schemas/EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaDataAdditionalCountryDataItems"},"description":"For some countries some data is needed to help Deel to process the termination. The questions comes from another endpoint to get the additional country data"},"custom_termination_reason_id":{"type":"string","format":"uuid","description":"Custom termination reason ID. A custom termination reason can be added on Client HR module"},"employee_notification_detail":{"type":["string","null"],"description":"If it's an termination contract ending and employee was already informed, the employee notification details should be provided"},"additional_supporting_documents":{"type":"array","items":{"$ref":"#/components/schemas/EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaDataAdditionalSupportingDocumentsItems"},"description":"Any proof such as correspondence, documentation of previous warnings or attendance records for the reason select above."}},"required":["reason","reason_detail","used_time_off","is_employee_notified"],"title":"EorOidTerminationsRegularPostRequestBodyContentApplicationJsonSchemaData"},"EorOidTerminationsRegularPostResponsesContentApplicationJsonSchemaRequestDataTerminationImpact":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"title":{"type":"string","description":"Termination impact title"},"description":{"type":"string","description":"Termination impact description"}},"description":"Custom termination impact data if there is some configured on HR module","title":"EorOidTerminationsRegularPostResponsesContentApplicationJsonSchemaRequestDataTerminationImpact"},"EorOidTerminationsRegularPostResponsesContentApplicationJsonSchemaRequestDataEligibleForRehire":{"type":"string","enum":["YES","NO","DONT_KNOW"],"description":"Parameter to inform whether it would be possible for the client to hire the employee again","title":"EorOidTerminationsRegularPostResponsesContentApplicationJsonSchemaRequestDataEligibleForRehire"},"EorOidTerminationsRegularPostResponsesContentApplicationJsonSchemaRequestData":{"type":"object","properties":{"reason":{"type":["string","null"]},"end_date":{"type":["string","null"],"format":"date-time","description":"The definitive contract end date"},"reason_detail":{"type":["string","null"],"description":"Optional field to describe the reason behind the resignation request"},"desired_end_date":{"type":["string","null"],"format":"date-time","description":"The desired end date. If the date is not provided, it will be selected by HRX the closest date possible"},"termination_impact":{"oneOf":[{"$ref":"#/components/schemas/EorOidTerminationsRegularPostResponsesContentApplicationJsonSchemaRequestDataTerminationImpact"},{"type":"null"}],"description":"Custom termination impact data if there is some configured on HR module"},"eligible_for_rehire":{"oneOf":[{"$ref":"#/components/schemas/EorOidTerminationsRegularPostResponsesContentApplicationJsonSchemaRequestDataEligibleForRehire"},{"type":"null"}],"description":"Parameter to inform whether it would be possible for the client to hire the employee again"},"eligible_for_rehire_reason":{"type":["string","null"],"description":"Describe if the option DONT_KNOW was selected on eligibleForRehire"},"custom_termination_reason_id":{"type":["number","null"],"format":"double","description":"Custom termination reason ID. A custom termination reason can be added on Client HR module"}},"title":"EorOidTerminationsRegularPostResponsesContentApplicationJsonSchemaRequestData"},"eor-terminations_createRegularTermination_Response_200":{"type":"object","properties":{"id":{"type":"number","format":"double"},"end_date":{"type":["string","null"],"format":"date-time","description":"The definitive contract end date"},"contract_id":{"type":"string","description":"Public contract oid"},"request_data":{"oneOf":[{"$ref":"#/components/schemas/EorOidTerminationsRegularPostResponsesContentApplicationJsonSchemaRequestData"},{"type":"null"}]},"desired_end_date":{"type":["string","null"],"format":"date-time","description":"The desired end date. If the date is not provided, it will be selected by HRX the closest date possible"}},"title":"eor-terminations_createRegularTermination_Response_200"},"EorOidTerminationsRegularPostResponsesContentApplicationJsonSchemaItems":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"title":"EorOidTerminationsRegularPostResponsesContentApplicationJsonSchemaItems"},"EorWorkerPostRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"contract_id":{"type":"string","description":"ID of the contract associated with the timesheet"}},"required":["contract_id"],"title":"EorWorkerPostRequestBodyContentApplicationJsonSchemaData"},"EorWorkerPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"user_id":{"type":"string","format":"uuid","description":"The ID of the worker's user profile"},"profile_id":{"type":"string","format":"uuid","description":"The ID of the worker's profile"},"hris_profile_id":{"type":"string","format":"uuid","description":"The ID of the worker's HRIS profile"}},"required":["user_id","profile_id","hris_profile_id"],"title":"EorWorkerPostResponsesContentApplicationJsonSchemaData"},"eor-worker-accounts_createWorker_Response_201":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorWorkerPostResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"eor-worker-accounts_createWorker_Response_201"},"EorWorkerPostResponsesContentApplicationJsonSchemaErrorsItems":{"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":"EorWorkerPostResponsesContentApplicationJsonSchemaErrorsItems"},"EorWorkerPostResponsesContentApplicationJsonSchemaRequest":{"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":"EorWorkerPostResponsesContentApplicationJsonSchemaRequest"},"CreateEorWorker-v2026-01-01RequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkerPostResponsesContentApplicationJsonSchemaErrorsItems"}},"request":{"$ref":"#/components/schemas/EorWorkerPostResponsesContentApplicationJsonSchemaRequest"}},"title":"CreateEorWorker-v2026-01-01RequestBadRequestError"},"EorWorkersContractsContractIdEmployeeAgreementDownloadGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"url":{"type":"string","description":"URL to requested employee agreement to download."},"expires_at":{"type":"string","format":"date-time","description":"Expiration date time of download URL."}},"title":"EorWorkersContractsContractIdEmployeeAgreementDownloadGetResponsesContentApplicationJsonSchemaData"},"eor-worker-agreements_downloadWorkerEmployeeAgreement_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorWorkersContractsContractIdEmployeeAgreementDownloadGetResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"eor-worker-agreements_downloadWorkerEmployeeAgreement_Response_200"},"EorWorkersContractsContractIdEmployeeAgreementDownloadGetResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"message":{"type":"string","description":"The error message"}},"title":"EorWorkersContractsContractIdEmployeeAgreementDownloadGetResponsesContentApplicationJsonSchemaErrorsItems"},"EorWorkersContractsContractIdEmployeeAgreementDownloadGetResponsesContentApplicationJsonSchemaRequest":{"type":"object","properties":{"url":{"type":"string","description":"The relative URL of the failed request"},"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":"EorWorkersContractsContractIdEmployeeAgreementDownloadGetResponsesContentApplicationJsonSchemaRequest"},"DownloadEmployeeAgreementPdfRequestConflictError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersContractsContractIdEmployeeAgreementDownloadGetResponsesContentApplicationJsonSchemaErrorsItems"}},"request":{"$ref":"#/components/schemas/EorWorkersContractsContractIdEmployeeAgreementDownloadGetResponsesContentApplicationJsonSchemaRequest"}},"title":"DownloadEmployeeAgreementPdfRequestConflictError"},"EorWorkersContractsContractIdSignaturesPostRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"version":{"type":"string","description":"Optional version of the Employment Agreement to be signed. If informed and in the case of a mismatch, the API will return an error."},"signature":{"type":"string","description":"Signature of employee."}},"required":["signature"],"title":"EorWorkersContractsContractIdSignaturesPostRequestBodyContentApplicationJsonSchemaData"},"EorWorkersContractsContractIdSignaturesPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"created":{"type":"boolean"}},"required":["created"],"title":"EorWorkersContractsContractIdSignaturesPostResponsesContentApplicationJsonSchemaData"},"eor-worker-agreements_signEORContractAsWorker_Response_201":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorWorkersContractsContractIdSignaturesPostResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"eor-worker-agreements_signEORContractAsWorker_Response_201"},"EorWorkersContractsContractIdSignaturesPostResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"message":{"type":"string","description":"The error message"}},"title":"EorWorkersContractsContractIdSignaturesPostResponsesContentApplicationJsonSchemaErrorsItems"},"EorWorkersContractsContractIdSignaturesPostResponsesContentApplicationJsonSchemaRequest":{"type":"object","properties":{"url":{"type":"string","description":"The relative URL of the failed request"},"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":"EorWorkersContractsContractIdSignaturesPostResponsesContentApplicationJsonSchemaRequest"},"SignAContractRequestConflictError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersContractsContractIdSignaturesPostResponsesContentApplicationJsonSchemaErrorsItems"}},"request":{"$ref":"#/components/schemas/EorWorkersContractsContractIdSignaturesPostResponsesContentApplicationJsonSchemaRequest"}},"title":"SignAContractRequestConflictError"},"EorWorkersBanksGuideCountryCountryCurrencyCurrencyGetResponsesContentApplicationJsonSchemaDataItemsUiGuide":{"type":"object","properties":{"label":{"type":"string","description":"Label for this field."},"order":{"type":"integer","description":"Order of the field in the form."},"helper_text":{"type":["string","null"],"description":"Helper text to guide the user."}},"description":"UI guidance information for rendering this field in forms.","title":"EorWorkersBanksGuideCountryCountryCurrencyCurrencyGetResponsesContentApplicationJsonSchemaDataItemsUiGuide"},"EorWorkersBanksGuideCountryCountryCurrencyCurrencyGetResponsesContentApplicationJsonSchemaDataItemsValidationsItemsType":{"type":"string","enum":["MIN_LENGTH","MAX_LENGTH","REGEX"],"description":"The type of validation rule to apply.","title":"EorWorkersBanksGuideCountryCountryCurrencyCurrencyGetResponsesContentApplicationJsonSchemaDataItemsValidationsItemsType"},"EorWorkersBanksGuideCountryCountryCurrencyCurrencyGetResponsesContentApplicationJsonSchemaDataItemsValidationsItemsValue":{"oneOf":[{"type":"string"},{"type":"number","format":"double"}],"description":"The value to use for the validation rule (e.g., minimum length, regex pattern).","title":"EorWorkersBanksGuideCountryCountryCurrencyCurrencyGetResponsesContentApplicationJsonSchemaDataItemsValidationsItemsValue"},"EorWorkersBanksGuideCountryCountryCurrencyCurrencyGetResponsesContentApplicationJsonSchemaDataItemsValidationsItems":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/EorWorkersBanksGuideCountryCountryCurrencyCurrencyGetResponsesContentApplicationJsonSchemaDataItemsValidationsItemsType","description":"The type of validation rule to apply."},"value":{"$ref":"#/components/schemas/EorWorkersBanksGuideCountryCountryCurrencyCurrencyGetResponsesContentApplicationJsonSchemaDataItemsValidationsItemsValue","description":"The value to use for the validation rule (e.g., minimum length, regex pattern)."},"error_message":{"type":"string","description":"Error message to be displayed if validation fails."}},"title":"EorWorkersBanksGuideCountryCountryCurrencyCurrencyGetResponsesContentApplicationJsonSchemaDataItemsValidationsItems"},"EorWorkersBanksGuideCountryCountryCurrencyCurrencyGetResponsesContentApplicationJsonSchemaDataItemsValuesAllowedItems":{"type":"object","properties":{"label":{"type":"string","description":"The name of the allowed value."},"value":{"type":"string","description":"The value of the allowed value."}},"title":"EorWorkersBanksGuideCountryCountryCurrencyCurrencyGetResponsesContentApplicationJsonSchemaDataItemsValuesAllowedItems"},"EorWorkersBanksGuideCountryCountryCurrencyCurrencyGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"key":{"type":"string","description":"The key of the field."},"type":{"type":"string","description":"Type of the field"},"ui_guide":{"$ref":"#/components/schemas/EorWorkersBanksGuideCountryCountryCurrencyCurrencyGetResponsesContentApplicationJsonSchemaDataItemsUiGuide","description":"UI guidance information for rendering this field in forms."},"is_required":{"type":["boolean","null"],"description":"Whether the field is required or not."},"validations":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersBanksGuideCountryCountryCurrencyCurrencyGetResponsesContentApplicationJsonSchemaDataItemsValidationsItems"},"description":"Array of validation rules that apply to this field."},"values_allowed":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersBanksGuideCountryCountryCurrencyCurrencyGetResponsesContentApplicationJsonSchemaDataItemsValuesAllowedItems"},"description":"Array of allowed values for this field (used for dropdowns, select lists, etc.)."}},"required":["key","ui_guide","is_required"],"title":"EorWorkersBanksGuideCountryCountryCurrencyCurrencyGetResponsesContentApplicationJsonSchemaDataItems"},"eor-worker-banks_getEORWorkerBankGuideByCountryAndCurrency_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersBanksGuideCountryCountryCurrencyCurrencyGetResponsesContentApplicationJsonSchemaDataItems"}}},"required":["data"],"title":"eor-worker-banks_getEORWorkerBankGuideByCountryAndCurrency_Response_200"},"EorWorkersBanksGuideCountryCountryCurrencyCurrencyGetResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code"},"field":{"type":"string","description":"Name of the field causing the error (for validation issues)"},"message":{"type":"string","description":"Human-readable explanation of the error"}},"title":"EorWorkersBanksGuideCountryCountryCurrencyCurrencyGetResponsesContentApplicationJsonSchemaErrorsItems"},"RetrieveBankAccountGuide-v2026-01-01RequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersBanksGuideCountryCountryCurrencyCurrencyGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"RetrieveBankAccountGuide-v2026-01-01RequestBadRequestError"},"EorWorkersBanksGuideGetResponsesContentApplicationJsonSchemaDataItemsValidationsItemsType":{"type":"string","enum":["MIN_LENGTH","MAX_LENGTH","REGEX"],"title":"EorWorkersBanksGuideGetResponsesContentApplicationJsonSchemaDataItemsValidationsItemsType"},"EorWorkersBanksGuideGetResponsesContentApplicationJsonSchemaDataItemsValidationsItemsValue":{"oneOf":[{"type":"string"},{"type":"number","format":"double"}],"title":"EorWorkersBanksGuideGetResponsesContentApplicationJsonSchemaDataItemsValidationsItemsValue"},"EorWorkersBanksGuideGetResponsesContentApplicationJsonSchemaDataItemsValidationsItems":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/EorWorkersBanksGuideGetResponsesContentApplicationJsonSchemaDataItemsValidationsItemsType"},"value":{"$ref":"#/components/schemas/EorWorkersBanksGuideGetResponsesContentApplicationJsonSchemaDataItemsValidationsItemsValue"}},"title":"EorWorkersBanksGuideGetResponsesContentApplicationJsonSchemaDataItemsValidationsItems"},"EorWorkersBanksGuideGetResponsesContentApplicationJsonSchemaDataItemsValuesAllowedItems":{"type":"object","properties":{"label":{"type":"string","description":"The name of the allowed value."},"value":{"type":"string","description":"The value of the allowed value."}},"title":"EorWorkersBanksGuideGetResponsesContentApplicationJsonSchemaDataItemsValuesAllowedItems"},"EorWorkersBanksGuideGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"key":{"type":"string","description":"The key of the field."},"type":{"type":"string","description":"Type of the field"},"label":{"type":"string","description":"Label for this field."},"required":{"type":"boolean","description":"Whether the field is required or not."},"validations":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersBanksGuideGetResponsesContentApplicationJsonSchemaDataItemsValidationsItems"}},"values_allowed":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersBanksGuideGetResponsesContentApplicationJsonSchemaDataItemsValuesAllowedItems"}}},"required":["key","required"],"title":"EorWorkersBanksGuideGetResponsesContentApplicationJsonSchemaDataItems"},"eor-worker-banks_getEORWorkerBankGuide_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersBanksGuideGetResponsesContentApplicationJsonSchemaDataItems"}}},"required":["data"],"title":"eor-worker-banks_getEORWorkerBankGuide_Response_200"},"EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItemsEnrollmentDetailsSelectedPlanAttachmentsItems":{"type":"object","properties":{"id":{"type":"string","description":"Unique id of the attachment"},"url":{"type":"string","description":"URL of the attachment"},"label":{"type":"string","description":"Label of the attachment"}},"required":["id","url","label"],"title":"EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItemsEnrollmentDetailsSelectedPlanAttachmentsItems"},"EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItemsEnrollmentDetailsSelectedPlan":{"type":"object","properties":{"id":{"type":"string","description":"Unique id of the plan"},"name":{"type":"string","description":"Name of the plan"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItemsEnrollmentDetailsSelectedPlanAttachmentsItems"}}},"required":["id","name","attachments"],"title":"EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItemsEnrollmentDetailsSelectedPlan"},"EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItemsEnrollmentDetailsSelectedProviderAttachmentsItems":{"type":"object","properties":{"id":{"type":"string","description":"Unique id of the attachment"},"url":{"type":"string","description":"URL of the attachment"},"label":{"type":"string","description":"Label of the attachment"}},"required":["id","url","label"],"title":"EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItemsEnrollmentDetailsSelectedProviderAttachmentsItems"},"EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItemsEnrollmentDetailsSelectedProvider":{"type":"object","properties":{"id":{"type":"string","description":"Unique id of the provider"},"name":{"type":"string","description":"Name of the provider"},"is_unisure":{"type":"boolean","description":"Indicates if Unisure."},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItemsEnrollmentDetailsSelectedProviderAttachmentsItems"}},"home_page_url":{"type":"string","description":"Home page URL of the provider"}},"required":["id","name","attachments","home_page_url"],"title":"EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItemsEnrollmentDetailsSelectedProvider"},"EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItemsEnrollmentDetails":{"type":"object","properties":{"selected_plan":{"$ref":"#/components/schemas/EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItemsEnrollmentDetailsSelectedPlan"},"selected_provider":{"$ref":"#/components/schemas/EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItemsEnrollmentDetailsSelectedProvider"},"current_cycle_plan_cost":{"type":"number","format":"double","description":"Cost of the plan for the current cycle"},"current_cycle_employer_contribution":{"type":"number","format":"double","description":"Employer contribution for the current cycle"}},"required":["selected_plan","selected_provider","current_cycle_plan_cost","current_cycle_employer_contribution"],"title":"EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItemsEnrollmentDetails"},"EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItemsOrganizationSelectionSelectedPlanAttachmentsItems":{"type":"object","properties":{"id":{"type":"string","description":"Unique id of the attachment"},"url":{"type":"string","description":"URL of the attachment"},"label":{"type":"string","description":"Label of the attachment"}},"required":["id","url","label"],"title":"EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItemsOrganizationSelectionSelectedPlanAttachmentsItems"},"EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItemsOrganizationSelectionSelectedPlan":{"type":"object","properties":{"id":{"type":"string","description":"Unique id of the plan"},"name":{"type":"string","description":"Name of the plan"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItemsOrganizationSelectionSelectedPlanAttachmentsItems"}}},"required":["id","name","attachments"],"title":"EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItemsOrganizationSelectionSelectedPlan"},"EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItemsOrganizationSelectionSelectedProviderAttachmentsItems":{"type":"object","properties":{"id":{"type":"string","description":"Unique id of the attachment"},"url":{"type":"string","description":"URL of the attachment"},"label":{"type":"string","description":"Label of the attachment"}},"required":["id","url","label"],"title":"EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItemsOrganizationSelectionSelectedProviderAttachmentsItems"},"EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItemsOrganizationSelectionSelectedProvider":{"type":"object","properties":{"id":{"type":"string","description":"Unique id of the provider"},"name":{"type":"string","description":"Name of the provider"},"is_unisure":{"type":"boolean","description":"Indicates if Unisure."},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItemsOrganizationSelectionSelectedProviderAttachmentsItems"}},"home_page_url":{"type":"string","description":"Home page URL of the provider"}},"required":["id","name","attachments","home_page_url"],"title":"EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItemsOrganizationSelectionSelectedProvider"},"EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItemsOrganizationSelection":{"type":"object","properties":{"selected_plan":{"$ref":"#/components/schemas/EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItemsOrganizationSelectionSelectedPlan"},"selected_provider":{"$ref":"#/components/schemas/EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItemsOrganizationSelectionSelectedProvider"}},"required":["selected_plan","selected_provider"],"title":"EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItemsOrganizationSelection"},"EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID of the benefit."},"name":{"type":"string","description":"Name of the benefit"},"type":{"type":["string","null"],"description":"Benefit type."},"status":{"type":"string","description":"Status of the benefit"},"description":{"type":"string","description":"Description of the benefit"},"enrollment_details":{"$ref":"#/components/schemas/EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItemsEnrollmentDetails"},"organization_selection":{"$ref":"#/components/schemas/EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItemsOrganizationSelection"}},"required":["name","type","status","description","enrollment_details","organization_selection"],"title":"EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItems"},"EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"benefits":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItemsBenefitsItems"}},"currency":{"type":"string","description":"Currency of the contract"},"contract_id":{"type":"string","description":"Unique id of the contract"}},"required":["benefits","currency","contract_id"],"title":"EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItems"},"eor-worker-benefits_getEORWorkerBenefits_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaDataItems"}}},"required":["data"],"title":"eor-worker-benefits_getEORWorkerBenefits_Response_200"},"EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaErrorsItems":{"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":"EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaErrorsItems"},"EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaRequest":{"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":"EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaRequest"},"RetrieveBenefitsForEmployeeRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaErrorsItems"}},"request":{"$ref":"#/components/schemas/EorWorkerBenefitsGetResponsesContentApplicationJsonSchemaRequest"}},"title":"RetrieveBenefitsForEmployeeRequestBadRequestError"},"eor-worker-compliance_createComplianceDocumentAcknowledgement_Response_204":{"type":"object","properties":{},"description":"Empty response body","title":"eor-worker-compliance_createComplianceDocumentAcknowledgement_Response_204"},"EorWorkersComplianceDocumentsDocumentIdAcknowledgementPostResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code"},"message":{"type":"string","description":"Human-readable explanation of the error"}},"title":"EorWorkersComplianceDocumentsDocumentIdAcknowledgementPostResponsesContentApplicationJsonSchemaErrorsItems"},"AcknowledgeAComplianceDocumentRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersComplianceDocumentsDocumentIdAcknowledgementPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"AcknowledgeAComplianceDocumentRequestBadRequestError"},"AcknowledgeAComplianceDocumentRequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersComplianceDocumentsDocumentIdAcknowledgementPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"AcknowledgeAComplianceDocumentRequestInternalServerError"},"EorWorkersComplianceDocumentsDocumentIdTemplatesDownloadGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"url":{"type":"string","description":"The URL for the requested compliance document template."},"expires_at":{"type":["string","null"],"format":"date-time","description":"Expiration date time of download URL."},"updated_at":{"type":"string","format":"date-time","description":"Last modified date of the template file"}},"title":"EorWorkersComplianceDocumentsDocumentIdTemplatesDownloadGetResponsesContentApplicationJsonSchemaData"},"eor-worker-compliance_downloadComplianceDocumentTemplate_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorWorkersComplianceDocumentsDocumentIdTemplatesDownloadGetResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"eor-worker-compliance_downloadComplianceDocumentTemplate_Response_200"},"EorWorkersComplianceDocumentsDocumentIdDownloadGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"url":{"type":"string","description":"The URL for the requested compliance document."},"expires_at":{"type":"string","format":"date-time","description":"Expiration date time of download URL."}},"title":"EorWorkersComplianceDocumentsDocumentIdDownloadGetResponsesContentApplicationJsonSchemaData"},"eor-worker-compliance_downloadComplianceDocument_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorWorkersComplianceDocumentsDocumentIdDownloadGetResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"eor-worker-compliance_downloadComplianceDocument_Response_200"},"EorWorkersComplianceDocumentsDocumentIdDownloadGetResponsesContentApplicationJsonSchemaErrorsItems":{"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":"EorWorkersComplianceDocumentsDocumentIdDownloadGetResponsesContentApplicationJsonSchemaErrorsItems"},"EorWorkersComplianceDocumentsDocumentIdDownloadGetResponsesContentApplicationJsonSchemaRequest":{"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":"EorWorkersComplianceDocumentsDocumentIdDownloadGetResponsesContentApplicationJsonSchemaRequest"},"DownloadSubmittedComplianceDocumentRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersComplianceDocumentsDocumentIdDownloadGetResponsesContentApplicationJsonSchemaErrorsItems"}},"request":{"$ref":"#/components/schemas/EorWorkersComplianceDocumentsDocumentIdDownloadGetResponsesContentApplicationJsonSchemaRequest"}},"title":"DownloadSubmittedComplianceDocumentRequestBadRequestError"},"EorWorkersComplianceDocumentsGetResponsesContentApplicationJsonSchemaDataDocumentsItemsStatus":{"type":"string","enum":["AWAITING_EX_REVIEW","AWAITING_EXTERNAL_REVIEW","REJECTED","APPROVED","ON_HOLD"],"description":"Review status of the uploaded document, null if no document has been uploaded yet.","title":"EorWorkersComplianceDocumentsGetResponsesContentApplicationJsonSchemaDataDocumentsItemsStatus"},"EorWorkersComplianceDocumentsGetResponsesContentApplicationJsonSchemaDataDocumentsItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the compliance document requirement."},"name":{"type":"string","description":"Display name of the compliance document."},"status":{"oneOf":[{"$ref":"#/components/schemas/EorWorkersComplianceDocumentsGetResponsesContentApplicationJsonSchemaDataDocumentsItemsStatus"},{"type":"null"}],"description":"Review status of the uploaded document, null if no document has been uploaded yet."},"country":{"type":"string","description":"ISO 3166-1 alpha-2 country code where the document is required."},"fillable":{"type":"boolean","description":"Whether the document can be filled through the Deel platform."},"filenames":{"type":"array","items":{"type":"string"},"description":"List of uploaded file names. Empty array when no files have been uploaded."},"description":{"type":"string","description":"Description of the document requirement. Empty string when no description exists."},"is_optional":{"type":"boolean","description":"Whether the document is optional for the worker. Also true when the document is required within 30 days."},"uploaded_at":{"type":["string","null"],"format":"date-time","description":"ISO 8601 timestamp when the document was uploaded, null if no document has been uploaded."},"has_template":{"type":"boolean","description":"Whether a template is available for this document."},"rejection_message":{"type":"string","description":"Plain text message explaining why the document was rejected. Empty string when no rejection message exists."},"is_consent_required":{"type":"boolean","description":"Whether consent is required for acknowledgement-only documents. Only present when is_acknowledgement_only_document is true."},"required_in_30_days":{"type":"boolean","description":"Whether the document is required within 30 days of employment start."},"is_acknowledgement_only_document":{"type":"boolean","description":"Whether this document only requires acknowledgement without file upload."}},"required":["id","name","status","country","fillable","filenames","description","is_optional","uploaded_at","has_template","rejection_message","required_in_30_days","is_acknowledgement_only_document"],"title":"EorWorkersComplianceDocumentsGetResponsesContentApplicationJsonSchemaDataDocumentsItems"},"EorWorkersComplianceDocumentsGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"documents":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersComplianceDocumentsGetResponsesContentApplicationJsonSchemaDataDocumentsItems"},"description":"List of compliance documents required for the worker."}},"required":["documents"],"title":"EorWorkersComplianceDocumentsGetResponsesContentApplicationJsonSchemaData"},"eor-worker-compliance_getEORWorkerComplianceDocuments_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorWorkersComplianceDocumentsGetResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"eor-worker-compliance_getEORWorkerComplianceDocuments_Response_200"},"EorWorkersComplianceDocumentsGetResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string"},"field":{"type":["string","null"]},"message":{"type":"string"}},"required":["code","message"],"title":"EorWorkersComplianceDocumentsGetResponsesContentApplicationJsonSchemaErrorsItems"},"ListOfEmployeeComplianceDocuments-v2026-01-01RequestUnauthorizedError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersComplianceDocumentsGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"ListOfEmployeeComplianceDocuments-v2026-01-01RequestUnauthorizedError"},"ListOfEmployeeComplianceDocuments-v2026-01-01RequestForbiddenError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersComplianceDocumentsGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"ListOfEmployeeComplianceDocuments-v2026-01-01RequestForbiddenError"},"ListOfEmployeeComplianceDocuments-v2026-01-01RequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersComplianceDocumentsGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"ListOfEmployeeComplianceDocuments-v2026-01-01RequestInternalServerError"},"EorWorkersComplianceDocumentsDocumentIdPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"success":{"type":"boolean","description":"Indicates whether the file upload was successful."}},"required":["success"],"title":"EorWorkersComplianceDocumentsDocumentIdPostResponsesContentApplicationJsonSchemaData"},"eor-worker-compliance_uploadEORWorkerComplianceDocument_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorWorkersComplianceDocumentsDocumentIdPostResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"eor-worker-compliance_uploadEORWorkerComplianceDocument_Response_200"},"EorWorkersComplianceDocumentsDocumentIdPostResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"message":{"type":"string","description":"Human-readable error message."}},"required":["message"],"title":"EorWorkersComplianceDocumentsDocumentIdPostResponsesContentApplicationJsonSchemaErrorsItems"},"UploadEmployeeComplianceDocument-v2026-01-01RequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersComplianceDocumentsDocumentIdPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"UploadEmployeeComplianceDocument-v2026-01-01RequestBadRequestError"},"UploadEmployeeComplianceDocument-v2026-01-01RequestUnauthorizedError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersComplianceDocumentsDocumentIdPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"UploadEmployeeComplianceDocument-v2026-01-01RequestUnauthorizedError"},"UploadEmployeeComplianceDocument-v2026-01-01RequestForbiddenError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersComplianceDocumentsDocumentIdPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"UploadEmployeeComplianceDocument-v2026-01-01RequestForbiddenError"},"UploadEmployeeComplianceDocument-v2026-01-01RequestNotFoundError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersComplianceDocumentsDocumentIdPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"UploadEmployeeComplianceDocument-v2026-01-01RequestNotFoundError"},"UploadEmployeeComplianceDocument-v2026-01-01RequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersComplianceDocumentsDocumentIdPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"UploadEmployeeComplianceDocument-v2026-01-01RequestInternalServerError"},"EorWorkersContractsContractIdHrDocumentsGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"id":{"type":"string","description":"Document Id."},"name":{"type":"string","description":"Name of the document."}},"required":["id","name"],"title":"EorWorkersContractsContractIdHrDocumentsGetResponsesContentApplicationJsonSchemaDataItems"},"eor-worker-documents_getEORWorkerHRDocuments_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersContractsContractIdHrDocumentsGetResponsesContentApplicationJsonSchemaDataItems"}}},"required":["data"],"title":"eor-worker-documents_getEORWorkerHRDocuments_Response_200"},"EorWorkersContractsContractIdAdditionalInformationPostRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"city":{"type":"string","description":"City"},"phone":{"type":"string","description":"Worker phone"},"state":{"type":"string","description":"State/province (required for countries with provinces/states)."},"street":{"type":"string","description":"Street"},"zip_code":{"type":"string","description":"Zipcode/Post code"},"tax_residence":{"type":"string","description":"Worker tax residence"},"is_payslip_access_allowed":{"type":"boolean","description":"Worker access to payslips"},"is_compliance_access_allowed":{"type":"boolean","description":"Worker access to compliance documents"}},"required":["city","phone","street","zip_code","tax_residence","is_payslip_access_allowed","is_compliance_access_allowed"],"description":"Additional fields are country/state-specific and validated against the worker additional fields form for the employment country.","title":"EorWorkersContractsContractIdAdditionalInformationPostRequestBodyContentApplicationJsonSchemaData"},"EorWorkersContractsContractIdAdditionalInformationPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"updated":{"type":"boolean","description":"Indicates if contract was updated"}},"required":["updated"],"title":"EorWorkersContractsContractIdAdditionalInformationPostResponsesContentApplicationJsonSchemaData"},"eor-worker-information_createGPWorkerAdditionalInformation_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorWorkersContractsContractIdAdditionalInformationPostResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"eor-worker-information_createGPWorkerAdditionalInformation_Response_200"},"EorWorkersContractsContractIdAdditionalInformationPostResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"title":"EorWorkersContractsContractIdAdditionalInformationPostResponsesContentApplicationJsonSchemaErrorsItems"},"EorWorkersContractsContractIdAdditionalInformationPostResponsesContentApplicationJsonSchemaTranslationsItems":{"type":"object","properties":{"originalKey":{"type":"string"},"publicApiKey":{"type":"string"}},"required":["originalKey","publicApiKey"],"title":"EorWorkersContractsContractIdAdditionalInformationPostResponsesContentApplicationJsonSchemaTranslationsItems"},"AddAdditionalInformation-v2026-01-01RequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersContractsContractIdAdditionalInformationPostResponsesContentApplicationJsonSchemaErrorsItems"}},"translations":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersContractsContractIdAdditionalInformationPostResponsesContentApplicationJsonSchemaTranslationsItems"},"description":"Present when additional fields fail validation, to map internal field keys back to public API keys."}},"required":["errors"],"title":"AddAdditionalInformation-v2026-01-01RequestBadRequestError"},"AddAdditionalInformation-v2026-01-01RequestUnauthorizedError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersContractsContractIdAdditionalInformationPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"AddAdditionalInformation-v2026-01-01RequestUnauthorizedError"},"AddAdditionalInformation-v2026-01-01RequestForbiddenError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersContractsContractIdAdditionalInformationPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"AddAdditionalInformation-v2026-01-01RequestForbiddenError"},"AddAdditionalInformation-v2026-01-01RequestNotFoundError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersContractsContractIdAdditionalInformationPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"AddAdditionalInformation-v2026-01-01RequestNotFoundError"},"AddAdditionalInformation-v2026-01-01RequestTooManyRequestsError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersContractsContractIdAdditionalInformationPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"AddAdditionalInformation-v2026-01-01RequestTooManyRequestsError"},"AddAdditionalInformation-v2026-01-01RequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersContractsContractIdAdditionalInformationPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"AddAdditionalInformation-v2026-01-01RequestInternalServerError"},"EorWorkersBanksPostRequestBodyContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"key":{"type":"string","description":"The key of the bank account properties."},"value":{"type":"string","description":"The value for that key property."}},"required":["key","value"],"title":"EorWorkersBanksPostRequestBodyContentApplicationJsonSchemaDataItems"},"EorWorkersBanksPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","description":"ID of Bank Account."}},"required":["id"],"title":"EorWorkersBanksPostResponsesContentApplicationJsonSchemaData"},"eor-worker-information_createEORWorkerBankAccount_Response_201":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorWorkersBanksPostResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"eor-worker-information_createEORWorkerBankAccount_Response_201"},"EorWorkersTaxDocumentsGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"id":{"type":"string","description":"Id of the tax document"},"url":{"type":"string","description":"URL of the tax document"},"type":{"type":"string","description":"Type of the tax document"},"year":{"type":"number","format":"double","description":"Year of tax document"},"country":{"type":"string","description":"Country of the tax document"}},"title":"EorWorkersTaxDocumentsGetResponsesContentApplicationJsonSchemaDataItems"},"eor-worker-information_getEORWorkerTaxDocuments_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersTaxDocumentsGetResponsesContentApplicationJsonSchemaDataItems"}}},"required":["data"],"title":"eor-worker-information_getEORWorkerTaxDocuments_Response_200"},"EorWorkersContractsContractIdAdditionalInformationPatchRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"dob":{"type":"string","description":"Date of birth (ISO 8601 date)"},"city":{"type":"string","description":"City"},"phone":{"type":"string","description":"Worker phone"},"state":{"type":"string","description":"State/province"},"street":{"type":"string","description":"Street"},"zip_code":{"type":"string","description":"Zipcode/Post code"},"tax_residence":{"type":"string","description":"Worker tax residence"},"is_payslip_access_allowed":{"type":"boolean","description":"Worker access to payslips"},"is_compliance_access_allowed":{"type":"boolean","description":"Worker access to compliance documents"}},"description":"You can submit any subset of fields. Keys not listed above are treated as country/state-specific additional information fields. Those keys must match the fields returned by GET /forms/eor/worker-additional-fields/{country_code} (public keys).","title":"EorWorkersContractsContractIdAdditionalInformationPatchRequestBodyContentApplicationJsonSchemaData"},"EorWorkersContractsContractIdAdditionalInformationPatchResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"updated":{"type":"boolean","description":"Indicates if contract was updated"}},"required":["updated"],"title":"EorWorkersContractsContractIdAdditionalInformationPatchResponsesContentApplicationJsonSchemaData"},"eor-worker-information_updateEORWorkerAdditionalInformation_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorWorkersContractsContractIdAdditionalInformationPatchResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"eor-worker-information_updateEORWorkerAdditionalInformation_Response_200"},"EorWorkersContractsContractIdAdditionalInformationPatchResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"],"title":"EorWorkersContractsContractIdAdditionalInformationPatchResponsesContentApplicationJsonSchemaErrorsItems"},"UpdateAdditionalInformation-v2026-01-01RequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersContractsContractIdAdditionalInformationPatchResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"UpdateAdditionalInformation-v2026-01-01RequestBadRequestError"},"UpdateAdditionalInformation-v2026-01-01RequestUnauthorizedError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersContractsContractIdAdditionalInformationPatchResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"UpdateAdditionalInformation-v2026-01-01RequestUnauthorizedError"},"UpdateAdditionalInformation-v2026-01-01RequestForbiddenError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersContractsContractIdAdditionalInformationPatchResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"UpdateAdditionalInformation-v2026-01-01RequestForbiddenError"},"UpdateAdditionalInformation-v2026-01-01RequestNotFoundError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersContractsContractIdAdditionalInformationPatchResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"UpdateAdditionalInformation-v2026-01-01RequestNotFoundError"},"UpdateAdditionalInformation-v2026-01-01RequestTooManyRequestsError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersContractsContractIdAdditionalInformationPatchResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"UpdateAdditionalInformation-v2026-01-01RequestTooManyRequestsError"},"UpdateAdditionalInformation-v2026-01-01RequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersContractsContractIdAdditionalInformationPatchResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"UpdateAdditionalInformation-v2026-01-01RequestInternalServerError"},"EorMailboxesChangePasswordPostRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"password":{"type":"string","description":"The new password."}},"title":"EorMailboxesChangePasswordPostRequestBodyContentApplicationJsonSchemaData"},"eor-worker-mailboxes_changePassword_Response_204":{"type":"object","properties":{},"description":"Empty response body","title":"eor-worker-mailboxes_changePassword_Response_204"},"EorMailboxesChangePasswordPostResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code"},"message":{"type":"string","description":"Human-readable explanation of the error"}},"title":"EorMailboxesChangePasswordPostResponsesContentApplicationJsonSchemaErrorsItems"},"ChangeEorMailboxPasswordRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorMailboxesChangePasswordPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"ChangeEorMailboxPasswordRequestBadRequestError"},"ChangeEorMailboxPasswordRequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorMailboxesChangePasswordPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"ChangeEorMailboxPasswordRequestInternalServerError"},"EorWorkersContractsContractIdOffboardingResignationLetterGetResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string","description":"Error code of the handler which produced the returned error"},"field":{"type":"string","description":"The field name where error occurred (null for server errors)"},"message":{"type":"string","description":"Description of the returned error"}},"title":"EorWorkersContractsContractIdOffboardingResignationLetterGetResponsesContentApplicationJsonSchemaErrorsItems"},"PreviewResignationLetterRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersContractsContractIdOffboardingResignationLetterGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"PreviewResignationLetterRequestBadRequestError"},"PreviewResignationLetterRequestUnauthorizedError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersContractsContractIdOffboardingResignationLetterGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"PreviewResignationLetterRequestUnauthorizedError"},"PreviewResignationLetterRequestForbiddenError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersContractsContractIdOffboardingResignationLetterGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"PreviewResignationLetterRequestForbiddenError"},"PreviewResignationLetterRequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersContractsContractIdOffboardingResignationLetterGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"PreviewResignationLetterRequestInternalServerError"},"EorContractsContractIdOffboardingResignationPostRequestBodyContentMultipartFormDataSchemaDataReason":{"type":"string","enum":["EMPLOYEE_IS_MOVING_TO_ANOTHER_COUNTRY","MOVING_EMPLOYEE_TO_INTERNAL_ENTITY","MOVING_EMPLOYEE_TO_DEEL_PEO","EMPLOYEE_FOUND_ANOTHER_JOB","EMPLOYEE_NOT_HAPPY_WITH_BENEFITS","EMPLOYEE_NOT_HAPPY_WITH_SALARY","EMPLOYEE_NOT_HAPPY_WITH_THE_ROLE","EMPLOYEE_NOT_HAPPY_WITH_COMPANY_CULTURE","EMPLOYEE_NOT_HAPPY_WITH_DEEL","EMPLOYEE_PROJECT_ENDED","EMPLOYEE_SWITCHING_TO_OTHER_EOR_PROVIDER","EMPLOYEE_LEFT_ROLE_FOR_PERSONAL_MATTERS","EMPLOYEE_MOVING_FROM_EOR_TO_CONTRACTOR_OR_FREELANCE","WORKER_TYPE_CHANGE","DEEL_COLLECTIONS","EMPLOYEE_DID_NOT_TAKE_THE_OFFER","EMPLOYEE_PROVIDED_NO_REASON","OTHER_BUSINESS_REASONS"],"description":"Reason why the contract is being terminated","title":"EorContractsContractIdOffboardingResignationPostRequestBodyContentMultipartFormDataSchemaDataReason"},"EorContractsContractIdOffboardingResignationPostRequestBodyContentMultipartFormDataSchemaDataUsedTimeOffTrackingType":{"type":"string","enum":["ON_PLATFORM","OFF_PLATFORM"],"description":"Type of time off tracking - whether it's tracked on Deel platform or off platform","title":"EorContractsContractIdOffboardingResignationPostRequestBodyContentMultipartFormDataSchemaDataUsedTimeOffTrackingType"},"EorContractsContractIdOffboardingResignationPostRequestBodyContentMultipartFormDataSchemaDataUsedTimeOffOffPlatformUsedTimeOffEntitlementsItems":{"type":"object","properties":{"used":{"type":"number","format":"double","description":"Amount of time off used in the period"},"tracking_period":{"type":"string","format":"date","description":"Start date of the tracking period"},"tracking_period_end_date":{"type":"string","format":"date","description":"End date of the tracking period"}},"required":["used","tracking_period","tracking_period_end_date"],"title":"EorContractsContractIdOffboardingResignationPostRequestBodyContentMultipartFormDataSchemaDataUsedTimeOffOffPlatformUsedTimeOffEntitlementsItems"},"EorContractsContractIdOffboardingResignationPostRequestBodyContentMultipartFormDataSchemaDataUsedTimeOffOffPlatformUsedTimeOffEntitlementUnit":{"type":"string","enum":["BUSINESS_DAY","CALENDAR_DAY","HOUR","WEEK","MONTH","YEAR"],"description":"Unit of measurement for the time off entitlements","title":"EorContractsContractIdOffboardingResignationPostRequestBodyContentMultipartFormDataSchemaDataUsedTimeOffOffPlatformUsedTimeOffEntitlementUnit"},"EorContractsContractIdOffboardingResignationPostRequestBodyContentMultipartFormDataSchemaDataUsedTimeOffOffPlatformUsedTimeOff":{"type":"object","properties":{"entitlements":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingResignationPostRequestBodyContentMultipartFormDataSchemaDataUsedTimeOffOffPlatformUsedTimeOffEntitlementsItems"},"description":"Array of time off entitlements for different tracking periods"},"total_scheduled":{"type":"number","format":"double","description":"Total amount of time off scheduled until the end date"},"entitlement_unit":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingResignationPostRequestBodyContentMultipartFormDataSchemaDataUsedTimeOffOffPlatformUsedTimeOffEntitlementUnit","description":"Unit of measurement for the time off entitlements"}},"required":["entitlements","total_scheduled","entitlement_unit"],"description":"Required when tracking_type is OFF_PLATFORM, null otherwise","title":"EorContractsContractIdOffboardingResignationPostRequestBodyContentMultipartFormDataSchemaDataUsedTimeOffOffPlatformUsedTimeOff"},"EorContractsContractIdOffboardingResignationPostRequestBodyContentMultipartFormDataSchemaDataUsedTimeOff":{"type":"object","properties":{"tracking_type":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingResignationPostRequestBodyContentMultipartFormDataSchemaDataUsedTimeOffTrackingType","description":"Type of time off tracking - whether it's tracked on Deel platform or off platform"},"off_platform_used_time_off":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdOffboardingResignationPostRequestBodyContentMultipartFormDataSchemaDataUsedTimeOffOffPlatformUsedTimeOff"},{"type":"null"}],"description":"Required when tracking_type is OFF_PLATFORM, null otherwise"}},"title":"EorContractsContractIdOffboardingResignationPostRequestBodyContentMultipartFormDataSchemaDataUsedTimeOff"},"EorContractsContractIdOffboardingResignationPostRequestBodyContentMultipartFormDataSchemaDataSeveranceType":{"type":"string","enum":["DAYS","WEEKS","MONTHS","CASH"],"description":"The type of severance selected by the client. It's an optional field","title":"EorContractsContractIdOffboardingResignationPostRequestBodyContentMultipartFormDataSchemaDataSeveranceType"},"EorContractsContractIdOffboardingResignationPostRequestBodyContentMultipartFormDataSchemaDataAdditionalReason":{"type":"string","enum":["MOVING_TO_INTERNAL_ENTITY_WITH_DEEL_GLOBAL_PAYROLL","MOVING_TO_INTERNAL_ENTITY_WITH_OTHER_PROVIDER"],"description":"An additional reason can be provided in case the reason selected is MOVING_EMPLOYEE_TO_INTERNAL_ENTITY","title":"EorContractsContractIdOffboardingResignationPostRequestBodyContentMultipartFormDataSchemaDataAdditionalReason"},"EorContractsContractIdOffboardingResignationPostRequestBodyContentMultipartFormDataSchemaDataEligibleForRehire":{"type":"string","enum":["YES","NO","DONT_KNOW"],"description":"Parameter to inform whether it would be possible for the client to hire the employee again","title":"EorContractsContractIdOffboardingResignationPostRequestBodyContentMultipartFormDataSchemaDataEligibleForRehire"},"EorContractsContractIdOffboardingResignationPostRequestBodyContentMultipartFormDataSchemaData":{"type":"object","properties":{"reason":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingResignationPostRequestBodyContentMultipartFormDataSchemaDataReason","description":"Reason why the contract is being terminated"},"attachments":{"type":"string","format":"binary","description":"This field allows for uploading multiple files at once. Attach any document that is important for the request to terminate the contract. Includes common image formats (JPG, JPEG, PNG, HEIC) and PDF documents"},"is_sensitive":{"type":"boolean","description":"Defines whether the termination is sensitive. In this case, only the person requesting the termination will be able to view the termination, receive emails or notifications."},"reason_detail":{"type":"string","description":"Optional field to describe the reason behind the resignation request"},"used_time_off":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingResignationPostRequestBodyContentMultipartFormDataSchemaDataUsedTimeOff"},"severance_type":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingResignationPostRequestBodyContentMultipartFormDataSchemaDataSeveranceType","description":"The type of severance selected by the client. It's an optional field"},"desired_end_date":{"type":"string","format":"date","description":"The desired end date. If the date is not provided, it will be selected by HRX the closest date possible"},"severance_amount":{"type":"number","format":"double","description":"The amount of severance needed"},"additional_reason":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdOffboardingResignationPostRequestBodyContentMultipartFormDataSchemaDataAdditionalReason"},{"type":"null"}],"description":"An additional reason can be provided in case the reason selected is MOVING_EMPLOYEE_TO_INTERNAL_ENTITY"},"termination_notes":{"type":"array","items":{"type":"string"},"description":"Additional notes can be provided regarding the termination for Deel, like questions and doubts"},"eligible_for_rehire":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdOffboardingResignationPostRequestBodyContentMultipartFormDataSchemaDataEligibleForRehire"},{"type":"null"}],"description":"Parameter to inform whether it would be possible for the client to hire the employee again"},"eligible_for_rehire_reason":{"type":["string","null"],"description":"Describe if the option DONT_KNOW was selected on eligible_for_rehire"},"is_employee_staying_with_deel":{"type":["boolean","null"],"description":"Defines if employee will keep using Deel as provider"}},"required":["reason","used_time_off","is_employee_staying_with_deel"],"title":"EorContractsContractIdOffboardingResignationPostRequestBodyContentMultipartFormDataSchemaData"},"EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataDocumentsSupportingItems":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the file"},"name":{"type":"string","description":"The name of the file"},"type":{"type":"string","description":"The type/extension of the file"},"created_at":{"type":"string","format":"date-time","description":"The date and time the file was created"},"updated_at":{"type":"string","format":"date-time","description":"The date and time the file was updated"},"is_additional_supporting_document":{"type":"boolean","description":"Indicates if this is an additional supporting document added after the initial submission"}},"required":["id","name","type","created_at","updated_at","is_additional_supporting_document"],"title":"EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataDocumentsSupportingItems"},"EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsFilesItems":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the file"},"name":{"type":"string","description":"The name of the file"},"type":{"type":"string","description":"The type/extension of the file"},"created_at":{"type":"string","format":"date-time","description":"The date and time the file was created"},"updated_at":{"type":"string","format":"date-time","description":"The date and time the file was updated"}},"required":["id","name","type","created_at"],"title":"EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsFilesItems"},"EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsStatus":{"type":"string","enum":["AWAITING_REVIEW","AWAITING_FEEDBACK","FEEDBACK_PROVIDED","APPROVED","CHANGES_REQUESTED_BY_CLIENT","CHANGES_REQUESTED_BY_EMPLOYEE","WAIVED_REVIEW","NOT_RESPONDED","CANCELLED"],"description":"The current status of the document review","title":"EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsStatus"},"EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsReviewerType":{"type":"string","enum":["CLIENT","EMPLOYEE"],"description":"The type of reviewer for this document","title":"EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsReviewerType"},"EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the document set shared with the employee."},"files":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsFilesItems"}},"status":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsStatus","description":"The current status of the document review"},"created_at":{"type":"string","format":"date-time","description":"The date and time the document set was created"},"updated_at":{"type":"string","format":"date-time","description":"The date and time the document set was updated"},"reviewed_at":{"type":["string","null"],"format":"date-time","description":"The date and time when the document was reviewed"},"reviewed_by":{"type":["string","null"],"description":"The name of the reviewer for this document. If the reviewer is not an employee, it will be the name of the client"},"reviewer_type":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsReviewerType","description":"The type of reviewer for this document"},"reviewer_feedback":{"type":["string","null"],"description":"Feedback provided by the reviewer"},"notification_instructions":{"type":["string","null"],"description":"HTML instructions for the reviewer notification"},"is_employee_notification_required":{"type":"boolean","description":"Indicates if the employee should be notified about this document review"}},"required":["files","status","reviewer_type","is_employee_notification_required"],"title":"EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItems"},"EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataDocuments":{"type":"object","properties":{"supporting":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataDocumentsSupportingItems"}},"offboarding":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItems"},"description":"Document set shared that requires client or employee review"}},"required":["supporting","offboarding"],"description":"Document management structure for termination workflow including review processes and supporting documents","title":"EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataDocuments"},"EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataRequestDataReason":{"type":"string","enum":["STATUS_CHANGE","RELOCATION","COMPENSATION","RETIREMENT","JOB_ABANDONMENT","WORK_RELATED","PERSONAL","OTHER_OPPORTUNITY","NON_RENEWAL","PROBATION","ASSIGNMENT_ENDED","POSITION_ELIMINATION","FORCE_REDUCTION","DEATH","FOR_CAUSE","PERFORMANCE","MEDICAL","PERFORMANCE_ISSUES","ATTENDANCE_ISSUES","REORGANIZATION_DOWNSIZING_BUDGET_OR_REDUCTION_OF_WORKFORCE","ROLE_BECAME_REDUNDANT_OR_ROLE_CHANGED","OFFER_WAS_REVOKED","EXITING_THE_MARKET","NO_LONGER_WISH_TO_WORK_WITH_DEEL","COMPANY_ACQUIRED","STEALING","MISCONDUCT","FALSIFYING","HARASSMENT","VIOLENCE","REORGANIZATION_DOWNSIZING_BUDGET_OR_REDUCTION_OF_WORKFORCE_OR_ROLE_BECAME_REDUNDANT_OR_ROLE_CHANGED","UNAUTHORIZED_ABSENCES_OR_LACK_OF_ATTENDANCE","STANDARD_RESELLER_PRACTICE","MOVING_EMPLOYEE_TO_INTERNAL_ENTITY","MOVING_EMPLOYEE_TO_DEEL_PEO","OTHER"],"description":"The reason for the termination","title":"EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataRequestDataReason"},"EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsUnit":{"type":"string","enum":["BUSINESS_DAY","CALENDAR_DAY","HOUR"],"description":"The unit of measurement for time off tracking","title":"EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsUnit"},"EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsTrackingPeriodsItems":{"type":"object","properties":{"used":{"type":"number","format":"double","description":"The amount of time off used in this tracking period"},"end_date":{"type":"string","format":"date-time","description":"The end date of the tracking period"},"start_date":{"type":"string","format":"date-time","description":"The start date of the tracking period"}},"required":["used","end_date","start_date"],"title":"EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsTrackingPeriodsItems"},"EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItems":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsUnit","description":"The unit of measurement for time off tracking"},"policy_type":{"type":"string","description":"The type of time-off policy"},"tracking_periods":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsTrackingPeriodsItems"}},"scheduled_until_end_date":{"type":"number","format":"double","description":"The amount of time off scheduled until the end date of the current tracking period"}},"required":["unit","policy_type","tracking_periods","scheduled_until_end_date"],"title":"EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItems"},"EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffAdditionalDetails":{"type":"object","properties":{"notes":{"type":["string","null"],"description":"Additional notes or comments about the time-off data"},"updated_by":{"type":["string","null"],"description":"The person or system that last updated the time-off data"},"last_updated_at":{"type":["string","null"],"format":"date-time","description":"The date and time when the time-off data was last updated"}},"title":"EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffAdditionalDetails"},"EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOff":{"type":"object","properties":{"time_offs":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItems"}},"additional_details":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffAdditionalDetails"},{"type":"null"}]},"is_deel_pto_confirmed":{"type":"boolean","description":"Indicates whether the PTO allocation has been confirmed by Deel's system"}},"required":["time_offs","is_deel_pto_confirmed"],"description":"Time-off usage data including policy information and tracking periods","title":"EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOff"},"EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataRequestDataEligibleForRehire":{"type":"string","enum":["YES","NO","DONT_KNOW"],"description":"Parameter to inform whether it would be possible for the client to hire the employee again","title":"EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataRequestDataEligibleForRehire"},"EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataRequestData":{"type":"object","properties":{"reason":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataRequestDataReason","description":"The reason for the termination"},"end_date":{"type":["string","null"],"format":"date-time","description":"The definitive contract end date"},"reason_detail":{"type":["string","null"],"description":"Optional field to describe the reason behind the resignation request"},"used_time_off":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOff","description":"Time-off usage data including policy information and tracking periods"},"desired_end_date":{"type":["string","null"],"format":"date","description":"The desired end date. If the date is not provided, it will be selected by HRX the closest date possible"},"eligible_for_rehire":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataRequestDataEligibleForRehire"},{"type":"null"}],"description":"Parameter to inform whether it would be possible for the client to hire the employee again"},"eligible_for_rehire_reason":{"type":["string","null"],"description":"Describe if the option DONT_KNOW was selected on eligible_for_rehire"}},"title":"EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataRequestData"},"EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the offboarding request"},"end_date":{"type":["string","null"],"format":"date-time","description":"The definitive contract end date"},"documents":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataDocuments","description":"Document management structure for termination workflow including review processes and supporting documents"},"created_at":{"type":"string","format":"date-time","description":"The date and time the offboarding request was created"},"updated_at":{"type":"string","format":"date-time","description":"The date and time the offboarding request was updated"},"contract_id":{"type":"string","description":"The unique identifier of the employee contract."},"is_sensitive":{"type":"boolean","description":"Indicates if the offboarding request is sensitive. This is used to restrict access to the request only to the requester and the HRX team."},"request_data":{"oneOf":[{"$ref":"#/components/schemas/EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaDataRequestData"},{"type":"null"}]},"desired_end_date":{"type":["string","null"],"format":"date-time","description":"The desired end date. If the date is not provided, it will be selected by HRX the closest date possible"}},"title":"EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaData"},"eor-worker-offboarding_createEmployeeResignation_Response_201":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"eor-worker-offboarding_createEmployeeResignation_Response_201"},"EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string","description":"Error code of the handler which produced the returned error"},"field":{"type":"string","description":"The field name where error occurred (null for server errors)"},"message":{"type":"string","description":"Description of the returned error"}},"title":"EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaErrorsItems"},"RequestContractResignationRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"RequestContractResignationRequestBadRequestError"},"RequestContractResignationRequestUnauthorizedError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"RequestContractResignationRequestUnauthorizedError"},"RequestContractResignationRequestForbiddenError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"RequestContractResignationRequestForbiddenError"},"RequestContractResignationRequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdOffboardingResignationPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"RequestContractResignationRequestInternalServerError"},"EorWorkersResignationsGetParametersStatus":{"type":"string","enum":["AWAITING_SIGNATURE","SIGNED"],"title":"EorWorkersResignationsGetParametersStatus"},"EorWorkersResignationsGetResponsesContentApplicationJsonSchemaDataItemsStatus":{"type":"string","enum":["COMPLETED","AWAITING_REFUND","PROCESSING","AWAITING_TRIAGE","AWAITING_PROCESSING","CANCELLED","AWAITING_PTO"],"description":"The status of the resignation","title":"EorWorkersResignationsGetResponsesContentApplicationJsonSchemaDataItemsStatus"},"EorWorkersResignationsGetResponsesContentApplicationJsonSchemaDataItemsResignationLetterStatus":{"type":"string","enum":["AWAITING_SIGNATURE","SIGNED"],"description":"The status of the resignation letter","title":"EorWorkersResignationsGetResponsesContentApplicationJsonSchemaDataItemsResignationLetterStatus"},"EorWorkersResignationsGetResponsesContentApplicationJsonSchemaDataItemsResignationLetter":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the resignation letter"},"status":{"$ref":"#/components/schemas/EorWorkersResignationsGetResponsesContentApplicationJsonSchemaDataItemsResignationLetterStatus","description":"The status of the resignation letter"},"signature":{"type":["string","null"],"description":"The signature of the resignation letter"},"signed_at":{"type":["string","null"],"format":"date-time","description":"The date and time the resignation letter was signed"},"created_at":{"type":"string","format":"date-time","description":"The date and time the resignation letter was created"},"updated_at":{"type":"string","format":"date-time","description":"The date and time the resignation letter was updated"}},"required":["id","status","signature","signed_at","created_at","updated_at"],"title":"EorWorkersResignationsGetResponsesContentApplicationJsonSchemaDataItemsResignationLetter"},"EorWorkersResignationsGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the resignation"},"status":{"$ref":"#/components/schemas/EorWorkersResignationsGetResponsesContentApplicationJsonSchemaDataItemsStatus","description":"The status of the resignation"},"end_date":{"type":["string","null"],"format":"date-time","description":"The confirmed end date of the resignation"},"created_at":{"type":"string","format":"date-time","description":"The date and time the resignation was created"},"updated_at":{"type":"string","format":"date-time","description":"The date and time the resignation was updated"},"contract_id":{"type":"string","description":"The unique identifier of the employee contract."},"desired_end_date":{"type":["string","null"],"format":"date-time","description":"The desired end date of the resignation"},"resignation_letter":{"oneOf":[{"$ref":"#/components/schemas/EorWorkersResignationsGetResponsesContentApplicationJsonSchemaDataItemsResignationLetter"},{"type":"null"}]}},"required":["id","status","end_date","created_at","updated_at","contract_id","desired_end_date","resignation_letter"],"title":"EorWorkersResignationsGetResponsesContentApplicationJsonSchemaDataItems"},"eor-worker-offboarding_getEmployeeResignations_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersResignationsGetResponsesContentApplicationJsonSchemaDataItems"}}},"required":["data"],"title":"eor-worker-offboarding_getEmployeeResignations_Response_200"},"EorWorkersResignationsGetResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string","description":"Error code of the handler which produced the returned error"},"field":{"type":"string","description":"The field name where error occurred (null for server errors)"},"message":{"type":"string","description":"Description of the returned error"}},"title":"EorWorkersResignationsGetResponsesContentApplicationJsonSchemaErrorsItems"},"RetrieveWorkerResignationsRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersResignationsGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"RetrieveWorkerResignationsRequestBadRequestError"},"RetrieveWorkerResignationsRequestUnauthorizedError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersResignationsGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"RetrieveWorkerResignationsRequestUnauthorizedError"},"RetrieveWorkerResignationsRequestForbiddenError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersResignationsGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"RetrieveWorkerResignationsRequestForbiddenError"},"RetrieveWorkerResignationsRequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersResignationsGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"RetrieveWorkerResignationsRequestInternalServerError"},"EorWorkersContractsContractIdOffboardingResignationLetterSignPostRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"signature":{"type":"string","description":"Employee signature"}},"title":"EorWorkersContractsContractIdOffboardingResignationLetterSignPostRequestBodyContentApplicationJsonSchemaData"},"EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataDocumentsSupportingItems":{"type":"object","properties":{"id":{"type":"string","format":"cuid","description":"The unique identifier of the file"},"name":{"type":"string","description":"The name of the file"},"type":{"type":"string","description":"The type/extension of the file"},"created_at":{"type":"string","format":"date-time","description":"The date and time the file was created"},"updated_at":{"type":"string","format":"date-time","description":"The date and time the file was updated"},"is_additional_supporting_document":{"type":"boolean","description":"Indicates if this is an additional supporting document added after the initial submission"}},"required":["id","name","type","created_at","updated_at","is_additional_supporting_document"],"title":"EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataDocumentsSupportingItems"},"EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsFilesItems":{"type":"object","properties":{"id":{"type":"string","format":"cuid","description":"The unique identifier of the file"},"name":{"type":"string","description":"The name of the file"},"type":{"type":"string","description":"The type/extension of the file"},"created_at":{"type":"string","format":"date-time","description":"The date and time the file was created"},"updated_at":{"type":"string","format":"date-time","description":"The date and time the file was updated"}},"required":["id","name","type","created_at"],"title":"EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsFilesItems"},"EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsStatus":{"type":"string","enum":["AWAITING_REVIEW","AWAITING_FEEDBACK","FEEDBACK_PROVIDED","APPROVED","CHANGES_REQUESTED_BY_CLIENT","CHANGES_REQUESTED_BY_EMPLOYEE","WAIVED_REVIEW","NOT_RESPONDED","CANCELLED"],"description":"The current status of the document review","title":"EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsStatus"},"EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsReviewerType":{"type":"string","enum":["CLIENT","EMPLOYEE"],"description":"The type of reviewer for this document","title":"EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsReviewerType"},"EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the document set shared with the employee."},"files":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsFilesItems"}},"status":{"$ref":"#/components/schemas/EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsStatus","description":"The current status of the document review"},"created_at":{"type":"string","format":"date-time","description":"The date and time the document set was created"},"updated_at":{"type":"string","format":"date-time","description":"The date and time the document set was updated"},"reviewed_at":{"type":["string","null"],"format":"date-time","description":"The date and time when the document was reviewed"},"reviewed_by":{"type":["string","null"],"description":"The name of the reviewer for this document. If the reviewer is not an employee, it will be the name of the client"},"reviewer_type":{"$ref":"#/components/schemas/EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsReviewerType","description":"The type of reviewer for this document"},"reviewer_feedback":{"type":["string","null"],"description":"Feedback provided by the reviewer"},"notification_instructions":{"type":["string","null"],"description":"HTML instructions for the reviewer notification"},"is_employee_notification_required":{"type":"boolean","description":"Indicates if the employee should be notified about this document review"}},"required":["files","status","reviewer_type","is_employee_notification_required"],"title":"EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItems"},"EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataDocumentsResignationLetter":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the resignation letter"},"signature":{"type":["string","null"],"description":"The signature of the resignation letter"},"signed_at":{"type":["string","null"],"format":"date-time","description":"The date and time when the resignation letter was signed"},"created_at":{"type":"string","format":"date-time","description":"The date and time the resignation letter was created"},"updated_at":{"type":"string","format":"date-time","description":"The date and time the resignation letter was updated"}},"title":"EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataDocumentsResignationLetter"},"EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataDocuments":{"type":"object","properties":{"supporting":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataDocumentsSupportingItems"}},"offboarding":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItems"},"description":"Document set shared that requires client or employee review"},"resignation_letter":{"oneOf":[{"$ref":"#/components/schemas/EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataDocumentsResignationLetter"},{"type":"null"}]}},"required":["supporting","offboarding"],"description":"Document management structure for termination workflow including review processes and supporting documents","title":"EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataDocuments"},"EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataRequestDataReason":{"type":"string","enum":["STATUS_CHANGE","RELOCATION","COMPENSATION","RETIREMENT","JOB_ABANDONMENT","WORK_RELATED","PERSONAL","OTHER_OPPORTUNITY","NON_RENEWAL","PROBATION","ASSIGNMENT_ENDED","POSITION_ELIMINATION","FORCE_REDUCTION","DEATH","FOR_CAUSE","PERFORMANCE","MEDICAL","PERFORMANCE_ISSUES","ATTENDANCE_ISSUES","REORGANIZATION_DOWNSIZING_BUDGET_OR_REDUCTION_OF_WORKFORCE","ROLE_BECAME_REDUNDANT_OR_ROLE_CHANGED","OFFER_WAS_REVOKED","EXITING_THE_MARKET","NO_LONGER_WISH_TO_WORK_WITH_DEEL","COMPANY_ACQUIRED","STEALING","MISCONDUCT","FALSIFYING","HARASSMENT","VIOLENCE","REORGANIZATION_DOWNSIZING_BUDGET_OR_REDUCTION_OF_WORKFORCE_OR_ROLE_BECAME_REDUNDANT_OR_ROLE_CHANGED","UNAUTHORIZED_ABSENCES_OR_LACK_OF_ATTENDANCE","STANDARD_RESELLER_PRACTICE","MOVING_EMPLOYEE_TO_INTERNAL_ENTITY","MOVING_EMPLOYEE_TO_DEEL_PEO","OTHER"],"description":"The reason for the termination","title":"EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataRequestDataReason"},"EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsUnit":{"type":"string","enum":["BUSINESS_DAY","CALENDAR_DAY","HOUR"],"description":"The unit of measurement for time off tracking","title":"EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsUnit"},"EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsTrackingPeriodsItems":{"type":"object","properties":{"used":{"type":"number","format":"double","description":"The amount of time off used in this tracking period"},"end_date":{"type":"string","format":"date-time","description":"The end date of the tracking period"},"start_date":{"type":"string","format":"date-time","description":"The start date of the tracking period"}},"required":["used","end_date","start_date"],"title":"EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsTrackingPeriodsItems"},"EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItems":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsUnit","description":"The unit of measurement for time off tracking"},"policy_type":{"type":"string","description":"The type of time-off policy"},"tracking_periods":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsTrackingPeriodsItems"}},"scheduled_until_end_date":{"type":"number","format":"double","description":"The amount of time off scheduled until the end date of the current tracking period"}},"required":["unit","policy_type","tracking_periods","scheduled_until_end_date"],"title":"EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItems"},"EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffAdditionalDetails":{"type":"object","properties":{"notes":{"type":["string","null"],"description":"Additional notes or comments about the time-off data"},"updated_by":{"type":["string","null"],"description":"The person or system that last updated the time-off data"},"last_updated_at":{"type":["string","null"],"format":"date-time","description":"The date and time when the time-off data was last updated"}},"title":"EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffAdditionalDetails"},"EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOff":{"type":"object","properties":{"time_offs":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItems"}},"additional_details":{"oneOf":[{"$ref":"#/components/schemas/EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffAdditionalDetails"},{"type":"null"}]},"is_deel_pto_confirmed":{"type":"boolean","description":"Indicates whether the PTO allocation has been confirmed by Deel's system"}},"required":["time_offs","is_deel_pto_confirmed"],"description":"Time-off usage data including policy information and tracking periods","title":"EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOff"},"EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataRequestDataEligibleForRehire":{"type":"string","enum":["YES","NO","DONT_KNOW"],"description":"Parameter to inform whether it would be possible for the client to hire the employee again","title":"EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataRequestDataEligibleForRehire"},"EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataRequestData":{"type":"object","properties":{"reason":{"$ref":"#/components/schemas/EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataRequestDataReason","description":"The reason for the termination"},"end_date":{"type":["string","null"],"format":"date-time","description":"The definitive contract end date"},"reason_detail":{"type":["string","null"],"description":"Optional field to describe the reason behind the resignation request"},"used_time_off":{"$ref":"#/components/schemas/EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOff","description":"Time-off usage data including policy information and tracking periods"},"desired_end_date":{"type":["string","null"],"format":"date","description":"The desired end date. If the date is not provided, it will be selected by HRX the closest date possible"},"eligible_for_rehire":{"oneOf":[{"$ref":"#/components/schemas/EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataRequestDataEligibleForRehire"},{"type":"null"}],"description":"Parameter to inform whether it would be possible for the client to hire the employee again"},"eligible_for_rehire_reason":{"type":["string","null"],"description":"Describe if the option DONT_KNOW was selected on eligible_for_rehire"}},"title":"EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataRequestData"},"EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the offboarding request"},"end_date":{"type":["string","null"],"format":"date-time","description":"The definitive contract end date"},"documents":{"$ref":"#/components/schemas/EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataDocuments","description":"Document management structure for termination workflow including review processes and supporting documents"},"created_at":{"type":"string","format":"date-time","description":"The date and time the offboarding request was created"},"updated_at":{"type":"string","format":"date-time","description":"The date and time the offboarding request was updated"},"contract_id":{"type":"string","description":"The unique identifier of the employee contract."},"is_sensitive":{"type":"boolean","description":"Indicates if the offboarding request is sensitive. This is used to restrict access to the request only to the requester and the HRX team."},"request_data":{"oneOf":[{"$ref":"#/components/schemas/EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaDataRequestData"},{"type":"null"}]},"desired_end_date":{"type":["string","null"],"format":"date-time","description":"The desired end date. If the date is not provided, it will be selected by HRX the closest date possible"}},"title":"EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaData"},"eor-worker-offboarding_signEmployeeResignationLetter_Response_201":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"eor-worker-offboarding_signEmployeeResignationLetter_Response_201"},"EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string","description":"Error code of the handler which produced the returned error"},"field":{"type":"string","description":"The field name where error occurred (null for server errors)"},"message":{"type":"string","description":"Description of the returned error"}},"title":"EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaErrorsItems"},"SignResignationLetterRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"SignResignationLetterRequestBadRequestError"},"SignResignationLetterRequestUnauthorizedError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"SignResignationLetterRequestUnauthorizedError"},"SignResignationLetterRequestForbiddenError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"SignResignationLetterRequestForbiddenError"},"SignResignationLetterRequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersContractsContractIdOffboardingResignationLetterSignPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"SignResignationLetterRequestInternalServerError"},"EorWorkersContractsContractIdOffboardingPostRequestBodyContentMultipartFormDataSchemaDataReason":{"type":"string","enum":["EMPLOYEE_IS_MOVING_TO_ANOTHER_COUNTRY","MOVING_EMPLOYEE_TO_INTERNAL_ENTITY","MOVING_EMPLOYEE_TO_DEEL_PEO","EMPLOYEE_FOUND_ANOTHER_JOB","EMPLOYEE_NOT_HAPPY_WITH_BENEFITS","EMPLOYEE_NOT_HAPPY_WITH_SALARY","EMPLOYEE_NOT_HAPPY_WITH_THE_ROLE","EMPLOYEE_NOT_HAPPY_WITH_COMPANY_CULTURE","EMPLOYEE_NOT_HAPPY_WITH_DEEL","EMPLOYEE_PROJECT_ENDED","EMPLOYEE_SWITCHING_TO_OTHER_EOR_PROVIDER","EMPLOYEE_LEFT_ROLE_FOR_PERSONAL_MATTERS","EMPLOYEE_MOVING_FROM_EOR_TO_CONTRACTOR_OR_FREELANCE","WORKER_TYPE_CHANGE","PREFERRED_NOT_TO_SAY"],"description":"The reason for the employee's resignation","title":"EorWorkersContractsContractIdOffboardingPostRequestBodyContentMultipartFormDataSchemaDataReason"},"EorWorkersContractsContractIdOffboardingPostRequestBodyContentMultipartFormDataSchemaData":{"type":"object","properties":{"reason":{"$ref":"#/components/schemas/EorWorkersContractsContractIdOffboardingPostRequestBodyContentMultipartFormDataSchemaDataReason","description":"The reason for the employee's resignation"},"signature":{"type":"string","description":"Employee signature"},"reason_detail":{"type":"string","description":"Additional details explaining the resignation reason"},"desired_end_date":{"type":"string","format":"date","description":"The employee's desired last day of work in YYYY-MM-DD format"},"supporting_documents":{"type":"string","format":"binary","description":"This field allows for uploading multiple files at once. Includes common image formats (JPG, JPEG, PNG, HEIC) and PDF documents."}},"required":["reason","signature","desired_end_date"],"title":"EorWorkersContractsContractIdOffboardingPostRequestBodyContentMultipartFormDataSchemaData"},"EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataDocumentsSupportingItems":{"type":"object","properties":{"id":{"type":"string","format":"cuid","description":"The unique identifier of the file"},"name":{"type":"string","description":"The name of the file"},"type":{"type":"string","description":"The type/extension of the file"},"created_at":{"type":"string","format":"date-time","description":"The date and time the file was created"},"updated_at":{"type":"string","format":"date-time","description":"The date and time the file was updated"},"is_additional_supporting_document":{"type":"boolean","description":"Indicates if this is an additional supporting document added after the initial submission"}},"required":["id","name","type","created_at","updated_at","is_additional_supporting_document"],"title":"EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataDocumentsSupportingItems"},"EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsFilesItems":{"type":"object","properties":{"id":{"type":"string","format":"cuid","description":"The unique identifier of the file"},"name":{"type":"string","description":"The name of the file"},"type":{"type":"string","description":"The type/extension of the file"},"created_at":{"type":"string","format":"date-time","description":"The date and time the file was created"},"updated_at":{"type":"string","format":"date-time","description":"The date and time the file was updated"}},"required":["id","name","type","created_at"],"title":"EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsFilesItems"},"EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsStatus":{"type":"string","enum":["AWAITING_REVIEW","AWAITING_FEEDBACK","FEEDBACK_PROVIDED","APPROVED","CHANGES_REQUESTED_BY_CLIENT","CHANGES_REQUESTED_BY_EMPLOYEE","WAIVED_REVIEW","NOT_RESPONDED","CANCELLED"],"description":"The current status of the document review","title":"EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsStatus"},"EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsReviewerType":{"type":"string","enum":["CLIENT","EMPLOYEE"],"description":"The type of reviewer for this document","title":"EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsReviewerType"},"EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the document set shared with the employee."},"files":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsFilesItems"}},"status":{"$ref":"#/components/schemas/EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsStatus","description":"The current status of the document review"},"created_at":{"type":"string","format":"date-time","description":"The date and time the document set was created"},"updated_at":{"type":"string","format":"date-time","description":"The date and time the document set was updated"},"reviewed_at":{"type":["string","null"],"format":"date-time","description":"The date and time when the document was reviewed"},"reviewed_by":{"type":["string","null"],"description":"The name of the reviewer for this document. If the reviewer is not an employee, it will be the name of the client"},"reviewer_type":{"$ref":"#/components/schemas/EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItemsReviewerType","description":"The type of reviewer for this document"},"reviewer_feedback":{"type":["string","null"],"description":"Feedback provided by the reviewer"},"notification_instructions":{"type":["string","null"],"description":"HTML instructions for the reviewer notification"},"is_employee_notification_required":{"type":"boolean","description":"Indicates if the employee should be notified about this document review"}},"required":["files","status","reviewer_type","is_employee_notification_required"],"title":"EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItems"},"EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataDocuments":{"type":"object","properties":{"supporting":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataDocumentsSupportingItems"}},"offboarding":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataDocumentsOffboardingItems"},"description":"Document set shared that requires client or employee review"}},"required":["supporting","offboarding"],"description":"Document management structure for termination workflow including review processes and supporting documents","title":"EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataDocuments"},"EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataRequestDataReason":{"type":"string","enum":["STATUS_CHANGE","RELOCATION","COMPENSATION","RETIREMENT","JOB_ABANDONMENT","WORK_RELATED","PERSONAL","OTHER_OPPORTUNITY","NON_RENEWAL","PROBATION","ASSIGNMENT_ENDED","POSITION_ELIMINATION","FORCE_REDUCTION","DEATH","FOR_CAUSE","PERFORMANCE","MEDICAL","PERFORMANCE_ISSUES","ATTENDANCE_ISSUES","REORGANIZATION_DOWNSIZING_BUDGET_OR_REDUCTION_OF_WORKFORCE","ROLE_BECAME_REDUNDANT_OR_ROLE_CHANGED","OFFER_WAS_REVOKED","EXITING_THE_MARKET","NO_LONGER_WISH_TO_WORK_WITH_DEEL","COMPANY_ACQUIRED","STEALING","MISCONDUCT","FALSIFYING","HARASSMENT","VIOLENCE","REORGANIZATION_DOWNSIZING_BUDGET_OR_REDUCTION_OF_WORKFORCE_OR_ROLE_BECAME_REDUNDANT_OR_ROLE_CHANGED","UNAUTHORIZED_ABSENCES_OR_LACK_OF_ATTENDANCE","STANDARD_RESELLER_PRACTICE","MOVING_EMPLOYEE_TO_INTERNAL_ENTITY","MOVING_EMPLOYEE_TO_DEEL_PEO","OTHER"],"description":"The reason for the termination","title":"EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataRequestDataReason"},"EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsUnit":{"type":"string","enum":["BUSINESS_DAY","CALENDAR_DAY","HOUR"],"description":"The unit of measurement for time off tracking","title":"EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsUnit"},"EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsTrackingPeriodsItems":{"type":"object","properties":{"used":{"type":"number","format":"double","description":"The amount of time off used in this tracking period"},"end_date":{"type":"string","format":"date-time","description":"The end date of the tracking period"},"start_date":{"type":"string","format":"date-time","description":"The start date of the tracking period"}},"required":["used","end_date","start_date"],"title":"EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsTrackingPeriodsItems"},"EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItems":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsUnit","description":"The unit of measurement for time off tracking"},"policy_type":{"type":"string","description":"The type of time-off policy"},"tracking_periods":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItemsTrackingPeriodsItems"}},"scheduled_until_end_date":{"type":"number","format":"double","description":"The amount of time off scheduled until the end date of the current tracking period"}},"required":["unit","policy_type","tracking_periods","scheduled_until_end_date"],"title":"EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItems"},"EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffAdditionalDetails":{"type":"object","properties":{"notes":{"type":["string","null"],"description":"Additional notes or comments about the time-off data"},"updated_by":{"type":["string","null"],"description":"The person or system that last updated the time-off data"},"last_updated_at":{"type":["string","null"],"format":"date-time","description":"The date and time when the time-off data was last updated"}},"title":"EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffAdditionalDetails"},"EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOff":{"type":"object","properties":{"time_offs":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffTimeOffsItems"}},"additional_details":{"oneOf":[{"$ref":"#/components/schemas/EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOffAdditionalDetails"},{"type":"null"}]},"is_deel_pto_confirmed":{"type":"boolean","description":"Indicates whether the PTO allocation has been confirmed by Deel's system"}},"required":["time_offs","is_deel_pto_confirmed"],"description":"Time-off usage data including policy information and tracking periods","title":"EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOff"},"EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataRequestDataEligibleForRehire":{"type":"string","enum":["YES","NO","DONT_KNOW"],"description":"Parameter to inform whether it would be possible for the client to hire the employee again","title":"EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataRequestDataEligibleForRehire"},"EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataRequestData":{"type":"object","properties":{"reason":{"$ref":"#/components/schemas/EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataRequestDataReason","description":"The reason for the termination"},"end_date":{"type":["string","null"],"format":"date-time","description":"The definitive contract end date"},"reason_detail":{"type":["string","null"],"description":"Optional field to describe the reason behind the resignation request"},"used_time_off":{"$ref":"#/components/schemas/EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataRequestDataUsedTimeOff","description":"Time-off usage data including policy information and tracking periods"},"desired_end_date":{"type":["string","null"],"format":"date","description":"The desired end date. If the date is not provided, it will be selected by HRX the closest date possible"},"eligible_for_rehire":{"oneOf":[{"$ref":"#/components/schemas/EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataRequestDataEligibleForRehire"},{"type":"null"}],"description":"Parameter to inform whether it would be possible for the client to hire the employee again"},"eligible_for_rehire_reason":{"type":["string","null"],"description":"Describe if the option DONT_KNOW was selected on eligible_for_rehire"}},"title":"EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataRequestData"},"EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the offboarding request"},"end_date":{"type":["string","null"],"format":"date-time","description":"The definitive contract end date"},"documents":{"$ref":"#/components/schemas/EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataDocuments","description":"Document management structure for termination workflow including review processes and supporting documents"},"created_at":{"type":"string","format":"date-time","description":"The date and time the offboarding request was created"},"updated_at":{"type":"string","format":"date-time","description":"The date and time the offboarding request was updated"},"contract_id":{"type":"string","description":"The unique identifier of the employee contract."},"is_sensitive":{"type":"boolean","description":"Indicates if the offboarding request is sensitive. This is used to restrict access to the request only to the requester and the HRX team."},"request_data":{"oneOf":[{"$ref":"#/components/schemas/EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaDataRequestData"},{"type":"null"}]},"desired_end_date":{"type":["string","null"],"format":"date-time","description":"The desired end date. If the date is not provided, it will be selected by HRX the closest date possible"}},"title":"EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaData"},"eor-worker-offboarding_submitEORWorkerResignation_Response_201":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"eor-worker-offboarding_submitEORWorkerResignation_Response_201"},"EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string","description":"Error code of the handler which produced the returned error"},"field":{"type":"string","description":"The field name where error occurred (null for server errors)"},"message":{"type":"string","description":"Description of the returned error"}},"title":"EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaErrorsItems"},"SubmitEorWorkerResignationRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"SubmitEorWorkerResignationRequestBadRequestError"},"SubmitEorWorkerResignationRequestUnauthorizedError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"SubmitEorWorkerResignationRequestUnauthorizedError"},"SubmitEorWorkerResignationRequestForbiddenError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"SubmitEorWorkerResignationRequestForbiddenError"},"SubmitEorWorkerResignationRequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorWorkersContractsContractIdOffboardingPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"SubmitEorWorkerResignationRequestInternalServerError"},"EorWorkersWorkerIdPayslipsPayslipIdDownloadGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"url":{"type":"string","description":"The URL to download the payslip PDF."}},"required":["url"],"title":"EorWorkersWorkerIdPayslipsPayslipIdDownloadGetResponsesContentApplicationJsonSchemaData"},"eor-worker-payslips_getWorkerPayslipsDownload_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorWorkersWorkerIdPayslipsPayslipIdDownloadGetResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"eor-worker-payslips_getWorkerPayslipsDownload_Response_200"},"EquitiesTokensTaxEventsPostRequestBodyContentApplicationJsonSchemaDataMethodOfTaxCoverage":{"type":"string","enum":["AD_HOC","BIK_REPORTING_ONLY","BIK_WITHHOLDING_AT_SOURCE_CLIENT","BIK_WITHHOLDING_AT_SOURCE_CLIENT_REVERSE","BIK_WITHHOLDING_GROSSED_UP_BONUS","BIK_WITHHOLDING_NET_SETTLEMENT","BIK_WITHHOLDING_SALARY_DEDUCTION","BIK_WITHHOLDING_WORKER","NO_BIK_NO_WITHHOLDING"],"description":"The method used to cover the taxes","title":"EquitiesTokensTaxEventsPostRequestBodyContentApplicationJsonSchemaDataMethodOfTaxCoverage"},"EquitiesTokensTaxEventsPostRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"fx_rate":{"type":"number","format":"double","description":"The exchange rate used to convert the local currency to the payroll currency"},"tax_rate":{"type":"number","format":"double","description":"The tax rate applied to the benefit in kind"},"unit_fmv":{"type":"number","format":"double","description":"The fair market value of the equity/token grant at the time of the event"},"event_date":{"type":"string","format":"date","description":"The date of the event"},"sale_price":{"type":"number","format":"double","description":"The price at which the equity/token was sold"},"contract_id":{"type":"string","description":"The unique identifier of the contract of the employee who received the equity/token grant"},"gross_value":{"type":"number","format":"double","description":"The gross value of the equity/token grant"},"plan_currency":{"type":"string","description":"The currency in which the equity/token grant was issued"},"exercise_price":{"type":"number","format":"double","description":"The price at which the equity/token was exercised"},"equity_grant_id":{"type":"string","description":"The unique identifier of the equity/token grant - optional in case you don't have remove the property"},"settlement_date":{"type":"string","format":"date","description":"The date of the settlement"},"payroll_currency":{"type":"string","description":"The currency in which the payroll is processed"},"tax_jurisdiction":{"type":"string","description":"The tax jurisdiction in which the equity/token grant was issued"},"transaction_fees":{"type":"number","format":"double","description":"The fees associated with the transaction"},"quantity_remaining":{"type":"number","format":"double","description":"The quantity of equity/token that remains"},"taxable_gain_or_loss":{"type":"number","format":"double","description":"The taxable gain or loss"},"total_exercise_price":{"type":"number","format":"double","description":"The total exercise price"},"total_taxes_withheld":{"type":"number","format":"double","description":"The total amount of taxes withheld"},"method_of_tax_coverage":{"$ref":"#/components/schemas/EquitiesTokensTaxEventsPostRequestBodyContentApplicationJsonSchemaDataMethodOfTaxCoverage","description":"The method used to cover the taxes"},"quantity_withheld_or_sold":{"type":"number","format":"double","description":"The quantity of equity/token that was withheld or sold"},"withheld_tax_local_currency":{"type":"number","format":"double","description":"The tax withheld in the local currency"},"benefit_in_kind_local_currency":{"type":"number","format":"double","description":"The benefit in kind in the local currency"},"quantity_exercised_or_released":{"type":"number","format":"double","description":"The quantity of equity/token that was exercised or released"}},"required":["fx_rate","contract_id","plan_currency","settlement_date","payroll_currency","tax_jurisdiction","taxable_gain_or_loss","total_taxes_withheld","method_of_tax_coverage","withheld_tax_local_currency","benefit_in_kind_local_currency"],"title":"EquitiesTokensTaxEventsPostRequestBodyContentApplicationJsonSchemaData"},"EquitiesTokensTaxEventsPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"the id of the equity/token tax event generated"},"created_at":{"type":"string","format":"date-time","description":"the date and time when the equity/token tax event was created"}},"title":"EquitiesTokensTaxEventsPostResponsesContentApplicationJsonSchemaData"},"Equity Tokens_createEquityOrTokenTaxEvent_Response_201":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EquitiesTokensTaxEventsPostResponsesContentApplicationJsonSchemaData"}},"title":"Equity Tokens_createEquityOrTokenTaxEvent_Response_201"},"EquitiesTokensTaxEventsPostResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string","description":"return code error"},"field":{"type":"string","description":"field that caused the error"},"message":{"type":"string","description":"description of the error"}},"title":"EquitiesTokensTaxEventsPostResponsesContentApplicationJsonSchemaErrorsItems"},"CreateEquityOrTokenTaxEventRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EquitiesTokensTaxEventsPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"CreateEquityOrTokenTaxEventRequestBadRequestError"},"FormsEorCreateContractDefinitionsPostRequestBodyContentApplicationJsonSchemaDataCountriesItems":{"type":"object","properties":{"state":{"type":"string","description":"The selected state code of the contract. This is only required for countries that specify it."},"country_code":{"type":"string","description":"Two-letter country code in ISO 3166-1 alpha-2 format"}},"required":["country_code"],"title":"FormsEorCreateContractDefinitionsPostRequestBodyContentApplicationJsonSchemaDataCountriesItems"},"FormsEorCreateContractDefinitionsPostRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"countries":{"type":"array","items":{"$ref":"#/components/schemas/FormsEorCreateContractDefinitionsPostRequestBodyContentApplicationJsonSchemaDataCountriesItems"},"description":"Array of countries for which to fetch quote forms. Maximum 10 countries per request."},"start_date":{"type":"string","format":"date","description":"The selected start date of the contract in ISO 8601 formatted date string."},"work_hours_per_week":{"type":"integer","description":"The selected number of work hours per week."},"contract_duration_in_days":{"type":"integer","description":"The contract duration in days for definite contracts."}},"required":["countries"],"title":"FormsEorCreateContractDefinitionsPostRequestBodyContentApplicationJsonSchemaData"},"FormsEorCreateContractDefinitionsPostResponsesContentApplicationJsonSchemaDataItemsPagesItemsSectionsItemsQuestionsItemsType":{"type":"string","enum":["FreeText","Paragraph","SingleSelection","MultiSelection","Address","PhoneNumber","DocumentUpload","Number","Dropdown","DatePicker","Email"],"description":"Type of the question.","title":"FormsEorCreateContractDefinitionsPostResponsesContentApplicationJsonSchemaDataItemsPagesItemsSectionsItemsQuestionsItemsType"},"FormsEorCreateContractDefinitionsPostResponsesContentApplicationJsonSchemaDataItemsPagesItemsSectionsItemsQuestionsItemsRulesItemsSource":{"type":"object","properties":{"url":{"type":"string","description":"API endpoint providing dynamic options."},"definition":{"type":"string","description":"Reference URL for API documentation."},"description":{"type":"string","description":"Description of the data source."}},"description":"Defines dynamic data source for the question.","title":"FormsEorCreateContractDefinitionsPostResponsesContentApplicationJsonSchemaDataItemsPagesItemsSectionsItemsQuestionsItemsRulesItemsSource"},"FormsEorCreateContractDefinitionsPostResponsesContentApplicationJsonSchemaDataItemsPagesItemsSectionsItemsQuestionsItemsRulesItemsOptionsItems":{"type":"object","properties":{"title":{"type":"string","description":"Display text for the option."},"value":{"type":["string","null"],"description":"Value associated with the option."}},"title":"FormsEorCreateContractDefinitionsPostResponsesContentApplicationJsonSchemaDataItemsPagesItemsSectionsItemsQuestionsItemsRulesItemsOptionsItems"},"FormsEorCreateContractDefinitionsPostResponsesContentApplicationJsonSchemaDataItemsPagesItemsSectionsItemsQuestionsItemsRulesItemsRequiresItemsValue":{"oneOf":[{"type":"string"},{"type":"number","format":"double"},{"type":"boolean"}],"description":"Expected value for the condition.","title":"FormsEorCreateContractDefinitionsPostResponsesContentApplicationJsonSchemaDataItemsPagesItemsSectionsItemsQuestionsItemsRulesItemsRequiresItemsValue"},"FormsEorCreateContractDefinitionsPostResponsesContentApplicationJsonSchemaDataItemsPagesItemsSectionsItemsQuestionsItemsRulesItemsRequiresItems":{"type":"object","properties":{"key":{"type":"string","description":"Key of the dependent field."},"value":{"$ref":"#/components/schemas/FormsEorCreateContractDefinitionsPostResponsesContentApplicationJsonSchemaDataItemsPagesItemsSectionsItemsQuestionsItemsRulesItemsRequiresItemsValue","description":"Expected value for the condition."},"operator":{"type":["string","null"],"description":"Comparison operator (e.g., 'eq', 'ne')."},"compare_key":{"type":["string","null"],"description":"Key of the field to compare against."}},"title":"FormsEorCreateContractDefinitionsPostResponsesContentApplicationJsonSchemaDataItemsPagesItemsSectionsItemsQuestionsItemsRulesItemsRequiresItems"},"FormsEorCreateContractDefinitionsPostResponsesContentApplicationJsonSchemaDataItemsPagesItemsSectionsItemsQuestionsItemsRulesItemsMaxValue":{"oneOf":[{"type":"string"},{"type":"number","format":"double"}],"description":"Maximum value allowed.","title":"FormsEorCreateContractDefinitionsPostResponsesContentApplicationJsonSchemaDataItemsPagesItemsSectionsItemsQuestionsItemsRulesItemsMaxValue"},"FormsEorCreateContractDefinitionsPostResponsesContentApplicationJsonSchemaDataItemsPagesItemsSectionsItemsQuestionsItemsRulesItemsMinValue":{"oneOf":[{"type":"string"},{"type":"number","format":"double"}],"description":"Minimum value allowed.","title":"FormsEorCreateContractDefinitionsPostResponsesContentApplicationJsonSchemaDataItemsPagesItemsSectionsItemsQuestionsItemsRulesItemsMinValue"},"FormsEorCreateContractDefinitionsPostResponsesContentApplicationJsonSchemaDataItemsPagesItemsSectionsItemsQuestionsItemsRulesItemsDefaultValue":{"oneOf":[{"type":"string"},{"type":"number","format":"double"},{"type":"boolean"}],"description":"Default value to pre-fill in the form.","title":"FormsEorCreateContractDefinitionsPostResponsesContentApplicationJsonSchemaDataItemsPagesItemsSectionsItemsQuestionsItemsRulesItemsDefaultValue"},"FormsEorCreateContractDefinitionsPostResponsesContentApplicationJsonSchemaDataItemsPagesItemsSectionsItemsQuestionsItemsRulesItems":{"type":"object","properties":{"title":{"type":"string","description":"Title of the question."},"source":{"oneOf":[{"$ref":"#/components/schemas/FormsEorCreateContractDefinitionsPostResponsesContentApplicationJsonSchemaDataItemsPagesItemsSectionsItemsQuestionsItemsRulesItemsSource"},{"type":"null"}],"description":"Defines dynamic data source for the question."},"options":{"type":["array","null"],"items":{"$ref":"#/components/schemas/FormsEorCreateContractDefinitionsPostResponsesContentApplicationJsonSchemaDataItemsPagesItemsSectionsItemsQuestionsItemsRulesItemsOptionsItems"},"description":"List of selectable options for selection-type questions. Value may be of any type."},"is_range":{"type":"boolean","description":"Specifies whether a date picker allows range selection."},"requires":{"type":"array","items":{"$ref":"#/components/schemas/FormsEorCreateContractDefinitionsPostResponsesContentApplicationJsonSchemaDataItemsPagesItemsSectionsItemsQuestionsItemsRulesItemsRequiresItems"},"description":"List of conditions that must be met for this rule to apply."},"max_value":{"$ref":"#/components/schemas/FormsEorCreateContractDefinitionsPostResponsesContentApplicationJsonSchemaDataItemsPagesItemsSectionsItemsQuestionsItemsRulesItemsMaxValue","description":"Maximum value allowed."},"min_value":{"$ref":"#/components/schemas/FormsEorCreateContractDefinitionsPostResponsesContentApplicationJsonSchemaDataItemsPagesItemsSectionsItemsQuestionsItemsRulesItemsMinValue","description":"Minimum value allowed."},"max_length":{"type":["integer","null"],"description":"Maximum character length for text responses."},"min_length":{"type":["integer","null"],"description":"Minimum character length for text responses."},"helper_text":{"type":["string","null"],"description":"Additional information to assist the user."},"is_disabled":{"type":"boolean","description":"If true, the field is disabled and cannot be edited."},"is_required":{"type":"boolean","description":"Indicates if the question is required."},"number_type":{"type":"string","description":"Used for number fields to define the unit or representation."},"default_value":{"$ref":"#/components/schemas/FormsEorCreateContractDefinitionsPostResponsesContentApplicationJsonSchemaDataItemsPagesItemsSectionsItemsQuestionsItemsRulesItemsDefaultValue","description":"Default value to pre-fill in the form."},"is_only_digits":{"type":"boolean","description":"Restricts input to numeric characters only, for FreeText questions."},"date_limitation":{"type":["string","null"],"description":"Limits date selection (e.g., blocking past dates). Will always be 'BLOCK_PAST' for now."},"is_multiple_selection":{"type":"boolean","description":"Indicates if the user can select multiple values."},"must_request_validation":{"type":"boolean","description":"Whether additional validation should be triggered for this field."}},"title":"FormsEorCreateContractDefinitionsPostResponsesContentApplicationJsonSchemaDataItemsPagesItemsSectionsItemsQuestionsItemsRulesItems"},"FormsEorCreateContractDefinitionsPostResponsesContentApplicationJsonSchemaDataItemsPagesItemsSectionsItemsQuestionsItemsSource":{"type":"object","properties":{"url":{"type":"string","description":"API endpoint providing dynamic options."},"definition":{"type":"string","description":"Reference URL for API documentation."},"description":{"type":"string","description":"Description of the data source."}},"description":"Defines dynamic data source for the question.","title":"FormsEorCreateContractDefinitionsPostResponsesContentApplicationJsonSchemaDataItemsPagesItemsSectionsItemsQuestionsItemsSource"},"FormsEorCreateContractDefinitionsPostResponsesContentApplicationJsonSchemaDataItemsPagesItemsSectionsItemsQuestionsItemsOptionsItems":{"type":"object","properties":{"title":{"type":"string","description":"Display text for the option."},"value":{"type":["string","null"],"description":"Value associated with the option."}},"title":"FormsEorCreateContractDefinitionsPostResponsesContentApplicationJsonSchemaDataItemsPagesItemsSectionsItemsQuestionsItemsOptionsItems"},"FormsEorCreateContractDefinitionsPostResponsesContentApplicationJsonSchemaDataItemsPagesItemsSectionsItemsQuestionsItemsMaxValue":{"oneOf":[{"type":"string"},{"type":"number","format":"double"}],"description":"Maximum value allowed.","title":"FormsEorCreateContractDefinitionsPostResponsesContentApplicationJsonSchemaDataItemsPagesItemsSectionsItemsQuestionsItemsMaxValue"},"FormsEorCreateContractDefinitionsPostResponsesContentApplicationJsonSchemaDataItemsPagesItemsSectionsItemsQuestionsItemsMinValue":{"oneOf":[{"type":"string"},{"type":"number","format":"double"}],"description":"Minimum value allowed.","title":"FormsEorCreateContractDefinitionsPostResponsesContentApplicationJsonSchemaDataItemsPagesItemsSectionsItemsQuestionsItemsMinValue"},"FormsEorCreateContractDefinitionsPostResponsesContentApplicationJsonSchemaDataItemsPagesItemsSectionsItemsQuestionsItemsDefaultValue":{"oneOf":[{"type":"string"},{"type":"number","format":"double"},{"type":"boolean"}],"description":"Default value to pre-fill in the form.","title":"FormsEorCreateContractDefinitionsPostResponsesContentApplicationJsonSchemaDataItemsPagesItemsSectionsItemsQuestionsItemsDefaultValue"},"FormsEorCreateContractDefinitionsPostResponsesContentApplicationJsonSchemaDataItemsPagesItemsSectionsItemsQuestionsItems":{"type":"object","properties":{"key":{"type":"string","description":"Unique key identifier for the question."},"type":{"$ref":"#/components/schemas/FormsEorCreateContractDefinitionsPostResponsesContentApplicationJsonSchemaDataItemsPagesItemsSectionsItemsQuestionsItemsType","description":"Type of the question."},"rules":{"type":["array","null"],"items":{"$ref":"#/components/schemas/FormsEorCreateContractDefinitionsPostResponsesContentApplicationJsonSchemaDataItemsPagesItemsSectionsItemsQuestionsItemsRulesItems"},"description":"Validation rules for the question."},"title":{"type":"string","description":"Title of the question."},"source":{"oneOf":[{"$ref":"#/components/schemas/FormsEorCreateContractDefinitionsPostResponsesContentApplicationJsonSchemaDataItemsPagesItemsSectionsItemsQuestionsItemsSource"},{"type":"null"}],"description":"Defines dynamic data source for the question."},"options":{"type":["array","null"],"items":{"$ref":"#/components/schemas/FormsEorCreateContractDefinitionsPostResponsesContentApplicationJsonSchemaDataItemsPagesItemsSectionsItemsQuestionsItemsOptionsItems"},"description":"List of selectable options for selection-type questions. Value may be of any type."},"is_range":{"type":"boolean","description":"Specifies whether a date picker allows range selection."},"max_value":{"$ref":"#/components/schemas/FormsEorCreateContractDefinitionsPostResponsesContentApplicationJsonSchemaDataItemsPagesItemsSectionsItemsQuestionsItemsMaxValue","description":"Maximum value allowed."},"min_value":{"$ref":"#/components/schemas/FormsEorCreateContractDefinitionsPostResponsesContentApplicationJsonSchemaDataItemsPagesItemsSectionsItemsQuestionsItemsMinValue","description":"Minimum value allowed."},"max_length":{"type":["integer","null"],"description":"Maximum character length for text responses."},"min_length":{"type":["integer","null"],"description":"Minimum character length for text responses."},"helper_text":{"type":["string","null"],"description":"Additional information to assist the user."},"is_disabled":{"type":"boolean","description":"If true, the field is disabled and cannot be edited."},"is_required":{"type":"boolean","description":"Indicates if the question is required."},"number_type":{"type":"string","description":"Used for number fields to define the unit or representation."},"default_value":{"$ref":"#/components/schemas/FormsEorCreateContractDefinitionsPostResponsesContentApplicationJsonSchemaDataItemsPagesItemsSectionsItemsQuestionsItemsDefaultValue","description":"Default value to pre-fill in the form."},"is_only_digits":{"type":"boolean","description":"Restricts input to numeric characters only, for FreeText questions."},"date_limitation":{"type":["string","null"],"description":"Limits date selection (e.g., blocking past dates). Will always be 'BLOCK_PAST' for now."},"is_multiple_selection":{"type":"boolean","description":"Indicates if the user can select multiple values."},"must_request_validation":{"type":"boolean","description":"Whether additional validation should be triggered for this field."}},"required":["key","type","title"],"title":"FormsEorCreateContractDefinitionsPostResponsesContentApplicationJsonSchemaDataItemsPagesItemsSectionsItemsQuestionsItems"},"FormsEorCreateContractDefinitionsPostResponsesContentApplicationJsonSchemaDataItemsPagesItemsSectionsItems":{"type":"object","properties":{"title":{"type":"string","description":"Title of the section."},"subtitle":{"type":"string","description":"Additional information shown at the top of the section."},"questions":{"type":"array","items":{"$ref":"#/components/schemas/FormsEorCreateContractDefinitionsPostResponsesContentApplicationJsonSchemaDataItemsPagesItemsSectionsItemsQuestionsItems"},"description":"List of questions within the section."}},"required":["title","questions"],"title":"FormsEorCreateContractDefinitionsPostResponsesContentApplicationJsonSchemaDataItemsPagesItemsSectionsItems"},"FormsEorCreateContractDefinitionsPostResponsesContentApplicationJsonSchemaDataItemsPagesItems":{"type":"object","properties":{"title":{"type":"string","description":"Title of the form page."},"sections":{"type":"array","items":{"$ref":"#/components/schemas/FormsEorCreateContractDefinitionsPostResponsesContentApplicationJsonSchemaDataItemsPagesItemsSectionsItems"},"description":"Sections within the page."}},"required":["title","sections"],"title":"FormsEorCreateContractDefinitionsPostResponsesContentApplicationJsonSchemaDataItemsPagesItems"},"FormsEorCreateContractDefinitionsPostResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"pages":{"type":"array","items":{"$ref":"#/components/schemas/FormsEorCreateContractDefinitionsPostResponsesContentApplicationJsonSchemaDataItemsPagesItems"},"description":"List of pages in the form."},"state":{"type":["string","null"],"description":"State or province code if applicable"},"country":{"type":"string","description":"Two-letter country code in ISO 3166-1 alpha-2 format"}},"required":["pages","country"],"title":"FormsEorCreateContractDefinitionsPostResponsesContentApplicationJsonSchemaDataItems"},"Forms_fetchMultipleEorContractForms_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/FormsEorCreateContractDefinitionsPostResponsesContentApplicationJsonSchemaDataItems"},"description":"Array of quote forms for the requested countries."},"has_more":{"type":"boolean","description":"Indicates if there are more results available beyond the current page."},"next_cursor":{"type":["string","null"],"description":"Cursor for fetching the next page of results. Null if no more results."},"total_count":{"type":"integer","description":"Total number of countries in the request."}},"required":["data","has_more","total_count"],"title":"Forms_fetchMultipleEorContractForms_Response_200"},"FormsEorCreateContractDefinitionsPostResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code"},"message":{"type":"string","description":"Human-readable explanation of the error"}},"title":"FormsEorCreateContractDefinitionsPostResponsesContentApplicationJsonSchemaErrorsItems"},"FetchMultipleEorContractFormsRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/FormsEorCreateContractDefinitionsPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"FetchMultipleEorContractFormsRequestBadRequestError"},"FetchMultipleEorContractFormsRequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/FormsEorCreateContractDefinitionsPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"FetchMultipleEorContractFormsRequestInternalServerError"},"FormsEorWorkerAdditionalFieldsCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsUiGuide":{"type":"object","properties":{"label":{"type":"string","description":"The primary label for the field"},"order":{"type":"integer","description":"Display order of the field in the UI"},"field_type":{"type":"string","description":"Type of the input field in the UI"},"description":{"type":"string","description":"Additional description for the field UI"},"helper_text":{"type":"string","description":"Helper text to guide user input"},"local_label":{"type":"string","description":"Localized version of the field label"}},"required":["label","order","field_type","description"],"description":"UI guidelines for rendering the field","title":"FormsEorWorkerAdditionalFieldsCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsUiGuide"},"FormsEorWorkerAdditionalFieldsCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsValidationItems":{"type":"object","properties":{"type":{"type":"string","description":"Type of the validation"},"value":{"type":"string","description":"Value to be used in the validation according to the type"},"error_message":{"type":"string","description":"Error message shown if the validation fails"}},"required":["type","error_message"],"description":"Validation rules for the field","title":"FormsEorWorkerAdditionalFieldsCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsValidationItems"},"FormsEorWorkerAdditionalFieldsCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsDependenciesItemsValueOneOf1Value":{"oneOf":[{"type":"string"},{"type":"number","format":"double"}],"title":"FormsEorWorkerAdditionalFieldsCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsDependenciesItemsValueOneOf1Value"},"FormsEorWorkerAdditionalFieldsCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsDependenciesItemsValue1":{"type":"object","properties":{"op":{"type":"string","description":"Comparison operator (e.g., gt, gte, lt, lte, eq, neq)"},"value":{"$ref":"#/components/schemas/FormsEorWorkerAdditionalFieldsCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsDependenciesItemsValueOneOf1Value"}},"required":["op","value"],"title":"FormsEorWorkerAdditionalFieldsCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsDependenciesItemsValue1"},"FormsEorWorkerAdditionalFieldsCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsDependenciesItemsValue":{"oneOf":[{"type":"string"},{"$ref":"#/components/schemas/FormsEorWorkerAdditionalFieldsCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsDependenciesItemsValue1"},{"type":"array","items":{"type":"string"}}],"description":"Value expected from dependant in order to display field. Can be a plain value or an object with an operator.","title":"FormsEorWorkerAdditionalFieldsCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsDependenciesItemsValue"},"FormsEorWorkerAdditionalFieldsCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsDependenciesItems":{"type":"object","properties":{"key":{"type":"string","description":"Unique identifier for the dependant field"},"value":{"$ref":"#/components/schemas/FormsEorWorkerAdditionalFieldsCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsDependenciesItemsValue","description":"Value expected from dependant in order to display field. Can be a plain value or an object with an operator."}},"required":["key","value"],"title":"FormsEorWorkerAdditionalFieldsCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsDependenciesItems"},"FormsEorWorkerAdditionalFieldsCountryCodeGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"key":{"type":"string","description":"Unique identifier for the field"},"type":{"type":"string","description":"Data type of the field"},"ui_guide":{"$ref":"#/components/schemas/FormsEorWorkerAdditionalFieldsCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsUiGuide","description":"UI guidelines for rendering the field"},"validation":{"type":"array","items":{"$ref":"#/components/schemas/FormsEorWorkerAdditionalFieldsCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsValidationItems"},"description":"Array of validation rules to apply to the field input"},"is_required":{"type":"boolean","description":"Indicates if the field is required"},"required_by":{"type":"string","description":"Indicates when the field is required (e.g., sign_up, contract_signing)"},"dependencies":{"type":"array","items":{"$ref":"#/components/schemas/FormsEorWorkerAdditionalFieldsCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsDependenciesItems"},"description":"Array of field dependencies that determine when this field should be displayed"},"values_allowed":{"type":"array","items":{"type":"string"},"description":"List of allowed values for select fields"}},"required":["key","type","ui_guide","validation","is_required","dependencies"],"title":"FormsEorWorkerAdditionalFieldsCountryCodeGetResponsesContentApplicationJsonSchemaDataItems"},"Forms_getWorkerAdditionalFieldsForEor_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/FormsEorWorkerAdditionalFieldsCountryCodeGetResponsesContentApplicationJsonSchemaDataItems"},"description":"Array of field configuration objects"}},"required":["data"],"title":"Forms_getWorkerAdditionalFieldsForEor_Response_200"},"FormsEorWorkerAdditionalFieldsCountryCodeGetResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code"},"message":{"type":"string","description":"Human-readable explanation of the error"}},"title":"FormsEorWorkerAdditionalFieldsCountryCodeGetResponsesContentApplicationJsonSchemaErrorsItems"},"GetWorkerAdditionalFieldsForEorRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/FormsEorWorkerAdditionalFieldsCountryCodeGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"GetWorkerAdditionalFieldsForEorRequestBadRequestError"},"GetWorkerAdditionalFieldsForEorRequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/FormsEorWorkerAdditionalFieldsCountryCodeGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"GetWorkerAdditionalFieldsForEorRequestInternalServerError"},"GpWorkersIdPayslipsPayslipIdDownloadGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"url":{"type":"string","description":"A pre-signed URL to download the payslip PDF."}},"required":["url"],"title":"GpWorkersIdPayslipsPayslipIdDownloadGetResponsesContentApplicationJsonSchemaData"},"Global Payroll_downloadAGpWorkerPayslip-v2026-01-01_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/GpWorkersIdPayslipsPayslipIdDownloadGetResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"Global Payroll_downloadAGpWorkerPayslip-v2026-01-01_Response_200"},"GpWorkersIdPayslipsPayslipIdDownloadGetResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"message":{"type":"string","description":"Error response"}},"required":["message"],"title":"GpWorkersIdPayslipsPayslipIdDownloadGetResponsesContentApplicationJsonSchemaErrorsItems"},"GpWorkersIdPayslipsPayslipIdDownloadGetResponsesContentApplicationJsonSchemaRequest":{"type":"object","properties":{"method":{"type":"string","description":"Method of the API"},"status":{"type":"number","format":"double","description":"Status of API response"}},"description":"Error request details","title":"GpWorkersIdPayslipsPayslipIdDownloadGetResponsesContentApplicationJsonSchemaRequest"},"DownloadAGpWorkerPayslip-v2026-01-01RequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/GpWorkersIdPayslipsPayslipIdDownloadGetResponsesContentApplicationJsonSchemaErrorsItems"},"description":"Error messages"},"request":{"$ref":"#/components/schemas/GpWorkersIdPayslipsPayslipIdDownloadGetResponsesContentApplicationJsonSchemaRequest","description":"Error request details"}},"required":["errors"],"title":"DownloadAGpWorkerPayslip-v2026-01-01RequestBadRequestError"},"CyclesCycleIdPayrollReportGetParametersCursor":{"oneOf":[{"type":"string"},{"type":"number","format":"double"}],"title":"CyclesCycleIdPayrollReportGetParametersCursor"},"CyclesCycleIdPayrollReportGetResponsesContentApplicationJsonSchemaDataCursor":{"oneOf":[{"type":"string"},{"type":"number","format":"double"}],"description":"Cursor for pagination.","title":"CyclesCycleIdPayrollReportGetResponsesContentApplicationJsonSchemaDataCursor"},"CyclesCycleIdPayrollReportGetResponsesContentApplicationJsonSchemaDataOverview":{"type":"object","properties":{},"description":"Optional aggregated overview for the report.","title":"CyclesCycleIdPayrollReportGetResponsesContentApplicationJsonSchemaDataOverview"},"CyclesCycleIdPayrollReportGetResponsesContentApplicationJsonSchemaDataEventEntityItemsItems":{"type":"object","properties":{"id":{"type":"string","description":"Column id."},"type":{"type":"string","description":"Column type."},"label":{"type":"string","description":"Display label."},"scope":{"type":"string","description":"Column scope."},"status":{"type":"string","description":"Column status."},"tooltip":{"type":["string","null"],"description":"Tooltip text."},"countries":{"type":"array","items":{"type":"string"},"description":"Countries where column applies."},"is_global":{"type":"boolean","description":"Whether column is global."},"created_at":{"type":"string","format":"date-time","description":"Creation time."},"item_order":{"type":"integer","description":"Ordering index."},"updated_at":{"type":"string","format":"date-time","description":"Last update time."},"description":{"type":["string","null"],"description":"Column description."},"system_name":{"type":["string","null"],"description":"System name."},"deel_enabled":{"type":"boolean","description":"Whether enabled for Deel."},"is_adjustable":{"type":"boolean","description":"Whether item is adjustable."},"appears_on_g2n":{"type":"boolean","description":"Whether appears on G2N."},"client_enabled":{"type":"boolean","description":"Whether enabled for clients."},"unit_of_measure":{"type":["string","null"],"description":"Unit of measure."},"can_be_recurring":{"type":"boolean","description":"Whether item can recur."},"employer_cost_type":{"type":["string","null"],"description":"Employer cost type."},"add_to_employer_cost":{"type":"boolean","description":"Whether adds to employer cost."},"included_in_g2n_report":{"type":"boolean","description":"Whether included in G2N report."},"payroll_legal_entity_id":{"type":["integer","null"],"description":"Payroll legal entity id."},"is_recurring_in_offcycle":{"type":"boolean","description":"Whether recurring in offcycle."},"appears_on_recurring_items":{"type":"boolean","description":"Whether appears on recurring items."},"client_payroll_report_label":{"type":["string","null"],"description":"Client-facing label."},"supported_in_payroll_report":{"type":"boolean","description":"Whether supported in payroll report."},"payroll_report_sub_category_id":{"type":["string","null"],"description":"Sub-category id."},"adjustment_payroll_report_column_id":{"type":["string","null"],"description":"Adjustment column id."}},"title":"CyclesCycleIdPayrollReportGetResponsesContentApplicationJsonSchemaDataEventEntityItemsItems"},"CyclesCycleIdPayrollReportGetResponsesContentApplicationJsonSchemaDataEmploymentPayrollEventsItemsContractHrisProfile":{"type":"object","properties":{"oid":{"type":"string","description":"HRIS profile identifier."}},"description":"HRIS profile details.","title":"CyclesCycleIdPayrollReportGetResponsesContentApplicationJsonSchemaDataEmploymentPayrollEventsItemsContractHrisProfile"},"CyclesCycleIdPayrollReportGetResponsesContentApplicationJsonSchemaDataEmploymentPayrollEventsItemsContract":{"type":"object","properties":{"id":{"type":"integer","description":"Internal contract id."},"oid":{"type":"string","description":"Public contract identifier."},"status":{"type":["string","null"],"description":"Contract status."},"hris_profile":{"$ref":"#/components/schemas/CyclesCycleIdPayrollReportGetResponsesContentApplicationJsonSchemaDataEmploymentPayrollEventsItemsContractHrisProfile","description":"HRIS profile details."},"contract_type":{"type":["string","null"],"description":"Contract type."},"completion_date":{"type":["string","null"],"format":"date-time","description":"Contract completion date."}},"description":"Contract details for the employee.","title":"CyclesCycleIdPayrollReportGetResponsesContentApplicationJsonSchemaDataEmploymentPayrollEventsItemsContract"},"CyclesCycleIdPayrollReportGetResponsesContentApplicationJsonSchemaDataEmploymentPayrollEventsItemsEmploymentEmployee":{"type":"object","properties":{"last_name":{"type":["string","null"],"description":"Last name."},"first_name":{"type":["string","null"],"description":"First name."},"middle_name":{"type":["string","null"],"description":"Middle name."}},"description":"Employee name details.","title":"CyclesCycleIdPayrollReportGetResponsesContentApplicationJsonSchemaDataEmploymentPayrollEventsItemsEmploymentEmployee"},"CyclesCycleIdPayrollReportGetResponsesContentApplicationJsonSchemaDataEmploymentPayrollEventsItemsEmploymentEmployeeRecurringItemsItemsAmount":{"oneOf":[{"type":"string"},{"type":"number","format":"double"}],"description":"Recurring item amount.","title":"CyclesCycleIdPayrollReportGetResponsesContentApplicationJsonSchemaDataEmploymentPayrollEventsItemsEmploymentEmployeeRecurringItemsItemsAmount"},"CyclesCycleIdPayrollReportGetResponsesContentApplicationJsonSchemaDataEmploymentPayrollEventsItemsEmploymentEmployeeRecurringItemsItemsPayrollReportColumn":{"type":"object","properties":{},"description":"Payroll report column details.","title":"CyclesCycleIdPayrollReportGetResponsesContentApplicationJsonSchemaDataEmploymentPayrollEventsItemsEmploymentEmployeeRecurringItemsItemsPayrollReportColumn"},"CyclesCycleIdPayrollReportGetResponsesContentApplicationJsonSchemaDataEmploymentPayrollEventsItemsEmploymentEmployeeRecurringItemsItems":{"type":"object","properties":{"id":{"type":"string","description":"Recurring item id."},"amount":{"$ref":"#/components/schemas/CyclesCycleIdPayrollReportGetResponsesContentApplicationJsonSchemaDataEmploymentPayrollEventsItemsEmploymentEmployeeRecurringItemsItemsAmount","description":"Recurring item amount."},"unit_of_measure":{"type":["string","null"],"description":"Unit of measure."},"payroll_report_column":{"$ref":"#/components/schemas/CyclesCycleIdPayrollReportGetResponsesContentApplicationJsonSchemaDataEmploymentPayrollEventsItemsEmploymentEmployeeRecurringItemsItemsPayrollReportColumn","description":"Payroll report column details."},"payroll_report_column_id":{"type":"string","description":"Payroll report column id."}},"title":"CyclesCycleIdPayrollReportGetResponsesContentApplicationJsonSchemaDataEmploymentPayrollEventsItemsEmploymentEmployeeRecurringItemsItems"},"CyclesCycleIdPayrollReportGetResponsesContentApplicationJsonSchemaDataEmploymentPayrollEventsItemsEmployment":{"type":"object","properties":{"employee":{"$ref":"#/components/schemas/CyclesCycleIdPayrollReportGetResponsesContentApplicationJsonSchemaDataEmploymentPayrollEventsItemsEmploymentEmployee","description":"Employee name details."},"employment_id":{"type":["string","null"],"description":"Employment id."},"employee_status":{"type":["string","null"],"description":"Employee status."},"employee_recurring_items":{"type":"array","items":{"$ref":"#/components/schemas/CyclesCycleIdPayrollReportGetResponsesContentApplicationJsonSchemaDataEmploymentPayrollEventsItemsEmploymentEmployeeRecurringItemsItems"},"description":"Recurring payroll items for the employee."}},"title":"CyclesCycleIdPayrollReportGetResponsesContentApplicationJsonSchemaDataEmploymentPayrollEventsItemsEmployment"},"CyclesCycleIdPayrollReportGetResponsesContentApplicationJsonSchemaDataEmploymentPayrollEventsItemsPayrollReportItemsItemsUpdatedByProfile":{"type":"object","properties":{"name":{"type":["string","null"],"description":"User name."},"email":{"type":["string","null"],"description":"User email."},"user_id":{"type":["integer","null"],"description":"User id."}},"description":"Profile of the user who last updated the item.","title":"CyclesCycleIdPayrollReportGetResponsesContentApplicationJsonSchemaDataEmploymentPayrollEventsItemsPayrollReportItemsItemsUpdatedByProfile"},"CyclesCycleIdPayrollReportGetResponsesContentApplicationJsonSchemaDataEmploymentPayrollEventsItemsPayrollReportItemsItemsPayrollReportColumn":{"type":"object","properties":{"id":{"type":"string","description":"Column id."},"type":{"type":"string","description":"Column type."},"label":{"type":"string","description":"Display label."},"scope":{"type":"string","description":"Column scope."},"status":{"type":"string","description":"Column status."},"tooltip":{"type":["string","null"],"description":"UI tooltip."},"countries":{"type":"array","items":{"type":"string"},"description":"Countries where the column applies."},"is_global":{"type":"boolean","description":"Whether the column is global."},"created_at":{"type":"string","format":"date-time","description":"Column creation time."},"item_order":{"type":"integer","description":"Column ordering."},"updated_at":{"type":"string","format":"date-time","description":"Column update time."},"description":{"type":["string","null"],"description":"Column description."},"system_name":{"type":["string","null"],"description":"System name."},"deel_enabled":{"type":"boolean","description":"Whether enabled for Deel."},"is_adjustable":{"type":"boolean","description":"Whether the column is adjustable."},"appears_on_g2n":{"type":"boolean","description":"Whether it appears on G2N."},"client_enabled":{"type":"boolean","description":"Whether enabled for clients."},"unit_of_measure":{"type":["string","null"],"description":"Unit of measure."},"can_be_recurring":{"type":"boolean","description":"Whether the item can recur."},"employer_cost_type":{"type":["string","null"],"description":"Employer cost type."},"add_to_employer_cost":{"type":"boolean","description":"Whether adds to employer cost."},"included_in_g2n_report":{"type":"boolean","description":"Whether included in G2N report."},"payroll_legal_entity_id":{"type":["integer","null"],"description":"Payroll legal entity id."},"is_recurring_in_offcycle":{"type":"boolean","description":"Whether recurring in offcycle."},"appears_on_recurring_items":{"type":"boolean","description":"Whether appears on recurring items."},"client_payroll_report_label":{"type":["string","null"],"description":"Client-facing label."},"supported_in_payroll_report":{"type":"boolean","description":"Whether the column appears in payroll report."},"payroll_report_sub_category_id":{"type":["string","null"],"description":"Report sub-category id."},"adjustment_payroll_report_column_id":{"type":["string","null"],"description":"Adjustment column id."}},"description":"Payroll report column details.","title":"CyclesCycleIdPayrollReportGetResponsesContentApplicationJsonSchemaDataEmploymentPayrollEventsItemsPayrollReportItemsItemsPayrollReportColumn"},"CyclesCycleIdPayrollReportGetResponsesContentApplicationJsonSchemaDataEmploymentPayrollEventsItemsPayrollReportItemsItemsEmploymentPayrollEventId":{"oneOf":[{"type":"integer"},{"type":"string"}],"description":"Employment payroll event id.","title":"CyclesCycleIdPayrollReportGetResponsesContentApplicationJsonSchemaDataEmploymentPayrollEventsItemsPayrollReportItemsItemsEmploymentPayrollEventId"},"CyclesCycleIdPayrollReportGetResponsesContentApplicationJsonSchemaDataEmploymentPayrollEventsItemsPayrollReportItemsItems":{"type":"object","properties":{"id":{"type":"string","description":"Payroll report item id."},"value":{"type":["string","null"],"description":"Item value."},"source":{"type":["string","null"],"description":"Value source."},"qtd_value":{"type":["string","null"],"description":"Quarter-to-date value."},"ytd_value":{"type":["string","null"],"description":"Year-to-date value."},"created_at":{"type":"string","format":"date-time","description":"Item creation time."},"updated_at":{"type":"string","format":"date-time","description":"Item update time."},"is_prorated":{"type":"boolean","description":"Whether the value is prorated."},"is_recurring":{"type":["boolean","null"],"description":"Whether the item is recurring."},"is_overwritten":{"type":"boolean","description":"Whether the value was overwritten."},"last_change_by":{"type":["integer","null"],"description":"Last editor user id."},"unit_of_measure":{"type":["string","null"],"description":"Unit of measure."},"updated_by_profile":{"$ref":"#/components/schemas/CyclesCycleIdPayrollReportGetResponsesContentApplicationJsonSchemaDataEmploymentPayrollEventsItemsPayrollReportItemsItemsUpdatedByProfile","description":"Profile of the user who last updated the item."},"payroll_report_column":{"$ref":"#/components/schemas/CyclesCycleIdPayrollReportGetResponsesContentApplicationJsonSchemaDataEmploymentPayrollEventsItemsPayrollReportItemsItemsPayrollReportColumn","description":"Payroll report column details."},"payroll_report_column_id":{"type":"string","description":"Payroll report column id."},"employment_payroll_event_id":{"$ref":"#/components/schemas/CyclesCycleIdPayrollReportGetResponsesContentApplicationJsonSchemaDataEmploymentPayrollEventsItemsPayrollReportItemsItemsEmploymentPayrollEventId","description":"Employment payroll event id."}},"title":"CyclesCycleIdPayrollReportGetResponsesContentApplicationJsonSchemaDataEmploymentPayrollEventsItemsPayrollReportItemsItems"},"CyclesCycleIdPayrollReportGetResponsesContentApplicationJsonSchemaDataEmploymentPayrollEventsItemsPreviousPayrollReportItemsItemsPayrollReportColumn":{"type":"object","properties":{},"description":"Payroll report column details.","title":"CyclesCycleIdPayrollReportGetResponsesContentApplicationJsonSchemaDataEmploymentPayrollEventsItemsPreviousPayrollReportItemsItemsPayrollReportColumn"},"CyclesCycleIdPayrollReportGetResponsesContentApplicationJsonSchemaDataEmploymentPayrollEventsItemsPreviousPayrollReportItemsItemsEmploymentPayrollEventId":{"oneOf":[{"type":"integer"},{"type":"string"}],"description":"Employment payroll event id.","title":"CyclesCycleIdPayrollReportGetResponsesContentApplicationJsonSchemaDataEmploymentPayrollEventsItemsPreviousPayrollReportItemsItemsEmploymentPayrollEventId"},"CyclesCycleIdPayrollReportGetResponsesContentApplicationJsonSchemaDataEmploymentPayrollEventsItemsPreviousPayrollReportItemsItems":{"type":"object","properties":{"id":{"type":"string","description":"Payroll report item id."},"value":{"type":["string","null"],"description":"Item value."},"source":{"type":["string","null"],"description":"Value source."},"qtd_value":{"type":["string","null"],"description":"Quarter-to-date value."},"ytd_value":{"type":["string","null"],"description":"Year-to-date value."},"created_at":{"type":"string","format":"date-time","description":"Item creation time."},"updated_at":{"type":"string","format":"date-time","description":"Item update time."},"is_prorated":{"type":"boolean","description":"Whether the value is prorated."},"is_overwritten":{"type":"boolean","description":"Whether the value was overwritten."},"last_change_by":{"type":["integer","null"],"description":"Last editor user id."},"unit_of_measure":{"type":["string","null"],"description":"Unit of measure."},"payroll_report_column":{"$ref":"#/components/schemas/CyclesCycleIdPayrollReportGetResponsesContentApplicationJsonSchemaDataEmploymentPayrollEventsItemsPreviousPayrollReportItemsItemsPayrollReportColumn","description":"Payroll report column details."},"payroll_report_column_id":{"type":"string","description":"Payroll report column id."},"employment_payroll_event_id":{"$ref":"#/components/schemas/CyclesCycleIdPayrollReportGetResponsesContentApplicationJsonSchemaDataEmploymentPayrollEventsItemsPreviousPayrollReportItemsItemsEmploymentPayrollEventId","description":"Employment payroll event id."}},"title":"CyclesCycleIdPayrollReportGetResponsesContentApplicationJsonSchemaDataEmploymentPayrollEventsItemsPreviousPayrollReportItemsItems"},"CyclesCycleIdPayrollReportGetResponsesContentApplicationJsonSchemaDataEmploymentPayrollEventsItems":{"type":"object","properties":{"contract":{"$ref":"#/components/schemas/CyclesCycleIdPayrollReportGetResponsesContentApplicationJsonSchemaDataEmploymentPayrollEventsItemsContract","description":"Contract details for the employee."},"employment":{"$ref":"#/components/schemas/CyclesCycleIdPayrollReportGetResponsesContentApplicationJsonSchemaDataEmploymentPayrollEventsItemsEmployment"},"payroll_report_items":{"type":"array","items":{"$ref":"#/components/schemas/CyclesCycleIdPayrollReportGetResponsesContentApplicationJsonSchemaDataEmploymentPayrollEventsItemsPayrollReportItemsItems"},"description":"Current payroll report items."},"previous_payroll_report_items":{"type":"array","items":{"$ref":"#/components/schemas/CyclesCycleIdPayrollReportGetResponsesContentApplicationJsonSchemaDataEmploymentPayrollEventsItemsPreviousPayrollReportItemsItems"},"description":"Previous payroll report items for comparison."}},"title":"CyclesCycleIdPayrollReportGetResponsesContentApplicationJsonSchemaDataEmploymentPayrollEventsItems"},"CyclesCycleIdPayrollReportGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"count":{"type":"integer","description":"Number of rows returned."},"cursor":{"oneOf":[{"$ref":"#/components/schemas/CyclesCycleIdPayrollReportGetResponsesContentApplicationJsonSchemaDataCursor"},{"type":"null"}],"description":"Cursor for pagination."},"overview":{"oneOf":[{"$ref":"#/components/schemas/CyclesCycleIdPayrollReportGetResponsesContentApplicationJsonSchemaDataOverview"},{"type":"null"}],"description":"Optional aggregated overview for the report."},"event_entity_items":{"type":"array","items":{"$ref":"#/components/schemas/CyclesCycleIdPayrollReportGetResponsesContentApplicationJsonSchemaDataEventEntityItemsItems"},"description":"Column definitions available for update."},"employment_payroll_events":{"type":"array","items":{"$ref":"#/components/schemas/CyclesCycleIdPayrollReportGetResponsesContentApplicationJsonSchemaDataEmploymentPayrollEventsItems"},"description":"Employee rows for the cycle."}},"required":["count","event_entity_items","employment_payroll_events"],"title":"CyclesCycleIdPayrollReportGetResponsesContentApplicationJsonSchemaData"},"Global Payroll_getPayrollReport-v2026-03-30_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CyclesCycleIdPayrollReportGetResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"Global Payroll_getPayrollReport-v2026-03-30_Response_200"},"CyclesCycleIdPayrollReportGetResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code"},"message":{"type":"string","description":"Human-readable explanation of the error"}},"title":"CyclesCycleIdPayrollReportGetResponsesContentApplicationJsonSchemaErrorsItems"},"GetPayrollReport-v2026-03-30RequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/CyclesCycleIdPayrollReportGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"GetPayrollReport-v2026-03-30RequestBadRequestError"},"GetPayrollReport-v2026-03-30RequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/CyclesCycleIdPayrollReportGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"GetPayrollReport-v2026-03-30RequestInternalServerError"},"FormsGpWorkerAdditionalFieldsCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsType":{"type":"string","enum":["string","number","boolean",""],"description":"Use this value to determine the data type expected when submitting field values. Mapped from the raw input type: 'date', 'text', 'select', 'textarea', 'tel', 'phone', and 'string' map to \"string\"; 'number' maps to \"number\"; 'checkbox' maps to \"boolean\". An empty string indicates an unrecognized input type.","title":"FormsGpWorkerAdditionalFieldsCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsType"},"FormsGpWorkerAdditionalFieldsCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsUiGuide":{"type":"object","properties":{"label":{"type":"string","description":"Use this value as the primary English-language label when rendering the field in the UI."},"order":{"type":"integer","description":"Use this value to determine the display position of the field in the form. Starts at 1 and reflects the position in the response array, which is pre-sorted by the configured display order."},"field_type":{"type":"string","description":"Use this value to select the appropriate UI input component. Represents the raw input type from the field configuration. Known values include 'text', 'date', 'select', 'textarea', 'tel', 'phone', 'number', 'checkbox', and 'string'. Additional values may exist."},"description":{"type":"string","description":"Use this value to display supplementary context about the field below or beside the input. HTML tags are stripped. Returns an empty string when no description is configured."},"helper_text":{"type":"string","description":"Use this value to display footnote or instructional text near the field. HTML tags are stripped. Returns an empty string when no helper text is configured."},"local_label":{"type":"string","description":"Use this value as the localized field label when rendering the form in the worker's local language."}},"required":["label","order","field_type","description","helper_text","local_label"],"description":"Use this object to control how the field is rendered in the UI. Contains labels, input type, display order, and supplementary text.","title":"FormsGpWorkerAdditionalFieldsCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsUiGuide"},"FormsGpWorkerAdditionalFieldsCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsValidationItems":{"type":"object","properties":{"type":{"type":"string","description":"Use this value to determine which validation strategy to apply. \"REGEX\" indicates the 'value' field contains a regular expression pattern. Any other value indicates a custom validation type identified by its uppercase name."},"value":{"type":"string","description":"Use this value as the validation parameter. For REGEX type, contains the regular expression pattern to validate the field input against. Absent when the validation type is a custom type that does not require a parameter."},"error_message":{"type":"string","description":"Use this message to display to the user when the field value fails validation. Defaults to 'Review the value entered' when no custom message is configured."}},"required":["type","error_message"],"title":"FormsGpWorkerAdditionalFieldsCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsValidationItems"},"FormsGpWorkerAdditionalFieldsCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsDependenciesItemsValueOneOf3Op":{"type":"string","enum":["eq","ne","gt","lt","notnull","contains"],"description":"Use this operator to evaluate the dependency condition against the referenced field's submitted value.","title":"FormsGpWorkerAdditionalFieldsCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsDependenciesItemsValueOneOf3Op"},"FormsGpWorkerAdditionalFieldsCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsDependenciesItemsValue3":{"type":"object","properties":{"op":{"$ref":"#/components/schemas/FormsGpWorkerAdditionalFieldsCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsDependenciesItemsValueOneOf3Op","description":"Use this operator to evaluate the dependency condition against the referenced field's submitted value."},"value":{"description":"Use this value as the operand for the dependency condition evaluation."}},"required":["op","value"],"title":"FormsGpWorkerAdditionalFieldsCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsDependenciesItemsValue3"},"FormsGpWorkerAdditionalFieldsCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsDependenciesItemsValue":{"oneOf":[{"type":"string"},{"type":"number","format":"double"},{"type":"boolean"},{"$ref":"#/components/schemas/FormsGpWorkerAdditionalFieldsCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsDependenciesItemsValue3"}],"description":"Use this value to evaluate the dependency condition. When the value is a primitive (string, number, or boolean), the condition is satisfied when the referenced field equals this value. When the value is an object with 'op' and 'value' properties, apply the specified operator: 'eq' (equals), 'ne' (not equals), 'gt' (greater than), 'lt' (less than), 'notnull' (field is not null), 'contains' (field value contains the specified substring).","title":"FormsGpWorkerAdditionalFieldsCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsDependenciesItemsValue"},"FormsGpWorkerAdditionalFieldsCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsDependenciesItems":{"type":"object","properties":{"key":{"type":"string","description":"Use this value to identify the field that this dependency refers to. Contains the snake_case key of the dependency field, matching another field's 'key' property in the same response."},"value":{"$ref":"#/components/schemas/FormsGpWorkerAdditionalFieldsCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsDependenciesItemsValue","description":"Use this value to evaluate the dependency condition. When the value is a primitive (string, number, or boolean), the condition is satisfied when the referenced field equals this value. When the value is an object with 'op' and 'value' properties, apply the specified operator: 'eq' (equals), 'ne' (not equals), 'gt' (greater than), 'lt' (less than), 'notnull' (field is not null), 'contains' (field value contains the specified substring)."}},"required":["key","value"],"title":"FormsGpWorkerAdditionalFieldsCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsDependenciesItems"},"FormsGpWorkerAdditionalFieldsCountryCodeGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"key":{"type":"string","description":"Use this value as the field identifier when submitting additional information. Represents the snake_case version of the internal field name, generated by the API naming convention service."},"type":{"$ref":"#/components/schemas/FormsGpWorkerAdditionalFieldsCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsType","description":"Use this value to determine the data type expected when submitting field values. Mapped from the raw input type: 'date', 'text', 'select', 'textarea', 'tel', 'phone', and 'string' map to \"string\"; 'number' maps to \"number\"; 'checkbox' maps to \"boolean\". An empty string indicates an unrecognized input type."},"ui_guide":{"$ref":"#/components/schemas/FormsGpWorkerAdditionalFieldsCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsUiGuide","description":"Use this object to control how the field is rendered in the UI. Contains labels, input type, display order, and supplementary text."},"validation":{"type":"array","items":{"$ref":"#/components/schemas/FormsGpWorkerAdditionalFieldsCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsValidationItems"},"description":"Use this array to apply client-side validation before form submission. Contains zero or one validation rule per field. An empty array means no validation is configured."},"is_required":{"type":"boolean","description":"Use this flag to determine whether the field must be provided when submitting additional information. For GP workers, the value considers the GP-specific optionality setting when available, falling back to the general optionality flag."},"required_by":{"type":"string","description":"Use this value to determine at which stage in the payroll lifecycle this field must be collected. Known values: 'before_payroll' (required before payroll processing), 'after_payroll' (can be collected after initial payroll), 'contract_signing' (required at contract signing). Absent from the response when no lifecycle stage is configured."},"dependencies":{"type":"array","items":{"$ref":"#/components/schemas/FormsGpWorkerAdditionalFieldsCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsDependenciesItems"},"description":"Use this array to implement conditional field visibility. When non-empty, this field should only be displayed and required when the referenced dependency conditions are met. An empty array means the field has no conditional dependencies."},"values_allowed":{"type":"array","items":{"type":"string"},"description":"Use this array to populate dropdown or select options when field_type is 'select'. Only present when the field has predefined options. Absent from the response for free-text, date, number, and other non-select field types."}},"required":["key","type","ui_guide","validation","is_required","dependencies"],"title":"FormsGpWorkerAdditionalFieldsCountryCodeGetResponsesContentApplicationJsonSchemaDataItems"},"Global Payroll_retrieveAdditionalInformationFieldsForGpWorkersByCountry-v2026-01-01_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/FormsGpWorkerAdditionalFieldsCountryCodeGetResponsesContentApplicationJsonSchemaDataItems"},"description":"Use this array to build the form UI. Each item defines one field with its type, validation, and display configuration. Items are pre-sorted by EDM display order. An empty array means no additional fields are configured for the requested country."}},"required":["data"],"title":"Global Payroll_retrieveAdditionalInformationFieldsForGpWorkersByCountry-v2026-01-01_Response_200"},"FormsGpWorkerAdditionalFieldsCountryCodeGetResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"message":{"type":"string","description":"Use this message to detect rate limiting. Implement exponential backoff before retrying."}},"required":["message"],"title":"FormsGpWorkerAdditionalFieldsCountryCodeGetResponsesContentApplicationJsonSchemaErrorsItems"},"RetrieveAdditionalInformationFieldsForGpWorkersByCountry-v2026-01-01RequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/FormsGpWorkerAdditionalFieldsCountryCodeGetResponsesContentApplicationJsonSchemaErrorsItems"},"description":"Use this array to identify each validation failure. Each item describes one parameter that failed validation."}},"required":["errors"],"title":"RetrieveAdditionalInformationFieldsForGpWorkersByCountry-v2026-01-01RequestBadRequestError"},"RetrieveAdditionalInformationFieldsForGpWorkersByCountry-v2026-01-01RequestUnauthorizedError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/FormsGpWorkerAdditionalFieldsCountryCodeGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"RetrieveAdditionalInformationFieldsForGpWorkersByCountry-v2026-01-01RequestUnauthorizedError"},"RetrieveAdditionalInformationFieldsForGpWorkersByCountry-v2026-01-01RequestForbiddenError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/FormsGpWorkerAdditionalFieldsCountryCodeGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"RetrieveAdditionalInformationFieldsForGpWorkersByCountry-v2026-01-01RequestForbiddenError"},"RetrieveAdditionalInformationFieldsForGpWorkersByCountry-v2026-01-01RequestNotFoundError":{"type":"object","properties":{"message":{"type":"string","description":"Use this message to understand why the request failed. Indicates the country does not have an additional info template configured."}},"required":["message"],"title":"RetrieveAdditionalInformationFieldsForGpWorkersByCountry-v2026-01-01RequestNotFoundError"},"RetrieveAdditionalInformationFieldsForGpWorkersByCountry-v2026-01-01RequestTooManyRequestsError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/FormsGpWorkerAdditionalFieldsCountryCodeGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"RetrieveAdditionalInformationFieldsForGpWorkersByCountry-v2026-01-01RequestTooManyRequestsError"},"RetrieveAdditionalInformationFieldsForGpWorkersByCountry-v2026-01-01RequestInternalServerError":{"type":"object","properties":{"message":{"type":"string","description":"Use this message for logging and debugging purposes. Contains a general error description."}},"title":"RetrieveAdditionalInformationFieldsForGpWorkersByCountry-v2026-01-01RequestInternalServerError"},"ContractsGpPostRequestBodyContentApplicationJsonSchemaDataClientTeam":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Refers to Groups in the platform. Working groups that reflect the organization's structure."}},"required":["id"],"title":"ContractsGpPostRequestBodyContentApplicationJsonSchemaDataClientTeam"},"ContractsGpPostRequestBodyContentApplicationJsonSchemaDataClientLegalEntity":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the legal entity."}},"required":["id"],"title":"ContractsGpPostRequestBodyContentApplicationJsonSchemaDataClientLegalEntity"},"ContractsGpPostRequestBodyContentApplicationJsonSchemaDataClient":{"type":"object","properties":{"team":{"$ref":"#/components/schemas/ContractsGpPostRequestBodyContentApplicationJsonSchemaDataClientTeam"},"legal_entity":{"$ref":"#/components/schemas/ContractsGpPostRequestBodyContentApplicationJsonSchemaDataClientLegalEntity"}},"required":["team","legal_entity"],"title":"ContractsGpPostRequestBodyContentApplicationJsonSchemaDataClient"},"ContractsGpPostRequestBodyContentApplicationJsonSchemaDataEmployeeAddressCountry":{"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XA","XB","XC","XK","XX","YE","YT","ZA","ZM","ZW"],"description":"ISO 3166-1 alpha-2 country code.","title":"ContractsGpPostRequestBodyContentApplicationJsonSchemaDataEmployeeAddressCountry"},"ContractsGpPostRequestBodyContentApplicationJsonSchemaDataEmployeeAddress":{"type":"object","properties":{"zip":{"type":"string","description":"Postal or ZIP code."},"city":{"type":"string","description":"City of residence."},"state":{"type":"string","description":"State or province code."},"street":{"type":"string","description":"Street name and building number."},"country":{"$ref":"#/components/schemas/ContractsGpPostRequestBodyContentApplicationJsonSchemaDataEmployeeAddressCountry","description":"ISO 3166-1 alpha-2 country code."}},"required":["zip","city","street","country"],"title":"ContractsGpPostRequestBodyContentApplicationJsonSchemaDataEmployeeAddress"},"ContractsGpPostRequestBodyContentApplicationJsonSchemaDataEmployeeNationality":{"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XA","XB","XC","XK","XX","YE","YT","ZA","ZM","ZW"],"description":"Employee's nationality in ISO 3166-1 alpha-2 format.","title":"ContractsGpPostRequestBodyContentApplicationJsonSchemaDataEmployeeNationality"},"ContractsGpPostRequestBodyContentApplicationJsonSchemaDataEmployee":{"type":"object","properties":{"email":{"type":"string","format":"email","description":"Employee's personal email address used for communication and onboarding."},"address":{"$ref":"#/components/schemas/ContractsGpPostRequestBodyContentApplicationJsonSchemaDataEmployeeAddress"},"last_name":{"type":"string","description":"Employee's last name."},"first_name":{"type":"string","description":"Employee's first name."},"work_email":{"type":"string","format":"email","description":"Employee's company email address associated with the client organization."},"nationality":{"$ref":"#/components/schemas/ContractsGpPostRequestBodyContentApplicationJsonSchemaDataEmployeeNationality","description":"Employee's nationality in ISO 3166-1 alpha-2 format."},"employee_number":{"type":"string","description":"Internal employee identifier within the client organization."}},"required":["email","address","last_name","first_name","work_email"],"title":"ContractsGpPostRequestBodyContentApplicationJsonSchemaDataEmployee"},"ContractsGpPostRequestBodyContentApplicationJsonSchemaDataEmploymentType":{"type":"string","enum":["Full-time","Part-time"],"description":"Employment type indicating whether the employee works full-time or part-time.","title":"ContractsGpPostRequestBodyContentApplicationJsonSchemaDataEmploymentType"},"ContractsGpPostRequestBodyContentApplicationJsonSchemaDataEmploymentCountry":{"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","XA","XB","XC","XK","XX","YE","YT","ZA","ZM","ZW"],"description":"Country where the employee is employed, in ISO 3166-1 alpha-2 format. Used as the contract country. Falls back to employee address country if not provided.","title":"ContractsGpPostRequestBodyContentApplicationJsonSchemaDataEmploymentCountry"},"ContractsGpPostRequestBodyContentApplicationJsonSchemaDataEmploymentHolidays":{"type":"object","properties":{"allowance":{"type":"number","format":"double","description":"Number of paid holiday days allocated per year."},"start_date":{"type":"string","format":"date","description":"Date when the holiday entitlement becomes effective (ISO-8601 YYYY-MM-DD)."}},"required":["allowance","start_date"],"title":"ContractsGpPostRequestBodyContentApplicationJsonSchemaDataEmploymentHolidays"},"ContractsGpPostRequestBodyContentApplicationJsonSchemaDataEmployment":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/ContractsGpPostRequestBodyContentApplicationJsonSchemaDataEmploymentType","description":"Employment type indicating whether the employee works full-time or part-time."},"country":{"$ref":"#/components/schemas/ContractsGpPostRequestBodyContentApplicationJsonSchemaDataEmploymentCountry","description":"Country where the employee is employed, in ISO 3166-1 alpha-2 format. Used as the contract country. Falls back to employee address country if not provided."},"holidays":{"$ref":"#/components/schemas/ContractsGpPostRequestBodyContentApplicationJsonSchemaDataEmploymentHolidays"},"start_date":{"type":"string","format":"date","description":"Employment start date in ISO-8601 format (YYYY-MM-DD)."}},"required":["type","holidays","start_date"],"title":"ContractsGpPostRequestBodyContentApplicationJsonSchemaDataEmployment"},"ContractsGpPostRequestBodyContentApplicationJsonSchemaDataWorkLocation":{"type":"object","properties":{"name":{"type":"string","description":"Name of the registered entity address where the employee works. Use 'Remote' if applicable."},"is_wfh":{"type":"boolean","description":"Indicates whether the employee works remotely."},"effective_date":{"type":"string","format":"date","description":"Date when the work location becomes effective (ISO-8601 YYYY-MM-DD)."}},"required":["is_wfh"],"description":"Work location details for the employee. Required for US legal entities.","title":"ContractsGpPostRequestBodyContentApplicationJsonSchemaDataWorkLocation"},"ContractsGpPostRequestBodyContentApplicationJsonSchemaDataCompensationDetailsScale":{"type":"string","enum":["YEAR","MONTH"],"default":"YEAR","description":"Defines whether the salary amount represents yearly or monthly gross compensation.","title":"ContractsGpPostRequestBodyContentApplicationJsonSchemaDataCompensationDetailsScale"},"ContractsGpPostRequestBodyContentApplicationJsonSchemaDataCompensationDetails":{"type":"object","properties":{"scale":{"$ref":"#/components/schemas/ContractsGpPostRequestBodyContentApplicationJsonSchemaDataCompensationDetailsScale","description":"Defines whether the salary amount represents yearly or monthly gross compensation."},"salary":{"type":"number","format":"double","description":"Gross salary amount based on the selected scale."},"currency":{"type":"string","description":"Three-letter ISO 4217 currency code representing the salary currency."}},"required":["scale","salary"],"title":"ContractsGpPostRequestBodyContentApplicationJsonSchemaDataCompensationDetails"},"ContractsGpPostRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"client":{"$ref":"#/components/schemas/ContractsGpPostRequestBodyContentApplicationJsonSchemaDataClient"},"employee":{"$ref":"#/components/schemas/ContractsGpPostRequestBodyContentApplicationJsonSchemaDataEmployee"},"job_title":{"type":"string","description":"Employee's official job title as stated in the employment agreement."},"employment":{"$ref":"#/components/schemas/ContractsGpPostRequestBodyContentApplicationJsonSchemaDataEmployment"},"work_location":{"$ref":"#/components/schemas/ContractsGpPostRequestBodyContentApplicationJsonSchemaDataWorkLocation","description":"Work location details for the employee. Required for US legal entities."},"compensation_details":{"$ref":"#/components/schemas/ContractsGpPostRequestBodyContentApplicationJsonSchemaDataCompensationDetails"},"invite_employee_to_app":{"type":"boolean","description":"When true, the employee will receive an invitation to join the platform for onboarding."}},"required":["client","employee","job_title","employment","compensation_details"],"title":"ContractsGpPostRequestBodyContentApplicationJsonSchemaData"},"ContractsGpPostResponsesContentApplicationJsonSchemaDataType":{"type":"string","enum":["ongoing_time_based","milestones","time_based","pay_as_you_go_time_based","commission","payg_milestones","payg_tasks","eor","unknown","employee","global_payroll","shield_msa","hris_direct_employee","peo"],"description":"Type of a contract.","title":"ContractsGpPostResponsesContentApplicationJsonSchemaDataType"},"ContractsGpPostResponsesContentApplicationJsonSchemaDataClientLegalEntity":{"type":"object","properties":{"name":{"type":"string","description":"Legal entity name."}},"title":"ContractsGpPostResponsesContentApplicationJsonSchemaDataClientLegalEntity"},"ContractsGpPostResponsesContentApplicationJsonSchemaDataClient":{"type":"object","properties":{"legal_entity":{"$ref":"#/components/schemas/ContractsGpPostResponsesContentApplicationJsonSchemaDataClientLegalEntity"}},"title":"ContractsGpPostResponsesContentApplicationJsonSchemaDataClient"},"ContractsGpPostResponsesContentApplicationJsonSchemaDataStatus":{"type":"string","enum":["new","under_review","waiting_for_employee_contract","waiting_for_client_sign","processing_payment","waiting_for_contractor_sign","waiting_for_eor_sign","waiting_for_employee_sign","awaiting_deposit_payment","in_progress","completed","cancelled","user_cancelled","rejected","waiting_for_client_payment","onboarding"],"description":"Status of a contract in Deel workflow.","title":"ContractsGpPostResponsesContentApplicationJsonSchemaDataStatus"},"ContractsGpPostResponsesContentApplicationJsonSchemaDataEmployee":{"type":"object","properties":{"email":{"type":"string","description":"Employee's email address."},"last_name":{"type":"string","description":"Employee's last name."},"first_name":{"type":"string","description":"Employee's first name."},"employee_number":{"type":["string","null"],"description":"Employee's number."}},"title":"ContractsGpPostResponsesContentApplicationJsonSchemaDataEmployee"},"ContractsGpPostResponsesContentApplicationJsonSchemaDataEmploymentHolidays":{"type":"object","properties":{"allowance":{"type":"number","format":"double","description":"Number of holidays."},"start_date":{"type":["string","null"],"format":"date-time","description":"Long date-time format following ISO-8601."}},"title":"ContractsGpPostResponsesContentApplicationJsonSchemaDataEmploymentHolidays"},"ContractsGpPostResponsesContentApplicationJsonSchemaDataEmployment":{"type":"object","properties":{"type":{"type":"string","description":"Is it a full-time contract or a part-time contract?"},"state":{"type":["string","null"],"description":"State code of the state/province where this person will be employed."},"country":{"type":"string","description":"Country of employment."},"end_date":{"type":["string","null"],"format":"date-time","description":"Long date-time format following ISO-8601."},"holidays":{"$ref":"#/components/schemas/ContractsGpPostResponsesContentApplicationJsonSchemaDataEmploymentHolidays"},"start_date":{"type":["string","null"],"format":"date-time","description":"Long date-time format following ISO-8601."},"work_visa_required":{"type":"boolean","description":"Do you require Deel to apply for a work visa for this person?"}},"title":"ContractsGpPostResponsesContentApplicationJsonSchemaDataEmployment"},"ContractsGpPostResponsesContentApplicationJsonSchemaDataCompensationDetails":{"type":"object","properties":{"scale":{"type":"string","description":"Scale at which the salary is paid."},"salary":{"type":"number","format":"double","description":"Gross annual/month salary."},"currency":{"type":"string","description":"Currency of gross annual/month salary."}},"title":"ContractsGpPostResponsesContentApplicationJsonSchemaDataCompensationDetails"},"ContractsGpPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","description":"Id of the contract created."},"type":{"$ref":"#/components/schemas/ContractsGpPostResponsesContentApplicationJsonSchemaDataType","description":"Type of a contract."},"client":{"$ref":"#/components/schemas/ContractsGpPostResponsesContentApplicationJsonSchemaDataClient"},"status":{"$ref":"#/components/schemas/ContractsGpPostResponsesContentApplicationJsonSchemaDataStatus","description":"Status of a contract in Deel workflow."},"employee":{"$ref":"#/components/schemas/ContractsGpPostResponsesContentApplicationJsonSchemaDataEmployee"},"job_title":{"type":"string","description":"Employee's job title."},"created_at":{"type":["string","null"],"format":"date-time","description":"Long date-time format following ISO-8601."},"employment":{"$ref":"#/components/schemas/ContractsGpPostResponsesContentApplicationJsonSchemaDataEmployment"},"compensation_details":{"$ref":"#/components/schemas/ContractsGpPostResponsesContentApplicationJsonSchemaDataCompensationDetails"}},"title":"ContractsGpPostResponsesContentApplicationJsonSchemaData"},"gp-hiring_createGPContract_Response_201":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ContractsGpPostResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"gp-hiring_createGPContract_Response_201"},"ContractsGpPostResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code"},"message":{"type":"string","description":"Human-readable explanation of the error"}},"title":"ContractsGpPostResponsesContentApplicationJsonSchemaErrorsItems"},"CreateAGlobalPayrollGpContract-v2026-01-01RequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ContractsGpPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"CreateAGlobalPayrollGpContract-v2026-01-01RequestBadRequestError"},"CreateAGlobalPayrollGpContract-v2026-01-01RequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ContractsGpPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"CreateAGlobalPayrollGpContract-v2026-01-01RequestInternalServerError"},"GpWorkersWorkerIdTerminationsPostRequestBodyContentApplicationJsonSchemaDataSeveranceOneOf0Type":{"type":"string","enum":["TIME"],"description":"The type of severance, either in time off.","title":"GpWorkersWorkerIdTerminationsPostRequestBodyContentApplicationJsonSchemaDataSeveranceOneOf0Type"},"GpWorkersWorkerIdTerminationsPostRequestBodyContentApplicationJsonSchemaDataSeveranceOneOf0TimeUnit":{"type":"string","enum":["DAYS","WEEKS","MONTHS"],"description":"The unit of time for severance (e.g., DAYS, WEEKS, MONTHS).","title":"GpWorkersWorkerIdTerminationsPostRequestBodyContentApplicationJsonSchemaDataSeveranceOneOf0TimeUnit"},"GpWorkersWorkerIdTerminationsPostRequestBodyContentApplicationJsonSchemaDataSeverance0":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/GpWorkersWorkerIdTerminationsPostRequestBodyContentApplicationJsonSchemaDataSeveranceOneOf0Type","description":"The type of severance, either in time off."},"amount":{"type":"number","format":"double","description":"The amount of severance, specified in the designated currency or time unit."},"currency":{"type":"string","description":"Currency code for severance."},"time_unit":{"$ref":"#/components/schemas/GpWorkersWorkerIdTerminationsPostRequestBodyContentApplicationJsonSchemaDataSeveranceOneOf0TimeUnit","description":"The unit of time for severance (e.g., DAYS, WEEKS, MONTHS)."}},"required":["type","amount","currency","time_unit"],"title":"GpWorkersWorkerIdTerminationsPostRequestBodyContentApplicationJsonSchemaDataSeverance0"},"GpWorkersWorkerIdTerminationsPostRequestBodyContentApplicationJsonSchemaDataSeveranceOneOf1Type":{"type":"string","enum":["CASH"],"description":"The type of severance, in cash.","title":"GpWorkersWorkerIdTerminationsPostRequestBodyContentApplicationJsonSchemaDataSeveranceOneOf1Type"},"GpWorkersWorkerIdTerminationsPostRequestBodyContentApplicationJsonSchemaDataSeverance1":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/GpWorkersWorkerIdTerminationsPostRequestBodyContentApplicationJsonSchemaDataSeveranceOneOf1Type","description":"The type of severance, in cash."},"amount":{"type":"number","format":"double","description":"The amount of severance, specified in the designated currency."},"currency":{"type":"string","description":"Currency code for severance."}},"required":["type","amount","currency"],"title":"GpWorkersWorkerIdTerminationsPostRequestBodyContentApplicationJsonSchemaDataSeverance1"},"GpWorkersWorkerIdTerminationsPostRequestBodyContentApplicationJsonSchemaDataSeverance":{"oneOf":[{"$ref":"#/components/schemas/GpWorkersWorkerIdTerminationsPostRequestBodyContentApplicationJsonSchemaDataSeverance0"},{"$ref":"#/components/schemas/GpWorkersWorkerIdTerminationsPostRequestBodyContentApplicationJsonSchemaDataSeverance1"}],"title":"GpWorkersWorkerIdTerminationsPostRequestBodyContentApplicationJsonSchemaDataSeverance"},"GpWorkersWorkerIdTerminationsPostRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"message":{"type":"string","description":"The reason for terminating the worker's engagement."},"severance":{"$ref":"#/components/schemas/GpWorkersWorkerIdTerminationsPostRequestBodyContentApplicationJsonSchemaDataSeverance"},"is_voluntary":{"type":"boolean","description":"Indicates whether the worker termination is voluntary (true) or involuntary (false)."},"desired_end_date":{"type":"string","format":"date","description":"The preferred end date for terminating the worker's engagement, in ISO-8601 format (YYYY-MM-DD)."},"last_date_of_work":{"type":"string","format":"date","description":"The effective termination date of the worker's employment, in ISO-8601 format (YYYY-MM-DD)."}},"required":["message","severance","is_voluntary","desired_end_date","last_date_of_work"],"title":"GpWorkersWorkerIdTerminationsPostRequestBodyContentApplicationJsonSchemaData"},"GpWorkersWorkerIdTerminationsPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the termination request."},"last_date_of_work":{"type":"string","format":"date-time","description":"Long date-time format following ISO-8601."}},"required":["id","last_date_of_work"],"title":"GpWorkersWorkerIdTerminationsPostResponsesContentApplicationJsonSchemaData"},"gp-hiring_createGPWorkerTermination_Response_201":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/GpWorkersWorkerIdTerminationsPostResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"gp-hiring_createGPWorkerTermination_Response_201"},"GroupsIdClonePostRequestBodyContentApplicationJsonSchemaDataExternalMetadata":{"type":"object","properties":{},"description":"The extra information of the group to be created.","title":"GroupsIdClonePostRequestBodyContentApplicationJsonSchemaDataExternalMetadata"},"GroupsIdClonePostRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"name":{"type":"string","description":"The name of the group to be created."},"external_metadata":{"$ref":"#/components/schemas/GroupsIdClonePostRequestBodyContentApplicationJsonSchemaDataExternalMetadata","description":"The extra information of the group to be created."}},"required":["name"],"title":"GroupsIdClonePostRequestBodyContentApplicationJsonSchemaData"},"GroupsIdClonePostResponsesContentApplicationJsonSchemaDataExternalMetadata":{"type":"object","properties":{},"description":"Extra information of the group.","title":"GroupsIdClonePostResponsesContentApplicationJsonSchemaDataExternalMetadata"},"GroupsIdClonePostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the created group."},"name":{"type":"string","description":"The name of the created group."},"created_at":{"type":"string","format":"date-time","description":"The timestamp when the group was created."},"updated_at":{"type":"string","format":"date-time","description":"The timestamp when the group was last updated."},"external_metadata":{"$ref":"#/components/schemas/GroupsIdClonePostResponsesContentApplicationJsonSchemaDataExternalMetadata","description":"Extra information of the group."}},"title":"GroupsIdClonePostResponsesContentApplicationJsonSchemaData"},"groups_cloneGroup_Response_201":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/GroupsIdClonePostResponsesContentApplicationJsonSchemaData"}},"title":"groups_cloneGroup_Response_201"},"GroupsIdClonePostResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"message":{"type":"string","description":"A description of the returned error"}},"title":"GroupsIdClonePostResponsesContentApplicationJsonSchemaErrorsItems"},"CloneAGroupRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/GroupsIdClonePostResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"CloneAGroupRequestBadRequestError"},"GroupsPostRequestBodyContentApplicationJsonSchemaDataExternalMetadata":{"type":"object","properties":{},"description":"The extra information of the group to be created.","title":"GroupsPostRequestBodyContentApplicationJsonSchemaDataExternalMetadata"},"GroupsPostRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"name":{"type":"string","description":"The name of the group to be created."},"external_metadata":{"$ref":"#/components/schemas/GroupsPostRequestBodyContentApplicationJsonSchemaDataExternalMetadata","description":"The extra information of the group to be created."}},"required":["name"],"title":"GroupsPostRequestBodyContentApplicationJsonSchemaData"},"GroupsPostResponsesContentApplicationJsonSchemaDataExternalMetadata":{"type":"object","properties":{},"description":"Extra information of the group.","title":"GroupsPostResponsesContentApplicationJsonSchemaDataExternalMetadata"},"GroupsPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the created group."},"name":{"type":"string","description":"The name of the created group."},"created_at":{"type":"string","format":"date-time","description":"The timestamp when the group was created."},"updated_at":{"type":"string","format":"date-time","description":"The timestamp when the group was last updated."},"external_metadata":{"$ref":"#/components/schemas/GroupsPostResponsesContentApplicationJsonSchemaDataExternalMetadata","description":"Extra information of the group."}},"title":"GroupsPostResponsesContentApplicationJsonSchemaData"},"groups_createGroup_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/GroupsPostResponsesContentApplicationJsonSchemaData"}},"title":"groups_createGroup_Response_200"},"GroupsPostResponsesContentApplicationJsonSchemaError":{"type":"object","properties":{"message":{"type":"string","description":"Description of the error."}},"title":"GroupsPostResponsesContentApplicationJsonSchemaError"},"CreateGroupRequestBadRequestError":{"type":"object","properties":{"error":{"$ref":"#/components/schemas/GroupsPostResponsesContentApplicationJsonSchemaError"}},"title":"CreateGroupRequestBadRequestError"},"GroupsIdDeleteResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"archived_at":{"type":"string","format":"date-time","description":"The timestamp when the group was archived."}},"title":"GroupsIdDeleteResponsesContentApplicationJsonSchemaData"},"groups_deleteGroup_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/GroupsIdDeleteResponsesContentApplicationJsonSchemaData"}},"title":"groups_deleteGroup_Response_200"},"GroupsIdDeleteResponsesContentApplicationJsonSchemaError":{"type":"object","properties":{"message":{"type":"string","description":"Group not found error message."}},"title":"GroupsIdDeleteResponsesContentApplicationJsonSchemaError"},"DeleteGroupRequestBadRequestError":{"type":"object","properties":{"error":{"$ref":"#/components/schemas/GroupsIdDeleteResponsesContentApplicationJsonSchemaError"}},"title":"DeleteGroupRequestBadRequestError"},"DeleteGroupRequestNotFoundError":{"type":"object","properties":{"error":{"$ref":"#/components/schemas/GroupsIdDeleteResponsesContentApplicationJsonSchemaError"}},"title":"DeleteGroupRequestNotFoundError"},"GroupsIdPatchRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"name":{"type":"string","description":"The updated name of the group."}},"required":["name"],"title":"GroupsIdPatchRequestBodyContentApplicationJsonSchemaData"},"GroupsIdPatchResponsesContentApplicationJsonSchemaDataExternalMetadata":{"type":"object","properties":{},"description":"Extra information of the group.","title":"GroupsIdPatchResponsesContentApplicationJsonSchemaDataExternalMetadata"},"GroupsIdPatchResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the updated group."},"name":{"type":"string","description":"The updated name of the group."},"created_at":{"type":"string","format":"date-time","description":"The timestamp when the group was created."},"updated_at":{"type":"string","format":"date-time","description":"The timestamp when the group was last updated."},"external_metadata":{"$ref":"#/components/schemas/GroupsIdPatchResponsesContentApplicationJsonSchemaDataExternalMetadata","description":"Extra information of the group."}},"title":"GroupsIdPatchResponsesContentApplicationJsonSchemaData"},"groups_updateGroup_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/GroupsIdPatchResponsesContentApplicationJsonSchemaData"}},"title":"groups_updateGroup_Response_200"},"GroupsIdPatchResponsesContentApplicationJsonSchemaError":{"type":"object","properties":{"message":{"type":"string","description":"Description of the error."}},"title":"GroupsIdPatchResponsesContentApplicationJsonSchemaError"},"EditGroupRequestBadRequestError":{"type":"object","properties":{"error":{"$ref":"#/components/schemas/GroupsIdPatchResponsesContentApplicationJsonSchemaError"}},"title":"EditGroupRequestBadRequestError"},"GroupsGetParametersSortOrder":{"type":"string","enum":["ASC","DESC"],"default":"ASC","title":"GroupsGetParametersSortOrder"},"GroupsGetResponsesContentApplicationJsonSchemaDataItemsStatus":{"type":"string","enum":["active","archived"],"description":"The current status of the group (active or archived).","title":"GroupsGetResponsesContentApplicationJsonSchemaDataItemsStatus"},"GroupsGetResponsesContentApplicationJsonSchemaDataItemsExternalMetadata":{"type":"object","properties":{},"description":"Extra information about the group.","title":"GroupsGetResponsesContentApplicationJsonSchemaDataItemsExternalMetadata"},"GroupsGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the group."},"name":{"type":"string","description":"The name of the group."},"status":{"$ref":"#/components/schemas/GroupsGetResponsesContentApplicationJsonSchemaDataItemsStatus","description":"The current status of the group (active or archived)."},"managers":{"type":"number","format":"double","description":"The number of managers associated with the group."},"created_at":{"type":"string","format":"date-time","description":"The timestamp when the group was created."},"updated_at":{"type":"string","format":"date-time","description":"The timestamp when the group was last updated."},"archived_at":{"type":["string","null"],"format":"date-time","description":"The timestamp when the group was archived (if applicable)."},"external_metadata":{"$ref":"#/components/schemas/GroupsGetResponsesContentApplicationJsonSchemaDataItemsExternalMetadata","description":"Extra information about the group."}},"title":"GroupsGetResponsesContentApplicationJsonSchemaDataItems"},"GroupsGetResponsesContentApplicationJsonSchemaPage":{"type":"object","properties":{"cursor":{"type":"string","description":"An opaque cursor to fetch the next set of results."},"total_rows":{"type":"integer","description":"The total number of groups available for the current query (including pagination)."}},"title":"GroupsGetResponsesContentApplicationJsonSchemaPage"},"groups_getGroups_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/GroupsGetResponsesContentApplicationJsonSchemaDataItems"}},"page":{"$ref":"#/components/schemas/GroupsGetResponsesContentApplicationJsonSchemaPage"}},"title":"groups_getGroups_Response_200"},"GetGroupsRequestBadRequestError":{"type":"object","properties":{"message":{"type":"string","description":"Error message explaining what went wrong."}},"title":"GetGroupsRequestBadRequestError"},"EorContractsContractIdHrxDocumentsDocumentIdGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"url":{"type":"string","format":"uri","description":"Pre-signed URL to download the HRX document PDF. Valid for 15 minutes."},"created_at":{"type":"string","format":"date-time","description":"When the document was created"},"updated_at":{"type":"string","format":"date-time","description":"When the document was last updated"}},"required":["url","created_at","updated_at"],"description":"Download information for the HRX document","title":"EorContractsContractIdHrxDocumentsDocumentIdGetResponsesContentApplicationJsonSchemaData"},"HRX Documents_downloadHrxDocuments_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EorContractsContractIdHrxDocumentsDocumentIdGetResponsesContentApplicationJsonSchemaData","description":"Download information for the HRX document"}},"required":["data"],"title":"HRX Documents_downloadHrxDocuments_Response_200"},"EorContractsContractIdHrxDocumentsDocumentIdGetResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string","description":"Error code of the handler which produced the returned error"},"field":{"type":"string","description":"The field name where authentication failed"},"message":{"type":"string","description":"Description of the returned error"}},"title":"EorContractsContractIdHrxDocumentsDocumentIdGetResponsesContentApplicationJsonSchemaErrorsItems"},"DownloadHrxDocumentsRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdHrxDocumentsDocumentIdGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"DownloadHrxDocumentsRequestBadRequestError"},"DownloadHrxDocumentsRequestUnauthorizedError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdHrxDocumentsDocumentIdGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"DownloadHrxDocumentsRequestUnauthorizedError"},"EorContractsContractIdHrxDocumentsGetResponsesContentApplicationJsonSchemaDataItemsCategoryType":{"type":"string","enum":["EMPLOYMENT_AGREEMENT","ONBOARDING_REGISTRATION","OFFBOARDING_TERMINATION","TAX_FISCAL","STATUS_BENEFITS","VISA_TRAVEL_SUPPORT","OTHER"],"description":"Type of the document category","title":"EorContractsContractIdHrxDocumentsGetResponsesContentApplicationJsonSchemaDataItemsCategoryType"},"EorContractsContractIdHrxDocumentsGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the employee document"},"name":{"type":"string","description":"Name of the employee document"},"category":{"type":"string","description":"Type of the document category"},"created_at":{"type":"string","format":"date-time","description":"When the document was created"},"updated_at":{"type":"string","format":"date-time","description":"When the document was last updated"},"category_id":{"type":"string","format":"uuid","description":"Unique identifier for the document category"},"category_type":{"$ref":"#/components/schemas/EorContractsContractIdHrxDocumentsGetResponsesContentApplicationJsonSchemaDataItemsCategoryType","description":"Type of the document category"},"category_description":{"type":"string","description":"Description of the document category"}},"required":["id","name","category","created_at","updated_at","category_id","category_type","category_description"],"title":"EorContractsContractIdHrxDocumentsGetResponsesContentApplicationJsonSchemaDataItems"},"HRX Documents_retrieveHrxDocuments_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdHrxDocumentsGetResponsesContentApplicationJsonSchemaDataItems"},"description":"List of employee documents"},"has_more":{"type":"boolean","description":"Indicates if there are more pages available"},"next_cursor":{"type":["string","null"],"description":"Cursor to use for the next page. Null if there are no more pages."},"total_count":{"type":"integer","description":"Total number of documents available across all pages"}},"required":["data","has_more","next_cursor","total_count"],"title":"HRX Documents_retrieveHrxDocuments_Response_200"},"EorContractsContractIdHrxDocumentsGetResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string","description":"Error code of the handler which produced the returned error"},"field":{"type":"string","description":"The field name where authentication failed"},"message":{"type":"string","description":"Description of the returned error"}},"title":"EorContractsContractIdHrxDocumentsGetResponsesContentApplicationJsonSchemaErrorsItems"},"RetrieveHrxDocumentsRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdHrxDocumentsGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"RetrieveHrxDocumentsRequestBadRequestError"},"RetrieveHrxDocumentsRequestUnauthorizedError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdHrxDocumentsGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"RetrieveHrxDocumentsRequestUnauthorizedError"},"RetrieveHrxDocumentsRequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EorContractsContractIdHrxDocumentsGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"RetrieveHrxDocumentsRequestInternalServerError"},"ContractsContractIdIcInvoicingTaxesPostRequestBodyContentApplicationJsonSchemaDataTaxType":{"type":"string","enum":["WITHHOLDING_TAX","VAT"],"description":"Type of IC invoicing tax.","title":"ContractsContractIdIcInvoicingTaxesPostRequestBodyContentApplicationJsonSchemaDataTaxType"},"ContractsContractIdIcInvoicingTaxesPostRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"tax_type":{"$ref":"#/components/schemas/ContractsContractIdIcInvoicingTaxesPostRequestBodyContentApplicationJsonSchemaDataTaxType","description":"Type of IC invoicing tax."},"percentage":{"type":"number","format":"double","description":"Tax percentage amount."}},"required":["tax_type","percentage"],"title":"ContractsContractIdIcInvoicingTaxesPostRequestBodyContentApplicationJsonSchemaData"},"IC invoicing taxes_createIcInvoicingTax_Response_201":{"type":"object","properties":{},"description":"Empty response body","title":"IC invoicing taxes_createIcInvoicingTax_Response_201"},"ContractsContractIdIcInvoicingTaxesPostResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code"},"message":{"type":"string","description":"Human-readable explanation of the error"}},"title":"ContractsContractIdIcInvoicingTaxesPostResponsesContentApplicationJsonSchemaErrorsItems"},"CreateIcInvoicingTaxRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ContractsContractIdIcInvoicingTaxesPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"CreateIcInvoicingTaxRequestBadRequestError"},"CreateIcInvoicingTaxRequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ContractsContractIdIcInvoicingTaxesPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"CreateIcInvoicingTaxRequestInternalServerError"},"ContractsContractIdIcInvoicingTaxesTaxTypeDeleteParametersTaxType":{"type":"string","enum":["WITHHOLDING_TAX","VAT"],"title":"ContractsContractIdIcInvoicingTaxesTaxTypeDeleteParametersTaxType"},"IC invoicing taxes_deleteIcInvoicingTax_Response_204":{"type":"object","properties":{},"description":"Empty response body","title":"IC invoicing taxes_deleteIcInvoicingTax_Response_204"},"ContractsContractIdIcInvoicingTaxesTaxTypeDeleteResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code"},"message":{"type":"string","description":"Human-readable explanation of the error"}},"title":"ContractsContractIdIcInvoicingTaxesTaxTypeDeleteResponsesContentApplicationJsonSchemaErrorsItems"},"DeleteIcInvoicingTaxRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ContractsContractIdIcInvoicingTaxesTaxTypeDeleteResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"DeleteIcInvoicingTaxRequestBadRequestError"},"DeleteIcInvoicingTaxRequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ContractsContractIdIcInvoicingTaxesTaxTypeDeleteResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"DeleteIcInvoicingTaxRequestInternalServerError"},"ContractsContractIdIcInvoicingTaxesGetResponsesContentApplicationJsonSchemaDataVat":{"type":"object","properties":{"percentage":{"type":["number","null"],"format":"double","description":"VAT percentage"}},"description":"VAT tax details (if applicable)","title":"ContractsContractIdIcInvoicingTaxesGetResponsesContentApplicationJsonSchemaDataVat"},"ContractsContractIdIcInvoicingTaxesGetResponsesContentApplicationJsonSchemaDataWithholdingTax":{"type":"object","properties":{"percentage":{"type":["number","null"],"format":"double","description":"Withholding tax percentage"}},"description":"Withholding tax details (if applicable)","title":"ContractsContractIdIcInvoicingTaxesGetResponsesContentApplicationJsonSchemaDataWithholdingTax"},"ContractsContractIdIcInvoicingTaxesGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","description":"Deel contract ID"},"vat":{"oneOf":[{"$ref":"#/components/schemas/ContractsContractIdIcInvoicingTaxesGetResponsesContentApplicationJsonSchemaDataVat"},{"type":"null"}],"description":"VAT tax details (if applicable)"},"withholding_tax":{"oneOf":[{"$ref":"#/components/schemas/ContractsContractIdIcInvoicingTaxesGetResponsesContentApplicationJsonSchemaDataWithholdingTax"},{"type":"null"}],"description":"Withholding tax details (if applicable)"}},"required":["id"],"title":"ContractsContractIdIcInvoicingTaxesGetResponsesContentApplicationJsonSchemaData"},"IC invoicing taxes_getIcInvoicingTaxes_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ContractsContractIdIcInvoicingTaxesGetResponsesContentApplicationJsonSchemaData"}},"title":"IC invoicing taxes_getIcInvoicingTaxes_Response_200"},"ContractsContractIdIcInvoicingTaxesGetResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code"},"message":{"type":"string","description":"Human-readable explanation of the error"}},"title":"ContractsContractIdIcInvoicingTaxesGetResponsesContentApplicationJsonSchemaErrorsItems"},"GetIcInvoicingTaxesRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ContractsContractIdIcInvoicingTaxesGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"GetIcInvoicingTaxesRequestBadRequestError"},"GetIcInvoicingTaxesRequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ContractsContractIdIcInvoicingTaxesGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"GetIcInvoicingTaxesRequestInternalServerError"},"ContractsContractIdIcInvoicingTaxesPatchRequestBodyContentApplicationJsonSchemaDataTaxType":{"type":"string","enum":["WITHHOLDING_TAX","VAT"],"description":"Type of IC invoicing tax.","title":"ContractsContractIdIcInvoicingTaxesPatchRequestBodyContentApplicationJsonSchemaDataTaxType"},"ContractsContractIdIcInvoicingTaxesPatchRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"tax_type":{"$ref":"#/components/schemas/ContractsContractIdIcInvoicingTaxesPatchRequestBodyContentApplicationJsonSchemaDataTaxType","description":"Type of IC invoicing tax."},"percentage":{"type":"number","format":"double","description":"Tax percentage amount."}},"required":["tax_type","percentage"],"title":"ContractsContractIdIcInvoicingTaxesPatchRequestBodyContentApplicationJsonSchemaData"},"IC invoicing taxes_updateIcInvoicingTax_Response_204":{"type":"object","properties":{},"description":"Empty response body","title":"IC invoicing taxes_updateIcInvoicingTax_Response_204"},"ContractsContractIdIcInvoicingTaxesPatchResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code"},"message":{"type":"string","description":"Human-readable explanation of the error"}},"title":"ContractsContractIdIcInvoicingTaxesPatchResponsesContentApplicationJsonSchemaErrorsItems"},"UpdateIcInvoicingTaxRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ContractsContractIdIcInvoicingTaxesPatchResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"UpdateIcInvoicingTaxRequestBadRequestError"},"UpdateIcInvoicingTaxRequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ContractsContractIdIcInvoicingTaxesPatchResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"UpdateIcInvoicingTaxRequestInternalServerError"},"ImmigrationClientCasesPostRequestBodyContentApplicationJsonSchemaDataOneOf0CaseType":{"type":"string","enum":["RIGHT_TO_WORK"],"description":"The type of immigration case to be created. Determines the workflow and requirements","title":"ImmigrationClientCasesPostRequestBodyContentApplicationJsonSchemaDataOneOf0CaseType"},"ImmigrationClientCasesPostRequestBodyContentApplicationJsonSchemaData0":{"type":"object","properties":{"case_type":{"$ref":"#/components/schemas/ImmigrationClientCasesPostRequestBodyContentApplicationJsonSchemaDataOneOf0CaseType","description":"The type of immigration case to be created. Determines the workflow and requirements"},"contract_id":{"type":"string","description":"The contract object identifier. Required for document reviews and visa applications"},"country_code":{"type":"string","description":"ISO 3166-1 alpha-2 country code where the immigration case needs to be processed"}},"required":["case_type","contract_id","country_code"],"title":"ImmigrationClientCasesPostRequestBodyContentApplicationJsonSchemaData0"},"ImmigrationClientCasesPostRequestBodyContentApplicationJsonSchemaDataOneOf1CaseType":{"type":"string","enum":["EOR_VISA"],"description":"The type of immigration case to be created. Determines the workflow and requirements","title":"ImmigrationClientCasesPostRequestBodyContentApplicationJsonSchemaDataOneOf1CaseType"},"ImmigrationClientCasesPostRequestBodyContentApplicationJsonSchemaData1":{"type":"object","properties":{"case_type":{"$ref":"#/components/schemas/ImmigrationClientCasesPostRequestBodyContentApplicationJsonSchemaDataOneOf1CaseType","description":"The type of immigration case to be created. Determines the workflow and requirements"},"contract_id":{"type":"string","description":"The contract object identifier. Required for document reviews and visa applications"},"country_code":{"type":"string","description":"ISO 3166-1 alpha-2 country code where the immigration case needs to be processed"},"visa_type_id":{"type":"string","format":"uuid","description":"The id of visa type that is being applied for. Identifies the type of the visa."}},"required":["case_type","contract_id","country_code"],"title":"ImmigrationClientCasesPostRequestBodyContentApplicationJsonSchemaData1"},"ImmigrationClientCasesPostRequestBodyContentApplicationJsonSchemaDataOneOf2CaseType":{"type":"string","enum":["SPONSORED_VISA"],"description":"The type of immigration case to be created. Determines the workflow and requirements","title":"ImmigrationClientCasesPostRequestBodyContentApplicationJsonSchemaDataOneOf2CaseType"},"ImmigrationClientCasesPostRequestBodyContentApplicationJsonSchemaData2":{"type":"object","properties":{"case_type":{"$ref":"#/components/schemas/ImmigrationClientCasesPostRequestBodyContentApplicationJsonSchemaDataOneOf2CaseType","description":"The type of immigration case to be created. Determines the workflow and requirements"},"entity_id":{"type":"string","format":"uuid","description":"The unique identifier of the entity sponsoring the visa. Required for sponsored visa applications"},"contract_id":{"type":"string","description":"The contract object identifier. Required for document reviews and visa applications"},"country_code":{"type":"string","description":"ISO 3166-1 alpha-2 country code where the immigration case needs to be processed"},"visa_type_id":{"type":"string","format":"uuid","description":"The id of visa type that is being applied for. Identifies the type of the visa."}},"required":["case_type","entity_id","contract_id","country_code"],"title":"ImmigrationClientCasesPostRequestBodyContentApplicationJsonSchemaData2"},"ImmigrationClientCasesPostRequestBodyContentApplicationJsonSchemaDataOneOf3CaseType":{"type":"string","enum":["PRE_HIRE_EOR_VISA"],"description":"The type of immigration case to be created. Determines the workflow and requirements","title":"ImmigrationClientCasesPostRequestBodyContentApplicationJsonSchemaDataOneOf3CaseType"},"ImmigrationClientCasesPostRequestBodyContentApplicationJsonSchemaData3":{"type":"object","properties":{"team_id":{"type":"string","format":"uuid","description":"The unique identifier of the team for which the pre-hire visa case is being created"},"case_type":{"$ref":"#/components/schemas/ImmigrationClientCasesPostRequestBodyContentApplicationJsonSchemaDataOneOf3CaseType","description":"The type of immigration case to be created. Determines the workflow and requirements"},"country_code":{"type":"string","description":"ISO 3166-1 alpha-2 country code where the immigration case needs to be processed"},"visa_type_id":{"type":"string","format":"uuid","description":"The id of visa type that is being applied for. Identifies the type of the visa."}},"required":["team_id","case_type","country_code"],"title":"ImmigrationClientCasesPostRequestBodyContentApplicationJsonSchemaData3"},"ImmigrationClientCasesPostRequestBodyContentApplicationJsonSchemaDataOneOf4CaseType":{"type":"string","enum":["PRE_HIRE_SPONSORSHIP_VISA"],"description":"The type of immigration case to be created. Determines the workflow and requirements","title":"ImmigrationClientCasesPostRequestBodyContentApplicationJsonSchemaDataOneOf4CaseType"},"ImmigrationClientCasesPostRequestBodyContentApplicationJsonSchemaData4":{"type":"object","properties":{"team_id":{"type":"string","format":"uuid","description":"The unique identifier of the team for which the pre-hire sponsorship visa case is being created"},"case_type":{"$ref":"#/components/schemas/ImmigrationClientCasesPostRequestBodyContentApplicationJsonSchemaDataOneOf4CaseType","description":"The type of immigration case to be created. Determines the workflow and requirements"},"entity_id":{"type":"string","format":"uuid","description":"The unique identifier of the entity sponsoring the visa. Required for sponsored visa applications"},"country_code":{"type":"string","description":"ISO 3166-1 alpha-2 country code where the immigration case needs to be processed"},"visa_type_id":{"type":"string","format":"uuid","description":"The id of visa type that is being applied for. Identifies the type of the visa."}},"required":["team_id","case_type","country_code"],"title":"ImmigrationClientCasesPostRequestBodyContentApplicationJsonSchemaData4"},"ImmigrationClientCasesPostRequestBodyContentApplicationJsonSchemaDataOneOf5CaseType":{"type":"string","enum":["BUSINESS_VISA"],"description":"The type of immigration case to be created. Determines the workflow and requirements","title":"ImmigrationClientCasesPostRequestBodyContentApplicationJsonSchemaDataOneOf5CaseType"},"ImmigrationClientCasesPostRequestBodyContentApplicationJsonSchemaDataOneOf5EmployeeDetails":{"type":"object","properties":{"email":{"type":"string","format":"email","description":"Employee's email address.  Required if contract_id is not provided"},"last_name":{"type":"string","description":"Employee's last name.  Required if contract_id is not provided"},"residence":{"type":"string","description":"ISO 3166-1 alpha-2 country code of employee's current residence"},"first_name":{"type":"string","description":"Employee's first name.  Required if contract_id is not provided"},"citizenships":{"type":"array","items":{"type":"string"},"description":"List of ISO 3166-1 alpha-2 country codes representing employee's citizenships"}},"required":["residence","citizenships"],"description":"Employee information. Citizenships and residence attributes are always required for business visa cases. The remaining fields are only required when no contract_id is present.","title":"ImmigrationClientCasesPostRequestBodyContentApplicationJsonSchemaDataOneOf5EmployeeDetails"},"ImmigrationClientCasesPostRequestBodyContentApplicationJsonSchemaDataOneOf5TravelInformationPurpose":{"type":"string","enum":["INTERNAL_BUSINESS_WITH_WORK_FOR_CLIENT","INTERNAL_BUSINESS_WITHOUT_WORK_FOR_CLIENT","MEETINGS_WITH_OR_FOR_A_CLIENT","MEETINGS_WITH_POTENTIAL_CLIENTS","NEGOTIATING_CONTRACTS_OR_SIGNING_AGREEMENTS","OTHER_EXTERNAL_BUSINESS","CONFERENCE","TEAM_OFFSITE","SPEAKING_AT_CONFERENCE_UNPAID","SPEAKING_AT_CONFERENCE_PAID","ATTENDING_INTERNAL_TRAINING","ATTENDING_EXTERNAL_TRAINING","DELIVERING_TRAINING_TO_INTERNAL_PARTICIPANTS","DELIVERING_TRAINING_TO_EXTERNAL_PARTICIPANTS_UNPAID","DELIVERING_TRAINING_TO_EXTERNAL_PARTICIPANTS_PAID","PARTICIPATION_IN_RESEARCH_PROJECTS_AND_STUDIES","ASSEMBLY_MAINTENANCE_REPAIR_INSTALLATION","TECHNICAL_SUPPORT_OR_SUPERVISION","OTHER_HANDS_ON_LABOUR","MARKET_RESEARCH_AND_EXPLORING_INVESTMENT_OPPORTUNITIES","OTHER"],"description":"The purpose of the business trip","title":"ImmigrationClientCasesPostRequestBodyContentApplicationJsonSchemaDataOneOf5TravelInformationPurpose"},"ImmigrationClientCasesPostRequestBodyContentApplicationJsonSchemaDataOneOf5TravelInformation":{"type":"object","properties":{"purpose":{"$ref":"#/components/schemas/ImmigrationClientCasesPostRequestBodyContentApplicationJsonSchemaDataOneOf5TravelInformationPurpose","description":"The purpose of the business trip"},"end_date":{"type":"string","format":"date","description":"Trip end date in YYYY-MM-DD format"},"start_date":{"type":"string","format":"date","description":"Trip start date in YYYY-MM-DD format"}},"required":["purpose","end_date","start_date"],"description":"Travel details for the business visa","title":"ImmigrationClientCasesPostRequestBodyContentApplicationJsonSchemaDataOneOf5TravelInformation"},"ImmigrationClientCasesPostRequestBodyContentApplicationJsonSchemaData5":{"type":"object","properties":{"team_id":{"type":"string","format":"uuid","description":"The id of the team for which the employee will be added to. Required if contract_id is not provided"},"case_type":{"$ref":"#/components/schemas/ImmigrationClientCasesPostRequestBodyContentApplicationJsonSchemaDataOneOf5CaseType","description":"The type of immigration case to be created. Determines the workflow and requirements"},"entity_id":{"type":"string","format":"uuid","description":"The unique identifier of the entity sponsoring the visa. Required for sponsored visa applications"},"contract_id":{"type":"string","description":"The contract object identifier. If not provided, employee_details and team_id become required"},"country_code":{"type":"string","description":"ISO 3166-1 alpha-2 country code where the immigration case needs to be processed"},"visa_type_id":{"type":"string","format":"uuid","description":"The id of visa type that is being applied for. Identifies the type of the visa"},"employee_details":{"$ref":"#/components/schemas/ImmigrationClientCasesPostRequestBodyContentApplicationJsonSchemaDataOneOf5EmployeeDetails","description":"Employee information. Citizenships and residence attributes are always required for business visa cases. The remaining fields are only required when no contract_id is present."},"travel_information":{"$ref":"#/components/schemas/ImmigrationClientCasesPostRequestBodyContentApplicationJsonSchemaDataOneOf5TravelInformation","description":"Travel details for the business visa"}},"required":["case_type","country_code","visa_type_id","employee_details","travel_information"],"title":"ImmigrationClientCasesPostRequestBodyContentApplicationJsonSchemaData5"},"ImmigrationClientCasesPostRequestBodyContentApplicationJsonSchemaData":{"oneOf":[{"$ref":"#/components/schemas/ImmigrationClientCasesPostRequestBodyContentApplicationJsonSchemaData0"},{"$ref":"#/components/schemas/ImmigrationClientCasesPostRequestBodyContentApplicationJsonSchemaData1"},{"$ref":"#/components/schemas/ImmigrationClientCasesPostRequestBodyContentApplicationJsonSchemaData2"},{"$ref":"#/components/schemas/ImmigrationClientCasesPostRequestBodyContentApplicationJsonSchemaData3"},{"$ref":"#/components/schemas/ImmigrationClientCasesPostRequestBodyContentApplicationJsonSchemaData4"},{"$ref":"#/components/schemas/ImmigrationClientCasesPostRequestBodyContentApplicationJsonSchemaData5"}],"title":"ImmigrationClientCasesPostRequestBodyContentApplicationJsonSchemaData"},"ImmigrationClientCasesPostResponsesContentApplicationJsonSchemaDataStatus":{"type":"string","enum":["OPEN","CLOSED","ON_HOLD"],"description":"Current status of the case","title":"ImmigrationClientCasesPostResponsesContentApplicationJsonSchemaDataStatus"},"ImmigrationClientCasesPostResponsesContentApplicationJsonSchemaDataProcess":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the process"},"status_name":{"type":"string","description":"Human-readable status of the process"},"process_name":{"type":"string","description":"Name of the immigration process"}},"required":["id","status_name","process_name"],"description":"Details about the current immigration process associated with the case","title":"ImmigrationClientCasesPostResponsesContentApplicationJsonSchemaDataProcess"},"ImmigrationClientCasesPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the case"},"status":{"$ref":"#/components/schemas/ImmigrationClientCasesPostResponsesContentApplicationJsonSchemaDataStatus","description":"Current status of the case"},"process":{"$ref":"#/components/schemas/ImmigrationClientCasesPostResponsesContentApplicationJsonSchemaDataProcess","description":"Details about the current immigration process associated with the case"},"created_at":{"type":"string","format":"date-time","description":"Timestamp when the case was created"},"updated_at":{"type":"string","format":"date-time","description":"Timestamp when the case was last updated"},"closure_note":{"type":["string","null"],"description":"Optional note explaining why the case was closed"},"closure_reason":{"type":["string","null"],"description":"Standardized reason for case closure"}},"required":["id","status","process","created_at","updated_at"],"description":"The immigration case data returned after successful creation","title":"ImmigrationClientCasesPostResponsesContentApplicationJsonSchemaData"},"Immigration_createAnImmigrationCase_Response_201":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ImmigrationClientCasesPostResponsesContentApplicationJsonSchemaData","description":"The immigration case data returned after successful creation"}},"required":["data"],"title":"Immigration_createAnImmigrationCase_Response_201"},"ImmigrationClientCasesPostResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code"},"message":{"type":"string","description":"Human-readable explanation of the error"}},"title":"ImmigrationClientCasesPostResponsesContentApplicationJsonSchemaErrorsItems"},"CreateAnImmigrationCaseRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ImmigrationClientCasesPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"CreateAnImmigrationCaseRequestBadRequestError"},"CreateAnImmigrationCaseRequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ImmigrationClientCasesPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"CreateAnImmigrationCaseRequestInternalServerError"},"ImmigrationVisaRequirementBusinessGetParametersTripReason":{"type":"string","enum":["INTERNAL_BUSINESS_WITH_WORK_FOR_CLIENT","INTERNAL_BUSINESS_WITHOUT_WORK_FOR_CLIENT","MEETINGS_WITH_OR_FOR_A_CLIENT","MEETINGS_WITH_POTENTIAL_CLIENTS","NEGOTIATING_CONTRACTS_OR_SIGNING_AGREEMENTS","OTHER_EXTERNAL_BUSINESS","CONFERENCE","TEAM_OFFSITE","SPEAKING_AT_CONFERENCE_UNPAID","SPEAKING_AT_CONFERENCE_PAID","ATTENDING_INTERNAL_TRAINING","ATTENDING_EXTERNAL_TRAINING","DELIVERING_TRAINING_TO_INTERNAL_PARTICIPANTS","DELIVERING_TRAINING_TO_EXTERNAL_PARTICIPANTS_UNPAID","DELIVERING_TRAINING_TO_EXTERNAL_PARTICIPANTS_PAID","PARTICIPATION_IN_RESEARCH_PROJECTS_AND_STUDIES","ASSEMBLY_MAINTENANCE_REPAIR_INSTALLATION","TECHNICAL_SUPPORT_OR_SUPERVISION","OTHER_HANDS_ON_LABOUR","MARKET_RESEARCH_AND_EXPLORING_INVESTMENT_OPPORTUNITIES","OTHER"],"title":"ImmigrationVisaRequirementBusinessGetParametersTripReason"},"ImmigrationVisaRequirementBusinessGetResponsesContentApplicationJsonSchemaDataQualification":{"type":"string","enum":["VISA_REQUIRED","NO_VISA_REQUIRED","UNSUPPORTED"],"description":"Visa qualification status, whether it is required or not. It can be also unsupported if the country does not support business visa options.","title":"ImmigrationVisaRequirementBusinessGetResponsesContentApplicationJsonSchemaDataQualification"},"ImmigrationVisaRequirementBusinessGetResponsesContentApplicationJsonSchemaDataEstimatedTimeline":{"type":"string","enum":["SIX_WEEKS","THREE_MONTHS","ONE_WEEK","THREE_WEEKS","ONE_YEAR","TWO_WEEKS","FIVE_WEEKS","TWO_MONTHS","FIVE_MONTHS","FOUR_MONTHS","SIX_MONTHS","FOUR_WEEKS"],"description":"Estimated processing timeline, in weeks, months or years","title":"ImmigrationVisaRequirementBusinessGetResponsesContentApplicationJsonSchemaDataEstimatedTimeline"},"ImmigrationVisaRequirementBusinessGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"fee":{"type":["number","null"],"format":"double","description":"Fee amount"},"name":{"type":["string","null"],"description":"Name of the visa type"},"description":{"type":"string","description":"Description of the visa type"},"fee_currency":{"type":["string","null"],"description":"Currency code for the fee in ISO 4217 format"},"visa_type_id":{"type":["string","null"],"format":"uuid","description":"Unique identifier of the visa type. This can be used to create a new business visa case on the create cases endpoint."},"qualification":{"$ref":"#/components/schemas/ImmigrationVisaRequirementBusinessGetResponsesContentApplicationJsonSchemaDataQualification","description":"Visa qualification status, whether it is required or not. It can be also unsupported if the country does not support business visa options."},"estimated_timeline":{"oneOf":[{"$ref":"#/components/schemas/ImmigrationVisaRequirementBusinessGetResponsesContentApplicationJsonSchemaDataEstimatedTimeline"},{"type":"null"}],"description":"Estimated processing timeline, in weeks, months or years"}},"required":["fee","name","description","fee_currency","visa_type_id","qualification","estimated_timeline"],"title":"ImmigrationVisaRequirementBusinessGetResponsesContentApplicationJsonSchemaData"},"immigration_getBusinessVisaRequirement_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ImmigrationVisaRequirementBusinessGetResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"immigration_getBusinessVisaRequirement_Response_200"},"ImmigrationVisaRequirementBusinessGetResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code"},"message":{"type":"string","description":"Human-readable explanation of the error"}},"title":"ImmigrationVisaRequirementBusinessGetResponsesContentApplicationJsonSchemaErrorsItems"},"GetBusinessVisaEligibilityAndRequirementsRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ImmigrationVisaRequirementBusinessGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"GetBusinessVisaEligibilityAndRequirementsRequestBadRequestError"},"GetBusinessVisaEligibilityAndRequirementsRequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ImmigrationVisaRequirementBusinessGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"GetBusinessVisaEligibilityAndRequirementsRequestInternalServerError"},"ImmigrationClientCasesIdGetResponsesContentApplicationJsonSchemaDataStatus":{"type":"string","enum":["OPEN","CLOSED","ON_HOLD"],"description":"Status of the immigration case.","title":"ImmigrationClientCasesIdGetResponsesContentApplicationJsonSchemaDataStatus"},"ImmigrationClientCasesIdGetResponsesContentApplicationJsonSchemaDataProcess":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the current active process."},"name":{"type":"string","description":"Name of the current active process."},"status":{"type":"string","description":"Status of the current active process."}},"title":"ImmigrationClientCasesIdGetResponsesContentApplicationJsonSchemaDataProcess"},"ImmigrationClientCasesIdGetResponsesContentApplicationJsonSchemaDataApplicant":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the applicant profile id."},"external_id":{"type":["string","null"],"description":"External identifier of the applicant."}},"title":"ImmigrationClientCasesIdGetResponsesContentApplicationJsonSchemaDataApplicant"},"ImmigrationClientCasesIdGetResponsesContentApplicationJsonSchemaDataDocumentsItemsStatus":{"type":"string","enum":["IN_REVIEW","APPROVED","REJECTED"],"description":"Status of the document.","title":"ImmigrationClientCasesIdGetResponsesContentApplicationJsonSchemaDataDocumentsItemsStatus"},"ImmigrationClientCasesIdGetResponsesContentApplicationJsonSchemaDataDocumentsItems":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the document."},"status":{"$ref":"#/components/schemas/ImmigrationClientCasesIdGetResponsesContentApplicationJsonSchemaDataDocumentsItemsStatus","description":"Status of the document."},"document_type":{"type":"string","description":"The type of the document. Represents the visa type for right to work cases."},"expiration_date":{"type":"string","format":"date-time","description":"Expiry date of the document."}},"title":"ImmigrationClientCasesIdGetResponsesContentApplicationJsonSchemaDataDocumentsItems"},"ImmigrationClientCasesIdGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of immigration case."},"status":{"$ref":"#/components/schemas/ImmigrationClientCasesIdGetResponsesContentApplicationJsonSchemaDataStatus","description":"Status of the immigration case."},"process":{"$ref":"#/components/schemas/ImmigrationClientCasesIdGetResponsesContentApplicationJsonSchemaDataProcess"},"applicant":{"oneOf":[{"$ref":"#/components/schemas/ImmigrationClientCasesIdGetResponsesContentApplicationJsonSchemaDataApplicant"},{"type":"null"}]},"case_type":{"type":"string","description":"Name of the case type"},"documents":{"type":"array","items":{"$ref":"#/components/schemas/ImmigrationClientCasesIdGetResponsesContentApplicationJsonSchemaDataDocumentsItems"}},"visa_type":{"type":["string","null"],"description":"The type of the the visa."},"country_code":{"type":"string","description":"The country of the immigration case."},"last_update_at":{"type":"string","format":"date-time","description":"Last activity on the immigration case."},"case_created_at":{"type":"string","format":"date-time","description":"Creation date of the immigration case."},"estimated_completion_date":{"type":["string","null"],"format":"date-time","description":"Estimated completion date of the immigration case."}},"title":"ImmigrationClientCasesIdGetResponsesContentApplicationJsonSchemaData"},"immigration_getClientCase_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ImmigrationClientCasesIdGetResponsesContentApplicationJsonSchemaData"}},"title":"immigration_getClientCase_Response_200"},"ImmigrationClientCasesIdGetResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code"},"message":{"type":"string","description":"Human-readable explanation of the error"}},"title":"ImmigrationClientCasesIdGetResponsesContentApplicationJsonSchemaErrorsItems"},"GetImmigrationCaseDetails-v2026-01-01RequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ImmigrationClientCasesIdGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"GetImmigrationCaseDetails-v2026-01-01RequestBadRequestError"},"GetImmigrationCaseDetails-v2026-01-01RequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ImmigrationClientCasesIdGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"GetImmigrationCaseDetails-v2026-01-01RequestInternalServerError"},"ImmigrationWorkersCasesCaseIdGetResponsesContentApplicationJsonSchemaDataStatus":{"type":"string","enum":["OPEN","CLOSED","ON_HOLD"],"description":"Status of the immigration case.","title":"ImmigrationWorkersCasesCaseIdGetResponsesContentApplicationJsonSchemaDataStatus"},"ImmigrationWorkersCasesCaseIdGetResponsesContentApplicationJsonSchemaDataProcessName":{"type":"string","enum":["WORK_AUTHORIZATION_VERIFICATION"],"description":"Name of the current active process.","title":"ImmigrationWorkersCasesCaseIdGetResponsesContentApplicationJsonSchemaDataProcessName"},"ImmigrationWorkersCasesCaseIdGetResponsesContentApplicationJsonSchemaDataProcessStatus":{"type":"string","enum":["CANCELLED","AWAITING_DOCUMENTS","IN_REVIEW","APPROVED","REJECTED","IN_PROGRESS"],"description":"Status of the current active process.","title":"ImmigrationWorkersCasesCaseIdGetResponsesContentApplicationJsonSchemaDataProcessStatus"},"ImmigrationWorkersCasesCaseIdGetResponsesContentApplicationJsonSchemaDataProcess":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the current active process."},"name":{"$ref":"#/components/schemas/ImmigrationWorkersCasesCaseIdGetResponsesContentApplicationJsonSchemaDataProcessName","description":"Name of the current active process."},"status":{"$ref":"#/components/schemas/ImmigrationWorkersCasesCaseIdGetResponsesContentApplicationJsonSchemaDataProcessStatus","description":"Status of the current active process."},"rejection_note":{"type":"string","description":"A detailed description of why the case was rejected. Only available if the case status is REJECTED."},"rejection_reason":{"type":"string","description":"The reason why the case was rejected. Only available if the case status is REJECTED."}},"description":"The current active process","title":"ImmigrationWorkersCasesCaseIdGetResponsesContentApplicationJsonSchemaDataProcess"},"ImmigrationWorkersCasesCaseIdGetResponsesContentApplicationJsonSchemaDataContract":{"type":"object","properties":{"id":{"type":["string","null"],"description":"Id of the contract associated with the immigration case"}},"description":"The contract associated with the returned immigration case","title":"ImmigrationWorkersCasesCaseIdGetResponsesContentApplicationJsonSchemaDataContract"},"ImmigrationWorkersCasesCaseIdGetResponsesContentApplicationJsonSchemaDataApplicant":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the applicant profile id."},"external_id":{"type":["string","null"],"description":"External identifier of the applicant  (from partner system or third party)."}},"description":"The employee for which this Right to Work case has been created for","title":"ImmigrationWorkersCasesCaseIdGetResponsesContentApplicationJsonSchemaDataApplicant"},"ImmigrationWorkersCasesCaseIdGetResponsesContentApplicationJsonSchemaDataCaseType":{"type":"string","enum":["IMMIGRATION_DOCUMENT_REVIEW"],"description":" Type of the case. It will always be IMMIGRATION_DOCUMENT_REVIEW for this endpoint.","title":"ImmigrationWorkersCasesCaseIdGetResponsesContentApplicationJsonSchemaDataCaseType"},"ImmigrationWorkersCasesCaseIdGetResponsesContentApplicationJsonSchemaDataDocumentsItemsStatus":{"type":"string","enum":["IN_REVIEW","ACTIVE","EXPIRED","EXPIRING"],"description":"Status of the document.","title":"ImmigrationWorkersCasesCaseIdGetResponsesContentApplicationJsonSchemaDataDocumentsItemsStatus"},"ImmigrationWorkersCasesCaseIdGetResponsesContentApplicationJsonSchemaDataDocumentsItems":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the document."},"status":{"$ref":"#/components/schemas/ImmigrationWorkersCasesCaseIdGetResponsesContentApplicationJsonSchemaDataDocumentsItemsStatus","description":"Status of the document."},"document_type":{"type":["string","null"],"description":"The type of the document. Represents the visa type for right to work cases."},"expiration_date":{"type":["string","null"],"format":"date-time","description":"Expiry date of the document. If document does not expire, it will be null"}},"title":"ImmigrationWorkersCasesCaseIdGetResponsesContentApplicationJsonSchemaDataDocumentsItems"},"ImmigrationWorkersCasesCaseIdGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of immigration case."},"status":{"$ref":"#/components/schemas/ImmigrationWorkersCasesCaseIdGetResponsesContentApplicationJsonSchemaDataStatus","description":"Status of the immigration case."},"process":{"$ref":"#/components/schemas/ImmigrationWorkersCasesCaseIdGetResponsesContentApplicationJsonSchemaDataProcess","description":"The current active process"},"contract":{"$ref":"#/components/schemas/ImmigrationWorkersCasesCaseIdGetResponsesContentApplicationJsonSchemaDataContract","description":"The contract associated with the returned immigration case"},"applicant":{"oneOf":[{"$ref":"#/components/schemas/ImmigrationWorkersCasesCaseIdGetResponsesContentApplicationJsonSchemaDataApplicant"},{"type":"null"}],"description":"The employee for which this Right to Work case has been created for"},"case_type":{"$ref":"#/components/schemas/ImmigrationWorkersCasesCaseIdGetResponsesContentApplicationJsonSchemaDataCaseType","description":" Type of the case. It will always be IMMIGRATION_DOCUMENT_REVIEW for this endpoint."},"documents":{"type":"array","items":{"$ref":"#/components/schemas/ImmigrationWorkersCasesCaseIdGetResponsesContentApplicationJsonSchemaDataDocumentsItems"},"description":"A list of documents associated to the immigration case"},"visa_type":{"type":["string","null"],"description":"The type of the visa."},"created_at":{"type":"string","format":"date-time","description":"Creation date of the immigration case."},"updated_at":{"type":"string","format":"date-time","description":"Last activity on the immigration case."},"country_code":{"type":"string","description":"The country of the immigration case."},"estimated_completion_date":{"type":["string","null"],"format":"date-time","description":"Estimated completion date of the immigration case."}},"title":"ImmigrationWorkersCasesCaseIdGetResponsesContentApplicationJsonSchemaData"},"immigration_getWorkerCase_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ImmigrationWorkersCasesCaseIdGetResponsesContentApplicationJsonSchemaData"}},"title":"immigration_getWorkerCase_Response_200"},"ImmigrationWorkersCasesCaseIdGetResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code"},"message":{"type":"string","description":"Human-readable explanation of the error"}},"title":"ImmigrationWorkersCasesCaseIdGetResponsesContentApplicationJsonSchemaErrorsItems"},"GetSpecificImmigrationCaseDetails-v2026-04-02RequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ImmigrationWorkersCasesCaseIdGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"GetSpecificImmigrationCaseDetails-v2026-04-02RequestBadRequestError"},"GetSpecificImmigrationCaseDetails-v2026-04-02RequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ImmigrationWorkersCasesCaseIdGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"GetSpecificImmigrationCaseDetails-v2026-04-02RequestInternalServerError"},"ImmigrationDocumentsIdGetResponsesContentApplicationJsonSchemaDataItemsStatus":{"type":"string","enum":["IN_REVIEW","APPROVED","REJECTED"],"description":"Current status of the document.","title":"ImmigrationDocumentsIdGetResponsesContentApplicationJsonSchemaDataItemsStatus"},"ImmigrationDocumentsIdGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"id":{"type":"string","description":"The UUID of document entity."},"status":{"oneOf":[{"$ref":"#/components/schemas/ImmigrationDocumentsIdGetResponsesContentApplicationJsonSchemaDataItemsStatus"},{"type":"null"}],"description":"Current status of the document."},"document_type":{"type":["string","null"],"description":"The type of the document. Represents the visa type for right to work cases."},"download_link":{"type":"array","items":{"type":"string"},"description":"S3 download link of all the files uploaded within current document record."},"expiration_date":{"type":["string","null"],"format":"date-time","description":"Expiry date of the document."}},"title":"ImmigrationDocumentsIdGetResponsesContentApplicationJsonSchemaDataItems"},"immigration_getDocument_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ImmigrationDocumentsIdGetResponsesContentApplicationJsonSchemaDataItems"}}},"title":"immigration_getDocument_Response_200"},"ImmigrationVisaTypesCountryCodeGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of a visa type."},"name":{"type":"string","description":"The name of a visa."}},"title":"ImmigrationVisaTypesCountryCodeGetResponsesContentApplicationJsonSchemaDataItems"},"immigration_getVisaTypes_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ImmigrationVisaTypesCountryCodeGetResponsesContentApplicationJsonSchemaDataItems"}}},"title":"immigration_getVisaTypes_Response_200"},"ImmigrationClientCasesGetParametersStatusesSchemaItems":{"type":"string","enum":["OPEN","ON_HOLD","CLOSED"],"title":"ImmigrationClientCasesGetParametersStatusesSchemaItems"},"ImmigrationClientCasesGetResponsesContentApplicationJsonSchemaDataItemsStatus":{"type":"string","enum":["OPEN","CLOSED","ON_HOLD"],"description":"Current lifecycle status of the immigration case.","title":"ImmigrationClientCasesGetResponsesContentApplicationJsonSchemaDataItemsStatus"},"ImmigrationClientCasesGetResponsesContentApplicationJsonSchemaDataItemsClosureReason":{"type":"string","enum":["CONTRACT_CANCELLED","NATIONALITY_CHANGE","NEW_CASE_TYPE_IS_REQUIRED","ONBOARDING_RELEASED","OTHER"],"description":"Reason why the immigration case was closed.","title":"ImmigrationClientCasesGetResponsesContentApplicationJsonSchemaDataItemsClosureReason"},"ImmigrationClientCasesGetResponsesContentApplicationJsonSchemaDataItemsClosure":{"type":"object","properties":{"note":{"type":["string","null"],"description":"Additional notes explaining the case closure."},"reason":{"oneOf":[{"$ref":"#/components/schemas/ImmigrationClientCasesGetResponsesContentApplicationJsonSchemaDataItemsClosureReason"},{"type":"null"}],"description":"Reason why the immigration case was closed."}},"required":["note","reason"],"description":"Closure details of the case if the case has been closed.","title":"ImmigrationClientCasesGetResponsesContentApplicationJsonSchemaDataItemsClosure"},"ImmigrationClientCasesGetResponsesContentApplicationJsonSchemaDataItemsProcessStatus":{"type":"object","properties":{"id":{"type":["string","null"],"format":"uuid","description":"Unique identifier of the process status."},"name":{"type":["string","null"],"description":"Human-readable name of the process status."}},"required":["id","name"],"description":"Current status of the process.","title":"ImmigrationClientCasesGetResponsesContentApplicationJsonSchemaDataItemsProcessStatus"},"ImmigrationClientCasesGetResponsesContentApplicationJsonSchemaDataItemsProcess":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the current process."},"name":{"type":"string","description":"Human-readable name of the current process step."},"status":{"$ref":"#/components/schemas/ImmigrationClientCasesGetResponsesContentApplicationJsonSchemaDataItemsProcessStatus","description":"Current status of the process."}},"required":["id","name","status"],"description":"Current active process associated with the case.","title":"ImmigrationClientCasesGetResponsesContentApplicationJsonSchemaDataItemsProcess"},"ImmigrationClientCasesGetResponsesContentApplicationJsonSchemaDataItemsApplicant":{"type":"object","properties":{"id":{"type":["string","null"],"format":"uuid","description":"Unique identifier of the applicant."},"name":{"type":"string","description":"Full name of the applicant."}},"required":["name"],"description":"Applicant associated with the immigration case.","title":"ImmigrationClientCasesGetResponsesContentApplicationJsonSchemaDataItemsApplicant"},"ImmigrationClientCasesGetResponsesContentApplicationJsonSchemaDataItemsCaseType":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the case type."},"name":{"type":"string","description":"Human-readable name of the case type."}},"required":["id","name"],"description":"Type of immigration case.","title":"ImmigrationClientCasesGetResponsesContentApplicationJsonSchemaDataItemsCaseType"},"ImmigrationClientCasesGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the immigration case."},"status":{"$ref":"#/components/schemas/ImmigrationClientCasesGetResponsesContentApplicationJsonSchemaDataItemsStatus","description":"Current lifecycle status of the immigration case."},"closure":{"oneOf":[{"$ref":"#/components/schemas/ImmigrationClientCasesGetResponsesContentApplicationJsonSchemaDataItemsClosure"},{"type":"null"}],"description":"Closure details of the case if the case has been closed."},"process":{"$ref":"#/components/schemas/ImmigrationClientCasesGetResponsesContentApplicationJsonSchemaDataItemsProcess","description":"Current active process associated with the case."},"applicant":{"oneOf":[{"$ref":"#/components/schemas/ImmigrationClientCasesGetResponsesContentApplicationJsonSchemaDataItemsApplicant"},{"type":"null"}],"description":"Applicant associated with the immigration case."},"case_type":{"$ref":"#/components/schemas/ImmigrationClientCasesGetResponsesContentApplicationJsonSchemaDataItemsCaseType","description":"Type of immigration case."},"created_at":{"type":"string","format":"date-time","description":"Timestamp indicating when the case was created."},"updated_at":{"type":"string","format":"date-time","description":"Timestamp indicating when the case was last updated."}},"required":["id","status","closure","process","applicant","case_type","created_at","updated_at"],"title":"ImmigrationClientCasesGetResponsesContentApplicationJsonSchemaDataItems"},"immigration_getClientCases_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ImmigrationClientCasesGetResponsesContentApplicationJsonSchemaDataItems"},"description":"List of cases in the current page."},"has_more":{"type":"boolean","description":"Indicates whether more results are available for pagination."},"next_cursor":{"type":["string","null"],"description":"Cursor value to be used for fetching the next page of results."},"total_count":{"type":"integer","description":"Total number of cases matching the search criteria."}},"required":["data","has_more","total_count"],"title":"immigration_getClientCases_Response_200"},"ImmigrationClientCasesGetResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code"},"message":{"type":"string","description":"Human-readable explanation of the error"}},"title":"ImmigrationClientCasesGetResponsesContentApplicationJsonSchemaErrorsItems"},"ListOfImmigrationCases-v2026-01-01RequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ImmigrationClientCasesGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"ListOfImmigrationCases-v2026-01-01RequestBadRequestError"},"ListOfImmigrationCases-v2026-01-01RequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ImmigrationClientCasesGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"ListOfImmigrationCases-v2026-01-01RequestInternalServerError"},"ImmigrationWorkersCasesGetParametersStatusesSchemaItems":{"type":"string","enum":["OPEN","ON_HOLD","CLOSED"],"title":"ImmigrationWorkersCasesGetParametersStatusesSchemaItems"},"ImmigrationWorkersCasesGetResponsesContentApplicationJsonSchemaDataItemsStatus":{"type":"string","enum":["OPEN","CLOSED","ON_HOLD"],"description":"Current lifecycle status of the immigration case.","title":"ImmigrationWorkersCasesGetResponsesContentApplicationJsonSchemaDataItemsStatus"},"ImmigrationWorkersCasesGetResponsesContentApplicationJsonSchemaDataItemsClosureReason":{"type":"string","enum":["CONTRACT_CANCELLED","NATIONALITY_CHANGE","NEW_CASE_TYPE_IS_REQUIRED","ONBOARDING_RELEASED","OTHER"],"description":"Reason why the immigration case was closed.","title":"ImmigrationWorkersCasesGetResponsesContentApplicationJsonSchemaDataItemsClosureReason"},"ImmigrationWorkersCasesGetResponsesContentApplicationJsonSchemaDataItemsClosure":{"type":"object","properties":{"note":{"type":["string","null"],"description":"Additional notes explaining the case closure."},"reason":{"oneOf":[{"$ref":"#/components/schemas/ImmigrationWorkersCasesGetResponsesContentApplicationJsonSchemaDataItemsClosureReason"},{"type":"null"}],"description":"Reason why the immigration case was closed."}},"required":["note","reason"],"description":"Closure details of the case if the case has been closed.","title":"ImmigrationWorkersCasesGetResponsesContentApplicationJsonSchemaDataItemsClosure"},"ImmigrationWorkersCasesGetResponsesContentApplicationJsonSchemaDataItemsProcessStatus":{"type":"object","properties":{"id":{"type":["string","null"],"format":"uuid","description":"Unique identifier of the process status."},"name":{"type":["string","null"],"description":"Human-readable name of the process status."}},"required":["id","name"],"description":"Current status of the process.","title":"ImmigrationWorkersCasesGetResponsesContentApplicationJsonSchemaDataItemsProcessStatus"},"ImmigrationWorkersCasesGetResponsesContentApplicationJsonSchemaDataItemsProcess":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the current process."},"name":{"type":"string","description":"Human-readable name of the current process step."},"status":{"$ref":"#/components/schemas/ImmigrationWorkersCasesGetResponsesContentApplicationJsonSchemaDataItemsProcessStatus","description":"Current status of the process."}},"required":["id","name","status"],"description":"Current active process associated with the case.","title":"ImmigrationWorkersCasesGetResponsesContentApplicationJsonSchemaDataItemsProcess"},"ImmigrationWorkersCasesGetResponsesContentApplicationJsonSchemaDataItemsApplicant":{"type":"object","properties":{"id":{"type":["string","null"],"format":"uuid","description":"Unique identifier of the applicant."},"name":{"type":"string","description":"Full name of the applicant."}},"required":["name"],"description":"Applicant associated with the immigration case.","title":"ImmigrationWorkersCasesGetResponsesContentApplicationJsonSchemaDataItemsApplicant"},"ImmigrationWorkersCasesGetResponsesContentApplicationJsonSchemaDataItemsCaseType":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the case type."},"name":{"type":"string","description":"Human-readable name of the case type."}},"required":["id","name"],"description":"Type of immigration case.","title":"ImmigrationWorkersCasesGetResponsesContentApplicationJsonSchemaDataItemsCaseType"},"ImmigrationWorkersCasesGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the immigration case."},"status":{"$ref":"#/components/schemas/ImmigrationWorkersCasesGetResponsesContentApplicationJsonSchemaDataItemsStatus","description":"Current lifecycle status of the immigration case."},"closure":{"oneOf":[{"$ref":"#/components/schemas/ImmigrationWorkersCasesGetResponsesContentApplicationJsonSchemaDataItemsClosure"},{"type":"null"}],"description":"Closure details of the case if the case has been closed."},"process":{"$ref":"#/components/schemas/ImmigrationWorkersCasesGetResponsesContentApplicationJsonSchemaDataItemsProcess","description":"Current active process associated with the case."},"applicant":{"oneOf":[{"$ref":"#/components/schemas/ImmigrationWorkersCasesGetResponsesContentApplicationJsonSchemaDataItemsApplicant"},{"type":"null"}],"description":"Applicant associated with the immigration case."},"case_type":{"$ref":"#/components/schemas/ImmigrationWorkersCasesGetResponsesContentApplicationJsonSchemaDataItemsCaseType","description":"Type of immigration case."},"created_at":{"type":"string","format":"date-time","description":"Timestamp indicating when the case was created."},"updated_at":{"type":"string","format":"date-time","description":"Timestamp indicating when the case was last updated."}},"required":["id","status","closure","process","applicant","case_type","created_at","updated_at"],"title":"ImmigrationWorkersCasesGetResponsesContentApplicationJsonSchemaDataItems"},"immigration_getWorkerCases_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ImmigrationWorkersCasesGetResponsesContentApplicationJsonSchemaDataItems"},"description":"List of cases in the current page."},"has_more":{"type":"boolean","description":"Indicates whether more results are available for pagination."},"next_cursor":{"type":["string","null"],"description":"Cursor value to be used for fetching the next page of results."},"total_count":{"type":"integer","description":"Total number of cases matching the search criteria."}},"required":["data","has_more","total_count"],"title":"immigration_getWorkerCases_Response_200"},"ImmigrationWorkersCasesGetResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code"},"message":{"type":"string","description":"Human-readable explanation of the error"}},"title":"ImmigrationWorkersCasesGetResponsesContentApplicationJsonSchemaErrorsItems"},"ListOfImmigrationCasesForWorkers-v2026-04-02RequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ImmigrationWorkersCasesGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"ListOfImmigrationCasesForWorkers-v2026-04-02RequestBadRequestError"},"ListOfImmigrationCasesForWorkers-v2026-04-02RequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ImmigrationWorkersCasesGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"ListOfImmigrationCasesForWorkers-v2026-04-02RequestInternalServerError"},"ImmigrationWorkersWorkerIdCasesCaseIdRequiredDocumentGetResponsesContentApplicationJsonSchemaDataDocumentStatus":{"type":"string","enum":["PENDING","IN_REVIEW","ACTIVE","EXPIRING","EXPIRED"],"description":"Status of the document.","title":"ImmigrationWorkersWorkerIdCasesCaseIdRequiredDocumentGetResponsesContentApplicationJsonSchemaDataDocumentStatus"},"ImmigrationWorkersWorkerIdCasesCaseIdRequiredDocumentGetResponsesContentApplicationJsonSchemaDataDocument":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the document."},"name":{"type":"string","description":"The name of the document."},"status":{"$ref":"#/components/schemas/ImmigrationWorkersWorkerIdCasesCaseIdRequiredDocumentGetResponsesContentApplicationJsonSchemaDataDocumentStatus","description":"Status of the document."},"expiration_date":{"type":["string","null"],"format":"date-time","description":"Expiration date of the document. If document does not expire, it will be null"}},"title":"ImmigrationWorkersWorkerIdCasesCaseIdRequiredDocumentGetResponsesContentApplicationJsonSchemaDataDocument"},"ImmigrationWorkersWorkerIdCasesCaseIdRequiredDocumentGetResponsesContentApplicationJsonSchemaDataPreviousRejectedDocumentStatus":{"type":"string","enum":["REJECTED"],"description":"Status of the document.","title":"ImmigrationWorkersWorkerIdCasesCaseIdRequiredDocumentGetResponsesContentApplicationJsonSchemaDataPreviousRejectedDocumentStatus"},"ImmigrationWorkersWorkerIdCasesCaseIdRequiredDocumentGetResponsesContentApplicationJsonSchemaDataPreviousRejectedDocument":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the document."},"status":{"$ref":"#/components/schemas/ImmigrationWorkersWorkerIdCasesCaseIdRequiredDocumentGetResponsesContentApplicationJsonSchemaDataPreviousRejectedDocumentStatus","description":"Status of the document."},"rejection_note":{"type":["string","null"],"description":"A detailed description about why the document was rejected."},"rejection_reason":{"type":["string","null"],"description":"The reason why the document was rejected."}},"title":"ImmigrationWorkersWorkerIdCasesCaseIdRequiredDocumentGetResponsesContentApplicationJsonSchemaDataPreviousRejectedDocument"},"ImmigrationWorkersWorkerIdCasesCaseIdRequiredDocumentGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the document requirement."},"name":{"type":"string","description":"The name of the document requirement to be uploaded."},"document":{"$ref":"#/components/schemas/ImmigrationWorkersWorkerIdCasesCaseIdRequiredDocumentGetResponsesContentApplicationJsonSchemaDataDocument"},"created_at":{"type":"string","format":"date-time","description":"Creation date of the document request."},"updated_at":{"type":"string","format":"date-time","description":"Last update date of the document request."},"description":{"type":"string","description":"A short text description of the document requirement to be uploaded."},"previous_rejected_document":{"$ref":"#/components/schemas/ImmigrationWorkersWorkerIdCasesCaseIdRequiredDocumentGetResponsesContentApplicationJsonSchemaDataPreviousRejectedDocument"},"immigration_document_requirement_id":{"type":"string","description":"The unique identifier of the immigration document requirement."}},"title":"ImmigrationWorkersWorkerIdCasesCaseIdRequiredDocumentGetResponsesContentApplicationJsonSchemaData"},"immigration_getWorkerCaseRequiredDocument_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ImmigrationWorkersWorkerIdCasesCaseIdRequiredDocumentGetResponsesContentApplicationJsonSchemaData"}},"title":"immigration_getWorkerCaseRequiredDocument_Response_200"},"ImmigrationWorkersWorkerIdOnboardingCaseGetResponsesContentApplicationJsonSchemaDataStatus":{"type":"string","enum":["OPEN","CLOSED","ON_HOLD"],"description":"Status of the immigration case.","title":"ImmigrationWorkersWorkerIdOnboardingCaseGetResponsesContentApplicationJsonSchemaDataStatus"},"ImmigrationWorkersWorkerIdOnboardingCaseGetResponsesContentApplicationJsonSchemaDataProcessName":{"type":"string","enum":["WORK_AUTHORIZATION_VERIFICATION"],"description":"Name of the current active process.","title":"ImmigrationWorkersWorkerIdOnboardingCaseGetResponsesContentApplicationJsonSchemaDataProcessName"},"ImmigrationWorkersWorkerIdOnboardingCaseGetResponsesContentApplicationJsonSchemaDataProcessStatus":{"type":"string","enum":["CANCELLED","AWAITING_DOCUMENTS","IN_REVIEW","APPROVED","REJECTED"],"description":"Status of the current active process.","title":"ImmigrationWorkersWorkerIdOnboardingCaseGetResponsesContentApplicationJsonSchemaDataProcessStatus"},"ImmigrationWorkersWorkerIdOnboardingCaseGetResponsesContentApplicationJsonSchemaDataProcess":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the current active process."},"name":{"$ref":"#/components/schemas/ImmigrationWorkersWorkerIdOnboardingCaseGetResponsesContentApplicationJsonSchemaDataProcessName","description":"Name of the current active process."},"status":{"$ref":"#/components/schemas/ImmigrationWorkersWorkerIdOnboardingCaseGetResponsesContentApplicationJsonSchemaDataProcessStatus","description":"Status of the current active process."},"rejection_note":{"type":"string","description":"A detailed description of why the case was rejected. Only available if the case status is REJECTED."},"rejection_reason":{"type":"string","description":"The reason why the case was rejected. Only available if the case status is REJECTED."}},"description":"The current active process","title":"ImmigrationWorkersWorkerIdOnboardingCaseGetResponsesContentApplicationJsonSchemaDataProcess"},"ImmigrationWorkersWorkerIdOnboardingCaseGetResponsesContentApplicationJsonSchemaDataContract":{"type":"object","properties":{"id":{"type":["string","null"],"description":"Id of the contract associated with the immigration case"}},"description":"The contract associated with the returned immigration case","title":"ImmigrationWorkersWorkerIdOnboardingCaseGetResponsesContentApplicationJsonSchemaDataContract"},"ImmigrationWorkersWorkerIdOnboardingCaseGetResponsesContentApplicationJsonSchemaDataApplicant":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the applicant profile id."},"external_id":{"type":["string","null"],"description":"External identifier of the applicant  (from partner system or third party)."}},"description":"The employee for which this Right to Work case has been created for","title":"ImmigrationWorkersWorkerIdOnboardingCaseGetResponsesContentApplicationJsonSchemaDataApplicant"},"ImmigrationWorkersWorkerIdOnboardingCaseGetResponsesContentApplicationJsonSchemaDataCaseType":{"type":"string","enum":["IMMIGRATION_DOCUMENT_REVIEW"],"description":" Type of the case. It will always be IMMIGRATION_DOCUMENT_REVIEW for this endpoint.","title":"ImmigrationWorkersWorkerIdOnboardingCaseGetResponsesContentApplicationJsonSchemaDataCaseType"},"ImmigrationWorkersWorkerIdOnboardingCaseGetResponsesContentApplicationJsonSchemaDataDocumentsItemsStatus":{"type":"string","enum":["IN_REVIEW","ACTIVE","EXPIRED","EXPIRING"],"description":"Status of the document.","title":"ImmigrationWorkersWorkerIdOnboardingCaseGetResponsesContentApplicationJsonSchemaDataDocumentsItemsStatus"},"ImmigrationWorkersWorkerIdOnboardingCaseGetResponsesContentApplicationJsonSchemaDataDocumentsItems":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the document."},"status":{"$ref":"#/components/schemas/ImmigrationWorkersWorkerIdOnboardingCaseGetResponsesContentApplicationJsonSchemaDataDocumentsItemsStatus","description":"Status of the document."},"document_type":{"type":["string","null"],"description":"The type of the document. Represents the visa type for right to work cases."},"expiration_date":{"type":["string","null"],"format":"date-time","description":"Expiry date of the document. If document does not expire, it will be null"}},"title":"ImmigrationWorkersWorkerIdOnboardingCaseGetResponsesContentApplicationJsonSchemaDataDocumentsItems"},"ImmigrationWorkersWorkerIdOnboardingCaseGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of immigration case."},"status":{"$ref":"#/components/schemas/ImmigrationWorkersWorkerIdOnboardingCaseGetResponsesContentApplicationJsonSchemaDataStatus","description":"Status of the immigration case."},"process":{"$ref":"#/components/schemas/ImmigrationWorkersWorkerIdOnboardingCaseGetResponsesContentApplicationJsonSchemaDataProcess","description":"The current active process"},"contract":{"$ref":"#/components/schemas/ImmigrationWorkersWorkerIdOnboardingCaseGetResponsesContentApplicationJsonSchemaDataContract","description":"The contract associated with the returned immigration case"},"applicant":{"oneOf":[{"$ref":"#/components/schemas/ImmigrationWorkersWorkerIdOnboardingCaseGetResponsesContentApplicationJsonSchemaDataApplicant"},{"type":"null"}],"description":"The employee for which this Right to Work case has been created for"},"case_type":{"$ref":"#/components/schemas/ImmigrationWorkersWorkerIdOnboardingCaseGetResponsesContentApplicationJsonSchemaDataCaseType","description":" Type of the case. It will always be IMMIGRATION_DOCUMENT_REVIEW for this endpoint."},"documents":{"type":"array","items":{"$ref":"#/components/schemas/ImmigrationWorkersWorkerIdOnboardingCaseGetResponsesContentApplicationJsonSchemaDataDocumentsItems"},"description":"A list of documents associated to the immigration case"},"visa_type":{"type":["string","null"],"description":"The type of the visa."},"created_at":{"type":"string","format":"date-time","description":"Creation date of the immigration case."},"updated_at":{"type":"string","format":"date-time","description":"Last activity on the immigration case."},"country_code":{"type":"string","description":"The country of the immigration case."},"estimated_completion_date":{"type":["string","null"],"format":"date-time","description":"Estimated completion date of the immigration case."}},"title":"ImmigrationWorkersWorkerIdOnboardingCaseGetResponsesContentApplicationJsonSchemaData"},"immigration_getWorkerOnboardingCase_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ImmigrationWorkersWorkerIdOnboardingCaseGetResponsesContentApplicationJsonSchemaData"}},"title":"immigration_getWorkerOnboardingCase_Response_200"},"ImmigrationWorkersWorkerIdOnboardingCaseGetResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code"},"message":{"type":"string","description":"Human-readable explanation of the error"}},"title":"ImmigrationWorkersWorkerIdOnboardingCaseGetResponsesContentApplicationJsonSchemaErrorsItems"},"RetrieveOnboardingRightToWorkCaseForAWorkerRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ImmigrationWorkersWorkerIdOnboardingCaseGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"RetrieveOnboardingRightToWorkCaseForAWorkerRequestBadRequestError"},"RetrieveOnboardingRightToWorkCaseForAWorkerRequestNotFoundError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ImmigrationWorkersWorkerIdOnboardingCaseGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"RetrieveOnboardingRightToWorkCaseForAWorkerRequestNotFoundError"},"RetrieveOnboardingRightToWorkCaseForAWorkerRequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ImmigrationWorkersWorkerIdOnboardingCaseGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"RetrieveOnboardingRightToWorkCaseForAWorkerRequestInternalServerError"},"ImmigrationWorkersWorkerIdCasesCaseIdRequiredDocumentDocumentRequestIdPostRequestBodyContentMultipartFormDataSchemaData":{"type":"object","properties":{"file":{"type":"string","format":"binary","description":"Immigration right to work document. More than 1 document can be uploaded at the same time (e.g.: front and back)"}},"required":["file"],"description":"Details of immigration document upload","title":"ImmigrationWorkersWorkerIdCasesCaseIdRequiredDocumentDocumentRequestIdPostRequestBodyContentMultipartFormDataSchemaData"},"ImmigrationWorkersWorkerIdCasesCaseIdRequiredDocumentDocumentRequestIdPostResponsesContentApplicationJsonSchemaDataStatus":{"type":"string","enum":["IN_REVIEW"],"description":"Status of the document.","title":"ImmigrationWorkersWorkerIdCasesCaseIdRequiredDocumentDocumentRequestIdPostResponsesContentApplicationJsonSchemaDataStatus"},"ImmigrationWorkersWorkerIdCasesCaseIdRequiredDocumentDocumentRequestIdPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the document."},"status":{"$ref":"#/components/schemas/ImmigrationWorkersWorkerIdCasesCaseIdRequiredDocumentDocumentRequestIdPostResponsesContentApplicationJsonSchemaDataStatus","description":"Status of the document."},"created_at":{"type":"string","format":"date-time","description":"Creation date of the document."},"updated_at":{"type":"string","format":"date-time","description":"Last update date of the document."}},"title":"ImmigrationWorkersWorkerIdCasesCaseIdRequiredDocumentDocumentRequestIdPostResponsesContentApplicationJsonSchemaData"},"immigration_createWorkerCaseRequiredDocument_Response_201":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ImmigrationWorkersWorkerIdCasesCaseIdRequiredDocumentDocumentRequestIdPostResponsesContentApplicationJsonSchemaData"}},"title":"immigration_createWorkerCaseRequiredDocument_Response_201"},"IntegrationsConsentGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the consent."},"scope":{"type":"string","description":"Scope of the consent."},"state":{"type":"string","description":"State of the consent."},"status":{"type":"string","description":"Status of the consent."},"user_id":{"type":["string","null"],"description":"User ID associated with the consent."},"client_id":{"type":"string","description":"Client ID associated with the consent."},"user_name":{"type":["string","null"],"description":"User name associated with the consent."},"created_at":{"type":"string","description":"Creation date for the consent."},"expires_at":{"type":"string","description":"Expiration date for the consent."},"profile_id":{"type":["string","null"],"description":"Profile ID associated with the consent."},"updated_at":{"type":"string","description":"Update date for the consent."},"user_email":{"type":["string","null"],"description":"User email associated with the consent."},"redirect_uri":{"type":"string","description":"Redirect URI for the consent."},"organization_id":{"type":["string","null"],"description":"Organization ID associated with the consent."}},"title":"IntegrationsConsentGetResponsesContentApplicationJsonSchemaData"},"Integrations_getIntegrationConsent_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/IntegrationsConsentGetResponsesContentApplicationJsonSchemaData"}},"title":"Integrations_getIntegrationConsent_Response_200"},"InvoiceAdjustmentsPostRequestBodyContentApplicationJsonSchemaDataType":{"type":"string","enum":["bonus","commission","deduction","expense","other","overtime","time_off","vat"],"description":"Type of invoice adjustment.","title":"InvoiceAdjustmentsPostRequestBodyContentApplicationJsonSchemaDataType"},"InvoiceAdjustmentsPostRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/InvoiceAdjustmentsPostRequestBodyContentApplicationJsonSchemaDataType","description":"Type of invoice adjustment."},"amount":{"type":"number","format":"double","description":"Amount to be paid. Must be a positive number."},"contract_id":{"type":"string","description":"Id of a Deel contract."},"description":{"type":"string","description":"Description of the adjustment."},"date_submitted":{"type":"string","format":"date","description":"Short date in format ISO-8601 (YYYY-MM-DD). For example: 2022-12-31."},"paymentCycleId":{"type":["number","null"],"format":"double","description":"ID of an existing active payment cycle - required if type is \"vat\""},"is_auto_approved":{"type":"boolean","description":"If true, the invoice adjustment will be automatically approved as part of the request."},"hourly_report_preset_id":{"type":["string","null"],"format":"uuid","description":"Id of an existing preset."}},"required":["type","amount","contract_id","description","date_submitted"],"description":"Details of invoice adjustment to create.","title":"InvoiceAdjustmentsPostRequestBodyContentApplicationJsonSchemaData"},"InvoiceAdjustmentsPostResponsesContentApplicationJsonSchemaDataId":{"oneOf":[{"type":"string"},{"type":"integer","format":"int64"}],"title":"InvoiceAdjustmentsPostResponsesContentApplicationJsonSchemaDataId"},"InvoiceAdjustmentsPostResponsesContentApplicationJsonSchemaDataStatus":{"type":"string","enum":["approved","declined","not_payable","paid","pending","processing"],"description":"status of invoice adjustment","title":"InvoiceAdjustmentsPostResponsesContentApplicationJsonSchemaDataStatus"},"InvoiceAdjustmentsPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/InvoiceAdjustmentsPostResponsesContentApplicationJsonSchemaDataId"},"status":{"oneOf":[{"$ref":"#/components/schemas/InvoiceAdjustmentsPostResponsesContentApplicationJsonSchemaDataStatus"},{"type":"null"}],"description":"status of invoice adjustment"},"created":{"type":"boolean"},"created_at":{"type":["string","null"],"format":"date-time","description":"Long date-time format following ISO-8601"}},"required":["created"],"description":"Details of invoice adjustment created.","title":"InvoiceAdjustmentsPostResponsesContentApplicationJsonSchemaData"},"invoice-adjustments_createInvoiceAdjustment_Response_201":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/InvoiceAdjustmentsPostResponsesContentApplicationJsonSchemaData","description":"Details of invoice adjustment created."}},"required":["data"],"title":"invoice-adjustments_createInvoiceAdjustment_Response_201"},"InvoiceAdjustmentsIdDeleteResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"deleted":{"type":"boolean","description":"Confirms the deletion."}},"required":["deleted"],"title":"InvoiceAdjustmentsIdDeleteResponsesContentApplicationJsonSchemaData"},"invoice-adjustments_deleteInvoiceAdjustment_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/InvoiceAdjustmentsIdDeleteResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"invoice-adjustments_deleteInvoiceAdjustment_Response_200"},"InvoiceAdjustmentsIdGetResponsesContentApplicationJsonSchemaDataType":{"type":"string","enum":["accrued_holiday","additional_fee","allowance","bonus","commission","deduction","deposit","deposit_refund","employer_cost","expense","health_allowance","health_benefit","health_insurance_fee","legal_fee","management_fee","milestone","offcycle","other","overtime","pension","pro_rata","setup_fee","severance","shield_service","signing_bonus","signing_bonus_employer_cost","refund","task","time_off","vat","withholding_tax","work"],"description":"Type of invoice adjustment.","title":"InvoiceAdjustmentsIdGetResponsesContentApplicationJsonSchemaDataType"},"InvoiceAdjustmentsIdGetResponsesContentApplicationJsonSchemaDataStatus":{"type":"string","enum":["approved","declined","not_payable","paid","pending","processing"],"description":"status of invoice adjustment","title":"InvoiceAdjustmentsIdGetResponsesContentApplicationJsonSchemaDataStatus"},"InvoiceAdjustmentsIdGetResponsesContentApplicationJsonSchemaDataContractType":{"type":"string","enum":["ongoing_time_based","milestones","time_based","pay_as_you_go_time_based","commission","payg_milestones","payg_tasks","eor","unknown","employee","global_payroll","shield_msa","hris_direct_employee","peo"],"description":"Type of a contract","title":"InvoiceAdjustmentsIdGetResponsesContentApplicationJsonSchemaDataContractType"},"InvoiceAdjustmentsIdGetResponsesContentApplicationJsonSchemaDataContract":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the contract."},"type":{"$ref":"#/components/schemas/InvoiceAdjustmentsIdGetResponsesContentApplicationJsonSchemaDataContractType","description":"Type of a contract"},"title":{"type":"string","description":"The display title of the contract."}},"required":["id","type","title"],"title":"InvoiceAdjustmentsIdGetResponsesContentApplicationJsonSchemaDataContract"},"InvoiceAdjustmentsIdGetResponsesContentApplicationJsonSchemaDataApproversItems":{"type":"object","properties":{"email":{"type":"string","description":"Email address of the approver."},"approved":{"type":"boolean","description":"Whether the specific approver has approved the adjustment."},"full_name":{"type":"string","description":"Full name of the approver."}},"required":["approved"],"title":"InvoiceAdjustmentsIdGetResponsesContentApplicationJsonSchemaDataApproversItems"},"InvoiceAdjustmentsIdGetResponsesContentApplicationJsonSchemaDataWorksheet":{"type":"object","properties":{"days":{"type":"number","format":"double","description":"Number of days."},"hours":{"type":"number","format":"double","description":"Number of hours."},"weeks":{"type":"number","format":"double","description":"Number of weeks."},"minutes":{"type":"number","format":"double","description":"Number of minutes."}},"required":["days","hours","weeks","minutes"],"description":"Breakdown of the time/effort involved in the adjustment.","title":"InvoiceAdjustmentsIdGetResponsesContentApplicationJsonSchemaDataWorksheet"},"InvoiceAdjustmentsIdGetResponsesContentApplicationJsonSchemaDataAttachment":{"type":"object","properties":{"key":{"type":"string","description":"Storage key returned from the attachments endpoint, can be used as a unique identifier for the file"},"filename":{"type":"string","description":"Original filename of the uploaded attachment"},"download_url":{"type":["string","null"],"description":"URL used to download the uploaded attachment file."}},"required":["key","filename"],"description":"File attachment linked to the invoice adjustment.","title":"InvoiceAdjustmentsIdGetResponsesContentApplicationJsonSchemaDataAttachment"},"InvoiceAdjustmentsIdGetResponsesContentApplicationJsonSchemaDataReportedById":{"oneOf":[{"type":"string"},{"type":"integer","format":"int64"}],"title":"InvoiceAdjustmentsIdGetResponsesContentApplicationJsonSchemaDataReportedById"},"InvoiceAdjustmentsIdGetResponsesContentApplicationJsonSchemaDataReportedBy":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/InvoiceAdjustmentsIdGetResponsesContentApplicationJsonSchemaDataReportedById"},"full_name":{"type":"string","description":"Full name of the reporter."}},"required":["id"],"description":"The user who reported/submitted the adjustment.","title":"InvoiceAdjustmentsIdGetResponsesContentApplicationJsonSchemaDataReportedBy"},"InvoiceAdjustmentsIdGetResponsesContentApplicationJsonSchemaDataReviewedById":{"oneOf":[{"type":"string"},{"type":"integer","format":"int64"}],"title":"InvoiceAdjustmentsIdGetResponsesContentApplicationJsonSchemaDataReviewedById"},"InvoiceAdjustmentsIdGetResponsesContentApplicationJsonSchemaDataReviewedBy":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/InvoiceAdjustmentsIdGetResponsesContentApplicationJsonSchemaDataReviewedById"},"remarks":{"type":"string","description":"Comments or notes left by the reviewer."},"full_name":{"type":"string","description":"Full name of the reviewer."},"reviewed_at":{"type":"string","description":"The timestamp when the review occurred."}},"required":["id","remarks","reviewed_at"],"description":"The user who reviewed the adjustment.","title":"InvoiceAdjustmentsIdGetResponsesContentApplicationJsonSchemaDataReviewedBy"},"InvoiceAdjustmentsIdGetResponsesContentApplicationJsonSchemaDataPaymentCycle":{"type":"object","properties":{"end_date":{"type":"string","format":"date-time","description":"Long date-time format following ISO-8601"},"start_date":{"type":"string","format":"date-time","description":"Long date-time format following ISO-8601"}},"required":["end_date","start_date"],"title":"InvoiceAdjustmentsIdGetResponsesContentApplicationJsonSchemaDataPaymentCycle"},"InvoiceAdjustmentsIdGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":["string","null"],"format":"uuid","description":"Unique identifier of this resource."},"type":{"$ref":"#/components/schemas/InvoiceAdjustmentsIdGetResponsesContentApplicationJsonSchemaDataType","description":"Type of invoice adjustment."},"scale":{"type":["string","null"],"description":"The scale used for calculation (e.g., hourly, daily)."},"status":{"oneOf":[{"$ref":"#/components/schemas/InvoiceAdjustmentsIdGetResponsesContentApplicationJsonSchemaDataStatus"},{"type":"null"}],"description":"status of invoice adjustment"},"contract":{"$ref":"#/components/schemas/InvoiceAdjustmentsIdGetResponsesContentApplicationJsonSchemaDataContract"},"quantity":{"type":["number","null"],"format":"double","description":"The quantity/number of units applied."},"approvers":{"type":"array","items":{"$ref":"#/components/schemas/InvoiceAdjustmentsIdGetResponsesContentApplicationJsonSchemaDataApproversItems"}},"worksheet":{"oneOf":[{"$ref":"#/components/schemas/InvoiceAdjustmentsIdGetResponsesContentApplicationJsonSchemaDataWorksheet"},{"type":"null"}],"description":"Breakdown of the time/effort involved in the adjustment."},"attachment":{"oneOf":[{"$ref":"#/components/schemas/InvoiceAdjustmentsIdGetResponsesContentApplicationJsonSchemaDataAttachment"},{"type":"null"}],"description":"File attachment linked to the invoice adjustment."},"created_at":{"type":"string","format":"date-time","description":"Long date-time format following ISO-8601"},"invoice_id":{"type":["number","null"],"format":"double","description":"Deprecated. No longer used"},"description":{"type":"string","description":"Details or notes regarding the adjustment."},"reported_by":{"$ref":"#/components/schemas/InvoiceAdjustmentsIdGetResponsesContentApplicationJsonSchemaDataReportedBy","description":"The user who reported/submitted the adjustment."},"reviewed_by":{"oneOf":[{"$ref":"#/components/schemas/InvoiceAdjustmentsIdGetResponsesContentApplicationJsonSchemaDataReviewedBy"},{"type":"null"}],"description":"The user who reviewed the adjustment."},"custom_scale":{"type":["string","null"],"description":"A custom unit of measurement if the standard 'scale' is not applicable."},"total_amount":{"type":"string","description":"The total monetary value of the adjustment."},"currency_code":{"type":"string","description":"Three-letter ISO-4217 currency code."},"payment_cycle":{"$ref":"#/components/schemas/InvoiceAdjustmentsIdGetResponsesContentApplicationJsonSchemaDataPaymentCycle"},"date_submitted":{"type":"string","format":"date-time","description":"Long date-time format following ISO-8601"},"invoice_public_id":{"type":["string","null"],"description":"Public Identifier for the associated invoice."}},"required":["id","type","status","contract","quantity","worksheet","attachment","created_at","description","reported_by","reviewed_by","total_amount","currency_code","payment_cycle","date_submitted"],"title":"InvoiceAdjustmentsIdGetResponsesContentApplicationJsonSchemaData"},"invoice-adjustments_getInvoiceAdjustmentById_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/InvoiceAdjustmentsIdGetResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"invoice-adjustments_getInvoiceAdjustmentById_Response_200"},"InvoiceAdjustmentsIdGetResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code"},"field":{"type":"string","description":"Name of the field causing the error (for validation issues)"},"message":{"type":"string","description":"Human-readable explanation of the error"}},"title":"InvoiceAdjustmentsIdGetResponsesContentApplicationJsonSchemaErrorsItems"},"InvoiceLineItemById-v2026-01-01RequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/InvoiceAdjustmentsIdGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"InvoiceLineItemById-v2026-01-01RequestBadRequestError"},"ContractsContractIdInvoiceAdjustmentsGetParametersContractTypesSchemaOneOf0Items":{"type":"string","enum":["ongoing_time_based","milestones","time_based","pay_as_you_go_time_based","commission","payg_milestones","payg_tasks","eor","unknown","employee","global_payroll","shield_msa","hris_direct_employee","peo"],"description":"Type of a contract","title":"ContractsContractIdInvoiceAdjustmentsGetParametersContractTypesSchemaOneOf0Items"},"ContractsContractIdInvoiceAdjustmentsGetParametersContractTypes0":{"type":"array","items":{"$ref":"#/components/schemas/ContractsContractIdInvoiceAdjustmentsGetParametersContractTypesSchemaOneOf0Items"},"description":"List of contract types","title":"ContractsContractIdInvoiceAdjustmentsGetParametersContractTypes0"},"ContractsContractIdInvoiceAdjustmentsGetParametersContractTypes1":{"type":"string","enum":["ongoing_time_based","milestones","time_based","pay_as_you_go_time_based","commission","payg_milestones","payg_tasks","eor","unknown","employee","global_payroll","shield_msa","hris_direct_employee","peo"],"title":"ContractsContractIdInvoiceAdjustmentsGetParametersContractTypes1"},"ContractsContractIdInvoiceAdjustmentsGetParametersContractTypes":{"oneOf":[{"$ref":"#/components/schemas/ContractsContractIdInvoiceAdjustmentsGetParametersContractTypes0"},{"$ref":"#/components/schemas/ContractsContractIdInvoiceAdjustmentsGetParametersContractTypes1"}],"title":"ContractsContractIdInvoiceAdjustmentsGetParametersContractTypes"},"ContractsContractIdInvoiceAdjustmentsGetParametersTypesSchemaOneOf0Items":{"type":"string","enum":["accrued_holiday","additional_fee","allowance","bonus","commission","deduction","deposit","deposit_refund","employer_cost","expense","health_allowance","health_benefit","health_insurance_fee","legal_fee","management_fee","milestone","offcycle","other","overtime","pension","pro_rata","setup_fee","severance","shield_service","signing_bonus","signing_bonus_employer_cost","refund","task","time_off","vat","withholding_tax","work"],"description":"Type of invoice adjustment.","title":"ContractsContractIdInvoiceAdjustmentsGetParametersTypesSchemaOneOf0Items"},"ContractsContractIdInvoiceAdjustmentsGetParametersTypes0":{"type":"array","items":{"$ref":"#/components/schemas/ContractsContractIdInvoiceAdjustmentsGetParametersTypesSchemaOneOf0Items"},"title":"ContractsContractIdInvoiceAdjustmentsGetParametersTypes0"},"ContractsContractIdInvoiceAdjustmentsGetParametersTypes1":{"type":"string","enum":["accrued_holiday","additional_fee","allowance","bonus","commission","deduction","deposit","deposit_refund","employer_cost","expense","health_allowance","health_benefit","health_insurance_fee","legal_fee","management_fee","milestone","offcycle","other","overtime","pension","pro_rata","setup_fee","severance","shield_service","signing_bonus","signing_bonus_employer_cost","refund","task","time_off","vat","withholding_tax","work"],"title":"ContractsContractIdInvoiceAdjustmentsGetParametersTypes1"},"ContractsContractIdInvoiceAdjustmentsGetParametersTypes":{"oneOf":[{"$ref":"#/components/schemas/ContractsContractIdInvoiceAdjustmentsGetParametersTypes0"},{"$ref":"#/components/schemas/ContractsContractIdInvoiceAdjustmentsGetParametersTypes1"}],"title":"ContractsContractIdInvoiceAdjustmentsGetParametersTypes"},"ContractsContractIdInvoiceAdjustmentsGetParametersStatusesSchemaOneOf0Items":{"type":"string","enum":["approved","declined","not_payable","paid","pending","processing"],"description":"status of invoice adjustment","title":"ContractsContractIdInvoiceAdjustmentsGetParametersStatusesSchemaOneOf0Items"},"ContractsContractIdInvoiceAdjustmentsGetParametersStatuses0":{"type":"array","items":{"$ref":"#/components/schemas/ContractsContractIdInvoiceAdjustmentsGetParametersStatusesSchemaOneOf0Items"},"title":"ContractsContractIdInvoiceAdjustmentsGetParametersStatuses0"},"ContractsContractIdInvoiceAdjustmentsGetParametersStatuses1":{"type":"string","enum":["approved","declined","not_payable","paid","pending","processing"],"title":"ContractsContractIdInvoiceAdjustmentsGetParametersStatuses1"},"ContractsContractIdInvoiceAdjustmentsGetParametersStatuses":{"oneOf":[{"$ref":"#/components/schemas/ContractsContractIdInvoiceAdjustmentsGetParametersStatuses0"},{"$ref":"#/components/schemas/ContractsContractIdInvoiceAdjustmentsGetParametersStatuses1"}],"title":"ContractsContractIdInvoiceAdjustmentsGetParametersStatuses"},"ContractsContractIdInvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsType":{"type":"string","enum":["accrued_holiday","additional_fee","allowance","bonus","commission","deduction","deposit","deposit_refund","employer_cost","expense","health_allowance","health_benefit","health_insurance_fee","legal_fee","management_fee","milestone","offcycle","other","overtime","pension","pro_rata","setup_fee","severance","shield_service","signing_bonus","signing_bonus_employer_cost","refund","task","time_off","vat","withholding_tax","work"],"description":"Type of invoice adjustment.","title":"ContractsContractIdInvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsType"},"ContractsContractIdInvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsStatus":{"type":"string","enum":["approved","declined","not_payable","paid","pending","processing"],"description":"status of invoice adjustment","title":"ContractsContractIdInvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsStatus"},"ContractsContractIdInvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsContractType":{"type":"string","enum":["ongoing_time_based","milestones","time_based","pay_as_you_go_time_based","commission","payg_milestones","payg_tasks","eor","unknown","employee","global_payroll","shield_msa","hris_direct_employee","peo"],"description":"Type of a contract","title":"ContractsContractIdInvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsContractType"},"ContractsContractIdInvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsContract":{"type":"object","properties":{"id":{"type":"string"},"type":{"$ref":"#/components/schemas/ContractsContractIdInvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsContractType","description":"Type of a contract"},"title":{"type":"string"}},"required":["id","type","title"],"title":"ContractsContractIdInvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsContract"},"ContractsContractIdInvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsWorksheet":{"type":"object","properties":{"days":{"type":"number","format":"double"},"hours":{"type":"number","format":"double"},"weeks":{"type":"number","format":"double"},"minutes":{"type":"number","format":"double"}},"required":["days","hours","weeks","minutes"],"title":"ContractsContractIdInvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsWorksheet"},"ContractsContractIdInvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsAttachment":{"type":"object","properties":{"key":{"type":"string","description":"You can call attachments end-point, get key and URL to upload your file."},"filename":{"type":"string","description":"Original filename you used to upload using attachments end-point."}},"required":["key","filename"],"description":"This object is used for linking file attachments to your records.","title":"ContractsContractIdInvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsAttachment"},"ContractsContractIdInvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsReportedById":{"oneOf":[{"type":"string"},{"type":"integer","format":"int64"}],"title":"ContractsContractIdInvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsReportedById"},"ContractsContractIdInvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsReportedBy":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ContractsContractIdInvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsReportedById"},"full_name":{"type":"string"}},"required":["id"],"title":"ContractsContractIdInvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsReportedBy"},"ContractsContractIdInvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsReviewedById":{"oneOf":[{"type":"string"},{"type":"integer","format":"int64"}],"title":"ContractsContractIdInvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsReviewedById"},"ContractsContractIdInvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsReviewedBy":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ContractsContractIdInvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsReviewedById"},"remarks":{"type":"string"},"full_name":{"type":"string"},"reviewed_at":{"type":"string"}},"required":["id","remarks","reviewed_at"],"title":"ContractsContractIdInvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsReviewedBy"},"ContractsContractIdInvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsPaymentCycle":{"type":"object","properties":{"end_date":{"type":["string","null"],"format":"date-time","description":"Long date-time format following ISO-8601"},"start_date":{"type":["string","null"],"format":"date-time","description":"Long date-time format following ISO-8601"}},"required":["end_date","start_date"],"title":"ContractsContractIdInvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsPaymentCycle"},"ContractsContractIdInvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"id":{"type":["string","null"],"format":"uuid","description":"Unique identifier of this resource."},"type":{"$ref":"#/components/schemas/ContractsContractIdInvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsType","description":"Type of invoice adjustment."},"scale":{"type":["string","null"]},"status":{"oneOf":[{"$ref":"#/components/schemas/ContractsContractIdInvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsStatus"},{"type":"null"}],"description":"status of invoice adjustment"},"contract":{"$ref":"#/components/schemas/ContractsContractIdInvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsContract"},"quantity":{"type":["number","null"],"format":"double"},"worksheet":{"oneOf":[{"$ref":"#/components/schemas/ContractsContractIdInvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsWorksheet"},{"type":"null"}]},"attachment":{"oneOf":[{"$ref":"#/components/schemas/ContractsContractIdInvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsAttachment"},{"type":"null"}],"description":"This object is used for linking file attachments to your records."},"created_at":{"type":"string","format":"date-time","description":"Long date-time format following ISO-8601"},"invoice_id":{"type":["number","null"],"format":"double"},"description":{"type":"string"},"reported_by":{"$ref":"#/components/schemas/ContractsContractIdInvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsReportedBy"},"reviewed_by":{"oneOf":[{"$ref":"#/components/schemas/ContractsContractIdInvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsReviewedBy"},{"type":"null"}]},"custom_scale":{"type":["string","null"]},"total_amount":{"type":"string"},"currency_code":{"type":"string"},"payment_cycle":{"$ref":"#/components/schemas/ContractsContractIdInvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsPaymentCycle"},"date_submitted":{"type":"string","format":"date-time","description":"Long date-time format following ISO-8601"}},"required":["id","type","status","contract","quantity","worksheet","attachment","created_at","description","reported_by","reviewed_by","total_amount","currency_code","payment_cycle","date_submitted"],"title":"ContractsContractIdInvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItems"},"ContractsContractIdInvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaPage":{"type":"object","properties":{"offset":{"type":"number","format":"double","description":"Index of the first row in this page"},"total_rows":{"type":"number","format":"double","description":"Total number of rows in the result set"},"items_per_page":{"type":"number","format":"double","description":"Number of items per page"}},"required":["offset","total_rows","items_per_page"],"title":"ContractsContractIdInvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaPage"},"invoice-adjustments_getContractInvoiceAdjustments_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ContractsContractIdInvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItems"}},"page":{"$ref":"#/components/schemas/ContractsContractIdInvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaPage"}},"required":["data","page"],"title":"invoice-adjustments_getContractInvoiceAdjustments_Response_200"},"InvoiceAdjustmentsGetParametersContractTypesSchemaOneOf0Items":{"type":"string","enum":["ongoing_time_based","pay_as_you_go_time_based","payg_milestones","payg_tasks"],"description":"Type of a contract","title":"InvoiceAdjustmentsGetParametersContractTypesSchemaOneOf0Items"},"InvoiceAdjustmentsGetParametersContractTypes0":{"type":"array","items":{"$ref":"#/components/schemas/InvoiceAdjustmentsGetParametersContractTypesSchemaOneOf0Items"},"description":"List of contract types","title":"InvoiceAdjustmentsGetParametersContractTypes0"},"InvoiceAdjustmentsGetParametersContractTypes1":{"type":"string","enum":["ongoing_time_based","pay_as_you_go_time_based","payg_milestones","payg_tasks"],"title":"InvoiceAdjustmentsGetParametersContractTypes1"},"InvoiceAdjustmentsGetParametersContractTypes":{"oneOf":[{"$ref":"#/components/schemas/InvoiceAdjustmentsGetParametersContractTypes0"},{"$ref":"#/components/schemas/InvoiceAdjustmentsGetParametersContractTypes1"}],"title":"InvoiceAdjustmentsGetParametersContractTypes"},"InvoiceAdjustmentsGetParametersTypesSchemaOneOf0Items":{"type":"string","enum":["accrued_holiday","additional_fee","allowance","bonus","commission","deduction","deposit","deposit_refund","employer_cost","expense","health_allowance","health_benefit","health_insurance_fee","legal_fee","management_fee","milestone","offcycle","other","overtime","pension","pro_rata","setup_fee","severance","shield_service","signing_bonus","signing_bonus_employer_cost","refund","task","time_off","vat","withholding_tax","work"],"description":"Type of invoice adjustment.","title":"InvoiceAdjustmentsGetParametersTypesSchemaOneOf0Items"},"InvoiceAdjustmentsGetParametersTypes0":{"type":"array","items":{"$ref":"#/components/schemas/InvoiceAdjustmentsGetParametersTypesSchemaOneOf0Items"},"title":"InvoiceAdjustmentsGetParametersTypes0"},"InvoiceAdjustmentsGetParametersTypes1":{"type":"string","enum":["accrued_holiday","additional_fee","allowance","bonus","commission","deduction","deposit","deposit_refund","employer_cost","expense","health_allowance","health_benefit","health_insurance_fee","legal_fee","management_fee","milestone","offcycle","other","overtime","pension","pro_rata","setup_fee","severance","shield_service","signing_bonus","signing_bonus_employer_cost","refund","task","time_off","vat","withholding_tax","work"],"title":"InvoiceAdjustmentsGetParametersTypes1"},"InvoiceAdjustmentsGetParametersTypes":{"oneOf":[{"$ref":"#/components/schemas/InvoiceAdjustmentsGetParametersTypes0"},{"$ref":"#/components/schemas/InvoiceAdjustmentsGetParametersTypes1"}],"title":"InvoiceAdjustmentsGetParametersTypes"},"InvoiceAdjustmentsGetParametersStatusesSchemaOneOf0Items":{"type":"string","enum":["approved","declined","not_payable","paid","pending","processing"],"description":"status of invoice adjustment","title":"InvoiceAdjustmentsGetParametersStatusesSchemaOneOf0Items"},"InvoiceAdjustmentsGetParametersStatuses0":{"type":"array","items":{"$ref":"#/components/schemas/InvoiceAdjustmentsGetParametersStatusesSchemaOneOf0Items"},"title":"InvoiceAdjustmentsGetParametersStatuses0"},"InvoiceAdjustmentsGetParametersStatuses1":{"type":"string","enum":["approved","declined","not_payable","paid","pending","processing"],"title":"InvoiceAdjustmentsGetParametersStatuses1"},"InvoiceAdjustmentsGetParametersStatuses":{"oneOf":[{"$ref":"#/components/schemas/InvoiceAdjustmentsGetParametersStatuses0"},{"$ref":"#/components/schemas/InvoiceAdjustmentsGetParametersStatuses1"}],"title":"InvoiceAdjustmentsGetParametersStatuses"},"InvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsType":{"type":"string","enum":["accrued_holiday","additional_fee","allowance","bonus","commission","deduction","deposit","deposit_refund","employer_cost","expense","health_allowance","health_benefit","health_insurance_fee","legal_fee","management_fee","milestone","offcycle","other","overtime","pension","pro_rata","setup_fee","severance","shield_service","signing_bonus","signing_bonus_employer_cost","refund","task","time_off","vat","withholding_tax","work"],"description":"Type of invoice adjustment.","title":"InvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsType"},"InvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsStatus":{"type":"string","enum":["approved","declined","not_payable","paid","pending","processing"],"description":"Current processing status of the invoice adjustment.","title":"InvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsStatus"},"InvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsContractType":{"type":"string","enum":["ongoing_time_based","milestones","time_based","pay_as_you_go_time_based","commission","payg_milestones","payg_tasks","eor","unknown","employee","global_payroll","shield_msa","hris_direct_employee","peo"],"description":"Type of the contract.","title":"InvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsContractType"},"InvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsContract":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the contract."},"type":{"$ref":"#/components/schemas/InvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsContractType","description":"Type of the contract."},"title":{"type":"string","description":"Human-readable contract title."}},"required":["id","type","title"],"description":"Contract associated with this invoice adjustment.","title":"InvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsContract"},"InvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsWorksheet":{"type":"object","properties":{"days":{"type":"number","format":"double","description":"Number of days reported."},"hours":{"type":"number","format":"double","description":"Number of hours reported."},"weeks":{"type":"number","format":"double","description":"Number of weeks reported."},"minutes":{"type":"number","format":"double","description":"Number of minutes reported."}},"required":["days","hours","weeks","minutes"],"description":"Breakdown of time used for time-based calculations.","title":"InvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsWorksheet"},"InvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsAttachment":{"type":"object","properties":{"key":{"type":"string","description":"Storage key returned from the attachments endpoint, can be used as a unique identifier for the file"},"filename":{"type":"string","description":"Original filename of the uploaded attachment, download link can be found on the individual invoice adjustment endpoint"}},"required":["key","filename"],"description":"File attachment linked to the invoice adjustment.","title":"InvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsAttachment"},"InvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsReportedById":{"oneOf":[{"type":"string"},{"type":"integer","format":"int64"}],"description":"Unique identifier of the reporting user.","title":"InvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsReportedById"},"InvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsReportedBy":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/InvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsReportedById","description":"Unique identifier of the reporting user."},"full_name":{"type":"string","description":"Full name of the reporting user."}},"required":["id"],"description":"User who reported the invoice adjustment.","title":"InvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsReportedBy"},"InvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsReviewedById":{"oneOf":[{"type":"string"},{"type":"integer","format":"int64"}],"description":"Unique identifier of the reviewer.","title":"InvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsReviewedById"},"InvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsReviewedBy":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/InvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsReviewedById","description":"Unique identifier of the reviewer."},"remarks":{"type":["string","null"],"description":"Reviewer remarks or decision notes."},"full_name":{"type":"string","description":"Full name of the reviewer."},"reviewed_at":{"type":["string","null"],"description":"Timestamp when the review occurred."}},"required":["id","remarks","reviewed_at"],"description":"Reviewer information if the adjustment has been reviewed.","title":"InvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsReviewedBy"},"InvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsPaymentCycle":{"type":"object","properties":{"end":{"type":["string","null"],"format":"date-time","description":"End date of the payment cycle."},"start":{"type":["string","null"],"format":"date-time","description":"Start date of the payment cycle."}},"description":"Payment cycle associated with this adjustment.","title":"InvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsPaymentCycle"},"InvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsHourlyReportPreset":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Id of assigned preset"},"rate":{"type":["number","null"],"format":"double","description":"Assigned preset rate"},"title":{"type":"string","description":"Description of assigned preset"}},"title":"InvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsHourlyReportPreset"},"InvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"id":{"type":["string","null"],"format":"uuid","description":"Unique identifier of this invoice adjustment."},"type":{"$ref":"#/components/schemas/InvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsType","description":"Type of invoice adjustment."},"scale":{"type":["string","null"],"description":"Predefined scale used to calculate the adjustment amount."},"status":{"oneOf":[{"$ref":"#/components/schemas/InvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsStatus"},{"type":"null"}],"description":"Current processing status of the invoice adjustment."},"contract":{"$ref":"#/components/schemas/InvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsContract","description":"Contract associated with this invoice adjustment."},"quantity":{"type":["number","null"],"format":"double","description":"Quantity used to calculate the total amount."},"worksheet":{"oneOf":[{"$ref":"#/components/schemas/InvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsWorksheet"},{"type":"null"}],"description":"Breakdown of time used for time-based calculations."},"attachment":{"oneOf":[{"$ref":"#/components/schemas/InvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsAttachment"},{"type":"null"}],"description":"File attachment linked to the invoice adjustment."},"created_at":{"type":"string","format":"date-time","description":"Timestamp when the adjustment was created (ISO-8601)."},"invoice_id":{"type":["number","null"],"format":"double","description":"Identifier of the generated invoice this adjustment belongs to."},"description":{"type":["string","null"],"description":"Human-readable explanation of the invoice adjustment."},"reported_by":{"$ref":"#/components/schemas/InvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsReportedBy","description":"User who reported the invoice adjustment."},"reviewed_by":{"oneOf":[{"$ref":"#/components/schemas/InvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsReviewedBy"},{"type":"null"}],"description":"Reviewer information if the adjustment has been reviewed."},"custom_scale":{"type":["string","null"],"description":"Custom scale label defined by the client."},"total_amount":{"type":"string","description":"Total monetary value of the invoice adjustment."},"currency_code":{"type":"string","description":"ISO 4217 currency code used for the amount."},"payment_cycle":{"$ref":"#/components/schemas/InvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsPaymentCycle","description":"Payment cycle associated with this adjustment."},"date_submitted":{"type":["string","null"],"format":"date-time","description":"Timestamp when the adjustment was submitted for review."},"hourlyReportPreset":{"oneOf":[{"$ref":"#/components/schemas/InvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItemsHourlyReportPreset"},{"type":"null"}]}},"required":["id","type","status","contract","quantity","worksheet","attachment","created_at","description","reported_by","reviewed_by","total_amount","currency_code","payment_cycle"],"title":"InvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItems"},"InvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaPage":{"type":"object","properties":{"offset":{"type":"number","format":"double","description":"Index of the first record in the current page."},"total_rows":{"type":"number","format":"double","description":"Total number of records available."},"items_per_page":{"type":"number","format":"double","description":"Number of records returned per page."}},"required":["offset","total_rows","items_per_page"],"description":"Pagination metadata for the response.","title":"InvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaPage"},"invoice-adjustments_getInvoiceAdjustments_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/InvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaDataItems"},"description":"List of invoice adjustments returned for the request."},"page":{"$ref":"#/components/schemas/InvoiceAdjustmentsGetResponsesContentApplicationJsonSchemaPage","description":"Pagination metadata for the response."}},"required":["data","page"],"title":"invoice-adjustments_getInvoiceAdjustments_Response_200"},"ListInvoiceAdjustments-v2026-01-01RequestBadRequestError":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"],"title":"ListInvoiceAdjustments-v2026-01-01RequestBadRequestError"},"InvoiceAdjustmentsIdReviewsPostRequestBodyContentApplicationJsonSchemaDataStatus":{"type":"string","enum":["approved","declined"],"description":"The status of the adjustment.","title":"InvoiceAdjustmentsIdReviewsPostRequestBodyContentApplicationJsonSchemaDataStatus"},"InvoiceAdjustmentsIdReviewsPostRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"reason":{"type":["string","null"],"description":"The reason for the adjustment update."},"status":{"$ref":"#/components/schemas/InvoiceAdjustmentsIdReviewsPostRequestBodyContentApplicationJsonSchemaDataStatus","description":"The status of the adjustment."}},"required":["status"],"title":"InvoiceAdjustmentsIdReviewsPostRequestBodyContentApplicationJsonSchemaData"},"InvoiceAdjustmentsIdReviewsPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"created":{"type":"boolean"}},"required":["created"],"title":"InvoiceAdjustmentsIdReviewsPostResponsesContentApplicationJsonSchemaData"},"invoice-adjustments_createInvoiceAdjustmentReview_Response_201":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/InvoiceAdjustmentsIdReviewsPostResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"invoice-adjustments_createInvoiceAdjustmentReview_Response_201"},"InvoiceAdjustmentsIdPatchRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"title":{"type":"string","description":"Title of adjustment."},"amount":{"type":"number","format":"double","description":"Amount of adjustment."},"description":{"type":"string","description":"Description of adjustment."}},"description":"Details of adjustment to update","title":"InvoiceAdjustmentsIdPatchRequestBodyContentApplicationJsonSchemaData"},"InvoiceAdjustmentsIdPatchResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"updated":{"type":"boolean","description":"Confirms the update."}},"required":["updated"],"title":"InvoiceAdjustmentsIdPatchResponsesContentApplicationJsonSchemaData"},"invoice-adjustments_updateInvoiceAdjustment_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/InvoiceAdjustmentsIdPatchResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"invoice-adjustments_updateInvoiceAdjustment_Response_200"},"KnowledgeHubCountryGuideCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsCategoriesItemsFieldsItemsType":{"type":"string","enum":["TEXT","LINK","HTML"],"description":"Type of the field, can contain text, link or html","title":"KnowledgeHubCountryGuideCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsCategoriesItemsFieldsItemsType"},"KnowledgeHubCountryGuideCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsCategoriesItemsFieldsItems":{"type":"object","properties":{"id":{"type":"string","description":"ID of the field"},"name":{"type":"string","description":"Title of the field"},"type":{"$ref":"#/components/schemas/KnowledgeHubCountryGuideCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsCategoriesItemsFieldsItemsType","description":"Type of the field, can contain text, link or html"},"value":{"type":["string","null"],"description":"The value associated for the field"}},"required":["id","name","type"],"title":"KnowledgeHubCountryGuideCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsCategoriesItemsFieldsItems"},"KnowledgeHubCountryGuideCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsCategoriesItemsArticlesItemsTagsItems":{"type":"object","properties":{"id":{"type":"string","description":"ID for the tag"},"tag":{"type":"string","description":"Slug for the tag"},"title":{"type":"string","description":"Title of the tag"}},"required":["id","tag","title"],"title":"KnowledgeHubCountryGuideCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsCategoriesItemsArticlesItemsTagsItems"},"KnowledgeHubCountryGuideCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsCategoriesItemsArticlesItemsType":{"type":"string","enum":["KNOWLEDGE","COMPLIANCE"],"description":"The type of the article, can contain knowledge or compliance","title":"KnowledgeHubCountryGuideCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsCategoriesItemsArticlesItemsType"},"KnowledgeHubCountryGuideCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsCategoriesItemsArticlesItems":{"type":"object","properties":{"id":{"type":"string","description":"ID for the article"},"tags":{"type":"array","items":{"$ref":"#/components/schemas/KnowledgeHubCountryGuideCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsCategoriesItemsArticlesItemsTagsItems"},"description":"Array of tags inside an article"},"type":{"$ref":"#/components/schemas/KnowledgeHubCountryGuideCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsCategoriesItemsArticlesItemsType","description":"The type of the article, can contain knowledge or compliance"},"title":{"type":"string","description":"Title of the article"},"created_at":{"type":"string","format":"date-time","description":"The timestamp when the article was created"},"updated_at":{"type":"string","format":"date-time","description":"The timestamp when the article was last updated"},"description":{"type":"string","description":"An excerpt for the article"},"effective_date":{"type":["string","null"],"format":"date","description":"The date when the article will be effective, meaning the content inside it becomes effective in the real world)"},"featured_image":{"type":"string","format":"uri","description":"The featured image for the article"}},"required":["id","tags","type","title","created_at","updated_at","description","featured_image"],"title":"KnowledgeHubCountryGuideCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsCategoriesItemsArticlesItems"},"KnowledgeHubCountryGuideCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsCategoriesItems":{"type":"object","properties":{"id":{"type":"string","description":"ID for the category"},"icon":{"type":"string","description":"Icon aligning with the category"},"name":{"type":"string","description":"Display name of the category"},"fields":{"type":"array","items":{"$ref":"#/components/schemas/KnowledgeHubCountryGuideCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsCategoriesItemsFieldsItems"},"description":"An array of informative fields and it's value that the category contains"},"articles":{"type":"array","items":{"$ref":"#/components/schemas/KnowledgeHubCountryGuideCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsCategoriesItemsArticlesItems"},"description":"An array of articles that are connected to this category"}},"required":["id","icon","name","fields","articles"],"title":"KnowledgeHubCountryGuideCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsCategoriesItems"},"KnowledgeHubCountryGuideCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsContractTypesItemsCategoriesItemsFieldsItemsType":{"type":"string","enum":["TEXT","LINK","HTML"],"description":"Type of the field, can contain text, link or html","title":"KnowledgeHubCountryGuideCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsContractTypesItemsCategoriesItemsFieldsItemsType"},"KnowledgeHubCountryGuideCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsContractTypesItemsCategoriesItemsFieldsItems":{"type":"object","properties":{"id":{"type":"string","description":"ID of the field"},"name":{"type":"string","description":"Title of the field"},"type":{"$ref":"#/components/schemas/KnowledgeHubCountryGuideCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsContractTypesItemsCategoriesItemsFieldsItemsType","description":"Type of the field, can contain text, link or html"},"value":{"type":["string","null"],"description":"The value associated for the field"}},"required":["id","name","type"],"title":"KnowledgeHubCountryGuideCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsContractTypesItemsCategoriesItemsFieldsItems"},"KnowledgeHubCountryGuideCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsContractTypesItemsCategoriesItemsArticlesItemsTagsItems":{"type":"object","properties":{"id":{"type":"string","description":"ID for the tag"},"tag":{"type":"string","description":"Slug for the tag"},"title":{"type":"string","description":"Title of the tag"}},"required":["id","tag","title"],"title":"KnowledgeHubCountryGuideCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsContractTypesItemsCategoriesItemsArticlesItemsTagsItems"},"KnowledgeHubCountryGuideCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsContractTypesItemsCategoriesItemsArticlesItemsType":{"type":"string","enum":["KNOWLEDGE","COMPLIANCE"],"description":"The type of the article, can contain knowledge or compliance","title":"KnowledgeHubCountryGuideCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsContractTypesItemsCategoriesItemsArticlesItemsType"},"KnowledgeHubCountryGuideCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsContractTypesItemsCategoriesItemsArticlesItems":{"type":"object","properties":{"id":{"type":"string","description":"ID for the article"},"tags":{"type":"array","items":{"$ref":"#/components/schemas/KnowledgeHubCountryGuideCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsContractTypesItemsCategoriesItemsArticlesItemsTagsItems"},"description":"Array of tags inside an article"},"type":{"$ref":"#/components/schemas/KnowledgeHubCountryGuideCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsContractTypesItemsCategoriesItemsArticlesItemsType","description":"The type of the article, can contain knowledge or compliance"},"title":{"type":"string","description":"Title of the article"},"created_at":{"type":"string","format":"date-time","description":"The timestamp when the article was created"},"updated_at":{"type":"string","format":"date-time","description":"The timestamp when the article was last updated"},"description":{"type":"string","description":"An excerpt for the article"},"effective_date":{"type":["string","null"],"format":"date","description":"The date when the article will be effective, meaning the content inside it becomes effective in the real world)"},"featured_image":{"type":"string","format":"uri","description":"The featured image for the article"}},"required":["id","tags","type","title","created_at","updated_at","description","featured_image"],"title":"KnowledgeHubCountryGuideCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsContractTypesItemsCategoriesItemsArticlesItems"},"KnowledgeHubCountryGuideCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsContractTypesItemsCategoriesItems":{"type":"object","properties":{"id":{"type":"string","description":"ID for the category"},"icon":{"type":"string","description":"Icon aligning with the category"},"name":{"type":"string","description":"Display name of the category"},"fields":{"type":"array","items":{"$ref":"#/components/schemas/KnowledgeHubCountryGuideCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsContractTypesItemsCategoriesItemsFieldsItems"},"description":"An array of informative fields and it's value that the category contains"},"articles":{"type":"array","items":{"$ref":"#/components/schemas/KnowledgeHubCountryGuideCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsContractTypesItemsCategoriesItemsArticlesItems"},"description":"An array of articles that are connected to this category"}},"required":["id","icon","name","fields","articles"],"title":"KnowledgeHubCountryGuideCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsContractTypesItemsCategoriesItems"},"KnowledgeHubCountryGuideCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsContractTypesItems":{"type":"object","properties":{"name":{"type":"string","description":"The user friendly name of the contract type"},"value":{"type":"string","description":"Identifier or key representing the contract type in lowercase."},"categories":{"type":"array","items":{"$ref":"#/components/schemas/KnowledgeHubCountryGuideCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsContractTypesItemsCategoriesItems"},"description":"List of categories applicable to this audience."}},"required":["name","value","categories"],"title":"KnowledgeHubCountryGuideCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsContractTypesItems"},"KnowledgeHubCountryGuideCountryCodeGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"name":{"type":"string","description":"Display name of the audience."},"value":{"type":"string","description":"Identifier or key representing the audience in lowercase."},"categories":{"type":"array","items":{"$ref":"#/components/schemas/KnowledgeHubCountryGuideCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsCategoriesItems"},"description":"List of categories applicable to this audience."},"contract_types":{"type":"array","items":{"$ref":"#/components/schemas/KnowledgeHubCountryGuideCountryCodeGetResponsesContentApplicationJsonSchemaDataItemsContractTypesItems"},"description":"List of contract types available for this audience."}},"required":["name","value"],"description":"Represents a specific audience such as Contractor, Client, or Employee.","title":"KnowledgeHubCountryGuideCountryCodeGetResponsesContentApplicationJsonSchemaDataItems"},"Knowledge Hub_getKnowledgeHubCountryGuidesByCountryCode_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/KnowledgeHubCountryGuideCountryCodeGetResponsesContentApplicationJsonSchemaDataItems"},"description":"List of different audiences with associated categories and contract types."},"has_more":{"type":"boolean","description":"Indicates if there are more items to fetch."},"next_cursor":{"type":["string","null"],"description":"Cursor for the next page of results"},"total_count":{"type":"number","format":"double","description":"Total number of audiences"}},"title":"Knowledge Hub_getKnowledgeHubCountryGuidesByCountryCode_Response_200"},"KnowledgeHubCountryGuideCountryCodeGetResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code"},"message":{"type":"string","description":"Human-readable explanation of the error"}},"title":"KnowledgeHubCountryGuideCountryCodeGetResponsesContentApplicationJsonSchemaErrorsItems"},"GetKnowledgeHubCountryGuidesByCountryCodeRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/KnowledgeHubCountryGuideCountryCodeGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"GetKnowledgeHubCountryGuidesByCountryCodeRequestBadRequestError"},"GetKnowledgeHubCountryGuidesByCountryCodeRequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/KnowledgeHubCountryGuideCountryCodeGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"GetKnowledgeHubCountryGuidesByCountryCodeRequestInternalServerError"},"EngageLearningActionableJourneysGetResponsesContentApplicationJsonSchemaDataItemsStepJourney":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the Journey"},"title":{"type":"string","description":"Title of the journey"}},"description":"Basic Journey information for the step","title":"EngageLearningActionableJourneysGetResponsesContentApplicationJsonSchemaDataItemsStepJourney"},"EngageLearningActionableJourneysGetResponsesContentApplicationJsonSchemaDataItemsStep":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the Step"},"journey":{"$ref":"#/components/schemas/EngageLearningActionableJourneysGetResponsesContentApplicationJsonSchemaDataItemsStepJourney","description":"Basic Journey information for the step"},"journey_id":{"type":"string","format":"uuid","description":"ID of the Journey this step belongs to"}},"required":["id","journey","journey_id"],"description":"Step details","title":"EngageLearningActionableJourneysGetResponsesContentApplicationJsonSchemaDataItemsStep"},"EngageLearningActionableJourneysGetResponsesContentApplicationJsonSchemaDataItemsJourneyCoverPicture":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the CoverPicture Attachment"},"url":{"type":"string","format":"uri","description":"URL to access the cover picture"},"file_name":{"type":"string","description":"Name of the file"},"attachable_id":{"type":"string","format":"uuid","description":"ID of the entity this attachment belongs to e.g. JourneyID"},"attachable_type":{"type":"string","description":"Type of the entity this attachment belongs to e.g Journey"},"file_content_type":{"type":"string","description":"Content type of the file"},"attachment_type_slug":{"type":"string","description":"Type of the attachment (e.g., cover_picture)"}},"description":"CoverPicture details for the Journey","title":"EngageLearningActionableJourneysGetResponsesContentApplicationJsonSchemaDataItemsJourneyCoverPicture"},"EngageLearningActionableJourneysGetResponsesContentApplicationJsonSchemaDataItemsJourneyVisibilitySlug":{"type":"string","enum":["organization","public","private-marketplace"],"description":"The visibility setting of the Journey","title":"EngageLearningActionableJourneysGetResponsesContentApplicationJsonSchemaDataItemsJourneyVisibilitySlug"},"EngageLearningActionableJourneysGetResponsesContentApplicationJsonSchemaDataItemsJourneyCreatedByHrisOrganizationUserProfileType":{"type":"string","enum":["WORKER","CLIENT"],"description":"Type of the User","title":"EngageLearningActionableJourneysGetResponsesContentApplicationJsonSchemaDataItemsJourneyCreatedByHrisOrganizationUserProfileType"},"EngageLearningActionableJourneysGetResponsesContentApplicationJsonSchemaDataItemsJourneyCreatedByHrisOrganizationUserProfile":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/EngageLearningActionableJourneysGetResponsesContentApplicationJsonSchemaDataItemsJourneyCreatedByHrisOrganizationUserProfileType","description":"Type of the User"},"email":{"type":"string","format":"email","description":"Email of the user who created the Journey"},"country":{"type":["string","null"],"description":"Country of the User"},"pic_url":{"type":"string","format":"uri","description":"URL of the profile picture"},"job_title":{"type":["string","null"],"description":"Job title of the User"},"last_name":{"type":"string","description":"Last name of the User"},"first_name":{"type":"string","description":"First name of the User"},"work_email":{"type":["string","null"],"format":"email","description":"Work email of the User"},"deactivated_at":{"type":["string","null"],"format":"date-time","description":"Deactivation timestamp, if applicable"},"preferred_name":{"type":"string","description":"Preferred name of the User"},"organization_public_id":{"type":"string","format":"uuid","description":"Public ID of the organization"},"hris_organization_user_id":{"type":"string","format":"uuid","description":"HRIS organization user ID"}},"description":"Profile of the user who created the journey","title":"EngageLearningActionableJourneysGetResponsesContentApplicationJsonSchemaDataItemsJourneyCreatedByHrisOrganizationUserProfile"},"EngageLearningActionableJourneysGetResponsesContentApplicationJsonSchemaDataItemsJourneyUpdatedByHrisOrganizationUserProfileType":{"type":"string","enum":["WORKER","CLIENT"],"description":"Type of the User","title":"EngageLearningActionableJourneysGetResponsesContentApplicationJsonSchemaDataItemsJourneyUpdatedByHrisOrganizationUserProfileType"},"EngageLearningActionableJourneysGetResponsesContentApplicationJsonSchemaDataItemsJourneyUpdatedByHrisOrganizationUserProfile":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/EngageLearningActionableJourneysGetResponsesContentApplicationJsonSchemaDataItemsJourneyUpdatedByHrisOrganizationUserProfileType","description":"Type of the User"},"email":{"type":"string","format":"email","description":"Email of the user who last updated the journey"},"country":{"type":["string","null"],"description":"Country of the User"},"pic_url":{"type":"string","format":"uri","description":"URL of the profile picture"},"job_title":{"type":["string","null"],"description":"Job title of the User"},"last_name":{"type":"string","description":"Last name of the User"},"first_name":{"type":"string","description":"First name of the User"},"work_email":{"type":["string","null"],"format":"email","description":"Work email of the User"},"deactivated_at":{"type":["string","null"],"format":"date-time","description":"Deactivation timestamp, if applicable"},"preferred_name":{"type":"string","description":"Preferred name of the User"},"organization_public_id":{"type":"string","format":"uuid","description":"Public ID of the organization"},"hris_organization_user_id":{"type":"string","format":"uuid","description":"HRIS organization user ID"}},"description":"Profile of the user who last updated the journey","title":"EngageLearningActionableJourneysGetResponsesContentApplicationJsonSchemaDataItemsJourneyUpdatedByHrisOrganizationUserProfile"},"EngageLearningActionableJourneysGetResponsesContentApplicationJsonSchemaDataItemsJourney":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the journey"},"title":{"type":"string","description":"Title of the journey"},"type_slug":{"type":"string","description":"The type slug of the Journey e.g default, Scorm"},"created_at":{"type":"string","format":"date-time","description":"The timestamp when the Journey was created"},"updated_at":{"type":"string","format":"date-time","description":"The timestamp when the Journey was last updated"},"description":{"type":"string","description":"Description of the Journey"},"is_template":{"type":"boolean","description":"Whether the Journey is a template"},"draft_for_id":{"type":["string","null"],"format":"uuid","description":"If this is draft for an existing Journey, draft_for_id is the reference to the original Journey ID."},"published_at":{"type":"string","format":"date-time","description":"The timestamp when the Journey was published"},"cover_picture":{"oneOf":[{"$ref":"#/components/schemas/EngageLearningActionableJourneysGetResponsesContentApplicationJsonSchemaDataItemsJourneyCoverPicture"},{"type":"null"}],"description":"CoverPicture details for the Journey"},"is_time_based":{"type":"boolean","description":"Whether the Journey is time-based"},"is_cohort_based":{"type":"boolean","description":"Whether the Journey is cohort-based"},"organization_id":{"type":"integer","description":"The organizationID this Journey belongs to"},"visibility_slug":{"$ref":"#/components/schemas/EngageLearningActionableJourneysGetResponsesContentApplicationJsonSchemaDataItemsJourneyVisibilitySlug","description":"The visibility setting of the Journey"},"recently_edited_at":{"type":"string","format":"date-time","description":"The timestamp when the Journey was recently edited"},"is_visible_in_library":{"type":"boolean","description":"Whether the Journey is visible in the library"},"is_self_assignment_allowed":{"type":"boolean","description":"Whether self-assignment is allowed for this Journey"},"created_by_hris_organization_user_profile":{"$ref":"#/components/schemas/EngageLearningActionableJourneysGetResponsesContentApplicationJsonSchemaDataItemsJourneyCreatedByHrisOrganizationUserProfile","description":"Profile of the user who created the journey"},"updated_by_hris_organization_user_profile":{"$ref":"#/components/schemas/EngageLearningActionableJourneysGetResponsesContentApplicationJsonSchemaDataItemsJourneyUpdatedByHrisOrganizationUserProfile","description":"Profile of the user who last updated the journey"}},"required":["id","title","type_slug","created_at","updated_at","description","is_template","draft_for_id","published_at","cover_picture","is_time_based","is_cohort_based","organization_id","visibility_slug","recently_edited_at","is_visible_in_library","is_self_assignment_allowed","created_by_hris_organization_user_profile","updated_by_hris_organization_user_profile"],"description":"Journey details","title":"EngageLearningActionableJourneysGetResponsesContentApplicationJsonSchemaDataItemsJourney"},"EngageLearningActionableJourneysGetResponsesContentApplicationJsonSchemaDataItemsScopeableAssigneeHrisOrganizationUserType":{"type":"string","enum":["WORKER","CLIENT"],"description":"Type of the assignee user","title":"EngageLearningActionableJourneysGetResponsesContentApplicationJsonSchemaDataItemsScopeableAssigneeHrisOrganizationUserType"},"EngageLearningActionableJourneysGetResponsesContentApplicationJsonSchemaDataItemsScopeableAssigneeHrisOrganizationUser":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/EngageLearningActionableJourneysGetResponsesContentApplicationJsonSchemaDataItemsScopeableAssigneeHrisOrganizationUserType","description":"Type of the assignee user"},"email":{"type":"string","format":"email","description":"Email address of the assignee"},"country":{"type":["string","null"],"description":"Country of the assignee"},"pic_url":{"type":"string","format":"uri","description":"URL of the profile picture of the assignee"},"job_title":{"type":["string","null"],"description":"Job title of the assignee"},"last_name":{"type":"string","description":"Last name of the assignee"},"first_name":{"type":"string","description":"First name of the assignee"},"work_email":{"type":"string","format":"email","description":"Work email of the assignee"},"deactivated_at":{"type":["string","null"],"format":"date-time","description":"Deactivation timestamp of the assignee, if applicable"},"preferred_name":{"type":"string","description":"Preferred name of the assignee"},"organization_public_id":{"type":"string","format":"uuid","description":"Public ID of the organization the assignee belongs to"},"hris_organization_user_id":{"type":"string","format":"uuid","description":"HRIS organization user ID of the assignee"}},"description":"Details of the assigned user","title":"EngageLearningActionableJourneysGetResponsesContentApplicationJsonSchemaDataItemsScopeableAssigneeHrisOrganizationUser"},"EngageLearningActionableJourneysGetResponsesContentApplicationJsonSchemaDataItemsScopeable":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the scopeable entity e.g AssignmentID"},"is_self_assigned":{"type":"boolean","description":"Whether the assignment was self-assigned"},"assignee_hris_organization_user":{"$ref":"#/components/schemas/EngageLearningActionableJourneysGetResponsesContentApplicationJsonSchemaDataItemsScopeableAssigneeHrisOrganizationUser","description":"Details of the assigned user"}},"required":["id","is_self_assigned","assignee_hris_organization_user"],"description":"Scopeable entity details e.g Assignment details","title":"EngageLearningActionableJourneysGetResponsesContentApplicationJsonSchemaDataItemsScopeable"},"EngageLearningActionableJourneysGetResponsesContentApplicationJsonSchemaDataItemsCompletion":{"type":"object","properties":{"percentage":{"type":"number","format":"double","description":"Completion percentage of the Journey"}},"required":["percentage"],"description":"Completion status of the Journey","title":"EngageLearningActionableJourneysGetResponsesContentApplicationJsonSchemaDataItemsCompletion"},"EngageLearningActionableJourneysGetResponsesContentApplicationJsonSchemaDataItemsRecipientableType":{"type":"string","enum":["WORKER","CLIENT"],"description":"Type of the recipient User","title":"EngageLearningActionableJourneysGetResponsesContentApplicationJsonSchemaDataItemsRecipientableType"},"EngageLearningActionableJourneysGetResponsesContentApplicationJsonSchemaDataItemsRecipientable":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/EngageLearningActionableJourneysGetResponsesContentApplicationJsonSchemaDataItemsRecipientableType","description":"Type of the recipient User"},"email":{"type":"string","format":"email","description":"Email address of the recipient"},"country":{"type":["string","null"],"description":"Country of the recipient"},"pic_url":{"type":"string","format":"uri","description":"URL of the profile picture of the recipient"},"job_title":{"type":["string","null"],"description":"Job title of the recipient"},"last_name":{"type":"string","description":"Last name of the recipient"},"first_name":{"type":"string","description":"First name of the recipient"},"work_email":{"type":"string","format":"email","description":"Work email of the recipient"},"deactivated_at":{"type":["string","null"],"format":"date-time","description":"Deactivation timestamp of the recipient, if applicable"},"preferred_name":{"type":"string","description":"Preferred name of the recipient"},"organization_public_id":{"type":"string","format":"uuid","description":"Public ID of the organization the recipient belongs to"},"hris_organization_user_id":{"type":"string","format":"uuid","description":"HRIS organization user ID of the recipient"}},"required":["type","email","country","pic_url","job_title","last_name","first_name","work_email","deactivated_at","preferred_name","organization_public_id","hris_organization_user_id"],"description":"Recipient for the ActionableJourney Step. Used in conjunction with recipient_setting_type. Recipient can be the same user as Assignee or any other user e.g Manager or Accounts Lead based on the RecipientSetting for the Step.","title":"EngageLearningActionableJourneysGetResponsesContentApplicationJsonSchemaDataItemsRecipientable"},"EngageLearningActionableJourneysGetResponsesContentApplicationJsonSchemaDataItemsRecipientSettingType":{"type":"string","enum":["hris_organization_user","manager","buddy","mentor"],"description":"Type of RecipientSetting. e.g Manager, Buddy etc.","title":"EngageLearningActionableJourneysGetResponsesContentApplicationJsonSchemaDataItemsRecipientSettingType"},"EngageLearningActionableJourneysGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"step":{"$ref":"#/components/schemas/EngageLearningActionableJourneysGetResponsesContentApplicationJsonSchemaDataItemsStep","description":"Step details"},"journey":{"$ref":"#/components/schemas/EngageLearningActionableJourneysGetResponsesContentApplicationJsonSchemaDataItemsJourney","description":"Journey details"},"scopeable":{"$ref":"#/components/schemas/EngageLearningActionableJourneysGetResponsesContentApplicationJsonSchemaDataItemsScopeable","description":"Scopeable entity details e.g Assignment details"},"completion":{"$ref":"#/components/schemas/EngageLearningActionableJourneysGetResponsesContentApplicationJsonSchemaDataItemsCompletion","description":"Completion status of the Journey"},"recipientable":{"$ref":"#/components/schemas/EngageLearningActionableJourneysGetResponsesContentApplicationJsonSchemaDataItemsRecipientable","description":"Recipient for the ActionableJourney Step. Used in conjunction with recipient_setting_type. Recipient can be the same user as Assignee or any other user e.g Manager or Accounts Lead based on the RecipientSetting for the Step."},"actionable_path":{"type":"string","description":"Path to redirect User for starting/resuming the Actionable Journey."},"recipient_setting_type":{"oneOf":[{"$ref":"#/components/schemas/EngageLearningActionableJourneysGetResponsesContentApplicationJsonSchemaDataItemsRecipientSettingType"},{"type":"null"}],"description":"Type of RecipientSetting. e.g Manager, Buddy etc."},"recipient_setting_dynamic_role_id":{"type":["string","null"],"description":"Dynamic role/relationship ID for RecipientSetting."},"recipient_setting_dynamic_role_name":{"type":["string","null"],"description":"Dynamic role name for RecipientSetting"}},"required":["step","journey","scopeable","completion","recipientable","actionable_path","recipient_setting_type","recipient_setting_dynamic_role_id","recipient_setting_dynamic_role_name"],"description":"ActionableJourney item","title":"EngageLearningActionableJourneysGetResponsesContentApplicationJsonSchemaDataItems"},"Learning_retrieveWorkersActionableJourneys_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/EngageLearningActionableJourneysGetResponsesContentApplicationJsonSchemaDataItems"}},"next_cursor":{"type":"string","description":"Cursor for the next page of results"}},"required":["data","next_cursor"],"description":"ActionableJourney is a representation of a JourneyAssignment and JourneyStep. This defines which Worker should be acting on which Step of the Journey. Generally, it would be same as Assignee of the JourneyAssignment, but can be different when RecipientSettings are added to Steps.","title":"Learning_retrieveWorkersActionableJourneys_Response_200"},"EngageLearningActionableJourneysGetResponsesContentApplicationJsonSchemaErrorsItems":{"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":"EngageLearningActionableJourneysGetResponsesContentApplicationJsonSchemaErrorsItems"},"EngageLearningActionableJourneysGetResponsesContentApplicationJsonSchemaRequest":{"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":"EngageLearningActionableJourneysGetResponsesContentApplicationJsonSchemaRequest"},"RetrieveWorkersActionableJourneysRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EngageLearningActionableJourneysGetResponsesContentApplicationJsonSchemaErrorsItems"}},"request":{"$ref":"#/components/schemas/EngageLearningActionableJourneysGetResponsesContentApplicationJsonSchemaRequest"}},"title":"RetrieveWorkersActionableJourneysRequestBadRequestError"},"LegalEntitiesPostRequestBodyContentApplicationJsonSchemaDataAddress":{"type":"object","properties":{"zip":{"type":"string","description":"Zip code."},"city":{"type":"string","description":"City name."},"state":{"type":"string","description":"State "},"street":{"type":"string","description":"Street address."},"country":{"type":"string","description":"Country code."}},"required":["zip","city","street","country"],"description":"The physical address of the entity.","title":"LegalEntitiesPostRequestBodyContentApplicationJsonSchemaDataAddress"},"LegalEntitiesPostRequestBodyContentApplicationJsonSchemaDataCompanyIdentifiers":{"type":"object","properties":{"tax_number":{"type":"string","description":"Tax number of the entity."},"registration_number":{"type":"string","description":"Registration number of the entity."}},"required":["tax_number","registration_number"],"title":"LegalEntitiesPostRequestBodyContentApplicationJsonSchemaDataCompanyIdentifiers"},"LegalEntitiesPostRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"name":{"type":"string","description":"The legal name of the entity."},"phone":{"type":"string","description":"Contact phone number for the entity."},"address":{"$ref":"#/components/schemas/LegalEntitiesPostRequestBodyContentApplicationJsonSchemaDataAddress","description":"The physical address of the entity."},"sic_number":{"type":"string","description":"The SIC number for the entity."},"entity_type":{"type":"string","description":"Type of the entity."},"company_identifiers":{"$ref":"#/components/schemas/LegalEntitiesPostRequestBodyContentApplicationJsonSchemaDataCompanyIdentifiers"}},"required":["name","phone","address","sic_number","entity_type","company_identifiers"],"title":"LegalEntitiesPostRequestBodyContentApplicationJsonSchemaData"},"LegalEntitiesPostResponsesContentApplicationJsonSchemaDataAddress":{"type":"object","properties":{"zip":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"street":{"type":"string"},"country":{"type":"string"}},"description":"The entity's address.","title":"LegalEntitiesPostResponsesContentApplicationJsonSchemaDataAddress"},"LegalEntitiesPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the legal entity."},"name":{"type":"string","description":"The name of the entity."},"phone":{"type":"string","description":"The contact number of the entity."},"address":{"$ref":"#/components/schemas/LegalEntitiesPostResponsesContentApplicationJsonSchemaDataAddress","description":"The entity's address."},"created_at":{"type":"string","format":"date-time","description":"Timestamp when the entity was created."},"sic_number":{"type":"string","description":"The SIC number of the entity."},"updated_at":{"type":"string","format":"date-time","description":"Timestamp when the entity was last updated."},"entity_type":{"type":"string","description":"Type of the entity."}},"title":"LegalEntitiesPostResponsesContentApplicationJsonSchemaData"},"legal-entities_createLegalEntity_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/LegalEntitiesPostResponsesContentApplicationJsonSchemaData"}},"title":"legal-entities_createLegalEntity_Response_200"},"CreateLegalEntityRequestBadRequestError":{"type":"object","properties":{"message":{"type":"string","description":"Error message explaining what went wrong."}},"title":"CreateLegalEntityRequestBadRequestError"},"CreateLegalEntityRequestForbiddenError":{"type":"object","properties":{"message":{"type":"string","description":"Error message explaining the lack of permission."}},"title":"CreateLegalEntityRequestForbiddenError"},"legal-entities_deleteLegalEntity_Response_200":{"type":"object","properties":{"archived_at":{"type":"string","format":"date-time","description":"The timestamp when the legal entity was archived."}},"title":"legal-entities_deleteLegalEntity_Response_200"},"DeleteLegalEntityRequestBadRequestError":{"type":"object","properties":{"message":{"type":"string","description":"Error message explaining what went wrong."}},"title":"DeleteLegalEntityRequestBadRequestError"},"DeleteLegalEntityRequestForbiddenError":{"type":"object","properties":{"error":{"type":"string","description":"Error message explaining why access is denied."}},"title":"DeleteLegalEntityRequestForbiddenError"},"LegalEntitiesIdPatchRequestBodyContentApplicationJsonSchemaAddress":{"type":"object","properties":{"city":{"type":"string","description":"The city."},"state":{"type":"string","description":"The state."},"street":{"type":"string","description":"The street address."},"country":{"type":"string","description":"The ISO 2-letter country code."}},"title":"LegalEntitiesIdPatchRequestBodyContentApplicationJsonSchemaAddress"},"LegalEntitiesIdPatchRequestBodyContentApplicationJsonSchemaCompanyIdentifiers":{"type":"object","properties":{"tax_number":{"type":"string","description":"The tax identification number of the legal entity."},"registration_number":{"type":"string","description":"The registration number of the legal entity."}},"description":"Identifiers associated with the legal entity.","title":"LegalEntitiesIdPatchRequestBodyContentApplicationJsonSchemaCompanyIdentifiers"},"LegalEntitiesIdPatchResponsesContentApplicationJsonSchemaDataAddress":{"type":"object","properties":{"city":{"type":"string","description":"The city."},"state":{"type":"string","description":"The state."},"street":{"type":"string","description":"The street address."},"country":{"type":"string","description":"The ISO 2-letter country code."}},"title":"LegalEntitiesIdPatchResponsesContentApplicationJsonSchemaDataAddress"},"LegalEntitiesIdPatchResponsesContentApplicationJsonSchemaDataCompanyIdentifiers":{"type":"object","properties":{"tax_number":{"type":"string","description":"The tax identification number of the legal entity."},"registration_number":{"type":"string","description":"The registration number of the legal entity."}},"title":"LegalEntitiesIdPatchResponsesContentApplicationJsonSchemaDataCompanyIdentifiers"},"LegalEntitiesIdPatchResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the legal entity."},"name":{"type":"string","description":"The name of the legal entity."},"phone":{"type":"string","description":"The phone number of the legal entity."},"address":{"$ref":"#/components/schemas/LegalEntitiesIdPatchResponsesContentApplicationJsonSchemaDataAddress"},"sic_number":{"type":"string","description":"The SIC number of the legal entity."},"entity_type":{"type":"string","description":"The type of the legal entity."},"industry_name":{"type":"string","description":"The industry name of the legal entity."},"company_identifiers":{"$ref":"#/components/schemas/LegalEntitiesIdPatchResponsesContentApplicationJsonSchemaDataCompanyIdentifiers"}},"title":"LegalEntitiesIdPatchResponsesContentApplicationJsonSchemaData"},"legal-entities_updateLegalEntity_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/LegalEntitiesIdPatchResponsesContentApplicationJsonSchemaData"}},"title":"legal-entities_updateLegalEntity_Response_200"},"EditLegalEntityRequestBadRequestError":{"type":"object","properties":{"message":{"type":"string","description":"Error message explaining what went wrong."}},"title":"EditLegalEntityRequestBadRequestError"},"EditLegalEntityRequestForbiddenError":{"type":"object","properties":{"error":{"type":"string","description":"Error message explaining why access is denied."}},"title":"EditLegalEntityRequestForbiddenError"},"BenefitsLegalEntitiesIdGetResponsesContentApplicationJsonSchemaAddress":{"type":"object","properties":{"zip":{"type":"string"},"city":{"type":"string"},"state":{"type":["string","null"]},"street":{"type":"string"},"country":{"type":"string"},"province":{"type":["string","null"]}},"description":"Address of the legal entity.","title":"BenefitsLegalEntitiesIdGetResponsesContentApplicationJsonSchemaAddress"},"BenefitsLegalEntitiesIdGetResponsesContentApplicationJsonSchemaEmploymentType":{"type":"string","enum":["peo","usp","gp"],"description":"Employment type of the legal entity.","title":"BenefitsLegalEntitiesIdGetResponsesContentApplicationJsonSchemaEmploymentType"},"BenefitsLegalEntitiesIdGetResponsesContentApplicationJsonSchemaRegistrationAddress":{"type":"object","properties":{"zip":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"street":{"type":"string"},"country":{"type":"string"},"province":{"type":"string"}},"description":"Registration address of the legal entity.","title":"BenefitsLegalEntitiesIdGetResponsesContentApplicationJsonSchemaRegistrationAddress"},"Legal Entities_getLegalEntityDataFromOrganizationIntegratedWithExternalBenefitsVendor-v2026-01-01_Response_200":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the legal entity."},"name":{"type":"string","description":"Name of the legal entity."},"phone":{"type":["string","null"],"description":"Phone number of the legal entity."},"vat_id":{"type":["string","null"],"description":"VAT ID of the legal entity, known as EIN in the US."},"address":{"$ref":"#/components/schemas/BenefitsLegalEntitiesIdGetResponsesContentApplicationJsonSchemaAddress","description":"Address of the legal entity."},"country":{"type":["string","null"],"description":"Country of the legal entity."},"naics_code":{"type":["string","null"],"description":"NAICS code of the legal entity."},"entity_type":{"type":"string","description":"Type of the legal entity (e.g., LLC)."},"employment_type":{"$ref":"#/components/schemas/BenefitsLegalEntitiesIdGetResponsesContentApplicationJsonSchemaEmploymentType","description":"Employment type of the legal entity."},"registration_number":{"type":["string","null"],"description":"Registration number of the legal entity."},"registration_address":{"oneOf":[{"$ref":"#/components/schemas/BenefitsLegalEntitiesIdGetResponsesContentApplicationJsonSchemaRegistrationAddress"},{"type":"null"}],"description":"Registration address of the legal entity."},"union_or_leased_employees":{"type":"boolean","description":"Indicates if the legal entity has union or leased employees."}},"title":"Legal Entities_getLegalEntityDataFromOrganizationIntegratedWithExternalBenefitsVendor-v2026-01-01_Response_200"},"IndustriesGetParametersOrder":{"type":"string","enum":["ASC","DESC"],"default":"ASC","title":"IndustriesGetParametersOrder"},"IndustriesGetParametersSortBy":{"type":"string","enum":["subcategoryName","categoryName"],"default":"categoryName","title":"IndustriesGetParametersSortBy"},"IndustriesGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"UUID of the subcategory."},"name":{"type":"string","description":"Name of the industry subcategory."},"created_at":{"type":"string","format":"date-time","description":"Date and time when the subcategory was created."},"updated_at":{"type":"string","format":"date-time","description":"Date and time when the subcategory was last updated."},"category_name":{"type":["string","null"],"description":"Name of the associated industry category."}},"required":["id","name","created_at","updated_at","category_name"],"title":"IndustriesGetResponsesContentApplicationJsonSchemaDataItems"},"legal-entities_getIndustries_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/IndustriesGetResponsesContentApplicationJsonSchemaDataItems"},"description":"List of industry subcategories."},"has_more":{"type":"boolean","description":"Indicates if there are more results available."},"next_cursor":{"type":["string","null"],"description":"Cursor to fetch the next page of results."},"total_count":{"type":"integer","description":"Total number of results matching the query."}},"required":["data","has_more","next_cursor","total_count"],"title":"legal-entities_getIndustries_Response_200"},"IndustriesGetResponsesContentApplicationJsonSchemaErrorsItems":{"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":"IndustriesGetResponsesContentApplicationJsonSchemaErrorsItems"},"IndustriesGetResponsesContentApplicationJsonSchemaRequest":{"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":"IndustriesGetResponsesContentApplicationJsonSchemaRequest"},"ListAllIndustrySubcategories-v2026-01-01RequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/IndustriesGetResponsesContentApplicationJsonSchemaErrorsItems"}},"request":{"$ref":"#/components/schemas/IndustriesGetResponsesContentApplicationJsonSchemaRequest"}},"title":"ListAllIndustrySubcategories-v2026-01-01RequestBadRequestError"},"LegalEntitiesGetParametersSortOrder":{"type":"string","enum":["ASC","DESC"],"default":"ASC","title":"LegalEntitiesGetParametersSortOrder"},"LegalEntitiesGetResponsesContentApplicationJsonSchemaDataItemsAddress":{"type":"object","properties":{"zip":{"type":"string","description":"Zip code"},"city":{"type":["string","null"],"description":"City"},"state":{"type":["string","null"],"description":"State"},"street":{"type":"string","description":"Street"},"country":{"type":"string","description":"Country"}},"title":"LegalEntitiesGetResponsesContentApplicationJsonSchemaDataItemsAddress"},"LegalEntitiesGetResponsesContentApplicationJsonSchemaDataItemsEntityType":{"type":"string","enum":["individual","company"],"description":"Entity type","title":"LegalEntitiesGetResponsesContentApplicationJsonSchemaDataItemsEntityType"},"LegalEntitiesGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"id":{"type":"string","description":"Id of the legal entity"},"name":{"type":"string","description":"Name of the legal entity"},"phone":{"type":["string","null"],"description":"Phone number"},"vat_id":{"type":["string","null"],"description":"VAT ID"},"address":{"oneOf":[{"$ref":"#/components/schemas/LegalEntitiesGetResponsesContentApplicationJsonSchemaDataItemsAddress"},{"type":"null"}]},"country":{"type":["string","null"],"description":"Country of the legal entity"},"created_at":{"type":"string","format":"date-time","description":"Created date"},"sic_number":{"type":["string","null"],"description":"SIC Company Identifier"},"updated_at":{"type":"string","format":"date-time","description":"Updated date"},"archived_at":{"type":["string","null"],"format":"date-time","description":"Archived date"},"entity_type":{"$ref":"#/components/schemas/LegalEntitiesGetResponsesContentApplicationJsonSchemaDataItemsEntityType","description":"Entity type"},"industry_name":{"type":["string","null"],"description":"Industry name"},"entity_subtype":{"type":"string","description":"Entity sub type"},"registrationNumber":{"type":["string","null"],"description":"Registration number"}},"title":"LegalEntitiesGetResponsesContentApplicationJsonSchemaDataItems"},"LegalEntitiesGetResponsesContentApplicationJsonSchemaPage":{"type":"object","properties":{"cursor":{"type":["string","null"],"description":"Cursor link"}},"title":"LegalEntitiesGetResponsesContentApplicationJsonSchemaPage"},"legal-entities_getLegalEntities_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/LegalEntitiesGetResponsesContentApplicationJsonSchemaDataItems"}},"page":{"$ref":"#/components/schemas/LegalEntitiesGetResponsesContentApplicationJsonSchemaPage"}},"title":"legal-entities_getLegalEntities_Response_200"},"LegalEntitiesLegalEntityIdPayrollEventsGetResponsesContentApplicationJsonSchemaDataItemsType":{"type":"string","enum":["OFFCYCLE","REGULAR"],"description":"The type of payroll cycle (e.g., OFFCYCLE, REGULAR).","title":"LegalEntitiesLegalEntityIdPayrollEventsGetResponsesContentApplicationJsonSchemaDataItemsType"},"LegalEntitiesLegalEntityIdPayrollEventsGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the payroll cycle."},"type":{"$ref":"#/components/schemas/LegalEntitiesLegalEntityIdPayrollEventsGetResponsesContentApplicationJsonSchemaDataItemsType","description":"The type of payroll cycle (e.g., OFFCYCLE, REGULAR)."},"date_end":{"type":"string","format":"date-time","description":"The end date of the payroll cycle."},"date_start":{"type":"string","format":"date-time","description":"The start date of the payroll cycle."},"legal_entity_id":{"type":"string","description":"The unique identifier for the associated legal entity."},"payroll_group_id":{"type":["string","null"],"description":"The unique identifier for the payroll group."}},"title":"LegalEntitiesLegalEntityIdPayrollEventsGetResponsesContentApplicationJsonSchemaDataItems"},"List Cycles_listPayrollCycles-v2026-01-01_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/LegalEntitiesLegalEntityIdPayrollEventsGetResponsesContentApplicationJsonSchemaDataItems"}},"has_more":{"type":"boolean","description":"Indicates whether more pages are available."},"next_cursor":{"type":["string","null"],"description":"Pagination cursor to fetch the next page of results."},"items_per_page":{"type":"integer","description":"The number of items per page."}},"required":["data","has_more","items_per_page"],"title":"List Cycles_listPayrollCycles-v2026-01-01_Response_200"},"LegalEntitiesLegalEntityIdPayrollEventsGetResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code"},"message":{"type":"string","description":"Human-readable explanation of the error"}},"title":"LegalEntitiesLegalEntityIdPayrollEventsGetResponsesContentApplicationJsonSchemaErrorsItems"},"ListPayrollCycles-v2026-01-01RequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/LegalEntitiesLegalEntityIdPayrollEventsGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"ListPayrollCycles-v2026-01-01RequestBadRequestError"},"ListPayrollCycles-v2026-01-01RequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/LegalEntitiesLegalEntityIdPayrollEventsGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"ListPayrollCycles-v2026-01-01RequestInternalServerError"},"LookupsJobTitlesGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"identifier of the job title"},"name":{"type":"string","description":"Job title."}},"required":["id","name"],"title":"LookupsJobTitlesGetResponsesContentApplicationJsonSchemaDataItems"},"LookupsJobTitlesGetResponsesContentApplicationJsonSchemaPage":{"type":"object","properties":{"cursor":{"type":"string","description":"Use for pagination to get next set of records after the given cursor."}},"required":["cursor"],"title":"LookupsJobTitlesGetResponsesContentApplicationJsonSchemaPage"},"lookups_getJobTitles_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/LookupsJobTitlesGetResponsesContentApplicationJsonSchemaDataItems"}},"page":{"$ref":"#/components/schemas/LookupsJobTitlesGetResponsesContentApplicationJsonSchemaPage"}},"title":"lookups_getJobTitles_Response_200"},"LookupsCountriesGetResponsesContentApplicationJsonSchemaDataItemsStatesItems":{"type":"object","properties":{"code":{"type":"string","description":"The code representing the sub-territory (e.g., state or region)."},"name":{"type":"string","description":"The name of the sub-territory (e.g., state or region)."}},"required":["code","name"],"title":"LookupsCountriesGetResponsesContentApplicationJsonSchemaDataItemsStatesItems"},"LookupsCountriesGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"code":{"type":"string","description":"The ISO 3166-1 alpha-2 country code."},"name":{"type":"string","description":"The official name of the country."},"states":{"type":"array","items":{"$ref":"#/components/schemas/LookupsCountriesGetResponsesContentApplicationJsonSchemaDataItemsStatesItems"},"description":"List of sub-territories within the country. These may be called states, provinces, prefectures, regions, or may not exist."},"state_type":{"type":["string","null"],"description":"The designation for sub-territories within the country, such as 'state', 'province', 'prefecture', or 'region'. If none, this field will be null."},"eor_support":{"type":"boolean","description":"Indicates whether Deel provides Employer of Record (EoR) support in this country."},"visa_support":{"type":"boolean","description":"Indicates whether Deel provides visa support for employees being hired in this country."},"default_currency":{"type":"string","description":"Indicates the default currency 3-letter ISO code"}},"required":["code","name","states","state_type","eor_support","visa_support","default_currency"],"title":"LookupsCountriesGetResponsesContentApplicationJsonSchemaDataItems"},"lookups_getCountries_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/LookupsCountriesGetResponsesContentApplicationJsonSchemaDataItems"}}},"title":"lookups_getCountries_Response_200"},"LookupsGetParametersDocuments":{"type":"string","enum":["sicNumbers","entityTypes","countries"],"title":"LookupsGetParametersDocuments"},"LookupsGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"label":{"type":"string","description":"The label for the lookup item (e.g., country name, entity type)."},"value":{"type":"string","description":"The value associated with the lookup item (e.g., ISO code, type identifier)."}},"title":"LookupsGetResponsesContentApplicationJsonSchemaDataItems"},"Lookups_getLookups_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/LookupsGetResponsesContentApplicationJsonSchemaDataItems"}}},"title":"Lookups_getLookups_Response_200"},"GetLookupsRequestBadRequestError":{"type":"object","properties":{"message":{"type":"string","description":"Error message explaining what went wrong."}},"title":"GetLookupsRequestBadRequestError"},"LookupsSenioritiesGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"A unique identifier for the seniority level."},"name":{"type":"string","description":"The name of the seniority level, e.g., 'Mid (Individual Contributor Level 2)'."},"level":{"type":["number","null"],"format":"double","description":"The hierarchical level of seniority, where higher numbers indicate greater seniority."}},"required":["id","name"],"title":"LookupsSenioritiesGetResponsesContentApplicationJsonSchemaDataItems"},"lookups_getSeniorityLevels_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/LookupsSenioritiesGetResponsesContentApplicationJsonSchemaDataItems"},"description":"List of predefined seniority levels supported by the Deel platform."}},"title":"lookups_getSeniorityLevels_Response_200"},"LookupsCurrenciesGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"code":{"type":"string","description":"The ISO 4217 three-letter currency code."},"name":{"type":["string","null"],"description":"The name of the currency. This may be null if a name is not available."}},"required":["code"],"title":"LookupsCurrenciesGetResponsesContentApplicationJsonSchemaDataItems"},"lookups_getCurrencies_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/LookupsCurrenciesGetResponsesContentApplicationJsonSchemaDataItems"},"description":"List of currencies supported by Deel."}},"title":"lookups_getCurrencies_Response_200"},"LookupsTimeOffTypesGetResponsesContentApplicationJsonSchemaDataItems":{"type":"string","enum":["VACATION","SICK_LEAVE","OTHER","UNPAID_LEAVE"],"description":"Predefined time-off types. Possible values include 'VACATION', 'SICK_LEAVE', 'UNPAID_LEAVE'  and 'OTHER'.","title":"LookupsTimeOffTypesGetResponsesContentApplicationJsonSchemaDataItems"},"lookups_getTimeOffTypes_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/LookupsTimeOffTypesGetResponsesContentApplicationJsonSchemaDataItems"},"description":"List of predefined time-off types supported by the Deel platform."}},"title":"lookups_getTimeOffTypes_Response_200"},"LookupsTimeOffTypesGetResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"message":{"type":"string","description":"Error message describing what went wrong."}},"required":["message"],"title":"LookupsTimeOffTypesGetResponsesContentApplicationJsonSchemaErrorsItems"},"RetrieveTimeOffTypesRequestNotFoundError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/LookupsTimeOffTypesGetResponsesContentApplicationJsonSchemaErrorsItems"},"description":"Array of error objects containing error messages."}},"required":["errors"],"title":"RetrieveTimeOffTypesRequestNotFoundError"},"MagicLinkPostRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"redirect_path":{"type":"string","description":"Path to redirect the user to after successful authentication."}},"title":"MagicLinkPostRequestBodyContentApplicationJsonSchemaData"},"MagicLinkPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"expires_at":{"type":"string","format":"date-time","description":"When the magic link expires (ISO 8601 format)"},"magic_link":{"type":"string","description":"The magic link URL that users can click and log in to deel automatically."}},"required":["expires_at","magic_link"],"title":"MagicLinkPostResponsesContentApplicationJsonSchemaData"},"magic-link_createMagicLink_Response_201":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/MagicLinkPostResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"magic-link_createMagicLink_Response_201"},"CreateMagicLinkRequestUnauthorizedError":{"type":"object","properties":{"error":{"type":"string"}},"title":"CreateMagicLinkRequestUnauthorizedError"},"CreateMagicLinkRequestInternalServerError":{"type":"object","properties":{"error":{"type":"string"}},"title":"CreateMagicLinkRequestInternalServerError"},"ManagersPostRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"email":{"type":"string","format":"email","description":"The email address of the manager."},"last_name":{"type":"string","description":"The last name of the manager."},"first_name":{"type":"string","description":"The first name of the manager."}},"required":["email","last_name","first_name"],"title":"ManagersPostRequestBodyContentApplicationJsonSchemaData"},"ManagersPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the created manager."},"email":{"type":"string","format":"email","description":"The email address of the created manager."},"last_name":{"type":"string","description":"The last name of the created manager."},"first_name":{"type":"string","description":"The first name of the created manager."}},"required":["id","email","last_name","first_name"],"title":"ManagersPostResponsesContentApplicationJsonSchemaData"},"managers_createManager_Response_201":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ManagersPostResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"managers_createManager_Response_201"},"CreateManagerRequestBadRequestError":{"type":"object","properties":{"error":{"type":"string","description":"Description of the validation error."}},"title":"CreateManagerRequestBadRequestError"},"CreateManagerRequestConflictError":{"type":"object","properties":{"error":{"type":"string","description":"Explanation of the conflict error."}},"title":"CreateManagerRequestConflictError"},"ManagersMagicLinksPostRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"manager_id":{"type":"string","description":"Manager id."}},"title":"ManagersMagicLinksPostRequestBodyContentApplicationJsonSchemaData"},"ManagersMagicLinksPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"created_at":{"type":"string","format":"date-time","description":"When the magic link was created (ISO 8601 format)"},"expires_at":{"type":"string","format":"date-time","description":"When the magic link expires (ISO 8601 format)"},"magic_link":{"type":"string","description":"The magic link URL that users can click and log in to Deel automatically"}},"required":["created_at","expires_at","magic_link"],"title":"ManagersMagicLinksPostResponsesContentApplicationJsonSchemaData"},"Managers_generateMagicLinkForManagerLogin_Response_201":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ManagersMagicLinksPostResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"Managers_generateMagicLinkForManagerLogin_Response_201"},"ManagersMagicLinksPostResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code"},"field":{"type":"string","description":"The field that caused the error"},"message":{"type":"string","description":"Human-readable error message"}},"required":["code","field","message"],"title":"ManagersMagicLinksPostResponsesContentApplicationJsonSchemaErrorsItems"},"GenerateMagicLinkForManagerLoginRequestUnauthorizedError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ManagersMagicLinksPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"GenerateMagicLinkForManagerLoginRequestUnauthorizedError"},"GenerateMagicLinkForManagerLoginRequestForbiddenError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ManagersMagicLinksPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"GenerateMagicLinkForManagerLoginRequestForbiddenError"},"GenerateMagicLinkForManagerLoginRequestNotFoundError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ManagersMagicLinksPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"GenerateMagicLinkForManagerLoginRequestNotFoundError"},"GenerateMagicLinkForManagerLoginRequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ManagersMagicLinksPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"GenerateMagicLinkForManagerLoginRequestInternalServerError"},"ManagersGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the manager."},"email":{"type":"string","format":"email","description":"The email address of the manager."},"last_name":{"type":"string","description":"The last name of the manager."},"first_name":{"type":"string","description":"The first name of the manager."}},"required":["id"],"title":"ManagersGetResponsesContentApplicationJsonSchemaDataItems"},"ManagersGetResponsesContentApplicationJsonSchemaPage":{"type":"object","properties":{"offset":{"type":["number","null"],"format":"double","description":"The offset/index of the current page."},"total_rows":{"type":"number","format":"double","description":"Total number of rows available for this resource."},"items_per_page":{"type":["number","null"],"format":"double","description":"Number of items returned per page."}},"required":["total_rows"],"description":"Pagination details for the response.","title":"ManagersGetResponsesContentApplicationJsonSchemaPage"},"managers_getManagers_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ManagersGetResponsesContentApplicationJsonSchemaDataItems"},"description":"List of managers in the organization."},"page":{"$ref":"#/components/schemas/ManagersGetResponsesContentApplicationJsonSchemaPage","description":"Pagination details for the response."}},"required":["data","page"],"title":"managers_getManagers_Response_200"},"ContractsContractIdMilestonesPostRequestBodyContentApplicationJsonSchemaDataAmount":{"oneOf":[{"type":"string"},{"type":"number","format":"double"}],"title":"ContractsContractIdMilestonesPostRequestBodyContentApplicationJsonSchemaDataAmount"},"ContractsContractIdMilestonesPostRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"title":{"type":"string","description":"The title of the milestone."},"amount":{"$ref":"#/components/schemas/ContractsContractIdMilestonesPostRequestBodyContentApplicationJsonSchemaDataAmount"},"description":{"type":"string","description":"A detailed description of the milestone."}},"required":["title","amount","description"],"title":"ContractsContractIdMilestonesPostRequestBodyContentApplicationJsonSchemaData"},"ContractsContractIdMilestonesPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"created":{"type":"boolean","description":"Indicates whether the milestone was successfully created."}},"required":["created"],"title":"ContractsContractIdMilestonesPostResponsesContentApplicationJsonSchemaData"},"milestones_createContractMilestone_Response_201":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ContractsContractIdMilestonesPostResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"milestones_createContractMilestone_Response_201"},"CreateMilestoneRequestBadRequestError":{"type":"object","properties":{"error":{"type":"string","description":"A detailed error message explaining the validation issue."}},"title":"CreateMilestoneRequestBadRequestError"},"CreateMilestoneRequestNotFoundError":{"type":"object","properties":{"error":{"type":"string","description":"A message indicating the contract was not found."}},"title":"CreateMilestoneRequestNotFoundError"},"ContractsContractIdMilestonesMilestoneIdDeleteResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"deleted":{"type":"boolean","description":"Confirms that the milestone was successfully deleted."}},"required":["deleted"],"title":"ContractsContractIdMilestonesMilestoneIdDeleteResponsesContentApplicationJsonSchemaData"},"milestones_deleteContractMilestone_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ContractsContractIdMilestonesMilestoneIdDeleteResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"milestones_deleteContractMilestone_Response_200"},"DeleteMilestoneByIdRequestBadRequestError":{"type":"object","properties":{"error":{"type":"string","description":"A message indicating the provided contract or milestone ID is not valid."}},"title":"DeleteMilestoneByIdRequestBadRequestError"},"DeleteMilestoneByIdRequestNotFoundError":{"type":"object","properties":{"error":{"type":"string","description":"A message indicating that the specified contract or milestone does not exist."}},"title":"DeleteMilestoneByIdRequestNotFoundError"},"DeleteMilestoneByIdRequestInternalServerError":{"type":"object","properties":{"error":{"type":"string","description":"A general error message for internal server issues."}},"title":"DeleteMilestoneByIdRequestInternalServerError"},"ContractsContractIdMilestonesMilestoneIdGetResponsesContentApplicationJsonSchemaDataId":{"oneOf":[{"type":"string"},{"type":"integer","format":"int64"}],"title":"ContractsContractIdMilestonesMilestoneIdGetResponsesContentApplicationJsonSchemaDataId"},"ContractsContractIdMilestonesMilestoneIdGetResponsesContentApplicationJsonSchemaDataReportedById":{"oneOf":[{"type":"string"},{"type":"integer","format":"int64"}],"title":"ContractsContractIdMilestonesMilestoneIdGetResponsesContentApplicationJsonSchemaDataReportedById"},"ContractsContractIdMilestonesMilestoneIdGetResponsesContentApplicationJsonSchemaDataReportedBy":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ContractsContractIdMilestonesMilestoneIdGetResponsesContentApplicationJsonSchemaDataReportedById"},"full_name":{"type":"string","description":"Reporter's full name."}},"required":["id"],"description":"Milestone creator.","title":"ContractsContractIdMilestonesMilestoneIdGetResponsesContentApplicationJsonSchemaDataReportedBy"},"ContractsContractIdMilestonesMilestoneIdGetResponsesContentApplicationJsonSchemaDataReviewedById":{"oneOf":[{"type":"string"},{"type":"integer","format":"int64"}],"title":"ContractsContractIdMilestonesMilestoneIdGetResponsesContentApplicationJsonSchemaDataReviewedById"},"ContractsContractIdMilestonesMilestoneIdGetResponsesContentApplicationJsonSchemaDataReviewedBy":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ContractsContractIdMilestonesMilestoneIdGetResponsesContentApplicationJsonSchemaDataReviewedById"},"full_name":{"type":"string","description":"Reviewer's full name."}},"required":["id"],"description":"Reviewer's information.","title":"ContractsContractIdMilestonesMilestoneIdGetResponsesContentApplicationJsonSchemaDataReviewedBy"},"ContractsContractIdMilestonesMilestoneIdGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ContractsContractIdMilestonesMilestoneIdGetResponsesContentApplicationJsonSchemaDataId"},"title":{"type":"string","description":"Title of milestone."},"amount":{"type":"string","description":"Amount to be paid for the milestone."},"status":{"type":"string","description":"Current status of milestone."},"created_at":{"type":["string","null"],"format":"date-time","description":"Long date-time format following ISO-8601"},"description":{"type":"string","description":"Description of milestone."},"reported_by":{"$ref":"#/components/schemas/ContractsContractIdMilestonesMilestoneIdGetResponsesContentApplicationJsonSchemaDataReportedBy","description":"Milestone creator."},"reviewed_by":{"oneOf":[{"$ref":"#/components/schemas/ContractsContractIdMilestonesMilestoneIdGetResponsesContentApplicationJsonSchemaDataReviewedBy"},{"type":"null"}],"description":"Reviewer's information."},"approval_requested":{"type":"boolean","description":"Indicates if the contractor has requested the approval for the milestone."}},"required":["id","title","amount","status","created_at","description","reported_by","reviewed_by","approval_requested"],"title":"ContractsContractIdMilestonesMilestoneIdGetResponsesContentApplicationJsonSchemaData"},"milestones_getContractMilestoneById_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ContractsContractIdMilestonesMilestoneIdGetResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"milestones_getContractMilestoneById_Response_200"},"ContractsContractIdMilestonesGetResponsesContentApplicationJsonSchemaDataItemsId":{"oneOf":[{"type":"string"},{"type":"integer","format":"int64"}],"title":"ContractsContractIdMilestonesGetResponsesContentApplicationJsonSchemaDataItemsId"},"ContractsContractIdMilestonesGetResponsesContentApplicationJsonSchemaDataItemsReportedById":{"oneOf":[{"type":"string"},{"type":"integer","format":"int64"}],"title":"ContractsContractIdMilestonesGetResponsesContentApplicationJsonSchemaDataItemsReportedById"},"ContractsContractIdMilestonesGetResponsesContentApplicationJsonSchemaDataItemsReportedBy":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ContractsContractIdMilestonesGetResponsesContentApplicationJsonSchemaDataItemsReportedById"},"full_name":{"type":"string","description":"The full name of the person who reported the milestone."}},"required":["id"],"description":"Information about the creator of the milestone.","title":"ContractsContractIdMilestonesGetResponsesContentApplicationJsonSchemaDataItemsReportedBy"},"ContractsContractIdMilestonesGetResponsesContentApplicationJsonSchemaDataItemsReviewedById":{"oneOf":[{"type":"string"},{"type":"integer","format":"int64"}],"title":"ContractsContractIdMilestonesGetResponsesContentApplicationJsonSchemaDataItemsReviewedById"},"ContractsContractIdMilestonesGetResponsesContentApplicationJsonSchemaDataItemsReviewedBy":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ContractsContractIdMilestonesGetResponsesContentApplicationJsonSchemaDataItemsReviewedById"},"full_name":{"type":"string","description":"The full name of the person who reviewed the milestone."}},"required":["id"],"description":"Information about the person who reviewed the milestone.","title":"ContractsContractIdMilestonesGetResponsesContentApplicationJsonSchemaDataItemsReviewedBy"},"ContractsContractIdMilestonesGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/ContractsContractIdMilestonesGetResponsesContentApplicationJsonSchemaDataItemsId"},"title":{"type":"string","description":"The title of the milestone."},"amount":{"type":"string","description":"The amount to be paid for completing this milestone."},"status":{"type":"string","description":"The current status of the milestone, such as 'Pending Approval', 'Approved', or 'Completed'."},"created_at":{"type":["string","null"],"format":"date-time","description":"The creation date of the milestone in ISO-8601 format."},"description":{"type":"string","description":"A detailed description of the milestone."},"reported_by":{"$ref":"#/components/schemas/ContractsContractIdMilestonesGetResponsesContentApplicationJsonSchemaDataItemsReportedBy","description":"Information about the creator of the milestone."},"reviewed_by":{"oneOf":[{"$ref":"#/components/schemas/ContractsContractIdMilestonesGetResponsesContentApplicationJsonSchemaDataItemsReviewedBy"},{"type":"null"}],"description":"Information about the person who reviewed the milestone."},"approval_requested":{"type":"boolean","description":"Indicates whether approval has been requested for the milestone."}},"required":["id","title","amount","status","created_at","description","reported_by","reviewed_by","approval_requested"],"title":"ContractsContractIdMilestonesGetResponsesContentApplicationJsonSchemaDataItems"},"milestones_getContractMilestones_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ContractsContractIdMilestonesGetResponsesContentApplicationJsonSchemaDataItems"},"description":"An array of milestone objects associated with the contract."}},"required":["data"],"title":"milestones_getContractMilestones_Response_200"},"ContractsContractIdOffCyclePaymentsPostRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"The amount of the off-cycle payment."},"description":{"type":"string","description":"A description or reason for the off-cycle payment."},"date_submitted":{"type":"string","format":"date","description":"The date the off-cycle payment is submitted, in ISO-8601 format (YYYY-MM-DD)."},"is_auto_approved":{"type":"boolean","description":"If true, the off-cycle payment will be automatically approved as part of the request."},"hourly_report_preset_id":{"type":["string","null"],"format":"uuid","description":"Id of an existing preset."}},"required":["amount","description","date_submitted"],"title":"ContractsContractIdOffCyclePaymentsPostRequestBodyContentApplicationJsonSchemaData"},"ContractsContractIdOffCyclePaymentsPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the created off-cycle payment."},"created":{"type":"boolean","description":"Indicates whether the off-cycle payment was successfully created."}},"required":["created"],"title":"ContractsContractIdOffCyclePaymentsPostResponsesContentApplicationJsonSchemaData"},"off-cycle_createContractOffCyclePayment_Response_201":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ContractsContractIdOffCyclePaymentsPostResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"off-cycle_createContractOffCyclePayment_Response_201"},"ContractsContractIdOffCyclePaymentsGetResponsesContentApplicationJsonSchemaDataItemsStatus":{"type":"string","enum":["approved","declined","not_payable","paid","pending","processing"],"description":"The current status of the off-cycle payment.","title":"ContractsContractIdOffCyclePaymentsGetResponsesContentApplicationJsonSchemaDataItemsStatus"},"ContractsContractIdOffCyclePaymentsGetResponsesContentApplicationJsonSchemaDataItemsReportedBy":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the reporter."},"full_name":{"type":"string","description":"Full name of the individual who reported the payment."}},"required":["id"],"description":"Details of the person who reported the off-cycle payment.","title":"ContractsContractIdOffCyclePaymentsGetResponsesContentApplicationJsonSchemaDataItemsReportedBy"},"ContractsContractIdOffCyclePaymentsGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the off-cycle payment."},"amount":{"type":"string","description":"The amount of the off-cycle payment."},"status":{"oneOf":[{"$ref":"#/components/schemas/ContractsContractIdOffCyclePaymentsGetResponsesContentApplicationJsonSchemaDataItemsStatus"},{"type":"null"}],"description":"The current status of the off-cycle payment."},"created_at":{"type":"string","format":"date-time","description":"The timestamp when the off-cycle payment was created."},"description":{"type":"string","description":"A description or reason for the off-cycle payment."},"reported_by":{"$ref":"#/components/schemas/ContractsContractIdOffCyclePaymentsGetResponsesContentApplicationJsonSchemaDataItemsReportedBy","description":"Details of the person who reported the off-cycle payment."},"currency_code":{"type":"string","description":"The three-letter ISO currency code for the payment amount."},"date_submitted":{"type":"string","format":"date-time","description":"The timestamp when the off-cycle payment was submitted."}},"required":["id","amount","status","created_at","description","reported_by","currency_code","date_submitted"],"title":"ContractsContractIdOffCyclePaymentsGetResponsesContentApplicationJsonSchemaDataItems"},"off-cycle_getContractOffCyclePayments_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ContractsContractIdOffCyclePaymentsGetResponsesContentApplicationJsonSchemaDataItems"}}},"required":["data"],"title":"off-cycle_getContractOffCyclePayments_Response_200"},"ContractsContractIdOffCyclePaymentsIdGetResponsesContentApplicationJsonSchemaDataStatus":{"type":"string","enum":["approved","declined","not_payable","paid","pending","processing"],"description":"Current status of the off-cycle payment.","title":"ContractsContractIdOffCyclePaymentsIdGetResponsesContentApplicationJsonSchemaDataStatus"},"ContractsContractIdOffCyclePaymentsIdGetResponsesContentApplicationJsonSchemaDataReportedBy":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the reporter."},"full_name":{"type":"string","description":"Full name of the person who reported the payment."}},"required":["id"],"title":"ContractsContractIdOffCyclePaymentsIdGetResponsesContentApplicationJsonSchemaDataReportedBy"},"ContractsContractIdOffCyclePaymentsIdGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the off-cycle payment."},"amount":{"type":"string","description":"Amount of the off-cycle payment."},"status":{"oneOf":[{"$ref":"#/components/schemas/ContractsContractIdOffCyclePaymentsIdGetResponsesContentApplicationJsonSchemaDataStatus"},{"type":"null"}],"description":"Current status of the off-cycle payment."},"created_at":{"type":"string","format":"date-time","description":"Timestamp of when the off-cycle payment was created."},"description":{"type":"string","description":"Description of the off-cycle payment."},"reported_by":{"$ref":"#/components/schemas/ContractsContractIdOffCyclePaymentsIdGetResponsesContentApplicationJsonSchemaDataReportedBy"},"currency_code":{"type":"string","description":"ISO 4217 currency code of the payment."},"date_submitted":{"type":"string","format":"date-time","description":"Timestamp of when the payment was submitted."}},"required":["id","amount","status","created_at","description","reported_by","currency_code","date_submitted"],"title":"ContractsContractIdOffCyclePaymentsIdGetResponsesContentApplicationJsonSchemaData"},"off-cycle_getContractOffCyclePaymentById_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ContractsContractIdOffCyclePaymentsIdGetResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"off-cycle_getContractOffCyclePaymentById_Response_200"},"OffboardingTrackerGetParametersHiringTypesSchemaItems":{"type":"string","enum":["contractor","employee"],"description":"Hiring type (e.g., contractor, employee)","title":"OffboardingTrackerGetParametersHiringTypesSchemaItems"},"OffboardingTrackerGetParametersProgressStatusesSchemaItems":{"type":"string","enum":["ACTIVE","INACTIVE","ONBOARDING"],"description":"Progress status of the contract","title":"OffboardingTrackerGetParametersProgressStatusesSchemaItems"},"OffboardingTrackerGetParametersSortBy":{"type":"string","enum":["progressStatusWeight"],"default":"progressStatusWeight","title":"OffboardingTrackerGetParametersSortBy"},"OffboardingTrackerGetParametersSortOrder":{"type":"string","enum":["ASC","DESC"],"default":"ASC","title":"OffboardingTrackerGetParametersSortOrder"},"OffboardingTrackerGetParametersPagination":{"type":"object","properties":{"contractId":{"type":"string","description":"Contract ID for pagination"},"effectiveDate":{"type":"string","format":"date-time","description":"Effective date for pagination"},"referenceDate":{"type":"string","format":"date-time","description":"Reference date for pagination"},"progressStatusWeight":{"type":"integer","description":"Progress status weight for pagination"}},"title":"OffboardingTrackerGetParametersPagination"},"OffboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsContract":{"type":"object","properties":{"id":{"type":"string","description":"The contract ID associated with the individual."}},"title":"OffboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsContract"},"OffboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsProgress":{"type":"object","properties":{"status":{"type":"string","description":"The current status of the offboarding process (e.g., OFFBOARDING_IN_PROGRESS)."},"reference_date":{"type":"string","description":"The reference date for the offboarding status (e.g., the termination date)."},"reference_date_type":{"type":"string","description":"The type of reference date (e.g., END_DATE)."},"reference_date_timezone":{"type":["string","null"],"description":"The timezone of the reference date."}},"title":"OffboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsProgress"},"OffboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsHrisProfile":{"type":"object","properties":{"oid":{"type":"string","description":"The object ID for the HRIS profile of the individual."}},"title":"OffboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsHrisProfile"},"OffboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsAppExperience":{"type":"object","properties":{"is_minimal_requirements":{"type":"boolean","description":"Indicates whether the individual meets the minimal experience requirements for the role."}},"title":"OffboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsAppExperience"},"OffboardingTrackerGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"name":{"type":"string","description":"The name of the individual associated with the offboarding."},"contract":{"$ref":"#/components/schemas/OffboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsContract"},"progress":{"$ref":"#/components/schemas/OffboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsProgress"},"unique_id":{"type":"string","description":"A unique identifier for the offboarding item."},"hiring_type":{"type":"string","description":"The hiring type for the individual (e.g., contractor)."},"hris_profile":{"$ref":"#/components/schemas/OffboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsHrisProfile"},"app_experience":{"$ref":"#/components/schemas/OffboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsAppExperience"},"termination_id":{"type":["string","null"],"description":"The termination ID if the individual has been terminated."},"offboarding_type":{"type":"string","description":"The type of offboarding (e.g., ENDING_CONTRACT, TERMINATION)."}},"title":"OffboardingTrackerGetResponsesContentApplicationJsonSchemaDataItems"},"OffboardingTrackerGetResponsesContentApplicationJsonSchemaPage":{"type":"object","properties":{"cursor":{"type":["string","null"],"description":"Cursor for pagination to fetch the next page of contractors"},"total_rows":{"type":"integer","description":"The total number of contractors available"}},"title":"OffboardingTrackerGetResponsesContentApplicationJsonSchemaPage"},"Offboarding_retrieveOffboardingList_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/OffboardingTrackerGetResponsesContentApplicationJsonSchemaDataItems"},"description":"A list of offboarding items."},"page":{"$ref":"#/components/schemas/OffboardingTrackerGetResponsesContentApplicationJsonSchemaPage"}},"title":"Offboarding_retrieveOffboardingList_Response_200"},"OffboardingTrackerIdGetResponsesContentApplicationJsonSchemaDataSummaryItemsDataId":{"oneOf":[{"type":"string"},{"type":"integer"}],"description":"The unique identifier for the contract associated with the summary item.","title":"OffboardingTrackerIdGetResponsesContentApplicationJsonSchemaDataSummaryItemsDataId"},"OffboardingTrackerIdGetResponsesContentApplicationJsonSchemaDataSummaryItemsData":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/OffboardingTrackerIdGetResponsesContentApplicationJsonSchemaDataSummaryItemsDataId","description":"The unique identifier for the contract associated with the summary item."}},"title":"OffboardingTrackerIdGetResponsesContentApplicationJsonSchemaDataSummaryItemsData"},"OffboardingTrackerIdGetResponsesContentApplicationJsonSchemaDataSummaryItems":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/OffboardingTrackerIdGetResponsesContentApplicationJsonSchemaDataSummaryItemsData"},"name":{"type":"string","description":"The name of the summary item (e.g., Contract ending details)."},"type":{"type":"string","description":"The type of summary information (e.g., CONTRACT_ENDING_DETAILS)."},"value":{"type":["string","null"],"description":"The value or status associated with the summary item."}},"title":"OffboardingTrackerIdGetResponsesContentApplicationJsonSchemaDataSummaryItems"},"OffboardingTrackerIdGetResponsesContentApplicationJsonSchemaDataContractEorProbationPeriod":{"type":"object","properties":{"status":{"type":"string","description":"probation status"},"period_end_at":{"type":"string","description":"Period end date"},"period_in_days":{"type":"integer","description":"total of days of period"}},"title":"OffboardingTrackerIdGetResponsesContentApplicationJsonSchemaDataContractEorProbationPeriod"},"OffboardingTrackerIdGetResponsesContentApplicationJsonSchemaDataContractEor":{"type":"object","properties":{"probation_period":{"$ref":"#/components/schemas/OffboardingTrackerIdGetResponsesContentApplicationJsonSchemaDataContractEorProbationPeriod"}},"description":"Employer of Record (EOR) for the contract, if applicable.","title":"OffboardingTrackerIdGetResponsesContentApplicationJsonSchemaDataContractEor"},"OffboardingTrackerIdGetResponsesContentApplicationJsonSchemaDataContract":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the contract."},"eor":{"oneOf":[{"$ref":"#/components/schemas/OffboardingTrackerIdGetResponsesContentApplicationJsonSchemaDataContractEor"},{"type":"null"}],"description":"Employer of Record (EOR) for the contract, if applicable."},"oid":{"type":"string","description":"The object ID for the contract, which might be the same as the contract ID."},"name":{"type":"string","description":"The name or title of the contract."},"timezone":{"type":"string","description":"The timezone associated with the contract (e.g., Europe/Belgrade)."},"contract_type":{"type":"string","description":"The type of the contract (e.g., payg_tasks)."}},"title":"OffboardingTrackerIdGetResponsesContentApplicationJsonSchemaDataContract"},"OffboardingTrackerIdGetResponsesContentApplicationJsonSchemaDataProgress":{"type":"object","properties":{"status":{"type":"string","description":"The current status of the offboarding process (e.g., OFFBOARDING_IN_PROGRESS)."},"reference_date":{"type":["string","null"],"description":"The reference date for the offboarding status (e.g., the termination date)."},"reference_date_type":{"type":"string","description":"The type of reference date (e.g., END_DATE)."},"reference_date_timezone":{"type":"string","description":"The timezone of the reference date."}},"title":"OffboardingTrackerIdGetResponsesContentApplicationJsonSchemaDataProgress"},"OffboardingTrackerIdGetResponsesContentApplicationJsonSchemaDataTerminationInitiatedBy":{"type":"object","properties":{"name":{"type":"string","description":"Name of individual"},"profile_type":{"type":["string","null"],"description":"individual's type"}},"description":"The individual that initiated the termination.","title":"OffboardingTrackerIdGetResponsesContentApplicationJsonSchemaDataTerminationInitiatedBy"},"OffboardingTrackerIdGetResponsesContentApplicationJsonSchemaDataTerminationTerminationImpact":{"type":"object","properties":{"title":{"type":"string","description":"Title of termination impact"},"description":{"type":"string","description":"Description of termination impact"}},"description":"The impact of the termination, if applicable.","title":"OffboardingTrackerIdGetResponsesContentApplicationJsonSchemaDataTerminationTerminationImpact"},"OffboardingTrackerIdGetResponsesContentApplicationJsonSchemaDataTermination":{"type":"object","properties":{"id":{"type":["string","null"],"description":"The termination ID"},"end_date":{"type":"string","description":"The end date of the contract termination."},"ending_type":{"type":"string","description":"The type of termination (e.g., ENDING_CONTRACT)."},"initiated_at":{"type":["string","null"],"description":"The date and time when the termination was initiated."},"initiated_by":{"oneOf":[{"$ref":"#/components/schemas/OffboardingTrackerIdGetResponsesContentApplicationJsonSchemaDataTerminationInitiatedBy"},{"type":"null"}],"description":"The individual that initiated the termination."},"public_message":{"type":["string","null"],"description":"A public message regarding the termination."},"termination_impact":{"oneOf":[{"$ref":"#/components/schemas/OffboardingTrackerIdGetResponsesContentApplicationJsonSchemaDataTerminationTerminationImpact"},{"type":"null"}],"description":"The impact of the termination, if applicable."},"eligible_for_rehire":{"type":["string","null"],"description":"Indicates whether the individual is eligible for rehire."},"eligible_for_rehire_reason":{"type":["string","null"],"description":"The reason why the individual is or is not eligible for rehire."}},"title":"OffboardingTrackerIdGetResponsesContentApplicationJsonSchemaDataTermination"},"OffboardingTrackerIdGetResponsesContentApplicationJsonSchemaDataHrisProfile":{"type":"object","properties":{"oid":{"type":"string","description":"The unique object ID for the HRIS profile."},"name":{"type":"string","description":"The name of the individual in the HRIS profile."},"work_email":{"type":"string","description":"The work email address of the individual in the HRIS profile."}},"title":"OffboardingTrackerIdGetResponsesContentApplicationJsonSchemaDataHrisProfile"},"OffboardingTrackerIdGetResponsesContentApplicationJsonSchemaDataAppExperience":{"type":"object","properties":{"is_minimal_requirements":{"type":"boolean","description":"Indicates whether the individual meets the minimal experience requirements for the role."}},"title":"OffboardingTrackerIdGetResponsesContentApplicationJsonSchemaDataAppExperience"},"OffboardingTrackerIdGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"summary":{"type":"array","items":{"$ref":"#/components/schemas/OffboardingTrackerIdGetResponsesContentApplicationJsonSchemaDataSummaryItems"}},"contract":{"$ref":"#/components/schemas/OffboardingTrackerIdGetResponsesContentApplicationJsonSchemaDataContract"},"progress":{"$ref":"#/components/schemas/OffboardingTrackerIdGetResponsesContentApplicationJsonSchemaDataProgress"},"hiring_type":{"type":"string","description":"The hiring type for the contract (e.g., contractor)."},"termination":{"$ref":"#/components/schemas/OffboardingTrackerIdGetResponsesContentApplicationJsonSchemaDataTermination"},"hris_profile":{"$ref":"#/components/schemas/OffboardingTrackerIdGetResponsesContentApplicationJsonSchemaDataHrisProfile"},"app_experience":{"$ref":"#/components/schemas/OffboardingTrackerIdGetResponsesContentApplicationJsonSchemaDataAppExperience"}},"title":"OffboardingTrackerIdGetResponsesContentApplicationJsonSchemaData"},"Offboarding_retrieveTerminationDetails_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/OffboardingTrackerIdGetResponsesContentApplicationJsonSchemaData"}},"title":"Offboarding_retrieveTerminationDetails_Response_200"},"OffboardingTrackerIdGetResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code"},"message":{"type":"string","description":"Human-readable explanation of the error"}},"title":"OffboardingTrackerIdGetResponsesContentApplicationJsonSchemaErrorsItems"},"RetrieveTerminationDetailsRequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/OffboardingTrackerIdGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"RetrieveTerminationDetailsRequestInternalServerError"},"OffboardingTrackerHrisProfileOidGetResponsesContentApplicationJsonSchemaDataSummaryItemsData":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the contract associated with the summary item."}},"title":"OffboardingTrackerHrisProfileOidGetResponsesContentApplicationJsonSchemaDataSummaryItemsData"},"OffboardingTrackerHrisProfileOidGetResponsesContentApplicationJsonSchemaDataSummaryItems":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/OffboardingTrackerHrisProfileOidGetResponsesContentApplicationJsonSchemaDataSummaryItemsData"},"name":{"type":"string","description":"The name of the summary item (e.g., Contract ending details)."},"type":{"type":"string","description":"The type of summary information (e.g., CONTRACT_ENDING_DETAILS)."},"value":{"type":"string","description":"The value or status associated with the summary item."}},"title":"OffboardingTrackerHrisProfileOidGetResponsesContentApplicationJsonSchemaDataSummaryItems"},"OffboardingTrackerHrisProfileOidGetResponsesContentApplicationJsonSchemaDataContractEorProbationPeriod":{"type":"object","properties":{"status":{"type":"string","description":"probation status"},"period_end_at":{"type":"string","description":"Period end date"},"period_in_days":{"type":"integer","description":"total of days of period"}},"title":"OffboardingTrackerHrisProfileOidGetResponsesContentApplicationJsonSchemaDataContractEorProbationPeriod"},"OffboardingTrackerHrisProfileOidGetResponsesContentApplicationJsonSchemaDataContractEor":{"type":"object","properties":{"probation_period":{"$ref":"#/components/schemas/OffboardingTrackerHrisProfileOidGetResponsesContentApplicationJsonSchemaDataContractEorProbationPeriod"}},"description":"Employer of Record (EOR) for the contract, if applicable.","title":"OffboardingTrackerHrisProfileOidGetResponsesContentApplicationJsonSchemaDataContractEor"},"OffboardingTrackerHrisProfileOidGetResponsesContentApplicationJsonSchemaDataContract":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the contract."},"eor":{"oneOf":[{"$ref":"#/components/schemas/OffboardingTrackerHrisProfileOidGetResponsesContentApplicationJsonSchemaDataContractEor"},{"type":"null"}],"description":"Employer of Record (EOR) for the contract, if applicable."},"oid":{"type":"string","description":"The object ID for the contract, which might be the same as the contract ID."},"name":{"type":"string","description":"The name or title of the contract."},"timezone":{"type":"string","description":"The timezone associated with the contract (e.g., Europe/Belgrade)."},"contract_type":{"type":"string","description":"The type of the contract (e.g., payg_tasks)."}},"title":"OffboardingTrackerHrisProfileOidGetResponsesContentApplicationJsonSchemaDataContract"},"OffboardingTrackerHrisProfileOidGetResponsesContentApplicationJsonSchemaDataProgress":{"type":"object","properties":{"status":{"type":"string","description":"The current status of the offboarding process (e.g., OFFBOARDING_IN_PROGRESS)."},"reference_date":{"type":"string","description":"The reference date for the offboarding status (e.g., the termination date)."},"reference_date_type":{"type":"string","description":"The type of reference date (e.g., END_DATE)."},"reference_date_timezone":{"type":"string","description":"The timezone of the reference date."}},"title":"OffboardingTrackerHrisProfileOidGetResponsesContentApplicationJsonSchemaDataProgress"},"OffboardingTrackerHrisProfileOidGetResponsesContentApplicationJsonSchemaDataTerminationInitiatedBy":{"type":"object","properties":{"name":{"type":"string","description":"Name of individual"},"profile_type":{"type":"string","description":"individual's type"}},"description":"The individual that initiated the termination.","title":"OffboardingTrackerHrisProfileOidGetResponsesContentApplicationJsonSchemaDataTerminationInitiatedBy"},"OffboardingTrackerHrisProfileOidGetResponsesContentApplicationJsonSchemaDataTerminationTerminationImpact":{"type":"object","properties":{"title":{"type":"string","description":"Title of termination impact"},"description":{"type":"string","description":"Description of termination impact"}},"description":"The impact of the termination, if applicable.","title":"OffboardingTrackerHrisProfileOidGetResponsesContentApplicationJsonSchemaDataTerminationTerminationImpact"},"OffboardingTrackerHrisProfileOidGetResponsesContentApplicationJsonSchemaDataTermination":{"type":"object","properties":{"id":{"type":["string","null"],"description":"The termination ID"},"end_date":{"type":"string","description":"The end date of the contract termination."},"ending_type":{"type":"string","description":"The type of termination (e.g., ENDING_CONTRACT)."},"initiated_at":{"type":["string","null"],"description":"The date and time when the termination was initiated."},"initiated_by":{"oneOf":[{"$ref":"#/components/schemas/OffboardingTrackerHrisProfileOidGetResponsesContentApplicationJsonSchemaDataTerminationInitiatedBy"},{"type":"null"}],"description":"The individual that initiated the termination."},"public_message":{"type":["string","null"],"description":"A public message regarding the termination."},"termination_impact":{"oneOf":[{"$ref":"#/components/schemas/OffboardingTrackerHrisProfileOidGetResponsesContentApplicationJsonSchemaDataTerminationTerminationImpact"},{"type":"null"}],"description":"The impact of the termination, if applicable."},"eligible_for_rehire":{"type":["string","null"],"description":"Indicates whether the individual is eligible for rehire."},"eligible_for_rehire_reason":{"type":["string","null"],"description":"The reason why the individual is or is not eligible for rehire."}},"title":"OffboardingTrackerHrisProfileOidGetResponsesContentApplicationJsonSchemaDataTermination"},"OffboardingTrackerHrisProfileOidGetResponsesContentApplicationJsonSchemaDataHrisProfile":{"type":"object","properties":{"oid":{"type":"string","description":"The unique object ID for the HRIS profile."},"name":{"type":"string","description":"The name of the individual in the HRIS profile."},"work_email":{"type":"string","description":"The work email address of the individual in the HRIS profile."}},"title":"OffboardingTrackerHrisProfileOidGetResponsesContentApplicationJsonSchemaDataHrisProfile"},"OffboardingTrackerHrisProfileOidGetResponsesContentApplicationJsonSchemaDataAppExperience":{"type":"object","properties":{"is_minimal_requirements":{"type":"boolean","description":"Indicates whether the individual meets the minimal experience requirements for the role."}},"title":"OffboardingTrackerHrisProfileOidGetResponsesContentApplicationJsonSchemaDataAppExperience"},"OffboardingTrackerHrisProfileOidGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"summary":{"type":"array","items":{"$ref":"#/components/schemas/OffboardingTrackerHrisProfileOidGetResponsesContentApplicationJsonSchemaDataSummaryItems"}},"contract":{"$ref":"#/components/schemas/OffboardingTrackerHrisProfileOidGetResponsesContentApplicationJsonSchemaDataContract"},"progress":{"$ref":"#/components/schemas/OffboardingTrackerHrisProfileOidGetResponsesContentApplicationJsonSchemaDataProgress"},"hiring_type":{"type":"string","description":"The hiring type for the contract (e.g., contractor)."},"termination":{"$ref":"#/components/schemas/OffboardingTrackerHrisProfileOidGetResponsesContentApplicationJsonSchemaDataTermination"},"hris_profile":{"$ref":"#/components/schemas/OffboardingTrackerHrisProfileOidGetResponsesContentApplicationJsonSchemaDataHrisProfile"},"app_experience":{"$ref":"#/components/schemas/OffboardingTrackerHrisProfileOidGetResponsesContentApplicationJsonSchemaDataAppExperience"}},"title":"OffboardingTrackerHrisProfileOidGetResponsesContentApplicationJsonSchemaData"},"Offboarding_retrieveTerminationDetailsByHrisProfileIdentifier_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/OffboardingTrackerHrisProfileOidGetResponsesContentApplicationJsonSchemaData"}},"title":"Offboarding_retrieveTerminationDetailsByHrisProfileIdentifier_Response_200"},"OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataProfile":{"type":"object","properties":{"name":{"type":"string","description":"Name associated with the profile"},"email":{"type":"string","format":"email","description":"Email of the profile"},"country":{"type":["string","null"],"description":"Country code"},"last_login":{"type":"string","format":"date-time","description":"Last login timestamp"},"previously_onboarded":{"type":"boolean","description":"Indicates if the contractor has previously onboarded"}},"description":"Employee profile information","title":"OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataProfile"},"OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataStepperItemsDataEmailsItemsMeta":{"type":"object","properties":{"type":{"type":"string","description":"Type of email"},"email":{"type":"string","format":"email","description":"Email address"},"sent_at":{"type":"string","format":"date-time","description":"Timestamp when the email was sent"}},"description":"Email metadata","title":"OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataStepperItemsDataEmailsItemsMeta"},"OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataStepperItemsDataEmailsItems":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataStepperItemsDataEmailsItemsMeta","description":"Email metadata"}},"title":"OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataStepperItemsDataEmailsItems"},"OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataStepperItemsData":{"type":"object","properties":{"emails":{"type":"array","items":{"$ref":"#/components/schemas/OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataStepperItemsDataEmailsItems"},"description":"List of emails sent during the stepper process"},"next_reminder_date":{"type":["string","null"],"format":"date-time","description":"Next reminder date, if applicable"}},"title":"OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataStepperItemsData"},"OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataStepperItems":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataStepperItemsData"},"type":{"type":"string","description":"Type of the stepper action"},"completed_at":{"type":["string","null"],"format":"date-time","description":"Completion timestamp of the stepper action"}},"description":"Stepper action information","title":"OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataStepperItems"},"OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataSummaryItemsData":{"type":"object","properties":{"country":{"type":"string","description":"Country code for location-related summaries"},"timezone":{"type":"string","description":"Timezone information"},"has_withdraw_methods":{"type":"boolean","description":"Indicates if withdrawal methods exist"}},"description":"Additional data about the summary item","title":"OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataSummaryItemsData"},"OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataSummaryItemsValue":{"oneOf":[{"type":"string"},{"type":"number","format":"double"},{"type":"boolean"},{"type":"string","format":"date-time"},{"type":"object","additionalProperties":{"description":"Any type"}}],"description":"Value of the summary item","title":"OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataSummaryItemsValue"},"OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataSummaryItems":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataSummaryItemsData","description":"Additional data about the summary item"},"name":{"type":"string","description":"Name of the summary item"},"type":{"type":"string","description":"Type of the summary item"},"value":{"$ref":"#/components/schemas/OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataSummaryItemsValue","description":"Value of the summary item"}},"description":"Summary item information","title":"OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataSummaryItems"},"OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataContractEmployeeAgreement":{"type":"object","properties":{"status":{"type":["string","null"],"description":"Status of the Employment Agreement. Can be null if the EA has not yet been generated"},"version_hash":{"type":["string","null"],"description":"Version of the Employment Agreement. Can be null if the EA has not yet been generated"}},"description":"Information about the Employment Agreement","title":"OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataContractEmployeeAgreement"},"OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataContractFirstEarlyInvoiceStatus":{"type":"string","enum":["OPEN","PENDING","SKIPPED","PREPROCESSING","PROCESSING","CREDITED","PROCESSED","PAID","FAILED","CANCELLED","REFUNDED","UNPAYABLE","AWAITING_PAYMENT"],"description":"Status of the invoice","title":"OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataContractFirstEarlyInvoiceStatus"},"OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataContractFirstEarlyInvoice":{"type":"object","properties":{"id":{"type":"string","description":"Unique invoice ID"},"amount":{"type":"string","description":"Invoice amount"},"status":{"$ref":"#/components/schemas/OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataContractFirstEarlyInvoiceStatus","description":"Status of the invoice"},"paid_at":{"type":["string","null"],"format":"date-time","description":"Timestamp when the invoice was paid, if applicable"},"currency":{"type":"string","description":"Currency code for the invoice amount"},"due_date":{"type":["string","null"],"format":"date-time","description":"Due date for the invoice"},"description":{"type":"string","description":"Invoice description"}},"description":"Only applicable for EOR contracts. First early invoice (EOR funding statement) for the contract, if any","title":"OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataContractFirstEarlyInvoice"},"OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataContract":{"type":"object","properties":{"id":{"type":"string","description":"Unique contract ID"},"oid":{"type":"string","description":"Contract OID"},"name":{"type":"string","description":"Contract name"},"status":{"type":"string","description":"Contract status (e.g., in_progress)"},"created_at":{"type":"string","format":"date-time","description":"Contract creation timestamp"},"first_sign":{"type":"string","description":"The first sign (either 'client' or 'contractor')"},"completion_date":{"type":["string","null"],"format":"date-time","description":"The completion date of the contract, if applicable"},"client_signed_at":{"type":["string","null"],"format":"date-time","description":"Timestamp when the client signed the contract"},"employee_agreement":{"$ref":"#/components/schemas/OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataContractEmployeeAgreement","description":"Information about the Employment Agreement"},"first_early_invoice":{"oneOf":[{"$ref":"#/components/schemas/OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataContractFirstEarlyInvoice"},{"type":"null"}],"description":"Only applicable for EOR contracts. First early invoice (EOR funding statement) for the contract, if any"},"contractor_signed_at":{"type":["string","null"],"format":"date-time","description":"Timestamp when the contractor signed the contract"},"invited_contractor_email":{"type":["string","null"],"format":"email","description":"Email of the invited contractor"}},"description":"Information about the contract","title":"OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataContract"},"OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataProgress":{"type":"object","properties":{"status":{"type":"string","description":"Current status of the onboarding process (e.g., ACTIVE)"},"reference_date":{"type":"string","format":"date-time","description":"Reference date for the progress"},"subject_to_overdue":{"type":"boolean","description":"Indicates if the onboarding is subject to overdue"},"reference_date_timezone":{"type":"string","description":"Timezone of the reference date"},"is_action_required_from_client":{"type":"boolean","description":"Indicates if action is required from the client"}},"description":"Progress of the onboarding process","title":"OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataProgress"},"OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataChecklistStepsItems":{"type":"object","properties":{"type":{"type":"string","description":"The type of checklist step"},"label":{"type":"string","description":"The label for the checklist step"},"status":{"type":"string","description":"Status of the checklist step"},"completed_at":{"type":["string","null"],"format":"date-time","description":"Completion timestamp of the checklist step"},"reject_reason":{"type":"string","description":"Reason for rejecting the checklist step (It may contain HTML elements)"}},"description":"Checklist step information","title":"OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataChecklistStepsItems"},"OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataChecklist":{"type":"object","properties":{"steps":{"type":"array","items":{"$ref":"#/components/schemas/OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataChecklistStepsItems"},"description":"List of checklist steps"}},"description":"List of checklist steps","title":"OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataChecklist"},"OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataHrisProfile":{"type":"object","properties":{"oid":{"type":"string","description":"HRIS Profile OID"},"name":{"type":"string","description":"HRIS Profile name"},"email":{"type":"string","format":"email","description":"Email of the HRIS profile"},"work_email":{"type":["string","null"],"format":"email","description":"Work email of the HRIS profile"}},"description":"Employeee HRIS profile information","title":"OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataHrisProfile"},"OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"profile":{"oneOf":[{"$ref":"#/components/schemas/OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataProfile"},{"type":"null"}],"description":"Employee profile information"},"stepper":{"type":"array","items":{"$ref":"#/components/schemas/OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataStepperItems"},"description":"List of stepper actions taken during the onboarding process"},"summary":{"type":"array","items":{"$ref":"#/components/schemas/OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataSummaryItems"},"description":"Summary of the onboarding process"},"contract":{"$ref":"#/components/schemas/OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataContract","description":"Information about the contract"},"progress":{"$ref":"#/components/schemas/OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataProgress","description":"Progress of the onboarding process"},"checklist":{"$ref":"#/components/schemas/OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataChecklist","description":"List of checklist steps"},"hiring_type":{"type":"string","description":"Hiring type (e.g., contractor)"},"hris_profile":{"$ref":"#/components/schemas/OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataHrisProfile","description":"Employeee HRIS profile information"}},"title":"OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaData"},"Onboarding_getOnboardingDetailsByEmployeeHrisProfileId-v2026-01-01_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/OnboardingTrackerHrisProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaData"}},"title":"Onboarding_getOnboardingDetailsByEmployeeHrisProfileId-v2026-01-01_Response_200"},"OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataProfile":{"type":"object","properties":{"name":{"type":"string","description":"Name associated with the profile"},"email":{"type":"string","format":"email","description":"Email of the profile"},"country":{"type":"string","description":"Country code"},"last_login":{"type":"string","format":"date-time","description":"Last login timestamp"},"previously_onboarded":{"type":"boolean","description":"Indicates if the contractor has previously onboarded"}},"description":"Employee profile information","title":"OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataProfile"},"OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataStepperItemsDataEmailsItemsMeta":{"type":"object","properties":{"type":{"type":"string","description":"Type of email"},"email":{"type":"string","format":"email","description":"Email address"},"sent_at":{"type":"string","format":"date-time","description":"Timestamp when the email was sent"}},"description":"Email metadata","title":"OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataStepperItemsDataEmailsItemsMeta"},"OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataStepperItemsDataEmailsItems":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataStepperItemsDataEmailsItemsMeta","description":"Email metadata"}},"title":"OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataStepperItemsDataEmailsItems"},"OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataStepperItemsData":{"type":"object","properties":{"emails":{"type":"array","items":{"$ref":"#/components/schemas/OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataStepperItemsDataEmailsItems"},"description":"List of emails sent during the stepper process"},"next_reminder_date":{"type":["string","null"],"format":"date-time","description":"Next reminder date, if applicable"}},"title":"OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataStepperItemsData"},"OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataStepperItems":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataStepperItemsData"},"type":{"type":"string","description":"Type of the stepper action"},"completed_at":{"type":["string","null"],"format":"date-time","description":"Completion timestamp of the stepper action"}},"description":"Stepper action information","title":"OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataStepperItems"},"OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataSummaryItemsData":{"type":"object","properties":{"country":{"type":"string","description":"Country code for location-related summaries"},"timezone":{"type":"string","description":"Timezone information"},"has_withdraw_methods":{"type":"boolean","description":"Indicates if withdrawal methods exist"}},"description":"Additional data about the summary item","title":"OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataSummaryItemsData"},"OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataSummaryItemsValue":{"oneOf":[{"type":"string"},{"type":"number","format":"double"},{"type":"boolean"},{"type":"string","format":"date-time"},{"type":"object","additionalProperties":{"description":"Any type"}}],"description":"Value of the summary item","title":"OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataSummaryItemsValue"},"OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataSummaryItems":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataSummaryItemsData","description":"Additional data about the summary item"},"name":{"type":"string","description":"Name of the summary item"},"type":{"type":"string","description":"Type of the summary item"},"value":{"$ref":"#/components/schemas/OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataSummaryItemsValue","description":"Value of the summary item"}},"description":"Summary item information","title":"OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataSummaryItems"},"OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataContractEmployeeAgreement":{"type":"object","properties":{"status":{"type":["string","null"],"description":"Status of the Employment Agreement. Can be null if the EA has not yet been generated"},"version_hash":{"type":["string","null"],"description":"Version of the Employment Agreement. Can be null if the EA has not yet been generated"}},"description":"Information about the Employment Agreement","title":"OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataContractEmployeeAgreement"},"OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataContractFirstEarlyInvoiceStatus":{"type":"string","enum":["OPEN","PENDING","SKIPPED","PREPROCESSING","PROCESSING","CREDITED","PROCESSED","PAID","FAILED","CANCELLED","REFUNDED","UNPAYABLE","AWAITING_PAYMENT"],"description":"Status of the invoice","title":"OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataContractFirstEarlyInvoiceStatus"},"OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataContractFirstEarlyInvoice":{"type":"object","properties":{"id":{"type":"string","description":"Unique invoice ID"},"amount":{"type":"string","description":"Invoice amount"},"status":{"$ref":"#/components/schemas/OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataContractFirstEarlyInvoiceStatus","description":"Status of the invoice"},"paid_at":{"type":["string","null"],"format":"date-time","description":"Timestamp when the invoice was paid, if applicable"},"currency":{"type":"string","description":"Currency code for the invoice amount"},"due_date":{"type":["string","null"],"format":"date-time","description":"Due date for the invoice"},"description":{"type":"string","description":"Invoice description"}},"description":"Applicable only for EOR contracts. First early invoice (EOR funding statement) for the contract, if any","title":"OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataContractFirstEarlyInvoice"},"OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataContract":{"type":"object","properties":{"id":{"type":"string","description":"Unique contract ID"},"oid":{"type":"string","description":"Contract OID"},"name":{"type":"string","description":"Contract name"},"status":{"type":"string","description":"Contract status (e.g., in_progress)"},"created_at":{"type":"string","format":"date-time","description":"Contract creation timestamp"},"first_sign":{"type":"string","description":"The first sign (either 'client' or 'contractor')"},"completion_date":{"type":["string","null"],"format":"date-time","description":"The completion date of the contract, if applicable"},"client_signed_at":{"type":["string","null"],"format":"date-time","description":"Timestamp when the client signed the contract"},"employee_agreement":{"$ref":"#/components/schemas/OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataContractEmployeeAgreement","description":"Information about the Employment Agreement"},"first_early_invoice":{"oneOf":[{"$ref":"#/components/schemas/OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataContractFirstEarlyInvoice"},{"type":"null"}],"description":"Applicable only for EOR contracts. First early invoice (EOR funding statement) for the contract, if any"},"contractor_signed_at":{"type":["string","null"],"format":"date-time","description":"Timestamp when the contractor signed the contract"},"invited_contractor_email":{"type":["string","null"],"format":"email","description":"Email of the invited contractor"}},"description":"Information about the contract","title":"OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataContract"},"OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataProgress":{"type":"object","properties":{"status":{"type":"string","description":"Current status of the onboarding process (e.g., ACTIVE)"},"reference_date":{"type":"string","format":"date-time","description":"Reference date for the progress"},"subject_to_overdue":{"type":"boolean","description":"Indicates if the onboarding is subject to overdue"},"reference_date_timezone":{"type":"string","description":"Timezone of the reference date"},"is_action_required_from_client":{"type":"boolean","description":"Indicates if action is required from the client"}},"description":"Progress of the onboarding process","title":"OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataProgress"},"OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataChecklistStepsItems":{"type":"object","properties":{"type":{"type":"string","description":"The type of checklist step"},"label":{"type":"string","description":"The label for the checklist step"},"status":{"type":"string","description":"Status of the checklist step"},"completed_at":{"type":["string","null"],"format":"date-time","description":"Completion timestamp of the checklist step"},"reject_reason":{"type":"string","description":"Reason for rejecting the checklist step (It may contain HTML elements)"}},"description":"Checklist step information","title":"OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataChecklistStepsItems"},"OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataChecklist":{"type":"object","properties":{"steps":{"type":"array","items":{"$ref":"#/components/schemas/OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataChecklistStepsItems"},"description":"List of checklist steps"}},"description":"List of checklist steps","title":"OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataChecklist"},"OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataHrisProfile":{"type":"object","properties":{"oid":{"type":"string","description":"HRIS Profile OID"},"name":{"type":"string","description":"HRIS Profile name"},"email":{"type":"string","format":"email","description":"Email of the HRIS profile"},"work_email":{"type":["string","null"],"format":"email","description":"Work email of the HRIS profile"}},"description":"Employeee HRIS profile information","title":"OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataHrisProfile"},"OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"profile":{"oneOf":[{"$ref":"#/components/schemas/OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataProfile"},{"type":"null"}],"description":"Employee profile information"},"stepper":{"type":"array","items":{"$ref":"#/components/schemas/OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataStepperItems"},"description":"List of stepper actions taken during the onboarding process"},"summary":{"type":"array","items":{"$ref":"#/components/schemas/OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataSummaryItems"},"description":"Summary of the onboarding process"},"contract":{"$ref":"#/components/schemas/OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataContract","description":"Information about the contract"},"progress":{"$ref":"#/components/schemas/OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataProgress","description":"Progress of the onboarding process"},"checklist":{"$ref":"#/components/schemas/OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataChecklist","description":"List of checklist steps"},"hiring_type":{"type":"string","description":"Hiring type (e.g., contractor)"},"hris_profile":{"$ref":"#/components/schemas/OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaDataHrisProfile","description":"Employeee HRIS profile information"}},"title":"OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaData"},"Onboarding_getOnboardingDetailsByOnboardingTrackerId-v2026-01-01_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/OnboardingTrackerTrackerIdGetResponsesContentApplicationJsonSchemaData"}},"title":"Onboarding_getOnboardingDetailsByOnboardingTrackerId-v2026-01-01_Response_200"},"OnboardingTrackerGetParametersHiringTypesSchemaItems":{"type":"string","enum":["contractor","employee"],"description":"Hiring type (e.g., contractor, employee)","title":"OnboardingTrackerGetParametersHiringTypesSchemaItems"},"OnboardingTrackerGetParametersProgressStatusesSchemaItems":{"type":"string","enum":["ACTIVE","INACTIVE","ONBOARDING"],"description":"Progress status of the contract","title":"OnboardingTrackerGetParametersProgressStatusesSchemaItems"},"OnboardingTrackerGetParametersActionsSchemaItems":{"type":"string","enum":["ONBOARD","COMPLETE","PAUSE"],"title":"OnboardingTrackerGetParametersActionsSchemaItems"},"OnboardingTrackerGetParametersSortBy":{"type":"string","enum":["progressStatusWeight"],"default":"progressStatusWeight","title":"OnboardingTrackerGetParametersSortBy"},"OnboardingTrackerGetParametersSortOrder":{"type":"string","enum":["ASC","DESC"],"default":"ASC","title":"OnboardingTrackerGetParametersSortOrder"},"OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsContract":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the contract"},"effective_date":{"type":"string","format":"date","description":"The effective date of the contract"}},"description":"The contract associated with the onboarding","title":"OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsContract"},"OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsProgressReferenceDate":{"oneOf":[{"type":"string","format":"date"},{"type":"string","format":"date-time"}],"description":"The reference date determining the onboarding status","title":"OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsProgressReferenceDate"},"OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsProgress":{"type":"object","properties":{"status":{"type":"string","description":"Current status of the onboarding"},"reference_date":{"$ref":"#/components/schemas/OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsProgressReferenceDate","description":"The reference date determining the onboarding status"},"people_list_status":{"type":"string","description":"Status of the people list"},"subject_to_overdue":{"type":"boolean","description":"Whether the onboarding is subject to overdue"},"onboarding_due_date":{"type":["string","null"],"format":"date-time","description":"Due date for onboarding"},"reference_date_type":{"type":"string","description":"Type of the reference date (e.g., EFFECTIVE_DATE)"},"reference_date_timezone":{"type":"string","description":"Timezone of the reference date"},"is_action_required_from_client":{"type":"boolean","description":"Whether action is required from the client"}},"description":"The progress state of the onboarding","title":"OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsProgress"},"OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsHrisProfile":{"type":"object","properties":{"oid":{"type":"string","description":"The unique identifier for the HRIS profile"},"work_email":{"type":["string","null"],"description":"The work email of the employee"}},"description":"The profile associated with the onboarding","title":"OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsHrisProfile"},"OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsAppExperience":{"type":"object","properties":{"is_minimal_requirements":{"type":"boolean","description":"Indicates if the employee meets minimal requirements"}},"description":"The app experience of the employee","title":"OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsAppExperience"},"OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"name":{"type":"string","description":"The name associated with the onboarding"},"contract":{"$ref":"#/components/schemas/OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsContract","description":"The contract associated with the onboarding"},"progress":{"$ref":"#/components/schemas/OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsProgress","description":"The progress state of the onboarding"},"unique_id":{"type":"string","description":"A unique identifier for the tracker"},"hiring_type":{"type":"string","description":"The type of hiring (e.g., contractor)"},"hris_profile":{"$ref":"#/components/schemas/OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsHrisProfile","description":"The profile associated with the onboarding"},"app_experience":{"$ref":"#/components/schemas/OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItemsAppExperience","description":"The app experience of the employee"}},"title":"OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItems"},"OnboardingTrackerGetResponsesContentApplicationJsonSchemaPage":{"type":"object","properties":{"cursor":{"type":["string","null"],"description":"Cursor for pagination"},"total_rows":{"type":"integer","description":"Total number of onboarding"}},"title":"OnboardingTrackerGetResponsesContentApplicationJsonSchemaPage"},"Onboarding_listOnboardingEmployees-v2026-01-01_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/OnboardingTrackerGetResponsesContentApplicationJsonSchemaDataItems"}},"page":{"$ref":"#/components/schemas/OnboardingTrackerGetResponsesContentApplicationJsonSchemaPage"}},"title":"Onboarding_listOnboardingEmployees-v2026-01-01_Response_200"},"OnboardingTrackerGetResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"message":{"type":"string","description":"Error response"}},"required":["message"],"title":"OnboardingTrackerGetResponsesContentApplicationJsonSchemaErrorsItems"},"OnboardingTrackerGetResponsesContentApplicationJsonSchemaRequest":{"type":"object","properties":{"method":{"type":"string","description":"Method of the API"},"status":{"type":"number","format":"double","description":"Status of API response"}},"description":"Error request details","title":"OnboardingTrackerGetResponsesContentApplicationJsonSchemaRequest"},"ListOnboardingEmployees-v2026-01-01RequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/OnboardingTrackerGetResponsesContentApplicationJsonSchemaErrorsItems"},"description":"Error messages"},"request":{"$ref":"#/components/schemas/OnboardingTrackerGetResponsesContentApplicationJsonSchemaRequest","description":"Error request details"}},"required":["errors"],"title":"ListOnboardingEmployees-v2026-01-01RequestBadRequestError"},"ItOrdersGetResponsesContentApplicationJsonSchemaDataItemsUserAddressType":{"type":"string","enum":["PII","PARTIAL","DELIVERY","COLLECTION","ENTITY","SUPPLIER","BILLING"],"description":"Type of the address","title":"ItOrdersGetResponsesContentApplicationJsonSchemaDataItemsUserAddressType"},"ItOrdersGetResponsesContentApplicationJsonSchemaDataItemsUserAddressCountry":{"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","XK","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"],"description":"Country code","title":"ItOrdersGetResponsesContentApplicationJsonSchemaDataItemsUserAddressCountry"},"ItOrdersGetResponsesContentApplicationJsonSchemaDataItemsUserAddress":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the address"},"city":{"type":["string","null"],"description":"City name"},"type":{"$ref":"#/components/schemas/ItOrdersGetResponsesContentApplicationJsonSchemaDataItemsUserAddressType","description":"Type of the address"},"line1":{"type":["string","null"],"description":"Address line 1"},"line2":{"type":["string","null"],"description":"Address line 2"},"state":{"type":["string","null"],"description":"State code or name"},"country":{"$ref":"#/components/schemas/ItOrdersGetResponsesContentApplicationJsonSchemaDataItemsUserAddressCountry","description":"Country code"},"is_valid":{"type":"boolean","description":"Whether the address passes validation"},"post_code":{"type":["string","null"],"description":"Post code"},"phone_number":{"type":["string","null"],"description":"Phone number"},"date_of_birth":{"type":["string","null"],"format":"date","description":"Date of birth (applicable for some address types)"},"tax_id_number":{"type":["string","null"],"description":"Tax ID number (applicable for some address types)"},"passport_number":{"type":["string","null"],"description":"Passport number (applicable for some address types)"},"delivery_instructions":{"type":["string","null"],"description":"Special instructions for deliveries"}},"description":"User address details","title":"ItOrdersGetResponsesContentApplicationJsonSchemaDataItemsUserAddress"},"ItOrdersGetResponsesContentApplicationJsonSchemaDataItemsUser":{"type":"object","properties":{"emails":{"type":"array","items":{"type":"string","format":"email"},"description":"Array of user email addresses"},"address":{"$ref":"#/components/schemas/ItOrdersGetResponsesContentApplicationJsonSchemaDataItemsUserAddress","description":"User address details"},"last_name":{"type":"string","description":"Last name of the user"},"first_name":{"type":"string","description":"First name of the user"},"hris_profile_id":{"type":"string","format":"uuid","description":"The unique identifier of the HRIS profile of the assigned user"}},"description":"Details of the user with asset possession","title":"ItOrdersGetResponsesContentApplicationJsonSchemaDataItemsUser"},"ItOrdersGetResponsesContentApplicationJsonSchemaDataItemsStatus":{"type":"string","enum":["REQUESTED","APPROVED","DECLINED","CANCELLED"],"description":"Order status","title":"ItOrdersGetResponsesContentApplicationJsonSchemaDataItemsStatus"},"ItOrdersGetResponsesContentApplicationJsonSchemaDataItemsOrderItemsItemsStatus":{"type":"string","enum":["PLACED","PROCESSING","AWAITING_PAYMENT","READY_TO_SHIP","SHIPPED","COMPLETED","CANCELLED"],"description":"Status of the order item","title":"ItOrdersGetResponsesContentApplicationJsonSchemaDataItemsOrderItemsItemsStatus"},"ItOrdersGetResponsesContentApplicationJsonSchemaDataItemsOrderItemsItemsProductCategory":{"type":"string","enum":["ADAPTER","CABLE","CHAIR","CHARGER","DESK","DESK_RISER","DESK_TIDY","DESKTOP","DOCKING_STATION","DONGLE","FOOTREST","HEADSET","KEYBOARD","LAPTOP","LAPTOP_STAND","MICE_TRACKPAD","MOBILE_DEVICE","MONITOR","MONITOR_ARM","OTHER","PRINTER","SHREDDER","STANDING_MAT","TABLET","TASK_LIGHT","WEBCAM","WIFI_RANGE_EXTENDER","WELCOME_PACK"],"description":"Product category","title":"ItOrdersGetResponsesContentApplicationJsonSchemaDataItemsOrderItemsItemsProductCategory"},"ItOrdersGetResponsesContentApplicationJsonSchemaDataItemsOrderItemsItemsProduct":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the product"},"name":{"type":"string","description":"Product name"},"brand":{"type":"string","description":"Product brand"},"category":{"$ref":"#/components/schemas/ItOrdersGetResponsesContentApplicationJsonSchemaDataItemsOrderItemsItemsProductCategory","description":"Product category"}},"description":"Product details","title":"ItOrdersGetResponsesContentApplicationJsonSchemaDataItemsOrderItemsItemsProduct"},"ItOrdersGetResponsesContentApplicationJsonSchemaDataItemsOrderItemsItemsPricingDetailsAssetPriceCurrency":{"type":"string","enum":["EUR","AED","AFN","XCD","ALL","AMD","AOA","ARS","USD","AUD","AWG","AZN","BAM","BDT","XOF","BGN","BHD","BIF","BMD","SGD","BOB","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","XAF","CHF","NZD","CLP","CNY","COP","CRC","CUC","CVE","ANG","CZK","DJF","DOP","DZD","EGP","MAD","ERN","ETB","FJD","FKP","DKK","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","WST","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MDL","MGA","MKD","MMK","MNT","MRU","MUR","MVR","MWK","MXN","MYR","MZN","NAD","XPF","NGN","NIO","NOK","NPR","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SHP","SLL","SOS","SRD","SSP","STD","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UYU","UZS","VEF","VND","VUV","YER","ZAR","ZMW","ZWD"],"description":"Three-letter currency code for the price","title":"ItOrdersGetResponsesContentApplicationJsonSchemaDataItemsOrderItemsItemsPricingDetailsAssetPriceCurrency"},"ItOrdersGetResponsesContentApplicationJsonSchemaDataItemsOrderItemsItemsPricingDetailsAssetPrice":{"type":"object","properties":{"amount":{"type":"string","description":"Amount"},"currency":{"$ref":"#/components/schemas/ItOrdersGetResponsesContentApplicationJsonSchemaDataItemsOrderItemsItemsPricingDetailsAssetPriceCurrency","description":"Three-letter currency code for the price"}},"description":"Price of the order item","title":"ItOrdersGetResponsesContentApplicationJsonSchemaDataItemsOrderItemsItemsPricingDetailsAssetPrice"},"ItOrdersGetResponsesContentApplicationJsonSchemaDataItemsOrderItemsItemsPricingDetailsStorefrontFeeCurrency":{"type":"string","enum":["EUR","AED","AFN","XCD","ALL","AMD","AOA","ARS","USD","AUD","AWG","AZN","BAM","BDT","XOF","BGN","BHD","BIF","BMD","SGD","BOB","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","XAF","CHF","NZD","CLP","CNY","COP","CRC","CUC","CVE","ANG","CZK","DJF","DOP","DZD","EGP","MAD","ERN","ETB","FJD","FKP","DKK","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","WST","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MDL","MGA","MKD","MMK","MNT","MRU","MUR","MVR","MWK","MXN","MYR","MZN","NAD","XPF","NGN","NIO","NOK","NPR","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SHP","SLL","SOS","SRD","SSP","STD","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UYU","UZS","VEF","VND","VUV","YER","ZAR","ZMW","ZWD"],"description":"Three-letter currency code for the price","title":"ItOrdersGetResponsesContentApplicationJsonSchemaDataItemsOrderItemsItemsPricingDetailsStorefrontFeeCurrency"},"ItOrdersGetResponsesContentApplicationJsonSchemaDataItemsOrderItemsItemsPricingDetailsStorefrontFee":{"type":"object","properties":{"amount":{"type":"string","description":"Amount"},"currency":{"$ref":"#/components/schemas/ItOrdersGetResponsesContentApplicationJsonSchemaDataItemsOrderItemsItemsPricingDetailsStorefrontFeeCurrency","description":"Three-letter currency code for the price"}},"description":"Storefront fee associated with the order item","title":"ItOrdersGetResponsesContentApplicationJsonSchemaDataItemsOrderItemsItemsPricingDetailsStorefrontFee"},"ItOrdersGetResponsesContentApplicationJsonSchemaDataItemsOrderItemsItemsPricingDetailsAcquisitionType":{"type":"string","enum":["RENTAL","PURCHASE","REUSE"],"description":"Acquisition type of the order item","title":"ItOrdersGetResponsesContentApplicationJsonSchemaDataItemsOrderItemsItemsPricingDetailsAcquisitionType"},"ItOrdersGetResponsesContentApplicationJsonSchemaDataItemsOrderItemsItemsPricingDetails":{"type":"object","properties":{"asset_price":{"oneOf":[{"$ref":"#/components/schemas/ItOrdersGetResponsesContentApplicationJsonSchemaDataItemsOrderItemsItemsPricingDetailsAssetPrice"},{"type":"null"}],"description":"Price of the order item"},"storefront_fee":{"oneOf":[{"$ref":"#/components/schemas/ItOrdersGetResponsesContentApplicationJsonSchemaDataItemsOrderItemsItemsPricingDetailsStorefrontFee"},{"type":"null"}],"description":"Storefront fee associated with the order item"},"acquisition_type":{"$ref":"#/components/schemas/ItOrdersGetResponsesContentApplicationJsonSchemaDataItemsOrderItemsItemsPricingDetailsAcquisitionType","description":"Acquisition type of the order item"}},"description":"Order item pricing details","title":"ItOrdersGetResponsesContentApplicationJsonSchemaDataItemsOrderItemsItemsPricingDetails"},"ItOrdersGetResponsesContentApplicationJsonSchemaDataItemsOrderItemsItems":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/ItOrdersGetResponsesContentApplicationJsonSchemaDataItemsOrderItemsItemsStatus","description":"Status of the order item"},"product":{"$ref":"#/components/schemas/ItOrdersGetResponsesContentApplicationJsonSchemaDataItemsOrderItemsItemsProduct","description":"Product details"},"is_approved":{"type":"boolean","description":"Is the order item approved"},"pricing_details":{"$ref":"#/components/schemas/ItOrdersGetResponsesContentApplicationJsonSchemaDataItemsOrderItemsItemsPricingDetails","description":"Order item pricing details"},"is_express_delivery_requested":{"type":"boolean","description":"Is express delivery requested for the order item"}},"title":"ItOrdersGetResponsesContentApplicationJsonSchemaDataItemsOrderItemsItems"},"ItOrdersGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the order"},"user":{"oneOf":[{"$ref":"#/components/schemas/ItOrdersGetResponsesContentApplicationJsonSchemaDataItemsUser"},{"type":"null"}],"description":"Details of the user with asset possession"},"status":{"$ref":"#/components/schemas/ItOrdersGetResponsesContentApplicationJsonSchemaDataItemsStatus","description":"Order status"},"created_at":{"type":"string","format":"date-time","description":"Creation timestamp of the order"},"updated_at":{"type":"string","format":"date-time","description":"Last update timestamp of the order"},"order_items":{"type":"array","items":{"$ref":"#/components/schemas/ItOrdersGetResponsesContentApplicationJsonSchemaDataItemsOrderItemsItems"},"description":"Order's items details"}},"title":"ItOrdersGetResponsesContentApplicationJsonSchemaDataItems"},"orders_getITOrders_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ItOrdersGetResponsesContentApplicationJsonSchemaDataItems"}},"has_more":{"type":"boolean","description":"Whether there are more results available"},"next_cursor":{"type":["string","null"],"description":"Cursor to the next page"},"total_count":{"type":"integer","description":"Total number of records"}},"title":"orders_getITOrders_Response_200"},"ItOrdersGetResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string","description":"Error code of the handler which produced the returned error"},"field":{"type":"string","description":"The field name where input validation failed"},"message":{"type":"string","description":"Description of the returned error"}},"title":"ItOrdersGetResponsesContentApplicationJsonSchemaErrorsItems"},"ListItOrdersRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ItOrdersGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"ListItOrdersRequestBadRequestError"},"ListItOrdersRequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ItOrdersGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"ListItOrdersRequestInternalServerError"},"ItOrdersOrderIdGetResponsesContentApplicationJsonSchemaDataUserAddressType":{"type":"string","enum":["PII","PARTIAL","DELIVERY","COLLECTION","ENTITY","SUPPLIER","BILLING"],"description":"Type of the address","title":"ItOrdersOrderIdGetResponsesContentApplicationJsonSchemaDataUserAddressType"},"ItOrdersOrderIdGetResponsesContentApplicationJsonSchemaDataUserAddressCountry":{"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","XK","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"],"description":"Country code","title":"ItOrdersOrderIdGetResponsesContentApplicationJsonSchemaDataUserAddressCountry"},"ItOrdersOrderIdGetResponsesContentApplicationJsonSchemaDataUserAddress":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the address"},"city":{"type":["string","null"],"description":"City name"},"type":{"$ref":"#/components/schemas/ItOrdersOrderIdGetResponsesContentApplicationJsonSchemaDataUserAddressType","description":"Type of the address"},"line1":{"type":["string","null"],"description":"Address line 1"},"line2":{"type":["string","null"],"description":"Address line 2"},"state":{"type":["string","null"],"description":"State code or name"},"country":{"$ref":"#/components/schemas/ItOrdersOrderIdGetResponsesContentApplicationJsonSchemaDataUserAddressCountry","description":"Country code"},"is_valid":{"type":"boolean","description":"Whether the address passes validation"},"post_code":{"type":["string","null"],"description":"Post code"},"phone_number":{"type":["string","null"],"description":"Phone number"},"date_of_birth":{"type":["string","null"],"format":"date","description":"Date of birth (applicable for some address types)"},"tax_id_number":{"type":["string","null"],"description":"Tax ID number (applicable for some address types)"},"passport_number":{"type":["string","null"],"description":"Passport number (applicable for some address types)"},"delivery_instructions":{"type":["string","null"],"description":"Special instructions for deliveries"}},"description":"User address details","title":"ItOrdersOrderIdGetResponsesContentApplicationJsonSchemaDataUserAddress"},"ItOrdersOrderIdGetResponsesContentApplicationJsonSchemaDataUser":{"type":"object","properties":{"emails":{"type":"array","items":{"type":"string","format":"email"},"description":"Array of user email addresses"},"address":{"$ref":"#/components/schemas/ItOrdersOrderIdGetResponsesContentApplicationJsonSchemaDataUserAddress","description":"User address details"},"last_name":{"type":"string","description":"Last name of the user"},"first_name":{"type":"string","description":"First name of the user"},"hris_profile_id":{"type":"string","format":"uuid","description":"The unique identifier of the HRIS profile of the assigned user"}},"description":"Details of the order attached user","title":"ItOrdersOrderIdGetResponsesContentApplicationJsonSchemaDataUser"},"ItOrdersOrderIdGetResponsesContentApplicationJsonSchemaDataStatus":{"type":"string","enum":["REQUESTED","APPROVED","DECLINED","CANCELLED"],"description":"Order status","title":"ItOrdersOrderIdGetResponsesContentApplicationJsonSchemaDataStatus"},"ItOrdersOrderIdGetResponsesContentApplicationJsonSchemaDataOrderItemsItemsStatus":{"type":"string","enum":["PLACED","PROCESSING","AWAITING_PAYMENT","READY_TO_SHIP","SHIPPED","COMPLETED","CANCELLED"],"description":"Status of the order item","title":"ItOrdersOrderIdGetResponsesContentApplicationJsonSchemaDataOrderItemsItemsStatus"},"ItOrdersOrderIdGetResponsesContentApplicationJsonSchemaDataOrderItemsItemsProductCategory":{"type":"string","enum":["ADAPTER","CABLE","CHAIR","CHARGER","DESK","DESK_RISER","DESK_TIDY","DESKTOP","DOCKING_STATION","DONGLE","FOOTREST","HEADSET","KEYBOARD","LAPTOP","LAPTOP_STAND","MICE_TRACKPAD","MOBILE_DEVICE","MONITOR","MONITOR_ARM","OTHER","PRINTER","SHREDDER","STANDING_MAT","TABLET","TASK_LIGHT","WEBCAM","WIFI_RANGE_EXTENDER","WELCOME_PACK"],"description":"Product category","title":"ItOrdersOrderIdGetResponsesContentApplicationJsonSchemaDataOrderItemsItemsProductCategory"},"ItOrdersOrderIdGetResponsesContentApplicationJsonSchemaDataOrderItemsItemsProduct":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the product"},"name":{"type":"string","description":"Product name"},"brand":{"type":"string","description":"Product brand"},"category":{"$ref":"#/components/schemas/ItOrdersOrderIdGetResponsesContentApplicationJsonSchemaDataOrderItemsItemsProductCategory","description":"Product category"}},"description":"Product details","title":"ItOrdersOrderIdGetResponsesContentApplicationJsonSchemaDataOrderItemsItemsProduct"},"ItOrdersOrderIdGetResponsesContentApplicationJsonSchemaDataOrderItemsItemsPricingDetailsAssetPriceCurrency":{"type":"string","enum":["EUR","AED","AFN","XCD","ALL","AMD","AOA","ARS","USD","AUD","AWG","AZN","BAM","BDT","XOF","BGN","BHD","BIF","BMD","SGD","BOB","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","XAF","CHF","NZD","CLP","CNY","COP","CRC","CUC","CVE","ANG","CZK","DJF","DOP","DZD","EGP","MAD","ERN","ETB","FJD","FKP","DKK","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","WST","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MDL","MGA","MKD","MMK","MNT","MRU","MUR","MVR","MWK","MXN","MYR","MZN","NAD","XPF","NGN","NIO","NOK","NPR","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SHP","SLL","SOS","SRD","SSP","STD","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UYU","UZS","VEF","VND","VUV","YER","ZAR","ZMW","ZWD"],"description":"Three-letter currency code for the price","title":"ItOrdersOrderIdGetResponsesContentApplicationJsonSchemaDataOrderItemsItemsPricingDetailsAssetPriceCurrency"},"ItOrdersOrderIdGetResponsesContentApplicationJsonSchemaDataOrderItemsItemsPricingDetailsAssetPrice":{"type":"object","properties":{"amount":{"type":"string","description":"Amount"},"currency":{"$ref":"#/components/schemas/ItOrdersOrderIdGetResponsesContentApplicationJsonSchemaDataOrderItemsItemsPricingDetailsAssetPriceCurrency","description":"Three-letter currency code for the price"}},"description":"Price of the order item","title":"ItOrdersOrderIdGetResponsesContentApplicationJsonSchemaDataOrderItemsItemsPricingDetailsAssetPrice"},"ItOrdersOrderIdGetResponsesContentApplicationJsonSchemaDataOrderItemsItemsPricingDetailsStorefrontFeeCurrency":{"type":"string","enum":["EUR","AED","AFN","XCD","ALL","AMD","AOA","ARS","USD","AUD","AWG","AZN","BAM","BDT","XOF","BGN","BHD","BIF","BMD","SGD","BOB","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","XAF","CHF","NZD","CLP","CNY","COP","CRC","CUC","CVE","ANG","CZK","DJF","DOP","DZD","EGP","MAD","ERN","ETB","FJD","FKP","DKK","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","WST","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MDL","MGA","MKD","MMK","MNT","MRU","MUR","MVR","MWK","MXN","MYR","MZN","NAD","XPF","NGN","NIO","NOK","NPR","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SHP","SLL","SOS","SRD","SSP","STD","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UYU","UZS","VEF","VND","VUV","YER","ZAR","ZMW","ZWD"],"description":"Three-letter currency code for the price","title":"ItOrdersOrderIdGetResponsesContentApplicationJsonSchemaDataOrderItemsItemsPricingDetailsStorefrontFeeCurrency"},"ItOrdersOrderIdGetResponsesContentApplicationJsonSchemaDataOrderItemsItemsPricingDetailsStorefrontFee":{"type":"object","properties":{"amount":{"type":"string","description":"Amount"},"currency":{"$ref":"#/components/schemas/ItOrdersOrderIdGetResponsesContentApplicationJsonSchemaDataOrderItemsItemsPricingDetailsStorefrontFeeCurrency","description":"Three-letter currency code for the price"}},"description":"Storefront fee associated with the order item","title":"ItOrdersOrderIdGetResponsesContentApplicationJsonSchemaDataOrderItemsItemsPricingDetailsStorefrontFee"},"ItOrdersOrderIdGetResponsesContentApplicationJsonSchemaDataOrderItemsItemsPricingDetailsAcquisitionType":{"type":"string","enum":["RENTAL","PURCHASE","REUSE"],"description":"Acquisition type of the order item","title":"ItOrdersOrderIdGetResponsesContentApplicationJsonSchemaDataOrderItemsItemsPricingDetailsAcquisitionType"},"ItOrdersOrderIdGetResponsesContentApplicationJsonSchemaDataOrderItemsItemsPricingDetails":{"type":"object","properties":{"asset_price":{"oneOf":[{"$ref":"#/components/schemas/ItOrdersOrderIdGetResponsesContentApplicationJsonSchemaDataOrderItemsItemsPricingDetailsAssetPrice"},{"type":"null"}],"description":"Price of the order item"},"storefront_fee":{"oneOf":[{"$ref":"#/components/schemas/ItOrdersOrderIdGetResponsesContentApplicationJsonSchemaDataOrderItemsItemsPricingDetailsStorefrontFee"},{"type":"null"}],"description":"Storefront fee associated with the order item"},"acquisition_type":{"$ref":"#/components/schemas/ItOrdersOrderIdGetResponsesContentApplicationJsonSchemaDataOrderItemsItemsPricingDetailsAcquisitionType","description":"Acquisition type of the order item"}},"description":"Order item pricing details","title":"ItOrdersOrderIdGetResponsesContentApplicationJsonSchemaDataOrderItemsItemsPricingDetails"},"ItOrdersOrderIdGetResponsesContentApplicationJsonSchemaDataOrderItemsItems":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/ItOrdersOrderIdGetResponsesContentApplicationJsonSchemaDataOrderItemsItemsStatus","description":"Status of the order item"},"product":{"$ref":"#/components/schemas/ItOrdersOrderIdGetResponsesContentApplicationJsonSchemaDataOrderItemsItemsProduct","description":"Product details"},"is_approved":{"type":"boolean","description":"Is the order item approved"},"pricing_details":{"$ref":"#/components/schemas/ItOrdersOrderIdGetResponsesContentApplicationJsonSchemaDataOrderItemsItemsPricingDetails","description":"Order item pricing details"},"is_express_delivery_requested":{"type":"boolean","description":"Is express delivery requested for the order item"}},"title":"ItOrdersOrderIdGetResponsesContentApplicationJsonSchemaDataOrderItemsItems"},"ItOrdersOrderIdGetResponsesContentApplicationJsonSchemaDataDeliveryAddressType":{"type":"string","enum":["PII","PARTIAL","DELIVERY","COLLECTION","ENTITY","SUPPLIER","BILLING"],"description":"Type of the address","title":"ItOrdersOrderIdGetResponsesContentApplicationJsonSchemaDataDeliveryAddressType"},"ItOrdersOrderIdGetResponsesContentApplicationJsonSchemaDataDeliveryAddressCountry":{"type":"string","enum":["AD","AE","AF","AG","AI","AL","AM","AN","AO","AQ","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BV","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","GB","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GS","GT","GU","GW","GY","HK","HM","HN","HR","HT","HU","IC","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","XK","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PN","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TF","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW"],"description":"Country code","title":"ItOrdersOrderIdGetResponsesContentApplicationJsonSchemaDataDeliveryAddressCountry"},"ItOrdersOrderIdGetResponsesContentApplicationJsonSchemaDataDeliveryAddress":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the address"},"city":{"type":["string","null"],"description":"City name"},"type":{"$ref":"#/components/schemas/ItOrdersOrderIdGetResponsesContentApplicationJsonSchemaDataDeliveryAddressType","description":"Type of the address"},"line1":{"type":["string","null"],"description":"Address line 1"},"line2":{"type":["string","null"],"description":"Address line 2"},"state":{"type":["string","null"],"description":"State code or name"},"country":{"$ref":"#/components/schemas/ItOrdersOrderIdGetResponsesContentApplicationJsonSchemaDataDeliveryAddressCountry","description":"Country code"},"is_valid":{"type":"boolean","description":"Whether the address passes validation"},"post_code":{"type":["string","null"],"description":"Post code"},"phone_number":{"type":["string","null"],"description":"Phone number"},"date_of_birth":{"type":["string","null"],"format":"date","description":"Date of birth (applicable for some address types)"},"tax_id_number":{"type":["string","null"],"description":"Tax ID number (applicable for some address types)"},"passport_number":{"type":["string","null"],"description":"Passport number (applicable for some address types)"},"delivery_instructions":{"type":["string","null"],"description":"Special instructions for deliveries"}},"description":"Order delivery address details","title":"ItOrdersOrderIdGetResponsesContentApplicationJsonSchemaDataDeliveryAddress"},"ItOrdersOrderIdGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the order"},"user":{"oneOf":[{"$ref":"#/components/schemas/ItOrdersOrderIdGetResponsesContentApplicationJsonSchemaDataUser"},{"type":"null"}],"description":"Details of the order attached user"},"status":{"$ref":"#/components/schemas/ItOrdersOrderIdGetResponsesContentApplicationJsonSchemaDataStatus","description":"Order status"},"created_at":{"type":"string","format":"date-time","description":"Creation timestamp of the order"},"updated_at":{"type":"string","format":"date-time","description":"Last update timestamp of the order"},"order_items":{"type":"array","items":{"$ref":"#/components/schemas/ItOrdersOrderIdGetResponsesContentApplicationJsonSchemaDataOrderItemsItems"},"description":"Order's items details"},"delivery_address":{"$ref":"#/components/schemas/ItOrdersOrderIdGetResponsesContentApplicationJsonSchemaDataDeliveryAddress","description":"Order delivery address details"}},"title":"ItOrdersOrderIdGetResponsesContentApplicationJsonSchemaData"},"orders_getITOrderById_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ItOrdersOrderIdGetResponsesContentApplicationJsonSchemaData"}},"title":"orders_getITOrderById_Response_200"},"ItOrdersOrderIdGetResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string","description":"Error code of the handler which produced the returned error"},"field":{"type":"string","description":"The field name where input validation failed"},"message":{"type":"string","description":"Description of the returned error"}},"title":"ItOrdersOrderIdGetResponsesContentApplicationJsonSchemaErrorsItems"},"RetrieveAnItOrderRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ItOrdersOrderIdGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"RetrieveAnItOrderRequestBadRequestError"},"RetrieveAnItOrderRequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ItOrdersOrderIdGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"RetrieveAnItOrderRequestInternalServerError"},"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_deleteAnOrgStructureFromTheOrganization-v2026-01-01_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"Organization structure_deleteAnOrgStructureFromTheOrganization-v2026-01-01_Response_200"},"HrisOrganizationStructuresHrisOrgStructureIdDeleteResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code"},"message":{"type":"string","description":"Human-readable explanation of the error"}},"title":"HrisOrganizationStructuresHrisOrgStructureIdDeleteResponsesContentApplicationJsonSchemaErrorsItems"},"DeleteAnOrgStructureFromTheOrganization-v2026-01-01RequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/HrisOrganizationStructuresHrisOrgStructureIdDeleteResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"DeleteAnOrgStructureFromTheOrganization-v2026-01-01RequestBadRequestError"},"DeleteAnOrgStructureFromTheOrganization-v2026-01-01RequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/HrisOrganizationStructuresHrisOrgStructureIdDeleteResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"DeleteAnOrgStructureFromTheOrganization-v2026-01-01RequestInternalServerError"},"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"},"HrisOrganizationStructuresHrisOrgStructureIdGetResponsesContentApplicationJsonSchemaDataRolesItems":{"type":"object","properties":{"id":{"type":"integer","description":"Role ID"},"name":{"type":"string","description":"Role Name"}},"title":"HrisOrganizationStructuresHrisOrgStructureIdGetResponsesContentApplicationJsonSchemaDataRolesItems"},"HrisOrganizationStructuresHrisOrgStructureIdGetResponsesContentApplicationJsonSchemaDataTeamsItems":{"type":"object","properties":{},"title":"HrisOrganizationStructuresHrisOrgStructureIdGetResponsesContentApplicationJsonSchemaDataTeamsItems"},"HrisOrganizationStructuresHrisOrgStructureIdGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"HRIS Organization Structure ID"},"name":{"type":"string","description":"HRIS Organization Structure Name"},"type":{"type":"string","description":"HRIS Organization Structure Type"},"roles":{"type":"array","items":{"$ref":"#/components/schemas/HrisOrganizationStructuresHrisOrgStructureIdGetResponsesContentApplicationJsonSchemaDataRolesItems"}},"teams":{"type":"array","items":{"$ref":"#/components/schemas/HrisOrganizationStructuresHrisOrgStructureIdGetResponsesContentApplicationJsonSchemaDataTeamsItems"}},"external_id":{"type":"string","description":"HRIS Organization Structure External ID"},"teams_count":{"type":"integer","description":"HRIS Organization Structure Teams Count"},"enable_roles":{"type":"boolean","description":"HRIS Organization Structure Enable Roles"},"is_multiselect":{"type":"boolean","description":"HRIS Organization Structure Is Multiselect"}},"title":"HrisOrganizationStructuresHrisOrgStructureIdGetResponsesContentApplicationJsonSchemaData"},"Organization structure_fetchAnOrgStructureFromTheOrganization-v2026-01-01_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/HrisOrganizationStructuresHrisOrgStructureIdGetResponsesContentApplicationJsonSchemaData"}},"title":"Organization structure_fetchAnOrgStructureFromTheOrganization-v2026-01-01_Response_200"},"HrisOrganizationStructuresHrisOrgStructureIdGetResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string"},"field":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"title":"HrisOrganizationStructuresHrisOrgStructureIdGetResponsesContentApplicationJsonSchemaErrorsItems"},"FetchAnOrgStructureFromTheOrganization-v2026-01-01RequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/HrisOrganizationStructuresHrisOrgStructureIdGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"FetchAnOrgStructureFromTheOrganization-v2026-01-01RequestBadRequestError"},"FetchAnOrgStructureFromTheOrganization-v2026-01-01RequestNotFoundError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/HrisOrganizationStructuresHrisOrgStructureIdGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"FetchAnOrgStructureFromTheOrganization-v2026-01-01RequestNotFoundError"},"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"},"HrisOrganizationStructuresHrisOrgStructureIdPatchRequestBodyContentApplicationJsonSchemaDataTeamsItems":{"type":"object","properties":{},"title":"HrisOrganizationStructuresHrisOrgStructureIdPatchRequestBodyContentApplicationJsonSchemaDataTeamsItems"},"HrisOrganizationStructuresHrisOrgStructureIdPatchRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"name":{"type":"string","description":"Name of the Org Structure"},"teams":{"type":"array","items":{"$ref":"#/components/schemas/HrisOrganizationStructuresHrisOrgStructureIdPatchRequestBodyContentApplicationJsonSchemaDataTeamsItems"}},"external_id":{"type":"string","description":"External ID of the Org Structure"},"enable_roles":{"type":"boolean","description":"Enable roles for the Org Structure"},"is_multiselect":{"type":"boolean","description":"Enable multiselect for the Org Structure"}},"required":["teams"],"title":"HrisOrganizationStructuresHrisOrgStructureIdPatchRequestBodyContentApplicationJsonSchemaData"},"Organization structure_updateAnExistingHrisOrgStructure-v2026-01-01_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"Organization structure_updateAnExistingHrisOrgStructure-v2026-01-01_Response_200"},"HrisOrganizationStructuresHrisOrgStructureIdPatchResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code"},"message":{"type":"string","description":"Human-readable explanation of the error"}},"title":"HrisOrganizationStructuresHrisOrgStructureIdPatchResponsesContentApplicationJsonSchemaErrorsItems"},"UpdateAnExistingHrisOrgStructure-v2026-01-01RequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/HrisOrganizationStructuresHrisOrgStructureIdPatchResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"UpdateAnExistingHrisOrgStructure-v2026-01-01RequestBadRequestError"},"UpdateAnExistingHrisOrgStructure-v2026-01-01RequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/HrisOrganizationStructuresHrisOrgStructureIdPatchResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"UpdateAnExistingHrisOrgStructure-v2026-01-01RequestInternalServerError"},"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"},"OrganizationsTasksGetParametersStatusesSchemaItems":{"type":"string","enum":["PENDING","COMPLETED","DISMISSED","FAILED"],"title":"OrganizationsTasksGetParametersStatusesSchemaItems"},"OrganizationsTasksGetParametersCategory":{"type":"string","enum":["PAYROLL","PAYMENTS","SETUP","EXPENSE_REQUESTS","TIME_OFF_REQUESTS","TIME_SHEET_SUBMISSIONS","PEOPLE_MANAGEMENT","DOCUMENT_ACTIONS","LEGAL_ENTITY_DOCUMENTS","HIRING","OTHER_TASKS","DEEL_IT","COMPLIANCE","PAYMENT_METHODS","ACCOUNTING"],"title":"OrganizationsTasksGetParametersCategory"},"OrganizationsTasksGetResponsesContentApplicationJsonSchemaDataItemsStatus":{"type":"string","enum":["PENDING","COMPLETED","DISMISSED","FAILED"],"description":"Current status of the task.","title":"OrganizationsTasksGetResponsesContentApplicationJsonSchemaDataItemsStatus"},"OrganizationsTasksGetResponsesContentApplicationJsonSchemaDataItemsAssigneesItems":{"type":"object","properties":{"id":{"type":"string","description":"Public identifier of the assignee (HRIS profile OID or profile public_id)."},"email":{"type":["string","null"],"description":"Assignee's email address."},"last_name":{"type":["string","null"],"description":"Assignee's last name."},"first_name":{"type":["string","null"],"description":"Assignee's first name."}},"required":["id"],"title":"OrganizationsTasksGetResponsesContentApplicationJsonSchemaDataItemsAssigneesItems"},"OrganizationsTasksGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the task."},"status":{"$ref":"#/components/schemas/OrganizationsTasksGetResponsesContentApplicationJsonSchemaDataItemsStatus","description":"Current status of the task."},"category":{"type":"string","description":"Category of the task."},"due_date":{"type":["string","null"],"format":"date-time","description":"When the task is due."},"assignees":{"type":"array","items":{"$ref":"#/components/schemas/OrganizationsTasksGetResponsesContentApplicationJsonSchemaDataItemsAssigneesItems"},"description":"List of users assigned to this task. Each assignee is either an HRIS profile (worker in organization context) or a profile without organization context."},"created_at":{"type":"string","format":"date-time","description":"When the task was created."},"expired_at":{"type":["string","null"],"format":"date-time","description":"When the task expires, if set."},"description":{"type":["string","null"],"description":"Detailed description of the task."},"external_id":{"type":["string","null"],"description":"External reference ID, if the task was created with one."},"resolved_at":{"type":["string","null"],"format":"date-time","description":"When the task was resolved (completed or dismissed)."},"display_name":{"type":"string","description":"Human-readable title of the task."}},"title":"OrganizationsTasksGetResponsesContentApplicationJsonSchemaDataItems"},"Organization Tasks_listOrganizationTasks-v2026-03-03_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/OrganizationsTasksGetResponsesContentApplicationJsonSchemaDataItems"},"description":"List of task objects for the organization."},"has_more":{"type":"boolean","description":"Flag to highlight if there are more items to be fetched."},"next_cursor":{"type":["string","null"],"description":"Cursor to request the next page; null if there are no more pages."},"total_count":{"type":"integer","description":"Total number of tasks matching the filter."}},"required":["data","has_more","next_cursor","total_count"],"title":"Organization Tasks_listOrganizationTasks-v2026-03-03_Response_200"},"OrganizationsTasksGetResponsesContentApplicationJsonSchemaErrorsItemsDetails":{"type":"object","properties":{},"description":"Additional error details.","title":"OrganizationsTasksGetResponsesContentApplicationJsonSchemaErrorsItemsDetails"},"OrganizationsTasksGetResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code."},"field":{"type":["string","null"],"description":"Request field that caused the error, if applicable."},"details":{"oneOf":[{"$ref":"#/components/schemas/OrganizationsTasksGetResponsesContentApplicationJsonSchemaErrorsItemsDetails"},{"type":"null"}],"description":"Additional error details."},"message":{"type":"string","description":"Human-readable error message."}},"required":["code","message"],"title":"OrganizationsTasksGetResponsesContentApplicationJsonSchemaErrorsItems"},"ListOrganizationTasks-v2026-03-03RequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/OrganizationsTasksGetResponsesContentApplicationJsonSchemaErrorsItems"},"description":"List of error entries."}},"required":["errors"],"title":"ListOrganizationTasks-v2026-03-03RequestBadRequestError"},"ListOrganizationTasks-v2026-03-03RequestUnauthorizedError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/OrganizationsTasksGetResponsesContentApplicationJsonSchemaErrorsItems"},"description":"List of error entries."}},"required":["errors"],"title":"ListOrganizationTasks-v2026-03-03RequestUnauthorizedError"},"ListOrganizationTasks-v2026-03-03RequestForbiddenError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/OrganizationsTasksGetResponsesContentApplicationJsonSchemaErrorsItems"},"description":"List of error entries."}},"required":["errors"],"title":"ListOrganizationTasks-v2026-03-03RequestForbiddenError"},"ListOrganizationTasks-v2026-03-03RequestUnprocessableEntityError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/OrganizationsTasksGetResponsesContentApplicationJsonSchemaErrorsItems"},"description":"List of validation errors."}},"required":["errors"],"title":"ListOrganizationTasks-v2026-03-03RequestUnprocessableEntityError"},"ListOrganizationTasks-v2026-03-03RequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/OrganizationsTasksGetResponsesContentApplicationJsonSchemaErrorsItems"},"description":"List of error entries."}},"required":["errors"],"title":"ListOrganizationTasks-v2026-03-03RequestInternalServerError"},"OrganizationsChildrenPostRequestBodyContentApplicationJsonSchemaDataChildOrganization":{"type":"object","properties":{"name":{"type":"string","description":"The organization's name."},"department":{"type":"string","description":"The department's name where the manager will be added"},"is_api_enabled":{"type":"boolean","description":"The flag that enables the public API for the child organization."},"workforce_size":{"type":"integer","description":"The workforce size of the child organization."},"headquarters_country":{"type":"string","description":"The 2-letter country code of the organization's headquarters."}},"required":["name"],"description":"The object that contains all the information related to the child organization that will be created.","title":"OrganizationsChildrenPostRequestBodyContentApplicationJsonSchemaDataChildOrganization"},"OrganizationsChildrenPostRequestBodyContentApplicationJsonSchemaDataParentOrganization":{"type":"object","properties":{"admin_email":{"type":"string","description":"The email of one of the managers of the parent organization that will be used to create an user for the child organization, it should exists on the parent organization."}},"description":"The object that contains the information related to the parent_organization.","title":"OrganizationsChildrenPostRequestBodyContentApplicationJsonSchemaDataParentOrganization"},"OrganizationsChildrenPostRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"child_organization":{"$ref":"#/components/schemas/OrganizationsChildrenPostRequestBodyContentApplicationJsonSchemaDataChildOrganization","description":"The object that contains all the information related to the child organization that will be created."},"parent_organization":{"$ref":"#/components/schemas/OrganizationsChildrenPostRequestBodyContentApplicationJsonSchemaDataParentOrganization","description":"The object that contains the information related to the parent_organization."}},"required":["child_organization","parent_organization"],"description":"The request payload.","title":"OrganizationsChildrenPostRequestBodyContentApplicationJsonSchemaData"},"OrganizationsChildrenPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the created child organization."},"token":{"type":"string","description":"The API token generated for the created child organization"},"created_at":{"type":"string","format":"date-time","description":"When the created child organization was created (ISO 8601 format)"},"updated_at":{"type":"string","format":"date-time","description":"When the created child organization was updated for the last time (ISO 8601 format)"}},"required":["id","token","created_at","updated_at"],"title":"OrganizationsChildrenPostResponsesContentApplicationJsonSchemaData"},"organizations_createOrganizationChild_Response_201":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/OrganizationsChildrenPostResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"organizations_createOrganizationChild_Response_201"},"OrganizationsChildrenPostResponsesContentApplicationJsonSchemaErrorsItems":{"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":"OrganizationsChildrenPostResponsesContentApplicationJsonSchemaErrorsItems"},"OrganizationsChildrenPostResponsesContentApplicationJsonSchemaRequest":{"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":"OrganizationsChildrenPostResponsesContentApplicationJsonSchemaRequest"},"CreateChildOrganizationRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/OrganizationsChildrenPostResponsesContentApplicationJsonSchemaErrorsItems"}},"request":{"$ref":"#/components/schemas/OrganizationsChildrenPostResponsesContentApplicationJsonSchemaRequest"}},"title":"CreateChildOrganizationRequestBadRequestError"},"RolesPostRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"name":{"type":"string","description":"Organization role name"},"scope":{"type":"string","description":"Organization role scope"},"description":{"type":"string","description":"Organization role description"},"permissionSets":{"type":"array","items":{"type":"string"}},"hrisOrgStructureId":{"type":"string","description":"HRIS organization structure id"}},"required":["name","scope","description","permissionSets"],"title":"RolesPostRequestBodyContentApplicationJsonSchemaData"},"Organizations_CreateOrganizationRole_Response_200":{"type":"object","properties":{"id":{"type":"number","format":"double","description":"Organization role id"},"name":{"type":"string","description":"Organization role name"},"scope":{"type":"string","description":"Organization role scope"},"description":{"type":"string","description":"Organization role description"},"permissionSets":{"type":"array","items":{"type":"string"}},"hrisOrgStructureId":{"type":"string","description":"HRIS organization structure id"}},"title":"Organizations_CreateOrganizationRole_Response_200"},"OrganizationsGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the organization."},"name":{"type":"string","description":"The name of the organization."}},"required":["id","name"],"title":"OrganizationsGetResponsesContentApplicationJsonSchemaDataItems"},"organizations_getOrganizations_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/OrganizationsGetResponsesContentApplicationJsonSchemaDataItems"}}},"title":"organizations_getOrganizations_Response_200"},"GetOrganizationsRequestUnauthorizedError":{"type":"object","properties":{"error":{"type":"string","description":"An error message indicating that the authentication failed."}},"title":"GetOrganizationsRequestUnauthorizedError"},"GetOrganizationsRequestNotFoundError":{"type":"object","properties":{"error":{"type":"string","description":"An error message indicating that no organization was found for the authenticated user."}},"title":"GetOrganizationsRequestNotFoundError"},"GetOrganizationsRequestInternalServerError":{"type":"object","properties":{"error":{"type":"string","description":"A general error message indicating that the server encountered an unexpected issue."}},"title":"GetOrganizationsRequestInternalServerError"},"TeamsGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the team within the organization."},"name":{"type":"string","description":"The name of the team."}},"required":["id","name"],"title":"TeamsGetResponsesContentApplicationJsonSchemaDataItems"},"Organizations_getTeams_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/TeamsGetResponsesContentApplicationJsonSchemaDataItems"}}},"required":["data"],"title":"Organizations_getTeams_Response_200"},"GetTeamsRequestUnauthorizedError":{"type":"object","properties":{"error":{"type":"string","description":"An error message indicating that the authentication failed."}},"title":"GetTeamsRequestUnauthorizedError"},"GetTeamsRequestNotFoundError":{"type":"object","properties":{"error":{"type":"string","description":"An error message indicating that no teams were found."}},"title":"GetTeamsRequestNotFoundError"},"GetTeamsRequestInternalServerError":{"type":"object","properties":{"error":{"type":"string","description":"A general error message indicating that the server encountered an unexpected issue."}},"title":"GetTeamsRequestInternalServerError"},"RolesGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"id":{"type":"number","format":"double","description":"The unique identifier for the role."},"name":{"type":"string","description":"The name of the role."},"scope":{"type":"string","description":"The scope of the role, which can define the level of access. For example, 'ORGANIZATION' represents a global role within the organization."},"hrisOrgStructureId":{"type":["string","null"],"description":"The HRIS (Human Resource Information System) organization structure ID associated with the role, if applicable."}},"required":["id","name","scope"],"title":"RolesGetResponsesContentApplicationJsonSchemaDataItems"},"Organizations_getTheRolesOfTheCurrentOrganization-v2026-01-01_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/RolesGetResponsesContentApplicationJsonSchemaDataItems"}}},"required":["data"],"title":"Organizations_getTheRolesOfTheCurrentOrganization-v2026-01-01_Response_200"},"GetTheRolesOfTheCurrentOrganization-v2026-01-01RequestBadRequestError":{"type":"object","properties":{"error":{"type":"string"}},"title":"GetTheRolesOfTheCurrentOrganization-v2026-01-01RequestBadRequestError"},"GetTheRolesOfTheCurrentOrganization-v2026-01-01RequestUnauthorizedError":{"type":"object","properties":{"error":{"type":"string"}},"title":"GetTheRolesOfTheCurrentOrganization-v2026-01-01RequestUnauthorizedError"},"GetTheRolesOfTheCurrentOrganization-v2026-01-01RequestInternalServerError":{"type":"object","properties":{"error":{"type":"string"}},"title":"GetTheRolesOfTheCurrentOrganization-v2026-01-01RequestInternalServerError"},"DepartmentsGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier for the department."},"name":{"type":"string","description":"The name of the department."},"parent":{"type":["string","null"],"description":"The ID of the parent department, if applicable."}},"required":["id","name"],"title":"DepartmentsGetResponsesContentApplicationJsonSchemaDataItems"},"Organizations_GetDepartments_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/DepartmentsGetResponsesContentApplicationJsonSchemaDataItems"}}},"title":"Organizations_GetDepartments_Response_200"},"GetDepartmentsRequestUnauthorizedError":{"type":"object","properties":{"error":{"type":"string","description":"An error message indicating that the authentication failed."}},"title":"GetDepartmentsRequestUnauthorizedError"},"GetDepartmentsRequestNotFoundError":{"type":"object","properties":{"error":{"type":"string","description":"An error message indicating that no departments were found."}},"title":"GetDepartmentsRequestNotFoundError"},"GetDepartmentsRequestInternalServerError":{"type":"object","properties":{"error":{"type":"string","description":"A general error message indicating that the server encountered an unexpected issue."}},"title":"GetDepartmentsRequestInternalServerError"},"WorkingLocationsGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"id":{"type":"number","format":"double","description":"Unique identifier of this resource."},"name":{"type":"string"}},"required":["id","name"],"title":"WorkingLocationsGetResponsesContentApplicationJsonSchemaDataItems"},"Organizations_retrieveWorkingLocations_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/WorkingLocationsGetResponsesContentApplicationJsonSchemaDataItems"}}},"required":["data"],"title":"Organizations_retrieveWorkingLocations_Response_200"},"RolesRoleIdPatchRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"name":{"type":"string","description":"Name of the role"},"description":{"type":"string","description":"Description of the role"},"permissionSets":{"type":"array","items":{"type":"string"}}},"title":"RolesRoleIdPatchRequestBodyContentApplicationJsonSchemaData"},"Organizations_UpdateOrganizationRole_Response_200":{"type":"object","properties":{"id":{"type":"number","format":"double","description":"ID of the role"},"name":{"type":"string","description":"Name of the role"},"scope":{"type":"string","description":"Scope of the role"},"description":{"type":"string","description":"Description of the role"},"permissionSets":{"type":"array","items":{"type":"string"}}},"title":"Organizations_UpdateOrganizationRole_Response_200"},"PayoutsEmployeesMethodsPostRequestBodyContentApplicationJsonSchemaDataPayload":{"type":"object","properties":{"city":{"type":"string","description":"Name of the city"},"iban":{"type":"string","description":"International Bank Account Number"},"postal":{"type":"string","description":"Postal code"},"bank_name":{"type":"string","description":"Name of the bank"},"full_name":{"type":"string","description":"Full name of the account holder"},"swift_bic":{"type":"string","description":"SWIFT/BIC code"},"country_code":{"type":"string","description":"Country code"},"address_line1":{"type":"string","description":"Address line 1"},"original_name":{"type":"string","description":"Original name of the account holder"},"province_state":{"type":"string","description":"Province or state"},"bank_country_code":{"type":"string","description":"Country code of the bank"}},"description":"Payload containing bank details","title":"PayoutsEmployeesMethodsPostRequestBodyContentApplicationJsonSchemaDataPayload"},"PayoutsEmployeesMethodsPostRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the bank details"},"payload":{"$ref":"#/components/schemas/PayoutsEmployeesMethodsPostRequestBodyContentApplicationJsonSchemaDataPayload","description":"Payload containing bank details"}},"description":"Request data","title":"PayoutsEmployeesMethodsPostRequestBodyContentApplicationJsonSchemaData"},"PayoutsEmployeesMethodsPostResponsesContentApplicationJsonSchemaDataData":{"type":"object","properties":{"city":{"type":"string","description":"Name of the city"},"iban":{"type":"string","description":"International Bank Account Number"},"postal":{"type":"string","description":"Postal code"},"bank_name":{"type":"string","description":"Name of the bank"},"full_name":{"type":"string","description":"Full name of the account holder"},"swift_bic":{"type":"string","description":"SWIFT/BIC code"},"country_code":{"type":"string","description":"Country code"},"address_line1":{"type":"string","description":"Address line 1"},"original_name":{"type":"string","description":"Original name of the account holder"},"province_state":{"type":"string","description":"Province or state"},"bank_country_code":{"type":"string","description":"Country code of the bank"}},"title":"PayoutsEmployeesMethodsPostResponsesContentApplicationJsonSchemaDataData"},"PayoutsEmployeesMethodsPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the bank details"},"data":{"$ref":"#/components/schemas/PayoutsEmployeesMethodsPostResponsesContentApplicationJsonSchemaDataData"},"status":{"type":"string","description":"Status of the bank details"},"version":{"type":"string","description":"Version identifier"},"created_at":{"type":"string","description":"Creation timestamp"},"updated_at":{"type":"string","description":"Last update timestamp"},"is_active_version":{"type":"boolean","description":"Indicates if this is the active version"},"funds_distribution":{"type":"number","format":"double","description":"Funds distribution percentage"}},"title":"PayoutsEmployeesMethodsPostResponsesContentApplicationJsonSchemaData"},"Payouts_addEditBankDetails_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PayoutsEmployeesMethodsPostResponsesContentApplicationJsonSchemaData"}},"title":"Payouts_addEditBankDetails_Response_200"},"PayoutsAutoWithdrawalSettingPatchRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"method_id":{"type":"string","format":"uuid","description":"The ID of the withdrawal method to be used for auto withdrawal"},"is_auto_withdraw_enabled":{"type":"boolean","description":"Whether auto withdrawal should be enabled"}},"title":"PayoutsAutoWithdrawalSettingPatchRequestBodyContentApplicationJsonSchemaData"},"PayoutsAutoWithdrawalSettingPatchResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"method_id":{"type":"string","format":"uuid","description":"The ID of the withdrawal method to be used for auto withdrawal"},"is_auto_withdraw_enabled":{"type":"boolean","description":"Whether auto withdrawal is enabled"}},"title":"PayoutsAutoWithdrawalSettingPatchResponsesContentApplicationJsonSchemaData"},"Payouts_changeTheAutoWithdrawalSetting-v2026-01-01_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PayoutsAutoWithdrawalSettingPatchResponsesContentApplicationJsonSchemaData"}},"title":"Payouts_changeTheAutoWithdrawalSetting-v2026-01-01_Response_200"},"PayoutsContractorsMethodsPostRequestBodyContentApplicationJsonSchemaDataAddress":{"type":"object","properties":{"city":{"type":"string","description":"City name"},"state":{"type":"string","description":"State code"},"country":{"type":"string","description":"Country code"},"post_code":{"type":"string","description":"Post code"},"first_line":{"type":"string","description":"First line of the address"}},"required":["city","country","post_code","first_line"],"title":"PayoutsContractorsMethodsPostRequestBodyContentApplicationJsonSchemaDataAddress"},"PayoutsContractorsMethodsPostRequestBodyContentApplicationJsonSchemaDataPaymentMethod":{"type":"string","enum":["bank_transfer"],"description":"Specifies the type of payment method","title":"PayoutsContractorsMethodsPostRequestBodyContentApplicationJsonSchemaDataPaymentMethod"},"PayoutsContractorsMethodsPostRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"address":{"$ref":"#/components/schemas/PayoutsContractorsMethodsPostRequestBodyContentApplicationJsonSchemaDataAddress"},"payload":{"type":"object","additionalProperties":{"description":"Any type"},"description":"Dynamic properties based on selected option. For example, if `selectedOption` is `swift_code`, payload may include `swiftCode`, `accountHolderName`, and `accountNumber`."},"is_default":{"type":"boolean","description":"Specifies if the method is the default payout method - if true, autowithdrawal will be enabled for the contractor using this method"},"method_name":{"type":"string","description":"Name for method"},"payment_method":{"$ref":"#/components/schemas/PayoutsContractorsMethodsPostRequestBodyContentApplicationJsonSchemaDataPaymentMethod","description":"Specifies the type of payment method"},"selectedOption":{"type":"string","description":"Specifies the type of bank transfer method. Maps from requirements type field"}},"required":["address","payload","payment_method"],"title":"PayoutsContractorsMethodsPostRequestBodyContentApplicationJsonSchemaData"},"PayoutsContractorsMethodsPostResponsesContentApplicationJsonSchemaDataStatus":{"type":"string","enum":["pending","verifying","failed","approved"],"description":"Status of the bank transfer method","title":"PayoutsContractorsMethodsPostResponsesContentApplicationJsonSchemaDataStatus"},"PayoutsContractorsMethodsPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the bank transfer method"},"status":{"$ref":"#/components/schemas/PayoutsContractorsMethodsPostResponsesContentApplicationJsonSchemaDataStatus","description":"Status of the bank transfer method"}},"title":"PayoutsContractorsMethodsPostResponsesContentApplicationJsonSchemaData"},"Payouts_createBankTransferMethod_Response_201":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PayoutsContractorsMethodsPostResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"Payouts_createBankTransferMethod_Response_201"},"Payouts_deleteBankDetails_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"Payouts_deleteBankDetails_Response_200"},"PayoutsEmployeesMethodsBankTransfersRequirementsPostRequestBodyContentApplicationJsonSchemaDataCurrentState":{"type":"object","properties":{"payment_type":{"type":"string","description":"Type of payment"},"currency_code":{"type":"string","description":"Currency code"},"bank_country_code":{"type":"string","description":"Country code of the bank"}},"description":"Current state of the bank details","title":"PayoutsEmployeesMethodsBankTransfersRequirementsPostRequestBodyContentApplicationJsonSchemaDataCurrentState"},"PayoutsEmployeesMethodsBankTransfersRequirementsPostRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"current_state":{"$ref":"#/components/schemas/PayoutsEmployeesMethodsBankTransfersRequirementsPostRequestBodyContentApplicationJsonSchemaDataCurrentState","description":"Current state of the bank details"}},"description":"Request data","title":"PayoutsEmployeesMethodsBankTransfersRequirementsPostRequestBodyContentApplicationJsonSchemaData"},"PayoutsEmployeesMethodsBankTransfersRequirementsPostResponsesContentApplicationJsonSchemaDataStepsItemsCategoriesItemsAlert":{"type":"object","properties":{"type":{"type":"string","description":"Alert type"},"title":{"type":"string","description":"Alert title"},"message":{"type":"string","description":"Alert message"}},"description":"Alert information","title":"PayoutsEmployeesMethodsBankTransfersRequirementsPostResponsesContentApplicationJsonSchemaDataStepsItemsCategoriesItemsAlert"},"PayoutsEmployeesMethodsBankTransfersRequirementsPostResponsesContentApplicationJsonSchemaDataStepsItemsCategoriesItemsFieldsItems":{"type":"object","properties":{"id":{"type":"number","format":"double","description":"Field ID"},"key":{"type":"string","description":"Field key"},"name":{"type":"string","description":"Field name"},"type":{"type":"string","description":"Field type"},"example":{"oneOf":[{"description":"Any type"},{"type":"null"}],"description":"Example value"},"tooltip":{"oneOf":[{"description":"Any type"},{"type":"null"}],"description":"Tooltip information"},"category":{"type":"string","description":"Field category"},"disabled":{"type":"boolean","description":"Indicates if the field is disabled"},"required":{"type":"boolean","description":"Indicates if the field is required"},"sensitive":{"type":"boolean","description":"Indicates if the field is sensitive"},"max_length":{"type":"string","description":"Maximum length of the field"},"min_length":{"type":"string","description":"Minimum length of the field"},"values_allowed":{"oneOf":[{"description":"Any type"},{"type":"null"}],"description":"Allowed values for the field"},"validation_regexp":{"oneOf":[{"description":"Any type"},{"type":"null"}],"description":"Validation regex pattern"},"validation_regex_flags":{"oneOf":[{"description":"Any type"},{"type":"null"}],"description":"Validation regex flags"}},"title":"PayoutsEmployeesMethodsBankTransfersRequirementsPostResponsesContentApplicationJsonSchemaDataStepsItemsCategoriesItemsFieldsItems"},"PayoutsEmployeesMethodsBankTransfersRequirementsPostResponsesContentApplicationJsonSchemaDataStepsItemsCategoriesItems":{"type":"object","properties":{"name":{"type":"string","description":"Category name"},"alert":{"$ref":"#/components/schemas/PayoutsEmployeesMethodsBankTransfersRequirementsPostResponsesContentApplicationJsonSchemaDataStepsItemsCategoriesItemsAlert","description":"Alert information"},"banner":{"oneOf":[{"description":"Any type"},{"type":"null"}],"description":"Banner information"},"fields":{"type":"array","items":{"$ref":"#/components/schemas/PayoutsEmployeesMethodsBankTransfersRequirementsPostResponsesContentApplicationJsonSchemaDataStepsItemsCategoriesItemsFieldsItems"},"description":"Fields in the category"},"header":{"type":"string","description":"Category header"},"priority":{"type":"number","format":"double","description":"Category priority"}},"title":"PayoutsEmployeesMethodsBankTransfersRequirementsPostResponsesContentApplicationJsonSchemaDataStepsItemsCategoriesItems"},"PayoutsEmployeesMethodsBankTransfersRequirementsPostResponsesContentApplicationJsonSchemaDataStepsItems":{"type":"object","properties":{"name":{"type":"string","description":"Step name"},"banner":{"oneOf":[{"description":"Any type"},{"type":"null"}],"description":"Banner information"},"header":{"type":"string","description":"Step header"},"categories":{"type":"array","items":{"$ref":"#/components/schemas/PayoutsEmployeesMethodsBankTransfersRequirementsPostResponsesContentApplicationJsonSchemaDataStepsItemsCategoriesItems"},"description":"Categories of the steps"},"right_side_placeholder":{"type":"string","description":"Right side placeholder"}},"title":"PayoutsEmployeesMethodsBankTransfersRequirementsPostResponsesContentApplicationJsonSchemaDataStepsItems"},"PayoutsEmployeesMethodsBankTransfersRequirementsPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"steps":{"type":"array","items":{"$ref":"#/components/schemas/PayoutsEmployeesMethodsBankTransfersRequirementsPostResponsesContentApplicationJsonSchemaDataStepsItems"},"description":"Steps to fulfill the requirements"},"is_final":{"type":"boolean","description":"Indicates if the requirements are final"},"requirements_id":{"type":"number","format":"double","description":"ID of the requirements"}},"description":"Response data","title":"PayoutsEmployeesMethodsBankTransfersRequirementsPostResponsesContentApplicationJsonSchemaData"},"Payouts_dynamicRequirements_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PayoutsEmployeesMethodsBankTransfersRequirementsPostResponsesContentApplicationJsonSchemaData","description":"Response data"}},"title":"Payouts_dynamicRequirements_Response_200"},"PayoutsContractorsMethodsGetResponsesContentApplicationJsonSchemaDataAddress":{"type":"object","properties":{"city":{"type":"string","description":"City name"},"state":{"type":"string","description":"State code"},"country":{"type":"string","description":"Country code"},"post_code":{"type":"string","description":"Post code"},"first_line":{"type":"string","description":"First line of the address"}},"required":["city","country","post_code","first_line"],"title":"PayoutsContractorsMethodsGetResponsesContentApplicationJsonSchemaDataAddress"},"PayoutsContractorsMethodsGetResponsesContentApplicationJsonSchemaDataPaymentMethod":{"type":"string","enum":["bank_transfer"],"title":"PayoutsContractorsMethodsGetResponsesContentApplicationJsonSchemaDataPaymentMethod"},"PayoutsContractorsMethodsGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"address":{"$ref":"#/components/schemas/PayoutsContractorsMethodsGetResponsesContentApplicationJsonSchemaDataAddress"},"payload":{"type":"object","additionalProperties":{"description":"Any type"},"description":"Dynamic properties based on selected option. For example, if `selectedOption` is `swift_code`, payload may include `swiftCode`, `accountHolderName`, and `accountNumber`."},"is_default":{"type":"boolean","description":"Specifies if the method is the default payout method - if true, autowithdrawal will be enabled for the contractor using this method"},"method_name":{"type":"string","description":"Name for method"},"payment_method":{"$ref":"#/components/schemas/PayoutsContractorsMethodsGetResponsesContentApplicationJsonSchemaDataPaymentMethod"},"selectedOption":{"type":"string","description":"Specifies the type of bank transfer method. Maps from requirements type field"}},"required":["address","payload","payment_method"],"title":"PayoutsContractorsMethodsGetResponsesContentApplicationJsonSchemaData"},"Payouts_getPayoutMethods_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PayoutsContractorsMethodsGetResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"Payouts_getPayoutMethods_Response_200"},"PayoutsEmployeesMethodsGetResponsesContentApplicationJsonSchemaDataItemsData":{"type":"object","properties":{"city":{"type":"string","description":"Name of the city"},"iban":{"type":"string","description":"International Bank Account Number"},"postal":{"type":"string","description":"Postal code"},"bank_name":{"type":"string","description":"Name of the bank"},"full_name":{"type":"string","description":"Full name of the account holder"},"swift_bic":{"type":"string","description":"SWIFT/BIC code"},"country_code":{"type":"string","description":"Country code"},"address_line1":{"type":"string","description":"Address line 1"},"original_name":{"type":"string","description":"Original name of the account holder"},"province_state":{"type":"string","description":"Province or state"},"bank_country_code":{"type":"string","description":"Country code of the bank"}},"title":"PayoutsEmployeesMethodsGetResponsesContentApplicationJsonSchemaDataItemsData"},"PayoutsEmployeesMethodsGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the bank details"},"data":{"$ref":"#/components/schemas/PayoutsEmployeesMethodsGetResponsesContentApplicationJsonSchemaDataItemsData"},"status":{"type":"string","description":"Status of the bank details"},"version":{"type":"string","description":"Version identifier"},"created_at":{"type":"string","description":"Creation timestamp"},"updated_at":{"type":"string","description":"Last update timestamp"},"is_active_version":{"type":"boolean","description":"Indicates if this is the active version"},"funds_distribution":{"type":"number","format":"double","description":"Funds distribution percentage"}},"title":"PayoutsEmployeesMethodsGetResponsesContentApplicationJsonSchemaDataItems"},"Payouts_getBankDetails_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/PayoutsEmployeesMethodsGetResponsesContentApplicationJsonSchemaDataItems"}}},"title":"Payouts_getBankDetails_Response_200"},"PayoutsContractorsMethodsBankTransfersRequirementsGetResponsesContentApplicationJsonSchemaDataItemsFieldsItemsGroupItemsType":{"type":"string","enum":["text","radio","select","date_local"],"description":"The type of the field, such as text, radio, select, or date_local.","title":"PayoutsContractorsMethodsBankTransfersRequirementsGetResponsesContentApplicationJsonSchemaDataItemsFieldsItemsGroupItemsType"},"PayoutsContractorsMethodsBankTransfersRequirementsGetResponsesContentApplicationJsonSchemaDataItemsFieldsItemsGroupItemsValuesAllowedItems":{"type":"object","properties":{"key":{"type":"string","description":"The country code (e.g., AL for Albania)."},"name":{"type":"string","description":"The full name of the country (e.g., Albania)."}},"required":["key","name"],"title":"PayoutsContractorsMethodsBankTransfersRequirementsGetResponsesContentApplicationJsonSchemaDataItemsFieldsItemsGroupItemsValuesAllowedItems"},"PayoutsContractorsMethodsBankTransfersRequirementsGetResponsesContentApplicationJsonSchemaDataItemsFieldsItemsGroupItems":{"type":"object","properties":{"key":{"type":"string","description":"The key of the field in the method creaion payload"},"name":{"type":"string","description":"User facing name of property"},"type":{"$ref":"#/components/schemas/PayoutsContractorsMethodsBankTransfersRequirementsGetResponsesContentApplicationJsonSchemaDataItemsFieldsItemsGroupItemsType","description":"The type of the field, such as text, radio, select, or date_local."},"example":{"type":"string","description":"Example value for the field"},"required":{"type":"boolean","description":"Whether the field is required"},"max_length":{"type":"integer","description":"The maximum length of the field"},"values_allowed":{"type":"array","items":{"$ref":"#/components/schemas/PayoutsContractorsMethodsBankTransfersRequirementsGetResponsesContentApplicationJsonSchemaDataItemsFieldsItemsGroupItemsValuesAllowedItems"},"description":"An array of allowed values with corresponding key and name."},"validation_regexp":{"type":"string","description":"The regular expression to validate the field"},"refresh_requirements_on_change":{"type":"boolean","description":"Whether to refresh the requirements when the field value changes with field key as query parameter"}},"required":["key","name","type","required"],"title":"PayoutsContractorsMethodsBankTransfersRequirementsGetResponsesContentApplicationJsonSchemaDataItemsFieldsItemsGroupItems"},"PayoutsContractorsMethodsBankTransfersRequirementsGetResponsesContentApplicationJsonSchemaDataItemsFieldsItems":{"type":"object","properties":{"name":{"type":"string"},"group":{"type":"array","items":{"$ref":"#/components/schemas/PayoutsContractorsMethodsBankTransfersRequirementsGetResponsesContentApplicationJsonSchemaDataItemsFieldsItemsGroupItems"}}},"required":["name","group"],"title":"PayoutsContractorsMethodsBankTransfersRequirementsGetResponsesContentApplicationJsonSchemaDataItemsFieldsItems"},"PayoutsContractorsMethodsBankTransfersRequirementsGetResponsesContentApplicationJsonSchemaDataItemsIntermediaryItemsGroupItemsValuesAllowedItems":{"type":"object","properties":{"key":{"type":"string","description":"The country code (e.g., AL for Albania)."},"name":{"type":"string","description":"The full name of the country (e.g., Albania)."}},"required":["key","name"],"title":"PayoutsContractorsMethodsBankTransfersRequirementsGetResponsesContentApplicationJsonSchemaDataItemsIntermediaryItemsGroupItemsValuesAllowedItems"},"PayoutsContractorsMethodsBankTransfersRequirementsGetResponsesContentApplicationJsonSchemaDataItemsIntermediaryItemsGroupItems":{"type":"object","properties":{"key":{"type":"string"},"name":{"type":"string","description":"User facing name of the intermediary object"},"type":{"type":"string"},"example":{"type":"string","description":"Example value for the field"},"required":{"type":"boolean","description":"Whether the field is required"},"max_length":{"type":"integer","description":"The maximum length of the field"},"min_length":{"type":"integer","description":"The minimum length of the field"},"values_allowed":{"type":"array","items":{"$ref":"#/components/schemas/PayoutsContractorsMethodsBankTransfersRequirementsGetResponsesContentApplicationJsonSchemaDataItemsIntermediaryItemsGroupItemsValuesAllowedItems"},"description":"An array of allowed values with corresponding key and name."},"validation_regexp":{"type":"string","description":"The regular expression to validate the field"}},"required":["key","name","type","required"],"title":"PayoutsContractorsMethodsBankTransfersRequirementsGetResponsesContentApplicationJsonSchemaDataItemsIntermediaryItemsGroupItems"},"PayoutsContractorsMethodsBankTransfersRequirementsGetResponsesContentApplicationJsonSchemaDataItemsIntermediaryItems":{"type":"object","properties":{"name":{"type":"string","description":"User facing name of the intermediary object"},"group":{"type":"array","items":{"$ref":"#/components/schemas/PayoutsContractorsMethodsBankTransfersRequirementsGetResponsesContentApplicationJsonSchemaDataItemsIntermediaryItemsGroupItems"}}},"required":["name","group"],"title":"PayoutsContractorsMethodsBankTransfersRequirementsGetResponsesContentApplicationJsonSchemaDataItemsIntermediaryItems"},"PayoutsContractorsMethodsBankTransfersRequirementsGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"type":{"type":"string","description":"Type of bank transfer, such as local, swift, iban. Maps to selected_option in method creation data."},"title":{"type":"string","description":"Title of the bank transfer method"},"fields":{"type":"array","items":{"$ref":"#/components/schemas/PayoutsContractorsMethodsBankTransfersRequirementsGetResponsesContentApplicationJsonSchemaDataItemsFieldsItems"},"description":"Each field key is input field for the bank transfer method creation payload."},"total_fee":{"type":"string","description":"Fee preview for amount provided in query parameter"},"intermediary":{"type":"array","items":{"$ref":"#/components/schemas/PayoutsContractorsMethodsBankTransfersRequirementsGetResponsesContentApplicationJsonSchemaDataItemsIntermediaryItems"},"description":"Each field is input for the bank transfer method creation payload intermediary object"}},"required":["type","title","fields","total_fee"],"title":"PayoutsContractorsMethodsBankTransfersRequirementsGetResponsesContentApplicationJsonSchemaDataItems"},"Payouts_getBankTransferRequirements_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/PayoutsContractorsMethodsBankTransfersRequirementsGetResponsesContentApplicationJsonSchemaDataItems"}}},"required":["data"],"title":"Payouts_getBankTransferRequirements_Response_200"},"Payouts_getBankTransferSupportedRoutes_Response_200":{"type":"object","properties":{"data":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}},"description":"A mapping of country codes to arrays of supported currency codes"}},"required":["data"],"title":"Payouts_getBankTransferSupportedRoutes_Response_200"},"PayoutsAutoWithdrawalSettingGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"method_id":{"type":"string","format":"uuid","description":"The ID of the withdrawal method to be used for auto withdrawal"},"is_auto_withdraw_enabled":{"type":"boolean","description":"Whether auto withdrawal is enabled"}},"title":"PayoutsAutoWithdrawalSettingGetResponsesContentApplicationJsonSchemaData"},"Payouts_getTheAutoWithdrawalSetting_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PayoutsAutoWithdrawalSettingGetResponsesContentApplicationJsonSchemaData"}},"title":"Payouts_getTheAutoWithdrawalSetting_Response_200"},"PayoutsBalancesGetResponsesContentApplicationJsonSchemaDataBalancesItems":{"type":"object","properties":{"amount":{"type":"string","description":"amount of that currency in the contractor balance"},"currency":{"type":"string","description":"currency of that amount"}},"title":"PayoutsBalancesGetResponsesContentApplicationJsonSchemaDataBalancesItems"},"PayoutsBalancesGetResponsesContentApplicationJsonSchemaDataBalancesTotal":{"type":"object","properties":{"amount":{"type":"string","description":"total amount of all currencies in the contractor balance"},"currency":{"type":"string","description":"currency of the total amount"}},"title":"PayoutsBalancesGetResponsesContentApplicationJsonSchemaDataBalancesTotal"},"PayoutsBalancesGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"balances":{"type":"array","items":{"$ref":"#/components/schemas/PayoutsBalancesGetResponsesContentApplicationJsonSchemaDataBalancesItems"}},"balances_total":{"$ref":"#/components/schemas/PayoutsBalancesGetResponsesContentApplicationJsonSchemaDataBalancesTotal"}},"title":"PayoutsBalancesGetResponsesContentApplicationJsonSchemaData"},"Payouts_listContractorBalances_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PayoutsBalancesGetResponsesContentApplicationJsonSchemaData"}},"title":"Payouts_listContractorBalances_Response_200"},"PayoutsBalancesGetResponsesContentApplicationJsonSchemaItems":{"type":"object","properties":{"message":{"type":"string","description":"error message"}},"title":"PayoutsBalancesGetResponsesContentApplicationJsonSchemaItems"},"PayoutsWithdrawalsPostRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"Amount to withdraw (must be positive)"},"currency":{"type":"string","description":"Currency code for the withdrawal amount"},"withdrawal_method_id":{"type":"string","format":"uuid","description":"Id of the withdrawal method to use"}},"required":["amount","currency","withdrawal_method_id"],"title":"PayoutsWithdrawalsPostRequestBodyContentApplicationJsonSchemaData"},"PayoutsWithdrawalsPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"ID of the created transaction"},"amount":{"type":"number","format":"double","description":"Amount of the transaction"},"currency":{"type":"string","description":"Currency of the transaction"},"created_at":{"type":"string","format":"date-time","description":"Timestamp of the transaction creation"},"updated_at":{"type":"string","format":"date-time","description":"Timestamp of the transaction update"}},"title":"PayoutsWithdrawalsPostResponsesContentApplicationJsonSchemaData"},"Payouts_requestToWithdrawFunds_Response_201":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PayoutsWithdrawalsPostResponsesContentApplicationJsonSchemaData"}},"title":"Payouts_requestToWithdrawFunds_Response_201"},"PayoutsWithdrawalsPostResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"message":{"type":"string","description":"Error message"}},"title":"PayoutsWithdrawalsPostResponsesContentApplicationJsonSchemaErrorsItems"},"RequestToWithdrawFundsRequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/PayoutsWithdrawalsPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"RequestToWithdrawFundsRequestInternalServerError"},"PayoutsContractorsMethodsIdPutRequestBodyContentApplicationJsonSchemaDataAddress":{"type":"object","properties":{"city":{"type":"string","description":"City name"},"state":{"type":"string","description":"State code"},"country":{"type":"string","description":"Country code"},"post_code":{"type":"string","description":"Post code"},"first_line":{"type":"string","description":"First line of the address"}},"required":["city","country","post_code","first_line"],"title":"PayoutsContractorsMethodsIdPutRequestBodyContentApplicationJsonSchemaDataAddress"},"PayoutsContractorsMethodsIdPutRequestBodyContentApplicationJsonSchemaDataPaymentMethod":{"type":"string","enum":["bank_transfer"],"description":"Specifies the type of payment method","title":"PayoutsContractorsMethodsIdPutRequestBodyContentApplicationJsonSchemaDataPaymentMethod"},"PayoutsContractorsMethodsIdPutRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"address":{"$ref":"#/components/schemas/PayoutsContractorsMethodsIdPutRequestBodyContentApplicationJsonSchemaDataAddress"},"payload":{"type":"object","additionalProperties":{"description":"Any type"},"description":"Dynamic properties based on selected option. For example, if `selectedOption` is `swift_code`, payload may include `swiftCode`, `accountHolderName`, and `accountNumber`."},"is_default":{"type":"boolean","description":"Specifies if the method is the default payout method - if true, autowithdrawal will be enabled for the contractor using this method"},"method_name":{"type":"string","description":"Name for method"},"payment_method":{"$ref":"#/components/schemas/PayoutsContractorsMethodsIdPutRequestBodyContentApplicationJsonSchemaDataPaymentMethod","description":"Specifies the type of payment method"},"selectedOption":{"type":"string","description":"Specifies the type of bank transfer method. Maps from requirements type field"}},"required":["address","payload","payment_method"],"title":"PayoutsContractorsMethodsIdPutRequestBodyContentApplicationJsonSchemaData"},"PayoutsContractorsMethodsIdPutResponsesContentApplicationJsonSchemaDataStatus":{"type":"string","enum":["pending","verifying","failed","approved"],"description":"Status of the method. Can be `pending`, `verifying`, `failed`, or `approved`","title":"PayoutsContractorsMethodsIdPutResponsesContentApplicationJsonSchemaDataStatus"},"PayoutsContractorsMethodsIdPutResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the bank transfer method"},"status":{"$ref":"#/components/schemas/PayoutsContractorsMethodsIdPutResponsesContentApplicationJsonSchemaDataStatus","description":"Status of the method. Can be `pending`, `verifying`, `failed`, or `approved`"}},"title":"PayoutsContractorsMethodsIdPutResponsesContentApplicationJsonSchemaData"},"Payouts_updateBankTransferMethod_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PayoutsContractorsMethodsIdPutResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"Payouts_updateBankTransferMethod_Response_200"},"PayoutsContractorsSettingsAutoWithdrawPostRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"is_auto_withdraw_enabled":{"type":"boolean","description":"Sets auto withdraw to enabled or disabled for contractor"}},"required":["is_auto_withdraw_enabled"],"title":"PayoutsContractorsSettingsAutoWithdrawPostRequestBodyContentApplicationJsonSchemaData"},"Payouts_updateAutoWithdrawSetting_Response_200":{"type":"object","properties":{},"description":"Empty response body","title":"Payouts_updateAutoWithdrawSetting_Response_200"},"BenefitsLegalEntitiesIdPayStubGetResponsesContentApplicationJsonSchemaDataItemsSource":{"type":"string","enum":["HISTORICAL","NEW"],"description":"Source of the payroll data.","title":"BenefitsLegalEntitiesIdPayStubGetResponsesContentApplicationJsonSchemaDataItemsSource"},"BenefitsLegalEntitiesIdPayStubGetResponsesContentApplicationJsonSchemaDataItemsEmployeesItemsContributionsItemsType":{"type":"string","enum":["Roth","Trad"],"description":"Type of the contribution.","title":"BenefitsLegalEntitiesIdPayStubGetResponsesContentApplicationJsonSchemaDataItemsEmployeesItemsContributionsItemsType"},"BenefitsLegalEntitiesIdPayStubGetResponsesContentApplicationJsonSchemaDataItemsEmployeesItemsContributionsItems":{"type":"object","properties":{"name":{"type":"string","description":"Name of the contribution."},"type":{"$ref":"#/components/schemas/BenefitsLegalEntitiesIdPayStubGetResponsesContentApplicationJsonSchemaDataItemsEmployeesItemsContributionsItemsType","description":"Type of the contribution."},"amount":{"type":"number","format":"double","description":"Amount contributed."}},"title":"BenefitsLegalEntitiesIdPayStubGetResponsesContentApplicationJsonSchemaDataItemsEmployeesItemsContributionsItems"},"BenefitsLegalEntitiesIdPayStubGetResponsesContentApplicationJsonSchemaDataItemsEmployeesItemsEmployerContributionsItemsType":{"type":"string","enum":["Match Rate","Non Elective"],"description":"Type of the employer contribution.","title":"BenefitsLegalEntitiesIdPayStubGetResponsesContentApplicationJsonSchemaDataItemsEmployeesItemsEmployerContributionsItemsType"},"BenefitsLegalEntitiesIdPayStubGetResponsesContentApplicationJsonSchemaDataItemsEmployeesItemsEmployerContributionsItems":{"type":"object","properties":{"name":{"type":"string","description":"Name of the employer contribution."},"type":{"$ref":"#/components/schemas/BenefitsLegalEntitiesIdPayStubGetResponsesContentApplicationJsonSchemaDataItemsEmployeesItemsEmployerContributionsItemsType","description":"Type of the employer contribution."},"amount":{"type":"number","format":"double","description":"Amount of the employer contribution."}},"title":"BenefitsLegalEntitiesIdPayStubGetResponsesContentApplicationJsonSchemaDataItemsEmployeesItemsEmployerContributionsItems"},"BenefitsLegalEntitiesIdPayStubGetResponsesContentApplicationJsonSchemaDataItemsEmployeesItems":{"type":"object","properties":{"gross_pay":{"type":"number","format":"double","description":"Total gross pay for the employee for this payroll period."},"contract_id":{"type":"string","description":"Identifier for the employee contract."},"employee_id":{"type":"string","description":"Unique identifier for the employee."},"hours_worked":{"type":"number","format":"double","description":"Total hours worked by the employee in this payroll period."},"contributions":{"type":"array","items":{"$ref":"#/components/schemas/BenefitsLegalEntitiesIdPayStubGetResponsesContentApplicationJsonSchemaDataItemsEmployeesItemsContributionsItems"},"description":"List of contributions made by the employee."},"employer_contributions":{"type":"array","items":{"$ref":"#/components/schemas/BenefitsLegalEntitiesIdPayStubGetResponsesContentApplicationJsonSchemaDataItemsEmployeesItemsEmployerContributionsItems"},"description":"List of contributions made by the employer."}},"title":"BenefitsLegalEntitiesIdPayStubGetResponsesContentApplicationJsonSchemaDataItemsEmployeesItems"},"BenefitsLegalEntitiesIdPayStubGetResponsesContentApplicationJsonSchemaDataItemsPaymentType":{"type":"string","enum":["RECONCILIATION","PARALLEL","HISTORICAL","OFFCYCLE","REGULAR"],"description":"Type of payroll payment.","title":"BenefitsLegalEntitiesIdPayStubGetResponsesContentApplicationJsonSchemaDataItemsPaymentType"},"BenefitsLegalEntitiesIdPayStubGetResponsesContentApplicationJsonSchemaDataItemsPaymentStatus":{"type":"string","enum":["OPEN","LOCKED","CLOSED"],"description":"Current status of the payroll payment.","title":"BenefitsLegalEntitiesIdPayStubGetResponsesContentApplicationJsonSchemaDataItemsPaymentStatus"},"BenefitsLegalEntitiesIdPayStubGetResponsesContentApplicationJsonSchemaDataItemsPayrollSchedule":{"type":"string","enum":["BIMONTHLY","MONTHLY","BIWEEKLY","WEEKLY"],"description":"Frequency of the payroll schedule.","title":"BenefitsLegalEntitiesIdPayStubGetResponsesContentApplicationJsonSchemaDataItemsPayrollSchedule"},"BenefitsLegalEntitiesIdPayStubGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"source":{"$ref":"#/components/schemas/BenefitsLegalEntitiesIdPayStubGetResponsesContentApplicationJsonSchemaDataItemsSource","description":"Source of the payroll data."},"employees":{"type":"array","items":{"$ref":"#/components/schemas/BenefitsLegalEntitiesIdPayStubGetResponsesContentApplicationJsonSchemaDataItemsEmployeesItems"},"description":"List of employees included in the payroll."},"payroll_id":{"type":"string","description":"Unique identifier for the payroll."},"payment_date":{"type":"string","description":"Date when the payment is made."},"payment_type":{"$ref":"#/components/schemas/BenefitsLegalEntitiesIdPayStubGetResponsesContentApplicationJsonSchemaDataItemsPaymentType","description":"Type of payroll payment."},"payment_status":{"$ref":"#/components/schemas/BenefitsLegalEntitiesIdPayStubGetResponsesContentApplicationJsonSchemaDataItemsPaymentStatus","description":"Current status of the payroll payment."},"payroll_end_date":{"type":"string","description":"End date of the payroll period."},"payroll_schedule":{"$ref":"#/components/schemas/BenefitsLegalEntitiesIdPayStubGetResponsesContentApplicationJsonSchemaDataItemsPayrollSchedule","description":"Frequency of the payroll schedule."},"payroll_start_date":{"type":"string","description":"Start date of the payroll period."}},"title":"BenefitsLegalEntitiesIdPayStubGetResponsesContentApplicationJsonSchemaDataItems"},"BenefitsLegalEntitiesIdPayStubGetResponsesContentApplicationJsonSchemaPage":{"type":"object","properties":{"offset":{"type":"integer","description":"Items to be skipped when searching"},"total_rows":{"type":"integer","description":"Total number of rows"},"items_per_page":{"type":"integer","description":"Items per page"}},"title":"BenefitsLegalEntitiesIdPayStubGetResponsesContentApplicationJsonSchemaPage"},"Payroll_getPayStubFromEmployeesFromOrganizationIntegratedWithExternalBenefitsVendor-v2026-01-01_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/BenefitsLegalEntitiesIdPayStubGetResponsesContentApplicationJsonSchemaDataItems"}},"page":{"$ref":"#/components/schemas/BenefitsLegalEntitiesIdPayStubGetResponsesContentApplicationJsonSchemaPage"}},"title":"Payroll_getPayStubFromEmployeesFromOrganizationIntegratedWithExternalBenefitsVendor-v2026-01-01_Response_200"},"BenefitsLegalEntitiesIdYearToDatePayGetResponsesContentApplicationJsonSchemaEmployeesItemsContributionsItemsType":{"type":"string","enum":["roth","trad","loan"],"description":"Type of the contribution.","title":"BenefitsLegalEntitiesIdYearToDatePayGetResponsesContentApplicationJsonSchemaEmployeesItemsContributionsItemsType"},"BenefitsLegalEntitiesIdYearToDatePayGetResponsesContentApplicationJsonSchemaEmployeesItemsContributionsItems":{"type":"object","properties":{"name":{"type":"string","description":"Name of the contribution."},"type":{"$ref":"#/components/schemas/BenefitsLegalEntitiesIdYearToDatePayGetResponsesContentApplicationJsonSchemaEmployeesItemsContributionsItemsType","description":"Type of the contribution."},"amount":{"type":"number","format":"double","description":"Amount of the contribution."}},"title":"BenefitsLegalEntitiesIdYearToDatePayGetResponsesContentApplicationJsonSchemaEmployeesItemsContributionsItems"},"BenefitsLegalEntitiesIdYearToDatePayGetResponsesContentApplicationJsonSchemaEmployeesItemsEmployerContributionsItemsType":{"type":"string","enum":["match_rate","non_elective"],"description":"Type of the employer contribution.","title":"BenefitsLegalEntitiesIdYearToDatePayGetResponsesContentApplicationJsonSchemaEmployeesItemsEmployerContributionsItemsType"},"BenefitsLegalEntitiesIdYearToDatePayGetResponsesContentApplicationJsonSchemaEmployeesItemsEmployerContributionsItems":{"type":"object","properties":{"name":{"type":"string","description":"Name of the employer contribution."},"type":{"$ref":"#/components/schemas/BenefitsLegalEntitiesIdYearToDatePayGetResponsesContentApplicationJsonSchemaEmployeesItemsEmployerContributionsItemsType","description":"Type of the employer contribution."},"amount":{"type":"number","format":"double","description":"Amount of the employer contribution."}},"title":"BenefitsLegalEntitiesIdYearToDatePayGetResponsesContentApplicationJsonSchemaEmployeesItemsEmployerContributionsItems"},"BenefitsLegalEntitiesIdYearToDatePayGetResponsesContentApplicationJsonSchemaEmployeesItems":{"type":"object","properties":{"gross_pay":{"type":"number","format":"double","description":"Total pay before deductions."},"contract_id":{"type":"string","description":"Identifier for the employee's contract."},"employee_id":{"type":"string","format":"uuid","description":"Unique identifier for the employee."},"hours_worked":{"type":"number","format":"double","description":"Total hours worked in the pay period."},"contributions":{"type":"array","items":{"$ref":"#/components/schemas/BenefitsLegalEntitiesIdYearToDatePayGetResponsesContentApplicationJsonSchemaEmployeesItemsContributionsItems"}},"employer_contributions":{"type":"array","items":{"$ref":"#/components/schemas/BenefitsLegalEntitiesIdYearToDatePayGetResponsesContentApplicationJsonSchemaEmployeesItemsEmployerContributionsItems"}}},"title":"BenefitsLegalEntitiesIdYearToDatePayGetResponsesContentApplicationJsonSchemaEmployeesItems"},"Payroll_getYearToDatePay_Response_200":{"type":"object","properties":{"end_date":{"type":"string","format":"date","description":"The end date of the pay period."},"employees":{"type":"array","items":{"$ref":"#/components/schemas/BenefitsLegalEntitiesIdYearToDatePayGetResponsesContentApplicationJsonSchemaEmployeesItems"}},"start_date":{"type":"string","format":"date","description":"The start date of the pay period."}},"title":"Payroll_getYearToDatePay_Response_200"},"GpWorkersIdPayslipsGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the payslip."},"to":{"type":"string","format":"date","description":"End date of the payslip period in ISO-8601 format."},"from":{"type":"string","format":"date","description":"Start date of the payslip period in ISO-8601 format."},"status":{"type":"string","description":"The current status of the payslip (e.g., AVAILABLE, PENDING, PUBLISHED)."}},"required":["id","to","from","status"],"title":"GpWorkersIdPayslipsGetResponsesContentApplicationJsonSchemaDataItems"},"payslips_getGPWorkerPayslips_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/GpWorkersIdPayslipsGetResponsesContentApplicationJsonSchemaDataItems"}}},"required":["data"],"title":"payslips_getGPWorkerPayslips_Response_200"},"GpWorkersIdPayslipsGetResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"message":{"type":"string","description":"Error response"}},"required":["message"],"title":"GpWorkersIdPayslipsGetResponsesContentApplicationJsonSchemaErrorsItems"},"GpWorkersIdPayslipsGetResponsesContentApplicationJsonSchemaRequest":{"type":"object","properties":{"method":{"type":"string","description":"Method of the API"},"status":{"type":"number","format":"double","description":"Status of API response"}},"description":"Error request details","title":"GpWorkersIdPayslipsGetResponsesContentApplicationJsonSchemaRequest"},"RetrieveEmployeePayslips-v2026-01-01RequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/GpWorkersIdPayslipsGetResponsesContentApplicationJsonSchemaErrorsItems"},"description":"Error messages"},"request":{"$ref":"#/components/schemas/GpWorkersIdPayslipsGetResponsesContentApplicationJsonSchemaRequest","description":"Error request details"}},"required":["errors"],"title":"RetrieveEmployeePayslips-v2026-01-01RequestBadRequestError"},"BenefitsLegalEntitiesLegalEntityIdPaystubsGetParametersStatesSchemaItems":{"type":"string","enum":["OPEN","LOCKED","CLOSED"],"title":"BenefitsLegalEntitiesLegalEntityIdPaystubsGetParametersStatesSchemaItems"},"BenefitsLegalEntitiesLegalEntityIdPaystubsGetResponsesContentApplicationJsonSchemaDataDataItemsEmployeesItemsContributionsItemsType":{"type":"string","enum":["Roth","Trad","Loan"],"description":"The type of contribution.","title":"BenefitsLegalEntitiesLegalEntityIdPaystubsGetResponsesContentApplicationJsonSchemaDataDataItemsEmployeesItemsContributionsItemsType"},"BenefitsLegalEntitiesLegalEntityIdPaystubsGetResponsesContentApplicationJsonSchemaDataDataItemsEmployeesItemsContributionsItems":{"type":"object","properties":{"name":{"type":"string","description":"The contribution name."},"type":{"$ref":"#/components/schemas/BenefitsLegalEntitiesLegalEntityIdPaystubsGetResponsesContentApplicationJsonSchemaDataDataItemsEmployeesItemsContributionsItemsType","description":"The type of contribution."},"amount":{"type":"number","format":"double","description":"The contribution amount."}},"description":"Details about the contributions.","title":"BenefitsLegalEntitiesLegalEntityIdPaystubsGetResponsesContentApplicationJsonSchemaDataDataItemsEmployeesItemsContributionsItems"},"BenefitsLegalEntitiesLegalEntityIdPaystubsGetResponsesContentApplicationJsonSchemaDataDataItemsEmployeesItemsEmployerContributionsItemsType":{"type":"string","enum":["Match Rate","Non Elective","Safe Harbor Type 1","Safe Harbor Type 2"],"description":"The type of contribution.","title":"BenefitsLegalEntitiesLegalEntityIdPaystubsGetResponsesContentApplicationJsonSchemaDataDataItemsEmployeesItemsEmployerContributionsItemsType"},"BenefitsLegalEntitiesLegalEntityIdPaystubsGetResponsesContentApplicationJsonSchemaDataDataItemsEmployeesItemsEmployerContributionsItems":{"type":"object","properties":{"name":{"type":"string","description":"The contribution name."},"type":{"$ref":"#/components/schemas/BenefitsLegalEntitiesLegalEntityIdPaystubsGetResponsesContentApplicationJsonSchemaDataDataItemsEmployeesItemsEmployerContributionsItemsType","description":"The type of contribution."},"amount":{"type":"number","format":"double","description":"The contribution amount."}},"description":"Details about the contributions.","title":"BenefitsLegalEntitiesLegalEntityIdPaystubsGetResponsesContentApplicationJsonSchemaDataDataItemsEmployeesItemsEmployerContributionsItems"},"BenefitsLegalEntitiesLegalEntityIdPaystubsGetResponsesContentApplicationJsonSchemaDataDataItemsEmployeesItems":{"type":"object","properties":{"gross_pay":{"type":["number","null"],"format":"double","description":"Gross pay."},"contract_id":{"type":"string","description":"The contract id."},"employee_id":{"type":"string","description":"Unique identifier for the employee."},"hours_worked":{"type":["number","null"],"format":"double","description":"The worked hours."},"contributions":{"type":"array","items":{"$ref":"#/components/schemas/BenefitsLegalEntitiesLegalEntityIdPaystubsGetResponsesContentApplicationJsonSchemaDataDataItemsEmployeesItemsContributionsItems"},"description":"List of employee's contributions."},"employerContributions":{"type":"array","items":{"$ref":"#/components/schemas/BenefitsLegalEntitiesLegalEntityIdPaystubsGetResponsesContentApplicationJsonSchemaDataDataItemsEmployeesItemsEmployerContributionsItems"},"description":"List of employeer's contributions."}},"title":"BenefitsLegalEntitiesLegalEntityIdPaystubsGetResponsesContentApplicationJsonSchemaDataDataItemsEmployeesItems"},"BenefitsLegalEntitiesLegalEntityIdPaystubsGetResponsesContentApplicationJsonSchemaDataDataItemsPayrollType":{"type":"string","enum":["CORRECTION","RECONCILIATION","PARALLEL","HISTORICAL","OFFCYCLE","REGULAR"],"description":"Payroll type.","title":"BenefitsLegalEntitiesLegalEntityIdPaystubsGetResponsesContentApplicationJsonSchemaDataDataItemsPayrollType"},"BenefitsLegalEntitiesLegalEntityIdPaystubsGetResponsesContentApplicationJsonSchemaDataDataItemsPayrollState":{"type":"string","enum":["OPEN","LOCKED","CLOSED"],"description":"Payroll state.","title":"BenefitsLegalEntitiesLegalEntityIdPaystubsGetResponsesContentApplicationJsonSchemaDataDataItemsPayrollState"},"BenefitsLegalEntitiesLegalEntityIdPaystubsGetResponsesContentApplicationJsonSchemaDataDataItemsPayrollSchedule":{"type":"string","enum":["MONTHLY","BIMONTHLY","BIWEEKLY","WEEKLY"],"description":"Payroll cycle type.","title":"BenefitsLegalEntitiesLegalEntityIdPaystubsGetResponsesContentApplicationJsonSchemaDataDataItemsPayrollSchedule"},"BenefitsLegalEntitiesLegalEntityIdPaystubsGetResponsesContentApplicationJsonSchemaDataDataItems":{"type":"object","properties":{"employees":{"type":"array","items":{"$ref":"#/components/schemas/BenefitsLegalEntitiesLegalEntityIdPaystubsGetResponsesContentApplicationJsonSchemaDataDataItemsEmployeesItems"},"description":"List of employees associated with the payroll."},"payroll_id":{"type":"string","description":"Unique identifier for the payroll."},"payment_date":{"type":"string","description":"Payment date."},"payroll_type":{"$ref":"#/components/schemas/BenefitsLegalEntitiesLegalEntityIdPaystubsGetResponsesContentApplicationJsonSchemaDataDataItemsPayrollType","description":"Payroll type."},"payroll_state":{"$ref":"#/components/schemas/BenefitsLegalEntitiesLegalEntityIdPaystubsGetResponsesContentApplicationJsonSchemaDataDataItemsPayrollState","description":"Payroll state."},"payroll_end_date":{"type":"string","description":"Payroll end date."},"payroll_schedule":{"$ref":"#/components/schemas/BenefitsLegalEntitiesLegalEntityIdPaystubsGetResponsesContentApplicationJsonSchemaDataDataItemsPayrollSchedule","description":"Payroll cycle type."},"payroll_start_date":{"type":"string","description":"Payroll start date."}},"title":"BenefitsLegalEntitiesLegalEntityIdPaystubsGetResponsesContentApplicationJsonSchemaDataDataItems"},"BenefitsLegalEntitiesLegalEntityIdPaystubsGetResponsesContentApplicationJsonSchemaDataPage":{"type":"object","properties":{"cursor":{"type":["string","null"],"description":"The last fetched id to start querying from"},"total_rows":{"type":"integer","description":"Total number of rows"},"items_per_page":{"type":"integer","description":"Items per page"}},"title":"BenefitsLegalEntitiesLegalEntityIdPaystubsGetResponsesContentApplicationJsonSchemaDataPage"},"BenefitsLegalEntitiesLegalEntityIdPaystubsGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/BenefitsLegalEntitiesLegalEntityIdPaystubsGetResponsesContentApplicationJsonSchemaDataDataItems"},"description":"List of paystubs"},"page":{"$ref":"#/components/schemas/BenefitsLegalEntitiesLegalEntityIdPaystubsGetResponsesContentApplicationJsonSchemaDataPage"}},"title":"BenefitsLegalEntitiesLegalEntityIdPaystubsGetResponsesContentApplicationJsonSchemaData"},"Paystubs_getPaystubsFromLegalEntityIntegratedWithExternalBenefitsVendor-v2026-01-01_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BenefitsLegalEntitiesLegalEntityIdPaystubsGetResponsesContentApplicationJsonSchemaData"}},"title":"Paystubs_getPaystubsFromLegalEntityIntegratedWithExternalBenefitsVendor-v2026-01-01_Response_200"},"PeoplePostRequestBodyContentApplicationJsonSchemaDataClientTeam":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The team that the employee is part of"},"direct_manager_id":{"type":"string","format":"uuid","description":"The direct manager of the employee"}},"required":["id"],"description":"The team information for the employee","title":"PeoplePostRequestBodyContentApplicationJsonSchemaDataClientTeam"},"PeoplePostRequestBodyContentApplicationJsonSchemaDataClientDepartment":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The department that the employee is part of"}},"required":["id"],"description":"The department information for the employee","title":"PeoplePostRequestBodyContentApplicationJsonSchemaDataClientDepartment"},"PeoplePostRequestBodyContentApplicationJsonSchemaDataClientLegalEntity":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The legal entity that the employee is part of"}},"required":["id"],"description":"The legal entity information for the employee","title":"PeoplePostRequestBodyContentApplicationJsonSchemaDataClientLegalEntity"},"PeoplePostRequestBodyContentApplicationJsonSchemaDataClient":{"type":"object","properties":{"team":{"$ref":"#/components/schemas/PeoplePostRequestBodyContentApplicationJsonSchemaDataClientTeam","description":"The team information for the employee"},"department":{"$ref":"#/components/schemas/PeoplePostRequestBodyContentApplicationJsonSchemaDataClientDepartment","description":"The department information for the employee"},"legal_entity":{"$ref":"#/components/schemas/PeoplePostRequestBodyContentApplicationJsonSchemaDataClientLegalEntity","description":"The legal entity information for the employee"}},"required":["team","legal_entity"],"description":"The entity that is hiring the employee","title":"PeoplePostRequestBodyContentApplicationJsonSchemaDataClient"},"PeoplePostRequestBodyContentApplicationJsonSchemaDataEmployee":{"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"},"last_name":{"type":"string","description":"The last name of the person being hired"},"first_name":{"type":"string","description":"The first name 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"}},"required":["email","country","last_name","first_name","nationality"],"description":"The person that is being hired","title":"PeoplePostRequestBodyContentApplicationJsonSchemaDataEmployee"},"PeoplePostRequestBodyContentApplicationJsonSchemaDataEmploymentOneOf0Type":{"type":"string","enum":["PART_TIME"],"description":"The type of employment","title":"PeoplePostRequestBodyContentApplicationJsonSchemaDataEmploymentOneOf0Type"},"PeoplePostRequestBodyContentApplicationJsonSchemaDataEmployment0":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/PeoplePostRequestBodyContentApplicationJsonSchemaDataEmploymentOneOf0Type","description":"The type of employment"},"end_date":{"type":"string","format":"date","description":"The end date of the employment"},"job_title":{"type":"string","description":"The job title of the employment"},"seniority":{"type":"string","description":"The seniority of the employment"},"start_date":{"type":"string","format":"date","description":"The start date of the employment"},"document_template_id":{"type":"string","format":"uuid","description":"The document template ID for the employment contract"},"part_time_percentage":{"type":"number","format":"double","description":"The percentage of PART_TIME employment"}},"required":["type","job_title","seniority","start_date","part_time_percentage"],"title":"PeoplePostRequestBodyContentApplicationJsonSchemaDataEmployment0"},"PeoplePostRequestBodyContentApplicationJsonSchemaDataEmploymentOneOf1Type":{"type":"string","enum":["FULL_TIME"],"description":"The type of employment","title":"PeoplePostRequestBodyContentApplicationJsonSchemaDataEmploymentOneOf1Type"},"PeoplePostRequestBodyContentApplicationJsonSchemaDataEmployment1":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/PeoplePostRequestBodyContentApplicationJsonSchemaDataEmploymentOneOf1Type","description":"The type of employment"},"end_date":{"type":"string","format":"date","description":"The end date of the employment"},"job_title":{"type":"string","description":"The job title of the employment"},"seniority":{"type":"string","description":"The seniority of the employment"},"start_date":{"type":"string","format":"date","description":"The start date of the employment"},"document_template_id":{"type":"string","format":"uuid","description":"The document template ID for the employment contract"}},"required":["type","job_title","seniority","start_date"],"title":"PeoplePostRequestBodyContentApplicationJsonSchemaDataEmployment1"},"PeoplePostRequestBodyContentApplicationJsonSchemaDataEmployment":{"oneOf":[{"$ref":"#/components/schemas/PeoplePostRequestBodyContentApplicationJsonSchemaDataEmployment0"},{"$ref":"#/components/schemas/PeoplePostRequestBodyContentApplicationJsonSchemaDataEmployment1"}],"description":"The employment details of the employee","title":"PeoplePostRequestBodyContentApplicationJsonSchemaDataEmployment"},"PeoplePostRequestBodyContentApplicationJsonSchemaDataCompensationDetailsScale":{"type":"string","enum":["ANNUAL","MONTHLY","SEMIMONTHLY","BIWEEKLY","WEEKLY","DAILY","HOURLY"],"default":"ANNUAL","description":"The scale at which the salary is paid","title":"PeoplePostRequestBodyContentApplicationJsonSchemaDataCompensationDetailsScale"},"PeoplePostRequestBodyContentApplicationJsonSchemaDataCompensationDetails":{"type":"object","properties":{"scale":{"$ref":"#/components/schemas/PeoplePostRequestBodyContentApplicationJsonSchemaDataCompensationDetailsScale","description":"The scale at which the salary is paid"},"salary":{"type":"number","format":"double","description":"The salary of the employee"},"currency":{"type":"string","description":"The currency of the salary"}},"required":["salary","currency"],"description":"The compensation details of the employee","title":"PeoplePostRequestBodyContentApplicationJsonSchemaDataCompensationDetails"},"PeoplePostRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"client":{"$ref":"#/components/schemas/PeoplePostRequestBodyContentApplicationJsonSchemaDataClient","description":"The entity that is hiring the employee"},"employee":{"$ref":"#/components/schemas/PeoplePostRequestBodyContentApplicationJsonSchemaDataEmployee","description":"The person that is being hired"},"employment":{"$ref":"#/components/schemas/PeoplePostRequestBodyContentApplicationJsonSchemaDataEmployment","description":"The employment details of the employee"},"compensation_details":{"$ref":"#/components/schemas/PeoplePostRequestBodyContentApplicationJsonSchemaDataCompensationDetails","description":"The compensation details of the employee"}},"required":["client","employee","employment","compensation_details"],"title":"PeoplePostRequestBodyContentApplicationJsonSchemaData"},"PeoplePostResponsesContentApplicationJsonSchemaDataEmployee":{"type":"object","properties":{"email":{"type":"string","format":"email","description":"The personal email of the person being hired"},"last_name":{"type":"string","description":"The last name of the person being hired"},"first_name":{"type":"string","description":"The first name 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"}},"required":["email","last_name","first_name","nationality"],"description":"The person that is being hired","title":"PeoplePostResponsesContentApplicationJsonSchemaDataEmployee"},"PeoplePostResponsesContentApplicationJsonSchemaDataEmploymentType":{"type":"string","enum":["FULL_TIME","PART_TIME"],"description":"The type of employment","title":"PeoplePostResponsesContentApplicationJsonSchemaDataEmploymentType"},"PeoplePostResponsesContentApplicationJsonSchemaDataEmployment":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/PeoplePostResponsesContentApplicationJsonSchemaDataEmploymentType","description":"The type of employment"},"country":{"type":"string","description":"The country of the employment"},"end_date":{"type":"string","format":"date","description":"The end date of the employment"},"job_title":{"type":"string","description":"The job title of the employment"},"seniority":{"type":"string","description":"The seniority of the employment"},"start_date":{"type":"string","format":"date","description":"The start date of the employment"},"contract_id":{"type":"string","description":"The unique identifier of the worker contract"},"part_time_percentage":{"type":"number","format":"double","description":"The percentage of PART_TIME employment"}},"required":["type","country","end_date","job_title","seniority","start_date","contract_id"],"description":"The employment details of the employee","title":"PeoplePostResponsesContentApplicationJsonSchemaDataEmployment"},"PeoplePostResponsesContentApplicationJsonSchemaDataCompensationDetailsScale":{"type":"string","enum":["ANNUAL","MONTHLY","SEMIMONTHLY","BIWEEKLY","WEEKLY","DAILY","HOURLY"],"default":"ANNUAL","description":"The scale at which the salary is paid","title":"PeoplePostResponsesContentApplicationJsonSchemaDataCompensationDetailsScale"},"PeoplePostResponsesContentApplicationJsonSchemaDataCompensationDetails":{"type":"object","properties":{"scale":{"$ref":"#/components/schemas/PeoplePostResponsesContentApplicationJsonSchemaDataCompensationDetailsScale","description":"The scale at which the salary is paid"},"salary":{"type":"number","format":"double","description":"The salary of the employee"},"currency":{"type":"string","description":"The currency of the salary"}},"required":["salary","currency"],"description":"The compensation details of the employee","title":"PeoplePostResponsesContentApplicationJsonSchemaDataCompensationDetails"},"PeoplePostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the created employee record"},"employee":{"$ref":"#/components/schemas/PeoplePostResponsesContentApplicationJsonSchemaDataEmployee","description":"The person that is being hired"},"employment":{"$ref":"#/components/schemas/PeoplePostResponsesContentApplicationJsonSchemaDataEmployment","description":"The employment details of the employee"},"compensation_details":{"$ref":"#/components/schemas/PeoplePostResponsesContentApplicationJsonSchemaDataCompensationDetails","description":"The compensation details of the employee"}},"required":["id","employee","employment","compensation_details"],"title":"PeoplePostResponsesContentApplicationJsonSchemaData"},"People_createADirectEmployee_Response_201":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PeoplePostResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"People_createADirectEmployee_Response_201"},"PeoplePostResponsesContentApplicationJsonSchemaError":{"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":"PeoplePostResponsesContentApplicationJsonSchemaError"},"CreateADirectEmployeeRequestBadRequestError":{"type":"object","properties":{"error":{"$ref":"#/components/schemas/PeoplePostResponsesContentApplicationJsonSchemaError"}},"required":["error"],"title":"CreateADirectEmployeeRequestBadRequestError"},"CreateADirectEmployeeRequestInternalServerError":{"type":"object","properties":{"error":{"$ref":"#/components/schemas/PeoplePostResponsesContentApplicationJsonSchemaError"}},"required":["error"],"title":"CreateADirectEmployeeRequestInternalServerError"},"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"},"PeopleMeGetResponsesContentApplicationJsonSchemaProfileType":{"type":"string","enum":["client","contractor","icp","direct_employee","hris_direct_employee","service_account"],"description":"Type of profile","title":"PeopleMeGetResponsesContentApplicationJsonSchemaProfileType"},"People_getMyCurrentPersonalProfile_Response_200":{"type":"object","properties":{"id":{"type":"number","format":"double","description":"Unique identifier for the user profile "},"email":{"type":"string","description":"Email address of the user"},"user_id":{"type":"number","format":"double","description":"Unique identifier for the user"},"username":{"type":"string","description":"Username of the user"},"full_name":{"type":"string","description":"Full name of the user"},"last_name":{"type":"string","description":"Last name of the user"},"avatar_url":{"type":["string","null"],"description":"URL of the user's avatar"},"first_name":{"type":"string","description":"First name of the user"},"middle_name":{"type":["string","null"],"description":"Middle name of the user"},"hris_enabled":{"type":["boolean","null"],"description":"HRIS feature enabled."},"profile_type":{"$ref":"#/components/schemas/PeopleMeGetResponsesContentApplicationJsonSchemaProfileType","description":"Type of profile"},"slack_team_id":{"type":["string","null"],"description":"User's team slack id"},"slack_user_id":{"type":["string","null"],"description":"User's slack id"},"client_country":{"type":["string","null"],"description":"Country code."},"organization_id":{"type":"number","format":"double","description":"Unique identifier for the organization"},"organization_name":{"type":["string","null"],"description":"Name of the organization"},"contractor_country":{"type":["string","null"],"description":"Country code."},"hris_organization_user_id":{"type":["string","null"],"format":"uuid","description":"HRIS Organization User ID of the user. Used in products like Deel Engage."}},"description":"People object representing a Deel","title":"People_getMyCurrentPersonalProfile_Response_200"},"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"},"Plans 401K_activateThe401KIntegrationForTheLegalEntity-v2026-01-01_Response_200":{"type":"object","properties":{"isActive":{"type":"boolean","description":"Whether the 401k integration has been activated or not."}},"title":"Plans 401K_activateThe401KIntegrationForTheLegalEntity-v2026-01-01_Response_200"},"Plans 401K_cleanUpPlanForAGivenLegalEntity-v2026-01-01_Response_202":{"type":"object","properties":{},"title":"Plans 401K_cleanUpPlanForAGivenLegalEntity-v2026-01-01_Response_202"},"BenefitsLegalEntitiesLegalEntityId401KPlansPostRequestBodyContentApplicationJsonSchemaDetails":{"type":"object","properties":{"key":{"type":"string","description":"A key-value pair providing additional details about the plan."}},"description":"Object containing additional information about the 401K plan.","title":"BenefitsLegalEntitiesLegalEntityId401KPlansPostRequestBodyContentApplicationJsonSchemaDetails"},"BenefitsLegalEntitiesLegalEntityId401KPlansPostRequestBodyContentApplicationJsonSchemaContributionType":{"type":"string","enum":["PERCENTAGE","NEC_PERCENTAGE","NEC_FIXED_AMOUNT","FIXED_AMOUNT","MATCH"],"description":"Type of contribution for the 401K plan.","title":"BenefitsLegalEntitiesLegalEntityId401KPlansPostRequestBodyContentApplicationJsonSchemaContributionType"},"BenefitsLegalEntitiesLegalEntityId401KPlansPostRequestBodyContentApplicationJsonSchemaContributionValueForMatchRateItems":{"type":"object","properties":{"rate":{"type":"number","format":"double","description":"Rate of matching contribution."},"limit":{"type":"number","format":"double","description":"Limit up to which the match rate is applicable."}},"required":["rate","limit"],"description":"Contribution values for match rate type.","title":"BenefitsLegalEntitiesLegalEntityId401KPlansPostRequestBodyContentApplicationJsonSchemaContributionValueForMatchRateItems"},"BenefitsLegalEntitiesLegalEntityId401KPlansPostResponsesContentApplicationJsonSchemaDataDetails":{"type":"object","properties":{"key":{"type":"string","description":"A key-value pair providing additional details about the plan."}},"description":"Object containing additional information about the 401K plan.","title":"BenefitsLegalEntitiesLegalEntityId401KPlansPostResponsesContentApplicationJsonSchemaDataDetails"},"BenefitsLegalEntitiesLegalEntityId401KPlansPostResponsesContentApplicationJsonSchemaDataContributionType":{"type":"string","enum":["PERCENTAGE","NEC_PERCENTAGE","NEC_FIXED_AMOUNT","FIXED_AMOUNT","MATCH"],"description":"Type of contribution for the 401K plan.","title":"BenefitsLegalEntitiesLegalEntityId401KPlansPostResponsesContentApplicationJsonSchemaDataContributionType"},"BenefitsLegalEntitiesLegalEntityId401KPlansPostResponsesContentApplicationJsonSchemaDataContributionValueForMatchRateItems":{"type":"object","properties":{"rate":{"type":"number","format":"double","description":"Rate of matching contribution."},"limit":{"type":"number","format":"double","description":"Limit up to which the match rate is applicable."}},"required":["rate","limit"],"description":"Contribution values for match rate type.","title":"BenefitsLegalEntitiesLegalEntityId401KPlansPostResponsesContentApplicationJsonSchemaDataContributionValueForMatchRateItems"},"BenefitsLegalEntitiesLegalEntityId401KPlansPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","description":"ID of the 401K plan."},"name":{"type":"string","description":"Name of the 401K plan."},"details":{"$ref":"#/components/schemas/BenefitsLegalEntitiesLegalEntityId401KPlansPostResponsesContentApplicationJsonSchemaDataDetails","description":"Object containing additional information about the 401K plan."},"currency":{"type":"string","description":"Currency for the contributions in ISO 4217 format."},"start_date":{"type":"string","format":"date-time","description":"Start date of the plan."},"contribution_type":{"$ref":"#/components/schemas/BenefitsLegalEntitiesLegalEntityId401KPlansPostResponsesContentApplicationJsonSchemaDataContributionType","description":"Type of contribution for the 401K plan."},"contribution_limit":{"type":"number","format":"double","description":"Limit of the contribution."},"contribution_value":{"type":"number","format":"double","description":"Value of the contribution if type is percent or amount."},"contribution_value_for_match_rate":{"type":"array","items":{"$ref":"#/components/schemas/BenefitsLegalEntitiesLegalEntityId401KPlansPostResponsesContentApplicationJsonSchemaDataContributionValueForMatchRateItems"},"description":"Array of objects containing limits and rates for match rate contribution type."}},"title":"BenefitsLegalEntitiesLegalEntityId401KPlansPostResponsesContentApplicationJsonSchemaData"},"Plans 401K_create401KPlanForLegalEntity-v2026-01-01_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BenefitsLegalEntitiesLegalEntityId401KPlansPostResponsesContentApplicationJsonSchemaData"}},"title":"Plans 401K_create401KPlanForLegalEntity-v2026-01-01_Response_200"},"BenefitsLegalEntitiesId401KPlansGetResponsesContentApplicationJsonSchemaDataItemsDetails":{"type":"object","properties":{},"description":"Object containing additional information about the 401K plan.","title":"BenefitsLegalEntitiesId401KPlansGetResponsesContentApplicationJsonSchemaDataItemsDetails"},"BenefitsLegalEntitiesId401KPlansGetResponsesContentApplicationJsonSchemaDataItemsContributionType":{"type":"string","enum":["PERCENTAGE","FIXED_AMOUNT","MATCH","NEC_FIXED_AMOUNT","NEC_PERCENTAGE"],"description":"Type of contribution for the 401K plan.","title":"BenefitsLegalEntitiesId401KPlansGetResponsesContentApplicationJsonSchemaDataItemsContributionType"},"BenefitsLegalEntitiesId401KPlansGetResponsesContentApplicationJsonSchemaDataItemsContributionValueForMatchRateItems":{"type":"object","properties":{"rate":{"type":["number","null"],"format":"double","description":"Rate of matching contribution."},"limit":{"type":["number","null"],"format":"double","description":"Limit up to which the match rate is applicable."}},"title":"BenefitsLegalEntitiesId401KPlansGetResponsesContentApplicationJsonSchemaDataItemsContributionValueForMatchRateItems"},"BenefitsLegalEntitiesId401KPlansGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"id":{"type":"string","description":"ID of the 401K plan."},"name":{"type":"string","description":"Name of the 401K plan."},"details":{"$ref":"#/components/schemas/BenefitsLegalEntitiesId401KPlansGetResponsesContentApplicationJsonSchemaDataItemsDetails","description":"Object containing additional information about the 401K plan."},"end_date":{"type":"string","description":"End date of the plan."},"start_date":{"type":["string","null"],"description":"Start date of the plan."},"contribution_type":{"$ref":"#/components/schemas/BenefitsLegalEntitiesId401KPlansGetResponsesContentApplicationJsonSchemaDataItemsContributionType","description":"Type of contribution for the 401K plan."},"contribution_value":{"type":"number","format":"double","description":"Value of the contribution if type is percent or amount."},"contribution_value_for_match_rate":{"type":["array","null"],"items":{"$ref":"#/components/schemas/BenefitsLegalEntitiesId401KPlansGetResponsesContentApplicationJsonSchemaDataItemsContributionValueForMatchRateItems"},"description":"Array of objects containing limits and rates for match rate contribution type."}},"title":"BenefitsLegalEntitiesId401KPlansGetResponsesContentApplicationJsonSchemaDataItems"},"Plans 401K_get401KPlansForLegalEntity-v2026-01-01_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/BenefitsLegalEntitiesId401KPlansGetResponsesContentApplicationJsonSchemaDataItems"},"description":"List of plans"}},"title":"Plans 401K_get401KPlansForLegalEntity-v2026-01-01_Response_200"},"BenefitsLegalEntitiesLegalEntityId401KPlansPlanIdPutRequestBodyContentApplicationJsonSchemaDataDetails":{"type":"object","properties":{},"description":"Object containing additional information about the 401K plan.","title":"BenefitsLegalEntitiesLegalEntityId401KPlansPlanIdPutRequestBodyContentApplicationJsonSchemaDataDetails"},"BenefitsLegalEntitiesLegalEntityId401KPlansPlanIdPutRequestBodyContentApplicationJsonSchemaDataContributionType":{"type":"string","enum":["NEC_PERCENTAGE","NEC_FIXED_AMOUNT","PERCENTAGE","FIXED_AMOUNT","MATCH"],"description":"Type of contribution for the 401K plan.","title":"BenefitsLegalEntitiesLegalEntityId401KPlansPlanIdPutRequestBodyContentApplicationJsonSchemaDataContributionType"},"BenefitsLegalEntitiesLegalEntityId401KPlansPlanIdPutRequestBodyContentApplicationJsonSchemaDataContributionValueForMatchRateItems":{"type":"object","properties":{"rate":{"type":"number","format":"double","description":"Rate of matching contribution."},"limit":{"type":"number","format":"double","description":"Limit up to which the match rate is applicable."}},"required":["rate","limit"],"description":"Contribution values for match rate type.","title":"BenefitsLegalEntitiesLegalEntityId401KPlansPlanIdPutRequestBodyContentApplicationJsonSchemaDataContributionValueForMatchRateItems"},"BenefitsLegalEntitiesLegalEntityId401KPlansPlanIdPutRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"name":{"type":"string","description":"Name of the 401K plan."},"details":{"$ref":"#/components/schemas/BenefitsLegalEntitiesLegalEntityId401KPlansPlanIdPutRequestBodyContentApplicationJsonSchemaDataDetails","description":"Object containing additional information about the 401K plan."},"end_date":{"type":"string","format":"date","description":"End date of the plan."},"start_date":{"type":"string","format":"date","description":"Start date of the plan."},"contribution_type":{"$ref":"#/components/schemas/BenefitsLegalEntitiesLegalEntityId401KPlansPlanIdPutRequestBodyContentApplicationJsonSchemaDataContributionType","description":"Type of contribution for the 401K plan."},"contribution_value":{"type":"number","format":"double","description":"Value of the contribution if type is percent or amount."},"contribution_value_for_match_rate":{"type":"array","items":{"$ref":"#/components/schemas/BenefitsLegalEntitiesLegalEntityId401KPlansPlanIdPutRequestBodyContentApplicationJsonSchemaDataContributionValueForMatchRateItems"},"description":"Array of objects containing limits and rates for match rate contribution type."}},"required":["name","start_date","contribution_type"],"description":"Schema for the 401K Guideline Plan request body.","title":"BenefitsLegalEntitiesLegalEntityId401KPlansPlanIdPutRequestBodyContentApplicationJsonSchemaData"},"BenefitsLegalEntitiesLegalEntityId401KPlansPlanIdPutResponsesContentApplicationJsonSchemaDataDetails":{"type":"object","properties":{},"description":"Object containing additional information about the 401K plan.","title":"BenefitsLegalEntitiesLegalEntityId401KPlansPlanIdPutResponsesContentApplicationJsonSchemaDataDetails"},"BenefitsLegalEntitiesLegalEntityId401KPlansPlanIdPutResponsesContentApplicationJsonSchemaDataContributionType":{"type":"string","enum":["NEC_PERCENTAGE","NEC_FIXED_AMOUNT","PERCENTAGE","FIXED_AMOUNT","MATCH"],"description":"Type of contribution for the 401K plan.","title":"BenefitsLegalEntitiesLegalEntityId401KPlansPlanIdPutResponsesContentApplicationJsonSchemaDataContributionType"},"BenefitsLegalEntitiesLegalEntityId401KPlansPlanIdPutResponsesContentApplicationJsonSchemaDataContributionValueForMatchRateItems":{"type":"object","properties":{"rate":{"type":["number","null"],"format":"double","description":"Rate of matching contribution."},"limit":{"type":["number","null"],"format":"double","description":"Limit up to which the match rate is applicable."}},"description":"Contribution values for match rate type.","title":"BenefitsLegalEntitiesLegalEntityId401KPlansPlanIdPutResponsesContentApplicationJsonSchemaDataContributionValueForMatchRateItems"},"BenefitsLegalEntitiesLegalEntityId401KPlansPlanIdPutResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","description":"ID of the 401K plan."},"name":{"type":"string","description":"Name of the 401K plan."},"details":{"$ref":"#/components/schemas/BenefitsLegalEntitiesLegalEntityId401KPlansPlanIdPutResponsesContentApplicationJsonSchemaDataDetails","description":"Object containing additional information about the 401K plan."},"end_date":{"type":"string","description":"End date of the plan."},"start_date":{"type":"string","description":"Start date of the plan."},"contribution_type":{"$ref":"#/components/schemas/BenefitsLegalEntitiesLegalEntityId401KPlansPlanIdPutResponsesContentApplicationJsonSchemaDataContributionType","description":"Type of contribution for the 401K plan."},"contribution_limit":{"type":"number","format":"double","description":"Limit of the contribution."},"contribution_value":{"type":"number","format":"double","description":"Value of the contribution if type is percent or amount."},"contribution_value_for_match_rate":{"type":"array","items":{"$ref":"#/components/schemas/BenefitsLegalEntitiesLegalEntityId401KPlansPlanIdPutResponsesContentApplicationJsonSchemaDataContributionValueForMatchRateItems"},"description":"Array of objects containing limits and rates for match rate contribution type."}},"required":["name","start_date","contribution_type"],"description":"Plan object for non PEO legal entity.","title":"BenefitsLegalEntitiesLegalEntityId401KPlansPlanIdPutResponsesContentApplicationJsonSchemaData"},"Plans 401K_update401KPlan-v2026-01-01_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BenefitsLegalEntitiesLegalEntityId401KPlansPlanIdPutResponsesContentApplicationJsonSchemaData","description":"Plan object for non PEO legal entity."}},"required":["data"],"title":"Plans 401K_update401KPlan-v2026-01-01_Response_200"},"Update401KPlan-v2026-01-01RequestBadRequestError":{"type":"object","properties":{"error":{"type":"string","description":"Error message describing what went wrong with the request."}},"required":["error"],"title":"Update401KPlan-v2026-01-01RequestBadRequestError"},"Update401KPlan-v2026-01-01RequestNotFoundError":{"type":"object","properties":{"error":{"type":"string","description":"Error message indicating the requested resource was not found."}},"required":["error"],"title":"Update401KPlan-v2026-01-01RequestNotFoundError"},"Update401KPlan-v2026-01-01RequestInternalServerError":{"type":"object","properties":{"error":{"type":"string","description":"Error message indicating an internal server error occurred."}},"required":["error"],"title":"Update401KPlan-v2026-01-01RequestInternalServerError"},"ItPoliciesGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the policy"},"name":{"type":"string","description":"Policy name"}},"title":"ItPoliciesGetResponsesContentApplicationJsonSchemaDataItems"},"policies_getITPolicies_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ItPoliciesGetResponsesContentApplicationJsonSchemaDataItems"}}},"title":"policies_getITPolicies_Response_200"},"ItPoliciesGetResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string","description":"Error code of the handler which produced the returned error"},"field":{"type":"string","description":"The field name where input validation failed"},"message":{"type":"string","description":"Description of the returned error"}},"title":"ItPoliciesGetResponsesContentApplicationJsonSchemaErrorsItems"},"ListItHardwarePoliciesRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ItPoliciesGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"ListItHardwarePoliciesRequestBadRequestError"},"ListItHardwarePoliciesRequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ItPoliciesGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"ListItHardwarePoliciesRequestInternalServerError"},"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"},"HrisPositionsProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataItemsRole":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Role ID"},"name":{"type":"string","description":"Role Name"}},"title":"HrisPositionsProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataItemsRole"},"HrisPositionsProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataItemsTeamOrganizationStructure":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Organization Structure ID"},"name":{"type":"string","description":"Organization Structure Name"}},"title":"HrisPositionsProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataItemsTeamOrganizationStructure"},"HrisPositionsProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataItemsTeam":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Team ID"},"name":{"type":"string","description":"Team Name"},"organization_structure":{"$ref":"#/components/schemas/HrisPositionsProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataItemsTeamOrganizationStructure"}},"title":"HrisPositionsProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataItemsTeam"},"HrisPositionsProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"HRIS Position ID"},"role":{"$ref":"#/components/schemas/HrisPositionsProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataItemsRole"},"team":{"$ref":"#/components/schemas/HrisPositionsProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataItemsTeam"},"is_supportive":{"type":"boolean","description":"Is Supportive Position"}},"title":"HrisPositionsProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataItems"},"Positions_fetchHrisPositionsFromAHrisProfile-v2026-01-01_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/HrisPositionsProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaDataItems"}}},"title":"Positions_fetchHrisPositionsFromAHrisProfile-v2026-01-01_Response_200"},"HrisPositionsProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string"},"field":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"title":"HrisPositionsProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaErrorsItems"},"FetchHrisPositionsFromAHrisProfile-v2026-01-01RequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/HrisPositionsProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"FetchHrisPositionsFromAHrisProfile-v2026-01-01RequestBadRequestError"},"FetchHrisPositionsFromAHrisProfile-v2026-01-01RequestNotFoundError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/HrisPositionsProfileHrisProfileIdGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"FetchHrisPositionsFromAHrisProfile-v2026-01-01RequestNotFoundError"},"ProfilesPatchRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"phone":{"type":"string","description":"The contact number for the profile."},"currency":{"type":"string","description":"The preferred currency for the profile."},"timezone":{"type":"string","description":"The timezone of the profile."},"last_name":{"type":"string","description":"The last name of the profile."},"first_name":{"type":"string","description":"The first name of the profile."},"preferred_name":{"type":"string","description":"The preferred name of the profile."}},"title":"ProfilesPatchRequestBodyContentApplicationJsonSchemaData"},"ProfilesPatchResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"phone":{"type":"string","description":"The contact number for the profile."},"currency":{"type":"string","description":"The preferred currency for the profile."},"timezone":{"type":"string","description":"The timezone of the profile."},"last_name":{"type":"string","description":"The last name of the profile."},"first_name":{"type":"string","description":"The first name of the profile."},"preferred_name":{"type":"string","description":"The preferred name of the profile."}},"title":"ProfilesPatchResponsesContentApplicationJsonSchemaData"},"profiles_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ProfilesPatchResponsesContentApplicationJsonSchemaData"}},"title":"profiles_Response_200"},"ProfilesRequestBadRequestError":{"type":"object","properties":{"message":{"type":"string","description":"Error message explaining what went wrong."}},"title":"ProfilesRequestBadRequestError"},"TimesheetsPresetsPostRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"file":{"type":["string","null"],"format":"binary","description":"Optional file attachment for the hourly report preset"},"rate":{"type":"number","format":"double","description":"The hourly rate for this preset (must be greater than 0)"},"title":{"type":"string","description":"The title of the hourly report preset"},"description":{"type":["string","null"],"description":"A detailed description of the hourly report preset's purpose and contents"},"work_statement_id":{"type":"string","format":"uuid","description":"The unique identifier of the associated work statement"},"hourly_report_root_preset_id":{"type":"string","format":"uuid","description":"The unique identifier of the root preset this report is based on"}},"required":["work_statement_id","hourly_report_root_preset_id"],"title":"TimesheetsPresetsPostRequestBodyContentApplicationJsonSchemaData"},"TimesheetsPresetsPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the newly created hourly report preset"}},"required":["id"],"title":"TimesheetsPresetsPostResponsesContentApplicationJsonSchemaData"},"Projects_createTimesheetsPreset_Response_201":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/TimesheetsPresetsPostResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"Projects_createTimesheetsPreset_Response_201"},"CreateHourlyReportPresetRequestBadRequestError":{"type":"object","properties":{"error":{"type":"string"}},"title":"CreateHourlyReportPresetRequestBadRequestError"},"CreateHourlyReportPresetRequestForbiddenError":{"type":"object","properties":{"error":{"type":"string"}},"title":"CreateHourlyReportPresetRequestForbiddenError"},"TimesheetsRootPresetsPostRequestBodyContentApplicationJsonSchemaType":{"type":"string","enum":["RATE","TRACKING"],"description":"The type of preset, RATE – indicates a preset that overrides the default contract rate, TRACKING - used exclusively for tracking, applying the default contract rate","title":"TimesheetsRootPresetsPostRequestBodyContentApplicationJsonSchemaType"},"TimesheetsRootPresetsPostRequestBodyContentApplicationJsonSchemaHourlyReportPresetsItemsActionType":{"type":"string","enum":["ADD"],"default":"ADD","description":"The action to perform with this preset (currently only ADD is supported)","title":"TimesheetsRootPresetsPostRequestBodyContentApplicationJsonSchemaHourlyReportPresetsItemsActionType"},"TimesheetsRootPresetsPostRequestBodyContentApplicationJsonSchemaHourlyReportPresetsItems":{"type":"object","properties":{"file":{"type":["string","null"],"format":"binary","description":"Optional file attachment for this specific preset instance"},"rate":{"type":"number","format":"double","description":"The hourly rate for this preset (must be greater than 0)"},"title":{"type":"string","description":"The title for this specific preset instance (maximum 255 characters)"},"action_type":{"$ref":"#/components/schemas/TimesheetsRootPresetsPostRequestBodyContentApplicationJsonSchemaHourlyReportPresetsItemsActionType","description":"The action to perform with this preset (currently only ADD is supported)"},"contract_id":{"type":"string","description":"The unique identifier of the contract this preset is associated with"},"description":{"type":["string","null"],"description":"Detailed description for this specific preset instance (maximum 30000 characters)"}},"required":["contract_id"],"title":"TimesheetsRootPresetsPostRequestBodyContentApplicationJsonSchemaHourlyReportPresetsItems"},"TimesheetsRootPresetsPostRequestBodyContentApplicationJsonSchemaHourlyReportPresetsProcessingType":{"type":"string","enum":["ASYNC","SYNC"],"default":"SYNC","description":"Determines whether presets should be processed synchronously or asynchronously","title":"TimesheetsRootPresetsPostRequestBodyContentApplicationJsonSchemaHourlyReportPresetsProcessingType"},"TimesheetsRootPresetsPostResponsesContentApplicationJsonSchemaDataAsyncTask":{"type":"object","properties":{"id":{"type":"integer","description":"The identifier of the asynchronous task processing this request"}},"title":"TimesheetsRootPresetsPostResponsesContentApplicationJsonSchemaDataAsyncTask"},"TimesheetsRootPresetsPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the created root preset"},"async_task":{"$ref":"#/components/schemas/TimesheetsRootPresetsPostResponsesContentApplicationJsonSchemaDataAsyncTask"}},"required":["id"],"title":"TimesheetsRootPresetsPostResponsesContentApplicationJsonSchemaData"},"Projects_createRootTimesheetsPreset_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/TimesheetsRootPresetsPostResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"Projects_createRootTimesheetsPreset_Response_200"},"CreateHourlyReportRootPresetRequestBadRequestError":{"type":"object","properties":{"error":{"type":"string"}},"title":"CreateHourlyReportRootPresetRequestBadRequestError"},"TimesheetsPresetsIdDeleteResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"deleted":{"type":"boolean","description":"Indicates whether the hourly report preset was successfully deleted"}},"required":["deleted"],"title":"TimesheetsPresetsIdDeleteResponsesContentApplicationJsonSchemaData"},"Projects_deleteTimesheetsPreset_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/TimesheetsPresetsIdDeleteResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"Projects_deleteTimesheetsPreset_Response_200"},"DeleteHourlyReportPresetRequestBadRequestError":{"type":"object","properties":{"error":{"type":"string"}},"title":"DeleteHourlyReportPresetRequestBadRequestError"},"DeleteHourlyReportPresetRequestForbiddenError":{"type":"object","properties":{"error":{"type":"string"}},"title":"DeleteHourlyReportPresetRequestForbiddenError"},"DeleteHourlyReportPresetRequestNotFoundError":{"type":"object","properties":{"error":{"type":"string"}},"title":"DeleteHourlyReportPresetRequestNotFoundError"},"TimesheetsPresetsIdGetResponsesContentApplicationJsonSchemaDataFile":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the file"},"name":{"type":"string","description":"The name of the file"},"type":{"type":"string","description":"The type of the file"}},"title":"TimesheetsPresetsIdGetResponsesContentApplicationJsonSchemaDataFile"},"TimesheetsPresetsIdGetResponsesContentApplicationJsonSchemaDataType":{"type":"string","enum":["RATE","TRACKING"],"description":"The type of preset based on type of root preset","title":"TimesheetsPresetsIdGetResponsesContentApplicationJsonSchemaDataType"},"TimesheetsPresetsIdGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the hourly report preset"},"file":{"oneOf":[{"$ref":"#/components/schemas/TimesheetsPresetsIdGetResponsesContentApplicationJsonSchemaDataFile"},{"type":"null"}]},"type":{"$ref":"#/components/schemas/TimesheetsPresetsIdGetResponsesContentApplicationJsonSchemaDataType","description":"The type of preset based on type of root preset"},"title":{"type":"string","description":"The title of the hourly report preset"},"status":{"type":"string","description":"The current status of the hourly report preset"},"description":{"type":"string","description":"A detailed description of the hourly report preset"}},"required":["id","title","status","description"],"title":"TimesheetsPresetsIdGetResponsesContentApplicationJsonSchemaData"},"Projects_getTimesheetsPresetById_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/TimesheetsPresetsIdGetResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"Projects_getTimesheetsPresetById_Response_200"},"GetHourlyReportPresetByIdRequestForbiddenError":{"type":"object","properties":{"error":{"type":"string"}},"title":"GetHourlyReportPresetByIdRequestForbiddenError"},"GetHourlyReportPresetByIdRequestNotFoundError":{"type":"object","properties":{"error":{"type":"string"}},"title":"GetHourlyReportPresetByIdRequestNotFoundError"},"ContractsContractIdTimesheetsPresetsGetResponsesContentApplicationJsonSchemaDataItemsFile":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the file"},"name":{"type":"string","description":"The name of the file"},"type":{"type":"string","description":"The type of the file"}},"title":"ContractsContractIdTimesheetsPresetsGetResponsesContentApplicationJsonSchemaDataItemsFile"},"ContractsContractIdTimesheetsPresetsGetResponsesContentApplicationJsonSchemaDataItemsHourlyReportRootPresetFile":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the file"},"name":{"type":"string","description":"The name of the file"},"type":{"type":"string","description":"The type of the file"}},"title":"ContractsContractIdTimesheetsPresetsGetResponsesContentApplicationJsonSchemaDataItemsHourlyReportRootPresetFile"},"ContractsContractIdTimesheetsPresetsGetResponsesContentApplicationJsonSchemaDataItemsHourlyReportRootPresetType":{"type":"string","enum":["RATE","TRACKING"],"description":"The type of preset based on type of root preset","title":"ContractsContractIdTimesheetsPresetsGetResponsesContentApplicationJsonSchemaDataItemsHourlyReportRootPresetType"},"ContractsContractIdTimesheetsPresetsGetResponsesContentApplicationJsonSchemaDataItemsHourlyReportRootPreset":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the root preset"},"file":{"oneOf":[{"$ref":"#/components/schemas/ContractsContractIdTimesheetsPresetsGetResponsesContentApplicationJsonSchemaDataItemsHourlyReportRootPresetFile"},{"type":"null"}]},"type":{"$ref":"#/components/schemas/ContractsContractIdTimesheetsPresetsGetResponsesContentApplicationJsonSchemaDataItemsHourlyReportRootPresetType","description":"The type of preset based on type of root preset"},"title":{"type":"string","description":"The title of the root preset template"},"description":{"type":"string","description":"Detailed description of the root preset template"}},"required":["id","title","description"],"title":"ContractsContractIdTimesheetsPresetsGetResponsesContentApplicationJsonSchemaDataItemsHourlyReportRootPreset"},"ContractsContractIdTimesheetsPresetsGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the hourly report preset"},"file":{"oneOf":[{"$ref":"#/components/schemas/ContractsContractIdTimesheetsPresetsGetResponsesContentApplicationJsonSchemaDataItemsFile"},{"type":"null"}]},"rate":{"type":"number","format":"double","description":"The hourly rate for this preset"},"title":{"type":"string","description":"Title of the hourly report preset."},"description":{"type":"string","description":"Detailed description of the hourly report preset"},"hourly_report_root_preset":{"$ref":"#/components/schemas/ContractsContractIdTimesheetsPresetsGetResponsesContentApplicationJsonSchemaDataItemsHourlyReportRootPreset"}},"required":["id","rate","title","description","hourly_report_root_preset"],"title":"ContractsContractIdTimesheetsPresetsGetResponsesContentApplicationJsonSchemaDataItems"},"ContractsContractIdTimesheetsPresetsGetResponsesContentApplicationJsonSchemaPage":{"type":"object","properties":{"cursor":{"type":"string","description":"Pagination cursor for fetching the next set of results"},"total_rows":{"type":"integer","description":"Total number of rows available in the result set"}},"required":["cursor","total_rows"],"title":"ContractsContractIdTimesheetsPresetsGetResponsesContentApplicationJsonSchemaPage"},"Projects_getContractTimesheetsPresets_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ContractsContractIdTimesheetsPresetsGetResponsesContentApplicationJsonSchemaDataItems"}},"page":{"$ref":"#/components/schemas/ContractsContractIdTimesheetsPresetsGetResponsesContentApplicationJsonSchemaPage"}},"required":["data","page"],"title":"Projects_getContractTimesheetsPresets_Response_200"},"GetHourlyReportPresetsRequestBadRequestError":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"],"title":"GetHourlyReportPresetsRequestBadRequestError"},"TimesheetsRootPresetsIdGetResponsesContentApplicationJsonSchemaDataFile":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the file"},"name":{"type":"string","description":"The name of the file"},"type":{"type":"string","description":"The type of the file"}},"title":"TimesheetsRootPresetsIdGetResponsesContentApplicationJsonSchemaDataFile"},"TimesheetsRootPresetsIdGetResponsesContentApplicationJsonSchemaDataType":{"type":"string","enum":["RATE","TRACKING"],"description":"The type of preset, RATE – indicates a preset that overrides the default contract rate, TRACKING - used exclusively for tracking, applying the default contract rate","title":"TimesheetsRootPresetsIdGetResponsesContentApplicationJsonSchemaDataType"},"TimesheetsRootPresetsIdGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the hourly report root preset"},"file":{"oneOf":[{"$ref":"#/components/schemas/TimesheetsRootPresetsIdGetResponsesContentApplicationJsonSchemaDataFile"},{"type":"null"}]},"type":{"$ref":"#/components/schemas/TimesheetsRootPresetsIdGetResponsesContentApplicationJsonSchemaDataType","description":"The type of preset, RATE – indicates a preset that overrides the default contract rate, TRACKING - used exclusively for tracking, applying the default contract rate"},"title":{"type":"string","description":"The title of the hourly report root preset"},"status":{"type":"string","description":"The current status of the hourly report root preset"},"description":{"type":"string","description":"Detailed description of the hourly report root preset's purpose and contents"}},"required":["id","title","status","description"],"title":"TimesheetsRootPresetsIdGetResponsesContentApplicationJsonSchemaData"},"Projects_getHourlyReportRootPresetById_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/TimesheetsRootPresetsIdGetResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"Projects_getHourlyReportRootPresetById_Response_200"},"GetHourlyReportRootPresetByIdRequestBadRequestError":{"type":"object","properties":{"error":{"type":"string"}},"title":"GetHourlyReportRootPresetByIdRequestBadRequestError"},"GetHourlyReportRootPresetByIdRequestNotFoundError":{"type":"object","properties":{"error":{"type":"string"}},"title":"GetHourlyReportRootPresetByIdRequestNotFoundError"},"TimesheetsRootPresetsGetParametersOrderBy":{"type":"string","enum":["created_at"],"default":"created_at","title":"TimesheetsRootPresetsGetParametersOrderBy"},"TimesheetsRootPresetsGetParametersOrderDirection":{"type":"string","enum":["ASC","DESC"],"default":"DESC","title":"TimesheetsRootPresetsGetParametersOrderDirection"},"TimesheetsRootPresetsGetResponsesContentApplicationJsonSchemaDataItemsFile":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the file"},"name":{"type":"string","description":"The name of the file"},"type":{"type":"string","description":"The type of the file"}},"title":"TimesheetsRootPresetsGetResponsesContentApplicationJsonSchemaDataItemsFile"},"TimesheetsRootPresetsGetResponsesContentApplicationJsonSchemaDataItemsType":{"type":"string","enum":["RATE","TRACKING"],"description":"The type of preset, RATE – indicates a preset that overrides the default contract rate, TRACKING - used exclusively for tracking, applying the default contract rate","title":"TimesheetsRootPresetsGetResponsesContentApplicationJsonSchemaDataItemsType"},"TimesheetsRootPresetsGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the hourly report root preset"},"file":{"oneOf":[{"$ref":"#/components/schemas/TimesheetsRootPresetsGetResponsesContentApplicationJsonSchemaDataItemsFile"},{"type":"null"}]},"type":{"$ref":"#/components/schemas/TimesheetsRootPresetsGetResponsesContentApplicationJsonSchemaDataItemsType","description":"The type of preset, RATE – indicates a preset that overrides the default contract rate, TRACKING - used exclusively for tracking, applying the default contract rate"},"title":{"type":"string","description":"The title of the hourly report root preset"},"description":{"type":"string","description":"Detailed description of the hourly report root preset"},"contracts_count":{"type":"integer","description":"Number of contracts using this root preset"},"hourly_report_presets_count":{"type":"integer","description":"Number of hourly report presets created from this root preset"}},"required":["id","title","description","contracts_count","hourly_report_presets_count"],"title":"TimesheetsRootPresetsGetResponsesContentApplicationJsonSchemaDataItems"},"TimesheetsRootPresetsGetResponsesContentApplicationJsonSchemaPage":{"type":"object","properties":{"cursor":{"type":"string","description":"Pagination cursor for fetching the next set of results"},"total_rows":{"type":"integer","description":"Total number of root presets available"}},"required":["cursor","total_rows"],"title":"TimesheetsRootPresetsGetResponsesContentApplicationJsonSchemaPage"},"Projects_getHourlyReportRootPresets_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/TimesheetsRootPresetsGetResponsesContentApplicationJsonSchemaDataItems"}},"page":{"$ref":"#/components/schemas/TimesheetsRootPresetsGetResponsesContentApplicationJsonSchemaPage"}},"required":["data","page"],"title":"Projects_getHourlyReportRootPresets_Response_200"},"GetHourlyReportRootPresetsRequestBadRequestError":{"type":"object","properties":{"error":{"type":"string"}},"title":"GetHourlyReportRootPresetsRequestBadRequestError"},"TimesheetsPresetsIdPatchRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"file":{"type":["string","null"],"format":"binary","description":"The file to be attached to this hourly report preset (optional)"},"rate":{"type":"number","format":"double","description":"The hourly rate for this preset (must be greater than 0)"},"title":{"type":"string","description":"The title of the hourly report preset (maximum 255 characters)"},"description":{"type":["string","null"],"description":"A detailed description of the hourly report preset's purpose and contents (maximum 30000 characters)"}},"title":"TimesheetsPresetsIdPatchRequestBodyContentApplicationJsonSchemaData"},"TimesheetsPresetsIdPatchResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier of the updated hourly report preset"}},"required":["id"],"title":"TimesheetsPresetsIdPatchResponsesContentApplicationJsonSchemaData"},"Projects_updateTimesheetsPreset_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/TimesheetsPresetsIdPatchResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"Projects_updateTimesheetsPreset_Response_200"},"UpdateHourlyReportPresetRequestBadRequestError":{"type":"object","properties":{"error":{"type":"string"}},"title":"UpdateHourlyReportPresetRequestBadRequestError"},"UpdateHourlyReportPresetRequestForbiddenError":{"type":"object","properties":{"error":{"type":"string"}},"title":"UpdateHourlyReportPresetRequestForbiddenError"},"UpdateHourlyReportPresetRequestNotFoundError":{"type":"object","properties":{"error":{"type":"string"}},"title":"UpdateHourlyReportPresetRequestNotFoundError"},"ReportsPayrollCyclesCycleIdGrossToNetGetResponsesContentApplicationJsonSchemaDataItemsItemsItemsCategoryGroup":{"type":"string","enum":["ADDITIONS","DEDUCTIONS","BENEFITS","INFOS","CONTRIBUTIONS","TOTALS"],"description":"Category group for the reporting label.","title":"ReportsPayrollCyclesCycleIdGrossToNetGetResponsesContentApplicationJsonSchemaDataItemsItemsItemsCategoryGroup"},"ReportsPayrollCyclesCycleIdGrossToNetGetResponsesContentApplicationJsonSchemaDataItemsItemsItems":{"type":"object","properties":{"label":{"type":"string","description":"Label of the payroll item."},"value":{"type":"number","format":"double","description":"Value associated with the payroll item."},"category":{"type":"string","description":"Category of the item."},"sub_category":{"type":"string","description":"Sub-category of the item."},"category_group":{"$ref":"#/components/schemas/ReportsPayrollCyclesCycleIdGrossToNetGetResponsesContentApplicationJsonSchemaDataItemsItemsItemsCategoryGroup","description":"Category group for the reporting label."}},"title":"ReportsPayrollCyclesCycleIdGrossToNetGetResponsesContentApplicationJsonSchemaDataItemsItemsItems"},"ReportsPayrollCyclesCycleIdGrossToNetGetResponsesContentApplicationJsonSchemaDataItemsPaymentData":{"type":"object","properties":{"conversion_rate":{"type":"string","description":"Conversion rate applied between the payroll currency and the payment currency."},"payment_currency":{"type":"string","description":"Currency in which the payment is made."}},"description":"Payment details associated with the payroll event. Null if no payment data is available.","title":"ReportsPayrollCyclesCycleIdGrossToNetGetResponsesContentApplicationJsonSchemaDataItemsPaymentData"},"ReportsPayrollCyclesCycleIdGrossToNetGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/ReportsPayrollCyclesCycleIdGrossToNetGetResponsesContentApplicationJsonSchemaDataItemsItemsItems"},"description":"List of payroll-related items."},"currency":{"type":"string","description":"Currency associated with the payroll event."},"contract_oid":{"type":"string","description":"Unique identifier for the contract."},"payment_data":{"oneOf":[{"$ref":"#/components/schemas/ReportsPayrollCyclesCycleIdGrossToNetGetResponsesContentApplicationJsonSchemaDataItemsPaymentData"},{"type":"null"}],"description":"Payment details associated with the payroll event. Null if no payment data is available."}},"title":"ReportsPayrollCyclesCycleIdGrossToNetGetResponsesContentApplicationJsonSchemaDataItems"},"Reports_getsG2NReportDataForAGivenPayrollCycleByItsId-v2026-01-01_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ReportsPayrollCyclesCycleIdGrossToNetGetResponsesContentApplicationJsonSchemaDataItems"},"description":"List of contracts associated with the payroll event."},"has_more":{"type":"boolean","description":"Indicates whether more pages are available."},"created_at":{"type":"string","format":"date-time","description":"Timestamp when the report was generated"},"updated_at":{"type":"string","format":"date-time","description":"Timestamp when the report was updated"},"next_cursor":{"type":["string","null"],"description":"Pagination cursor to fetch the next page of results."},"items_per_page":{"type":"integer","description":"The number of items per page."}},"required":["data","has_more","created_at","updated_at","next_cursor","items_per_page"],"title":"Reports_getsG2NReportDataForAGivenPayrollCycleByItsId-v2026-01-01_Response_200"},"ReportsPayrollCyclesCycleIdGrossToNetGetResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code."},"message":{"type":"string","description":"Human-readable explanation of the server error."}},"title":"ReportsPayrollCyclesCycleIdGrossToNetGetResponsesContentApplicationJsonSchemaErrorsItems"},"GetsG2NReportDataForAGivenPayrollCycleByItsId-v2026-01-01RequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ReportsPayrollCyclesCycleIdGrossToNetGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"GetsG2NReportDataForAGivenPayrollCycleByItsId-v2026-01-01RequestBadRequestError"},"GetsG2NReportDataForAGivenPayrollCycleByItsId-v2026-01-01RequestNotFoundError":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code."},"message":{"type":"string","description":"Error message explaining the resource was not found."}},"title":"GetsG2NReportDataForAGivenPayrollCycleByItsId-v2026-01-01RequestNotFoundError"},"GetsG2NReportDataForAGivenPayrollCycleByItsId-v2026-01-01RequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ReportsPayrollCyclesCycleIdGrossToNetGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"GetsG2NReportDataForAGivenPayrollCycleByItsId-v2026-01-01RequestInternalServerError"},"GpReportsIdGrossToNetGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"type":{"type":"string","description":"Cell type used for rendering/formatting."},"label":{"type":"string","description":"Human-readable label of the column for this cell."},"compareValue":{"description":"Raw value for the comparison period, if applicable."},"currentValue":{"description":"Raw value for the current period. Type varies by column (string/number/null/etc)."},"percentageDiff":{"description":"Percentage difference between current and comparison values, if applicable."},"formattedCurrentValue":{"description":"Formatted value for display purposes."}},"required":["type","label"],"description":"A cell value object for a given column.","title":"GpReportsIdGrossToNetGetResponsesContentApplicationJsonSchemaDataItems"},"GpReportsIdGrossToNetGetResponsesContentApplicationJsonSchemaPage":{"type":"object","properties":{"limit":{"type":"number","format":"double","description":"Maximum number of rows returned per page."},"offset":{"type":"number","format":"double","description":"Zero-based offset of the first returned row."},"total_rows":{"type":"number","format":"double","description":"Total number of rows available across all pages."}},"required":["limit","offset","total_rows"],"description":"Pagination metadata for the report rows.","title":"GpReportsIdGrossToNetGetResponsesContentApplicationJsonSchemaPage"},"reports_getGPReportGrossToNet_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/GpReportsIdGrossToNetGetResponsesContentApplicationJsonSchemaDataItems"}},"description":"List of report rows (summary rows are filtered out). Each row contains dynamic column keys mapped to cell objects."},"page":{"$ref":"#/components/schemas/GpReportsIdGrossToNetGetResponsesContentApplicationJsonSchemaPage","description":"Pagination metadata for the report rows."}},"required":["data","page"],"title":"reports_getGPReportGrossToNet_Response_200"},"GpReportsIdGrossToNetGetResponsesContentApplicationJsonSchemaErrorsItems":{"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":"GpReportsIdGrossToNetGetResponsesContentApplicationJsonSchemaErrorsItems"},"GpReportsIdGrossToNetGetResponsesContentApplicationJsonSchemaRequest":{"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":"GpReportsIdGrossToNetGetResponsesContentApplicationJsonSchemaRequest"},"ListGrossToNetReportRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/GpReportsIdGrossToNetGetResponsesContentApplicationJsonSchemaErrorsItems"}},"request":{"$ref":"#/components/schemas/GpReportsIdGrossToNetGetResponsesContentApplicationJsonSchemaRequest"}},"title":"ListGrossToNetReportRequestBadRequestError"},"GpLegalEntitiesLegalEntityIdReportsGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier for the payroll event."},"status":{"type":"string","description":"Status of the payroll event (e.g., OPEN, CLOSED)."},"end_date":{"type":"string","format":"date-time","description":"End date of the payroll event in ISO-8601 format."},"lock_date":{"type":["string","null"],"format":"date-time","description":"Date when the payroll event is locked, in ISO-8601 format."},"start_date":{"type":"string","format":"date-time","description":"Start date of the payroll event in ISO-8601 format."}},"required":["id","status","end_date","start_date"],"title":"GpLegalEntitiesLegalEntityIdReportsGetResponsesContentApplicationJsonSchemaDataItems"},"reports_getGPLegalEntityReports_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/GpLegalEntitiesLegalEntityIdReportsGetResponsesContentApplicationJsonSchemaDataItems"}}},"required":["data"],"title":"reports_getGPLegalEntityReports_Response_200"},"GpLegalEntitiesLegalEntityIdReportsGetResponsesContentApplicationJsonSchemaErrorsItems":{"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":"GpLegalEntitiesLegalEntityIdReportsGetResponsesContentApplicationJsonSchemaErrorsItems"},"GpLegalEntitiesLegalEntityIdReportsGetResponsesContentApplicationJsonSchemaRequest":{"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":"GpLegalEntitiesLegalEntityIdReportsGetResponsesContentApplicationJsonSchemaRequest"},"ListPayrollEventsByLegalEntityRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/GpLegalEntitiesLegalEntityIdReportsGetResponsesContentApplicationJsonSchemaErrorsItems"}},"request":{"$ref":"#/components/schemas/GpLegalEntitiesLegalEntityIdReportsGetResponsesContentApplicationJsonSchemaRequest"}},"title":"ListPayrollEventsByLegalEntityRequestBadRequestError"},"ScreeningsManualVerificationPostRequestBodyContentMultipartFormDataSchemaDocumentType":{"type":"string","enum":["PASSPORT","DRIVING_LICENSE","GOVERNMENT_ID","OTHER"],"description":"The type of document to be verified","title":"ScreeningsManualVerificationPostRequestBodyContentMultipartFormDataSchemaDocumentType"},"ScreeningsManualVerificationPostRequestBodyContentMultipartFormDataSchemaOperationType":{"type":"string","enum":["IDENTITY_RESUBMISSION_KYC","IDENTITY_VERIFICATION_KYC","NAME_CHANGE_KYC"],"description":"The type of KYC operation to perform","title":"ScreeningsManualVerificationPostRequestBodyContentMultipartFormDataSchemaOperationType"},"ScreeningsManualVerificationPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"created_at":{"type":"string","format":"date-time","description":"Timestamp when screening was successfully received and processed (ISO 8601)"},"request_id":{"type":"string","description":"Unique request identifier"}},"required":["created_at","request_id"],"title":"ScreeningsManualVerificationPostResponsesContentApplicationJsonSchemaData"},"screenings_createManualVerification_Response_201":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ScreeningsManualVerificationPostResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"screenings_createManualVerification_Response_201"},"CreateManualVerificationScreeningRequestBadRequestError":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string","description":"Human-readable error message"}},"required":["code","message"],"title":"CreateManualVerificationScreeningRequestBadRequestError"},"CreateManualVerificationScreeningRequestConflictError":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"}},"required":["code","message"],"title":"CreateManualVerificationScreeningRequestConflictError"},"VeriffSessionPostRequestBodyContentApplicationJsonSchemaDataUserInput":{"type":"object","properties":{"last_name":{"type":"string","description":"The desired last name of the user"},"first_name":{"type":"string","description":"The desired first name of the user"},"middle_name":{"type":["string","null"],"description":"The desired middle name of the user"}},"required":["last_name","first_name"],"description":"Input data for the name change KYC operation","title":"VeriffSessionPostRequestBodyContentApplicationJsonSchemaDataUserInput"},"VeriffSessionPostRequestBodyContentApplicationJsonSchemaDataOperationType":{"type":"string","enum":["IDENTITY_RESUBMISSION_KYC","IDENTITY_VERIFICATION_KYC","NAME_CHANGE_KYC","EMAIL_CHANGE_KYC"],"description":"The type of KYC operation to perform","title":"VeriffSessionPostRequestBodyContentApplicationJsonSchemaDataOperationType"},"VeriffSessionPostRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"user_input":{"$ref":"#/components/schemas/VeriffSessionPostRequestBodyContentApplicationJsonSchemaDataUserInput","description":"Input data for the name change KYC operation"},"operation_type":{"$ref":"#/components/schemas/VeriffSessionPostRequestBodyContentApplicationJsonSchemaDataOperationType","description":"The type of KYC operation to perform"}},"required":["operation_type"],"title":"VeriffSessionPostRequestBodyContentApplicationJsonSchemaData"},"VeriffSessionPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"url":{"type":"string","description":"The URL of the Veriff session"}},"required":["url"],"title":"VeriffSessionPostResponsesContentApplicationJsonSchemaData"},"screenings_createVeriffSession_Response_201":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/VeriffSessionPostResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"screenings_createVeriffSession_Response_201"},"ScreeningsAmlEntityTypeEntityIdGetParametersEntityType":{"type":"string","enum":["profile","hris_profile","legal_entity"],"title":"ScreeningsAmlEntityTypeEntityIdGetParametersEntityType"},"ScreeningsAmlEntityTypeEntityIdGetResponsesContentApplicationJsonSchemaResult":{"type":"string","enum":["ACCEPT","REJECT","REFERRED","PENDING"],"description":"The result of the screening. ACCEPT means the screening passed, REJECT means it failed, and REFERRED means it is pending further review.","title":"ScreeningsAmlEntityTypeEntityIdGetResponsesContentApplicationJsonSchemaResult"},"ScreeningsAmlEntityTypeEntityIdGetResponsesContentApplicationJsonSchemaEntityType":{"type":"string","enum":["profile","hris_profile","legal_entity"],"description":"The type of entity being screened.","title":"ScreeningsAmlEntityTypeEntityIdGetResponsesContentApplicationJsonSchemaEntityType"},"ScreeningsAmlEntityTypeEntityIdGetResponsesContentApplicationJsonSchemaDetailedResultsPep":{"type":"string","enum":["PASS","FAIL"],"description":"The result of the PEP (Politically Exposed Person) check.","title":"ScreeningsAmlEntityTypeEntityIdGetResponsesContentApplicationJsonSchemaDetailedResultsPep"},"ScreeningsAmlEntityTypeEntityIdGetResponsesContentApplicationJsonSchemaDetailedResultsSanctions":{"type":"string","enum":["PASS","FAIL"],"description":"The result of the sanctions check.","title":"ScreeningsAmlEntityTypeEntityIdGetResponsesContentApplicationJsonSchemaDetailedResultsSanctions"},"ScreeningsAmlEntityTypeEntityIdGetResponsesContentApplicationJsonSchemaDetailedResultsAdverseMedia":{"type":"string","enum":["PASS","FAIL"],"description":"The result of the adverse media check.","title":"ScreeningsAmlEntityTypeEntityIdGetResponsesContentApplicationJsonSchemaDetailedResultsAdverseMedia"},"ScreeningsAmlEntityTypeEntityIdGetResponsesContentApplicationJsonSchemaDetailedResults":{"type":"object","properties":{"pep":{"$ref":"#/components/schemas/ScreeningsAmlEntityTypeEntityIdGetResponsesContentApplicationJsonSchemaDetailedResultsPep","description":"The result of the PEP (Politically Exposed Person) check."},"sanctions":{"$ref":"#/components/schemas/ScreeningsAmlEntityTypeEntityIdGetResponsesContentApplicationJsonSchemaDetailedResultsSanctions","description":"The result of the sanctions check."},"adverse_media":{"$ref":"#/components/schemas/ScreeningsAmlEntityTypeEntityIdGetResponsesContentApplicationJsonSchemaDetailedResultsAdverseMedia","description":"The result of the adverse media check."}},"description":"Details of checks performed for this screening.","title":"ScreeningsAmlEntityTypeEntityIdGetResponsesContentApplicationJsonSchemaDetailedResults"},"screenings_getAMLDetails_Response_200":{"type":"object","properties":{"result":{"$ref":"#/components/schemas/ScreeningsAmlEntityTypeEntityIdGetResponsesContentApplicationJsonSchemaResult","description":"The result of the screening. ACCEPT means the screening passed, REJECT means it failed, and REFERRED means it is pending further review."},"entity_id":{"type":"string","description":"UUID of the entity."},"entity_type":{"$ref":"#/components/schemas/ScreeningsAmlEntityTypeEntityIdGetResponsesContentApplicationJsonSchemaEntityType","description":"The type of entity being screened."},"detailed_results":{"$ref":"#/components/schemas/ScreeningsAmlEntityTypeEntityIdGetResponsesContentApplicationJsonSchemaDetailedResults","description":"Details of checks performed for this screening."}},"required":["result","entity_id","entity_type","detailed_results"],"title":"screenings_getAMLDetails_Response_200"},"ScreeningsAmlEntityTypeEntityIdGetResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"message":{"type":"string","description":"A description of the returned error"}},"title":"ScreeningsAmlEntityTypeEntityIdGetResponsesContentApplicationJsonSchemaErrorsItems"},"AmlApiForWhitelabelDataRetrieval-v2026-01-01RequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ScreeningsAmlEntityTypeEntityIdGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"AmlApiForWhitelabelDataRetrieval-v2026-01-01RequestBadRequestError"},"AmlApiForWhitelabelDataRetrieval-v2026-01-01RequestNotFoundError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ScreeningsAmlEntityTypeEntityIdGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"AmlApiForWhitelabelDataRetrieval-v2026-01-01RequestNotFoundError"},"ScreeningsVerificationMethodGetParametersDocumentType":{"type":"string","enum":["passport","government_id","driving_license","other"],"title":"ScreeningsVerificationMethodGetParametersDocumentType"},"ScreeningsVerificationMethodGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"verification_method":{"type":"string","description":"The supported method for KYC"}},"required":["verification_method"],"title":"ScreeningsVerificationMethodGetResponsesContentApplicationJsonSchemaData"},"screenings_getVerificationMethod_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ScreeningsVerificationMethodGetResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"screenings_getVerificationMethod_Response_200"},"ScreeningsKycDetailsGetResponsesContentApplicationJsonSchemaDataKycStatus":{"type":"string","enum":["APPROVED","REJECTED","PENDING_REVIEW","EXPIRED","EXPIRING_SOON","NOT_SUBMITTED","NOT_REQUESTED"],"description":"The current KYC verification status of the profile","title":"ScreeningsKycDetailsGetResponsesContentApplicationJsonSchemaDataKycStatus"},"ScreeningsKycDetailsGetResponsesContentApplicationJsonSchemaDataIdentityDocumentType":{"type":"string","enum":["DRIVING_LICENSE","PASSPORT","GOVERNMENT_ID","SELFIE_WITH_ID","PROOF_OF_RESIDENCY","OTHER"],"description":"The type of identity document used for verification","title":"ScreeningsKycDetailsGetResponsesContentApplicationJsonSchemaDataIdentityDocumentType"},"ScreeningsKycDetailsGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"created_at":{"type":["string","null"],"format":"date-time","description":"The date and time when the KYC screening was created"},"kyc_status":{"$ref":"#/components/schemas/ScreeningsKycDetailsGetResponsesContentApplicationJsonSchemaDataKycStatus","description":"The current KYC verification status of the profile"},"updated_at":{"type":["string","null"],"format":"date-time","description":"The date and time when the KYC screening was last updated"},"approval_date":{"type":["string","null"],"format":"date-time","description":"The date and time when the KYC screening was approved (null if not approved)"},"rejection_date":{"type":["string","null"],"format":"date-time","description":"The date and time when the KYC screening was rejected (null if not rejected or pending review for Veriff)"},"expiration_date":{"type":["string","null"],"format":"date-time","description":"The date and time when the KYC screening expires (null if no expiry)"},"submission_date":{"type":["string","null"],"format":"date-time","description":"The date and time when the KYC screening was submitted"},"identity_document_name":{"type":["string","null"],"description":"The name of the identity document used for verification (in case of other document type)"},"identity_document_type":{"oneOf":[{"$ref":"#/components/schemas/ScreeningsKycDetailsGetResponsesContentApplicationJsonSchemaDataIdentityDocumentType"},{"type":"null"}],"description":"The type of identity document used for verification"},"identity_document_number":{"type":["string","null"],"description":"Number of the submitted document"},"document_extracted_last_name":{"type":["string","null"],"description":"The last name extracted from the submitted document"},"document_extracted_first_name":{"type":["string","null"],"description":"The first name extracted from the submitted document"},"document_extracted_middle_name":{"type":["string","null"],"description":"The middle name extracted from the submitted document"}},"required":["created_at","kyc_status","updated_at","approval_date","rejection_date","expiration_date","submission_date","identity_document_type","document_extracted_middle_name"],"title":"ScreeningsKycDetailsGetResponsesContentApplicationJsonSchemaData"},"screenings_getKYCDetails_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ScreeningsKycDetailsGetResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"screenings_getKYCDetails_Response_200"},"ScreeningsKycDetailsGetResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code"},"message":{"type":"string","description":"Human-readable explanation of the error"}},"title":"ScreeningsKycDetailsGetResponsesContentApplicationJsonSchemaErrorsItems"},"GetWorkersKycDetailsRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ScreeningsKycDetailsGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"GetWorkersKycDetailsRequestBadRequestError"},"GetWorkersKycDetailsRequestForbiddenError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ScreeningsKycDetailsGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"GetWorkersKycDetailsRequestForbiddenError"},"GetWorkersKycDetailsRequestNotFoundError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ScreeningsKycDetailsGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"GetWorkersKycDetailsRequestNotFoundError"},"GetWorkersKycDetailsRequestConflictError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ScreeningsKycDetailsGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"GetWorkersKycDetailsRequestConflictError"},"ScreeningsKycExternalPostRequestBodyContentMultipartFormDataSchemaDataKycDocumentType":{"type":"string","enum":["passport","driving_license","government_id","other"],"description":"Type of KYC document (e.g., passport, driver's license)","title":"ScreeningsKycExternalPostRequestBodyContentMultipartFormDataSchemaDataKycDocumentType"},"ScreeningsKycExternalPostRequestBodyContentMultipartFormDataSchemaDataKycDocument":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/ScreeningsKycExternalPostRequestBodyContentMultipartFormDataSchemaDataKycDocumentType","description":"Type of KYC document (e.g., passport, driver's license)"},"id_number":{"type":"string","description":"Document identification number"},"document_name":{"type":"string","description":"Name of the document when type is 'other'"},"issuance_date":{"type":"string","format":"date","description":"Date when the document was issued (YYYY-MM-DD)"},"expiration_date":{"type":"string","format":"date","description":"Expiry date of the document (YYYY-MM-DD)"},"issuance_country":{"type":"string","description":"Country where the document was issued (ISO 3166‑1 alpha‑2)"}},"required":["type","id_number","issuance_country"],"title":"ScreeningsKycExternalPostRequestBodyContentMultipartFormDataSchemaDataKycDocument"},"ScreeningsKycExternalPostRequestBodyContentMultipartFormDataSchemaDataScreeningType":{"type":"string","enum":["live","manual"],"description":"Tells your API whether the identity verification check should be performed automatically (“live”) or via human review (“manual”)","title":"ScreeningsKycExternalPostRequestBodyContentMultipartFormDataSchemaDataScreeningType"},"ScreeningsKycExternalPostRequestBodyContentMultipartFormDataSchemaDataScreeningStatus":{"type":"string","enum":["approved","rejected"],"description":"The result of the screening process","title":"ScreeningsKycExternalPostRequestBodyContentMultipartFormDataSchemaDataScreeningStatus"},"ScreeningsKycExternalPostRequestBodyContentMultipartFormDataSchemaData":{"type":"object","properties":{"back":{"type":"string","format":"binary","description":"Back side file of the KYC document. Required when kyc_document.type equals to either 'driving_license' or 'government_id'. Not needed when equals to 'passport'. Optional when type is 'other'"},"front":{"type":"string","format":"binary","description":"Front side file of the KYC document"},"last_name":{"type":"string","description":"Worker's last name"},"first_name":{"type":"string","description":"Worker's first name"},"middle_name":{"type":["string","null"],"description":"Worker's middle name (if available)"},"kyc_document":{"$ref":"#/components/schemas/ScreeningsKycExternalPostRequestBodyContentMultipartFormDataSchemaDataKycDocument"},"date_of_birth":{"type":"string","format":"date","description":"Worker's date of birth (YYYY-MM-DD)"},"screening_type":{"$ref":"#/components/schemas/ScreeningsKycExternalPostRequestBodyContentMultipartFormDataSchemaDataScreeningType","description":"Tells your API whether the identity verification check should be performed automatically (“live”) or via human review (“manual”)"},"selfie_with_id":{"type":"string","format":"binary","description":"Selfie file for identity verification"},"screening_status":{"$ref":"#/components/schemas/ScreeningsKycExternalPostRequestBodyContentMultipartFormDataSchemaDataScreeningStatus","description":"The result of the screening process"}},"required":["front","last_name","first_name","kyc_document","date_of_birth","screening_type","selfie_with_id","screening_status"],"title":"ScreeningsKycExternalPostRequestBodyContentMultipartFormDataSchemaData"},"ScreeningsKycExternalPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"created_at":{"type":"string","format":"date-time","description":"Timestamp when screening was successfully received and processed (ISO 8601)"},"request_id":{"type":"string","description":"Request identifier for this KYC submission"}},"required":["created_at","request_id"],"title":"ScreeningsKycExternalPostResponsesContentApplicationJsonSchemaData"},"Screenings_submitExternalKyc_Response_201":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ScreeningsKycExternalPostResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"Screenings_submitExternalKyc_Response_201"},"ScreeningsKycExternalPostResponsesContentApplicationJsonSchemaErrorsItems":{"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":"ScreeningsKycExternalPostResponsesContentApplicationJsonSchemaErrorsItems"},"ScreeningsKycExternalPostResponsesContentApplicationJsonSchemaRequest":{"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":"ScreeningsKycExternalPostResponsesContentApplicationJsonSchemaRequest"},"SubmitExternalKycRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ScreeningsKycExternalPostResponsesContentApplicationJsonSchemaErrorsItems"}},"request":{"$ref":"#/components/schemas/ScreeningsKycExternalPostResponsesContentApplicationJsonSchemaRequest"}},"title":"SubmitExternalKycRequestBadRequestError"},"AuthenticationScheme":{"type":"object","properties":{"description":{"type":"string"},"documentationUrl":{"type":"string"},"name":{"type":"string"},"specUrl":{"type":"string"}},"title":"AuthenticationScheme"},"AuthenticationSchemes":{"type":"object","properties":{"authenticationSchemes":{"type":"array","items":{"$ref":"#/components/schemas/AuthenticationScheme"}}},"title":"AuthenticationSchemes"},"BulkSupported":{"type":"object","properties":{"maxOperations":{"type":"integer"},"maxPayloadSize":{"type":"integer"},"supported":{"type":"boolean","default":false}},"title":"BulkSupported"},"Supported":{"type":"object","properties":{"supported":{"type":"boolean","default":false}},"title":"Supported"},"FilterSupported":{"type":"object","properties":{"maxResults":{"type":"integer"},"supported":{"type":"boolean","default":false}},"title":"FilterSupported"},"ServiceProviderConfigSchemasItems":{"type":"string","enum":["urn:ietf:params:scim:schemas:core:2.0:ServiceProviderConfig"],"title":"ServiceProviderConfigSchemasItems"},"ServiceProviderConfig":{"type":"object","properties":{"authenticationSchemes":{"$ref":"#/components/schemas/AuthenticationSchemes"},"bulk":{"$ref":"#/components/schemas/BulkSupported"},"changePassword":{"$ref":"#/components/schemas/Supported"},"etag":{"$ref":"#/components/schemas/Supported"},"filter":{"$ref":"#/components/schemas/FilterSupported"},"patch":{"$ref":"#/components/schemas/Supported"},"schemas":{"type":"array","items":{"$ref":"#/components/schemas/ServiceProviderConfigSchemasItems"}},"sort":{"$ref":"#/components/schemas/Supported"},"xmlDataFormat":{"$ref":"#/components/schemas/Supported"}},"title":"ServiceProviderConfig"},"ContractsContractIdTasksPostRequestBodyContentApplicationJsonSchemaDataDateSubmitted":{"oneOf":[{"type":"string","format":"date"},{"type":"string","format":"date-time"}],"description":"The date the task was submitted, in ISO 8601 format. Also accepts date-time (YYYY-MM-DDTHH:MM:SSZ).","title":"ContractsContractIdTasksPostRequestBodyContentApplicationJsonSchemaDataDateSubmitted"},"ContractsContractIdTasksPostRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"amount":{"type":"string","description":"The amount to be associated with the task, in the appropriate currency."},"description":{"type":["string","null"],"description":"A description of the task."},"date_submitted":{"$ref":"#/components/schemas/ContractsContractIdTasksPostRequestBodyContentApplicationJsonSchemaDataDateSubmitted","description":"The date the task was submitted, in ISO 8601 format. Also accepts date-time (YYYY-MM-DDTHH:MM:SSZ)."},"is_auto_approved":{"type":"boolean","description":"If true, the task will be automatically approved as part of the request."}},"required":["amount","description","date_submitted"],"title":"ContractsContractIdTasksPostRequestBodyContentApplicationJsonSchemaData"},"ContractsContractIdTasksPostResponsesContentApplicationJsonSchemaDataStatus":{"type":"string","enum":["approved","declined","not_payable","paid","pending","processing"],"description":"The current status of the task.","title":"ContractsContractIdTasksPostResponsesContentApplicationJsonSchemaDataStatus"},"ContractsContractIdTasksPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier for the created task."},"status":{"oneOf":[{"$ref":"#/components/schemas/ContractsContractIdTasksPostResponsesContentApplicationJsonSchemaDataStatus"},{"type":"null"}],"description":"The current status of the task."},"created":{"type":"boolean","description":"Indicates whether the task creation operation was successful."}},"title":"ContractsContractIdTasksPostResponsesContentApplicationJsonSchemaData"},"tasks_createContractTask_Response_201":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ContractsContractIdTasksPostResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"tasks_createContractTask_Response_201"},"CreateANewTaskRequestBadRequestError":{"type":"object","properties":{"error":{"type":"string"}},"title":"CreateANewTaskRequestBadRequestError"},"CreateANewTaskRequestUnauthorizedError":{"type":"object","properties":{"error":{"type":"string"}},"title":"CreateANewTaskRequestUnauthorizedError"},"CreateANewTaskRequestInternalServerError":{"type":"object","properties":{"error":{"type":"string"}},"title":"CreateANewTaskRequestInternalServerError"},"ContractsContractIdTasksTaskIdDeleteResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"deleted":{"type":"boolean","description":"Indicates whether the task was successfully deleted."}},"required":["deleted"],"title":"ContractsContractIdTasksTaskIdDeleteResponsesContentApplicationJsonSchemaData"},"tasks_deleteContractTask_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ContractsContractIdTasksTaskIdDeleteResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"tasks_deleteContractTask_Response_200"},"ContractsContractIdTasksGetResponsesContentApplicationJsonSchemaDataItemsStatus":{"type":"string","enum":["approved","declined","not_payable","paid","pending","processing"],"description":"The current status of the task.","title":"ContractsContractIdTasksGetResponsesContentApplicationJsonSchemaDataItemsStatus"},"ContractsContractIdTasksGetResponsesContentApplicationJsonSchemaDataItemsAttachment":{"type":"object","properties":{"key":{"type":["string","null"],"description":"(Optional) The key for accessing the attachment."},"filename":{"type":["string","null"],"description":"(Optional) The name of the file attached to the task."}},"title":"ContractsContractIdTasksGetResponsesContentApplicationJsonSchemaDataItemsAttachment"},"ContractsContractIdTasksGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier for the task."},"amount":{"type":"string","description":"The monetary amount associated with the task."},"status":{"oneOf":[{"$ref":"#/components/schemas/ContractsContractIdTasksGetResponsesContentApplicationJsonSchemaDataItemsStatus"},{"type":"null"}],"description":"The current status of the task."},"attachment":{"$ref":"#/components/schemas/ContractsContractIdTasksGetResponsesContentApplicationJsonSchemaDataItemsAttachment"},"description":{"type":"string","description":"(Required) A brief description of the task."},"date_submitted":{"type":"string","description":"(Required) The date when the task was submitted."}},"required":["id","amount","status","description","date_submitted"],"title":"ContractsContractIdTasksGetResponsesContentApplicationJsonSchemaDataItems"},"tasks_getContractTasks_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ContractsContractIdTasksGetResponsesContentApplicationJsonSchemaDataItems"}}},"required":["data"],"title":"tasks_getContractTasks_Response_200"},"ContractsContractIdTasksTaskIdReviewsPostRequestBodyContentApplicationJsonSchemaDataStatus":{"type":"string","enum":["approved","declined"],"description":"The review status of the task. Possible values are 'approved' or 'declined'.","title":"ContractsContractIdTasksTaskIdReviewsPostRequestBodyContentApplicationJsonSchemaDataStatus"},"ContractsContractIdTasksTaskIdReviewsPostRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"reason":{"type":["string","null"],"description":"Optional reason for declining the task."},"status":{"$ref":"#/components/schemas/ContractsContractIdTasksTaskIdReviewsPostRequestBodyContentApplicationJsonSchemaDataStatus","description":"The review status of the task. Possible values are 'approved' or 'declined'."}},"required":["status"],"title":"ContractsContractIdTasksTaskIdReviewsPostRequestBodyContentApplicationJsonSchemaData"},"ContractsContractIdTasksTaskIdReviewsPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"created":{"type":"boolean","description":"Indicating whether the task review was created"}},"required":["created"],"title":"ContractsContractIdTasksTaskIdReviewsPostResponsesContentApplicationJsonSchemaData"},"tasks_createContractTaskReview_Response_201":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ContractsContractIdTasksTaskIdReviewsPostResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"tasks_createContractTaskReview_Response_201"},"ReviewASingleTaskRequestBadRequestError":{"type":"object","properties":{"error":{"type":"string"}},"title":"ReviewASingleTaskRequestBadRequestError"},"ReviewASingleTaskRequestUnauthorizedError":{"type":"object","properties":{"error":{"type":"string"}},"title":"ReviewASingleTaskRequestUnauthorizedError"},"ReviewASingleTaskRequestNotFoundError":{"type":"object","properties":{"error":{"type":"string"}},"title":"ReviewASingleTaskRequestNotFoundError"},"ReviewASingleTaskRequestInternalServerError":{"type":"object","properties":{"error":{"type":"string"}},"title":"ReviewASingleTaskRequestInternalServerError"},"ContractsContractIdTasksManyReviewsPostRequestBodyContentApplicationJsonSchemaDataStatus":{"type":"string","enum":["approved","declined"],"description":"The review status of the tasks. Possible values are 'approved' or 'declined'.","title":"ContractsContractIdTasksManyReviewsPostRequestBodyContentApplicationJsonSchemaDataStatus"},"ContractsContractIdTasksManyReviewsPostRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"ids":{"type":"array","items":{"type":"string","format":"uuid"},"description":"An array of task IDs to review. A maximum of 1000 task IDs is allowed per request."},"reason":{"type":["string","null"],"description":"Optional reason for declining the tasks."},"status":{"$ref":"#/components/schemas/ContractsContractIdTasksManyReviewsPostRequestBodyContentApplicationJsonSchemaDataStatus","description":"The review status of the tasks. Possible values are 'approved' or 'declined'."}},"required":["ids","status"],"title":"ContractsContractIdTasksManyReviewsPostRequestBodyContentApplicationJsonSchemaData"},"ContractsContractIdTasksManyReviewsPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"created":{"type":"boolean","description":"Indicating whether the task review was created"}},"required":["created"],"title":"ContractsContractIdTasksManyReviewsPostResponsesContentApplicationJsonSchemaData"},"Tasks_reviewMultipleTasks_Response_201":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ContractsContractIdTasksManyReviewsPostResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"Tasks_reviewMultipleTasks_Response_201"},"ReviewMultipleTasksRequestBadRequestError":{"type":"object","properties":{"error":{"type":"string"}},"title":"ReviewMultipleTasksRequestBadRequestError"},"ReviewMultipleTasksRequestUnauthorizedError":{"type":"object","properties":{"error":{"type":"string"}},"title":"ReviewMultipleTasksRequestUnauthorizedError"},"ReviewMultipleTasksRequestNotFoundError":{"type":"object","properties":{"error":{"type":"string"}},"title":"ReviewMultipleTasksRequestNotFoundError"},"ReviewMultipleTasksRequestInternalServerError":{"type":"object","properties":{"error":{"type":"string"}},"title":"ReviewMultipleTasksRequestInternalServerError"},"TasksTaskIdPatchRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"amount":{"type":["string","null"],"description":"The amount to be associated with the task, in the appropriate currency."},"description":{"type":["string","null"],"description":"A description of the task."},"hourly_report_preset_id":{"type":["string","null"],"description":"Public ID of the hourly report preset, if applicable."}},"title":"TasksTaskIdPatchRequestBodyContentApplicationJsonSchemaData"},"TasksTaskIdPatchResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"created_at":{"type":"string","format":"date-time","description":"Timestamp indicating when the task was last updated."},"updated_at":{"type":"string","format":"date-time","description":"Timestamp indicating when the task was last updated."}},"required":["created_at","updated_at"],"title":"TasksTaskIdPatchResponsesContentApplicationJsonSchemaData"},"Tasks_updateTaskById_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/TasksTaskIdPatchResponsesContentApplicationJsonSchemaData"}},"title":"Tasks_updateTaskById_Response_200"},"TasksTaskIdPatchResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code"},"message":{"type":"string","description":"Human-readable explanation of the error"}},"title":"TasksTaskIdPatchResponsesContentApplicationJsonSchemaErrorsItems"},"UpdateTaskByIdRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/TasksTaskIdPatchResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"UpdateTaskByIdRequestBadRequestError"},"UpdateTaskByIdRequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/TasksTaskIdPatchResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"UpdateTaskByIdRequestInternalServerError"},"terminations_deleteContractTermination_Response_204":{"type":"object","properties":{},"description":"Empty response body","title":"terminations_deleteContractTermination_Response_204"},"ContractsContractIdTerminationsDeleteResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code"},"message":{"type":"string","description":"Human-readable explanation of the error"}},"title":"ContractsContractIdTerminationsDeleteResponsesContentApplicationJsonSchemaErrorsItems"},"DeleteContractTerminationRequestRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ContractsContractIdTerminationsDeleteResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"DeleteContractTerminationRequestRequestBadRequestError"},"DeleteContractTerminationRequestRequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ContractsContractIdTerminationsDeleteResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"DeleteContractTerminationRequestRequestInternalServerError"},"ContractsContractIdTerminationsPostRequestBodyContentApplicationJsonSchemaDataTerminationType":{"type":"string","enum":["RESIGNATION","TERMINATION","END_OF_CONTRACT"],"description":"The type of termination. Specifies whether it is a resignation (contractor-initiated), termination (client-initiated), or end of contract (mutual/planned).","title":"ContractsContractIdTerminationsPostRequestBodyContentApplicationJsonSchemaDataTerminationType"},"ContractsContractIdTerminationsPostRequestBodyContentApplicationJsonSchemaDataEligibleForRehire":{"type":"string","enum":["YES","NO","DONT_KNOW"],"description":"Indicates whether the contractor is eligible for rehire in the future.","title":"ContractsContractIdTerminationsPostRequestBodyContentApplicationJsonSchemaDataEligibleForRehire"},"ContractsContractIdTerminationsPostRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"message":{"type":"string","description":"Optional message to include with the termination"},"terminate_now":{"type":"boolean","default":false,"description":"If true, terminates the contract immediately. If false, completion_date is required."},"completion_date":{"type":"string","format":"date","description":"Contract completion date (YYYY-MM-DD). Required when terminate_now is false or not provided. Since terminate_now defaults to false, this field is required unless you explicitly set terminate_now to true."},"termination_type":{"$ref":"#/components/schemas/ContractsContractIdTerminationsPostRequestBodyContentApplicationJsonSchemaDataTerminationType","description":"The type of termination. Specifies whether it is a resignation (contractor-initiated), termination (client-initiated), or end of contract (mutual/planned)."},"eligible_for_rehire":{"$ref":"#/components/schemas/ContractsContractIdTerminationsPostRequestBodyContentApplicationJsonSchemaDataEligibleForRehire","description":"Indicates whether the contractor is eligible for rehire in the future."},"termination_reason_id":{"type":"string","format":"uuid","description":"The UUID of the termination reason. Use GET /termination_reasons/paginated to retrieve available reasons. Can be provided independently or with termination_reason_description."},"eligible_for_rehire_reason":{"type":"string","description":"Provides context when eligible_for_rehire is 'DONT_KNOW'. Should be empty or null for other values."},"termination_reason_description":{"type":"string","description":"Free-form text providing additional context about the termination reason. Can be provided independently without termination_reason_id, or used to add context to a selected reason."}},"description":"Termination data. At minimum, you must provide either terminate_now: true (for immediate termination) OR completion_date (for scheduled termination).","title":"ContractsContractIdTerminationsPostRequestBodyContentApplicationJsonSchemaData"},"ContractsContractIdTerminationsPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","description":"Contract id"},"completion_date":{"type":"string","format":"date-time","description":"Contract completion date"}},"title":"ContractsContractIdTerminationsPostResponsesContentApplicationJsonSchemaData"},"terminations_createContractTermination_Response_201":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ContractsContractIdTerminationsPostResponsesContentApplicationJsonSchemaData"}},"title":"terminations_createContractTermination_Response_201"},"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"},"TimeOffsGetParametersStatusSchemaItems":{"type":"string","enum":["REQUESTED","APPROVED","REJECTED","USED","CANCELED"],"title":"TimeOffsGetParametersStatusSchemaItems"},"TimeOffsGetResponsesContentApplicationJsonSchemaDataItemsStatus":{"type":"string","enum":["REQUESTED","APPROVED","REJECTED","USED","CANCELED"],"description":"Status of time off","title":"TimeOffsGetResponsesContentApplicationJsonSchemaDataItemsStatus"},"TimeOffsGetResponsesContentApplicationJsonSchemaDataItemsTimeOffTypePolicyPolicyType":{"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":"TimeOffsGetResponsesContentApplicationJsonSchemaDataItemsTimeOffTypePolicyPolicyType"},"TimeOffsGetResponsesContentApplicationJsonSchemaDataItemsTimeOffTypePolicy":{"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/TimeOffsGetResponsesContentApplicationJsonSchemaDataItemsTimeOffTypePolicyPolicyType"}},"required":["id","name","policy_type"],"title":"TimeOffsGetResponsesContentApplicationJsonSchemaDataItemsTimeOffTypePolicy"},"TimeOffsGetResponsesContentApplicationJsonSchemaDataItemsTimeOffType":{"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/TimeOffsGetResponsesContentApplicationJsonSchemaDataItemsTimeOffTypePolicy"}},"required":["id","name"],"title":"TimeOffsGetResponsesContentApplicationJsonSchemaDataItemsTimeOffType"},"TimeOffsGetResponsesContentApplicationJsonSchemaDataItemsEntitlementUnit":{"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":"TimeOffsGetResponsesContentApplicationJsonSchemaDataItemsEntitlementUnit"},"TimeOffsGetResponsesContentApplicationJsonSchemaDataItemsTimeOffDailiesItemsType":{"type":"string","enum":["WORKING_DAY","NON_WORKING_DAY","HOLIDAY"],"description":"Time off daily type","title":"TimeOffsGetResponsesContentApplicationJsonSchemaDataItemsTimeOffDailiesItemsType"},"TimeOffsGetResponsesContentApplicationJsonSchemaDataItemsTimeOffDailiesItems":{"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/TimeOffsGetResponsesContentApplicationJsonSchemaDataItemsTimeOffDailiesItemsType","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":"TimeOffsGetResponsesContentApplicationJsonSchemaDataItemsTimeOffDailiesItems"},"TimeOffsGetResponsesContentApplicationJsonSchemaDataItemsRecipientProfile":{"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":"TimeOffsGetResponsesContentApplicationJsonSchemaDataItemsRecipientProfile"},"TimeOffsGetResponsesContentApplicationJsonSchemaDataItemsRequesterProfile":{"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":"TimeOffsGetResponsesContentApplicationJsonSchemaDataItemsRequesterProfile"},"TimeOffsGetResponsesContentApplicationJsonSchemaDataItems":{"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/TimeOffsGetResponsesContentApplicationJsonSchemaDataItemsStatus","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"},"time_off_type":{"$ref":"#/components/schemas/TimeOffsGetResponsesContentApplicationJsonSchemaDataItemsTimeOffType"},"half_start_date":{"type":"boolean","description":"Is half start date"},"deduction_amount":{"type":["number","null"],"format":"double","description":"Deduction amount"},"entitlement_unit":{"$ref":"#/components/schemas/TimeOffsGetResponsesContentApplicationJsonSchemaDataItemsEntitlementUnit","description":"The unit in which the time off usage and entitlement are calculated."},"time_off_dailies":{"type":"array","items":{"$ref":"#/components/schemas/TimeOffsGetResponsesContentApplicationJsonSchemaDataItemsTimeOffDailiesItems"}},"time_off_type_id":{"type":"string","description":"Time off type id"},"recipient_profile":{"$ref":"#/components/schemas/TimeOffsGetResponsesContentApplicationJsonSchemaDataItemsRecipientProfile"},"requester_profile":{"$ref":"#/components/schemas/TimeOffsGetResponsesContentApplicationJsonSchemaDataItemsRequesterProfile"},"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":"TimeOffsGetResponsesContentApplicationJsonSchemaDataItems"},"Time Off_listTimeOffRequestsForOrganization_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/TimeOffsGetResponsesContentApplicationJsonSchemaDataItems"}},"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_listTimeOffRequestsForOrganization_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"},"TimeTrackingShiftRatesPostRequestBodyContentApplicationJsonSchemaDataType":{"type":"string","enum":["MULTIPLIER_PERCENTAGE","PER_HOUR_FLAT_RATE","PER_UNIT_FLAT_RATE"],"description":"The type of the shift rate.","title":"TimeTrackingShiftRatesPostRequestBodyContentApplicationJsonSchemaDataType"},"TimeTrackingShiftRatesPostRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"name":{"type":"string","description":"The name of the shift rate."},"type":{"$ref":"#/components/schemas/TimeTrackingShiftRatesPostRequestBodyContentApplicationJsonSchemaDataType","description":"The type of the shift rate."},"value":{"type":"number","format":"double","description":"The value of the shift rate."},"external_id":{"type":"string","description":"A unique identifier for the shift rate."}},"required":["name","external_id"],"title":"TimeTrackingShiftRatesPostRequestBodyContentApplicationJsonSchemaData"},"TimeTrackingShiftRatesPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"name":{"type":"string","description":"The name of the created shift rate."},"type":{"type":"string","description":"The type of the created shift rate."},"value":{"type":"number","format":"double","description":"The value of the created shift rate."},"external_id":{"type":"string","description":"The unique identifier of the created shift rate."}},"title":"TimeTrackingShiftRatesPostResponsesContentApplicationJsonSchemaData"},"time-tracking_createTimeTrackingShiftRate_Response_201":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/TimeTrackingShiftRatesPostResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"time-tracking_createTimeTrackingShiftRate_Response_201"},"time-tracking_deleteTimeTrackingShiftRateByExternalId_Response_204":{"type":"object","properties":{},"description":"Empty response body","title":"time-tracking_deleteTimeTrackingShiftRateByExternalId_Response_204"},"TimeTrackingTimesheetsUploadUrlPostRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"end_date":{"type":"string","format":"date","description":"End date of the timesheet period. Must be equal to or later than start_date."},"file_name":{"type":"string","description":"Name of the timesheet file. Must end with .csv extension."},"start_date":{"type":"string","format":"date","description":"Start date of the timesheet period. Must be equal to or earlier than end_date."},"contract_id":{"type":"string","description":"Id of the worker's contract associated with the timesheet"}},"required":["end_date","file_name","start_date","contract_id"],"title":"TimeTrackingTimesheetsUploadUrlPostRequestBodyContentApplicationJsonSchemaData"},"TimeTrackingTimesheetsUploadUrlPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the created timesheet"},"created_at":{"type":"string","format":"date-time","description":"Timestamp when the timesheet was created"},"updated_at":{"type":"string","format":"date-time","description":"Timestamp when the timesheet was last updated"},"upload_url":{"type":"string","format":"uri","description":"Pre-signed S3 URL for uploading the timesheet file"},"upload_fields":{"type":"object","additionalProperties":{"description":"Any type"},"description":"Form fields required for the multipart POST upload to S3. Include these fields alongside the file in the upload request."}},"required":["id","created_at","updated_at","upload_url","upload_fields"],"title":"TimeTrackingTimesheetsUploadUrlPostResponsesContentApplicationJsonSchemaData"},"time-tracking_getTimeTrackingTimesheetsUploadUrl_Response_201":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/TimeTrackingTimesheetsUploadUrlPostResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"time-tracking_getTimeTrackingTimesheetsUploadUrl_Response_201"},"TimeTrackingTimesheetsUploadUrlPostResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code"},"field":{"type":"string","description":"Name of the field causing the error (for validation issues)"},"message":{"type":"string","description":"Human-readable explanation of the error"}},"required":["code","field","message"],"title":"TimeTrackingTimesheetsUploadUrlPostResponsesContentApplicationJsonSchemaErrorsItems"},"GenerateTimesheetUploadUrl-v2026-01-01RequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/TimeTrackingTimesheetsUploadUrlPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"GenerateTimesheetUploadUrl-v2026-01-01RequestBadRequestError"},"GenerateTimesheetUploadUrl-v2026-01-01RequestNotFoundError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/TimeTrackingTimesheetsUploadUrlPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"GenerateTimesheetUploadUrl-v2026-01-01RequestNotFoundError"},"GenerateTimesheetUploadUrl-v2026-01-01RequestUnprocessableEntityError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/TimeTrackingTimesheetsUploadUrlPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"GenerateTimesheetUploadUrl-v2026-01-01RequestUnprocessableEntityError"},"TimeTrackingShiftRatesGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"name":{"type":"string","description":"Name of the shift rate."},"type":{"type":"string","description":"Type of the shift rate (e.g., MULTIPLIER_PERCENTAGE or FLAT_RATE)."},"value":{"type":"number","format":"double","description":"The value associated with the shift rate."},"created_at":{"type":"string","description":"Timestamp indicating when the shift rate was created."},"updated_at":{"type":"string","description":"Timestamp indicating when the shift rate was last updated."},"external_id":{"type":"string","description":"External identifier of the shift rate."}},"required":["name","type","value","created_at","updated_at","external_id"],"title":"TimeTrackingShiftRatesGetResponsesContentApplicationJsonSchemaDataItems"},"TimeTrackingShiftRatesGetResponsesContentApplicationJsonSchemaPage":{"type":"object","properties":{"offset":{"type":"integer","description":"The offset/index for the current page of records."},"total_rows":{"type":"integer","description":"Total number of shift rates available in the dataset."},"items_per_page":{"type":"integer","description":"The number of items returned per page."}},"required":["offset","total_rows","items_per_page"],"title":"TimeTrackingShiftRatesGetResponsesContentApplicationJsonSchemaPage"},"time-tracking_getTimeTrackingShiftRates_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/TimeTrackingShiftRatesGetResponsesContentApplicationJsonSchemaDataItems"}},"page":{"$ref":"#/components/schemas/TimeTrackingShiftRatesGetResponsesContentApplicationJsonSchemaPage"}},"required":["data","page"],"title":"time-tracking_getTimeTrackingShiftRates_Response_200"},"TimeTrackingShiftRatesExternalIdGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"name":{"type":"string","description":"The name of the shift rate."},"type":{"type":"string","description":"The type of the shift rate (e.g., MULTIPLIER_PERCENTAGE or FLAT_RATE)."},"value":{"type":"number","format":"double","description":"The value of the shift rate."},"external_id":{"type":"string","description":"The unique external identifier of the shift rate."}},"title":"TimeTrackingShiftRatesExternalIdGetResponsesContentApplicationJsonSchemaData"},"time-tracking_getTimeTrackingShiftRateByExternalId_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/TimeTrackingShiftRatesExternalIdGetResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"time-tracking_getTimeTrackingShiftRateByExternalId_Response_200"},"TimeTrackingTimesheetsTimesheetIdGetResponsesContentApplicationJsonSchemaDataFileData":{"type":"object","properties":{"file_id":{"type":"string","format":"uuid","description":"Unique identifier for the timesheet file"},"file_name":{"type":"string","description":"Name of the timesheet file"},"download_url":{"type":"string","format":"uri","description":"Pre-signed S3 URL for downloading the timesheet file"}},"required":["file_id","file_name","download_url"],"description":"Present only when `extend=file_data` is provided. Contains file details and download URL.","title":"TimeTrackingTimesheetsTimesheetIdGetResponsesContentApplicationJsonSchemaDataFileData"},"TimeTrackingTimesheetsTimesheetIdGetResponsesContentApplicationJsonSchemaDataReviewStatus":{"type":"string","enum":["PENDING_CREATION","PENDING_REVIEW","APPROVED","REJECTED"],"description":"Current status of the timesheet review","title":"TimeTrackingTimesheetsTimesheetIdGetResponsesContentApplicationJsonSchemaDataReviewStatus"},"TimeTrackingTimesheetsTimesheetIdGetResponsesContentApplicationJsonSchemaDataSubmissionStatus":{"type":"string","enum":["UPLOADING","UPLOAD_FAILED","PROCESSING","SUBMITTED","INVALID","FAILED"],"description":"Current status of the timesheet submission","title":"TimeTrackingTimesheetsTimesheetIdGetResponsesContentApplicationJsonSchemaDataSubmissionStatus"},"TimeTrackingTimesheetsTimesheetIdGetResponsesContentApplicationJsonSchemaDataValidationErrorsItemsType":{"type":"string","enum":["EMPTY_TIMESHEET","INVALID_TIMESHEET_FORMAT","FILE_TOO_LARGE","INVALID_FILE_TYPE","INVALID_SHIFT_TIME_ORDER","INVALID_BREAK_TIME_ORDER","BREAK_OUTSIDE_SHIFT","OVERLAPPING_BREAKS","CANNOT_SUBMIT_SHIFTS","WORK_DURATION_MISMATCH","NON_WORKING_DAY_VIOLATION","PUBLIC_HOLIDAY_VIOLATION","TIME_OFF_VIOLATION","SHIFT_OUT_OF_CYCLE","DAY_UNAVAILABLE","INVALID_SHIFT_SUBMIT_TYPE","INVALID_SHIFT_ORIGIN","INVALID_SHIFT_TYPE","INVALID_SHIFT_KEEP_IN_TOUCH_DATE_INTERVAL","OVERLAPPING_SHIFT","SHIFT_CONTRACT_IN_RESTRICTED_STATUS","SHIFT_CONTRACT_IN_TERMINATION_STATUS","SHIFT_CONTRACT_COMPLETION_DATE","SHIFT_CONTRACT_START_DATE","SHIFT_MAX_SATURDAYS_PER_YEAR_VIOLATION","INVALID_DAY_TRACKING_DATA","SHIFT_MAX_WORKING_DAYS_PER_YEAR_VIOLATION","SHIFT_MAX_CONSECUTIVE_DAYS_STREAK_VIOLATION","BREAK_TYPE_NOT_AVAILABLE","BREAK_MISSED_OR_WAIVED","BREAK_DURATION_MISMATCH","BREAK_MAX_DURATION_EXCEEDED","WORK_LOCATION_VIOLATION","WORK_LOCATION_MISMATCH_BETWEEN_TIME_CLOCK_EVENTS_FOR_SHIFT","MISSING_WORK_DESCRIPTION"],"description":"Type of validation error","title":"TimeTrackingTimesheetsTimesheetIdGetResponsesContentApplicationJsonSchemaDataValidationErrorsItemsType"},"TimeTrackingTimesheetsTimesheetIdGetResponsesContentApplicationJsonSchemaDataValidationErrorsItems":{"type":"object","properties":{"row":{"type":["number","null"],"format":"double","description":"Row number in the timesheet file where the error occurred"},"type":{"$ref":"#/components/schemas/TimeTrackingTimesheetsTimesheetIdGetResponsesContentApplicationJsonSchemaDataValidationErrorsItemsType","description":"Type of validation error"},"column":{"type":["string","null"],"description":"Column name in the timesheet file where the error occurred"},"context":{"type":["object","null"],"additionalProperties":{"description":"Any type"},"description":"Additional context information about the error"},"message":{"type":"string","description":"Human-readable error message"}},"required":["type","message"],"title":"TimeTrackingTimesheetsTimesheetIdGetResponsesContentApplicationJsonSchemaDataValidationErrorsItems"},"TimeTrackingTimesheetsTimesheetIdGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the timesheet"},"end_date":{"type":"string","format":"date","description":"End date of the timesheet period"},"file_data":{"oneOf":[{"$ref":"#/components/schemas/TimeTrackingTimesheetsTimesheetIdGetResponsesContentApplicationJsonSchemaDataFileData"},{"type":"null"}],"description":"Present only when `extend=file_data` is provided. Contains file details and download URL."},"created_at":{"type":"string","format":"date-time","description":"Timestamp when the timesheet was created"},"start_date":{"type":"string","format":"date","description":"Start date of the timesheet period"},"updated_at":{"type":"string","format":"date-time","description":"Timestamp when the timesheet was last updated"},"contract_id":{"type":"string","description":"External id of the worker's contract associated with the timesheet"},"review_status":{"$ref":"#/components/schemas/TimeTrackingTimesheetsTimesheetIdGetResponsesContentApplicationJsonSchemaDataReviewStatus","description":"Current status of the timesheet review"},"submission_status":{"$ref":"#/components/schemas/TimeTrackingTimesheetsTimesheetIdGetResponsesContentApplicationJsonSchemaDataSubmissionStatus","description":"Current status of the timesheet submission"},"validation_errors":{"type":["array","null"],"items":{"$ref":"#/components/schemas/TimeTrackingTimesheetsTimesheetIdGetResponsesContentApplicationJsonSchemaDataValidationErrorsItems"},"description":"Array of validation errors found during timesheet processing. Null if no errors found."}},"required":["id","end_date","created_at","start_date","updated_at","contract_id","review_status","submission_status","validation_errors"],"description":"Timesheet data including validation errors if applicable. When extend=file_data, also includes file_data object with file details and download URL.","title":"TimeTrackingTimesheetsTimesheetIdGetResponsesContentApplicationJsonSchemaData"},"time-tracking_getTimeTrackingTimesheetById_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/TimeTrackingTimesheetsTimesheetIdGetResponsesContentApplicationJsonSchemaData","description":"Timesheet data including validation errors if applicable. When extend=file_data, also includes file_data object with file details and download URL."}},"required":["data"],"title":"time-tracking_getTimeTrackingTimesheetById_Response_200"},"TimeTrackingTimesheetsTimesheetIdGetResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code"},"field":{"type":"string","description":"Name of the field causing the error (for validation issues)"},"message":{"type":"string","description":"Human-readable explanation of the error"}},"required":["code","field","message"],"title":"TimeTrackingTimesheetsTimesheetIdGetResponsesContentApplicationJsonSchemaErrorsItems"},"RetrieveATimesheet-v2026-01-01RequestNotFoundError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/TimeTrackingTimesheetsTimesheetIdGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"RetrieveATimesheet-v2026-01-01RequestNotFoundError"},"TimeTrackingTimesheetsTimesheetIdReviewPostRequestBodyContentApplicationJsonSchemaDataReviewStatus":{"type":"string","enum":["APPROVED","REJECTED"],"description":"The review status for the timesheet. Must be APPROVED or REJECTED.","title":"TimeTrackingTimesheetsTimesheetIdReviewPostRequestBodyContentApplicationJsonSchemaDataReviewStatus"},"TimeTrackingTimesheetsTimesheetIdReviewPostRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"review_reason":{"type":["string","null"],"description":"Reason for rejecting the timesheet. Required when review_status is REJECTED, optional when APPROVED."},"review_status":{"$ref":"#/components/schemas/TimeTrackingTimesheetsTimesheetIdReviewPostRequestBodyContentApplicationJsonSchemaDataReviewStatus","description":"The review status for the timesheet. Must be APPROVED or REJECTED."}},"required":["review_status"],"title":"TimeTrackingTimesheetsTimesheetIdReviewPostRequestBodyContentApplicationJsonSchemaData"},"TimeTrackingTimesheetsTimesheetIdReviewPostResponsesContentApplicationJsonSchemaDataReviewStatus":{"type":"string","enum":["PENDING_CREATION","PENDING_REVIEW","APPROVED","REJECTED"],"description":"Current status of the timesheet review","title":"TimeTrackingTimesheetsTimesheetIdReviewPostResponsesContentApplicationJsonSchemaDataReviewStatus"},"TimeTrackingTimesheetsTimesheetIdReviewPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the timesheet"},"reviewed_at":{"type":"string","format":"date-time","description":"Timestamp when the timesheet was reviewed"},"review_reason":{"type":["string","null"],"description":"Reason provided by the reviewer when rejecting the timesheet. Only present when review_status is REJECTED."},"review_status":{"$ref":"#/components/schemas/TimeTrackingTimesheetsTimesheetIdReviewPostResponsesContentApplicationJsonSchemaDataReviewStatus","description":"Current status of the timesheet review"}},"required":["id","reviewed_at","review_status"],"description":"Updated timesheet details after review","title":"TimeTrackingTimesheetsTimesheetIdReviewPostResponsesContentApplicationJsonSchemaData"},"time-tracking_reviewTimeTrackingTimesheet_Response_201":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/TimeTrackingTimesheetsTimesheetIdReviewPostResponsesContentApplicationJsonSchemaData","description":"Updated timesheet details after review"}},"required":["data"],"title":"time-tracking_reviewTimeTrackingTimesheet_Response_201"},"TimeTrackingTimesheetsTimesheetIdReviewPostResponsesContentApplicationJsonSchemaErrorsItemsDetailsTimesheetReviewStatus":{"type":"string","enum":["PENDING_CREATION","PENDING_REVIEW","APPROVED","REJECTED"],"description":"Current status of the timesheet review","title":"TimeTrackingTimesheetsTimesheetIdReviewPostResponsesContentApplicationJsonSchemaErrorsItemsDetailsTimesheetReviewStatus"},"TimeTrackingTimesheetsTimesheetIdReviewPostResponsesContentApplicationJsonSchemaErrorsItemsDetailsTimesheetSubmissionStatus":{"type":"string","enum":["UPLOADING","UPLOAD_FAILED","PROCESSING","SUBMITTED","INVALID","FAILED"],"description":"Current status of the timesheet submission","title":"TimeTrackingTimesheetsTimesheetIdReviewPostResponsesContentApplicationJsonSchemaErrorsItemsDetailsTimesheetSubmissionStatus"},"TimeTrackingTimesheetsTimesheetIdReviewPostResponsesContentApplicationJsonSchemaErrorsItemsDetailsTimesheet":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the timesheet"},"contract_id":{"type":"string","description":"External id of the worker's contract associated with the timesheet"},"reviewed_at":{"type":["string","null"],"format":"date-time","description":"Timestamp when the timesheet was reviewed (if already reviewed)"},"review_status":{"$ref":"#/components/schemas/TimeTrackingTimesheetsTimesheetIdReviewPostResponsesContentApplicationJsonSchemaErrorsItemsDetailsTimesheetReviewStatus","description":"Current status of the timesheet review"},"submission_status":{"$ref":"#/components/schemas/TimeTrackingTimesheetsTimesheetIdReviewPostResponsesContentApplicationJsonSchemaErrorsItemsDetailsTimesheetSubmissionStatus","description":"Current status of the timesheet submission"}},"required":["id","contract_id","review_status","submission_status"],"description":"Current state of the timesheet that cannot be reviewed","title":"TimeTrackingTimesheetsTimesheetIdReviewPostResponsesContentApplicationJsonSchemaErrorsItemsDetailsTimesheet"},"TimeTrackingTimesheetsTimesheetIdReviewPostResponsesContentApplicationJsonSchemaErrorsItemsDetails":{"type":"object","properties":{"timesheet":{"$ref":"#/components/schemas/TimeTrackingTimesheetsTimesheetIdReviewPostResponsesContentApplicationJsonSchemaErrorsItemsDetailsTimesheet","description":"Current state of the timesheet that cannot be reviewed"}},"required":["timesheet"],"description":"Additional details about the error, including the current timesheet state","title":"TimeTrackingTimesheetsTimesheetIdReviewPostResponsesContentApplicationJsonSchemaErrorsItemsDetails"},"TimeTrackingTimesheetsTimesheetIdReviewPostResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code"},"field":{"type":["string","null"],"description":"Name of the field causing the error (for validation issues)"},"details":{"$ref":"#/components/schemas/TimeTrackingTimesheetsTimesheetIdReviewPostResponsesContentApplicationJsonSchemaErrorsItemsDetails","description":"Additional details about the error, including the current timesheet state"},"message":{"type":"string","description":"Human-readable explanation of the error"}},"required":["code","details","message"],"title":"TimeTrackingTimesheetsTimesheetIdReviewPostResponsesContentApplicationJsonSchemaErrorsItems"},"ReviewASubmittedTimesheetRequestNotFoundError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/TimeTrackingTimesheetsTimesheetIdReviewPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"ReviewASubmittedTimesheetRequestNotFoundError"},"ReviewASubmittedTimesheetRequestUnprocessableEntityError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/TimeTrackingTimesheetsTimesheetIdReviewPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"ReviewASubmittedTimesheetRequestUnprocessableEntityError"},"TimeTrackingShiftRatesExternalIdPatchRequestBodyContentApplicationJsonSchemaDataType":{"type":"string","enum":["MULTIPLIER_PERCENTAGE","PER_HOUR_FLAT_RATE","PER_UNIT_FLAT_RATE"],"description":"The updated type of shift rate.","title":"TimeTrackingShiftRatesExternalIdPatchRequestBodyContentApplicationJsonSchemaDataType"},"TimeTrackingShiftRatesExternalIdPatchRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"name":{"type":"string","description":"The updated name of the shift rate."},"type":{"$ref":"#/components/schemas/TimeTrackingShiftRatesExternalIdPatchRequestBodyContentApplicationJsonSchemaDataType","description":"The updated type of shift rate."},"value":{"type":"number","format":"double","description":"The updated value of the shift rate."}},"title":"TimeTrackingShiftRatesExternalIdPatchRequestBodyContentApplicationJsonSchemaData"},"TimeTrackingShiftRatesExternalIdPatchResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"name":{"type":"string","description":"The updated name of the shift rate."},"type":{"type":"string","description":"The type of shift rate, e.g., MULTIPLIER_PERCENTAGE."},"value":{"type":"number","format":"double","description":"The updated value of the shift rate."},"created_at":{"type":"string","format":"date-time","description":"The timestamp when the shift rate was created."},"updated_at":{"type":"string","format":"date-time","description":"The timestamp when the shift rate was last updated."},"external_id":{"type":"string","description":"The unique identifier of the updated shift rate."}},"title":"TimeTrackingShiftRatesExternalIdPatchResponsesContentApplicationJsonSchemaData"},"time-tracking_updateTimeTrackingShiftRateByExternalId_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/TimeTrackingShiftRatesExternalIdPatchResponsesContentApplicationJsonSchemaData"}},"title":"time-tracking_updateTimeTrackingShiftRateByExternalId_Response_200"},"TimeTrackingShiftRatesExternalIdPatchResponsesContentApplicationJsonSchemaError":{"type":"object","properties":{"message":{"type":"string","description":"Description of the error."}},"title":"TimeTrackingShiftRatesExternalIdPatchResponsesContentApplicationJsonSchemaError"},"UpdateAShiftRateRequestBadRequestError":{"type":"object","properties":{"error":{"$ref":"#/components/schemas/TimeTrackingShiftRatesExternalIdPatchResponsesContentApplicationJsonSchemaError"}},"title":"UpdateAShiftRateRequestBadRequestError"},"TimeTrackingShiftsRawPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsMetaEnd":{"type":"object","properties":{"date":{"type":"string","description":"End date"},"time":{"type":"string","description":"End time"},"is_rest_day":{"type":"boolean","description":"Is rest day"},"is_public_holiday":{"type":"boolean","description":"Is public holiday"}},"description":"End time details of the shift.","title":"TimeTrackingShiftsRawPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsMetaEnd"},"TimeTrackingShiftsRawPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsMetaStart":{"type":"object","properties":{"date":{"type":"string","description":"Start date"},"time":{"type":"string","description":"Start time"},"is_rest_day":{"type":"boolean","description":"Is rest day"},"is_public_holiday":{"type":"boolean","description":"Is public holiday"}},"description":"Start time details of the shift.","title":"TimeTrackingShiftsRawPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsMetaStart"},"TimeTrackingShiftsRawPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsMetaBreaksItemsEnd":{"type":"object","properties":{"date":{"type":"string","description":"Break end date"},"time":{"type":"string","description":"Break end time"}},"description":"End time details of the break.","title":"TimeTrackingShiftsRawPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsMetaBreaksItemsEnd"},"TimeTrackingShiftsRawPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsMetaBreaksItemsStart":{"type":"object","properties":{"date":{"type":"string","description":"Break start date"},"time":{"type":"string","description":"Break start time"}},"description":"Start time details of the break.","title":"TimeTrackingShiftsRawPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsMetaBreaksItemsStart"},"TimeTrackingShiftsRawPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsMetaBreaksItems":{"type":"object","properties":{"end":{"$ref":"#/components/schemas/TimeTrackingShiftsRawPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsMetaBreaksItemsEnd","description":"End time details of the break."},"start":{"$ref":"#/components/schemas/TimeTrackingShiftsRawPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsMetaBreaksItemsStart","description":"Start time details of the break."},"is_paid":{"type":"boolean","description":"Is break paid"}},"title":"TimeTrackingShiftsRawPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsMetaBreaksItems"},"TimeTrackingShiftsRawPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsMeta":{"type":"object","properties":{"end":{"$ref":"#/components/schemas/TimeTrackingShiftsRawPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsMetaEnd","description":"End time details of the shift."},"start":{"$ref":"#/components/schemas/TimeTrackingShiftsRawPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsMetaStart","description":"Start time details of the shift."},"breaks":{"type":"array","items":{"$ref":"#/components/schemas/TimeTrackingShiftsRawPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsMetaBreaksItems"},"description":"List of break periods within the shift."},"approval_date":{"type":"string","description":"Approval date"}},"description":"Metadata containing detailed information about the shift timing, breaks, and approval status.","title":"TimeTrackingShiftsRawPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsMeta"},"TimeTrackingShiftsRawPostRequestBodyContentApplicationJsonSchemaDataShiftsItems":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/TimeTrackingShiftsRawPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsMeta","description":"Metadata containing detailed information about the shift timing, breaks, and approval status."},"description":{"type":"string","description":"Description of the shift."},"external_id":{"type":"string","description":"Extrenal ID of the shift."},"date_of_work":{"type":"string","description":"Date of shift work"}},"required":["meta","external_id","date_of_work"],"title":"TimeTrackingShiftsRawPostRequestBodyContentApplicationJsonSchemaDataShiftsItems"},"TimeTrackingShiftsRawPostRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"shifts":{"type":"array","items":{"$ref":"#/components/schemas/TimeTrackingShiftsRawPostRequestBodyContentApplicationJsonSchemaDataShiftsItems"},"description":"Array of shift records to be created."},"contract_id":{"type":"string","description":"Contract ID associated with the shifts."}},"required":["shifts","contract_id"],"description":"Request data containing contract ID and shifts to be created.","title":"TimeTrackingShiftsRawPostRequestBodyContentApplicationJsonSchemaData"},"TimeTrackingShiftsRawPostResponsesContentApplicationJsonSchemaDataItemsMetaEnd":{"type":"object","properties":{"date":{"type":"string","description":"End date"},"time":{"type":"string","description":"End time"},"is_rest_day":{"type":"boolean","description":"Is rest day"},"is_public_holiday":{"type":"boolean","description":"Is public holiday"}},"description":"End time details of the shift.","title":"TimeTrackingShiftsRawPostResponsesContentApplicationJsonSchemaDataItemsMetaEnd"},"TimeTrackingShiftsRawPostResponsesContentApplicationJsonSchemaDataItemsMetaStart":{"type":"object","properties":{"date":{"type":"string","description":"Start date"},"time":{"type":"string","description":"Start time"},"is_rest_day":{"type":"boolean","description":"Is rest day"},"is_public_holiday":{"type":"boolean","description":"Is public holiday"}},"description":"Start time details of the shift.","title":"TimeTrackingShiftsRawPostResponsesContentApplicationJsonSchemaDataItemsMetaStart"},"TimeTrackingShiftsRawPostResponsesContentApplicationJsonSchemaDataItemsMetaBreaksItemsEnd":{"type":"object","properties":{"date":{"type":"string","description":"Break end date"},"time":{"type":"string","description":"Break end time"}},"description":"End time details of the break.","title":"TimeTrackingShiftsRawPostResponsesContentApplicationJsonSchemaDataItemsMetaBreaksItemsEnd"},"TimeTrackingShiftsRawPostResponsesContentApplicationJsonSchemaDataItemsMetaBreaksItemsStart":{"type":"object","properties":{"date":{"type":"string","description":"Break start date"},"time":{"type":"string","description":"Break start time"}},"description":"Start time details of the break.","title":"TimeTrackingShiftsRawPostResponsesContentApplicationJsonSchemaDataItemsMetaBreaksItemsStart"},"TimeTrackingShiftsRawPostResponsesContentApplicationJsonSchemaDataItemsMetaBreaksItems":{"type":"object","properties":{"end":{"$ref":"#/components/schemas/TimeTrackingShiftsRawPostResponsesContentApplicationJsonSchemaDataItemsMetaBreaksItemsEnd","description":"End time details of the break."},"start":{"$ref":"#/components/schemas/TimeTrackingShiftsRawPostResponsesContentApplicationJsonSchemaDataItemsMetaBreaksItemsStart","description":"Start time details of the break."},"is_paid":{"type":"boolean","description":"Is break paid"}},"title":"TimeTrackingShiftsRawPostResponsesContentApplicationJsonSchemaDataItemsMetaBreaksItems"},"TimeTrackingShiftsRawPostResponsesContentApplicationJsonSchemaDataItemsMeta":{"type":"object","properties":{"end":{"$ref":"#/components/schemas/TimeTrackingShiftsRawPostResponsesContentApplicationJsonSchemaDataItemsMetaEnd","description":"End time details of the shift."},"start":{"$ref":"#/components/schemas/TimeTrackingShiftsRawPostResponsesContentApplicationJsonSchemaDataItemsMetaStart","description":"Start time details of the shift."},"breaks":{"type":"array","items":{"$ref":"#/components/schemas/TimeTrackingShiftsRawPostResponsesContentApplicationJsonSchemaDataItemsMetaBreaksItems"},"description":"List of break periods within the shift."},"approval_date":{"type":"string","description":"Approval date of the shift."}},"description":"Metadata containing detailed information about the shift timing, breaks, and approval status.","title":"TimeTrackingShiftsRawPostResponsesContentApplicationJsonSchemaDataItemsMeta"},"TimeTrackingShiftsRawPostResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/TimeTrackingShiftsRawPostResponsesContentApplicationJsonSchemaDataItemsMeta","description":"Metadata containing detailed information about the shift timing, breaks, and approval status."},"created_at":{"type":"string","description":"Creation timestamp of the shift."},"updated_at":{"type":"string","description":"Last update timestamp of the shift."},"contract_id":{"type":"string","description":"Contract identifier."},"description":{"type":"string","description":"Description of the shift."},"external_id":{"type":"string","description":"Unique identifier of the shift."},"date_of_work":{"type":"string","description":"Date of the shift."}},"required":["meta","contract_id","external_id","date_of_work"],"title":"TimeTrackingShiftsRawPostResponsesContentApplicationJsonSchemaDataItems"},"time-tracking-shifts_createTimeTrackingShiftsRaw_Response_201":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/TimeTrackingShiftsRawPostResponsesContentApplicationJsonSchemaDataItems"},"description":"List of created shift records."}},"required":["data"],"title":"time-tracking-shifts_createTimeTrackingShiftsRaw_Response_201"},"TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsOneOf0SummaryTimeUnit":{"type":"string","enum":["HOUR","MONTH","DAY","WEEK"],"description":"Time unit","title":"TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsOneOf0SummaryTimeUnit"},"TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsOneOf0Summary":{"type":"object","properties":{"time_unit":{"$ref":"#/components/schemas/TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsOneOf0SummaryTimeUnit","description":"Time unit"},"time_amount":{"type":"number","format":"double","description":"Time amount"},"shift_rate_external_id":{"type":"string","description":"Shift Rate external ID"}},"required":["time_unit","time_amount","shift_rate_external_id"],"description":"Summary of calculated time and rates for the shift.","title":"TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsOneOf0Summary"},"TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsOneOf0ShiftType":{"type":"string","enum":["REGULAR"],"description":"Type of the shift","title":"TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsOneOf0ShiftType"},"TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsOneOf0PayrollCycleRef":{"type":"object","properties":{"date":{"type":"string","format":"date-time","description":"Date in ISO 8601 format that helps referencing a payroll cycle"}},"required":["date"],"description":"Reference to the payroll cycle associated with this shift.","title":"TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsOneOf0PayrollCycleRef"},"TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItems0":{"type":"object","properties":{"summary":{"$ref":"#/components/schemas/TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsOneOf0Summary","description":"Summary of calculated time and rates for the shift."},"shift_type":{"$ref":"#/components/schemas/TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsOneOf0ShiftType","description":"Type of the shift"},"description":{"type":"string","description":"Description of the shift."},"external_id":{"type":"string","description":"External ID of the shift."},"date_of_work":{"type":"string","format":"date","description":"Date of shift work"},"payroll_cycle_ref":{"$ref":"#/components/schemas/TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsOneOf0PayrollCycleRef","description":"Reference to the payroll cycle associated with this shift."}},"required":["summary","description","external_id","date_of_work"],"title":"TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItems0"},"TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsOneOf1Summary":{"type":"object","properties":{"time_amount":{"type":"number","format":"double","description":"Time amount"}},"required":["time_amount"],"description":"Summary of calculated time and rates for the correction shift.","title":"TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsOneOf1Summary"},"TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsOneOf1ShiftType":{"type":"string","enum":["CORRECTION_ABSOLUTE"],"description":"Type of the shift","title":"TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsOneOf1ShiftType"},"TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsOneOf1PayrollCycleRef":{"type":"object","properties":{"date":{"type":"string","format":"date-time","description":"Date in ISO 8601 format that helps referencing a payroll cycle"}},"required":["date"],"description":"Reference to the payroll cycle associated with this shift.","title":"TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsOneOf1PayrollCycleRef"},"TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItems1":{"type":"object","properties":{"summary":{"$ref":"#/components/schemas/TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsOneOf1Summary","description":"Summary of calculated time and rates for the correction shift."},"shift_type":{"$ref":"#/components/schemas/TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsOneOf1ShiftType","description":"Type of the shift"},"description":{"type":"string","description":"Description of the correction shift."},"external_id":{"type":"string","description":"External ID of the correction shift."},"payroll_cycle_ref":{"$ref":"#/components/schemas/TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsOneOf1PayrollCycleRef","description":"Reference to the payroll cycle associated with this shift."},"shift_reference_id":{"type":"string","description":"External ID of the original shift being corrected"}},"required":["summary","shift_type","description","external_id","shift_reference_id"],"title":"TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItems1"},"TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsOneOf2ShiftType":{"type":"string","enum":["CORRECTION_DELTA"],"description":"Type of the shift","title":"TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsOneOf2ShiftType"},"TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsOneOf2CorrectionsItemsType":{"type":"string","enum":["SUBTRACTION","ADDITION"],"description":"Type of correction","title":"TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsOneOf2CorrectionsItemsType"},"TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsOneOf2CorrectionsItems":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsOneOf2CorrectionsItemsType","description":"Type of correction"},"time_amount":{"type":"number","format":"double","description":"Time amount"}},"required":["type","time_amount"],"title":"TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsOneOf2CorrectionsItems"},"TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsOneOf2PayrollCycleRef":{"type":"object","properties":{"date":{"type":"string","format":"date-time","description":"Date in ISO 8601 format that helps referencing a payroll cycle"}},"required":["date"],"description":"Reference to the payroll cycle associated with this shift.","title":"TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsOneOf2PayrollCycleRef"},"TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItems2":{"type":"object","properties":{"shift_type":{"$ref":"#/components/schemas/TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsOneOf2ShiftType","description":"Type of the shift"},"corrections":{"type":"array","items":{"$ref":"#/components/schemas/TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsOneOf2CorrectionsItems"},"description":"Array of correction adjustments to apply to the original shift."},"description":{"type":"string","description":"Description of the correction shift."},"external_id":{"type":"string","description":"External ID of the correction shift."},"payroll_cycle_ref":{"$ref":"#/components/schemas/TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsOneOf2PayrollCycleRef","description":"Reference to the payroll cycle associated with this shift."},"shift_reference_id":{"type":"string","description":"External ID of the original shift being corrected"}},"required":["shift_type","corrections","description","external_id","shift_reference_id"],"title":"TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItems2"},"TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsOneOf3Summary":{"type":"object","properties":{"total_break_hours":{"type":"number","format":"double","description":"Total break hours"},"payable_break_hours":{"type":"number","format":"double","description":"Payable break hours"},"total_payable_hours":{"type":"number","format":"double","description":"Total payable hours"},"shift_duration_hours":{"type":"number","format":"double","description":"Shift duration hours"},"shift_rate_external_id":{"type":"string","description":"Shift Rate external ID"}},"required":["total_payable_hours","shift_rate_external_id"],"description":"Summary of calculated hours and rates for the shift.","title":"TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsOneOf3Summary"},"TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsOneOf3ShiftType":{"type":"string","enum":["REGULAR"],"description":"Type of the shift","title":"TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsOneOf3ShiftType"},"TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsOneOf3PayrollCycleRef":{"type":"object","properties":{"date":{"type":"string","format":"date-time","description":"Date in ISO 8601 format that helps referencing a payroll cycle"}},"required":["date"],"description":"Reference to the payroll cycle associated with this shift.","title":"TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsOneOf3PayrollCycleRef"},"TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItems3":{"type":"object","properties":{"summary":{"$ref":"#/components/schemas/TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsOneOf3Summary","description":"Summary of calculated hours and rates for the shift."},"shift_type":{"$ref":"#/components/schemas/TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsOneOf3ShiftType","description":"Type of the shift"},"description":{"type":"string","description":"Description of the shift."},"external_id":{"type":"string","description":"External ID of the shift."},"date_of_work":{"type":"string","format":"date","description":"Date of shift work"},"payroll_cycle_ref":{"$ref":"#/components/schemas/TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsOneOf3PayrollCycleRef","description":"Reference to the payroll cycle associated with this shift."}},"required":["summary","description","external_id","date_of_work"],"title":"TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItems3"},"TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsOneOf4Summary":{"type":"object","properties":{"total_break_hours":{"type":"number","format":"double","description":"Absolute total break hours"},"payable_break_hours":{"type":"number","format":"double","description":"Absolute payable break hours"},"total_payable_hours":{"type":"number","format":"double","description":"Absolute total payable hours"},"shift_duration_hours":{"type":"number","format":"double","description":"Absolute shift duration hours"}},"required":["total_payable_hours"],"description":"Summary of calculated hours and rates for the correction shift.","title":"TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsOneOf4Summary"},"TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsOneOf4ShiftType":{"type":"string","enum":["CORRECTION_ABSOLUTE"],"description":"Type of the shift","title":"TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsOneOf4ShiftType"},"TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsOneOf4PayrollCycleRef":{"type":"object","properties":{"date":{"type":"string","description":"Date in ISO 8601 format that helps referencing a payroll cycle"}},"required":["date"],"description":"Reference to the payroll cycle associated with this shift.","title":"TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsOneOf4PayrollCycleRef"},"TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItems4":{"type":"object","properties":{"summary":{"$ref":"#/components/schemas/TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsOneOf4Summary","description":"Summary of calculated hours and rates for the correction shift."},"shift_type":{"$ref":"#/components/schemas/TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsOneOf4ShiftType","description":"Type of the shift"},"description":{"type":"string","description":"Description of the correction shift."},"external_id":{"type":"string","description":"External ID of the correction shift."},"payroll_cycle_ref":{"$ref":"#/components/schemas/TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsOneOf4PayrollCycleRef","description":"Reference to the payroll cycle associated with this shift."},"shift_reference_id":{"type":"string","description":"External ID of the original shift being corrected"}},"required":["summary","shift_type","description","external_id","shift_reference_id"],"title":"TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItems4"},"TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsOneOf5ShiftType":{"type":"string","enum":["CORRECTION_DELTA"],"description":"Type of the shift","title":"TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsOneOf5ShiftType"},"TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsOneOf5CorrectionsItems":{"type":"object","properties":{"type":{"type":"string","description":"Type of correction"},"total_break_hours":{"type":"number","format":"double","description":"Break hours to add or subtract"},"payable_break_hours":{"type":"number","format":"double","description":"Payable break hours to add or subtract"},"total_payable_hours":{"type":"number","format":"double","description":"Payable hours to add or subtract"},"shift_duration_hours":{"type":"number","format":"double","description":"Shift duration hours to add or subtract"}},"required":["type"],"title":"TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsOneOf5CorrectionsItems"},"TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsOneOf5PayrollCycleRef":{"type":"object","properties":{"date":{"type":"string","description":"Date in ISO 8601 format that helps referencing a payroll cycle"}},"required":["date"],"description":"Reference to the payroll cycle associated with this shift.","title":"TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsOneOf5PayrollCycleRef"},"TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItems5":{"type":"object","properties":{"shift_type":{"$ref":"#/components/schemas/TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsOneOf5ShiftType","description":"Type of the shift"},"corrections":{"type":"array","items":{"$ref":"#/components/schemas/TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsOneOf5CorrectionsItems"},"description":"Array of correction adjustments to apply to the original shift."},"description":{"type":"string","description":"Description of the correction shift."},"external_id":{"type":"string","description":"External ID of the correction shift."},"payroll_cycle_ref":{"$ref":"#/components/schemas/TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItemsOneOf5PayrollCycleRef","description":"Reference to the payroll cycle associated with this shift."},"shift_reference_id":{"type":"string","description":"External ID of the original shift being corrected"}},"required":["shift_type","corrections","description","external_id","shift_reference_id"],"title":"TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItems5"},"TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItems":{"oneOf":[{"$ref":"#/components/schemas/TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItems0"},{"$ref":"#/components/schemas/TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItems1"},{"$ref":"#/components/schemas/TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItems2"},{"$ref":"#/components/schemas/TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItems3"},{"$ref":"#/components/schemas/TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItems4"},{"$ref":"#/components/schemas/TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItems5"}],"title":"TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItems"},"TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"shifts":{"type":"array","items":{"$ref":"#/components/schemas/TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaDataShiftsItems"},"description":"Array of shift records to be created, supporting regular shifts and correction shifts."},"contract_id":{"type":"string","description":"The unique identifier of the employee contract."}},"required":["shifts","contract_id"],"description":"Request data containing contract ID and shifts to be created.","title":"TimeTrackingShiftsPostRequestBodyContentApplicationJsonSchemaData"},"TimeTrackingShiftsPostResponsesContentApplicationJsonSchemaDataItemsSummaryTimeUnit":{"type":"string","enum":["HOUR","DAY","WEEK","MONTH"],"description":"Time unit","title":"TimeTrackingShiftsPostResponsesContentApplicationJsonSchemaDataItemsSummaryTimeUnit"},"TimeTrackingShiftsPostResponsesContentApplicationJsonSchemaDataItemsSummary":{"type":"object","properties":{"time_unit":{"$ref":"#/components/schemas/TimeTrackingShiftsPostResponsesContentApplicationJsonSchemaDataItemsSummaryTimeUnit","description":"Time unit"},"time_amount":{"type":"number","format":"double","description":"Time amount"},"total_break_hours":{"type":"number","format":"double","description":"Total break hours"},"payable_break_hours":{"type":"number","format":"double","description":"Payable break hours"},"total_payable_hours":{"type":"number","format":"double","description":"Total payable hours"},"shift_duration_hours":{"type":"number","format":"double","description":"Shift duration hours"},"shift_rate_external_id":{"type":"string","description":"Shift rate external ID"}},"required":["shift_rate_external_id"],"description":"Summary of calculated time and rates for the shift.","title":"TimeTrackingShiftsPostResponsesContentApplicationJsonSchemaDataItemsSummary"},"TimeTrackingShiftsPostResponsesContentApplicationJsonSchemaDataItemsShiftType":{"type":"string","enum":["REGULAR","CORRECTION_ABSOLUTE","CORRECTION_DELTA"],"description":"Type of the shift","title":"TimeTrackingShiftsPostResponsesContentApplicationJsonSchemaDataItemsShiftType"},"TimeTrackingShiftsPostResponsesContentApplicationJsonSchemaDataItemsPayrollCycleRef":{"type":"object","properties":{"date":{"type":"string","format":"date-time","description":"Date in ISO 8601 format that helps referencing a payroll cycle"}},"required":["date"],"description":"Reference to the payroll cycle associated with this shift.","title":"TimeTrackingShiftsPostResponsesContentApplicationJsonSchemaDataItemsPayrollCycleRef"},"TimeTrackingShiftsPostResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"summary":{"$ref":"#/components/schemas/TimeTrackingShiftsPostResponsesContentApplicationJsonSchemaDataItemsSummary","description":"Summary of calculated time and rates for the shift."},"created_at":{"type":"string","format":"date-time","description":"Creation timestamp of the shift."},"shift_type":{"$ref":"#/components/schemas/TimeTrackingShiftsPostResponsesContentApplicationJsonSchemaDataItemsShiftType","description":"Type of the shift"},"updated_at":{"type":"string","format":"date-time","description":"Last update timestamp of the shift."},"contract_id":{"type":"string","description":"The unique identifier of the employee contract."},"description":{"type":"string","description":"Description of the shift."},"external_id":{"type":"string","description":"Unique identifier of the shift."},"date_of_work":{"type":"string","format":"date","description":"Date of the shift."},"payroll_cycle_ref":{"$ref":"#/components/schemas/TimeTrackingShiftsPostResponsesContentApplicationJsonSchemaDataItemsPayrollCycleRef","description":"Reference to the payroll cycle associated with this shift."},"shift_reference_id":{"type":"string","description":"Reference ID for the shift"}},"required":["summary","shift_type","contract_id","description","external_id","date_of_work"],"title":"TimeTrackingShiftsPostResponsesContentApplicationJsonSchemaDataItems"},"time-tracking-shifts_createTimeTrackingShifts_Response_201":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/TimeTrackingShiftsPostResponsesContentApplicationJsonSchemaDataItems"},"description":"List of created shift records."}},"required":["data"],"title":"time-tracking-shifts_createTimeTrackingShifts_Response_201"},"time-tracking-shifts_deleteTimeTrackingShiftByExternalId_Response_204":{"type":"object","properties":{},"description":"Empty response body","title":"time-tracking-shifts_deleteTimeTrackingShiftByExternalId_Response_204"},"TimeTrackingShiftsBulkDeletePostRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"external_ids":{"type":"array","items":{"type":"string"},"description":"Array of shift external IDs to delete."}},"required":["external_ids"],"description":"Request data containing the external IDs of shifts to be deleted.","title":"TimeTrackingShiftsBulkDeletePostRequestBodyContentApplicationJsonSchemaData"},"TimeTrackingShiftsBulkDeletePostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"message":{"type":"string","description":"Success message indicating the number of shifts deleted"}},"required":["message"],"title":"TimeTrackingShiftsBulkDeletePostResponsesContentApplicationJsonSchemaData"},"Time Tracking Shifts_deleteMultipleShiftsByExternalId_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/TimeTrackingShiftsBulkDeletePostResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"Time Tracking Shifts_deleteMultipleShiftsByExternalId_Response_200"},"TimeTrackingShiftsExternalIdGetResponsesContentApplicationJsonSchemaDataMetaEnd":{"type":"object","properties":{"date":{"type":"string","description":"End date of the shift."},"time":{"type":"string","description":"End time of the shift."},"is_rest_day":{"type":"boolean","description":"Indicates if the shift end day is a rest day."},"is_public_holiday":{"type":"boolean","description":"Indicates if the shift end day is a public holiday."}},"description":"End time details of the shift.","title":"TimeTrackingShiftsExternalIdGetResponsesContentApplicationJsonSchemaDataMetaEnd"},"TimeTrackingShiftsExternalIdGetResponsesContentApplicationJsonSchemaDataMetaStart":{"type":"object","properties":{"date":{"type":"string","description":"Start date of the shift."},"time":{"type":"string","description":"Start time of the shift."},"is_rest_day":{"type":"boolean","description":"Indicates if the shift start day is a rest day."},"is_public_holiday":{"type":"boolean","description":"Indicates if the shift start day is a public holiday."}},"description":"Start time details of the shift.","title":"TimeTrackingShiftsExternalIdGetResponsesContentApplicationJsonSchemaDataMetaStart"},"TimeTrackingShiftsExternalIdGetResponsesContentApplicationJsonSchemaDataMetaBreaksItemsEnd":{"type":"object","properties":{"date":{"type":"string","description":"Break end date."},"time":{"type":"string","description":"Break end time."}},"description":"End time details of the break.","title":"TimeTrackingShiftsExternalIdGetResponsesContentApplicationJsonSchemaDataMetaBreaksItemsEnd"},"TimeTrackingShiftsExternalIdGetResponsesContentApplicationJsonSchemaDataMetaBreaksItemsStart":{"type":"object","properties":{"date":{"type":"string","description":"Break start date."},"time":{"type":"string","description":"Break start time."}},"description":"Start time details of the break.","title":"TimeTrackingShiftsExternalIdGetResponsesContentApplicationJsonSchemaDataMetaBreaksItemsStart"},"TimeTrackingShiftsExternalIdGetResponsesContentApplicationJsonSchemaDataMetaBreaksItems":{"type":"object","properties":{"end":{"$ref":"#/components/schemas/TimeTrackingShiftsExternalIdGetResponsesContentApplicationJsonSchemaDataMetaBreaksItemsEnd","description":"End time details of the break."},"start":{"$ref":"#/components/schemas/TimeTrackingShiftsExternalIdGetResponsesContentApplicationJsonSchemaDataMetaBreaksItemsStart","description":"Start time details of the break."},"is_paid":{"type":"boolean","description":"Indicates if the break is paid."}},"title":"TimeTrackingShiftsExternalIdGetResponsesContentApplicationJsonSchemaDataMetaBreaksItems"},"TimeTrackingShiftsExternalIdGetResponsesContentApplicationJsonSchemaDataMeta":{"type":"object","properties":{"end":{"$ref":"#/components/schemas/TimeTrackingShiftsExternalIdGetResponsesContentApplicationJsonSchemaDataMetaEnd","description":"End time details of the shift."},"start":{"$ref":"#/components/schemas/TimeTrackingShiftsExternalIdGetResponsesContentApplicationJsonSchemaDataMetaStart","description":"Start time details of the shift."},"breaks":{"type":"array","items":{"$ref":"#/components/schemas/TimeTrackingShiftsExternalIdGetResponsesContentApplicationJsonSchemaDataMetaBreaksItems"},"description":"List of break periods within the shift."},"approval_date":{"type":"string","description":"Approval date of the shift."}},"description":"Metadata containing detailed information about the shift timing, breaks, and approval status.","title":"TimeTrackingShiftsExternalIdGetResponsesContentApplicationJsonSchemaDataMeta"},"TimeTrackingShiftsExternalIdGetResponsesContentApplicationJsonSchemaDataSummary":{"type":"object","properties":{"total_break_hours":{"type":"number","format":"double","description":"Total break hours within the shift."},"payable_break_hours":{"type":"number","format":"double","description":"Total payable break hours."},"total_payable_hours":{"type":"number","format":"double","description":"Total payable hours for the shift."},"shift_duration_hours":{"type":"number","format":"double","description":"Total duration of the shift in hours."},"shift_rate_external_id":{"type":"string","description":"External ID of the shift rate associated with the shift."}},"description":"Summary of calculated hours and rates for the shift.","title":"TimeTrackingShiftsExternalIdGetResponsesContentApplicationJsonSchemaDataSummary"},"TimeTrackingShiftsExternalIdGetResponsesContentApplicationJsonSchemaDataPayrollCycleRef":{"type":"object","properties":{"date":{"type":"string","description":"Date in ISO 8601 format that helps referencing a payroll cycle"}},"required":["date"],"description":"Reference to the payroll cycle associated with this shift.","title":"TimeTrackingShiftsExternalIdGetResponsesContentApplicationJsonSchemaDataPayrollCycleRef"},"TimeTrackingShiftsExternalIdGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/TimeTrackingShiftsExternalIdGetResponsesContentApplicationJsonSchemaDataMeta","description":"Metadata containing detailed information about the shift timing, breaks, and approval status."},"summary":{"$ref":"#/components/schemas/TimeTrackingShiftsExternalIdGetResponsesContentApplicationJsonSchemaDataSummary","description":"Summary of calculated hours and rates for the shift."},"created_at":{"type":"string","description":"Timestamp when the shift was created."},"updated_at":{"type":"string","description":"Timestamp when the shift was last updated."},"contract_id":{"type":"string","description":"Contract ID associated with the shift."},"description":{"type":"string","description":"Description of the shift."},"external_id":{"type":"string","description":"Unique identifier of the shift."},"date_of_work":{"type":"string","description":"The date of work for the shift."},"payroll_cycle_ref":{"$ref":"#/components/schemas/TimeTrackingShiftsExternalIdGetResponsesContentApplicationJsonSchemaDataPayrollCycleRef","description":"Reference to the payroll cycle associated with this shift."}},"description":"Shift record details.","title":"TimeTrackingShiftsExternalIdGetResponsesContentApplicationJsonSchemaData"},"time-tracking-shifts_getTimeTrackingShiftByExternalId_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/TimeTrackingShiftsExternalIdGetResponsesContentApplicationJsonSchemaData","description":"Shift record details."}},"required":["data"],"title":"time-tracking-shifts_getTimeTrackingShiftByExternalId_Response_200"},"TimeTrackingShiftsExternalIdGetResponsesContentApplicationJsonSchemaError":{"type":"object","properties":{"message":{"type":"string","description":"Description of the error."}},"title":"TimeTrackingShiftsExternalIdGetResponsesContentApplicationJsonSchemaError"},"GetShiftDetailsRequestBadRequestError":{"type":"object","properties":{"error":{"$ref":"#/components/schemas/TimeTrackingShiftsExternalIdGetResponsesContentApplicationJsonSchemaError"}},"title":"GetShiftDetailsRequestBadRequestError"},"TimeTrackingShiftsGetResponsesContentApplicationJsonSchemaDataItemsMetaEnd":{"type":"object","properties":{"date":{"type":"string","description":"End date of the shift."},"time":{"type":"string","description":"End time of the shift."},"is_rest_day":{"type":"boolean","description":"Indicates if the shift end day is a rest day."},"is_public_holiday":{"type":"boolean","description":"Indicates if the shift end day is a public holiday."}},"description":"End time details of the shift.","title":"TimeTrackingShiftsGetResponsesContentApplicationJsonSchemaDataItemsMetaEnd"},"TimeTrackingShiftsGetResponsesContentApplicationJsonSchemaDataItemsMetaStart":{"type":"object","properties":{"date":{"type":"string","description":"Start date of the shift."},"time":{"type":"string","description":"Start time of the shift."},"is_rest_day":{"type":"boolean","description":"Indicates if the shift start day is a rest day."},"is_public_holiday":{"type":"boolean","description":"Indicates if the shift start day is a public holiday."}},"description":"Start time details of the shift.","title":"TimeTrackingShiftsGetResponsesContentApplicationJsonSchemaDataItemsMetaStart"},"TimeTrackingShiftsGetResponsesContentApplicationJsonSchemaDataItemsMetaBreaksItemsEnd":{"type":"object","properties":{"date":{"type":"string","description":"Break end date."},"time":{"type":"string","description":"Break end time."}},"description":"End time details of the break.","title":"TimeTrackingShiftsGetResponsesContentApplicationJsonSchemaDataItemsMetaBreaksItemsEnd"},"TimeTrackingShiftsGetResponsesContentApplicationJsonSchemaDataItemsMetaBreaksItemsStart":{"type":"object","properties":{"date":{"type":"string","description":"Break start date."},"time":{"type":"string","description":"Break start time."}},"description":"Start time details of the break.","title":"TimeTrackingShiftsGetResponsesContentApplicationJsonSchemaDataItemsMetaBreaksItemsStart"},"TimeTrackingShiftsGetResponsesContentApplicationJsonSchemaDataItemsMetaBreaksItems":{"type":"object","properties":{"end":{"$ref":"#/components/schemas/TimeTrackingShiftsGetResponsesContentApplicationJsonSchemaDataItemsMetaBreaksItemsEnd","description":"End time details of the break."},"start":{"$ref":"#/components/schemas/TimeTrackingShiftsGetResponsesContentApplicationJsonSchemaDataItemsMetaBreaksItemsStart","description":"Start time details of the break."},"is_paid":{"type":"boolean","description":"Indicates if the break is paid."}},"title":"TimeTrackingShiftsGetResponsesContentApplicationJsonSchemaDataItemsMetaBreaksItems"},"TimeTrackingShiftsGetResponsesContentApplicationJsonSchemaDataItemsMeta":{"type":"object","properties":{"end":{"$ref":"#/components/schemas/TimeTrackingShiftsGetResponsesContentApplicationJsonSchemaDataItemsMetaEnd","description":"End time details of the shift."},"start":{"$ref":"#/components/schemas/TimeTrackingShiftsGetResponsesContentApplicationJsonSchemaDataItemsMetaStart","description":"Start time details of the shift."},"breaks":{"type":"array","items":{"$ref":"#/components/schemas/TimeTrackingShiftsGetResponsesContentApplicationJsonSchemaDataItemsMetaBreaksItems"},"description":"List of break periods within the shift."},"approval_date":{"type":"string","description":"Approval date of the shift."}},"description":"Metadata containing detailed information about the shift timing, breaks, and approval status.","title":"TimeTrackingShiftsGetResponsesContentApplicationJsonSchemaDataItemsMeta"},"TimeTrackingShiftsGetResponsesContentApplicationJsonSchemaDataItemsSummary":{"type":"object","properties":{"total_break_hours":{"type":"number","format":"double","description":"Total break hours within the shift."},"payable_break_hours":{"type":"number","format":"double","description":"Total payable break hours."},"total_payable_hours":{"type":"number","format":"double","description":"Total payable hours for the shift."},"shift_duration_hours":{"type":"number","format":"double","description":"Total duration of the shift in hours."},"shift_rate_external_id":{"type":"string","description":"External ID of the shift rate associated with the shift."}},"description":"Summary of calculated hours and rates for the shift.","title":"TimeTrackingShiftsGetResponsesContentApplicationJsonSchemaDataItemsSummary"},"TimeTrackingShiftsGetResponsesContentApplicationJsonSchemaDataItemsPayrollCycleRef":{"type":"object","properties":{"date":{"type":"string","description":"Date in ISO 8601 format that helps referencing a payroll cycle"}},"required":["date"],"description":"Reference to the payroll cycle associated with this shift.","title":"TimeTrackingShiftsGetResponsesContentApplicationJsonSchemaDataItemsPayrollCycleRef"},"TimeTrackingShiftsGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"meta":{"$ref":"#/components/schemas/TimeTrackingShiftsGetResponsesContentApplicationJsonSchemaDataItemsMeta","description":"Metadata containing detailed information about the shift timing, breaks, and approval status."},"summary":{"$ref":"#/components/schemas/TimeTrackingShiftsGetResponsesContentApplicationJsonSchemaDataItemsSummary","description":"Summary of calculated hours and rates for the shift."},"created_at":{"type":"string","description":"Timestamp when the shift was created."},"updated_at":{"type":"string","description":"Timestamp when the shift was last updated."},"contract_id":{"type":"string","description":"Contract ID associated with the shift."},"description":{"type":"string","description":"Description of the shift."},"external_id":{"type":"string","description":"Unique identifier of the shift."},"date_of_work":{"type":"string","description":"The date of work for the shift."},"payroll_cycle_ref":{"$ref":"#/components/schemas/TimeTrackingShiftsGetResponsesContentApplicationJsonSchemaDataItemsPayrollCycleRef","description":"Reference to the payroll cycle associated with this shift."}},"required":["created_at","updated_at","contract_id","description","external_id","date_of_work"],"title":"TimeTrackingShiftsGetResponsesContentApplicationJsonSchemaDataItems"},"TimeTrackingShiftsGetResponsesContentApplicationJsonSchemaPage":{"type":"object","properties":{"offset":{"type":"integer","description":"Offset used for pagination."},"total_rows":{"type":"integer","description":"Total number of shifts available."},"items_per_page":{"type":"integer","description":"Number of items returned per page."}},"required":["offset","total_rows","items_per_page"],"description":"Pagination information for the response.","title":"TimeTrackingShiftsGetResponsesContentApplicationJsonSchemaPage"},"time-tracking-shifts_getTimeTrackingShifts_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/TimeTrackingShiftsGetResponsesContentApplicationJsonSchemaDataItems"},"description":"List of shift records."},"page":{"$ref":"#/components/schemas/TimeTrackingShiftsGetResponsesContentApplicationJsonSchemaPage","description":"Pagination information for the response."}},"required":["data","page"],"title":"time-tracking-shifts_getTimeTrackingShifts_Response_200"},"TimeTrackingShiftsExternalIdPatchRequestBodyContentApplicationJsonSchemaDataSummaryTimeUnit":{"type":"string","enum":["HOUR","DAY","WEEK","MONTH"],"description":"Time unit","title":"TimeTrackingShiftsExternalIdPatchRequestBodyContentApplicationJsonSchemaDataSummaryTimeUnit"},"TimeTrackingShiftsExternalIdPatchRequestBodyContentApplicationJsonSchemaDataSummary":{"type":"object","properties":{"time_unit":{"$ref":"#/components/schemas/TimeTrackingShiftsExternalIdPatchRequestBodyContentApplicationJsonSchemaDataSummaryTimeUnit","description":"Time unit"},"time_amount":{"type":"number","format":"double","description":"Time amount"},"total_break_hours":{"type":"number","format":"double","description":"Total break hours"},"payable_break_hours":{"type":"number","format":"double","description":"Payable break hours"},"total_payable_hours":{"type":"number","format":"double","description":"Total payable hours"},"shift_duration_hours":{"type":"number","format":"double","description":"Shift duration hours"},"shift_rate_external_id":{"type":"string","description":"Shift Rate external ID"}},"description":"Summary of calculated time and rates for the shift.","title":"TimeTrackingShiftsExternalIdPatchRequestBodyContentApplicationJsonSchemaDataSummary"},"TimeTrackingShiftsExternalIdPatchRequestBodyContentApplicationJsonSchemaDataPayrollCycleRef":{"type":"object","properties":{"date":{"type":"string","description":"Date in ISO 8601 format that helps referencing a payroll cycle"}},"required":["date"],"description":"Reference to the payroll cycle associated with this shift.","title":"TimeTrackingShiftsExternalIdPatchRequestBodyContentApplicationJsonSchemaDataPayrollCycleRef"},"TimeTrackingShiftsExternalIdPatchRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"summary":{"$ref":"#/components/schemas/TimeTrackingShiftsExternalIdPatchRequestBodyContentApplicationJsonSchemaDataSummary","description":"Summary of calculated time and rates for the shift."},"description":{"type":"string","description":"Description of the shift."},"date_of_work":{"type":"string","description":"The date of the shift."},"payroll_cycle_ref":{"$ref":"#/components/schemas/TimeTrackingShiftsExternalIdPatchRequestBodyContentApplicationJsonSchemaDataPayrollCycleRef","description":"Reference to the payroll cycle associated with this shift."}},"description":"Shift update request data.","title":"TimeTrackingShiftsExternalIdPatchRequestBodyContentApplicationJsonSchemaData"},"TimeTrackingShiftsExternalIdPatchResponsesContentApplicationJsonSchemaDataSummaryTimeUnit":{"type":"string","enum":["HOUR","DAY","WEEK","MONTH"],"description":"Time unit","title":"TimeTrackingShiftsExternalIdPatchResponsesContentApplicationJsonSchemaDataSummaryTimeUnit"},"TimeTrackingShiftsExternalIdPatchResponsesContentApplicationJsonSchemaDataSummary":{"type":"object","properties":{"time_unit":{"$ref":"#/components/schemas/TimeTrackingShiftsExternalIdPatchResponsesContentApplicationJsonSchemaDataSummaryTimeUnit","description":"Time unit"},"time_amount":{"type":"number","format":"double","description":"Time amount"},"total_break_hours":{"type":"number","format":"double","description":"Total break hours."},"payable_break_hours":{"type":"number","format":"double","description":"Payable break hours."},"total_payable_hours":{"type":"number","format":"double","description":"Total payable hours."},"shift_duration_hours":{"type":"number","format":"double","description":"Shift duration hours."},"shift_rate_external_id":{"type":"string","description":"ShiftRate external ID."}},"description":"Summary of calculated time and rates for the shift.","title":"TimeTrackingShiftsExternalIdPatchResponsesContentApplicationJsonSchemaDataSummary"},"TimeTrackingShiftsExternalIdPatchResponsesContentApplicationJsonSchemaDataPayrollCycleRef":{"type":"object","properties":{"date":{"type":"string","description":"Date in ISO 8601 format that helps referencing a payroll cycle"}},"required":["date"],"description":"Reference to the payroll cycle associated with this shift.","title":"TimeTrackingShiftsExternalIdPatchResponsesContentApplicationJsonSchemaDataPayrollCycleRef"},"TimeTrackingShiftsExternalIdPatchResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"summary":{"$ref":"#/components/schemas/TimeTrackingShiftsExternalIdPatchResponsesContentApplicationJsonSchemaDataSummary","description":"Summary of calculated time and rates for the shift."},"created_at":{"type":"string","description":"Timestamp when the shift was created."},"updated_at":{"type":"string","description":"Timestamp when the shift was last updated."},"contract_id":{"type":"string","description":"The contract ID associated with the shift."},"description":{"type":"string","description":"The description of the shift."},"external_id":{"type":"string","description":"Unique identifier of the shift."},"date_of_work":{"type":"string","description":"The date of the shift."},"payroll_cycle_ref":{"$ref":"#/components/schemas/TimeTrackingShiftsExternalIdPatchResponsesContentApplicationJsonSchemaDataPayrollCycleRef","description":"Reference to the payroll cycle associated with this shift."}},"description":"Updated shift record details.","title":"TimeTrackingShiftsExternalIdPatchResponsesContentApplicationJsonSchemaData"},"time-tracking-shifts_updateTimeTrackingShiftByExternalId_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/TimeTrackingShiftsExternalIdPatchResponsesContentApplicationJsonSchemaData","description":"Updated shift record details."}},"title":"time-tracking-shifts_updateTimeTrackingShiftByExternalId_Response_200"},"TimesheetsPostRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"quantity":{"type":"number","format":"double","description":"This is based on the scale of work statement of the associated contract"},"contract_id":{"type":"string","description":"Id of a Deel contract."},"description":{"type":"string","default":""},"date_submitted":{"type":"string","format":"date","description":"Short date in format ISO-8601 (YYYY-MM-DD). For example: 2022-12-31."},"is_auto_approved":{"type":"boolean","description":"If true, the timesheet will be automatically approved as part of the request."},"hourly_report_preset_id":{"type":["string","null"],"description":"Id of an existing timesheets preset. Created through /rest/v2/timesheets/presets"}},"required":["quantity","contract_id","description","date_submitted"],"description":"Details of the timesheet to create. Both a client or a contractor may create a timesheet.","title":"TimesheetsPostRequestBodyContentApplicationJsonSchemaData"},"TimesheetsPostResponsesContentApplicationJsonSchemaDataStatus":{"type":"string","enum":["approved","declined","not_payable","paid","pending","processing"],"description":"status of invoice adjustment","title":"TimesheetsPostResponsesContentApplicationJsonSchemaDataStatus"},"TimesheetsPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of this resource."},"status":{"oneOf":[{"$ref":"#/components/schemas/TimesheetsPostResponsesContentApplicationJsonSchemaDataStatus"},{"type":"null"}],"description":"status of invoice adjustment"},"created":{"type":"boolean"},"created_at":{"type":["string","null"],"format":"date-time","description":"Long date-time format following ISO-8601"}},"required":["created"],"description":"Details of invoice adjustment created.","title":"TimesheetsPostResponsesContentApplicationJsonSchemaData"},"timesheets_createTimesheet_Response_201":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/TimesheetsPostResponsesContentApplicationJsonSchemaData","description":"Details of invoice adjustment created."}},"required":["data"],"title":"timesheets_createTimesheet_Response_201"},"TimesheetsIdDeleteResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"deleted":{"type":"boolean","description":"Confirms the deletion."}},"required":["deleted"],"title":"TimesheetsIdDeleteResponsesContentApplicationJsonSchemaData"},"Timesheets_deleteTimesheetById_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/TimesheetsIdDeleteResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"Timesheets_deleteTimesheetById_Response_200"},"TimesheetsGetParametersContractTypesSchemaOneOf0Items":{"type":"string","enum":["ongoing_time_based","pay_as_you_go_time_based","payg_milestones","payg_tasks"],"description":"Type of a contract","title":"TimesheetsGetParametersContractTypesSchemaOneOf0Items"},"TimesheetsGetParametersContractTypes0":{"type":"array","items":{"$ref":"#/components/schemas/TimesheetsGetParametersContractTypesSchemaOneOf0Items"},"description":"List of contract types","title":"TimesheetsGetParametersContractTypes0"},"TimesheetsGetParametersContractTypes1":{"type":"string","enum":["ongoing_time_based","pay_as_you_go_time_based","payg_milestones","payg_tasks"],"title":"TimesheetsGetParametersContractTypes1"},"TimesheetsGetParametersContractTypes":{"oneOf":[{"$ref":"#/components/schemas/TimesheetsGetParametersContractTypes0"},{"$ref":"#/components/schemas/TimesheetsGetParametersContractTypes1"}],"title":"TimesheetsGetParametersContractTypes"},"TimesheetsGetParametersStatusesSchemaOneOf0Items":{"type":"string","enum":["approved","declined","not_payable","paid","pending","processing"],"description":"status of invoice adjustment","title":"TimesheetsGetParametersStatusesSchemaOneOf0Items"},"TimesheetsGetParametersStatuses0":{"type":"array","items":{"$ref":"#/components/schemas/TimesheetsGetParametersStatusesSchemaOneOf0Items"},"title":"TimesheetsGetParametersStatuses0"},"TimesheetsGetParametersStatuses1":{"type":"string","enum":["approved","declined","not_payable","paid","pending","processing"],"title":"TimesheetsGetParametersStatuses1"},"TimesheetsGetParametersStatuses":{"oneOf":[{"$ref":"#/components/schemas/TimesheetsGetParametersStatuses0"},{"$ref":"#/components/schemas/TimesheetsGetParametersStatuses1"}],"title":"TimesheetsGetParametersStatuses"},"TimesheetsGetResponsesContentApplicationJsonSchemaDataItemsStatus":{"type":"string","enum":["approved","declined","not_payable","paid","pending","processing"],"description":"status of invoice adjustment","title":"TimesheetsGetResponsesContentApplicationJsonSchemaDataItemsStatus"},"TimesheetsGetResponsesContentApplicationJsonSchemaDataItemsContractType":{"type":"string","enum":["ongoing_time_based","milestones","time_based","pay_as_you_go_time_based","commission","payg_milestones","payg_tasks","eor","unknown","employee","global_payroll","shield_msa","hris_direct_employee","peo"],"description":"Type of a contract","title":"TimesheetsGetResponsesContentApplicationJsonSchemaDataItemsContractType"},"TimesheetsGetResponsesContentApplicationJsonSchemaDataItemsContract":{"type":"object","properties":{"id":{"type":"string"},"type":{"$ref":"#/components/schemas/TimesheetsGetResponsesContentApplicationJsonSchemaDataItemsContractType","description":"Type of a contract"},"title":{"type":"string"}},"required":["id","type","title"],"title":"TimesheetsGetResponsesContentApplicationJsonSchemaDataItemsContract"},"TimesheetsGetResponsesContentApplicationJsonSchemaDataItemsWorksheet":{"type":"object","properties":{"days":{"type":"number","format":"double"},"hours":{"type":"number","format":"double"},"weeks":{"type":"number","format":"double"},"minutes":{"type":"number","format":"double"}},"required":["days","hours","weeks","minutes"],"title":"TimesheetsGetResponsesContentApplicationJsonSchemaDataItemsWorksheet"},"TimesheetsGetResponsesContentApplicationJsonSchemaDataItemsAttachment":{"type":"object","properties":{"key":{"type":"string","description":"You can call attachments end-point, get key and URL to upload your file."},"filename":{"type":"string","description":"Original filename you used to upload using attachments end-point."}},"required":["key","filename"],"description":"This object is used for linking file attachments to your records.","title":"TimesheetsGetResponsesContentApplicationJsonSchemaDataItemsAttachment"},"TimesheetsGetResponsesContentApplicationJsonSchemaDataItemsReportedBy":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of this resource."},"full_name":{"type":"string"}},"required":["id"],"title":"TimesheetsGetResponsesContentApplicationJsonSchemaDataItemsReportedBy"},"TimesheetsGetResponsesContentApplicationJsonSchemaDataItemsReviewedBy":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of this resource."},"remarks":{"type":"string"},"full_name":{"type":"string"},"reviewed_at":{"type":"string","format":"date-time"}},"required":["id","remarks","reviewed_at"],"title":"TimesheetsGetResponsesContentApplicationJsonSchemaDataItemsReviewedBy"},"TimesheetsGetResponsesContentApplicationJsonSchemaDataItemsPaymentCycle":{"type":"object","properties":{"end_date":{"type":"string","format":"date-time","description":"Long date-time format following ISO-8601"},"start_date":{"type":"string","format":"date-time","description":"Long date-time format following ISO-8601"}},"title":"TimesheetsGetResponsesContentApplicationJsonSchemaDataItemsPaymentCycle"},"TimesheetsGetResponsesContentApplicationJsonSchemaDataItemsHourlyReportPreset":{"type":"object","properties":{"id":{"type":["string","null"],"description":"unique identifier of the related timesheet preset"},"rate":{"type":["number","null"],"format":"double","description":"the hourly rate of the related timesheet preset"},"title":{"type":["string","null"],"description":"the title of the related timesheet preset"},"description":{"type":["string","null"],"description":"the description of the related timesheet preset"}},"title":"TimesheetsGetResponsesContentApplicationJsonSchemaDataItemsHourlyReportPreset"},"TimesheetsGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of this resource."},"type":{"type":"string","description":"Deprecated - it is always \"work\""},"scale":{"type":["string","null"]},"status":{"oneOf":[{"$ref":"#/components/schemas/TimesheetsGetResponsesContentApplicationJsonSchemaDataItemsStatus"},{"type":"null"}],"description":"status of invoice adjustment"},"contract":{"$ref":"#/components/schemas/TimesheetsGetResponsesContentApplicationJsonSchemaDataItemsContract"},"quantity":{"type":["number","null"],"format":"double"},"worksheet":{"oneOf":[{"$ref":"#/components/schemas/TimesheetsGetResponsesContentApplicationJsonSchemaDataItemsWorksheet"},{"type":"null"}]},"attachment":{"oneOf":[{"$ref":"#/components/schemas/TimesheetsGetResponsesContentApplicationJsonSchemaDataItemsAttachment"},{"type":"null"}],"description":"This object is used for linking file attachments to your records."},"created_at":{"type":"string","format":"date-time","description":"Long date-time format following ISO-8601"},"description":{"type":"string"},"reported_by":{"$ref":"#/components/schemas/TimesheetsGetResponsesContentApplicationJsonSchemaDataItemsReportedBy"},"reviewed_by":{"oneOf":[{"$ref":"#/components/schemas/TimesheetsGetResponsesContentApplicationJsonSchemaDataItemsReviewedBy"},{"type":"null"}]},"custom_scale":{"type":["string","null"]},"total_amount":{"type":"string","description":"is equal to quantity times rate of active work statement + bonus in this record"},"currency_code":{"type":"string"},"payment_cycle":{"$ref":"#/components/schemas/TimesheetsGetResponsesContentApplicationJsonSchemaDataItemsPaymentCycle"},"date_submitted":{"type":"string","format":"date-time","description":"Long date-time format following ISO-8601"},"hourly_report_preset":{"oneOf":[{"$ref":"#/components/schemas/TimesheetsGetResponsesContentApplicationJsonSchemaDataItemsHourlyReportPreset"},{"type":"null"}]}},"required":["id","type","status","contract","quantity","worksheet","created_at","description","reported_by","total_amount","currency_code","date_submitted"],"title":"TimesheetsGetResponsesContentApplicationJsonSchemaDataItems"},"TimesheetsGetResponsesContentApplicationJsonSchemaPage":{"type":"object","properties":{"total_rows":{"type":"number","format":"double"}},"required":["total_rows"],"title":"TimesheetsGetResponsesContentApplicationJsonSchemaPage"},"timesheets_getTimesheets_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/TimesheetsGetResponsesContentApplicationJsonSchemaDataItems"}},"page":{"$ref":"#/components/schemas/TimesheetsGetResponsesContentApplicationJsonSchemaPage"}},"required":["data","page"],"title":"timesheets_getTimesheets_Response_200"},"ContractsContractIdTimesheetsGetParametersContractTypesSchemaOneOf0Items":{"type":"string","enum":["ongoing_time_based","milestones","time_based","pay_as_you_go_time_based","commission","payg_milestones","payg_tasks","eor","unknown","employee","global_payroll","shield_msa","hris_direct_employee","peo"],"description":"Type of a contract","title":"ContractsContractIdTimesheetsGetParametersContractTypesSchemaOneOf0Items"},"ContractsContractIdTimesheetsGetParametersContractTypes0":{"type":"array","items":{"$ref":"#/components/schemas/ContractsContractIdTimesheetsGetParametersContractTypesSchemaOneOf0Items"},"description":"List of contract types","title":"ContractsContractIdTimesheetsGetParametersContractTypes0"},"ContractsContractIdTimesheetsGetParametersContractTypes1":{"type":"string","enum":["ongoing_time_based","milestones","time_based","pay_as_you_go_time_based","commission","payg_milestones","payg_tasks","eor","unknown","employee","global_payroll","shield_msa","hris_direct_employee","peo"],"title":"ContractsContractIdTimesheetsGetParametersContractTypes1"},"ContractsContractIdTimesheetsGetParametersContractTypes":{"oneOf":[{"$ref":"#/components/schemas/ContractsContractIdTimesheetsGetParametersContractTypes0"},{"$ref":"#/components/schemas/ContractsContractIdTimesheetsGetParametersContractTypes1"}],"title":"ContractsContractIdTimesheetsGetParametersContractTypes"},"ContractsContractIdTimesheetsGetParametersStatusesSchemaOneOf0Items":{"type":"string","enum":["approved","declined","not_payable","paid","pending","processing"],"description":"Status of this entry.","title":"ContractsContractIdTimesheetsGetParametersStatusesSchemaOneOf0Items"},"ContractsContractIdTimesheetsGetParametersStatuses0":{"type":"array","items":{"$ref":"#/components/schemas/ContractsContractIdTimesheetsGetParametersStatusesSchemaOneOf0Items"},"title":"ContractsContractIdTimesheetsGetParametersStatuses0"},"ContractsContractIdTimesheetsGetParametersStatuses1":{"type":"string","enum":["approved","declined","not_payable","paid","pending","processing"],"title":"ContractsContractIdTimesheetsGetParametersStatuses1"},"ContractsContractIdTimesheetsGetParametersStatuses":{"oneOf":[{"$ref":"#/components/schemas/ContractsContractIdTimesheetsGetParametersStatuses0"},{"$ref":"#/components/schemas/ContractsContractIdTimesheetsGetParametersStatuses1"}],"title":"ContractsContractIdTimesheetsGetParametersStatuses"},"ContractsContractIdTimesheetsGetResponsesContentApplicationJsonSchemaDataItemsStatus":{"type":"string","enum":["approved","declined","not_payable","paid","pending","processing"],"description":"Status of this entry.","title":"ContractsContractIdTimesheetsGetResponsesContentApplicationJsonSchemaDataItemsStatus"},"ContractsContractIdTimesheetsGetResponsesContentApplicationJsonSchemaDataItemsContractType":{"type":"string","enum":["ongoing_time_based","milestones","time_based","pay_as_you_go_time_based","commission","payg_milestones","payg_tasks","eor","unknown","employee","global_payroll","shield_msa","hris_direct_employee","peo"],"description":"Type of a contract","title":"ContractsContractIdTimesheetsGetResponsesContentApplicationJsonSchemaDataItemsContractType"},"ContractsContractIdTimesheetsGetResponsesContentApplicationJsonSchemaDataItemsContract":{"type":"object","properties":{"id":{"type":"string"},"type":{"$ref":"#/components/schemas/ContractsContractIdTimesheetsGetResponsesContentApplicationJsonSchemaDataItemsContractType","description":"Type of a contract"},"title":{"type":"string"}},"required":["id","type","title"],"title":"ContractsContractIdTimesheetsGetResponsesContentApplicationJsonSchemaDataItemsContract"},"ContractsContractIdTimesheetsGetResponsesContentApplicationJsonSchemaDataItemsWorksheet":{"type":"object","properties":{"days":{"type":"number","format":"double"},"hours":{"type":"number","format":"double"},"weeks":{"type":"number","format":"double"},"minutes":{"type":"number","format":"double"}},"required":["days","hours","weeks","minutes"],"title":"ContractsContractIdTimesheetsGetResponsesContentApplicationJsonSchemaDataItemsWorksheet"},"ContractsContractIdTimesheetsGetResponsesContentApplicationJsonSchemaDataItemsAttachment":{"type":"object","properties":{"key":{"type":"string","description":"You can call attachments end-point, get key and URL to upload your file."},"filename":{"type":"string","description":"Original filename you used to upload using attachments end-point."}},"required":["key","filename"],"description":"This object is used for linking file attachments to your records.","title":"ContractsContractIdTimesheetsGetResponsesContentApplicationJsonSchemaDataItemsAttachment"},"ContractsContractIdTimesheetsGetResponsesContentApplicationJsonSchemaDataItemsReportedBy":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of this resource."},"full_name":{"type":"string"}},"required":["id"],"title":"ContractsContractIdTimesheetsGetResponsesContentApplicationJsonSchemaDataItemsReportedBy"},"ContractsContractIdTimesheetsGetResponsesContentApplicationJsonSchemaDataItemsReviewedBy":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of this resource."},"remarks":{"type":"string"},"full_name":{"type":"string"},"reviewed_at":{"type":"string"}},"required":["id","remarks","reviewed_at"],"title":"ContractsContractIdTimesheetsGetResponsesContentApplicationJsonSchemaDataItemsReviewedBy"},"ContractsContractIdTimesheetsGetResponsesContentApplicationJsonSchemaDataItemsPaymentCycle":{"type":"object","properties":{"end_date":{"type":["string","null"],"format":"date-time","description":"Long date-time format following ISO-8601"},"start_date":{"type":["string","null"],"format":"date-time","description":"Long date-time format following ISO-8601"}},"title":"ContractsContractIdTimesheetsGetResponsesContentApplicationJsonSchemaDataItemsPaymentCycle"},"ContractsContractIdTimesheetsGetResponsesContentApplicationJsonSchemaDataItemsHourlyReportPreset":{"type":"object","properties":{"id":{"type":["string","null"],"description":"unique identifier of the related timesheet preset"},"rate":{"type":["number","null"],"format":"double","description":"the hourly rate of the related timesheet preset"},"title":{"type":["string","null"],"description":"the title of the related timesheet preset"},"description":{"type":["string","null"],"description":"the description of the related timesheet preset"}},"title":"ContractsContractIdTimesheetsGetResponsesContentApplicationJsonSchemaDataItemsHourlyReportPreset"},"ContractsContractIdTimesheetsGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of this resource."},"type":{"type":"string","description":"Deprecated - it is always \"work\""},"scale":{"type":["string","null"]},"status":{"oneOf":[{"$ref":"#/components/schemas/ContractsContractIdTimesheetsGetResponsesContentApplicationJsonSchemaDataItemsStatus"},{"type":"null"}],"description":"Status of this entry."},"contract":{"$ref":"#/components/schemas/ContractsContractIdTimesheetsGetResponsesContentApplicationJsonSchemaDataItemsContract"},"quantity":{"type":["number","null"],"format":"double"},"worksheet":{"oneOf":[{"$ref":"#/components/schemas/ContractsContractIdTimesheetsGetResponsesContentApplicationJsonSchemaDataItemsWorksheet"},{"type":"null"}]},"attachment":{"oneOf":[{"$ref":"#/components/schemas/ContractsContractIdTimesheetsGetResponsesContentApplicationJsonSchemaDataItemsAttachment"},{"type":"null"}],"description":"This object is used for linking file attachments to your records."},"created_at":{"type":"string"},"description":{"type":"string"},"reported_by":{"$ref":"#/components/schemas/ContractsContractIdTimesheetsGetResponsesContentApplicationJsonSchemaDataItemsReportedBy"},"reviewed_by":{"oneOf":[{"$ref":"#/components/schemas/ContractsContractIdTimesheetsGetResponsesContentApplicationJsonSchemaDataItemsReviewedBy"},{"type":"null"}]},"custom_scale":{"type":["string","null"]},"total_amount":{"type":"string","description":"is equal to quantity times rate of active work statement + bonus in this record"},"currency_code":{"type":"string"},"payment_cycle":{"$ref":"#/components/schemas/ContractsContractIdTimesheetsGetResponsesContentApplicationJsonSchemaDataItemsPaymentCycle"},"date_submitted":{"type":"string","format":"date-time","description":"Long date-time format following ISO-8601"},"hourly_report_preset":{"oneOf":[{"$ref":"#/components/schemas/ContractsContractIdTimesheetsGetResponsesContentApplicationJsonSchemaDataItemsHourlyReportPreset"},{"type":"null"}]}},"required":["id","type","status","contract","quantity","worksheet","created_at","description","reported_by","total_amount","currency_code","date_submitted"],"title":"ContractsContractIdTimesheetsGetResponsesContentApplicationJsonSchemaDataItems"},"ContractsContractIdTimesheetsGetResponsesContentApplicationJsonSchemaPage":{"type":"object","properties":{"total_rows":{"type":"number","format":"double"}},"required":["total_rows"],"description":"This object is used for pagination.","title":"ContractsContractIdTimesheetsGetResponsesContentApplicationJsonSchemaPage"},"timesheets_getContractTimesheets_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ContractsContractIdTimesheetsGetResponsesContentApplicationJsonSchemaDataItems"}},"page":{"$ref":"#/components/schemas/ContractsContractIdTimesheetsGetResponsesContentApplicationJsonSchemaPage","description":"This object is used for pagination."}},"required":["data","page"],"title":"timesheets_getContractTimesheets_Response_200"},"TimesheetsIdGetResponsesContentApplicationJsonSchemaDataId":{"oneOf":[{"type":"string"},{"type":"integer","format":"int64"}],"title":"TimesheetsIdGetResponsesContentApplicationJsonSchemaDataId"},"TimesheetsIdGetResponsesContentApplicationJsonSchemaDataStatus":{"type":"string","enum":["approved","declined","not_payable","paid","pending","processing"],"description":"Status of this entry.","title":"TimesheetsIdGetResponsesContentApplicationJsonSchemaDataStatus"},"TimesheetsIdGetResponsesContentApplicationJsonSchemaDataContractType":{"type":"string","enum":["ongoing_time_based","milestones","time_based","pay_as_you_go_time_based","commission","payg_milestones","payg_tasks","eor","unknown","employee","global_payroll","shield_msa","hris_direct_employee","peo"],"description":"Type of a contract","title":"TimesheetsIdGetResponsesContentApplicationJsonSchemaDataContractType"},"TimesheetsIdGetResponsesContentApplicationJsonSchemaDataContract":{"type":"object","properties":{"id":{"type":"string"},"type":{"$ref":"#/components/schemas/TimesheetsIdGetResponsesContentApplicationJsonSchemaDataContractType","description":"Type of a contract"},"title":{"type":"string"}},"required":["id","type","title"],"title":"TimesheetsIdGetResponsesContentApplicationJsonSchemaDataContract"},"TimesheetsIdGetResponsesContentApplicationJsonSchemaDataWorksheet":{"type":"object","properties":{"days":{"type":"number","format":"double"},"hours":{"type":"number","format":"double"},"weeks":{"type":"number","format":"double"},"minutes":{"type":"number","format":"double"}},"required":["days","hours","weeks","minutes"],"title":"TimesheetsIdGetResponsesContentApplicationJsonSchemaDataWorksheet"},"TimesheetsIdGetResponsesContentApplicationJsonSchemaDataAttachment":{"type":"object","properties":{"key":{"type":"string","description":"You can call attachments end-point, get key and URL to upload your file."},"filename":{"type":"string","description":"Original filename you used to upload using attachments end-point."}},"required":["key","filename"],"description":"This object is used for linking file attachments to your records.","title":"TimesheetsIdGetResponsesContentApplicationJsonSchemaDataAttachment"},"TimesheetsIdGetResponsesContentApplicationJsonSchemaDataReportedById":{"oneOf":[{"type":"string"},{"type":"integer","format":"int64"}],"title":"TimesheetsIdGetResponsesContentApplicationJsonSchemaDataReportedById"},"TimesheetsIdGetResponsesContentApplicationJsonSchemaDataReportedBy":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/TimesheetsIdGetResponsesContentApplicationJsonSchemaDataReportedById"},"full_name":{"type":"string"}},"required":["id"],"title":"TimesheetsIdGetResponsesContentApplicationJsonSchemaDataReportedBy"},"TimesheetsIdGetResponsesContentApplicationJsonSchemaDataReviewedById":{"oneOf":[{"type":"string"},{"type":"integer","format":"int64"}],"title":"TimesheetsIdGetResponsesContentApplicationJsonSchemaDataReviewedById"},"TimesheetsIdGetResponsesContentApplicationJsonSchemaDataReviewedBy":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/TimesheetsIdGetResponsesContentApplicationJsonSchemaDataReviewedById"},"remarks":{"type":"string"},"full_name":{"type":"string"},"reviewed_at":{"type":"string"}},"required":["id","remarks","reviewed_at"],"title":"TimesheetsIdGetResponsesContentApplicationJsonSchemaDataReviewedBy"},"TimesheetsIdGetResponsesContentApplicationJsonSchemaDataPaymentCycle":{"type":"object","properties":{"end_date":{"type":["string","null"],"format":"date-time","description":"Long date-time format following ISO-8601"},"start_date":{"type":["string","null"],"format":"date-time","description":"Long date-time format following ISO-8601"}},"title":"TimesheetsIdGetResponsesContentApplicationJsonSchemaDataPaymentCycle"},"TimesheetsIdGetResponsesContentApplicationJsonSchemaDataHourlyReportPreset":{"type":"object","properties":{"id":{"type":["string","null"],"description":"unique identifier of the related timesheet preset"},"rate":{"type":["number","null"],"format":"double","description":"the hourly rate of the related timesheet preset"},"title":{"type":["string","null"],"description":"the title of the related timesheet preset"},"description":{"type":["string","null"],"description":"the description of the related timesheet preset"}},"title":"TimesheetsIdGetResponsesContentApplicationJsonSchemaDataHourlyReportPreset"},"TimesheetsIdGetResponsesContentApplicationJsonSchemaDataApproversItems":{"type":"object","properties":{"email":{"type":"string"},"approved":{"type":"boolean"},"full_name":{"type":"string"}},"required":["approved"],"title":"TimesheetsIdGetResponsesContentApplicationJsonSchemaDataApproversItems"},"TimesheetsIdGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/TimesheetsIdGetResponsesContentApplicationJsonSchemaDataId"},"type":{"type":"string","description":"Deprecated - it is always \"work\""},"scale":{"type":["string","null"]},"status":{"oneOf":[{"$ref":"#/components/schemas/TimesheetsIdGetResponsesContentApplicationJsonSchemaDataStatus"},{"type":"null"}],"description":"Status of this entry."},"contract":{"$ref":"#/components/schemas/TimesheetsIdGetResponsesContentApplicationJsonSchemaDataContract"},"quantity":{"type":["number","null"],"format":"double"},"worksheet":{"oneOf":[{"$ref":"#/components/schemas/TimesheetsIdGetResponsesContentApplicationJsonSchemaDataWorksheet"},{"type":"null"}]},"attachment":{"oneOf":[{"$ref":"#/components/schemas/TimesheetsIdGetResponsesContentApplicationJsonSchemaDataAttachment"},{"type":"null"}],"description":"This object is used for linking file attachments to your records."},"created_at":{"type":"string"},"description":{"type":"string"},"reported_by":{"$ref":"#/components/schemas/TimesheetsIdGetResponsesContentApplicationJsonSchemaDataReportedBy"},"reviewed_by":{"oneOf":[{"$ref":"#/components/schemas/TimesheetsIdGetResponsesContentApplicationJsonSchemaDataReviewedBy"},{"type":"null"}]},"custom_scale":{"type":["string","null"]},"total_amount":{"type":"string","description":"is equal to quantity times rate of active work statement + bonus in this record"},"currency_code":{"type":"string"},"payment_cycle":{"$ref":"#/components/schemas/TimesheetsIdGetResponsesContentApplicationJsonSchemaDataPaymentCycle"},"date_submitted":{"type":"string","format":"date-time","description":"Long date-time format following ISO-8601"},"hourly_report_preset":{"oneOf":[{"$ref":"#/components/schemas/TimesheetsIdGetResponsesContentApplicationJsonSchemaDataHourlyReportPreset"},{"type":"null"}]},"approvers":{"type":"array","items":{"$ref":"#/components/schemas/TimesheetsIdGetResponsesContentApplicationJsonSchemaDataApproversItems"}}},"required":["id","type","status","contract","quantity","worksheet","attachment","created_at","description","reported_by","reviewed_by","total_amount","currency_code","date_submitted","approvers"],"title":"TimesheetsIdGetResponsesContentApplicationJsonSchemaData"},"timesheets_getTimesheetById_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/TimesheetsIdGetResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"timesheets_getTimesheetById_Response_200"},"TimesheetsIdReviewsPostRequestBodyContentApplicationJsonSchemaDataStatus":{"type":"string","enum":["approved","declined"],"title":"TimesheetsIdReviewsPostRequestBodyContentApplicationJsonSchemaDataStatus"},"TimesheetsIdReviewsPostRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"reason":{"type":["string","null"]},"status":{"$ref":"#/components/schemas/TimesheetsIdReviewsPostRequestBodyContentApplicationJsonSchemaDataStatus"}},"required":["status"],"title":"TimesheetsIdReviewsPostRequestBodyContentApplicationJsonSchemaData"},"TimesheetsIdReviewsPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"created":{"type":"boolean"}},"required":["created"],"title":"TimesheetsIdReviewsPostResponsesContentApplicationJsonSchemaData"},"timesheets_createTimesheetReview_Response_201":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/TimesheetsIdReviewsPostResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"timesheets_createTimesheetReview_Response_201"},"TimesheetsIdPatchRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"quantity":{"type":"number","format":"double"},"description":{"type":"string"},"hourly_report_preset_id":{"type":["string","null"],"description":"Id of an existing timesheets preset. Created through /rest/v2/timesheets/presets"}},"required":["quantity","description"],"title":"TimesheetsIdPatchRequestBodyContentApplicationJsonSchemaData"},"TimesheetsIdPatchResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"updated":{"type":"boolean"}},"required":["updated"],"title":"TimesheetsIdPatchResponsesContentApplicationJsonSchemaData"},"timesheets_updateTimesheet_Response_201":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/TimesheetsIdPatchResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"timesheets_updateTimesheet_Response_201"},"AccountsPayableVendorBillsPostRequestBodyContentApplicationJsonSchemaDataLineItemsItems":{"type":"object","properties":{"amount":{"type":"number","format":"double","description":"Total amount for this line item"},"quantity":{"type":"number","format":"double","description":"Quantity of items"},"vat_code":{"type":"string","description":"VAT Code name"},"vat_rate":{"type":"number","format":"double","description":"VAT rate percentage"},"unit_price":{"type":"number","format":"double","description":"Price per unit"},"vat_amount":{"type":"number","format":"double","description":"VAT amount for this line item"},"description":{"type":"string","description":"Description of the line item"},"department_id":{"type":"string","description":"Unique Identifier for the Financial department"},"expense_account_id":{"type":"string","description":"Unique Identifier for the Expense account"}},"required":["amount","quantity","vat_rate","unit_price","description"],"title":"AccountsPayableVendorBillsPostRequestBodyContentApplicationJsonSchemaDataLineItemsItems"},"AccountsPayableVendorBillsPostRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"date":{"type":"string","format":"date","description":"Invoice/bill date"},"amount":{"type":"number","format":"double","description":"Total amount including VAT"},"currency":{"type":"string","description":"ISO 4217 currency code"},"due_date":{"type":"string","format":"date","description":"Due date for payment"},"subtotal":{"type":"number","format":"double","description":"Subtotal amount excluding VAT"},"reference":{"type":"string","description":"Vendor bill reference"},"vendor_id":{"type":"string","description":"Unique identifier for the Vendor"},"line_items":{"type":"array","items":{"$ref":"#/components/schemas/AccountsPayableVendorBillsPostRequestBodyContentApplicationJsonSchemaDataLineItemsItems"},"description":"Line items for the vendor bill"},"description":{"type":"string","description":"General description of the vendor bill"},"external_id":{"type":"string","description":"External system identifier (e.g., Brightflag ID)"},"subsidiary_id":{"type":"string","description":"Unique identifier for the Deel legal entity/subsidiary"}},"required":["date","amount","currency","due_date","subtotal","reference","vendor_id","line_items","description","external_id","subsidiary_id"],"title":"AccountsPayableVendorBillsPostRequestBodyContentApplicationJsonSchemaData"},"AccountsPayableVendorBillsPostResponsesContentApplicationJsonSchemaDataLineItemsItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the line item"},"amount":{"type":"number","format":"double","description":"Total amount for this line item"},"quantity":{"type":"number","format":"double","description":"Quantity of items"},"vat_code":{"type":["string","null"],"description":"VAT code name"},"vat_rate":{"type":"number","format":"double","description":"VAT rate percentage"},"created_at":{"type":"string","format":"date-time","description":"Creation timestamp"},"unit_price":{"type":"number","format":"double","description":"Price per unit"},"updated_at":{"type":"string","format":"date-time","description":"Last update timestamp"},"vat_amount":{"type":"number","format":"double","description":"VAT amount for this line item"},"description":{"type":"string","description":"Description of the line item"},"department_id":{"type":["string","null"],"description":"Unique identifier for the Financial department"},"vendor_bill_id":{"type":"string","format":"uuid","description":"Reference to parent vendor bill"},"expense_account_id":{"type":["string","null"],"description":"Unique identifier for the expense account"}},"required":["id","amount","quantity","vat_rate","created_at","unit_price","updated_at","vat_amount","description","vendor_bill_id"],"title":"AccountsPayableVendorBillsPostResponsesContentApplicationJsonSchemaDataLineItemsItems"},"AccountsPayableVendorBillsPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the vendor in the treasury system"},"date":{"type":"string","format":"date","description":"Invoice/bill date"},"amount":{"type":"number","format":"double","description":"Total amount including VAT"},"currency":{"type":"string","description":"ISO 4217 currency code"},"due_date":{"type":"string","format":"date","description":"Due date for payment"},"subtotal":{"type":"number","format":"double","description":"Subtotal amount excluding VAT"},"is_active":{"type":"boolean","description":"Whether the vendor bill is active"},"reference":{"type":"string","description":"Vendor bill reference"},"vendor_id":{"type":"string","description":"Vendor ID"},"created_at":{"type":"string","format":"date-time","description":"Creation timestamp"},"line_items":{"type":"array","items":{"$ref":"#/components/schemas/AccountsPayableVendorBillsPostResponsesContentApplicationJsonSchemaDataLineItemsItems"},"description":"Line items for the vendor bill"},"updated_at":{"type":"string","format":"date-time","description":"Last update timestamp"},"description":{"type":"string","description":"General description of the vendor bill"},"external_id":{"type":"string","description":"External system identifier (e.g., Brightflag ID)"},"exchange_rate":{"type":["number","null"],"format":"double","description":"Exchange rate to USD"},"subsidiary_id":{"type":"string","description":"Unique identifier for the Deel legal entity/subsidiary"}},"required":["id","date","amount","currency","due_date","subtotal","is_active","reference","vendor_id","created_at","line_items","updated_at","description","external_id","exchange_rate","subsidiary_id"],"title":"AccountsPayableVendorBillsPostResponsesContentApplicationJsonSchemaData"},"Treasury_createVendorBill-v2026-01-01_Response_201":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AccountsPayableVendorBillsPostResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"Treasury_createVendorBill-v2026-01-01_Response_201"},"AccountsPayableVendorBillsPostResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code"},"message":{"type":"string","description":"Human-readable explanation"}},"required":["code","message"],"title":"AccountsPayableVendorBillsPostResponsesContentApplicationJsonSchemaErrorsItems"},"CreateVendorBill-v2026-01-01RequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/AccountsPayableVendorBillsPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"CreateVendorBill-v2026-01-01RequestBadRequestError"},"CreateVendorBill-v2026-01-01RequestConflictError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/AccountsPayableVendorBillsPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"CreateVendorBill-v2026-01-01RequestConflictError"},"CreateVendorBill-v2026-01-01RequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/AccountsPayableVendorBillsPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"CreateVendorBill-v2026-01-01RequestInternalServerError"},"AccountsPayableVendorBillsVendorBillIdAttachmentsPostRequestBodyContentMultipartFormDataSchemaData":{"type":"object","properties":{"file":{"type":"string","format":"binary","description":"PDF file to upload (max 8MB)"}},"title":"AccountsPayableVendorBillsVendorBillIdAttachmentsPostRequestBodyContentMultipartFormDataSchemaData"},"AccountsPayableVendorBillsVendorBillIdAttachmentsPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier of the uploaded attachment"},"created_at":{"type":"string","format":"date-time","description":"Creation timestamp"},"updated_at":{"type":"string","format":"date-time","description":"Last update timestamp"}},"required":["id","created_at","updated_at"],"title":"AccountsPayableVendorBillsVendorBillIdAttachmentsPostResponsesContentApplicationJsonSchemaData"},"Treasury_uploadVendorBillAttachment_Response_201":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AccountsPayableVendorBillsVendorBillIdAttachmentsPostResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"Treasury_uploadVendorBillAttachment_Response_201"},"AccountsPayableVendorBillsVendorBillIdAttachmentsPostResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code"},"message":{"type":"string","description":"Human-readable explanation"}},"required":["code","message"],"title":"AccountsPayableVendorBillsVendorBillIdAttachmentsPostResponsesContentApplicationJsonSchemaErrorsItems"},"UploadVendorBillAttachmentRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/AccountsPayableVendorBillsVendorBillIdAttachmentsPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"UploadVendorBillAttachmentRequestBadRequestError"},"UploadVendorBillAttachmentRequestNotFoundError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/AccountsPayableVendorBillsVendorBillIdAttachmentsPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"UploadVendorBillAttachmentRequestNotFoundError"},"UploadVendorBillAttachmentRequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/AccountsPayableVendorBillsVendorBillIdAttachmentsPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"UploadVendorBillAttachmentRequestInternalServerError"},"UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaMetaResourceType":{"type":"string","enum":["User","Group"],"title":"UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaMetaResourceType"},"UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaMeta":{"type":"object","properties":{"created":{"type":"string","format":"date-time"},"location":{"type":"string"},"lastModified":{"type":"string","format":"date-time"},"resourceType":{"$ref":"#/components/schemas/UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaMetaResourceType"}},"title":"UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaMeta"},"UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaName":{"type":"object","properties":{"givenName":{"type":"string"},"familyName":{"type":"string"}},"required":["givenName","familyName"],"title":"UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaName"},"UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaEmailsItemsType":{"type":"string","enum":["home","work","other"],"title":"UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaEmailsItemsType"},"UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaEmailsItems":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaEmailsItemsType"},"value":{"type":"string"},"primary":{"type":"boolean","default":false}},"required":["type","value"],"title":"UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaEmailsItems"},"UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaSchemasItems":{"type":"string","enum":["urn:ietf:params:scim:schemas:core:2.0:User"],"title":"UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaSchemasItems"},"UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaAddressesItems":{"type":"object","properties":{"type":{"type":"string"},"region":{"type":"string"},"country":{"type":["string","null"]},"locality":{"type":"string"},"postalCode":{"type":"string"},"streetAddress":{"type":"string"}},"title":"UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaAddressesItems"},"UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaUrnIetfParamsScimSchemasExtension20UserEndDate1":{"type":"string","enum":[""],"title":"UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaUrnIetfParamsScimSchemasExtension20UserEndDate1"},"UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaUrnIetfParamsScimSchemasExtension20UserEndDate":{"oneOf":[{"type":"string","format":"date-time"},{"$ref":"#/components/schemas/UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaUrnIetfParamsScimSchemasExtension20UserEndDate1"}],"title":"UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaUrnIetfParamsScimSchemasExtension20UserEndDate"},"UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaUrnIetfParamsScimSchemasExtension20UserEmploymentsItemsTeam":{"type":"object","properties":{"name":{"type":"string"}},"title":"UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaUrnIetfParamsScimSchemasExtension20UserEmploymentsItemsTeam"},"UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaUrnIetfParamsScimSchemasExtension20UserEmploymentsItemsCustomFieldsItemsData":{"type":"object","properties":{},"description":"The custom field value payload, structure varies by field type","title":"UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaUrnIetfParamsScimSchemasExtension20UserEmploymentsItemsCustomFieldsItemsData"},"UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaUrnIetfParamsScimSchemasExtension20UserEmploymentsItemsCustomFieldsItems":{"type":"object","properties":{"id":{"type":"string"},"data":{"oneOf":[{"$ref":"#/components/schemas/UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaUrnIetfParamsScimSchemasExtension20UserEmploymentsItemsCustomFieldsItemsData"},{"type":"null"}],"description":"The custom field value payload, structure varies by field type"},"name":{"type":"string"},"type":{"type":"string"}},"title":"UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaUrnIetfParamsScimSchemasExtension20UserEmploymentsItemsCustomFieldsItems"},"UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaUrnIetfParamsScimSchemasExtension20UserEmploymentsItems":{"type":"object","properties":{"team":{"$ref":"#/components/schemas/UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaUrnIetfParamsScimSchemasExtension20UserEmploymentsItemsTeam"},"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/UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaUrnIetfParamsScimSchemasExtension20UserEmploymentsItemsCustomFieldsItems"},"description":"Contract-level custom fields associated with the employment"}},"title":"UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaUrnIetfParamsScimSchemasExtension20UserEmploymentsItems"},"UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaUrnIetfParamsScimSchemasExtension20UserCustomFieldsItems":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":["string","null"]},"value":{"type":["string","null"]}},"title":"UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaUrnIetfParamsScimSchemasExtension20UserCustomFieldsItems"},"UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaUrnIetfParamsScimSchemasExtension20User":{"type":"object","properties":{"state":{"type":["string","null"]},"country":{"type":["string","null"]},"endDate":{"$ref":"#/components/schemas/UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaUrnIetfParamsScimSchemasExtension20UserEndDate"},"isManager":{"type":"boolean","default":false},"startDate":{"type":["string","null"],"format":"date"},"employments":{"type":["array","null"],"items":{"$ref":"#/components/schemas/UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaUrnIetfParamsScimSchemasExtension20UserEmploymentsItems"}},"customFields":{"type":["array","null"],"items":{"$ref":"#/components/schemas/UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaUrnIetfParamsScimSchemasExtension20UserCustomFieldsItems"}},"hiringStatus":{"type":"string"},"workLocation":{"type":["string","null"],"description":"The work location label assigned to the worker's HRIS profile"},"departmentHierarchy":{"type":["string","null"]},"departmentExternalId":{"type":["string","null"]},"departmentExternalIdHierarchy":{"type":["string","null"]}},"title":"UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaUrnIetfParamsScimSchemasExtension20User"},"UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaUrnIetfParamsScimSchemasExtensionEnterprise20UserManager":{"type":"object","properties":{"value":{"type":"string"},"displayName":{"type":"string"}},"required":["value"],"title":"UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaUrnIetfParamsScimSchemasExtensionEnterprise20UserManager"},"UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaUrnIetfParamsScimSchemasExtensionEnterprise20User":{"type":"object","properties":{"manager":{"$ref":"#/components/schemas/UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaUrnIetfParamsScimSchemasExtensionEnterprise20UserManager"},"costCenter":{"type":"string"},"department":{"type":"string"},"organization":{"type":"string"}},"title":"UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaUrnIetfParamsScimSchemasExtensionEnterprise20User"},"User_retrieveASingleUser-v2026-01-01_Response_200":{"type":"object","properties":{"id":{"type":"string"},"meta":{"$ref":"#/components/schemas/UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaMeta"},"name":{"$ref":"#/components/schemas/UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaName"},"title":{"type":"string"},"active":{"type":"boolean","default":false},"emails":{"type":"array","items":{"$ref":"#/components/schemas/UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaEmailsItems"}},"schemas":{"type":"array","items":{"$ref":"#/components/schemas/UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaSchemasItems"}},"userName":{"type":"string"},"userType":{"type":"string"},"addresses":{"type":"array","items":{"$ref":"#/components/schemas/UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaAddressesItems"}},"urn:ietf:params:scim:schemas:extension:2.0:User":{"$ref":"#/components/schemas/UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaUrnIetfParamsScimSchemasExtension20User"},"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User":{"$ref":"#/components/schemas/UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaUrnIetfParamsScimSchemasExtensionEnterprise20User"}},"required":["meta","name","emails","schemas","userName"],"title":"User_retrieveASingleUser-v2026-01-01_Response_200"},"UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaErrorsItemsContext":{"type":"object","properties":{},"title":"UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaErrorsItemsContext"},"UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"key":{"type":"string"},"path":{"type":"array","items":{"type":"string"}},"type":{"type":"string"},"context":{"$ref":"#/components/schemas/UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaErrorsItemsContext"},"message":{"type":"string"}},"title":"UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaErrorsItems"},"UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaRequest":{"type":"object","properties":{"url":{"type":"string"},"docs":{"type":"string"},"method":{"type":"string"},"source":{"type":"string"},"status":{"type":"integer"},"api_req_id":{"type":"string"}},"title":"UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaRequest"},"RetrieveASingleUser-v2026-01-01RequestNotFoundError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaErrorsItems"}},"request":{"$ref":"#/components/schemas/UsersHrisProfileIdGetResponsesContentApplicationJsonSchemaRequest"}},"title":"RetrieveASingleUser-v2026-01-01RequestNotFoundError"},"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"},"CreateWebhookRequestStatus":{"type":"string","enum":["enabled","disabled"],"description":"Status of webhook.","title":"CreateWebhookRequestStatus"},"CreateWebhookRequest":{"type":"object","properties":{"name":{"type":["string","null"],"description":"Webhook subscription name."},"description":{"type":["string","null"],"description":"Webhook subscription description."},"status":{"$ref":"#/components/schemas/CreateWebhookRequestStatus","description":"Status of webhook."},"url":{"type":"string","description":"Endpoint to receive webhook."},"signing_key":{"type":["string","null"],"description":"The webhook's signing key, used to generate webhook signatures."},"api_version":{"type":"string","default":"v2","description":"Deel API version. Currently Deel accepts v1 or v2 version."},"events":{"type":"array","items":{"type":"string"},"description":"The list of events to enable for this subscription."}},"required":["name","description","status","url","signing_key","api_version","events"],"title":"CreateWebhookRequest"},"WebhookItemStatus":{"type":"string","enum":["enabled","disabled"],"description":"Status of webhook.","title":"WebhookItemStatus"},"WebhookItem":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of this resource."},"name":{"type":["string","null"],"description":"Webhook subscription name."},"description":{"type":["string","null"],"description":"Webhook subscription description."},"status":{"$ref":"#/components/schemas/WebhookItemStatus","description":"Status of webhook."},"url":{"type":"string","description":"Endpoint to receive webhook."},"signing_key":{"type":["string","null"],"description":"The webhook's signing key, used to generate webhook signatures."},"api_version":{"type":"string","default":"v2","description":"Deel API version. Currently Deel accepts v1 or v2 version."},"events":{"type":"array","items":{"type":"string"},"description":"The list of events to enable for this subscription."},"created_at":{"type":"string","description":"Time at which the webhook was created."},"updated_at":{"type":"string","description":"Time at which the webhook was updated."},"hidden":{"type":["boolean","null"],"description":"Property to hide the webhook from frontend view. Commonly by Dell 3rd party apps"},"internal":{"type":"boolean"},"deleted_at":{"type":"string","description":"Time at which the webhook was deleted."}},"required":["id","name","description","status","url","signing_key","api_version","events","created_at","updated_at"],"title":"WebhookItem"},"WebhookItemResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/WebhookItem"}},"required":["data"],"title":"WebhookItemResponse"},"GenericResultDeletedData":{"type":"object","properties":{"deleted":{"type":"boolean","description":"Confirms the deletion."}},"required":["deleted"],"title":"GenericResultDeletedData"},"GenericResultDeleted":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/GenericResultDeletedData"}},"required":["data"],"title":"GenericResultDeleted"},"PatchWebhookRequestStatus":{"type":"string","enum":["enabled","disabled"],"description":"Status of webhook.","title":"PatchWebhookRequestStatus"},"PatchWebhookRequest":{"type":"object","properties":{"name":{"type":["string","null"],"description":"Webhook subscription name."},"description":{"type":["string","null"],"description":"Webhook subscription description."},"status":{"$ref":"#/components/schemas/PatchWebhookRequestStatus","description":"Status of webhook."},"url":{"type":"string","description":"Endpoint to receive webhook."},"signing_key":{"type":["string","null"],"description":"The webhook's signing key, used to generate webhook signatures."},"api_version":{"type":"string","default":"v2","description":"Deel API version. Currently Deel accepts v1 or v2 version."},"events":{"type":"array","items":{"type":"string"},"description":"The list of events to enable for this subscription."}},"required":["name","description","status","url","signing_key","events"],"title":"PatchWebhookRequest"},"WebhookEventTypeResponse":{"type":"object","properties":{"id":{"type":"number","format":"double","description":"Event type unique identifier."},"module_name":{"type":"string","description":"Name of the rabbit queue."},"module_label":{"type":"string","description":"Display name of the rabbit queue in Deel UI."},"name":{"type":"string","description":"Name of the webhook event."},"description":{"type":"string","description":"Describes the webhook event and other pertinent info."},"payload_example":{"type":["string","null"],"description":"JSON payload example of the specific event."},"created_at":{"type":"string","description":"Time at which the event type was created."},"updated_at":{"type":"string","description":"Time at which the event type was updated."}},"required":["id","module_name","module_label","name","description"],"title":"WebhookEventTypeResponse"},"WebhookEventTypeListResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/WebhookEventTypeResponse"}}},"title":"WebhookEventTypeListResponse"},"WebhookListResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/WebhookItem"}}},"required":["data"],"title":"WebhookListResponse"},"EscalationsWorkersMeHrxGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier (UUID) for the HRX representative"},"name":{"type":"string","description":"Full name of the HRX representative"},"avatar":{"type":"string","description":"URL to the HRX representative's avatar/profile picture"},"created_at":{"type":"string","format":"date-time","description":"Timestamp when the HRX record was created"},"updated_at":{"type":"string","format":"date-time","description":"Timestamp when the HRX record was last updated"},"cal_com_url":{"type":"string","description":"A link to schedule call with HRX Manager"}},"required":["id","name","avatar","created_at","updated_at"],"title":"EscalationsWorkersMeHrxGetResponsesContentApplicationJsonSchemaData"},"Worker HR_getHrxManagerForWorker_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EscalationsWorkersMeHrxGetResponsesContentApplicationJsonSchemaData"}},"title":"Worker HR_getHrxManagerForWorker_Response_200"},"EscalationsWorkersMeHrxGetResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code"},"message":{"type":"string","description":"Human-readable explanation of the error"}},"title":"EscalationsWorkersMeHrxGetResponsesContentApplicationJsonSchemaErrorsItems"},"GetHrxManagerForWorkerRequestForbiddenError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EscalationsWorkersMeHrxGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"GetHrxManagerForWorkerRequestForbiddenError"},"GetHrxManagerForWorkerRequestNotFoundError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EscalationsWorkersMeHrxGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"GetHrxManagerForWorkerRequestNotFoundError"},"GetHrxManagerForWorkerRequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/EscalationsWorkersMeHrxGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"GetHrxManagerForWorkerRequestInternalServerError"},"GpWorkersWorkerIdBanksPostRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"city":{"type":"string","description":"The city of the user's address."},"iban":{"type":"string","description":"The International Bank Account Number (IBAN)."},"email":{"type":"string","description":"The user's email address."},"phone":{"type":"string","description":"The user's phone number."},"postal":{"type":"string","description":"The user's postal or ZIP code."},"tax_id":{"type":"string","description":"The user's tax identification number."},"bank_code":{"type":"string","description":"The bank code."},"bank_name":{"type":"string","description":"Name of the user's bank."},"full_name":{"type":"string","description":"Full name of the user."},"swift_bic":{"type":"string","description":"SWIFT/BIC code for the bank."},"rib_number":{"type":"string","description":"The RIB (Relevé d'Identité Bancaire)."},"branch_code":{"type":"string","description":"The branch code of the user's bank."},"account_type":{"type":"string","description":"Bank account type."},"country_code":{"type":"string","description":"The country code of the user's address."},"address_line1":{"type":"string","description":"The primary address line."},"address_line2":{"type":"string","description":"The secondary address line."},"currency_code":{"type":"string","description":"The currency code for transactions."},"original_name":{"type":"string","description":"The original name of the user."},"account_number":{"type":"string","description":"The user's bank account number."},"province_state":{"type":"string","description":"The state or province of the user's address."},"bank_branch_name":{"type":"string","description":"The name of the user's bank branch."},"bank_country_code":{"type":"string","description":"The country code where the bank is located."},"ach_routing_number":{"type":"string","description":"The ACH (Automated Clearing House) Routing Number."}},"title":"GpWorkersWorkerIdBanksPostRequestBodyContentApplicationJsonSchemaData"},"GpWorkersWorkerIdBanksPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the newly added bank account."},"status":{"type":"string","description":"The status of the newly added bank account."},"created_at":{"type":"string","format":"date-time","description":"Timestamp of when the bank account was created, in ISO-8601 format."},"updated_at":{"type":"string","format":"date-time","description":"Timestamp of the last update to the bank account, in ISO-8601 format."}},"required":["id","status","created_at","updated_at"],"title":"GpWorkersWorkerIdBanksPostResponsesContentApplicationJsonSchemaData"},"worker-information_createGPWorkerBank_Response_201":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/GpWorkersWorkerIdBanksPostResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"worker-information_createGPWorkerBank_Response_201"},"GpWorkersContractsContractIdAdditionalInformationPostRequestBodyContentApplicationJsonSchemaData":{"oneOf":[{"type":"string"},{"type":"number","format":"double"},{"type":"boolean"}],"title":"GpWorkersContractsContractIdAdditionalInformationPostRequestBodyContentApplicationJsonSchemaData"},"GpWorkersContractsContractIdAdditionalInformationPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"created_at":{"type":"string","description":"Datetime of submission of the additional information"}},"title":"GpWorkersContractsContractIdAdditionalInformationPostResponsesContentApplicationJsonSchemaData"},"worker-information_createGPWorkerAdditionalInformation_Response_201":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/GpWorkersContractsContractIdAdditionalInformationPostResponsesContentApplicationJsonSchemaData"}},"title":"worker-information_createGPWorkerAdditionalInformation_Response_201"},"GpWorkersContractsContractIdAdditionalInformationPostResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code"},"message":{"type":"string","description":"Human-readable explanation of the error"}},"title":"GpWorkersContractsContractIdAdditionalInformationPostResponsesContentApplicationJsonSchemaErrorsItems"},"AddGpWorkersAdditionalInformationRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/GpWorkersContractsContractIdAdditionalInformationPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"AddGpWorkersAdditionalInformationRequestBadRequestError"},"AddGpWorkersAdditionalInformationRequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/GpWorkersContractsContractIdAdditionalInformationPostResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"AddGpWorkersAdditionalInformationRequestInternalServerError"},"GpWorkersWorkerIdBanksBankIdPatchResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the modified bank account."},"status":{"type":"string","description":"The status of the modified bank account."},"created_at":{"type":"string","format":"date-time","description":"Timestamp of when the bank account was created, in ISO-8601 format."},"updated_at":{"type":"string","format":"date-time","description":"Timestamp of the last update to the bank account, in ISO-8601 format."}},"required":["id","status","created_at","updated_at"],"title":"GpWorkersWorkerIdBanksBankIdPatchResponsesContentApplicationJsonSchemaData"},"worker-information_updateGPWorkerBank_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/GpWorkersWorkerIdBanksBankIdPatchResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"worker-information_updateGPWorkerBank_Response_200"},"GpWorkersWorkerIdBanksGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"city":{"type":"string","description":"The city of the user's address."},"iban":{"type":"string","description":"The International Bank Account Number (IBAN)."},"email":{"type":"string","description":"The user's email address."},"phone":{"type":"string","description":"The user's phone number."},"postal":{"type":"string","description":"The user's postal or ZIP code."},"tax_id":{"type":"string","description":"The user's tax identification number."},"bank_code":{"type":"string","description":"The bank code."},"bank_name":{"type":"string","description":"Name of the user's bank."},"full_name":{"type":"string","description":"Full name of the user."},"sort_code":{"type":"string","description":"UK sort code."},"swift_bic":{"type":"string","description":"SWIFT/BIC code for the bank."},"rib_number":{"type":"string","description":"The RIB(Relevé d'Identité Bancaire)."},"branch_code":{"type":"string","description":"The branch code of the user's bank."},"account_type":{"type":"string","description":"Bank account type."},"country_code":{"type":"string","description":"The country code of the user."},"address_line1":{"type":"string","description":"The primary address line."},"address_line2":{"type":"string","description":"The secondary address line."},"currency_code":{"type":"string","description":"The currency code for transactions."},"original_name":{"type":"string","description":"The original name of the user."},"account_number":{"type":"string","description":"The user's bank account number."},"province_state":{"type":"string","description":"The state or province of the user's address."},"bank_branch_name":{"type":"string","description":"The name of the user's bank branch."},"bank_country_code":{"type":"string","description":"The country code where the bank is located."},"ach_routing_number":{"type":"string","description":"The ACH (Automated Clearing House) Routing Number."},"id":{"type":"string","description":"Unique identifier of this resource."},"status":{"type":"string","description":"Current status of bank account."},"created_at":{"type":"string","format":"date-time","description":"Long date-time format following ISO-8601."},"updated_at":{"type":"string","format":"date-time","description":"Long date-time format following ISO-8601."}},"required":["id","created_at","updated_at"],"title":"GpWorkersWorkerIdBanksGetResponsesContentApplicationJsonSchemaDataItems"},"worker-information_getGPWorkerBanks_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/GpWorkersWorkerIdBanksGetResponsesContentApplicationJsonSchemaDataItems"}}},"required":["data"],"title":"worker-information_getGPWorkerBanks_Response_200"},"GpWorkersWorkerIdBanksGuideGetResponsesContentApplicationJsonSchemaDataItemsValidationsItemsType":{"type":"string","enum":["MIN_LENGTH","MAX_LENGTH","REGEX"],"description":"The type of validation applied to the field.","title":"GpWorkersWorkerIdBanksGuideGetResponsesContentApplicationJsonSchemaDataItemsValidationsItemsType"},"GpWorkersWorkerIdBanksGuideGetResponsesContentApplicationJsonSchemaDataItemsValidationsItemsValue":{"oneOf":[{"type":"string"},{"type":"number","format":"double"}],"title":"GpWorkersWorkerIdBanksGuideGetResponsesContentApplicationJsonSchemaDataItemsValidationsItemsValue"},"GpWorkersWorkerIdBanksGuideGetResponsesContentApplicationJsonSchemaDataItemsValidationsItems":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/GpWorkersWorkerIdBanksGuideGetResponsesContentApplicationJsonSchemaDataItemsValidationsItemsType","description":"The type of validation applied to the field."},"value":{"$ref":"#/components/schemas/GpWorkersWorkerIdBanksGuideGetResponsesContentApplicationJsonSchemaDataItemsValidationsItemsValue"}},"title":"GpWorkersWorkerIdBanksGuideGetResponsesContentApplicationJsonSchemaDataItemsValidationsItems"},"GpWorkersWorkerIdBanksGuideGetResponsesContentApplicationJsonSchemaDataItemsValuesAllowedItems":{"type":"object","properties":{"label":{"type":"string","description":"The display name of the allowed value."},"value":{"type":"string","description":"The value associated with the allowed option."}},"title":"GpWorkersWorkerIdBanksGuideGetResponsesContentApplicationJsonSchemaDataItemsValuesAllowedItems"},"GpWorkersWorkerIdBanksGuideGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"key":{"type":"string","description":"The unique key representing the field."},"type":{"type":"string","description":"The type of the field, such as 'Text' or 'Dropdown'."},"label":{"type":"string","description":"The label or display name for this field."},"required":{"type":"boolean","description":"Indicates whether the field is required."},"validations":{"type":"array","items":{"$ref":"#/components/schemas/GpWorkersWorkerIdBanksGuideGetResponsesContentApplicationJsonSchemaDataItemsValidationsItems"},"description":"An array of validation rules applied to the field."},"values_allowed":{"type":"array","items":{"$ref":"#/components/schemas/GpWorkersWorkerIdBanksGuideGetResponsesContentApplicationJsonSchemaDataItemsValuesAllowedItems"},"description":"An array of allowed values for the field (e.g., for dropdown fields)."}},"required":["key","required"],"title":"GpWorkersWorkerIdBanksGuideGetResponsesContentApplicationJsonSchemaDataItems"},"worker-information_getGPWorkerBankGuide_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/GpWorkersWorkerIdBanksGuideGetResponsesContentApplicationJsonSchemaDataItems"}}},"required":["data"],"title":"worker-information_getGPWorkerBankGuide_Response_200"},"GpWorkersWorkerIdAddressPatchRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"zip":{"type":"string","description":"Zip code."},"city":{"type":"string","description":"City name."},"street":{"type":"string","description":"Street name."}},"title":"GpWorkersWorkerIdAddressPatchRequestBodyContentApplicationJsonSchemaData"},"GpWorkersWorkerIdAddressPatchResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"zip":{"type":["string","null"],"description":"Zip code."},"city":{"type":["string","null"],"description":"City name."},"state":{"type":["string","null"],"description":"State name."},"street":{"type":["string","null"],"description":"Street name."},"country":{"type":"string","description":"Country code."},"updated_at":{"type":"string","format":"date-time","description":"Long date-time format following ISO-8601"}},"title":"GpWorkersWorkerIdAddressPatchResponsesContentApplicationJsonSchemaData"},"worker-information_updateGPWorkerAddress_Response_201":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/GpWorkersWorkerIdAddressPatchResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"worker-information_updateGPWorkerAddress_Response_201"},"GpWorkersWorkerIdCompensationPatchRequestBodyContentApplicationJsonSchemaDataScale":{"type":"string","enum":["YEAR","MONTH","HOUR"],"description":"The scale to which a given salary applies.","title":"GpWorkersWorkerIdCompensationPatchRequestBodyContentApplicationJsonSchemaDataScale"},"GpWorkersWorkerIdCompensationPatchRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"scale":{"$ref":"#/components/schemas/GpWorkersWorkerIdCompensationPatchRequestBodyContentApplicationJsonSchemaDataScale","description":"The scale to which a given salary applies."},"salary":{"type":"number","format":"double","description":"Compensation salary."},"effective_date":{"type":"string","format":"date","description":"Short date in format ISO-8601 (YYYY-MM-DD). For example: 2022-12-31."}},"required":["scale","salary","effective_date"],"title":"GpWorkersWorkerIdCompensationPatchRequestBodyContentApplicationJsonSchemaData"},"GpWorkersWorkerIdCompensationPatchResponsesContentApplicationJsonSchemaDataItemsScale":{"type":"string","enum":["YEAR","MONTH","HOUR"],"description":"The scale to which a given salary applies.","title":"GpWorkersWorkerIdCompensationPatchResponsesContentApplicationJsonSchemaDataItemsScale"},"GpWorkersWorkerIdCompensationPatchResponsesContentApplicationJsonSchemaDataItemsStatus":{"type":"string","enum":["ACTIVE","UPCOMING","OUTDATED"],"description":"The status of a salary amendment.","title":"GpWorkersWorkerIdCompensationPatchResponsesContentApplicationJsonSchemaDataItemsStatus"},"GpWorkersWorkerIdCompensationPatchResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"scale":{"$ref":"#/components/schemas/GpWorkersWorkerIdCompensationPatchResponsesContentApplicationJsonSchemaDataItemsScale","description":"The scale to which a given salary applies."},"salary":{"type":"string","description":"Compensation salary."},"status":{"$ref":"#/components/schemas/GpWorkersWorkerIdCompensationPatchResponsesContentApplicationJsonSchemaDataItemsStatus","description":"The status of a salary amendment."},"effective_date":{"type":"string","format":"date","description":"Short date in format ISO-8601 (YYYY-MM-DD). For example: 2022-12-31."}},"title":"GpWorkersWorkerIdCompensationPatchResponsesContentApplicationJsonSchemaDataItems"},"worker-information_updateGPWorkerCompensation_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/GpWorkersWorkerIdCompensationPatchResponsesContentApplicationJsonSchemaDataItems"}}},"required":["data"],"title":"worker-information_updateGPWorkerCompensation_Response_200"},"GpWorkersWorkerIdEmployeeInformationPatchRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"employee_number":{"type":"string","description":"Employee's unique number."}},"title":"GpWorkersWorkerIdEmployeeInformationPatchRequestBodyContentApplicationJsonSchemaData"},"GpWorkersContractsContractIdAdditionalInformationPatchRequestBodyContentApplicationJsonSchemaData":{"oneOf":[{"type":"string"},{"type":"number","format":"double"},{"type":"boolean"}],"title":"GpWorkersContractsContractIdAdditionalInformationPatchRequestBodyContentApplicationJsonSchemaData"},"worker-information_getGPWorkerAdditionalInformation_Response_204":{"type":"object","properties":{},"description":"Empty response body","title":"worker-information_getGPWorkerAdditionalInformation_Response_204"},"GpWorkersContractsContractIdAdditionalInformationPatchResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code"},"message":{"type":"string","description":"Human-readable explanation of the error"}},"title":"GpWorkersContractsContractIdAdditionalInformationPatchResponsesContentApplicationJsonSchemaErrorsItems"},"UpdateGpWorkersAdditionalInformationRequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/GpWorkersContractsContractIdAdditionalInformationPatchResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"UpdateGpWorkersAdditionalInformationRequestBadRequestError"},"UpdateGpWorkersAdditionalInformationRequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/GpWorkersContractsContractIdAdditionalInformationPatchResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"UpdateGpWorkersAdditionalInformationRequestInternalServerError"},"GpWorkersWorkerIdPtoPolicyPatchRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"yearly_allowance":{"type":"string","description":"Enter the number of holidays. Example: '15' for 15 days."},"accrual_start_date":{"type":"string","format":"date","description":"Short date in format ISO-8601 (YYYY-MM-DD). For example: '2022-12-31'."}},"required":["yearly_allowance","accrual_start_date"],"title":"GpWorkersWorkerIdPtoPolicyPatchRequestBodyContentApplicationJsonSchemaData"},"GpWorkersWorkerIdPtoPolicyPatchResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"updated":{"type":"boolean","description":"Indicates if the PTO policy was successfully updated."}},"required":["updated"],"title":"GpWorkersWorkerIdPtoPolicyPatchResponsesContentApplicationJsonSchemaData"},"worker-information_updateGPWorkerPTOPolicy_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/GpWorkersWorkerIdPtoPolicyPatchResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"worker-information_updateGPWorkerPTOPolicy_Response_200"},"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"},"HrisWorkerRelationsProfileExternalProfileIdParentPutRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"relation_external_id":{"type":["string","null"],"description":"The external identifier for this specific relation record."},"parent_profile_external_id":{"type":["string","null"],"description":"The external identifier of the parent HRIS Profile. Pass null to remove the existing parent relationship."},"hris_relationship_type_external_id":{"type":"string","description":"The external identifier of the relationship type to apply."}},"required":["parent_profile_external_id","hris_relationship_type_external_id"],"description":"The request payload containing parent relationship details.","title":"HrisWorkerRelationsProfileExternalProfileIdParentPutRequestBodyContentApplicationJsonSchemaData"},"Worker Relations_createAParentWorkerRelationWithExternalId-v2026-01-01_Response_204":{"type":"object","properties":{},"description":"Empty response body","title":"Worker Relations_createAParentWorkerRelationWithExternalId-v2026-01-01_Response_204"},"HrisWorkerRelationsProfileExternalProfileIdParentPutResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string"},"field":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"title":"HrisWorkerRelationsProfileExternalProfileIdParentPutResponsesContentApplicationJsonSchemaErrorsItems"},"CreateAParentWorkerRelationWithExternalId-v2026-01-01RequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/HrisWorkerRelationsProfileExternalProfileIdParentPutResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"CreateAParentWorkerRelationWithExternalId-v2026-01-01RequestBadRequestError"},"CreateAParentWorkerRelationWithExternalId-v2026-01-01RequestNotFoundError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/HrisWorkerRelationsProfileExternalProfileIdParentPutResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"CreateAParentWorkerRelationWithExternalId-v2026-01-01RequestNotFoundError"},"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"},"HrisWorkerRelationsProfileHrisProfileOidChildPutRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"ids":{"type":"array","items":{"type":"string","format":"uuid"},"description":"An array containing the IDs of the child profiles"},"hris_relationship_type_id":{"type":"string","format":"uuid","description":"The ID of the relationship type"}},"required":["ids","hris_relationship_type_id"],"title":"HrisWorkerRelationsProfileHrisProfileOidChildPutRequestBodyContentApplicationJsonSchemaData"},"Worker Relations_createChildWorkerRelation-v2026-01-01_Response_204":{"type":"object","properties":{},"description":"Empty response body","title":"Worker Relations_createChildWorkerRelation-v2026-01-01_Response_204"},"HrisWorkerRelationsProfileHrisProfileOidChildPutResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string"},"field":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"title":"HrisWorkerRelationsProfileHrisProfileOidChildPutResponsesContentApplicationJsonSchemaErrorsItems"},"CreateChildWorkerRelation-v2026-01-01RequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/HrisWorkerRelationsProfileHrisProfileOidChildPutResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"CreateChildWorkerRelation-v2026-01-01RequestBadRequestError"},"CreateChildWorkerRelation-v2026-01-01RequestNotFoundError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/HrisWorkerRelationsProfileHrisProfileOidChildPutResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"CreateChildWorkerRelation-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_deleteAWorkerRelationType-v2026-01-01_Response_204":{"type":"object","properties":{},"description":"Empty response body","title":"Worker Relations_deleteAWorkerRelationType-v2026-01-01_Response_204"},"HrisWorkerRelationsTypesTypeIdDeleteResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code"},"message":{"type":"string","description":"Human-readable explanation of the error"}},"title":"HrisWorkerRelationsTypesTypeIdDeleteResponsesContentApplicationJsonSchemaErrorsItems"},"DeleteAWorkerRelationType-v2026-01-01RequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/HrisWorkerRelationsTypesTypeIdDeleteResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"DeleteAWorkerRelationType-v2026-01-01RequestBadRequestError"},"DeleteAWorkerRelationType-v2026-01-01RequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/HrisWorkerRelationsTypesTypeIdDeleteResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"DeleteAWorkerRelationType-v2026-01-01RequestInternalServerError"},"worker-relations_deleteWorkerRelationTypeByExternalId_Response_204":{"type":"object","properties":{},"description":"Empty response body","title":"worker-relations_deleteWorkerRelationTypeByExternalId_Response_204"},"HrisWorkerRelationsProfileExternalProfileIdGetResponsesContentApplicationJsonSchemaDataItemsChildRelationshipsItems":{"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"},"external_id":{"type":"string","description":"The external ID of the child profile"},"relation_id":{"type":"string","format":"uuid","description":"The ID of the relation between the profiles"}},"title":"HrisWorkerRelationsProfileExternalProfileIdGetResponsesContentApplicationJsonSchemaDataItemsChildRelationshipsItems"},"HrisWorkerRelationsProfileExternalProfileIdGetResponsesContentApplicationJsonSchemaDataItemsParentRelationship":{"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"},"profile_external_id":{"type":"string","description":"The external ID of the parent profile"},"relation_external_id":{"type":"string","description":"The external ID of the relation"}},"description":"An object that has information about the parent profile in the relation.","title":"HrisWorkerRelationsProfileExternalProfileIdGetResponsesContentApplicationJsonSchemaDataItemsParentRelationship"},"HrisWorkerRelationsProfileExternalProfileIdGetResponsesContentApplicationJsonSchemaDataItems":{"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/HrisWorkerRelationsProfileExternalProfileIdGetResponsesContentApplicationJsonSchemaDataItemsChildRelationshipsItems"},"description":"An array containing the information about the child profiles in the relation."},"parent_relationship":{"$ref":"#/components/schemas/HrisWorkerRelationsProfileExternalProfileIdGetResponsesContentApplicationJsonSchemaDataItemsParentRelationship","description":"An object that has information about the parent profile in the relation."}},"title":"HrisWorkerRelationsProfileExternalProfileIdGetResponsesContentApplicationJsonSchemaDataItems"},"Worker Relations_fetchWorkerRelationsOfAGivenHrisProfileByExternalId-v2026-01-01_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/HrisWorkerRelationsProfileExternalProfileIdGetResponsesContentApplicationJsonSchemaDataItems"},"description":"An array containing the Worker Relations of the profile. It includes either the parent or child relations."}},"title":"Worker Relations_fetchWorkerRelationsOfAGivenHrisProfileByExternalId-v2026-01-01_Response_200"},"HrisWorkerRelationsProfileExternalProfileIdGetResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string"},"field":{"type":"string"},"message":{"type":"string"}},"required":["code","message"],"title":"HrisWorkerRelationsProfileExternalProfileIdGetResponsesContentApplicationJsonSchemaErrorsItems"},"FetchWorkerRelationsOfAGivenHrisProfileByExternalId-v2026-01-01RequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/HrisWorkerRelationsProfileExternalProfileIdGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"FetchWorkerRelationsOfAGivenHrisProfileByExternalId-v2026-01-01RequestBadRequestError"},"FetchWorkerRelationsOfAGivenHrisProfileByExternalId-v2026-01-01RequestNotFoundError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/HrisWorkerRelationsProfileExternalProfileIdGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"FetchWorkerRelationsOfAGivenHrisProfileByExternalId-v2026-01-01RequestNotFoundError"},"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"},"WorkersSessionPostRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"profile_id":{"type":"string","format":"uuid","description":"The ID of the profile to create access token for"}},"required":["profile_id"],"title":"WorkersSessionPostRequestBodyContentApplicationJsonSchemaData"},"WorkersSessionPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"token":{"type":"string","description":"Access token"},"expires_at":{"type":"string","format":"date-time","description":"Expiration date of the access token"}},"required":["token","expires_at"],"title":"WorkersSessionPostResponsesContentApplicationJsonSchemaData"},"Worker Session_createWorkerAccessToken_Response_201":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/WorkersSessionPostResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"Worker Session_createWorkerAccessToken_Response_201"},"Worker Session_deleteWorkerAccessToken_Response_204":{"type":"object","properties":{},"description":"Empty response body","title":"Worker Session_deleteWorkerAccessToken_Response_204"},"IcWorkersInvoicesInvoiceIdPdfGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"url":{"type":"string","format":"uri","description":"HTTPS URL to download the invoice PDF."}},"required":["url"],"description":"Payload with the signed download URL.","title":"IcWorkersInvoicesInvoiceIdPdfGetResponsesContentApplicationJsonSchemaData"},"Workers_icWorkersInvoicesInvoiceIdPdf-v2026-04-20_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/IcWorkersInvoicesInvoiceIdPdfGetResponsesContentApplicationJsonSchemaData","description":"Payload with the signed download URL."}},"required":["data"],"description":"Envelope containing a time-limited signed URL to the invoice PDF.","title":"Workers_icWorkersInvoicesInvoiceIdPdf-v2026-04-20_Response_200"},"IcWorkersInvoicesInvoiceIdPdfGetResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string"},"field":{"type":"string"},"details":{"type":"object","additionalProperties":{"description":"Any type"}},"message":{"type":"string"}},"required":["code","message"],"title":"IcWorkersInvoicesInvoiceIdPdfGetResponsesContentApplicationJsonSchemaErrorsItems"},"IcWorkersInvoicesInvoiceIdPdf-v2026-04-20RequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/IcWorkersInvoicesInvoiceIdPdfGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"IcWorkersInvoicesInvoiceIdPdf-v2026-04-20RequestBadRequestError"},"IcWorkersInvoicesInvoiceIdPdf-v2026-04-20RequestUnauthorizedError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/IcWorkersInvoicesInvoiceIdPdfGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"IcWorkersInvoicesInvoiceIdPdf-v2026-04-20RequestUnauthorizedError"},"IcWorkersInvoicesInvoiceIdPdfGetResponsesContentApplicationJsonSchemaRequest":{"type":"object","properties":{"url":{"type":"string"},"method":{"type":"string"},"status":{"type":"integer"}},"description":"Present for some public API responses (e.g. when x-is-api-call is set).","title":"IcWorkersInvoicesInvoiceIdPdfGetResponsesContentApplicationJsonSchemaRequest"},"IcWorkersInvoicesInvoiceIdPdf-v2026-04-20RequestForbiddenError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/IcWorkersInvoicesInvoiceIdPdfGetResponsesContentApplicationJsonSchemaErrorsItems"}},"request":{"$ref":"#/components/schemas/IcWorkersInvoicesInvoiceIdPdfGetResponsesContentApplicationJsonSchemaRequest","description":"Present for some public API responses (e.g. when x-is-api-call is set)."}},"required":["errors"],"title":"IcWorkersInvoicesInvoiceIdPdf-v2026-04-20RequestForbiddenError"},"IcWorkersInvoicesInvoiceIdPdf-v2026-04-20RequestPreconditionFailedError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/IcWorkersInvoicesInvoiceIdPdfGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"IcWorkersInvoicesInvoiceIdPdf-v2026-04-20RequestPreconditionFailedError"},"IcWorkersInvoicesInvoiceIdPdf-v2026-04-20RequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/IcWorkersInvoicesInvoiceIdPdfGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"IcWorkersInvoicesInvoiceIdPdf-v2026-04-20RequestInternalServerError"},"WorkerPostRequestBodyContentApplicationJsonSchemaDataCompanyType":{"type":"string","enum":["COMPANY","INDIVIDUAL"],"description":"Type of company registration","title":"WorkerPostRequestBodyContentApplicationJsonSchemaDataCompanyType"},"WorkerPostRequestBodyContentApplicationJsonSchemaDataCompanyPersonal":{"type":"object","properties":{"zip":{"type":"number","format":"double","description":"Zip/Postal code"},"city":{"type":"string","description":"City"},"phone":{"type":"number","format":"double","description":"Phone number"},"street":{"type":"string","description":"Street address"},"citizen":{"type":"string","description":"Citizenship country code"},"country":{"type":"string","description":"Country code"},"id_type":{"type":"string","description":"Type of identification"},"province":{"type":["string","null"],"description":"Province/State"},"timezone":{"type":"string","description":"Personal timezone"},"personal_id":{"type":"number","format":"double","description":"Personal identification number"},"legal_status":{"type":"string","description":"Legal status (required only when type is INDIVIDUAL)"},"tax_residence":{"type":"string","description":"Tax residence country code"},"entity_tax_residence":{"type":"string","description":"Entity tax residence (only applicable for company type)"}},"required":["zip","city","phone","street","citizen","personal_id"],"title":"WorkerPostRequestBodyContentApplicationJsonSchemaDataCompanyPersonal"},"WorkerPostRequestBodyContentApplicationJsonSchemaDataCompany":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/WorkerPostRequestBodyContentApplicationJsonSchemaDataCompanyType","description":"Type of company registration"},"personal":{"$ref":"#/components/schemas/WorkerPostRequestBodyContentApplicationJsonSchemaDataCompanyPersonal"}},"required":["type","personal"],"title":"WorkerPostRequestBodyContentApplicationJsonSchemaDataCompany"},"WorkerPostRequestBodyContentApplicationJsonSchemaDataProfileType":{"type":"string","enum":["CONTRACTOR","EOR"],"description":"Type of worker profile","title":"WorkerPostRequestBodyContentApplicationJsonSchemaDataProfileType"},"WorkerPostRequestBodyContentApplicationJsonSchemaData":{"type":"object","properties":{"email":{"type":"string","format":"email","description":"Worker's email address"},"company":{"$ref":"#/components/schemas/WorkerPostRequestBodyContentApplicationJsonSchemaDataCompany"},"timezone":{"type":"string","description":"Worker's timezone"},"last_name":{"type":"string","description":"Worker's last name"},"first_name":{"type":"string","description":"Worker's first name"},"contract_id":{"type":"string","description":"Associated contract ID"},"middle_name":{"type":["string","null"],"description":"Worker's middle name"},"profile_type":{"$ref":"#/components/schemas/WorkerPostRequestBodyContentApplicationJsonSchemaDataProfileType","description":"Type of worker profile"},"preferred_name":{"type":["string","null"],"description":"Worker's preferred name"},"preferred_lastName":{"type":["string","null"],"description":"Worker's preferred last name"},"preferred_firstname":{"type":["string","null"],"description":"Worker's preferred first name"}},"required":["email","company","timezone","last_name","first_name","contract_id","profile_type"],"title":"WorkerPostRequestBodyContentApplicationJsonSchemaData"},"WorkerPostResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"user_id":{"type":"string","description":"Created user ID"},"profile_id":{"type":"string","description":"Created profile ID"},"contract_id":{"type":"string","description":"Associated contract ID"}},"required":["user_id","profile_id","contract_id"],"title":"WorkerPostResponsesContentApplicationJsonSchemaData"},"Workers_createWorker_Response_201":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/WorkerPostResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"Workers_createWorker_Response_201"},"CreateWorkerRequestBadRequestError":{"type":"object","properties":{"error":{"type":"string"}},"title":"CreateWorkerRequestBadRequestError"},"CreateWorkerRequestInternalServerError":{"type":"object","properties":{"error":{"type":"string"}},"title":"CreateWorkerRequestInternalServerError"},"IcWorkersInvoicesInvoiceIdGetResponsesContentApplicationJsonSchemaDataPaymentDisplayStatus":{"type":"object","properties":{"key":{"type":"string","description":"Stable machine key."},"label":{"type":"string","description":"Human-readable label."}},"required":["key","label"],"description":"Derived payment display state for the invoice.","title":"IcWorkersInvoicesInvoiceIdGetResponsesContentApplicationJsonSchemaDataPaymentDisplayStatus"},"IcWorkersInvoicesInvoiceIdGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"id":{"type":"string","description":"Public invoice id."},"title":{"type":"string","description":"Display title."},"total":{"type":["string","null"],"description":"Total including fees."},"amount":{"type":["string","null"],"description":"Amount before fees."},"status":{"type":"string","description":"Invoice workflow status."},"currency":{"type":"string","description":"Three-letter currency code."},"issued_at":{"type":["string","null"],"format":"date-time","description":"When the invoice was issued, if applicable."},"created_at":{"type":"string","format":"date-time","description":"When the invoice record was created (ISO-8601)."},"payment_display_status":{"$ref":"#/components/schemas/IcWorkersInvoicesInvoiceIdGetResponsesContentApplicationJsonSchemaDataPaymentDisplayStatus","description":"Derived payment display state for the invoice."}},"required":["id","status","currency","created_at"],"description":"Invoice summary (snake_case; display card fields, amounts, and payment display).","title":"IcWorkersInvoicesInvoiceIdGetResponsesContentApplicationJsonSchemaData"},"Workers_getInvoiceDetailsById-v2026-04-27_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/IcWorkersInvoicesInvoiceIdGetResponsesContentApplicationJsonSchemaData","description":"Invoice summary (snake_case; display card fields, amounts, and payment display)."}},"required":["data"],"title":"Workers_getInvoiceDetailsById-v2026-04-27_Response_200"},"IcWorkersInvoicesInvoiceIdGetResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code."},"field":{"type":"string","description":"JSON pointer to the invalid field, when applicable."},"details":{"type":"object","additionalProperties":{"description":"Any type"},"description":"Optional structured context for the error."},"message":{"type":"string","description":"Human-readable explanation of the error."}},"required":["code","message"],"title":"IcWorkersInvoicesInvoiceIdGetResponsesContentApplicationJsonSchemaErrorsItems"},"GetInvoiceDetailsById-v2026-04-27RequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/IcWorkersInvoicesInvoiceIdGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"GetInvoiceDetailsById-v2026-04-27RequestBadRequestError"},"GetInvoiceDetailsById-v2026-04-27RequestUnauthorizedError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/IcWorkersInvoicesInvoiceIdGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"GetInvoiceDetailsById-v2026-04-27RequestUnauthorizedError"},"IcWorkersInvoicesInvoiceIdGetResponsesContentApplicationJsonSchemaRequest":{"type":"object","properties":{"url":{"type":"string"},"method":{"type":"string"},"status":{"type":"integer"}},"description":"Present for some public API responses (e.g. when `x-is-api-call` is set).","title":"IcWorkersInvoicesInvoiceIdGetResponsesContentApplicationJsonSchemaRequest"},"GetInvoiceDetailsById-v2026-04-27RequestForbiddenError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/IcWorkersInvoicesInvoiceIdGetResponsesContentApplicationJsonSchemaErrorsItems"}},"request":{"$ref":"#/components/schemas/IcWorkersInvoicesInvoiceIdGetResponsesContentApplicationJsonSchemaRequest","description":"Present for some public API responses (e.g. when `x-is-api-call` is set)."}},"required":["errors"],"title":"GetInvoiceDetailsById-v2026-04-27RequestForbiddenError"},"GetInvoiceDetailsById-v2026-04-27RequestPreconditionFailedError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/IcWorkersInvoicesInvoiceIdGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"GetInvoiceDetailsById-v2026-04-27RequestPreconditionFailedError"},"GetInvoiceDetailsById-v2026-04-27RequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/IcWorkersInvoicesInvoiceIdGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"GetInvoiceDetailsById-v2026-04-27RequestInternalServerError"},"WorkersComplianceDocumentsGetResponsesContentApplicationJsonSchemaDataDocumentsItemsStatus":{"type":"string","enum":["AWAITING_EX_REVIEW","AWAITING_EXTERNAL_REVIEW","REJECTED","APPROVED","ON_HOLD"],"description":"Review status of the uploaded document, null if no document has been uploaded yet.","title":"WorkersComplianceDocumentsGetResponsesContentApplicationJsonSchemaDataDocumentsItemsStatus"},"WorkersComplianceDocumentsGetResponsesContentApplicationJsonSchemaDataDocumentsItems":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Unique identifier for the compliance document requirement."},"name":{"type":"string","description":"Display name of the compliance document."},"status":{"oneOf":[{"$ref":"#/components/schemas/WorkersComplianceDocumentsGetResponsesContentApplicationJsonSchemaDataDocumentsItemsStatus"},{"type":"null"}],"description":"Review status of the uploaded document, null if no document has been uploaded yet."},"country":{"type":"string","description":"ISO 3166-1 alpha-2 country code where the document is required."},"fillable":{"type":"boolean","description":"Whether the document can be filled through the Deel platform."},"filenames":{"type":"array","items":{"type":"string"},"description":"List of uploaded file names. Empty array when no files have been uploaded."},"description":{"type":"string","description":"Description of the document requirement. Empty string when no description exists."},"is_optional":{"type":"boolean","description":"Whether the document is optional for the worker. Also true when the document is required within 30 days."},"uploaded_at":{"type":["string","null"],"format":"date-time","description":"ISO 8601 timestamp when the document was uploaded, null if no document has been uploaded."},"has_template":{"type":"boolean","description":"Whether a template is available for this document."},"rejection_message":{"type":"string","description":"Plain text message explaining why the document was rejected. Empty string when no rejection message exists."},"is_consent_required":{"type":"boolean","description":"Whether consent is required for acknowledgement-only documents. Only present when is_acknowledgement_only_document is true."},"required_in_30_days":{"type":"boolean","description":"Whether the document is required within 30 days of employment start."},"is_acknowledgement_only_document":{"type":"boolean","description":"Whether this document only requires acknowledgement without file upload."}},"required":["id","name","status","country","fillable","filenames","description","is_optional","uploaded_at","has_template","rejection_message","required_in_30_days","is_acknowledgement_only_document"],"title":"WorkersComplianceDocumentsGetResponsesContentApplicationJsonSchemaDataDocumentsItems"},"WorkersComplianceDocumentsGetResponsesContentApplicationJsonSchemaData":{"type":"object","properties":{"documents":{"type":"array","items":{"$ref":"#/components/schemas/WorkersComplianceDocumentsGetResponsesContentApplicationJsonSchemaDataDocumentsItems"},"description":"List of compliance documents required for the worker."}},"required":["documents"],"title":"WorkersComplianceDocumentsGetResponsesContentApplicationJsonSchemaData"},"Workers_listOfWorkerComplianceDocuments-v2026-04-23_Response_200":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/WorkersComplianceDocumentsGetResponsesContentApplicationJsonSchemaData"}},"required":["data"],"title":"Workers_listOfWorkerComplianceDocuments-v2026-04-23_Response_200"},"WorkersComplianceDocumentsGetResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code."},"field":{"type":"string","description":"Name of the field causing the error, if applicable."},"message":{"type":"string","description":"Human-readable error message."}},"required":["code","message"],"title":"WorkersComplianceDocumentsGetResponsesContentApplicationJsonSchemaErrorsItems"},"ListOfWorkerComplianceDocuments-v2026-04-23RequestForbiddenError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/WorkersComplianceDocumentsGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"ListOfWorkerComplianceDocuments-v2026-04-23RequestForbiddenError"},"ListOfWorkerComplianceDocuments-v2026-04-23RequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/WorkersComplianceDocumentsGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"title":"ListOfWorkerComplianceDocuments-v2026-04-23RequestInternalServerError"},"IcWorkersTransactionsGetParametersFilter":{"type":"string","enum":["ALL","ONLY_PROCESSING","WITHOUT_PROCESSING"],"default":"ALL","title":"IcWorkersTransactionsGetParametersFilter"},"IcWorkersTransactionsGetParametersTransactionType":{"type":"string","enum":["PAY_IN","PAY_OUT"],"title":"IcWorkersTransactionsGetParametersTransactionType"},"IcWorkersTransactionsGetResponsesContentApplicationJsonSchemaDataItems":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of this resource (public transaction id)."},"amount":{"type":["string","null"],"description":"Transaction amount."},"status":{"type":"string","description":"Transaction status."},"currency":{"type":"string","description":"Three-letter currency code."},"created_at":{"type":"string","format":"date-time","description":"Date and time when the transaction was created (ISO-8601)."}},"required":["id","created_at"],"description":"One contractor transaction; `id` is the public transaction UUID.","title":"IcWorkersTransactionsGetResponsesContentApplicationJsonSchemaDataItems"},"Workers_retrieveWorkerTransactionHistory-v2026-04-30_Response_200":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/IcWorkersTransactionsGetResponsesContentApplicationJsonSchemaDataItems"},"description":"Transaction rows for this page."},"has_more":{"type":"boolean","description":"Whether another page exists after this one."},"next_cursor":{"type":["string","null"],"description":"Opaque cursor for the next page; null when there is no next page. Pass this value as the `cursor` query parameter to request the following page."},"total_count":{"type":"integer","description":"Total number of transactions matching server-side filters for this request (ignores pagination). If `statuses` is provided, that filter is applied in memory to listed rows only, so this count may be higher than the rows returned across all pages."}},"required":["data","has_more","total_count"],"title":"Workers_retrieveWorkerTransactionHistory-v2026-04-30_Response_200"},"IcWorkersTransactionsGetResponsesContentApplicationJsonSchemaErrorsItems":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code"},"field":{"type":"string","description":"JSON pointer to the invalid field"},"details":{"type":"object","additionalProperties":{"description":"Any type"},"description":"Optional structured details"},"message":{"type":"string","description":"Human-readable explanation of the error"}},"required":["code","message"],"title":"IcWorkersTransactionsGetResponsesContentApplicationJsonSchemaErrorsItems"},"RetrieveWorkerTransactionHistory-v2026-04-30RequestBadRequestError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/IcWorkersTransactionsGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"RetrieveWorkerTransactionHistory-v2026-04-30RequestBadRequestError"},"RetrieveWorkerTransactionHistory-v2026-04-30RequestUnauthorizedError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/IcWorkersTransactionsGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"RetrieveWorkerTransactionHistory-v2026-04-30RequestUnauthorizedError"},"IcWorkersTransactionsGetResponsesContentApplicationJsonSchemaRequest":{"type":"object","properties":{"url":{"type":"string"},"method":{"type":"string"},"status":{"type":"integer"}},"description":"Present for some public API responses (e.g. when x-is-api-call is set).","title":"IcWorkersTransactionsGetResponsesContentApplicationJsonSchemaRequest"},"RetrieveWorkerTransactionHistory-v2026-04-30RequestForbiddenError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/IcWorkersTransactionsGetResponsesContentApplicationJsonSchemaErrorsItems"}},"request":{"$ref":"#/components/schemas/IcWorkersTransactionsGetResponsesContentApplicationJsonSchemaRequest","description":"Present for some public API responses (e.g. when x-is-api-call is set)."}},"required":["errors"],"title":"RetrieveWorkerTransactionHistory-v2026-04-30RequestForbiddenError"},"RetrieveWorkerTransactionHistory-v2026-04-30RequestPreconditionFailedError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/IcWorkersTransactionsGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"RetrieveWorkerTransactionHistory-v2026-04-30RequestPreconditionFailedError"},"RetrieveWorkerTransactionHistory-v2026-04-30RequestInternalServerError":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/IcWorkersTransactionsGetResponsesContentApplicationJsonSchemaErrorsItems"}}},"required":["errors"],"title":"RetrieveWorkerTransactionHistory-v2026-04-30RequestInternalServerError"}},"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/"}}}}