{"openapi":"3.1.0","info":{"title":"Endpoints","version":"1.0.0"},"paths":{"/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"}}}}}}},"/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"]}}}}}},"/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"}}}}}}},"/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"}}}}}}},"/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"}}}}}}},"/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_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"]}}}}}},"/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"]}}}}}}},"servers":[{"url":"https://api.letsdeel.com/rest/v2"},{"url":"https://api-staging.letsdeel.com/rest/v2"}],"components":{"schemas":{"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"},"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"},"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"},"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"},"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"},"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"},"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"},"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"},"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"},"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"}},"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/"}}}}